Class TimelineMax

Hierarchy

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(vars?: Object): TimelineMax

Parameters

  • vars?: Object optional

Returns

TimelineMax

Properties

public autoRemoveChildren: boolean

public data: any

public smoothChildTiming: boolean

public timeline: SimpleTimeline

public vars: Object

Methods

public add(value: any, position?: any, align?: string, stagger?: number): any

Parameters

  • value: any
  • position?: any optional
  • align?: string optional
  • stagger?: number optional

Returns

any

public addCallback(callback: Function, position: any, params?: Array<any>, scope?: any): TimelineMax

Parameters

  • callback: Function
  • position: any
  • params?: Array<any> optional
  • scope?: any optional

Returns

TimelineMax

public addLabel(label: string, position: any): any

Parameters

  • label: string
  • position: any

Returns

any

public addPause(position?: any, callback?: Function, params?: Array<any>, scope?: any): any

Parameters

  • position?: any optional
  • callback?: Function optional
  • params?: Array<any> optional
  • scope?: any optional

Returns

any

public append(value: any, offsetOrLabel?: any): any

Parameters

  • value: any
  • offsetOrLabel?: any optional

Returns

any

public appendMultiple(tweens: Array<any>, offsetOrLabel?: any, align?: string, stagger?: number): any

Parameters

  • tweens: Array<any>
  • offsetOrLabel?: any optional
  • align?: string optional
  • stagger?: number optional

Returns

any

public call(callback: Function, params?: Array<any>, scope?: any, position?: any): any

Parameters

  • callback: Function
  • params?: Array<any> optional
  • scope?: any optional
  • position?: any optional

Returns

any

public clear(labels?: boolean): any

Parameters

  • labels?: boolean optional

Returns

any

public currentLabel(value?: string): any

Parameters

  • value?: string optional

Returns

any

public delay(value: number): any

Parameters

  • value: number

Returns

any

public duration(value: number): any

Parameters

  • value: number

Returns

any

public eventCallback(type: string, callback?: Function, params?: Array<any>, scope?: any): any

Parameters

  • type: string
  • callback?: Function optional
  • params?: Array<any> optional
  • scope?: any optional

Returns

any

public exportRoot(vars?: Object, omitDelayedCalls?: boolean): TimelineLite

Parameters

  • vars?: Object optional
  • omitDelayedCalls?: boolean optional

Returns

TimelineLite

public fromTo(target: Object, duration: number, fromVars: Object, toVars: Object, position?: any): any

Parameters

  • target: Object
  • duration: number
  • fromVars: Object
  • toVars: Object
  • position?: any optional

Returns

any

public getActive(nested?: boolean, tweens?: boolean, timelines?: boolean): Array<any>

Parameters

  • nested?: boolean optional
  • tweens?: boolean optional
  • timelines?: boolean optional

Returns

Array<any>

public getChildren(nested?: boolean, tweens?: boolean, timelines?: boolean, ignoreBeforeTime?: number): Array<any>

Parameters

  • nested?: boolean optional
  • tweens?: boolean optional
  • timelines?: boolean optional
  • ignoreBeforeTime?: number optional

Returns

Array<any>

public getLabelAfter(time: number): string

Parameters

  • time: number

Returns

string

public getLabelBefore(time: number): string

Parameters

  • time: number

Returns

string

public getLabelTime(label: string): number

Parameters

  • label: string

Returns

number

public getLabelsArray(): Array<any>

Returns

Array<any>

public getTweensOf(target: Object, nested?: boolean): Array<any>

Parameters

  • target: Object
  • nested?: boolean optional

Returns

Array<any>

public insert(value: any, timeOrLabel?: any): any

Parameters

  • value: any
  • timeOrLabel?: any optional

Returns

any

public insertMultiple(tweens: Array<any>, timeOrLabel?: any, align?: string, stagger?: number): any

Parameters

  • tweens: Array<any>
  • timeOrLabel?: any optional
  • align?: string optional
  • stagger?: number optional

Returns

any

public invalidate(): any

Returns

any

public isActive(): boolean

Returns

boolean

public kill(vars?: Object, target?: Object): any

Parameters

  • vars?: Object optional
  • target?: Object optional

Returns

any

public pause(atTime?: any, suppressEvents?: boolean): any

Parameters

  • atTime?: any optional
  • suppressEvents?: boolean optional

Returns

any

public paused(value?: boolean): any

Parameters

  • value?: boolean optional

Returns

any

public play(from?: any, suppressEvents?: boolean): any

Parameters

  • from?: any optional
  • suppressEvents?: boolean optional

Returns

any

public progress(value: number): any

Parameters

  • value: number

Returns

any

public remove(value: any): any

Parameters

  • value: any

Returns

any

public removeCallback(callback: Function, timeOrLabel?: any): TimelineMax

Parameters

  • callback: Function
  • timeOrLabel?: any optional

Returns

TimelineMax

public removeLabel(label: string): any

Parameters

  • label: string

Returns

any

public render(time: number, suppressEvents?: boolean, force?: boolean)

Parameters

  • time: number
  • suppressEvents?: boolean optional
  • force?: boolean optional

public repeat(value?: number): any

Parameters

  • value?: number optional

Returns

any

public repeatDelay(value?: number): any

Parameters

  • value?: number optional

Returns

any

public restart(includeDelay?: boolean, suppressEvents?: boolean): any

Parameters

  • includeDelay?: boolean optional
  • suppressEvents?: boolean optional

Returns

any

public resume(from?: any, suppressEvents?: boolean): any

Parameters

  • from?: any optional
  • suppressEvents?: boolean optional

Returns

any

public reverse(from?: any, suppressEvents?: boolean): any

Parameters

  • from?: any optional
  • suppressEvents?: boolean optional

Returns

any

public reversed(value?: boolean): any

Parameters

  • value?: boolean optional

Returns

any

public seek(position: any, suppressEvents?: boolean): any

Parameters

  • position: any
  • suppressEvents?: boolean optional

Returns

any

public set(target: Object, vars: Object, position?: any): any

Parameters

  • target: Object
  • vars: Object
  • position?: any optional

Returns

any

public shiftChildren(amount: number, adjustLabels?: boolean, ignoreBeforeTime?: number): any

Parameters

  • amount: number
  • adjustLabels?: boolean optional
  • ignoreBeforeTime?: number optional

Returns

any

public staggerFrom(targets: Array<any>, duration: number, vars: Object, stagger?: number, position?: any, onCompleteAll?: Function, onCompleteAllParams?: Array<any>, onCompleteScope?: any): any

Parameters

  • targets: Array<any>
  • duration: number
  • vars: Object
  • stagger?: number optional
  • position?: any optional
  • onCompleteAll?: Function optional
  • onCompleteAllParams?: Array<any> optional
  • onCompleteScope?: any optional

Returns

any

public staggerFromTo(targets: Array<any>, duration: number, fromVars: Object, toVars: Object, stagger?: number, position?: any, onCompleteAll?: Function, onCompleteAllParams?: Array<any>, onCompleteAllScope?: any): any

Parameters

  • targets: Array<any>
  • duration: number
  • fromVars: Object
  • toVars: Object
  • stagger?: number optional
  • position?: any optional
  • onCompleteAll?: Function optional
  • onCompleteAllParams?: Array<any> optional
  • onCompleteAllScope?: any optional

Returns

any

public staggerTo(targets: Array<any>, duration: number, vars: Object, stagger: number, position?: any, onCompleteAll?: Function, onCompleteAllParams?: Array<any>, onCompleteAllScope?: any): any

Parameters

  • targets: Array<any>
  • duration: number
  • vars: Object
  • stagger: number
  • position?: any optional
  • onCompleteAll?: Function optional
  • onCompleteAllParams?: Array<any> optional
  • onCompleteAllScope?: any optional

Returns

any

public startTime(value: number): any

Parameters

  • value: number

Returns

any

public stop(): any

Returns

any

public time(value: number, suppressEvents?: boolean): any

Parameters

  • value: number
  • suppressEvents?: boolean optional

Returns

any

public timeScale(value: number): any

Parameters

  • value: number

Returns

any

public to(target: Object, duration: number, vars: Object, position?: any): any

Parameters

  • target: Object
  • duration: number
  • vars: Object
  • position?: any optional

Returns

any

public totalDuration(value: number): any

Parameters

  • value: number

Returns

any

public totalProgress(value: number): any

Parameters

  • value: number

Returns

any

public totalTime(time: number, suppressEvents?: boolean): any

Parameters

  • time: number
  • suppressEvents?: boolean optional

Returns

any

public tweenFromTo(fromPosition: any, toPosition: any, vars?: Object): TweenLite

Parameters

  • fromPosition: any
  • toPosition: any
  • vars?: Object optional

Returns

TweenLite

public tweenTo(position: any, vars?: Object): TweenLite

Parameters

  • position: any
  • vars?: Object optional

Returns

TweenLite

public usesFrames(): Boolean

Returns

Boolean

public yoyo(value?: boolean): any

Parameters

  • value?: boolean optional

Returns

any