Interface INumberPropertyItem

A property item which supports Number properties

Hierarchy

Properties

enable id paneId typeName value visible

Methods

setTitle setTooltip updateLimits

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.

Readonly value

value: number

Remarks

Current value of the property item.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

setTitle

  • Parameters

    Returns void

    Remarks

    Updates title of the property item.

setTooltip

  • Parameters

    Returns void

    Remarks

    Updates tooltip description of property item.

updateLimits

  • Parameters

    • limits: {
          max?: number;
          min?: number;
      }
      • Optional max?: number
      • Optional min?: number

    Returns void

    Remarks

    Updates number limits and clamps the current value.

Settings

Member Visibility

Theme

On This Page