Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LottieProgressPlayer

Hierarchy

  • LottieProgressPlayer

Implements

Index

Constructors

constructor

Methods

createLottie

  • createLottie(): void

dispose

  • dispose(): void

getLottieInstance

  • getLottieInstance(): object
  • Returns object

    • animationID: string
    • assetsPath: string
    • autoplay: boolean
    • currentFrame: number
    • currentRawFrame: number
    • firstFrame: number
    • frameMult: number
    • frameRate: number
    • isLoaded: boolean
    • isPaused: boolean
    • isSubframeEnabled: boolean
    • loop: boolean
    • name: string
    • playCount: number
    • playDirection: number
    • playSpeed: number
    • renderer: any
    • segmentPos: number
    • segments: AnimationSegment | AnimationSegment[]
    • timeCompleted: number
    • totalFrames: number
    • addEventListener: function
      • addEventListener<T>(name: AnimationEventName, callback: AnimationEventCallback<T>): void
      • Type parameters

        • T

        Parameters

        • name: AnimationEventName
        • callback: AnimationEventCallback<T>

        Returns void

    • destroy: function
      • destroy(name: string): void
      • Parameters

        • Optional name: string

        Returns void

    • getDuration: function
      • getDuration(inFrames: boolean): number
      • Parameters

        • Optional inFrames: boolean

        Returns number

    • goToAndPlay: function
      • goToAndPlay(value: number, isFrame: boolean, name: string): void
      • Parameters

        • value: number
        • Optional isFrame: boolean
        • Optional name: string

        Returns void

    • goToAndStop: function
      • goToAndStop(value: number, isFrame: boolean, name: string): void
      • Parameters

        • value: number
        • Optional isFrame: boolean
        • Optional name: string

        Returns void

    • hide: function
      • hide(): void
      • Returns void

    • includeLayers: function
      • includeLayers(data: any): void
      • Parameters

        • data: any

        Returns void

    • pause: function
      • pause(name: string): void
      • Parameters

        • Optional name: string

        Returns void

    • play: function
      • play(name: string): void
      • Parameters

        • Optional name: string

        Returns void

    • playSegments: function
      • playSegments(segments: AnimationSegment | AnimationSegment[], forceFlag: boolean): void
      • Parameters

        • segments: AnimationSegment | AnimationSegment[]
        • Optional forceFlag: boolean

        Returns void

    • removeEventListener: function
      • removeEventListener<T>(name: AnimationEventName, callback: AnimationEventCallback<T>): void
      • Type parameters

        • T

        Parameters

        • name: AnimationEventName
        • callback: AnimationEventCallback<T>

        Returns void

    • resetSegments: function
      • resetSegments(forceFlag: boolean): void
      • Parameters

        • forceFlag: boolean

        Returns void

    • resize: function
      • resize(): void
      • Returns void

    • setDirection: function
      • setDirection(direction: AnimationDirection): void
      • Parameters

        • direction: AnimationDirection

        Returns void

    • setSegment: function
      • setSegment(init: number, end: number): void
      • Parameters

        • init: number
        • end: number

        Returns void

    • setSpeed: function
      • setSpeed(speed: number): void
      • Parameters

        • speed: number

        Returns void

    • setSubframe: function
      • setSubframe(useSubFrames: boolean): void
      • Parameters

        • useSubFrames: boolean

        Returns void

    • show: function
      • show(): void
      • Returns void

    • stop: function
      • stop(name: string): void
      • Parameters

        • Optional name: string

        Returns void

    • togglePause: function
      • togglePause(name: string): void
      • Parameters

        • Optional name: string

        Returns void

    • triggerEvent: function
      • triggerEvent<T>(name: AnimationEventName, args: T): void
      • Type parameters

        • T

        Parameters

        • name: AnimationEventName
        • args: T

        Returns void

getProgress

  • getProgress(): number

off

on

setFrame

  • setFrame(frame: number): void

setProgress

  • setProgress(progress: number): void