Interface INumberPropertyItem

A property item which supports Number properties

interface INumberPropertyItem {
    enable: boolean;
    id: string;
    paneId: string;
    typeName: PropertyItemType;
    value: number;
    visible: boolean;
    setTitle(title: LocalizedString): void;
    setTooltip(tooltip: LocalizedString): void;
    updateLimits(limits: { max?: number; min?: number }): void;
}

Hierarchy (View Summary)

IPropertyItemBase
- INumberPropertyItem

Index

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

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

setTooltip

setTooltip(tooltip: LocalizedString): void
Parameters
- tooltip: LocalizedString
  New tooltip.
Returns void
Remarks
Updates tooltip description of property item.

updateLimits

updateLimits(limits: { max?: number; min?: number }): void
Parameters
- limits: { max?: number; min?: number }
Returns void
Remarks
Updates number limits and clamps the current value.