Interface FlashTimeline

Index

Properties

Methods

Properties

public currentFrame: number

A zero-based index for the frame at the current

public currentLayer: number

A zero-based index for the currently active layer.

public frameCount: number

Read-only; an integer that represents the number of

public layerCount: number

Read-only; an integer that represents the number of

public layers: FlashLayer[]

Read-only; an array of layer objects.

public name: string

A string that represents the name of the current

Methods

public addMotionGuide(): number

Adds a motion guide layer above the current layer and attaches the current layer to the newly added guide layer.

Returns

number

public addNewLayer(name?: string, layerType?: string, bAddAbove?: boolean): any

Adds a new layer to the document and makes it the current layer.

Parameters

  • name?: string optional
  • layerType?: string optional
  • bAddAbove?: boolean optional

Returns

any

public clearFrames(startFrameIndex?: number, endFrameIndex?: number)

Deletes all the contents from a frame or range of frames on the current layer.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public clearKeyframes(startFrameIndex?: number, endFrameIndex?: number)

Converts a keyframe to a regular frame and deletes its contents on the current layer.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public convertToBlankKeyframes(startFrameIndex?: number, endFrameIndex?: number)

Converts frames to blank keyframes on the current layer.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public convertToKeyframes(startFrameIndex?: number, endFrameIndex?: number)

Converts a range of frames to keyframes (or converts the selection if no frames are specified) on the current layer.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public copyFrames(startFrameIndex?: number, endFrameIndex?: number)

Copies a range of frames on the current layer to the clipboard.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public copyLayers(startFrameIndex?: number, endFrameIndex?: number)

Copies a range of Timeline layers to the clipboard.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public copyMotion()

Copies motion on selected frames, either from a motion tween or from frame - by - frame animation, so it can be applied to other frames.

public copyMotionAsAS3()

Copies motion on selected frames, either from a motion tween or from frame - by - frame animation, to the clipboard as ActionScript 3.0 code.

public createMotionObject(startFrameIndex?: number, endFrameIndex?: number)

Creates a new motion object at a designated start and end frame.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public createMotionTween(startFrameIndex?: number, endFrameIndex?: number)

Sets the frame.tweenType property to motion for each selected keyframe on the current layer, and converts each frame's contents to a single symbol instance if necessary.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public cutFrames(startFrameIndex?: number, endFrameIndex?: number)

Cuts a range of frames on the current layer from the timeline and saves them to the clipboard.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public cutLayers(startLayerIndex?: number, endLayerIndex?: number)

Cuts a range of Timeline layers and saves them to the clipboard.

Parameters

  • startLayerIndex?: number optional
  • endLayerIndex?: number optional

public deleteLayer(index: number)

Deletes a layer.

Parameters

  • index: number

public duplicateLayers(startFrameIndex?: number, endFrameIndex?: number)

Duplicates the selected layers or specified layers.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public expandFolder(bExpand: boolean, bRecurseNestedParents?: boolean, index?: number)

Expands or collapses the specified folder or folders.

Parameters

  • bExpand: boolean
  • bRecurseNestedParents?: boolean optional
  • index?: number optional

public findLayerIndex(name: string): Array<number>

Finds an array of indexes for the layers with the given name.

Parameters

  • name: string

Returns

Array<number>

public getFrameProperty(property: string, startframeIndex?: number, endFrameIndex?: number): any

Retrieves the specified property's value for the selected frames.

Parameters

  • property: string
  • startframeIndex?: number optional
  • endFrameIndex?: number optional

Returns

any

public getGuidelines(): string

Returns an XML string that represents the current positions of the horizontal and vertical guide lines for a timeline(View > Guides > Show Guides).

Returns

string

public getLayerProperty(property: string): any

Retrieves the specified property's value for the selected layers.

Parameters

  • property: string

Returns

any

public getSelectedFrames(): FlashFrame[]

Retrieves the currently selected frames in an array.

Returns

FlashFrame[]

public getSelectedLayers(): FlashLayer[]

Retrieves the zero - based index values of the currently selected layers.

Returns

FlashLayer[]

public insertBlankKeyframe(frameNumIndex?: number)

Inserts a blank keyframe at the specified frame index; if the index is not specified, inserts the blank keyframe by using the playhead / selection.

Parameters

  • frameNumIndex?: number optional

public insertFrames(numFrames?: number, bAllLayers?: boolean, frameNumIndex?: number)

Inserts the specified number of frames at the given frame number.

Parameters

  • numFrames?: number optional
  • bAllLayers?: boolean optional
  • frameNumIndex?: number optional

public insertKeyframe(frameNumIndex?: number)

Inserts a keyframe at the specified frame.

Parameters

  • frameNumIndex?: number optional

public pasteFrames(startFrameIndex?: number, endFrameIndex?: number)

Pastes the range of frames from the clipboard into the specified frames.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public pasteLayers(layerIndex: number): number

Pastes copied layers to the Timeline above the specified layer index.

Parameters

  • layerIndex: number

Returns

number

public pasteMotion()

Pastes the range of motion frames retrieved by

public removeFrames(startFrameIndex?: number, endFrameIndex?: number)

Deletes the frame.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public removeMotionObject(startFrame: number, endFrame: number)

Removes the motion object created with timeline.createMotionObject(), and converts the frame(s) to static frames.

Parameters

  • startFrame: number
  • endFrame: number

public reorderLayer(layerToMove: number, layerToPutItBy: number, bAddBefore?: boolean)

Moves the first specified layer before or after the second specified layer.

Parameters

  • layerToMove: number
  • layerToPutItBy: number
  • bAddBefore?: boolean optional

public reverseFrames(startFrameIndex?: number, endFrameIndex?: number)

Reverses a range of frames.

Parameters

  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public selectAllFrames()

Selects all the frames in the current timeline.

public setFrameProperty(property: string, value: any, startFrameIndex?: number, endFrameIndex?: number)

Sets the property of the Frame object for the selected frames.

Parameters

  • property: string
  • value: any
  • startFrameIndex?: number optional
  • endFrameIndex?: number optional

public setGuidelines(xmlString: string): boolean

Replaces the guide lines for the timeline with the information specified.

Parameters

  • xmlString: string

Returns

boolean

public setLayerProperty(property: string, value: any, layersToChange?: string)

Sets the specified property on all the selected layers to a specified value.

Parameters

  • property: string
  • value: any
  • layersToChange?: string optional

public setSelectedFrames(startFrameIndex: number, endFrameIndex: number, bReplaceCurrentSelection?: boolean)

Selects a range of frames in the current layer or sets the selected frames to the selection array passed into this method.

Parameters

  • startFrameIndex: number
  • endFrameIndex: number
  • bReplaceCurrentSelection?: boolean optional

public setSelectedFrames(selectionList: Array<number>, bReplaceCurrentSelection?: boolean)

Parameters

  • selectionList: Array<number>
  • bReplaceCurrentSelection?: boolean optional

public setSelectedLayers(index: number, bReplaceCurrentSelection?: boolean)

Sets the layer to be selected; also makes the specified layer the current layer.

Parameters

  • index: number
  • bReplaceCurrentSelection?: boolean optional

public showLayerMasking(layer: number)

Shows the layer masking during authoring by locking the mask and masked layers.

Parameters

  • layer: number

public startPlayback()

Starts automatic playback of the timeline if it is not currently playing.

public stopPlayback()

Stops autoumatic playback of the timeline if it is currently playing.