Skip to main content
Version: 3.x

Class: Keyframe

@cognite/reveal/tools.Keyframe

Timeline Key Frames contains parameters to access Nodes, Styles for the Timeline

Constructors

constructor

new Keyframe(model, date)

Parameters

NameType
modelCognite3DModel
dateDate

Defined in

packages/tools/src/Timeline/Keyframe.ts:17

Methods

activate

activate(): void

Assigns the styles for the node set for the model for this Keyframe

Returns

void

Defined in

packages/tools/src/Timeline/Keyframe.ts:33


assignStyledNodeCollection

assignStyledNodeCollection(nodeCollection, nodeAppearance): void

Add node & style to the collection. If the collection has been added, the style is updated to the appearance provided.

Parameters

NameTypeDescription
nodeCollectionNodeCollectionNode set to apply the Styles
nodeAppearanceNodeAppearanceStyle to assign to the node collection

Returns

void

Defined in

packages/tools/src/Timeline/Keyframe.ts:54


deactivate

deactivate(): void

Removes the style for the model

Returns

void

Defined in

packages/tools/src/Timeline/Keyframe.ts:42


getKeyframeDate

getKeyframeDate(): Date

Get date of the Keyframe

Returns

Date

date

Defined in

packages/tools/src/Timeline/Keyframe.ts:26


unassignStyledNodeCollection

unassignStyledNodeCollection(nodeCollection): void

Remove Node & Style for this keyframe's nodeCollection and nodeAppearance

Parameters

NameTypeDescription
nodeCollectionNodeCollectionNodes to be unassign from node collection

Returns

void

Defined in

packages/tools/src/Timeline/Keyframe.ts:69