Skip to main content

Introducing Workflow Engine, try for FREE workflowengine.io.

Class: Store

The form viewer settings. Internal use only.

Implements​

Constructors​

new Store()​

new Store(formViewerPropsStore, parentStore?, parentComponentStore?): Store

Creates form viewer settings.

Parameters​

• formViewerPropsStore: FormViewerPropsStore

the form viewer store settings.

• parentStore?: Store

the form viewer settings, used in templates.

• parentComponentStore?: ComponentStore

the parent component settings.

Returns​

Store

Properties​

eventSubject​

readonly eventSubject: Subject<ActionEventArgs>

The Subject for submitting form events.

form​

form: Form

The form.

Implementation of​

IStore.form

formViewerPropsStore​

formViewerPropsStore: FormViewerPropsStore

the form viewer store settings.

parentComponentStore?​

readonly optional parentComponentStore: ComponentStore

the parent component settings.

parentStore?​

readonly optional parentStore: Store

the form viewer settings, used in templates.

selectedLanguage?​

optional selectedLanguage: Language

The currently selected language.

viewMode​

viewMode: ViewMode = 'desktop'

Current display resolution type.

Accessors​

commonActions​

get commonActions(): ActionValues

Returns​

ActionValues

the Record with the common actions.

displayedLanguage​

get displayedLanguage(): Language

Returns​

Language

the current display language.

formData​

get formData(): ComponentData

Returns​

ComponentData

the IFormData with all the form data.

Implementation of​

IFormViewer.formData

initialDataSlice​

get initialDataSlice(): undefined | Record<string, unknown>

Returns​

undefined | Record<string, unknown>

the slice of the initial data in accordance with the Store hierarchy. Internal use only.

Implementation of​

IStore.initialDataSlice

Methods​

applyPersistedForm()​

applyPersistedForm(persistedForm): void

Populates the value of this store with the values of the saved form.

Parameters​

• persistedForm: PersistedForm

saved form value.

Returns​

void

applyStringForm()​

applyStringForm(text): void

Populates the value of this store with the values of the saved form.

Parameters​

• text: string

saved form value.

Returns​

void

clear()​

clear(): void

Clears the form in Form Viewer.

Returns​

void

createComponentData()​

createComponentData(componentStore, deferFieldCalculation, model?): ComponentData

Creates the element for the component tree.

Parameters​

• componentStore: ComponentStore

the component settings.

• deferFieldCalculation: boolean = false

if true, then the calculated field must be explicitly initialized.

• model?: Model<any>

the component's metadata.

Returns​

ComponentData

the element for the component tree.

dispose()​

dispose(): void

Correctly clears allocated resources, the function must be called when destroying an instance of the class.

Returns​

void

Inherit Doc​

Implementation of​

IStore.dispose

findAction()​

findAction(actionData): ActionDefinition

Searches for an action, returns definition for the found action.

Parameters​

• actionData: ActionData

the action's data.

Returns​

ActionDefinition

the action definition.

Throws​

Error, if action was not found.

getAction()​

getAction(name, type): ActionDefinition

Returns an action by the specified action name and action type.

Parameters​

• name: string

the action name.

• type: ActionType

the action type.

Returns​

ActionDefinition

the action.

getModel()​

getModel(type): Model<Record<string, any>> | Model<InternalErrorProps>

Returns model for the specified type.

Parameters​

• type: string

the component type.

Returns​

Model<Record<string, any>> | Model<InternalErrorProps>

the model for the specified type.

getValidationRules()​

getValidationRules(type): FormViewerValidationRules

Returns the object with validators for the specified value type.

Parameters​

• type: keyof SchemaTypeMap

the value type.

Returns​

FormViewerValidationRules

the object with validators for the specified value type.

loadForm()​

loadForm(getForm?, formName?): void

Loads a form by form name and sets that form in the form viewer.

Parameters​

• getForm?

the function that loads the form.

• formName?: string

the form name.

Returns​

void

localizeComponent()​

localizeComponent(type, componentStore): Record<string, any>

Localizes a component store based on the given localization type. If a custom localizer is available, it will be used.

Parameters​

• type: string

the type of localization.

• componentStore: ComponentStore

the component settings.

Returns​

Record<string, any>

the Record with the localized properties.

localizeErrorMessages()​

localizeErrorMessages(componentStore, validationResults?): undefined | string

The function to localize the validation error message.

Parameters​

• componentStore: ComponentStore

the component settings.

• validationResults?: ValidationResult[]

the validation results.

Returns​

undefined | string

the localized error messages joined by space, or undefined if validationResults is undefined.

Implementation of​

IStore.localizeErrorMessages

reduceScreen()​

reduceScreen<T>(callback, initialValue): T

Performs the callback function on each element of the component tree, accumulates the return values.

Type Parameters​

• T

the return value type.

Parameters​

• callback

the function that calculates the value for the accumulator.

• initialValue: T

the initial value for the accumulator.

Returns​

T

the accumulated value.

Implementation of​

IStore.reduceScreen