import EditTableComponent from 'formiojs/src/components/edittable/EditTable.js'

public class | source

EditTableComponent

Extends:

src/Element.js~Element → Component → NestedComponent → DataGridComponent → EditTableComponent

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 get	componentComponents: *
public	dataValue: *
public get	emptyColumn: {"label": , "key": }
public get	groupsMode: *
public get	tableClass: *

Method Summary

Public Methods
public	addEmptyRows(n: *)
public	build(state: {})
public	buildGroup(objectPattern: {"label": }):
public	buildGroups()
public	buildRow(row: , index: , state: {}): *
public	buildRows()
public	builderView(): *
public	componentSchema(extend: ...):
public	getColumns(): Array Returns all non-empty columns.
public	getGroups(): *
public	getMeta(): *
public	getRowChunks(groups: Numbers[], coll: Array<T>): Array<T[]>
public	hasAddButton(): *
public	hasColumns(): Boolean Checks whether columns are available
public	hasExtraColumn(): boolean
public	removeButton(index: ): override *
public	setMeta()
public	totalRowsNumber(groups: ):

Inherited Summary

From class Component
public static	schema(sources: ...):
public static	tableView(value: , options: ) Provides a table view for this component.
public get	className: string: * Retrieves the CSS class name of this component.
public get	currentForm: *
public set	currentForm
public get	customStyle: string: * Build the custom style from the layout values
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 get	emptyValue: null: * The empty value for this component.
public get	errorLabel: : Returns the error label for this component.
public get	errors: *
public get	hasInput: *
public get	hasSetValue: *
public get	isInputComponent: *
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	logic: *
public get	name: string: * The readible name for this component.
public get	parentVisible: *
public set	parentVisible
public get	ready: *
public get	rootValue: : Get the data value at the root level.
public get	schema: * Returns the JSON schema for this component.
public get	shouldDisable: *
public get	submissionTimezone: : Return the submission timezone.
public set	template
public get	transform: *
public get	validationValue: *
public get	viewOnly: *
public get	visible: boolean: *
public set	visible(value: *)
public	attached: boolean If the component has been attached
public	component: * The Form.io component JSON schema.
public	data: * The data object in which this component resides.
public	element: *
public	error: string The existing error that this component has.
public	id: *
public	info: * The element information for creating the input element.
public	invalid: boolean
public	isBuilt: boolean
public	originalComponent: *
public	parent: Component Points to the parent component.
public	pristine: boolean If this input has been input and provided value.
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	row: number The row path of this component.
public	tooltips: Array list of attached tooltips
public	triggerChange: *
public	triggerRedraw: Function Used to trigger a redraw event within this component.
public	type: *
public	validators: [string] The validators that are assigned to this component.
private	_currentForm: *
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	_parentVisible: boolean
private	_visible: * Determines if this component is visible, or not.
public	addClass(element: , className: ): *
public	addInputError(message: , dirty: ) Add a new input error to this element.
public	append(element: *)
public	applyActions(actions: , result: , data: , newComponent: ): *
public	asString(value: ): Prints out the value of this component as a string value.
public	attach(element: ):
public	attachLogic()
public	attachRefreshEvent(refreshData: *)
public	attachRefreshOn()
public	autofocus()
public	beforeNext(): * Called before a next 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	buildOld() Builds the component.
public	calculateValue(data: *): boolean Perform a calculated value operation.
public	checkCondition(row: , data: ): boolean Checks the condition of this component.
public	checkConditions(data: ): Check for conditionals and hide/show the element based on those conditions.
public	checkValidity(data: , dirty: , rowData: ):
public	clear()
public	clearOnHide()
public	conditionallyVisible(data: *): boolean Check if this component is conditionally visible.
public	createModal(element: ):
public	createViewOnlyElement(): *
public	deleteValue() Deletes the value of the component.
public	destroy()
public	detach() Remove all event handlers.
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	getFlags(): *
public	getIcon(name: , content: , styles: , ref: string):
public	getModifiedSchema(schema: , defaultSchema: ): * Returns only the schema that is different from the default.
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	getValueAt(index: ): Get the value at a specific index.
public	getView(value: ):
public	hasChanged(before: , after: ): 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	isValid(data: , dirty: ): boolean Returns if the component is valid or not.
public	labelIsHidden(): *
public	loadRefs(element: , refs: )
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	removeValue(index: number) Removes a value out of the data array and rebuild the rows.
public	render(children: undefined): *
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	selectOptions(select: , tag: , options: , defaultValue: )
public	setCustomValidity(message: , dirty: )
public	setDisabled(element: , disabled: )
public	setLoading(element: , loading: )
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: , rowData: ):
public	splice(index: *) Splice a value from the dataValue.
public	t(text: string, params: Object): * Translate a text using the i18n system.
public	updateItems(args: ...*)
public	updateOnChange(flags: , changed: ): boolean Update the value on change.
public	updateValue(flags: ): Update a value of this component.
public	validateMultiple(value: *): boolean Check if a component is eligible for multiple validation
public	whenReady(): *

From class NestedComponent
public static	schema(extend: ...):
public get	collapsed: *
public set	collapsed
public get	componentComponents: *
public get	currentForm: *
public set	currentForm
public get	defaultSchema: *
public set	disabled
public get	errors: *
public get	nestedKey: string
public get	parentVisible: *
public set	parentVisible
public get	ready: *
public get	schema: *
public get	templateName: string
public get	visible: *
public set	visible
public	components: *
public	type: string
private	_collapsed: *
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	beforeNext(): * 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	calculateValue(data: , flags: ): *
public	checkConditions(data: ):
public	checkData(data: , flags: ): * A more performant way to check the conditions, calculations, and validity of a submission once it has been changed.
public	checkValidity(data: , dirty: ): *
public	clearOnHide(show: *)
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	getAllComponents(): *
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	hasChanged(): boolean
public	init()
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: , changed: ): *
public	setPristine(pristine: *)
public	setValue(value: , flags: ): *
public	updateValue(flags: , source: ): *

From class DataGridComponent
public static get	builderInfo: {"title": string, "icon": string, "group": string, "documentation": string, "weight": number, "schema": *}
public static	schema(extend: ...):
public get	addAnotherPosition: *
public get	dataValue: *
public set	dataValue
public get	datagridKey: string
public get	defaultSchema: *
public get	defaultValue: *
public get	emptyValue: undefined[]
public	components: *
public	numColumns: number
public	rows: *[]
public	type: string
public	visibleColumns: {}
public	addRow()
public	attach(element: *)
public	buildGroup(objectPattern: {"label": }, index: , groupRows: ):
public	buildGroups()
public	checkColumns(data: ): {"rebuild": , "show": *}
public	checkConditions(data: ):
public	createRowComponents(row: , rowIndex: ): *
public	createRows()
public	getColumns(): *
public	getComponent(path: , fn: ): *
public	getRowChunks(groups: Numbers[], rows: Array<T>): Array<T[]>
public	getRows(): *
public	getValue(): * Get the value of this component.
public	hasAddButton(): *
public	hasBottomSubmit(): *
public	hasChanged(before: , after: ): *
public	hasExtraColumn(): *
public	hasHeader(): *
public	hasRemoveButtons(): *
public	hasRowGroups(): *
public	hasTopSubmit(): *
public	init()
public	removeRow(index: *)
public	render(): *
public	restoreComponentsContext()
public	setStaticValue(n: *)
public	setValue(value: , flags: ): *
public	totalRowsNumber(groups: ):
public	updateValue(flags: , value: ): *

Static Public Members

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

Override:

DataGridComponent#builderInfo

Static Public Methods

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

Override:

DataGridComponent#schema

Params:

Name	Type	Attribute	Description
extend	...*

Return:

Public Constructors

public constructor() source

Initialize a new Component.

Override:

DataGridComponent#constructor

Public Members

public get componentComponents: * source

Override:

NestedComponent#componentComponents

public dataValue: * source

Get the static value of this component.

Override:

DataGridComponent#dataValue

public get emptyColumn: {"label": , "key": } source

public get groupsMode: * source

public get tableClass: * source

Public Methods

public addEmptyRows(n: *) source

Params:

Name	Type	Attribute	Description
n	*

public build(state: {}) source

Override:

Component#build

Params:

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

public buildGroup(objectPattern: {"label": }): source

Override:

DataGridComponent#buildGroup

Params:

Name	Type	Attribute	Description
objectPattern	{"label": *}	default: {"label":null}

Return:

public buildGroups() source

Override:

DataGridComponent#buildGroups

public buildRow(row: , index: , state: {}): * source

Params:

Name	Type	Attribute	Description
row	*
index	*
state	{}	optional default: {}

Return:

public buildRows() source

public builderView(): * source

Return:

public componentSchema(extend: ...): source

Params:

Name	Type	Attribute	Description
extend	...*

Return:

public getColumns(): Array source

Returns all non-empty columns.

Override:

DataGridComponent#getColumns

Return:

Array

public getGroups(): * source

Return:

public getMeta(): * source

Return:

public getRowChunks(groups: Numbers[], coll: Array<T>): Array<T[]> source

Override:

DataGridComponent#getRowChunks

Params:

Name	Type	Attribute	Description
groups	Numbers[]
coll	Array<T>		collection

Return:

Array<T[]>

public hasAddButton(): * source

Override:

DataGridComponent#hasAddButton

Return:

public hasColumns(): Boolean source

Checks whether columns are available

Return:

Boolean

public hasExtraColumn(): boolean source

Override:

DataGridComponent#hasExtraColumn

Return:

boolean

public removeButton(index: ): source

override *

Params:

Name	Type	Attribute	Description
index	*

Return:

public setMeta() source

public totalRowsNumber(groups: ): source

Override:

DataGridComponent#totalRowsNumber

Params:

Name	Type	Attribute	Description
groups	*

EditTableComponent

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

Override:

Static Public Methods

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

Override:

Params:

Return:

Public Constructors

public constructor() source

Override:

Public Members

public get componentComponents: * source

Override:

public dataValue: * source

Override:

public get emptyColumn: {"label": *, "key": *} source

public get groupsMode: * source

public get tableClass: * source

Public Methods

public addEmptyRows(n: *) source

Params:

public build(state: {}) source

Override:

Params:

public buildGroup(objectPattern: {"label": *}): * source

Override:

Params:

Return:

public buildGroups() source

Override:

public buildRow(row: *, index: *, state: {}): * source

Params:

Return:

public buildRows() source

public builderView(): * source

Return:

public componentSchema(extend: ...*): * source

Params:

Return:

public getColumns(): Array source

Override:

Return:

public getGroups(): * source

Return:

public getMeta(): * source

Return:

public getRowChunks(groups: Numbers[], coll: Array<T>): Array<T[]> source

Override:

Params:

Return:

public hasAddButton(): * source

Override:

Return:

public hasColumns(): Boolean source

Return:

public hasExtraColumn(): boolean source

Override:

Return:

public removeButton(index: *): * source

Params:

Return:

public setMeta() source

public totalRowsNumber(groups: *): * source

Override:

Params:

Return:

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

public get emptyColumn: {"label": , "key": } source

public buildGroup(objectPattern: {"label": }): source

public buildRow(row: , index: , state: {}): * source

public componentSchema(extend: ...): source

public removeButton(index: ): source

public totalRowsNumber(groups: ): source