#Interface: IColorTimelinePropertyItem experimental

Beta

A property item which supports Color Timeline properties

#Extends

• IPropertyItemBase

#Properties

#enable

enable: boolean

Beta

#Remarks

If the item is enabled in the UI.

#Inherited from

IPropertyItemBase.enable

---

#id

readonly id: string

Beta

#Remarks

Unique ID for the property item.

#Inherited from

IPropertyItemBase.id

---

#paneId

readonly paneId: string

Beta

#Remarks

The parent pane id.

#Inherited from

IPropertyItemBase.paneId

---

#typeName

readonly typeName: PropertyItemType

Beta

#Remarks

The type name of the target property.

#Inherited from

IPropertyItemBase.typeName

---

#visible

visible: boolean

Beta

#Remarks

If the item should be visible in the UI.

#Inherited from

IPropertyItemBase.visible

#Methods

#addNode()

addNode(data): void

Beta

#Parameters

#data

IColorTimelinePropertyItemEntry

New color node.

#Returns

void

#Remarks

Update color timeline entry

---

#getData()

getData(): IColorTimelinePropertyItemEntry[]

Beta

#Returns

IColorTimelinePropertyItemEntry[]

#Remarks

Get the list of nodes in the property item.

---

#getTime()

getTime(): number

Beta

#Returns

number

#Remarks

Get time current time value on the slider.

---

#removeNode()

removeNode(data): void

Beta

#Parameters

#data

IColorTimelinePropertyItemEntry

Node to be removed.

#Returns

void

#Remarks

Remove color node

---

#setPrecision()

setPrecision(precision): void

Beta

#Parameters

#precision

number

#Returns

void

#Remarks

Set custom decimal precision for the calculations

---

#setTime()

setTime(time): void

Beta

#Parameters

#time

number

The new time value.

#Returns

void

#Remarks

Set time line slider value to a new value

---

#setTitle()

setTitle(title): void

Beta

#Parameters

#title

LocalizedString

New title.

#Returns

void

#Remarks

Updates title of the property item.

---

#updateNode()

updateNode(data): void

Beta

#Parameters

#data

IColorTimelinePropertyItemEntry

Node to be updated.

#Returns

void

#Remarks

Update node value