Skip to main content

Interface: UiObjectConfig<T, TType>

Core-API.UiObjectConfig

Type parameters​

NameType
Tany
TTypeextends UiObjectType = UiObjectType

Indexable​

▪ [id: string]: any

Properties​

uuid​

• Optional uuid: string

type​

• Optional type: TType

label​

• Optional label: string | () => string

children​

• Optional children: (UiObjectConfig<any, string> | () => UiObjectConfig<any, string> | UiObjectConfig<any, string>[])[]

property​

• Optional property: [T, number | Extract<keyof T, string>]

value​

• Optional value: T

hidden​

• Optional hidden: boolean | () => boolean

expanded​

• Optional expanded: boolean | () => boolean

inlinePicker​

• Optional inlinePicker: boolean | () => boolean

disabled​

• Optional disabled: boolean | () => boolean

uiRef​

• Optional uiRef: any

uiRefType​

• Optional uiRefType: string

onChange​

• Optional onChange: (...args: any[]) => void | (undefined | (...args: any[]) => void)[]

bounds​

• Optional bounds: number[] | () => number[]

stepSize​

• Optional stepSize: number

isMonitor​

• Optional isMonitor: boolean

limitedUi​

• Optional limitedUi: boolean

domChildren​

• Optional domChildren: HTMLElement[] | () => HTMLElement[]

alert​

• Optional alert: [message?: string]

confirm​

• Optional confirm: [message?: string]

prompt​

• Optional prompt: [message?: string, _default?: string, cancel: boolean]

Methods​

getValue​

▸ Optional getValue(): T

Returns​

T

setValue​

▸ Optional setValue(value): void

Parameters​

NameType
valueT

Returns​

void

uiRefresh​

▸ Optional uiRefresh(mode?, deep?, delay?): void

Parameters​

NameType
mode?TUiRefreshModes | "immediate"
deep?boolean
delay?number

Returns​

void

onExpand​

▸ Optional onExpand(c): void

Parameters​

NameType
cUiObjectConfig<any, string>

Returns​

void