Versions Compared

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


Image RemovedImage Added

Figure 1 : Sample Spreadsheet Form Element in the userviewUserview

 

Image RemovedImage Added

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 (See Format for documentation)
  • 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 based on the chosen format type.

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.

 

Image RemovedImage Added

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.

Info
titleSample

Row numbering checked.

Image Added

Number of columns to fixed on left 
Number of spare rows

Number of spare row to be added automatically after lines with values.

Info
titleSample

1 spare row

Image Added

 

 

Custom Settings (JSON) 

 

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

...