TABLE OF CONTENTS
- 1. Dashboards
- 1.2. Adding new dashboards
- 1.3 Dashboard slugs
- 1.4. Dashboard localized name
- 1.5. Dashboard groups
- 1.7. Position in Dashboard menu
- 1.8. Conditions
- 1.9. Changing Dashboard layout
1.2. Adding new dashboards
To create a new dashboard: POST http://localhost:4200/dashboard/api/dashboards/(URL) with JSON in the body.
1.3 Dashboard slugs
URL will look like /dashboard/<dashboard id> by default. But, it's possible to define dashboard slug URL in config section.
1.4. Dashboard localized name
Dashboard name could be localized in the menu via configuration
1.5. Dashboard groups
By default, all dashboards will be shown in Dashboard group. But, there is a possibility to configure dashboards in groups.
1.6. Icons in Dashboard menu
By default, all dashboards are combined in Dashboard group and have predefined icon or letter. In addition we have possibility to specify icon in the Dashboard group or assign it for each.
Dashboard or Dashboard group icon could be set up in the menu via configuration and for this we should apply icon parameter. To choose value for icon use Material Design icons set
And if you want to configure Dashboard without icon use "icon": "no-icon"
1.7. Position in Dashboard menu
In General Dashboards or Dashboard groups are sorted by predefined rules. First of all should be shown single Dashboards and after them Dashboards in the group. If you want to change this order you should use orderIndex parameter. This parameter also sets up in the menu via configuration.
orderIndex - can be negative or positive. Less parameter pushed Dashboard or Dashboard group into first place.
groupIsLink - can be true or false and used for placing single Dashboards between groups.
By default, all dashboards will be shown in the menu. But, there is a possibility to configure conditions when they should or should not be shown.
context.get('xmEntityId') will return xmEntityId that chosen from the entity list.
1.9. Changing Dashboard layout
To change a new dashboard layout: PUT http://localhost:4200/dashboard/api/dashboards/(URL) with JSON in the body.