Available Dashlets Section

Available Fields

The availableDashlets portion of the config is an array containing a number of objects; each object represents a Dashlet that will be visible inside of the sidebar when creating/editing a dashboard. The fields contained within each Dashlet object will be used to display the Dashlets inside of the sidebar, as well as how they behave inside of the layout of the dashboard. The fields for a Dashlet object are as follows:

Field Name	Required	Type	Description
label	Yes	string	The label field is the text shown for the dashlet inside of the sidebar
tooltip	Yes	string	The tooltip field is the text that appears when hovering over a dashlet inside of the sidebar
chartType	Yes	string	The chartType field determines the icon that will appear beside the label's text inside of the sidebar, for more information see the chartTypes documentation below
dashletType	No	string	The dashletType field is the category that this dashlet falls under. When passed, this dashlet will be visible under an accordion where this dashletType will be the accordion header text
width	Yes	number	The initial width of a dashlet in units of grids (Dashboard is 12 grids wide by default). This determines how wide the dashlet is when dropped onto the layout
height	Yes	number	The initial height of a dashlet in units of grids. This determines how tall the dashlet is when dropped onto the layout
minWidth	No	number	The minimum grid width to which a user can reduce the dashlet when resizing horizontally
minHeight	No	number	The minimum grid height to which a user can reduce the dashlet when resizing vertically
dashletId	Yes	string	The dashletId field is the key that connects this particular dashlet to the object inside of the dashletDictionary section, in order for the application to retrieve information that will be used to render the dashlet's content and settings form. For example, in order to find more details about a dashlet with dashletId of 'summaryTiles', we will look under the dashletDictionary section for the object with the key 'summaryTiles'

*Note that the height, width, minHeight, and minWidth are just partial implementations of the React Grid Layout properties as that is being used under the hood for the dashboard.

Here is what a sample availableDashlets section would look like.

availableDashlets:
  - label: Summary Tile
    width: 2
    height: 2
    minWidth: 2
    minHeight: 2
    tooltip: Display a total count for a selection and create a shortcut link
    description: Display the total count for your summary type selection and create a shortcut link.
    chartType: summary
    dashletId: summaryTiles
    dashletType: General Dashlets
  - label: Average Time To Close Cases
    width: 4
    height: 2
    tooltip: Display the average time to close cases over a time frame
    description: Display the average time to close all cases or build a chart showing the average time to close cases by the priority level set at the time the case closed.
    minWidth: 4
    chartType: barHorizontal
    dashletId: avgTimeToClose
    dashletType: General Dashlets

ChartTypes

These are the chartTypes that are supported currently:

chartType	Icon
bar
barHorizontal
summary
donut
dualAxes