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

Defined in

webgi/src/interfaces.ts:542


type

Optional type: TType

Defined in

webgi/src/interfaces.ts:543


label

Optional label: string | () => string

Defined in

webgi/src/interfaces.ts:544


children

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

Defined in

webgi/src/interfaces.ts:545


property

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

Defined in

webgi/src/interfaces.ts:546


value

Optional value: T

Defined in

webgi/src/interfaces.ts:547


hidden

Optional hidden: boolean | () => boolean

Defined in

webgi/src/interfaces.ts:550


expanded

Optional expanded: boolean | () => boolean

Defined in

webgi/src/interfaces.ts:551


inlinePicker

Optional inlinePicker: boolean | () => boolean

Defined in

webgi/src/interfaces.ts:552


disabled

Optional disabled: boolean | () => boolean

Defined in

webgi/src/interfaces.ts:553


uiRef

Optional uiRef: any

Defined in

webgi/src/interfaces.ts:554


uiRefType

Optional uiRefType: string

Defined in

webgi/src/interfaces.ts:555


onChange

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

Defined in

webgi/src/interfaces.ts:558


bounds

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

Defined in

webgi/src/interfaces.ts:560


stepSize

Optional stepSize: number

Defined in

webgi/src/interfaces.ts:561


isMonitor

Optional isMonitor: boolean

Defined in

webgi/src/interfaces.ts:563


limitedUi

Optional limitedUi: boolean

Defined in

webgi/src/interfaces.ts:565


domChildren

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

Defined in

webgi/src/interfaces.ts:570


alert

Optional alert: [message?: string]

Defined in

webgi/src/interfaces.ts:572


confirm

Optional confirm: [message?: string]

Defined in

webgi/src/interfaces.ts:573


prompt

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

Defined in

webgi/src/interfaces.ts:574

Methods

getValue

Optional getValue(): T

Returns

T

Defined in

webgi/src/interfaces.ts:548


setValue

Optional setValue(value): void

Parameters

NameType
valueT

Returns

void

Defined in

webgi/src/interfaces.ts:549


uiRefresh

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

Parameters

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

Returns

void

Defined in

webgi/src/interfaces.ts:556


onExpand

Optional onExpand(c): void

Parameters

NameType
cUiObjectConfig<any, string>

Returns

void

Defined in

webgi/src/interfaces.ts:567