Versions Compared

Old Version 13

changes.mady.by.user Justin

Saved on

compared with

New Version 14

changes.mady.by.user Hugo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColorgreen
borderWidth1
titleBGColor#ddffcc
borderStylesolid
titleDefinition
Spreadsheet Form Element allow users to perform many actions in an excel-like environment, depending on the use cases. A few examples of uses of spreadsheets are:
  • Database editing
  • Configuration controlling
  • Data merging
  • Workforce planning
  • Sales reporting
  • Financial analysis


Figure 1 : Sample Spreadsheet Form Element in the userview

 

Figure 2 : Spreadsheet Form Element Properties

 

NameDescription
SpreadsheetElement ID of the form element.
LabelSpreadsheet label/title.
Columns

The spreadsheet column(s) is defined here.

Sub-elementDescription
ValueField ID of the column.
LabelColumn header title/label.
Format Type

Defines the type of input to store.

Default format type is Text.

Available Data Types:

  • Text - format the value as text
  • Numeric - accepts a numeric value
  • Date - accepts a date type value
  • Time - accepts a time type value
  • Checkbox - appears as a checkbox to check
  • Dropdown - appears as a dropdown menu to select options
  • Autocomplete - autocompletes any known phrases
  • Password - obscures any alphanumerical value into a password
  • Custom
Format

Defines the format to show data on the spreadsheet.

Regex ValidationValidates input value to match the defined Regular Expression pattern.
FormulaDefines a formula to perform processing. Refer to Figure 1 & Figure 2 for a simple example.
ReadonlyDefines if the column is editable.

 

Figure 3 : Spreadsheet Form Element Properties - UI

 

NameDescription
Enable Header Sorting?Determines if users can sort spreadsheet data by column in ascending or descending order.
Data Order Field IDField to keep the ordering sequence. Must correspond with a field id in the target form.
ReadonlyDefines if the entire spreadsheet is editable.
Disable Add FeatureDetermines if a new row can be added.
Disable Delete FeatureDetermines if a row can be removed.
Show Row Numbering?Show additional column on the leftmost to denote numbering.
Number of columns to fixed on left 
Number of spare rows 
Custom Settings (JSON) 

 

Figure 4 : Spreadsheet Form Element Properties - Validation & Data Binder

 

NameDescription
Validator

Attach a Validator plugin to validate the input value.

Info
titleWhen will validation takes place?

Validation will takes place whenever form is submitted except when it is submitted as "Save as Draft".

Min Number of Row Validation (Integer)Defines the minimum number of rows required for input.
Max Number of Row Validation (Integer)Defines the maximum number of rows possible for input.
Error MessageError message to be shown when row requirements set above is not met.
Load BinderOption by default. Grid data will be saved/loaded in JSON format in its defined database cell.
Store BinderOption by default. Grid data will be saved/loaded in JSON format in its defined database cell.