...
Info | ||
---|---|---|
| ||
This space contains documentation for the Community Dashboard Framework version 2.x. |
...
Property | Description | Default value (must be present) | Type | Required for | ||
name | Name of the component |
| String | all | ||
type | Type of the component |
| String | all | ||
solution | Solution of the xaction |
| String |
| ||
path | Path to the xaction within the solution |
| String |
| ||
action | Name of the xaction to be executed |
| String |
| ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="4f93a913901e1493-b9cea511-4796490b-9d23a372-bf928d2d534fa518c4fa1113"><ac:plain-text-body><![CDATA[ | listeners | A change in on of this variables triggers a refresh of the component | [] | Array of Strings |
| ]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1ee319c4bf58774a-2bfede82-462f4532-b251aa8c-48ec6d2c61639f8907c12173"><ac:plain-text-body><![CDATA[ | valuesArray | Array of values for selectors | [] | Array of Strings | Multiple choice selector components | ]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6e6d41f3f129ab6e-8cdb8ccd-4be44d3c-a3ae81f0-bf81ea2b4da4ab610e04c65c"><ac:plain-text-body><![CDATA[ | parameters | Parameters to execute the xaction | [] | Array of String arrays |
| ]]></ac:plain-text-body></ac:structured-macro> |
parameter | The dashboard variable that gets set by this component |
| String |
| ||
htmlObject | The id of the html tag that display this component (usually a <div>) |
| String | all | ||
expression | Function to return a parametrized String | function(){}; |
| text | ||
executeAtStart | Should the component be executed when the dashboard is loaded? (true or false) | function(){}; | boolean | all | ||
preExecution | This Javascript function will be executed before the components executes |
| function |
| ||
postExecution | This Javascript function will be executed after the components executes |
| function |
| ||
preChange | This Javascript function will be executed before a selector change propagates |
| function |
| ||
postChange | This Javascript function will be executed after a selector change propagates |
| function |
|
...