Class TreeView

The HybridForms Treeview control. For representation and selection of hierarchical data.

Hierarchy (View Summary)

FormControl
- TreeView

Index

Constructors

Properties

defaultValue disposed element enabled label labelEl onChanged options required tooltip visiting

Methods

deleteFields disable dispose enable get getAllValues getDefault getPostfixFieldId getWithId hide isRepeatingUnit set setDataSource setLabel setWithId show val

Constructors

constructor

new TreeView(element: HTMLElement, options: any): TreeView
Parameters
- element: HTMLElement
- options: any
Returns TreeView
Overrides FormControl.constructor

Properties

defaultValue

defaultValue: any

`Protected`disposed

disposed: boolean

element

element: HTMLElement

enabled

enabled: any

label

label: string

labelEl

labelEl: JQuery<HTMLElement>

onChanged

onChanged: (value: any) => void

`Protected`options

options: any

required

required: boolean

tooltip: string

visiting

visiting: boolean = false

Methods

deleteFields

deleteFields(name: string): Promise<any>
Deletes the all fields related to the form control.
Parameters
- name: string
  The field id.
Returns Promise<any>
Inherited from FormControl.deleteFields

disable

disable(): void
Disables the form control.

Returns void
Inherited from FormControl.disable

dispose

dispose(): void
Disposes the form control.

Returns void
Inherited from FormControl.dispose

enable

enable(): void
Enables the form control.

Returns void
Inherited from FormControl.enable

get

get(): IFormField
Gets the corresponding field of the form control.

Returns IFormField
Inherited from FormControl.get

getAllValues

getAllValues(): any
Returns any
all fields and values that are connected with the the form control.

Inherited from FormControl.getAllValues

getDefault

getDefault(): any
Gets the default value auf the form control, if it is set.

Returns any
Inherited from FormControl.getDefault

getPostfixFieldId

getPostfixFieldId(): string
Gets the PostfixFieldId. Relevant for operations in repeating units. Check first, if the form control is contained in a repeating unit, see: isRepeatingUnit.

Returns string
Inherited from FormControl.getPostfixFieldId

getWithId

getWithId(id: string): IFormField
Searches for a field by providing its id.
Parameters
- id: string
  The id of the field.
Returns IFormField
Inherited from FormControl.getWithId

hide

hide(animate?: boolean, lock?: boolean): void
Hide FormControl
Parameters
- animate: boolean = false
  En/Disable animation
- lock: boolean = true
  Enable lock of hidden FormControl to not process control with condition
Returns void
Inherited from FormControl.hide

isRepeatingUnit

isRepeatingUnit(): boolean
Checks if the form control is included in a repeating unit.

Returns boolean
Inherited from FormControl.isRepeatingUnit

set

set(value: any): number
Sets the field value of the form control. Be careful: This does not update the UI. In most cases it is better to use the val() method, see: val
Parameters
- value: any
  The value of the field
Returns number
Inherited from FormControl.set

setDataSource

setDataSource(dataSource: any[], dataIdField?: any, dataTextField?: any): void
Set the data source of a Treeview control.
Parameters
- dataSource: any[]
  Expects an array of key/value objects. The key name is defined in the data-hf-options ('dataTextField') of the formcontrol. For more information see https://docs.telerik.com/kendo-ui/framework/datasource/hierarchical
- dataIdField: any = null
- dataTextField: any = null
Returns void

setLabel

setLabel(value: string): void
Sets a new label value.
Parameters
- value: string
  The value to set.
Returns void
Inherited from FormControl.setLabel

setWithId

setWithId(id: string, val: any): number
Sets any field value by providing its id.
Parameters
- id: string
  The id of the field.
- val: any
  The value of the field. Data type is an object. Its structure depends on the specific field type.
Returns number
Inherited from FormControl.setWithId

show

show(animate?: boolean, unlock?: boolean): void
Show hidden FormControl
Parameters
- animate: boolean = false
  En/Disable animation
- unlock: boolean = true
  Disable lock of hidden state to process control with condition
Returns void
Inherited from FormControl.show

val

val(
value?: { id: string; text: string }[] | { id: string; text: string },
disableOnChanged?: boolean,
): { id: string; text: string }[]
Gets or sets the value of the Treeview control. The TreeView control sets to fields:
- 1. the field with the "id" as key and the dataValueField (defined in the formdefinition) as value.
- 1. the field with the "id" plus the addition '_HFText' as key and the dataTextField (defined in the formdefinition) as value.
Parameters
- Optionalvalue: { id: string; text: string }[] | { id: string; text: string }
  [optional] If provided, the value (and the corresponding field) of the Treeview control gets set.
- disableOnChanged: boolean = false
  [optional] Disables the onChanged callback if set to true. Necessary if an onChanged-Handler wants to change itself.
Returns { id: string; text: string }[]
Overrides FormControl.val