Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Control

Control object for animation.

Hierarchy

Index

Methods

  • catch<TResult>(onrejected?: (reason: any) => TResult | PromiseLike<TResult>): Promise<Vizzu | TResult>
  • Attaches a callback for only the rejection of the Promise.

    Type parameters

    • TResult = never

    Parameters

    • Optional onrejected: (reason: any) => TResult | PromiseLike<TResult>

      The callback to execute when the Promise is rejected.

        • (reason: any): TResult | PromiseLike<TResult>
        • Parameters

          • reason: any

          Returns TResult | PromiseLike<TResult>

    Returns Promise<Vizzu | TResult>

    A Promise for the completion of the callback.

  • pause(): void
  • play(): void
  • reverse(): void
  • seek(value: `${number}%` | Duration): void
  • Seeks the animation to the position specified by time or progress percentage. Seeking the animation to the end position will not trigger the (@link Vizzu.animate|animation promise) to resolve.

    Parameters

    Returns void

  • stop(): void
  • then<TResult1, TResult2>(onfulfilled?: (value: Vizzu) => TResult1 | PromiseLike<TResult1>, onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>
  • Attaches callbacks for the resolution and/or rejection of the Promise.

    Type parameters

    • TResult1 = Vizzu

    • TResult2 = never

    Parameters

    • Optional onfulfilled: (value: Vizzu) => TResult1 | PromiseLike<TResult1>

      The callback to execute when the Promise is resolved.

        • (value: Vizzu): TResult1 | PromiseLike<TResult1>
        • Parameters

          Returns TResult1 | PromiseLike<TResult1>

    • Optional onrejected: (reason: any) => TResult2 | PromiseLike<TResult2>

      The callback to execute when the Promise is rejected.

        • (reason: any): TResult2 | PromiseLike<TResult2>
        • Parameters

          • reason: any

          Returns TResult2 | PromiseLike<TResult2>

    Returns Promise<TResult1 | TResult2>

    A Promise for the completion of which ever callback is executed.

Generated using TypeDoc