Interface IColorTimelinePropertyItem

A property item which supports Color Timeline properties

interface IColorTimelinePropertyItem {
    enable: boolean;
    id: string;
    paneId: string;
    typeName: PropertyItemType;
    visible: boolean;
    addNode(data: IColorTimelinePropertyItemEntry): void;
    getData(): IColorTimelinePropertyItemEntry[];
    getTime(): number;
    removeNode(data: IColorTimelinePropertyItemEntry): void;
    setPrecision(precision: number): void;
    setTime(time: number): void;
    setTitle(title: LocalizedString): void;
    updateNode(data: IColorTimelinePropertyItemEntry): void;
}

Hierarchy (View Summary)

IPropertyItemBase
- IColorTimelinePropertyItem

Index

Properties

enable id paneId typeName visible

Methods

addNode getData getTime removeNode setPrecision setTime setTitle updateNode

Properties

enable

enable: boolean

Remarks

If the item is enabled in the UI.

`Readonly`id

id: string

Remarks

Unique ID for the property item.

`Readonly`paneId

paneId: string

Remarks

The parent pane id.

`Readonly`typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

addNode

addNode(data: IColorTimelinePropertyItemEntry): void
Parameters
- data: IColorTimelinePropertyItemEntry
  New color node.
Returns void
Remarks
Update color timeline entry

getData

getData(): IColorTimelinePropertyItemEntry[]
Returns IColorTimelinePropertyItemEntry[]
Remarks
Get the list of nodes in the property item.

getTime

getTime(): number
Returns number
Remarks
Get time current time value on the slider.

removeNode

removeNode(data: IColorTimelinePropertyItemEntry): void
Parameters
- data: IColorTimelinePropertyItemEntry
  Node to be removed.
Returns void
Remarks
Remove color node

setPrecision

setPrecision(precision: number): void
Parameters
- precision: number
Returns void
Remarks
Set custom decimal precision for the calculations

setTime

setTime(time: number): void
Parameters
- time: number
  The new time value.
Returns void
Remarks
Set time line slider value to a new value

setTitle

setTitle(title: LocalizedString): void
Parameters
- title: LocalizedString
  New title.
Returns void
Remarks
Updates title of the property item.

updateNode

updateNode(data: IColorTimelinePropertyItemEntry): void
Parameters
- data: IColorTimelinePropertyItemEntry
  Node to be updated.
Returns void
Remarks
Update node value