Versions Compared

Old Version 35

changes.mady.by.user Chris Angel

Saved on

compared with

New Version Current

changes.mady.by.user Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.
Label

Column header title/label.

You can also include a tooltip that shows up when someone hovers over the column label.

Info
titleSample

Example label:

<span title='This tooltip will show when someone hovers over the column'>Column Label A</span>

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 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
  • File - Accept file upload and render a file download link
  • Image - Accept image file upload and render a thumbnail
  • URL - Convert value to an URL
  • Hidden - Hidden column for storing formular value
  • Custom - Use custom setting to configure the column. Examples: Spreadsheet Custom Formats
Format

Defines the format to show data on the spreadsheet based on the chosen format type.

  • Numeric - Key in format accepted by numbrojs library. (For example, 0.00 is to create 2 decimal places)
  • Date - Key in format accepted by moment.js library. (Default value: DD/MM/YYYY)
  • Time - Key in format accepted by moment.js library.(Default value: h:mm:ss a)

  • Dropdown - Key in the Form ID that contains the equivalent dropdown element.

    Info
    titleDynamic Cascading Select Box

    Dynamic Cascading Select Box is supported when the target select box is making use of Options Binder and with the attribute "Use AJAX for cascade options?" is checked.

  • Autocomplete - See handsontable for samples.
  • File- Key in Form Def ID that contains File Upload form element.
  • Image - Key in Form Def ID that contains Image Upload form element.
  • URL - Provide an URL syntax. Example: http://www.joget.org?id={id}&name={name}
  • Hidden - Key in default value to be saved.
  • Custom - See handsontable for samples. Please put the setting json in {{ and }}. Example: {{"editor":"text"}}

Please note that any string within {{ and }} will be treat as setting json and used to configure the column.

Regex ValidationValidates input value to match the defined Regular Expression pattern.
Formula

Defines a formula to perform processing.

Info
titleSample

Example: sales + profit-loss

Image Modified


Please refer to formula.

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.

Info
titleSample

Row numbering checked.

Image Modified

Number of columns to fixed on left

Allows to specify the number of fixed (or frozen) columns on the left of the table.

Default Value: 0

Number of spare rows

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

Info
titleSample

1 spare row

Image Modified

 

 

Custom Settings (JSON)

Example:

Code Block
languagetext
{
	selectionMode: 'single',
	customBorders: [
      {
        range: {
          from: {
            row: 0,
            col: 0
          },
          to: {
            row: 1,
            col: 4
          }
        },
        top: {
          width: 2,
          color: 'green'
        },
        left: {
          width: 2,
          color: 'orange'
        },
        bottom: {
          width: 2,
          color: 'red'
        },
        right: {
          width: 2,
          color: 'magenta'
        }
      }]
}

...

Refer to plugins and APIs from https://handsontable.com/docs/6.2.2/tutorial-introduction.html for more customizations.

Example:

Code Block
languagetext
{
	selectionMode: 'single'
}


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


NameDescription
Validator

Attach a Validator plugin to validate the input value. Please see Form Validator.

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.

...


Supported Formula Functions

...

For example, to make spreadsheet pull and display the population value after the user picks the city name (pulldown menu), use FORMDATA("city_formId",select_city,"population") where 'select_city' is the first field id in your spreadsheet.

 

 

 

...


Below is a sample app to demonstrate the use of Spreadsheet form element: