import Component from 'formiojs/src/components/_classes/component/Component.js'

public class | source

Component

Extends:

src/Element.js~Element → Component

Direct Subclass:

ContentComponent, Field, FormComponent, HTMLComponent, ReCaptchaComponent, StripeComponent, UnknownComponent, WebformBuilder

This is the Component class which all elements within the FormioForm derive from.

Static Member Summary

Static Public Members
public static get	Validator: ValidationChecker: * Return the validator as part of the component.

Static Method Summary

Static Public Methods
public static	schema(sources: ...):
public static	tableView(value: , options: ) Provides a table view for this component.

Constructor Summary

Public Constructor
public	constructor(component: Object, options: Object, data: Object) Initialize a new Component.

Member Summary

Public Members
public get	allowData: *
public	attached: boolean If the component has been attached
public get	builderMode: *
public get	calculatedPath: *
public	calculatedValue: *
public get	className: string: * Retrieves the CSS class name of this component.
public	component: * The Form.io component JSON schema.
public	componentModal: *
public get	currentForm: *
public set	currentForm
public get	customStyle: string: * Build the custom style from the layout values
public get	data: *
public set	data
public get	dataReady: *
public get	dataValue: : Get the static value of this component.
public set	dataValue(value: *) Sets the static value of this component.
public get	defaultSchema: *
public get	defaultValue: *
public get	defaultViewOnlyValue: string
public get	disabled: boolean: * Return if the component is disabled.
public set	disabled(disabled: boolean) Disable this component.
public	element: *
public get	emptyValue: null: * The empty value for this component.
public	error: string The existing error that this component has.
public get	errorLabel: : Returns the error label for this component.
public get	errors: *
public get	fileService: * Get `Formio` instance for working with files
public get	fullMode: *
public get	hasInput: *
public get	hasModalSaveButton: boolean
public get	hasSetValue: *
public	id: *
public	info: * The element information for creating the input element.
public	invalid: boolean
public get	isAdvancedLabel: *
public get	isInputComponent: *
public get	isMobile: *
public get	key: *
public get	label: * Get this component's label text.
public set	label(value: *) Set this component's label text and render it.
public get	labelInfo: *
public get	labelMargin: *
public get	labelPosition: *
public get	labelPositions: *
public get	labelWidth: *
public get	logic: *
public get	name: string: * The readible name for this component.
public	originalComponent: *
public	parent: Component Points to the parent component.
public set	parentDisabled
public get	parentDisabled: *
public set	parentVisible
public get	parentVisible: *
public	path: string The data path to this specific component instance.
public	pristine: boolean If this input has been input and provided value.
public	quill: *
public get	ready: *
public	refreshOnChanged: *
public	refreshOnValue: *
public	refs: {} References to dom elements
public	rendered: boolean If the component has been rendered
public	root: Component Points to the root component, usually the FormComponent.
public get	rootPristine: *
public get	rootValue: : Get the data value at the root level.
public	row: number The row path of this component.
public get	schema: * Returns the JSON schema for this component.
public get	shouldDisabled: *
public get	skipInEmail: boolean
public get	submissionTimezone: : Return the submission timezone.
public	tooltip: string Tool tip text after processing
public	tooltips: Array list of attached tooltips
public get	transform: *
public get	tree: *
public	triggerChange: *
public	triggerRedraw: Function Used to trigger a redraw event within this component.
public	type: *
public get	validationValue: *
public	validator: * Set the validator instance.
public	validators: [string] The validators that are assigned to this component.
public get	viewOnly: *
public set	visible(value: *)
public get	visible: boolean: *
public get	wysiwygDefault: {"quill": , "ace": , "ckeditor": , "default": }

Private Members
private	_currentForm: *
private	_data: * The data object in which this component resides.
private	_disabled: boolean Determines if this component is disabled, or not.
private	_hasCondition: null Determines if this component has a condition assigned to it.
private	_parentDisabled: boolean
private	_parentPath: *
private	_parentVisible: * Determines if this component is visible, or not.
private	_path: string
private	_visible: *

Method Summary

Public Methods
public	addAce(element: , settings: , onChange: ):
public	addCKE(element: , settings: , onChange: ):
public	addClass(element: , className: ): *
public	addInputError(message: , dirty: , elements: *)
public	addMessages(message: , dirty: ) Add a new input error to this element.
public	addQuill(element: , settings: , onChange: ):
public	addShortcut(element: , shortcut: )
public	append(element: *)
public	applyActions(newComponent: , actions: , result: , row: , data: ):
public	asString(value: ): Prints out the value of this component as a string value.
public	attach(element: ):
public	attachLogic()
public	autofocus()
public	beforeNext(): *
public	beforePage(): * Called before a next and previous page is triggered allowing the components to perform special functions.
public	beforeSubmit(): * Called before a submission is triggered allowing the components to perform special async functions.
public	build(element: ):
public	calculateComponentValue(data: , flags: , row: ):
public	calculateValue(args: *): boolean Performs calculations in this component plus any child components.
public	checkAsyncValidity(data: , dirty: , row: , silentCheck: ): *
public	checkComponentConditions(data: , flags: , row: ): Check for conditionals and hide/show the element based on those conditions.
public	checkComponentValidity(data: , dirty: , row: *): boolean Checks the validity of this component and sets the error message if it is invalid.
public	checkCondition(row: , data: ): boolean Checks the condition of this component.
public	checkConditions(args: *): boolean Checks conditions for this component and any sub components.
public	checkData(data: , flags: ): * Check the conditions, calculations, and validity of a single component and triggers an update if something changed.
public	checkRefresh(refreshData: , changed: , flags: *)
public	checkRefreshOn(changes: , flags: )
public	checkTemplate(templates: , names: , modes: ):
public	checkTemplateMode(templatesByName: , modes: ): *
public	checkValidity(data: , dirty: , row: , silentCheck: ): *
public	clear()
public	clearErrorClasses()
public	clearOnHide()
public	conditionallyVisible(data: *): boolean Check if this component is conditionally visible.
public	convertNumberOrBoolToString(data: *): boolean Perform a calculated value operation.
public	createModal(element: , attr: , confirm: ):
public	createViewOnlyElement(): *
public	deleteValue() Deletes the value of the component.
public	destroy()
public	detach() Remove all event handlers.
public	detachLogic()
public	elementInfo(): {"type": string, "component": , "changeEvent": string, "attr": } Get the element information.
public	errorMessage(type: ): Get the error message provided a certain type of error.
public	evalContext(additional: ): Create an evaluation context for all script executions and interpolations.
public	fieldLogic(data: ): Check all triggers and apply necessary actions.
public	focus()
public	getBrowserLanguage(): *
public	getElement(): HTMLElement Returns the outside wrapping element of this component.
public	getIcon(name: , content: , styles: , ref: string):
public	getLabelInfo(): {"isRightPosition": , "isRightAlign": , "labelStyles": , "contentStyles": }
public	getModalPreviewTemplate(): *
public	getModifiedSchema(schema: , defaultSchema: ): * Returns only the schema that is different from the default.
public	getRelativePath(path: ):
public	getRoot(): * Get FormioForm element at the root of this component tree.
public	getTemplate(names: , modes: ): *
public	getValue(): * Get the input value of this component.
public	getValueAsString(value: , options: ): *
public	getValueAt(index: ): Get the value at a specific index.
public	getView(value: , options: ): *
public	getWidgetValueAsString(value: ): Uses the widget to determine the output string.
public	hasChanged(newValue: , oldValue: ): boolean Determine if the value of this component has changed.
public	hasClass(element: , className: ): *
public	hasCondition(): null Determines if this component has a condition defined.
public	hasValue(data: ): Returns if this component has a value set.
public	iconClass(name: , spinning: ): *
public	inContext(component: *): boolean Checks to see if a separate component is in the "context" of this component.
public	init()
public	invalidMessage(data: , dirty: ): * Returns the invalid message, or empty string if the component is valid.
public	isEmpty(value: ):
public	isEqual(valueA: , valueB: ): *
public	isIE(): boolean
public	isValid(data: , dirty: ): boolean Returns if the component is valid or not.
public	isValueHidden(): boolean \| * Determines if the value of this component is hidden from the user as if it is coming from the server, but is protected.
public	itemValue(data: , forceUseValue: boolean):
public	itemValueForHTMLMode(value: ):
public	labelIsHidden(): *
public	loadRefs(element: , refs: )
public	mergeSchema(component: {}): *
public	normalizeValue(value: ): Normalize values coming into updateValue.
public	onChange(flags: , fromRoot: ): *
public	performInputMapping(input: ):
public	prepend(element: *)
public	rebuild(): *
public	redraw(): *
public	refresh(value: *) Refreshes the component with a new value.
public	removeChild(element: *)
public	removeClass(element: , className: ): *
public	removeEventListeners()
public	removeInputError(elements: *)
public	removeShortcut(element: , shortcut: )
public	removeValue(index: number) Removes a value out of the data array and rebuild the rows.
public	render(children: undefined, topLevel: boolean): *
public	renderString(template: , data: , actions: *): HTMLElement Render a template string into html.
public	renderTemplate(name: , data: {}, modeOption: ): *
public	resetValue() Resets the value of this component.
public	restoreValue() Restore the value of a control.
public	rightDirection(direction: ):
public	sanitize(string: ): Sanitize an html string.
public	selectOptions(select: , tag: , options: , defaultValue: )
public	setComponentValidity(messages: , dirty: , silentCheck: ):
public	setContent(element: , content: ): boolean
public	setCustomValidity(messages: , dirty: , external: *)
public	setDefaultValue()
public	setDisabled(element: , disabled: )
public	setErrorClasses(elements: , dirty: , hasErrors: , hasMessages: )
public	setLoading(element: , loading: )
public	setOpenModalElement()
public	setPristine(pristine: *) Sets the pristine flag for this component.
public	setSelectValue(select: , value: )
public	setValue(value: , flags: ): boolean Set the value of this component.
public	setValueAt(index: , value: ) Set the value at a specific index.
public	shouldSkipValidation(data: , dirty: , row: ):
public	size(size: ):
public	splice(index: *) Splice a value from the dataValue.
public	t(text: string, params: Object): * Translate a text using the i18n system.
public	triggerRootChange(args: ...*)
public	unset()
public	updateComponentValue(flags: ): Update a value of this component.
public	updateItems(args: ...*)
public	updateOnChange(flags: *): boolean Update the value on change.
public	updateValue(args: *): boolean Updates the value of this component plus all sub-components.
public	validateMultiple(): boolean Check if a component is eligible for multiple validation
public	whenReady(): *

Static Public Members

public static get Validator: ValidationChecker: * source

Return the validator as part of the component.

Return:

ValidationChecker

Static Public Methods

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

Params:

Name	Type	Attribute	Description
sources	...*

Return:

public static tableView(value: , options: ) source

Provides a table view for this component. Override if you wish to do something different than using getView method of your instance.

Params:

Name	Type	Attribute	Description
value	*
options	*

Public Constructors

public constructor(component: Object, options: Object, data: Object) source

Initialize a new Component.

Params:

Name	Type	Attribute	Description
component	Object		The component JSON you wish to initialize.
options	Object		The options for this component.
data	Object		The global data submission object this component will belong.

Public Members

public get allowData: * source

public attached: boolean source

If the component has been attached

public get builderMode: * source

public get calculatedPath: * source

public calculatedValue: * source

public get className: string: * source

Retrieves the CSS class name of this component.

Return:

string

The class name of this component.

public component: * source

The Form.io component JSON schema.

public componentModal: * source

public get currentForm: * source

public set currentForm source

public get customStyle: string: * source

Build the custom style from the layout values

Return:

string

The custom style

public get data: * source

public set data source

public get dataReady: * source

public get dataValue: : source

Get the static value of this component.

Return:

public set dataValue(value: *) source

Sets the static value of this component.

public get defaultSchema: * source

public get defaultValue: * source

public get defaultViewOnlyValue: string source

public get disabled: boolean: * source

Return if the component is disabled.

Return:

boolean

public set disabled(disabled: boolean) source

Disable this component.

public element: * source

public get emptyValue: null: * source

The empty value for this component.

Return:

null

public error: string source

The existing error that this component has.

public get errorLabel: : source

Returns the error label for this component.

Return:

public get errors: * source

public get fileService: * source

Get Formio instance for working with files

public get fullMode: * source

public get hasInput: * source

public get hasModalSaveButton: boolean source

public get hasSetValue: * source

public id: * source

public info: * source

The element information for creating the input element.

public invalid: boolean source

public get isAdvancedLabel: * source

public get isInputComponent: * source

public get isMobile: * source

public get key: * source

public get label: * source

Get this component's label text.

public set label(value: *) source

Set this component's label text and render it.

public get labelInfo: * source

public get labelMargin: * source

public get labelPosition: * source

public get labelPositions: * source

public get labelWidth: * source

public get logic: * source

public get name: string: * source

The readible name for this component.

Return:

string

The name of the component.

public originalComponent: * source

public parent: Component source

Points to the parent component.

public set parentDisabled source

public get parentDisabled: * source

public set parentVisible source

public get parentVisible: * source

public path: string source

The data path to this specific component instance.

public pristine: boolean source

If this input has been input and provided value.

public quill: * source

public get ready: * source

public refreshOnChanged: * source

public refreshOnValue: * source

public refs: {} source

References to dom elements

public rendered: boolean source

If the component has been rendered

public root: Component source

Points to the root component, usually the FormComponent.

public get rootPristine: * source

public get rootValue: : source

Get the data value at the root level.

Return:

public row: number source

The row path of this component.

public get schema: * source

Returns the JSON schema for this component.

public get shouldDisabled: * source

public get skipInEmail: boolean source

public get submissionTimezone: : source

Return the submission timezone.

Return:

Tool tip text after processing

public tooltips: Array source

list of attached tooltips

public get transform: * source

public get tree: * source

public triggerChange: * source

public triggerRedraw: Function source

Used to trigger a redraw event within this component.

public type: * source

public get validationValue: * source

public validator: * source

Set the validator instance.

public validators: [string] source

The validators that are assigned to this component.

public get viewOnly: * source

public set visible(value: *) source

public get visible: boolean: * source

Return:

boolean

public get wysiwygDefault: {"quill": , "ace": , "ckeditor": , "default": } source

Private Members

private _currentForm: * source

private _data: * source

The data object in which this component resides.

private _disabled: boolean source

Determines if this component is disabled, or not.

private _hasCondition: null source

Determines if this component has a condition assigned to it.

private _parentDisabled: boolean source

private _parentPath: * source

private _parentVisible: * source

Determines if this component is visible, or not.

private _path: string source

private _visible: * source

Public Methods

public addAce(element: , settings: , onChange: ): source

Params:

Name	Type	Attribute	Description
element	*
settings	*
onChange	*

Return:

public addCKE(element: , settings: , onChange: ): source

Params:

Name	Type	Attribute	Description
element	*
settings	*
onChange	*

Return:

public addClass(element: , className: ): * source

Params:

Name	Type	Attribute	Description
element	*
className	*

Return:

public addInputError(message: , dirty: , elements: *) source

Params:

Name	Type	Attribute	Description
message	*
dirty	*
elements	*

public addMessages(message: , dirty: ) source

Add a new input error to this element.

Params:

Name	Type	Attribute	Description
message	*
dirty	*

public addQuill(element: , settings: , onChange: ): source

Params:

Name	Type	Attribute	Description
element	*
settings	*
onChange	*

Return:

public addShortcut(element: , shortcut: ) source

Params:

Name	Type	Attribute	Description
element	*
shortcut	*

public append(element: *) source

Params:

Name	Type	Attribute	Description
element	*

public applyActions(newComponent: , actions: , result: , row: , data: ): source

Params:

Name	Type	Attribute	Description
newComponent	*
actions	*
result	*
row	*
data	*

Return:

public asString(value: ): source

Prints out the value of this component as a string value.

Params:

Name	Type	Attribute	Description
value	*

Return:

public attach(element: ): source

Params:

Name	Type	Attribute	Description
element	*

Return:

public attachLogic() source

public autofocus() source

public beforeNext(): * source

Return:

public beforePage(): * source

Called before a next and previous page is triggered allowing the components to perform special functions.

Return:

public beforeSubmit(): * source

Called before a submission is triggered allowing the components to perform special async functions.

Return:

public build(element: ): source

Params:

Name	Type	Attribute	Description
element	*

Return:

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

Params:

Name	Type	Attribute	Description
data	*
flags	*
row	*

Return:

public calculateValue(args: *): boolean source

Performs calculations in this component plus any child components.

Params:

Name	Type	Attribute	Description
args	*

Return:

boolean

public checkAsyncValidity(data: , dirty: , row: , silentCheck: ): * source

Params:

Name	Type	Attribute	Description
data	*
dirty	*
row	*
silentCheck	*

Return:

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

Check for conditionals and hide/show the element based on those conditions.

Params:

Name	Type	Attribute	Description
data	*
flags	*
row	*

Return:

public checkComponentValidity(data: , dirty: , row: *): boolean source

Checks the validity of this component and sets the error message if it is invalid.

Params:

Name	Type	Attribute	Description
data	*
dirty	*
row	*

Return:

boolean

public checkCondition(row: , data: ): boolean source

Checks the condition of this component.

TODO: Switch row and data parameters to be consistent with other methods.

Params:

Name	Type	Attribute	Description
row	*		The row contextual data.
data	*		The global data object.

Return:

boolean

True if the condition applies to this component.

public checkConditions(args: *): boolean source

Checks conditions for this component and any sub components.

Params:

Name	Type	Attribute	Description
args	*

Return:

boolean

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

Check the conditions, calculations, and validity of a single component and triggers an update if something changed.

Params:

Name	Type	Attribute	Description
data	*		The root data of the change event.
flags	*		The flags from this change event.

Return:

*	boolean - If component is valid or not.

public checkRefresh(refreshData: , changed: , flags: *) source

Params:

Name	Type	Attribute	Description
refreshData	*
changed	*
flags	*

public checkRefreshOn(changes: , flags: ) source

Params:

Name	Type	Attribute	Description
changes	*
flags	*

public checkTemplate(templates: , names: , modes: ): source

Params:

Name	Type	Attribute	Description
templates	*
names	*
modes	*

Return:

public checkTemplateMode(templatesByName: , modes: ): * source

Params:

Name	Type	Attribute	Description
templatesByName	*
modes	*

Return:

public checkValidity(data: , dirty: , row: , silentCheck: ): * source

Params:

Name	Type	Attribute	Description
data	*
dirty	*
row	*
silentCheck	*

Return:

public clear() source

public clearErrorClasses() source

public clearOnHide() source

public conditionallyVisible(data: *): boolean source

Check if this component is conditionally visible.

Params:

Name	Type	Attribute	Description
data	*

Return:

boolean

public convertNumberOrBoolToString(data: *): boolean source

Perform a calculated value operation.

Params:

Name	Type	Attribute	Description
data	*		The global data object.

Return:

boolean

If the value changed during calculation.

public createModal(element: , attr: , confirm: ): source

Params:

Name	Type	Attribute	Description
element	*
attr	*
confirm	*

Return:

public createViewOnlyElement(): * source

Return:

public deleteValue() source

Deletes the value of the component.

public destroy() source

public detach() source

Remove all event handlers.

public detachLogic() source

public elementInfo(): {"type": string, "component": , "changeEvent": string, "attr": } source

Get the element information.

Return:

{"type": string, "component": *, "changeEvent": string, "attr": *}

public errorMessage(type: ): source

Get the error message provided a certain type of error.

Params:

Name	Type	Attribute	Description
type	*

Return:

public evalContext(additional: ): source

Create an evaluation context for all script executions and interpolations.

Params:

Name	Type	Attribute	Description
additional	*

Return:

public fieldLogic(data: ): source

Check all triggers and apply necessary actions.

Params:

Name	Type	Attribute	Description
data	*

Return:

public focus() source

public getBrowserLanguage(): * source

Return:

public getElement(): HTMLElement source

Returns the outside wrapping element of this component.

Return:

HTMLElement

public getIcon(name: , content: , styles: , ref: string): source

Params:

Name	Type	Attribute	Description
name	*
content	*
styles	*
ref	string	optional default: icon

Return:

public getLabelInfo(): {"isRightPosition": , "isRightAlign": , "labelStyles": , "contentStyles": } source

Return:

{"isRightPosition": *, "isRightAlign": *, "labelStyles": *, "contentStyles": *}

public getModalPreviewTemplate(): * source

Return:

public getModifiedSchema(schema: , defaultSchema: ): * source

Returns only the schema that is different from the default.

Params:

Name	Type	Attribute	Description
schema	*
defaultSchema	*

Return:

public getRelativePath(path: ): source

Params:

Name	Type	Attribute	Description
path	*

Return:

public getRoot(): * source

Get FormioForm element at the root of this component tree.

Return:

public getTemplate(names: , modes: ): * source

Params:

Name	Type	Attribute	Description
names	*
modes	*

Return:

public getValue(): * source

Get the input value of this component.

Return:

public getValueAsString(value: , options: ): * source

Params:

Name	Type	Attribute	Description
value	*
options	*

Return:

public getValueAt(index: ): source

Get the value at a specific index.

Params:

Name	Type	Attribute	Description
index	*

Return:

public getView(value: , options: ): * source

Params:

Name	Type	Attribute	Description
value	*
options	*

Return:

public getWidgetValueAsString(value: ): source

Uses the widget to determine the output string.

Params:

Name	Type	Attribute	Description
value	*

Return:

public hasChanged(newValue: , oldValue: ): boolean source

Determine if the value of this component has changed.

Params:

Name	Type	Attribute	Description
newValue	*
oldValue	*

Return:

boolean

public hasClass(element: , className: ): * source

Params:

Name	Type	Attribute	Description
element	*
className	*

Return:

public hasCondition(): null source

Determines if this component has a condition defined.

Return:

null

public hasValue(data: ): source

Returns if this component has a value set.

Params:

Name	Type	Attribute	Description
data	*

Return:

public iconClass(name: , spinning: ): * source

Params:

Name	Type	Attribute	Description
name	*
spinning	*

Return:

public inContext(component: *): boolean source

Checks to see if a separate component is in the "context" of this component. This is determined by first checking if they share the same "data" object. It will then walk up the parent tree and compare its parents data objects with the components data and returns true if they are in the same context.

Different rows of the same EditGrid, for example, are in different contexts.

Params:

Name	Type	Attribute	Description
component	*

Return:

boolean

public init() source

public invalidMessage(data: , dirty: ): * source

Returns the invalid message, or empty string if the component is valid.

Params:

Name	Type	Attribute	Description
data	*
dirty	*

Return:

public isEmpty(value: ): source

Params:

Name	Type	Attribute	Description
value	*	optional

Return:

public isEqual(valueA: , valueB: ): * source

Params:

Name	Type	Attribute	Description
valueA	*
valueB	*	optional

Return:

public isIE(): boolean source

Return:

boolean

public isValid(data: , dirty: ): boolean source

Returns if the component is valid or not.

Params:

Name	Type	Attribute	Description
data	*
dirty	*

Return:

boolean

public isValueHidden(): boolean | * source

Determines if the value of this component is hidden from the user as if it is coming from the server, but is protected.

Return:

boolean | *

public itemValue(data: , forceUseValue: boolean): source

Params:

Name	Type	Attribute	Description
data	*
forceUseValue	boolean	optional default: false	if true, return 'value' property of the data

Return:

public itemValueForHTMLMode(value: ): source

Params:

Name	Type	Attribute	Description
value	*

Return:

public labelIsHidden(): * source

Return:

public loadRefs(element: , refs: ) source

Params:

Name	Type	Attribute	Description
element	*
refs	*

public mergeSchema(component: {}): * source

Params:

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

Return:

public normalizeValue(value: ): source

Normalize values coming into updateValue.

Params:

Name	Type	Attribute	Description
value	*

Return:

public onChange(flags: , fromRoot: ): * source

Params:

Name	Type	Attribute	Description
flags	*
fromRoot	*

Return:

public performInputMapping(input: ): source

Params:

Name	Type	Attribute	Description
input	*

Return:

public prepend(element: *) source

Params:

Name	Type	Attribute	Description
element	*

public rebuild(): * source

Return:

public redraw(): * source

Return:

public refresh(value: *) source

Refreshes the component with a new value.

Params:

Name	Type	Attribute	Description
value	*

public removeChild(element: *) source

Params:

Name	Type	Attribute	Description
element	*

public removeClass(element: , className: ): * source

Params:

Name	Type	Attribute	Description
element	*
className	*

Return:

public removeEventListeners() source

public removeInputError(elements: *) source

Params:

Name	Type	Attribute	Description
elements	*

public removeShortcut(element: , shortcut: ) source

Params:

Name	Type	Attribute	Description
element	*
shortcut	*

public removeValue(index: number) source

Removes a value out of the data array and rebuild the rows.

Params:

Name	Type	Attribute	Description
index	number		The index of the data element to remove.

public render(children: undefined, topLevel: boolean): * source

Params:

Name	Type	Attribute	Description
children	undefined	optional default: undefined
topLevel	boolean	optional default: false

Return:

public renderString(template: , data: , actions: *): HTMLElement source

Render a template string into html.

Params:

Name	Type	Attribute	Description
template	*
data	*
actions	*

Return:

HTMLElement

The created element.

public renderTemplate(name: , data: {}, modeOption: ): * source

Params:

Name	Type	Attribute	Description
name	*
data	{}	optional default: {}
modeOption	*

Return:

public resetValue() source

Resets the value of this component.

public restoreValue() source

Restore the value of a control.

public rightDirection(direction: ): source

Params:

Name	Type	Attribute	Description
direction	*

Return:

public sanitize(string: ): source

Sanitize an html string.

Params:

Name	Type	Attribute	Description
string	*

Return:

public selectOptions(select: , tag: , options: , defaultValue: ) source

Params:

Name	Type	Attribute	Description
select	*
tag	*
options	*
defaultValue	*

public setComponentValidity(messages: , dirty: , silentCheck: ): source

Params:

Name	Type	Attribute	Description
messages	*
dirty	*
silentCheck	*

Return:

public setContent(element: , content: ): boolean source

Params:

Name	Type	Attribute	Description
element	*
content	*

Return:

boolean

public setCustomValidity(messages: , dirty: , external: *) source

Params:

Name	Type	Attribute	Description
messages	*
dirty	*
external	*

public setDefaultValue() source

public setDisabled(element: , disabled: ) source

Params:

Name	Type	Attribute	Description
element	*
disabled	*

public setErrorClasses(elements: , dirty: , hasErrors: , hasMessages: ) source

Params:

Name	Type	Attribute	Description
elements	*
dirty	*
hasErrors	*
hasMessages	*

public setLoading(element: , loading: ) source

Params:

Name	Type	Attribute	Description
element	*
loading	*

public setOpenModalElement() source

public setPristine(pristine: *) source

Sets the pristine flag for this component.

Params:

Name	Type	Attribute	Description
pristine	*		{boolean} - TRUE to make pristine, FALSE not pristine.

public setSelectValue(select: , value: ) source

Params:

Name	Type	Attribute	Description
select	*
value	*

public setValue(value: , flags: ): boolean source

Set the value of this component.

Params:

Name	Type	Attribute	Description
value	*
flags	*

Return:

boolean

If the value changed.

public setValueAt(index: , value: ) source

Set the value at a specific index.

Params:

Name	Type	Attribute	Description
index	*
value	*

public shouldSkipValidation(data: , dirty: , row: ): source

Params:

Name	Type	Attribute	Description
data	*
dirty	*
row	*

Return:

public size(size: ): source

Params:

Name	Type	Attribute	Description
size	*

Return:

public splice(index: *) source

Splice a value from the dataValue.

Params:

Name	Type	Attribute	Description
index	*

public t(text: string, params: Object): * source

Translate a text using the i18n system.

Params:

Name	Type	Attribute	Description
text	string		The i18n identifier.
params	Object		The i18n parameters to use for translation.

Return:

public triggerRootChange(args: ...*) source

Params:

Name	Type	Attribute	Description
args	...*

public unset() source

public updateComponentValue(flags: ): source

Update a value of this component.

Params:

Name	Type	Attribute	Description
flags	*

Return:

public updateItems(args: ...*) source

Params:

Name	Type	Attribute	Description
args	...*

public updateOnChange(flags: *): boolean source

Update the value on change.

Params:

Name	Type	Attribute	Description
flags	*

Return:

boolean

public updateValue(args: *): boolean source

Updates the value of this component plus all sub-components.

Params:

Name	Type	Attribute	Description
args	*

Component

Extends:

Direct Subclass:

Indirect Subclass:

Static Member Summary

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Static Public Members

public static get Validator: ValidationChecker: * source

Return:

Static Public Methods

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

Params:

Return:

public static tableView(value: *, options: *) source

Params:

Public Constructors

public constructor(component: Object, options: Object, data: Object) source

Params:

Public Members

public get allowData: * source

public attached: boolean source

public get builderMode: * source

public get calculatedPath: * source

public calculatedValue: * source

public get className: string: * source

Return:

public component: * source

public componentModal: * source

public get currentForm: * source

public set currentForm source

public get customStyle: string: * source

Return:

public get data: * source

public set data source

public get dataReady: * source

public get dataValue: *: * source

Return:

public set dataValue(value: *) source

public get defaultSchema: * source

public get defaultValue: * source

public get defaultViewOnlyValue: string source

public get disabled: boolean: * source

Return:

public set disabled(disabled: boolean) source

public element: * source

public get emptyValue: null: * source

Return:

public error: string source

public get errorLabel: *: * source

Return:

public get errors: * source

public get fileService: * source

public get fullMode: * source

public get hasInput: * source

public get hasModalSaveButton: boolean source

public get hasSetValue: * source

public id: * source

public info: * source

public invalid: boolean source

public get isAdvancedLabel: * source

public get isInputComponent: * source

public get isMobile: * source

public get key: * source

public get label: * source

public set label(value: *) source

public get labelInfo: * source

public get labelMargin: * source

public get labelPosition: * source

public get labelPositions: * source

public get labelWidth: * source

public get logic: * source

public get name: string: * source

Return:

public originalComponent: * source

public parent: Component source

public set parentDisabled source

public get parentDisabled: * source

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

public static tableView(value: , options: ) source

public get dataValue: : source

public get errorLabel: : source

public get rootValue: : source

public get submissionTimezone: : source

public get wysiwygDefault: {"quill": , "ace": , "ckeditor": , "default": } source

public addAce(element: , settings: , onChange: ): source

public addCKE(element: , settings: , onChange: ): source

public addClass(element: , className: ): * source

public addInputError(message: , dirty: , elements: *) source

public addMessages(message: , dirty: ) source

public addQuill(element: , settings: , onChange: ): source

public addShortcut(element: , shortcut: ) source

public applyActions(newComponent: , actions: , result: , row: , data: ): source

public asString(value: ): source