Interface IPropertyItem<T, Prop>

Common base for all property items

interface IPropertyItem<T extends PropertyBag, Prop extends keyof T & string> {
    enable: boolean;
    id: string;
    obj: T;
    paneId: string;
    property: Prop;
    typeName: PropertyItemType;
    value: T[Prop];
    visible: boolean;
    dispose(): void;
}

Type Parameters

T extends PropertyBag
Prop extends keyof T & string

Hierarchy (View Summary)

IPropertyItemBase
- IPropertyItem

Index

Properties

enable id obj paneId property typeName value visible

Methods

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`obj

obj: T

Remarks

The object associated.

`Readonly`paneId

paneId: string

Remarks

The parent pane id.

`Readonly`property

property: Prop

Remarks

The target property of the object associated.

`Readonly`typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

`Readonly`value

value: T[Prop]

Remarks

The value of the property.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

dispose

dispose(): void
Returns void