import TreeComponent from 'formiojs/src/components/tree/Tree.js'

public class | source

TreeComponent

Extends:

src/components/_classes/component/Component.js~Component → Field → NestedComponent → TreeComponent

Static Member Summary

Static Public Members
public static get	builderInfo: {"title": string, "icon": string, "group": string, "weight": number, "schema": *}

Static Method Summary

Static Public Methods
public static	schema(extend: ...):

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	componentOptions: {...undefined: Object, "parent": , "root": }
public	components: *[]
public	dataValue: *
public get	emptyValue: {}
public	treeRoot: *
public	type: string
public get	viewComponents: *
public	viewComponentsInstantiated: boolean

Private Members
private	_viewComponents: *

Method Summary

Public Methods
public	addChild(parent: *)
public	attach(element: ):
public	attachActions(node: *)
public	attachChildren(node: ):
public	attachComponents(node: , args: ...): *
public	attachNode(element: , node: ): *
public	cancelNode(node: *)
public	checkData(data: , flags: , row: ):
public	checkNode(data: , node: , flags: , row: ): *
public	createComponents(data: , node: ): *
public	destroy()
public	editNode(node: *)
public	getValue(): *
public	init(): *
public	removeComponents(components: ):
public	removeNode(node: *)
public	removeRoot()
public	render(): *
public	renderChildNodes(nodes: [], odd: ): *
public	renderEdit(node: {}): *
public	renderTree(node: {}, odd: boolean): *
public	renderView(node: {}): *
public	revertNode(node: *)
public	saveNode(node: *)
public	setRoot()
public	setValue(value: , flags: {}):
public	toggleNode(node: *)
public	updateTree()

Inherited Summary

From class Field
public	render(element: ):

From class NestedComponent
public static	schema(extend: ...):
public get	collapsed: *
public set	collapsed
public get	componentComponents: *
public get	currentForm: *
public set	currentForm
public get	data: *
public set	data
public get	dataReady: *
public get	defaultSchema: *
public get	disabled: *
public set	disabled
public get	errors: *
public get	isDirty: *
public get	isPristine: *
public get	nestedKey: string
public get	parentDisabled: *
public set	parentDisabled
public get	parentVisible: *
public set	parentVisible
public get	ready: *
public get	rowIndex: *
public set	rowIndex
public get	schema: *
public get	templateName: string
public get	visible: *
public set	visible
public	components: *
public	dataValue: *
public	error: string
public	type: string
private	_collapsed: *
private	_data: *
private	_rowIndex: *
private	_visible: *
public	addComponent(component: Object, data: Object, before: HTMLElement): Component Add a new component to the components array.
public	addComponents(element: , data: )
public	attach(element: ):
public	attachComponents(element: , components: , container: ):
public	beforeFocus()
public	beforePage(next: ): Allow components to hook into the next page trigger to perform their own logic.
public	beforeSubmit(): * Allow components to hook into the submission to provide their own async data.
public	calculateComponentPath(component: Object): string Return a path of component's value.
public	calculateValue(data: , flags: , row: ):
public	checkAsyncValidity(data: , dirty: , row: , silentCheck: ): *
public	checkConditions(data: , flags: , row: ):
public	checkData(data: , flags: , row: , components: ): *
public	checkModal(isValid: , dirty: )
public	checkValidity(data: , dirty: , row: , silentCheck: ): *
public	clear()
public	clearOnHide(show: *)
public	componentContext(): *
public	createComponent(component: , data: ): * Create a new component and add it to the components array.
public	destroy()
public	destroyComponents()
public	detach()
public	eachComponent(fn: function) Perform an iteration over each component within this container component.
public	everyComponent(fn: function) Perform a deep iteration over every component, including those within other container based components.
public	flattenComponents(): *
public	getComponent(key: string, fn: function): Object Returns a component provided a key.
public	getComponentById(id: string, fn: function): Object Return a component provided the Id of the component.
public	getComponents(): *
public	getContainer(): *
public	getValue(): *
public	hasComponent(component: ):
public	init(): *
public	isLastPage(): *
public	isValid(data: , dirty: ): *
public	removeComponent(component: Component, components: Array<Component>) Remove a component from the components array.
public	removeComponentById(id: string, fn: function): null Removes a component provided the Id of the component.
public	removeComponentByKey(key: string, fn: function): null Removes a component provided the API key of that component.
public	render(children: ):
public	renderComponents(components: ):
public	resetValue()
public	restoreComponentsContext()
public	setNestedValue(component: , value: , flags: {}): *
public	setPristine(pristine: *)
public	setValue(value: , flags: {}):
public	shouldSkipValidation(data: , dirty: , row: ):
public	updateValue(value: , flags: {}):

Static Public Members

public static get builderInfo: {"title": string, "icon": string, "group": string, "weight": number, "schema": *} source

Static Public Methods

public static schema(extend: ...): source

Override:

NestedComponent#schema

Params:

Name	Type	Attribute	Description
extend	...*

Return:

Public Constructors

public constructor() source

Override:

NestedComponent#constructor

Public Members

public componentOptions: {...undefined: Object, "parent": , "root": } source

public components: *[] source

Override:

NestedComponent#components

public dataValue: * source

Override:

NestedComponent#dataValue

public get emptyValue: {} source

public treeRoot: * source

public type: string source

Override:

NestedComponent#type

public get viewComponents: * source

public viewComponentsInstantiated: boolean source

Private Members

private _viewComponents: * source

Public Methods

public addChild(parent: *) source

Params:

Name	Type	Attribute	Description
parent	*

public attach(element: ): source

Override:

NestedComponent#attach

Params:

Name	Type	Attribute	Description
element	*

Return:

public attachActions(node: *) source

Params:

Name	Type	Attribute	Description
node	*

public attachChildren(node: ): source

Params:

Name	Type	Attribute	Description
node	*

Return:

public attachComponents(node: , args: ...): * source

Override:

NestedComponent#attachComponents

Params:

Name	Type	Attribute	Description
node	*
args	...*

Return:

public attachNode(element: , node: ): * source

Params:

Name	Type	Attribute	Description
element	*
node	*

Return:

public cancelNode(node: *) source

Params:

Name	Type	Attribute	Description
node	*

public checkData(data: , flags: , row: ): source

Override:

NestedComponent#checkData

Params:

Name	Type	Attribute	Description
data	*
flags	*
row	*

Return:

public checkNode(data: , node: , flags: , row: ): * source

Params:

Name	Type	Attribute	Description
data	*
node	*
flags	*
row	*

Return:

public createComponents(data: , node: ): * source

Params:

Name	Type	Attribute	Description
data	*
node	*

Return:

public destroy() source

Override:

NestedComponent#destroy

public editNode(node: *) source

Params:

Name	Type	Attribute	Description
node	*

public getValue(): * source

Override:

NestedComponent#getValue

Return:

public init(): * source

Override:

NestedComponent#init

Return:

public removeComponents(components: ): source

Params:

Name	Type	Attribute	Description
components	*

Return:

public removeNode(node: *) source

Params:

Name	Type	Attribute	Description
node	*

public removeRoot() source

public render(): * source

Override:

NestedComponent#render

Return:

public renderChildNodes(nodes: [], odd: ): * source

Params:

Name	Type	Attribute	Description
nodes	*[]	optional default: []
odd	*

Return:

public renderEdit(node: {}): * source

Params:

Name	Type	Attribute	Description
node	{}	optional default: {}

Return:

public renderTree(node: {}, odd: boolean): * source

Params:

Name	Type	Attribute	Description
node	{}	optional default: {}
odd	boolean	optional default: true

Return:

public renderView(node: {}): * source

Params:

Name	Type	Attribute	Description
node	{}	optional default: {}

Return:

public revertNode(node: *) source

Params:

Name	Type	Attribute	Description
node	*

public saveNode(node: *) source

Params:

Name	Type	Attribute	Description
node	*

public setRoot() source

public setValue(value: , flags: {}): source

Override:

NestedComponent#setValue

Params:

Name	Type	Attribute	Description
value	*
flags	{}	optional default: {}

Return:

public toggleNode(node: *) source

Params:

Name	Type	Attribute	Description
node	*

TreeComponent

Extends:

Static Member Summary

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Members

public static get builderInfo: {"title": string, "icon": string, "group": string, "weight": number, "schema": *} source

Static Public Methods

public static schema(extend: ...*): * source

Override:

Params:

Return:

Public Constructors

public constructor() source

Override:

Public Members

public componentOptions: {...undefined: Object, "parent": *, "root": *} source

public components: *[] source

Override:

public dataValue: * source

Override:

public get emptyValue: {} source

public treeRoot: * source

public type: string source

Override:

public get viewComponents: * source

public viewComponentsInstantiated: boolean source

Private Members

private _viewComponents: * source

Public Methods

public addChild(parent: *) source

Params:

public attach(element: *): * source

Override:

Params:

Return:

public attachActions(node: *) source

Params:

public attachChildren(node: *): * source

Params:

Return:

public attachComponents(node: *, args: ...*): * source

Override:

Params:

Return:

public attachNode(element: *, node: *): * source

Params:

Return:

public cancelNode(node: *) source

Params:

public checkData(data: *, flags: *, row: *): * source

Override:

Params:

Return:

public checkNode(data: *, node: *, flags: *, row: *): * source

Params:

Return:

public createComponents(data: *, node: *): * source

Params:

Return:

public destroy() source

Override:

public editNode(node: *) source

Params:

public getValue(): * source

Override:

Return:

public init(): * source

Override:

Return:

public removeComponents(components: *): * source

Params:

Return:

public removeNode(node: *) source

Params:

public removeRoot() source

public render(): * source

public static schema(extend: ...): source

public componentOptions: {...undefined: Object, "parent": , "root": } source

public attach(element: ): source

public attachChildren(node: ): source

public attachComponents(node: , args: ...): * source

public attachNode(element: , node: ): * source

public checkData(data: , flags: , row: ): source

public checkNode(data: , node: , flags: , row: ): * source

public createComponents(data: , node: ): * source

public removeComponents(components: ): source

public renderChildNodes(nodes: [], odd: ): * source

public setValue(value: , flags: {}): source