Class BindingApi<In, Ex, C>

The API for binding between the parameter and the pane.

Type Parameters

In = unknown

The internal type.
Ex = unknown

The external type.
C extends BindingController<In> = BindingController<In>

Hierarchy

BladeApi<C>
- BindingApi
  - ListInputBindingApi
  - SliderInputBindingApi

Implements

EventListenable<BindingApiEvents<Ex>>
Refreshable

Index

Accessors

disabled element hidden key label tag

Methods

dispose exportState importState off on refresh

Accessors

disabled

get disabled(): boolean
Returns boolean
Inherited from BladeApi.disabled
- Defined in core/src/blade/common/api/blade.ts:21
set disabled(disabled: boolean): void
Parameters
- disabled: boolean
Returns void
Inherited from BladeApi.disabled
- Defined in core/src/blade/common/api/blade.ts:25

element

get element(): HTMLElement
Returns HTMLElement
Inherited from BladeApi.element
- Defined in core/src/blade/common/api/blade.ts:17

hidden

get hidden(): boolean
Returns boolean
Inherited from BladeApi.hidden
- Defined in core/src/blade/common/api/blade.ts:29
set hidden(hidden: boolean): void
Parameters
- hidden: boolean
Returns void
Inherited from BladeApi.hidden
- Defined in core/src/blade/common/api/blade.ts:33

key

get key(): string
The key of the bound value.

Returns string
- Defined in core/src/blade/binding/api/binding.ts:53

label

get label(): undefined | null | string
Returns undefined | null | string
- Defined in core/src/blade/binding/api/binding.ts:42
set label(label: undefined | null | string): void
Parameters
- label: undefined | null | string
Returns void
- Defined in core/src/blade/binding/api/binding.ts:46

Methods

dispose

dispose(): void
Returns void
Inherited from BladeApi.dispose
- Defined in core/src/blade/common/api/blade.ts:37

exportState

exportState(): BladeState
Returns BladeState
Inherited from BladeApi.exportState
- Defined in core/src/blade/common/api/blade.ts:45

importState

importState(state: BladeState): boolean
Parameters
- state: BladeState
Returns boolean
Inherited from BladeApi.importState
- Defined in core/src/blade/common/api/blade.ts:41

off

off<EventName>(eventName: EventName, handler: ((ev: BindingApiEvents<Ex>[EventName]) => void)): BindingApi<In, Ex, C>
Type Parameters
- EventName extends "change"
Parameters
- eventName: EventName
- handler: ((ev: BindingApiEvents<Ex>[EventName]) => void)
  - - (ev: BindingApiEvents<Ex>[EventName]): void
    - Parameters
      
      ev: BindingApiEvents<Ex>[EventName]
      
      Returns void
Returns BindingApi<In, Ex, C>
Implementation of EventListenable.off
- Defined in core/src/blade/binding/api/binding.ts:85

on

on<EventName>(eventName: EventName, handler: ((ev: BindingApiEvents<Ex>[EventName]) => void)): BindingApi<In, Ex, C>
Type Parameters
- EventName extends "change"
Parameters
- eventName: EventName
- handler: ((ev: BindingApiEvents<Ex>[EventName]) => void)
  - - (ev: BindingApiEvents<Ex>[EventName]): void
    - Parameters
      
      ev: BindingApiEvents<Ex>[EventName]
      
      Returns void
Returns BindingApi<In, Ex, C>
Implementation of EventListenable.on
- Defined in core/src/blade/binding/api/binding.ts:68

refresh

refresh(): void
Refreshes the target.

Returns void
Implementation of Refreshable.refresh
- Defined in core/src/blade/binding/api/binding.ts:93

Class BindingApi<In, Ex, C>

Type Parameters

In = unknown

Ex = unknown

C extends BindingController<In> = BindingController<In>

Hierarchy

Implements

Index

Accessors

Methods

Accessors

disabled

Returns boolean

Parameters

disabled: boolean

Returns void

element

Returns HTMLElement

hidden

Returns boolean

Parameters

hidden: boolean

Returns void

key

Returns string

label

Returns undefined | null | string

Parameters

label: undefined | null | string

Returns void

tag

Returns undefined | string

Parameters

tag: undefined | string

Returns void

Methods

dispose

Returns void

exportState

Returns BladeState

importState

Parameters

state: BladeState

Returns boolean

off

Type Parameters

EventName extends "change"

Parameters

eventName: EventName

handler: ((ev: BindingApiEvents<Ex>[EventName]) => void)

Parameters

ev: BindingApiEvents<Ex>[EventName]

Returns void

Returns BindingApi<In, Ex, C>

on

Type Parameters

EventName extends "change"

Parameters

eventName: EventName

handler: ((ev: BindingApiEvents<Ex>[EventName]) => void)

Parameters

ev: BindingApiEvents<Ex>[EventName]

Returns void

Returns BindingApi<In, Ex, C>

refresh

Returns void

Settings

Member Visibility

Theme