LocationComponent
Extends:
Static Member Summary
| Static Public Members | ||
| public static get |
builderInfo: {"title": string, "group": string, "icon": string, "weight": number, "schema": *} |
|
Static Method Summary
| Static Public Methods | ||
| public static |
schema(extend: ...*): * |
|
Member Summary
| Public Members | ||
| public get |
|
|
| public get |
|
|
| public get |
inputInfo: * |
|
Method Summary
| Public Methods | ||
| public |
addMarker(latlng: *, title: *, element: *) |
|
| public |
attach(element: *): * |
|
| public |
attachElement(element: *, index: *) |
|
| public |
init() |
|
| public |
renderElement(value: *, index: *): * |
|
| public |
setValue(value: *, flags: *) |
|
Inherited Summary
| From class Component | ||
| public static |
schema(sources: ...*): * |
|
| public static |
tableView(value: *, options: *) Provides a table view for this component. |
|
| public get |
Retrieves the CSS class name of this component. |
|
| public get |
currentForm: * |
|
| public set |
|
|
| 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 |
|
|
| public get |
defaultValue: * |
|
| public get |
|
|
| public get |
Return if the component is disabled. |
|
| public set |
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 |
|
|
| 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 |
The readible name for this component. |
|
| public get |
|
|
| public set |
|
|
| 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 |
|
|
| public get |
submissionTimezone: *: * Return the submission timezone. |
|
| public set |
|
|
| public get |
transform: * |
|
| public get |
|
|
| public get |
viewOnly: * |
|
| public get |
|
|
| public set |
visible(value: *) |
|
| public |
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 |
The existing error that this component has. |
|
| public |
id: * |
|
| public |
info: * The element information for creating the input element. |
|
| public |
|
|
| public |
|
|
| public |
|
|
| public |
Points to the parent component. |
|
| public |
If this input has been input and provided value. |
|
| public |
|
|
| public |
|
|
| public |
refs: {} References to dom elements |
|
| public |
If the component has been rendered |
|
| public |
Points to the root component, usually the FormComponent. |
|
| public |
The row path of this component. |
|
| public |
list of attached tooltips |
|
| public |
|
|
| public |
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 |
Determines if this component is disabled, or not. |
|
| private |
Determines if this component has a condition assigned to it. |
|
| private |
|
|
| 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 |
|
|
| public |
attachRefreshEvent(refreshData: *) |
|
| public |
|
|
| public |
|
|
| 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 |
|
|
| public |
conditionallyVisible(data: *): boolean Check if this component is conditionally visible. |
|
| public |
createModal(element: *): * |
|
| public |
|
|
| public |
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 |
|
|
| 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 |
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 |
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 |
|
|
| public |
removeValue(index: number) Removes a value out of the data array and rebuild the rows. |
|
| public |
|
|
| public |
renderString(template: *, data: *, actions: *): HTMLElement Render a template string into html. |
|
| public |
renderTemplate(name: *, data: {}, modeOption: *): * |
|
| public |
Resets the value of this component. |
|
| public |
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 |
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 |
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 Field | ||
| public get |
className: * |
|
| public get |
labelInfo: * |
|
| public |
attach(dom: *) |
|
| public |
deattach() |
|
| public |
render(element: *): * |
|
| From class Multivalue | ||
| public get |
addAnother: * |
|
| public get |
dataValue: * |
|
| public set |
|
|
| public get |
defaultValue: * |
|
| public |
addNewValue(value: *) Adds a new empty value to the data array. |
|
| public |
addValue() Adds a new empty value to the data array, and add a new row to contain it. |
|
| public |
attach(dom: *) |
|
| public |
render(): * |
|
| public |
renderRow(value: *, index: *): * |
|
| public |
useWrapper(): * |
|
| From class Input | ||
| public get |
|
|
| public get |
|
|
| public get |
|
|
| public get |
maskOptions: * |
|
| public get |
|
|
| public get |
widget: *: * Returns the instance of the widget for this component. |
|
| public |
|
|
| private |
_widget: * |
|
| public |
addFocusBlurEvents(element: *) |
|
| public |
attach(element: *): * |
|
| public |
attachElement(element: *, index: *) |
|
| public |
createWidget(index: *): null Creates an instance of a widget for this component. |
|
| public |
getMaskByName(maskName: *): * |
|
| public |
renderElement(value: *, index: *): * |
|
| public |
setCounter(type: *, element: *, count: *, max: *) |
|
| public |
setInputMask(input: *, inputMask: *): * |
|
| public |
updateMask(textInput: *, newMaskName: *) |
|
| public |
updateValue(flags: *, value: *, index: *): * |
|
| public |
updateValueAt(flags: *, value: *, index: *) |
|
| From class TextFieldComponent | ||
| public static get |
builderInfo: {"title": string, "icon": string, "group": string, "documentation": string, "weight": *, "schema": *} |
|
| public static |
schema(extend: ...*): * |
|
| public get |
|
|
| public get |
|
|
| public get |
inputInfo: * |
|
| public |
createMaskInput(textInput: *): * |
|
| public |
getValueAt(index: *): {"value": *, "maskName": *} |
|
| public |
isEmpty(value: *): * |
|
| public |
performInputMapping(input: *): * |
|
| public |
setValueAt(index: *, value: *, flags: *): * |
|
Static Public Members
Static Public Methods
public static schema(extend: ...*): * source
Override:
TextFieldComponent#schemaParams:
| Name | Type | Attribute | Description |
| extend | ...* |
Return:
| * |
Public Members
public get emptyValue: string source
The empty value for this component.
Override:
TextFieldComponent#emptyValuePublic Methods
public addMarker(latlng: *, title: *, element: *) source
Params:
| Name | Type | Attribute | Description |
| latlng | * | ||
| title | * | ||
| element | * |
public attach(element: *): * source
Override:
Input#attachParams:
| Name | Type | Attribute | Description |
| element | * |
Return:
| * |
public attachElement(element: *, index: *) source
Override:
Input#attachElementParams:
| Name | Type | Attribute | Description |
| element | * | ||
| index | * |
public renderElement(value: *, index: *): * source
Override:
Input#renderElementParams:
| Name | Type | Attribute | Description |
| value | * | ||
| index | * |
Return:
| * |
public setValue(value: *, flags: *) source
Set the value of this component.
Override:
Component#setValueParams:
| Name | Type | Attribute | Description |
| value | * | ||
| flags | * |
