vdl-table-column
Define an array column within a table. Must be contained within a <vdl-table> element. You can also add <vdl-table-column> elements associated with index sets in the table to allow customization of the index columns.
Required parent element
Example
<vdl-table>
<vdl-table-column set="SupportLevels" width="100" vdl-visible="=false">Support Level</vdl-table-column>
<vdl-table-column entity="ServiceLevelAgreements" editable="true">Agreement</vdl-table-column>
<vdl-table-column entity="SupportCosts" format="$#,###.00" heading="Cost" editable="true"></vdl-table-column>
</vdl-table>
Attributes
| class | CSS classes to add to the table column cells. You can provide multiple classes separated by spaces. | accepts expression | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| disable-set-sorting | When applied to an index column, this will prevent set sorting from being applied to the column. Default table sorting will be used instead. This option is provided to reduce the sorting overhead where performance is being affected. Set the value to "true" to disable set sorting for this table column. | |||||||||||||||||
| editable | Whether the cells within this column are editable. | accepts expression | ||||||||||||||||
| editor-checked-value | The value to set the cell data to if editor-type is checkbox and it is checked. | |||||||||||||||||
| editor-options | An expression that results in one of the follow to be used as the select options: an array of values, an object of property to value or an array of objects containing key and value properties. This will automatically set the editor-type to be "select".
|
requires expression | ||||||||||||||||
| editor-options-include-empty | Allow array elements to be removed using the select input. Setting this to true will add a blank item to the top of the select list. Defaults to false. | |||||||||||||||||
| editor-options-set | Name of a set entity to use for select options. This will display labels if a labels entity is defined against this set. This will automatically set the editor-type to be "select". | |||||||||||||||||
| editor-type | The editor type to use, in edit mode, for cells in this column. If not specified then it will be autodetected based on entity type. Possible values: checkbox, select, text | |||||||||||||||||
| editor-unchecked-value | The value to set the cell data to if editor-type is checkbox and it is not checked. | |||||||||||||||||
| entity | Name of the array entity to show in this column. Throws an error if the entity doesn't exist or is not an array or set type. | |||||||||||||||||
| filter-by-formatted | Use formatted values for filtering. This defaults to false unless the entity has a label in which case the default is true. | |||||||||||||||||
| format | Specify a number formatting string. Only applicable to array elements of type integer, real, decision variable and constraint. The formatting syntax is explained in the Xpress Insight Developer Guide. | |||||||||||||||||
| heading | A custom header for this column, will default to be the entity alias. Alternatively, you can set the title as the text contents of the <vdl-table-column> element. | accepts expression | ||||||||||||||||
| render | Reference to a custom cell renderer. Overrides any default entity rendering. This will be used to generate the cell value for rendering, filtering and sorting. It must be an expression and resolves as a function, this function should return a string.
|
requires expression | ||||||||||||||||
| scenario | The scenario id/index for this column. Not allowed on index column (when specifying a set entity) | accepts expression | ||||||||||||||||
| set | Name of the set entity to show in this column. Throws an error if the entity doesn't exist or is not a set type. | |||||||||||||||||
| set-position | Index (zero-based) of occurrence of that index set in the index tuple for the array.Defaults to next available position. | |||||||||||||||||
| sort-by-formatted | Use formatted values for sorting. | |||||||||||||||||
| width | The width, in pixels, to set the column. | accepts expression | ||||||||||||||||
Element contents
Text content only
The text contents are used as the column header. If the "heading" attribute is specified it will override the text contents as the column header. It can also contain multiple <vdl-validate> tags, which are used for column value validation. Validation is performed on initialisation and on every change.
© 2001-2020 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.