NeonDashlet
This page provides generated reference documentation for the NeonDashlet data model.
A dashlet is an element on a dashboard
Overview
| Property | Summary |
|---|---|
| configName | Name of the configuration that exists within the linked view (see viewName) |
| parameters | Allows to specify values for parameters (params are defined in the linked entity). Note that you do not have access to any code/variables. It's only possible… |
| requiresConfiguration | Flag, determining if the dashlet has to be configured by the user to work properly. If so, the user is asked to configure it when adding the dashlet. |
| title | Displayed title of the dashlet. The title is used for example when the user loads a dashboard for the first time as a preset value. |
| uiConfiguration | Linked UI configuration of the dashlet (like position, size, etc.) |
| viewName | Name of the view that is linked with the dashlet |
configName
Type: String
Constraints: Verification: TITLE_LENGTH
Name of the configuration that exists within the linked view (see viewName)
parameters
Type: DashletParameters
Allows to specify values for parameters (params are defined in the linked entity). Note that you do not have access to any code/variables. It's only possible to specify hard-coded values there.
Example: If you want to limit records to those wo were created by the current logged-in user, it's possible to add a param
filterCreatedByMe_param in the entity, limit the data in the recordContainer whenever the param is true and then specify in the
parameters-config of the dashlet the value of filterCreatedByMe_param as true.
requiresConfiguration
Type: Boolean
Flag, determining if the dashlet has to be configured by the user to work properly. If so, the user is asked to configure it when adding the dashlet.
title
Type: String
Constraints: Verification: TITLE_LENGTH
Displayed title of the dashlet. The title is used for example when the user loads a dashboard for the first time as a preset value.
uiConfiguration
Type: NeonDashletUIConfigurationDataModel
Linked UI configuration of the dashlet (like position, size, etc.)
viewName
Type: String
Name of the view that is linked with the dashlet