webchalk-animate - v0.31.0
    Preparing search index...

    Typings for the preset connector exit animation effects that come with the library's connector exit effect bank.

    interface WebchalkPresetConnectorExitEffects {
        "~disappear": {
            defaultConfig: {};
            howOftenBuildGenerators: "on-first-play-only";
            immutableConfig: { composite: "replace"; duration: 0; easing: "linear" };
            buildFrameGenerators(
                this: Readonly<
                    Pick<
                        ConnectorExitClip<
                            Readonly<
                                StripDuplicateMethodAutocompletion<
                                    {
                                        defaultConfig?: Partial<(...)> & object;
                                        howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                        immutableConfig?: Partial<(...)> & object;
                                        buildFrameGenerators(
                                            this: Readonly<Pick<AnimClip<(...), (...)>, "computeTween">>,
                                            ...effectOptions: unknown[],
                                        ): EffectFrameGeneratorSet;
                                    },
                                >,
                            >,
                        >,
                        | "domElem"
                        | "getEffectDetails"
                        | "getStatus"
                        | "getStyles"
                        | "getTiming",
                    >,
                > & Readonly<
                    Pick<
                        AnimClip<
                            Readonly<
                                StripDuplicateMethodAutocompletion<
                                    {
                                        defaultConfig?: Partial<(...)> & object;
                                        howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                        immutableConfig?: Partial<(...)> & object;
                                        buildFrameGenerators(
                                            this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                            ...effectOptions: unknown[],
                                        ): EffectFrameGeneratorSet;
                                    },
                                >,
                            >,
                            AnimClipConfig,
                        >,
                        "computeTween",
                    >,
                >,
            ): {};
        };
        "~fade-out": {
            defaultConfig: {};
            howOftenBuildGenerators: "on-first-play-only";
            immutableConfig: { composite: "replace" };
            buildFrameGenerators(
                this: Readonly<
                    Pick<
                        ConnectorExitClip<
                            Readonly<
                                StripDuplicateMethodAutocompletion<
                                    {
                                        defaultConfig?: Partial<(...)> & object;
                                        howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                        immutableConfig?: Partial<(...)> & object;
                                        buildFrameGenerators(
                                            this: Readonly<Pick<AnimClip<(...), (...)>, "computeTween">>,
                                            ...effectOptions: unknown[],
                                        ): EffectFrameGeneratorSet;
                                    },
                                >,
                            >,
                        >,
                        | "domElem"
                        | "getEffectDetails"
                        | "getStatus"
                        | "getStyles"
                        | "getTiming",
                    >,
                > & Readonly<
                    Pick<
                        AnimClip<
                            Readonly<
                                StripDuplicateMethodAutocompletion<
                                    {
                                        defaultConfig?: Partial<(...)> & object;
                                        howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                        immutableConfig?: Partial<(...)> & object;
                                        buildFrameGenerators(
                                            this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                            ...effectOptions: unknown[],
                                        ): EffectFrameGeneratorSet;
                                    },
                                >,
                            >,
                            AnimClipConfig,
                        >,
                        "computeTween",
                    >,
                >,
            ): {
                keyframesGenerator_play: () => (
                    { opacity?: undefined }
                    | { opacity: string }
                )[];
            };
        };
        "~trace": {
            defaultConfig: {};
            howOftenBuildGenerators: "on-every-play";
            immutableConfig: { composite: "replace" };
            buildFrameGenerators(
                this: Readonly<
                    Pick<
                        ConnectorExitClip<
                            Readonly<
                                StripDuplicateMethodAutocompletion<
                                    {
                                        defaultConfig?: Partial<(...)> & object;
                                        howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                        immutableConfig?: Partial<(...)> & object;
                                        buildFrameGenerators(
                                            this: Readonly<Pick<AnimClip<(...), (...)>, "computeTween">>,
                                            ...effectOptions: unknown[],
                                        ): EffectFrameGeneratorSet;
                                    },
                                >,
                            >,
                        >,
                        | "domElem"
                        | "getEffectDetails"
                        | "getStatus"
                        | "getStyles"
                        | "getTiming",
                    >,
                > & Readonly<
                    Pick<
                        AnimClip<
                            Readonly<
                                StripDuplicateMethodAutocompletion<
                                    {
                                        defaultConfig?: Partial<(...)> & object;
                                        howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                        immutableConfig?: Partial<(...)> & object;
                                        buildFrameGenerators(
                                            this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                            ...effectOptions: unknown[],
                                        ): EffectFrameGeneratorSet;
                                    },
                                >,
                            >,
                            AnimClipConfig,
                        >,
                        "computeTween",
                    >,
                >,
                direction?:
                    | "from-left"
                    | "from-top"
                    | "from-bottom"
                    | "from-right"
                    | "from-A"
                    | "from-B",
            ): { keyframesGenerator_play: () => Keyframe[] };
        };
    }
    Index

    Properties

    "~disappear": {
        defaultConfig: {};
        howOftenBuildGenerators: "on-first-play-only";
        immutableConfig: { composite: "replace"; duration: 0; easing: "linear" };
        buildFrameGenerators(
            this: Readonly<
                Pick<
                    ConnectorExitClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: Partial<(...)> & object;
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: Partial<(...)> & object;
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<(...), (...)>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                    >,
                    "domElem"
                    | "getEffectDetails"
                    | "getStatus"
                    | "getStyles"
                    | "getTiming",
                >,
            > & Readonly<
                Pick<
                    AnimClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: Partial<(...)> & object;
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: Partial<(...)> & object;
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                        AnimClipConfig,
                    >,
                    "computeTween",
                >,
            >,
        ): {};
    } = ...

    The connector element disappears instantaneously.

    Type Declaration

    • defaultConfig: {}
    • howOftenBuildGenerators: "on-first-play-only"
    • immutableConfig: { composite: "replace"; duration: 0; easing: "linear" }
    • buildFrameGenerators: function
      • Parameters

        • this: Readonly<
              Pick<
                  ConnectorExitClip<
                      Readonly<
                          StripDuplicateMethodAutocompletion<
                              {
                                  defaultConfig?: Partial<(...)> & object;
                                  howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                  immutableConfig?: Partial<(...)> & object;
                                  buildFrameGenerators(
                                      this: Readonly<Pick<AnimClip<(...), (...)>, "computeTween">>,
                                      ...effectOptions: unknown[],
                                  ): EffectFrameGeneratorSet;
                              },
                          >,
                      >,
                  >,
                  "domElem"
                  | "getEffectDetails"
                  | "getStatus"
                  | "getStyles"
                  | "getTiming",
              >,
          > & Readonly<
              Pick<
                  AnimClip<
                      Readonly<
                          StripDuplicateMethodAutocompletion<
                              {
                                  defaultConfig?: Partial<(...)> & object;
                                  howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                  immutableConfig?: Partial<(...)> & object;
                                  buildFrameGenerators(
                                      this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                      ...effectOptions: unknown[],
                                  ): EffectFrameGeneratorSet;
                              },
                          >,
                      >,
                      AnimClipConfig,
                  >,
                  "computeTween",
              >,
          >

        Returns {}

    "~fade-out": {
        defaultConfig: {};
        howOftenBuildGenerators: "on-first-play-only";
        immutableConfig: { composite: "replace" };
        buildFrameGenerators(
            this: Readonly<
                Pick<
                    ConnectorExitClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: Partial<(...)> & object;
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: Partial<(...)> & object;
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<(...), (...)>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                    >,
                    "domElem"
                    | "getEffectDetails"
                    | "getStatus"
                    | "getStyles"
                    | "getTiming",
                >,
            > & Readonly<
                Pick<
                    AnimClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: Partial<(...)> & object;
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: Partial<(...)> & object;
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                        AnimClipConfig,
                    >,
                    "computeTween",
                >,
            >,
        ): {
            keyframesGenerator_play: () => (
                { opacity?: undefined }
                | { opacity: string }
            )[];
        };
    } = ...

    The connector element fades out to 0 opacity.

    Type Declaration

    • defaultConfig: {}
    • howOftenBuildGenerators: "on-first-play-only"
    • immutableConfig: { composite: "replace" }
    • buildFrameGenerators: function
      • Parameters

        • this: Readonly<
              Pick<
                  ConnectorExitClip<
                      Readonly<
                          StripDuplicateMethodAutocompletion<
                              {
                                  defaultConfig?: Partial<(...)> & object;
                                  howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                  immutableConfig?: Partial<(...)> & object;
                                  buildFrameGenerators(
                                      this: Readonly<Pick<AnimClip<(...), (...)>, "computeTween">>,
                                      ...effectOptions: unknown[],
                                  ): EffectFrameGeneratorSet;
                              },
                          >,
                      >,
                  >,
                  "domElem"
                  | "getEffectDetails"
                  | "getStatus"
                  | "getStyles"
                  | "getTiming",
              >,
          > & Readonly<
              Pick<
                  AnimClip<
                      Readonly<
                          StripDuplicateMethodAutocompletion<
                              {
                                  defaultConfig?: Partial<(...)> & object;
                                  howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                  immutableConfig?: Partial<(...)> & object;
                                  buildFrameGenerators(
                                      this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                      ...effectOptions: unknown[],
                                  ): EffectFrameGeneratorSet;
                              },
                          >,
                      >,
                      AnimClipConfig,
                  >,
                  "computeTween",
              >,
          >

        Returns {
            keyframesGenerator_play: () => (
                { opacity?: undefined }
                | { opacity: string }
            )[];
        }

    "~trace": {
        defaultConfig: {};
        howOftenBuildGenerators: "on-every-play";
        immutableConfig: { composite: "replace" };
        buildFrameGenerators(
            this: Readonly<
                Pick<
                    ConnectorExitClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: Partial<(...)> & object;
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: Partial<(...)> & object;
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<(...), (...)>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                    >,
                    "domElem"
                    | "getEffectDetails"
                    | "getStatus"
                    | "getStyles"
                    | "getTiming",
                >,
            > & Readonly<
                Pick<
                    AnimClip<
                        Readonly<
                            StripDuplicateMethodAutocompletion<
                                {
                                    defaultConfig?: Partial<(...)> & object;
                                    howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                    immutableConfig?: Partial<(...)> & object;
                                    buildFrameGenerators(
                                        this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                        ...effectOptions: unknown[],
                                    ): EffectFrameGeneratorSet;
                                },
                            >,
                        >,
                        AnimClipConfig,
                    >,
                    "computeTween",
                >,
            >,
            direction?:
                | "from-left"
                | "from-top"
                | "from-bottom"
                | "from-right"
                | "from-A"
                | "from-B",
        ): { keyframesGenerator_play: () => Keyframe[] };
    } = ...

    The connector element is wiped off from the specified direction as if being erased.

    Type Declaration

    • defaultConfig: {}
    • howOftenBuildGenerators: "on-every-play"
    • immutableConfig: { composite: "replace" }
    • buildFrameGenerators: function
      • Parameters

        • this: Readonly<
              Pick<
                  ConnectorExitClip<
                      Readonly<
                          StripDuplicateMethodAutocompletion<
                              {
                                  defaultConfig?: Partial<(...)> & object;
                                  howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                  immutableConfig?: Partial<(...)> & object;
                                  buildFrameGenerators(
                                      this: Readonly<Pick<AnimClip<(...), (...)>, "computeTween">>,
                                      ...effectOptions: unknown[],
                                  ): EffectFrameGeneratorSet;
                              },
                          >,
                      >,
                  >,
                  "domElem"
                  | "getEffectDetails"
                  | "getStatus"
                  | "getStyles"
                  | "getTiming",
              >,
          > & Readonly<
              Pick<
                  AnimClip<
                      Readonly<
                          StripDuplicateMethodAutocompletion<
                              {
                                  defaultConfig?: Partial<(...)> & object;
                                  howOftenBuildGenerators?: "on-first-play-only" | "on-every-play";
                                  immutableConfig?: Partial<(...)> & object;
                                  buildFrameGenerators(
                                      this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<{ defaultConfig?: (Partial<unknown> & object) | undefined; immutableConfig?: (Partial<unknown> & object) | undefined; howOftenBuildGenerators?: "on-first-play-only" | "on-every-play" | undefined; buildFrameGenerators(this: Readonly<Pick<AnimClip<Readonly<StripDuplicateMethodAutocompletion<any>>, AnimClipConfig>, "computeTween">>, ...effectOptions: unknown[]): EffectFrameGeneratorSet; }>>, AnimClipConfig>, "computeTween">>,
                                      ...effectOptions: unknown[],
                                  ): EffectFrameGeneratorSet;
                              },
                          >,
                      >,
                      AnimClipConfig,
                  >,
                  "computeTween",
              >,
          >
        • direction: "from-left" | "from-top" | "from-bottom" | "from-right" | "from-A" | "from-B" = 'from-A'

          The direction from which the connector should be traced.

        Returns { keyframesGenerator_play: () => Keyframe[] }