TablePopinToggleCell API
Definition
The TablePopinToggleCell is inserted as a cell variant in the first column of a table and enables the user to open and close a TablePopin as an enhancement of a table row by selecting the row,
Description of UI Element Properties
· cellDesign
Specifies the background color of the cell. The cellDesign property can be filled with the following values and is represented by the enumeration type WDTableCellDesign.
badvalue_dark |
Dark background color that indicates a negative value. |
badvalue_light |
Light background color that indicates a negative value. |
badvalue_medium |
Medium background color that indicates a negative value. |
criticalvalue_dark |
Dark background color that indicates a critical value. |
criticalvalue_light |
Light background color that indicates a critical value. |
criticalvalue_medium |
Medium background color that indicates a critical value. |
goodvalue_dark |
Dark background color that indicates a good value. |
goodvalue_light |
Light background color that indicates a good value. |
goodvalue_medium |
Medium background color that indicates a good value. |
group_level1 |
Background color for cells of group level 1 |
group_level2 |
Background color for cells of group level 2 |
group_level3 |
Background color for cells of group level 3 |
key_medium |
Medium background color for cells of key column |
negative |
Background color that indicates a negative value. |
positive |
Background color that indicates a positive value. |
standard |
Standard background color, the same for the entire row |
one |
Color of category one, depends on the respective design theme used. |
two |
Color of category two, depends on the respective design theme used. |
three |
Color of category three, depends on the respective design theme used. |
four |
Color of category four, depends on the respective design theme used. |
· hAlign
Determines the horizontal alignment of the UI element in the grid layout cell. The default value of this property is beginOfLine. The hAlign property is represented by the enumeration type WDCellHAlign and can be filled with the following values:
beginOfLine |
The text content is always displayed at the beginning of line. Therefore, the text content for the value ltr of the textDirection property is left-justified. The text content for the value rtl is right-justified. |
center |
Centered alignment. |
char |
Specifies the alignment using a specific character. The assignment of the char value allows you to align the cell contents to a single character. |
endOfLine |
The text content is always displayed at the end of the line. Therefore, the text content for the value ltr of the textDirection property is right-justified. The text content for the value rtl is left-justified. |
forcedLeft |
The text content is always left-justified, regardless of whether the value is ltr or rtl for the textDirection property. |
forcedRight |
The text content is always right-justified, regardless of whether the value is ltr or rtl for the textDirection property. |
justify |
Justified - This value allows forced justification within a grid layout cell. |
left |
Left-justified alignment. This value is deprecated. Use beginOfLine instead. |
right |
Right-justified alignment. This value is deprecated. Use forcedRight instead. |
· variantKey
Determines the key to be used to identify the TablePopinToggleCell.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
cellDesign |
IWDTablePopinToggleCell |
WDTableCellDesign |
standard |
bindable |
No |
hAlign |
IWDAbstractTableCellVariant |
WDTableColumnHAlign |
auto |
bindable |
No |
variantKey |
IWDAbstractTableCellVariant |
String |
|
not_bindable |
No |
Event
· onToggle (boolean expanded)
The onToggle event is triggered when the user clicks the TablePopinToggleCell. The transfer parameter expanded is the new status.