For Dashboard Designers Reference View
Friday, November 11, 2022 12:54 PMView
Inherits from: Function.
Parameters
Key | Description | Default value | Possible values |
---|---|---|---|
area |
name/id of the area where the view will appear in | content |
Element ID of View Area |
container.background |
Only for views in modal area. CSS declaration for the background of the parent element of the view (surrounding area) |
rgba(0, 0, 0, 0.3) |
null / CSS declaration |
container.collapsable |
The view starts collapsed (when collapsing is enabled) | false |
false / true |
container.collapsed |
Enable collapsing of view content | false |
false / true |
container.closable |
Enable closing of the view (a close [x] button will be present on the view) | false |
false / true |
container.height |
width of the view in pixels | undefined |
integer |
container.id |
Identifier for container/view (for reuse purposes) | _new |
non-empty string that starts with a letter and contains only letters, numbers _ and - |
container.width |
height of the view in pixels | undefined |
integer |
container.onTop |
brings current container on top over all other containers (only for the default content area) |
undefined |
true /false |
container.toBottom |
sends current container to the bottom under all other containers (only for the default content area) |
undefined |
true /false |
disableContextMenu.{name} |
Disable default context menus by their name. | false |
true /false |
More info on areas and containers.
Outgoing Triggers
Type: load
Occurrence: when the View has finished loading and is displayed on the page.
Additional event properties (besides the inherited properties):
None
Type: context
Occurrence: when the user right-clicks an item that has a context menu.
Additional event properties (besides the inherited properties):
Key | Description | Possible values |
---|---|---|
target |
Data from the clicked target. Can be different for each View and menu. | object |
More info on context menus.
Type: batch
Occurrence: when the user clicks a 'batch trigger' button at the top of the View.
Additional event properties (besides the inherited properties):
None
More info on batch triggers.