Class InputForm

Hierarchy (View Summary)

EventSystem
- InputForm

Index

Constructors

Properties

events form_config form_data max_label_width node uses_wide_inputs uuid

Methods

addListener buildForm dispatchEvent getResult on once removeListener setToggles setValues update updateLabelWidth updateValues getDefaultValue

Constructors

constructor

new InputForm(form_config: InputFormConfig, options?: {}): InputForm
Parameters
- form_config: InputFormConfig
- Optionaloptions: {}
Returns InputForm
Overrides EventSystem.constructor
- Defined in types/generated/interface/form.d.ts:163

Properties

events

events: Record<string, EventListener[]>

form_config

form_config: InputFormConfig

form_data

form_data: { [formElement: string]: FormElement }

max_label_width

max_label_width: number

node

node: HTMLDivElement

uses_wide_inputs

uses_wide_inputs: boolean

uuid

uuid: string

Methods

addListener

addListener(event_name: string, cb: EventListener): Deletable
Parameters
- event_name: string
- cb: EventListener
Returns Deletable
Inherited from EventSystem.addListener
- Defined in types/generated/util/event_system.d.ts:11

buildForm

buildForm(): void
Returns void
- Defined in types/generated/interface/form.d.ts:164

dispatchEvent

dispatchEvent(event_name: string, data: any): any
Parameters
- event_name: string
- data: any
Returns any
Inherited from EventSystem.dispatchEvent
- Defined in types/generated/util/event_system.d.ts:8

getResult

getResult(): FormValues
Returns FormValues
- Defined in types/generated/interface/form.d.ts:173

on

on(event_name: string, cb: EventListener): Deletable
Parameters
- event_name: string
- cb: EventListener
Returns Deletable
Inherited from EventSystem.on
- Defined in types/generated/util/event_system.d.ts:9

once

once(event_name: string, cb: EventListener): Deletable
Parameters
- event_name: string
- cb: EventListener
Returns Deletable
Inherited from EventSystem.once
- Defined in types/generated/util/event_system.d.ts:10

removeListener

removeListener(event_name: string, cb: EventListener): void
Parameters
- event_name: string
- cb: EventListener
Returns void
Inherited from EventSystem.removeListener
- Defined in types/generated/util/event_system.d.ts:12

setToggles

setToggles(values: Record<string, boolean>, update?: boolean): void
Parameters
- values: Record<string, boolean>
- Optionalupdate: boolean
Returns void
- Defined in types/generated/interface/form.d.ts:172

setValues

setValues(values: FormValues, update?: boolean): void
Parameters
- values: FormValues
- Optionalupdate: boolean
Returns void
- Defined in types/generated/interface/form.d.ts:171

update

update(form_result: FormValues): void
Parameters
- form_result: FormValues
Returns void
- Defined in types/generated/interface/form.d.ts:166

updateLabelWidth

updateLabelWidth(ignore_hidden?: boolean): void
Parameters
- Optionalignore_hidden: boolean
Returns void
- Defined in types/generated/interface/form.d.ts:165

updateValues

updateValues(context?: { cause?: string; changed_keys?: string[] }): FormValues
Parameters
- Optionalcontext: { cause?: string; changed_keys?: string[] }
Returns FormValues
- Defined in types/generated/interface/form.d.ts:167

`Static`getDefaultValue

getDefaultValue(input_config: FormElementOptions): FormResultValue
Parameters
- input_config: FormElementOptions
Returns FormResultValue
- Defined in types/generated/interface/form.d.ts:174