Class LottieClip

Hierarchy (View Summary)

Clip<Sprite, ClipStyle<Sprite>>
- LottieClip

Index

Constructors

Properties

animationController id sprite state style

Methods

addClipMask addEffect addFilter clearAllCustomData clone destroy discardProcessing generateNewId getAllCustomData getBlendMode getCustomData getDuration getEffectById getEffects getEndTime getFilterById getFilters getGroups getHasTransition getId getIsProcessing getLeftBound getLeftTrim getMasks getMediaId getName getProperties getProperty getPropertyValue getRightBound getRightTrim getStartTime getSubtitlesId getSubtitlesOffset getTrimmedDuration getType getVisible getWrapMode hasCustomData hasName hasSprite hitTest init isActive isReady moveBy onPause onPlay onRenderDone onRenderStart onResize postRender preload removeAllEffectsByEffectId removeClipMask removeEffect removeFilter removeSubtitles render replaceFillColor replaceImage replaceStrokeColor replaceStrokeWidth replaceText resetAllAnimationProperties serialize setAllCustomData setBlendMode setCustomData setHasTransition setLeftTrim setName setProperty setRightTrim setStartTime setSubtitles setSubtitlesId setSubtitlesOffset setVisible setWrapMode update updateMediaData updateVisibility deserialize

Constructors

constructor

new LottieClip(options: LottieClipOptions): LottieClip
Parameters
- options: LottieClipOptions
Returns LottieClip
Overrides Clip.constructor

Properties

`Readonly`animationController

animationController: (Anonymous class)<Sprite>

id

id: string

sprite

sprite: Sprite

state

state: ClipState

style

style: ClipStyle

Methods

addClipMask

addClipMask(clip: Clip, options?: MaskOptions): undefined | MaskFilter
Parameters
- clip: Clip
- Optionaloptions: MaskOptions
Returns undefined | MaskFilter
Inherited from Clip.addClipMask

addEffect

addEffect(effect: Effect): Effect
Parameters
- effect: Effect
Returns Effect
Inherited from Clip.addEffect
addEffect(effectId: string, properties?: Record<string, any>): Effect
Parameters
- effectId: string
- Optionalproperties: Record<string, any>
Returns Effect
Inherited from Clip.addEffect

addFilter

addFilter(filter: Filter): Filter
Parameters
- filter: Filter
Returns Filter
Inherited from Clip.addFilter
addFilter(filterId: string): Filter
Parameters
- filterId: string
Returns Filter
Inherited from Clip.addFilter

clearAllCustomData

clearAllCustomData(): void
Returns void
Inherited from Clip.clearAllCustomData

clone

clone(): LottieClip
Returns LottieClip
Overrides Clip.clone

destroy

destroy(): void
Returns void
Overrides Clip.destroy

discardProcessing

discardProcessing(): void
Returns void
Inherited from Clip.discardProcessing

generateNewId

generateNewId(): void
Returns void
Inherited from Clip.generateNewId

getAllCustomData

getAllCustomData(): undefined | Map<string, unknown>
Returns undefined | Map<string, unknown>
Inherited from Clip.getAllCustomData

getBlendMode

getBlendMode(): BlendModeEnum
Returns BlendModeEnum
Inherited from Clip.getBlendMode

getCustomData

getCustomData(key: string): unknown
Parameters
- key: string
Returns unknown
Inherited from Clip.getCustomData

getDuration

getDuration(): number
Returns number
Inherited from Clip.getDuration

getEffectById

getEffectById(effectId: string): undefined | Effect
Parameters
- effectId: string
Returns undefined | Effect
Inherited from Clip.getEffectById

getEffects

getEffects(): Effect[]
Returns Effect[]
Inherited from Clip.getEffects

getEndTime

getEndTime(): number
Returns number
Inherited from Clip.getEndTime

getFilterById

getFilterById(filterId: string): undefined | Filter
Parameters
- filterId: string
Returns undefined | Filter
Inherited from Clip.getFilterById

getFilters

getFilters(): Filter[]
Returns Filter[]
Inherited from Clip.getFilters

getGroups

getGroups(): { id: string; label: string }[]
Returns { id: string; label: string }[]

getHasTransition

getHasTransition(): boolean
Returns boolean
Inherited from Clip.getHasTransition

getId

getId(): string
Returns string
Inherited from Clip.getId

getIsProcessing

getIsProcessing(): boolean
Returns boolean
Inherited from Clip.getIsProcessing

getLeftBound

getLeftBound(): number
Returns number
Inherited from Clip.getLeftBound

getLeftTrim

getLeftTrim(): number
Returns number
Inherited from Clip.getLeftTrim

getMasks

getMasks(): MaskFilter[]
Returns MaskFilter[]
Inherited from Clip.getMasks

getMediaId

getMediaId(): undefined | string
Returns undefined | string
Inherited from Clip.getMediaId

getName

getName(): string
Returns string
Inherited from Clip.getName

getProperties

getProperties(): Map<
    string,
    {
        group?: string;
        id: string;
        label: string;
        path: string;
        type: LottiePropertyTypeEnum;
        value?: unknown;
    },
>
Returns Map<
    string,
    {
        group?: string;
        id: string;
        label: string;
        path: string;
        type: LottiePropertyTypeEnum;
        value?: unknown;
    },
>

getProperty

getProperty(
    propertyId: string,
):
    | undefined
    | {
        group?: string;
        id: string;
        label: string;
        path: string;
        type: LottiePropertyTypeEnum;
        value?: unknown;
    }
Parameters
- propertyId: string
Returns
    | undefined
    | {
        group?: string;
        id: string;
        label: string;
        path: string;
        type: LottiePropertyTypeEnum;
        value?: unknown;
    }

getPropertyValue

getPropertyValue(propertyId: string): any
Parameters
- propertyId: string
Returns any

getRightBound

getRightBound(): number
Returns number
Inherited from Clip.getRightBound

getRightTrim

getRightTrim(): number
Returns number
Inherited from Clip.getRightTrim

getStartTime

getStartTime(): number
Returns number
Inherited from Clip.getStartTime

getSubtitlesId

getSubtitlesId(): undefined | string
Returns undefined | string
Inherited from Clip.getSubtitlesId

getSubtitlesOffset

getSubtitlesOffset(): number
Returns number
Inherited from Clip.getSubtitlesOffset

getTrimmedDuration

getTrimmedDuration(): number
Returns number
Inherited from Clip.getTrimmedDuration

getType

getType(): string
Returns string
Inherited from Clip.getType

getVisible

getVisible(): boolean
Returns boolean
Inherited from Clip.getVisible

getWrapMode

getWrapMode(): WrapModeEnum
Returns WrapModeEnum
Inherited from Clip.getWrapMode

hasCustomData

hasCustomData(key: string): boolean
Parameters
- key: string
Returns boolean
Inherited from Clip.hasCustomData

hasName

hasName(): boolean
Returns boolean
Inherited from Clip.hasName

hasSprite

hasSprite(): boolean
Returns boolean
Inherited from Clip.hasSprite

hitTest

hitTest(
point: { cursorX: number; cursorY: number },
ignoreVisibility?: boolean,
): boolean
Parameters
- point: { cursorX: number; cursorY: number }
- OptionalignoreVisibility: boolean
Returns boolean
Inherited from Clip.hitTest

init

init(layerId: string): Promise<void>
Parameters
- layerId: string
Returns Promise<void>
Overrides Clip.init

isActive

isActive(currentTime: number): boolean
Parameters
- currentTime: number
Returns boolean
Inherited from Clip.isActive

isReady

isReady(): boolean
Returns boolean
Inherited from Clip.isReady

moveBy

moveBy(amount: number): void
Parameters
- amount: number
Returns void
Inherited from Clip.moveBy

onPause

onPause(currentTime: number): Promise<void>
Parameters
- currentTime: number
Returns Promise<void>
Inherited from Clip.onPause

onPlay

onPlay(currentTime: number): Promise<void>
Parameters
- currentTime: number
Returns Promise<void>
Inherited from Clip.onPlay

onRenderDone

onRenderDone(canceled: boolean): Promise<void>
Parameters
- canceled: boolean
Returns Promise<void>
Inherited from Clip.onRenderDone

onRenderStart

onRenderStart(options: ExportOptions): Promise<void>
Parameters
- options: ExportOptions
Returns Promise<void>
Inherited from Clip.onRenderStart

onResize

onResize(width: number, height: number): Promise<void>
Parameters
- width: number
- height: number
Returns Promise<void>
Inherited from Clip.onResize

postRender

postRender(currentTime: number): void
Parameters
- currentTime: number
  The current time of the timeline
Returns void
Description
This is called after all the clips have been rendered in the preview, useful if you want to change some other clip states after rendering

Inherited from Clip.postRender

preload

preload(currentTime: number): void
Parameters
- currentTime: number
Returns void
Overrides Clip.preload

removeAllEffectsByEffectId

removeAllEffectsByEffectId(effectId: string): void
Parameters
- effectId: string
Returns void
Inherited from Clip.removeAllEffectsByEffectId

removeClipMask

removeClipMask(clip: Clip): void
Parameters
- clip: Clip
Returns void
Inherited from Clip.removeClipMask

removeEffect

removeEffect(id: string): void
Parameters
- id: string
Returns void
Inherited from Clip.removeEffect

removeFilter

removeFilter(id: string): void
Parameters
- id: string
Returns void
Inherited from Clip.removeFilter

removeSubtitles

removeSubtitles(): void
Returns void
Inherited from Clip.removeSubtitles

render

render(currentTime: number): void
Parameters
- currentTime: number
Returns void
Inherited from Clip.render

replaceFillColor

replaceFillColor(path: string | number, color: number[]): void
Parameters
- path: string | number
- color: number[]
Returns void

replaceImage

replaceImage(layerId: string | number, url: string): void
Parameters
- layerId: string | number
- url: string
Returns void

replaceStrokeColor

replaceStrokeColor(path: string | number, color: number[]): void
Parameters
- path: string | number
- color: number[]
Returns void

replaceStrokeWidth

replaceStrokeWidth(path: string | number, width: number): void
Parameters
- path: string | number
- width: number
Returns void

replaceText

replaceText(path: string | number, text: string): void
Parameters
- path: string | number
- text: string
Returns void

resetAllAnimationProperties

resetAllAnimationProperties(): void
Returns void
Inherited from Clip.resetAllAnimationProperties

serialize

serialize(): {
    animationController?: {
        animationDataIn?: {
            amplification?: number;
            inOutOfRange: OutOfRangeEnum;
            name: string;
            offset?: number;
            outOutOfRange: OutOfRangeEnum;
            propertyAnimations: {
                inOutOfRange: OutOfRangeEnum;
                keyframes: {
                    easing: EasingEnum;
                    relativeProperty?: string;
                    space: AnimationSpaceEnum;
                    time: number;
                    value: string
                    | number;
                }[];
                outOutOfRange: OutOfRangeEnum;
                property: string;
            }[];
            speed?: number;
        };
        animationDataLoop?: {
            amplification?: number;
            inOutOfRange: OutOfRangeEnum;
            name: string;
            offset?: number;
            outOutOfRange: OutOfRangeEnum;
            propertyAnimations: {
                inOutOfRange: OutOfRangeEnum;
                keyframes: {
                    easing: EasingEnum;
                    relativeProperty?: string;
                    space: AnimationSpaceEnum;
                    time: number;
                    value: string
                    | number;
                }[];
                outOutOfRange: OutOfRangeEnum;
                property: string;
            }[];
            speed?: number;
        };
        animationDataOut?: {
            amplification?: number;
            inOutOfRange: OutOfRangeEnum;
            name: string;
            offset?: number;
            outOutOfRange: OutOfRangeEnum;
            propertyAnimations: {
                inOutOfRange: OutOfRangeEnum;
                keyframes: {
                    easing: EasingEnum;
                    relativeProperty?: string;
                    space: AnimationSpaceEnum;
                    time: number;
                    value: string
                    | number;
                }[];
                outOutOfRange: OutOfRangeEnum;
                property: string;
            }[];
            speed?: number;
        };
        animationInDuration: number;
        animationLoopCount: number;
        animationOutDuration: number;
        loopSmoothing: number;
    };
    assetsUrl?: string;
    blendMode?: NORMAL
    | ADD
    | SCREEN
    | MULTIPLY;
    clipMasks?: { clipId: string; id: string; wrapMode: MaskWrapModeEnum }[];
    customData?: [string, unknown][];
    dataUrl: string;
    duration: number;
    effects: any[];
    filters: {
        clipId?: string;
        filterId: string;
        id: string;
        intensity: number;
        provider: string;
    }[];
    groups?: { id: string; label: string }[];
    id: string;
    isVisible: boolean;
    leftTrim: number;
    mediaDataId?: string;
    name?: string;
    properties?: {
        group?: string;
        id: string;
        label: string;
        path: string;
        type: LottiePropertyTypeEnum;
        value?: unknown;
    }[];
    propertiesUrl?: string;
    rightTrim: number;
    startTime: number;
    style?: unknown;
    subtitlesId?: string;
    subtitlesOffset: number;
    text?: string;
    type: string;
    wrapMode?: CLAMP
    | REPEAT
    | PING_PONG
    | EMPTY;
}
Returns {
    animationController?: {
        animationDataIn?: {
            amplification?: number;
            inOutOfRange: OutOfRangeEnum;
            name: string;
            offset?: number;
            outOutOfRange: OutOfRangeEnum;
            propertyAnimations: {
                inOutOfRange: OutOfRangeEnum;
                keyframes: {
                    easing: EasingEnum;
                    relativeProperty?: string;
                    space: AnimationSpaceEnum;
                    time: number;
                    value: string | number;
                }[];
                outOutOfRange: OutOfRangeEnum;
                property: string;
            }[];
            speed?: number;
        };
        animationDataLoop?: {
            amplification?: number;
            inOutOfRange: OutOfRangeEnum;
            name: string;
            offset?: number;
            outOutOfRange: OutOfRangeEnum;
            propertyAnimations: {
                inOutOfRange: OutOfRangeEnum;
                keyframes: {
                    easing: EasingEnum;
                    relativeProperty?: string;
                    space: AnimationSpaceEnum;
                    time: number;
                    value: string
                    | number;
                }[];
                outOutOfRange: OutOfRangeEnum;
                property: string;
            }[];
            speed?: number;
        };
        animationDataOut?: {
            amplification?: number;
            inOutOfRange: OutOfRangeEnum;
            name: string;
            offset?: number;
            outOutOfRange: OutOfRangeEnum;
            propertyAnimations: {
                inOutOfRange: OutOfRangeEnum;
                keyframes: {
                    easing: EasingEnum;
                    relativeProperty?: string;
                    space: AnimationSpaceEnum;
                    time: number;
                    value: string
                    | number;
                }[];
                outOutOfRange: OutOfRangeEnum;
                property: string;
            }[];
            speed?: number;
        };
        animationInDuration: number;
        animationLoopCount: number;
        animationOutDuration: number;
        loopSmoothing: number;
    };
    assetsUrl?: string;
    blendMode?: NORMAL
    | ADD
    | SCREEN
    | MULTIPLY;
    clipMasks?: { clipId: string; id: string; wrapMode: MaskWrapModeEnum }[];
    customData?: [string, unknown][];
    dataUrl: string;
    duration: number;
    effects: any[];
    filters: {
        clipId?: string;
        filterId: string;
        id: string;
        intensity: number;
        provider: string;
    }[];
    groups?: { id: string; label: string }[];
    id: string;
    isVisible: boolean;
    leftTrim: number;
    mediaDataId?: string;
    name?: string;
    properties?: {
        group?: string;
        id: string;
        label: string;
        path: string;
        type: LottiePropertyTypeEnum;
        value?: unknown;
    }[];
    propertiesUrl?: string;
    rightTrim: number;
    startTime: number;
    style?: unknown;
    subtitlesId?: string;
    subtitlesOffset: number;
    text?: string;
    type: string;
    wrapMode?: CLAMP
    | REPEAT
    | PING_PONG
    | EMPTY;
}
Overrides Clip.serialize

setAllCustomData

setAllCustomData(data: Map<string, unknown>): void
Parameters
- data: Map<string, unknown>
Returns void
Inherited from Clip.setAllCustomData

setBlendMode

setBlendMode(blendMode: BlendModeEnum): void
Parameters
- blendMode: BlendModeEnum
Returns void
Inherited from Clip.setBlendMode

setCustomData

setCustomData(key: string, value: unknown, overwrite?: boolean): boolean
Parameters
- key: string
- value: unknown
- overwrite: boolean = true
Returns boolean
Inherited from Clip.setCustomData

setHasTransition

setHasTransition(hasTransition: boolean): void
Parameters
- hasTransition: boolean
Returns void
Inherited from Clip.setHasTransition

setLeftTrim

setLeftTrim(trim: number): void
Parameters
- trim: number
Returns void
Inherited from Clip.setLeftTrim

setName

setName(name: string): void
Parameters
- name: string
Returns void
Inherited from Clip.setName

setProperty

setProperty(propertyId: string, value: unknown): void
Parameters
- propertyId: string
- value: unknown
Returns void

setRightTrim

setRightTrim(trim: number): void
Parameters
- trim: number
Returns void
Inherited from Clip.setRightTrim

setStartTime

setStartTime(startTime: number): void
Parameters
- startTime: number
Returns void
Inherited from Clip.setStartTime

setSubtitles

setSubtitles(subtitlesId: string, offset?: number): void
Parameters
- subtitlesId: string
- offset: number = 0
Returns void
Inherited from Clip.setSubtitles

setSubtitlesId

setSubtitlesId(subtitlesId: string): void
Parameters
- subtitlesId: string
Returns void
Inherited from Clip.setSubtitlesId

setSubtitlesOffset

setSubtitlesOffset(offset: number): void
Parameters
- offset: number
Returns void
Inherited from Clip.setSubtitlesOffset

setVisible

setVisible(visible: boolean): void
Parameters
- visible: boolean
Returns void
Inherited from Clip.setVisible

setWrapMode

setWrapMode(wrapMode: WrapModeEnum): void
Parameters
- wrapMode: WrapModeEnum
Returns void
Inherited from Clip.setWrapMode

update

update(currentTime: number): void
Parameters
- currentTime: number
Returns void
Overrides Clip.update

updateMediaData

updateMediaData(newMediaId?: string): Promise<boolean>
Parameters
- OptionalnewMediaId: string
Returns Promise<boolean>
Inherited from Clip.updateMediaData

updateVisibility

updateVisibility(currentTime: number): void
Parameters
- currentTime: number
Returns void
Overrides Clip.updateVisibility

`Static`deserialize

deserialize(payload: object): LottieClip
Parameters
- payload: object
Returns LottieClip
Overrides Clip.deserialize

Class LottieClip

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LottieClip

Properties

ReadonlyanimationController

id

sprite

state

style

Methods

addClipMask

Parameters

Returns undefined | MaskFilter

addEffect

Parameters

Returns Effect

Parameters

Returns Effect

addFilter

Parameters

Returns Filter

Parameters

Returns Filter

clearAllCustomData

Returns void

clone

Returns LottieClip

destroy

Returns void

discardProcessing

Returns void

generateNewId

Returns void

getAllCustomData

Returns undefined | Map<string, unknown>

getBlendMode

Returns BlendModeEnum

getCustomData

Parameters

Returns unknown

getDuration

Returns number

getEffectById

Parameters

Returns undefined | Effect

getEffects

Returns Effect[]

getEndTime

Returns number

getFilterById

Parameters

Returns undefined | Filter

getFilters

Returns Filter[]

getGroups

Returns { id: string; label: string }[]

getHasTransition

Returns boolean

getId

Returns string

getIsProcessing

Returns boolean

getLeftBound

Returns number

getLeftTrim

Returns number

getMasks

Returns MaskFilter[]

getMediaId

Returns undefined | string

getName

Returns string

getProperties

`Readonly`animationController

Returns Map<
string,
{
group?: string;
id: string;
label: string;
path: string;
type: LottiePropertyTypeEnum;
value?: unknown;
},
>

Returns
| undefined
| {
group?: string;
id: string;
label: string;
path: string;
type: LottiePropertyTypeEnum;
value?: unknown;
}