Widget Types and Properties
This page describes each Widget type and their corresponding properties.
Widget Types
The following Widget types are available:
Text
Provides a data-bound text control that can used like a label to show dynamic data
List
Displays a list of data-bound values
Rank
Provides a ranking of data-bound values and colors them appropriately
Chart
Displays a chart for the specified dataset. Chart type is configurable
Trends Chart
Displays a chart for showing data over time from the specified dataset
Counter
Provides a data-bound statistic-style Widget, generally used for showing counts
Table
Displays a table of raw data from the specified dataset
Button
Displays an button that you can write a JavaScript expression to execute on the button click.
Progress Bar
Timeline
Displays a milestone timeline of selected data.
Widget Properties
The following Widget properties are available for all types of Widgets. These are the common properties. Each Widget has their own type-specific properties that we'll list further along this page.
Card Title
This will be the main title for this particular Widget. It should be used to inform the viewer of the dashboard what data the Widget shows.
Info Text
(Optional) When specified, this will show an information icon next to the card title that when clicked, will pop up with helper text that gives more of a detailed explanation of the data.
Create Default Data
(Optional) When specified, this will show an information icon next to the card title that when clicked, will pop up with helper text that gives more of a detailed explanation of the data.
Exportable
When this is enable, the dashboard can be exported and imported into another environment.
Data Provider
This section allows you to browse for a specific data provider that contains the dataset that you wish to bind the respective Widget to.
Linked Filters
Select which Dashboard Filters to link to the Widget. When filter data changes, the Widget will automatically refresh if linked.
Parameter Options
This section allows the creation of parameters that may be passed to the dataset. See the Adding Parameters section below.
Text Widget Properties
Text Content - If the widget is not bound to a data provider, it will display this text.
Text Content Column - If the widget is bound to a data provider, it will display the value of this field from the dataset.
List Widget Properties
In addition to the common properties, Text Widgets have the following properties:
Displayed Properties - This provides a list of the available properties from the selected dataset. You can select a property from the Displayed Properties list and then click +Add Property to add it to the list of Current Properties.
Rank Widget Properties
Name Column - This should be the column from the dataset to use as the display name for this ranking on the dashboard. This will be what actually gets shown.
Count Column - This should be the column that is used to evaluate. This will not be shown on the dashboard and will only be used to determine the ranking. Different colors can be used for different rankings. The value of the column specified in the Name Column field will be evaluated against the Name Value to Match field, and if it matches, the dashboard will render that item in the selected color. Multiple criteria can be added for different colors.
Color Matches - For each color match you wish to add, enter a Name Value to Match, choose the appropriate Value Type, choose a Color (either a Theme Color, or a Custom) and then click +Add Color. The new item will get added to the Current Color Matches section. Repeat for any other colors.
Chart Widget Properties
Chart Type - Choose the desired chart type that best fits the data.
Value Column - Choose the numeric field that represents the value to render.
Single Series Ordering - Choose the style of ordering for a single series dataset.
Trends Chart Widget Properties
Value Column - Select the column from the dataset that represents the value to be shown on the chart
Series Column - Select the column from the dataset that represents the series data to be shown on the chart
X Axis Column - Select the column from the dataset that represents the data to be shown on the X axis on the chart
Interval Parameter - If the interval is being passed through as a parameter, select or add the parameter
Date Parameter - If the data is being passed through as a parameter, select or add the parameter
Counter Widget Properties
Counter Configs - This button will open a pop-out menu for the additional properties below.
Count Column - This should be the dataset column containing the data to display as the primary text data on the widget.
Top Label - This should be the text description for this counter.
Icon - This should be the name of the icon to display to the left of the counter text
After entering these details click +Add Counter Config to add it to the Counter Configs section. Multiple counter configs can be added to a single counter widget.
Table Widget Properties
Rows Per Page - The default number of rows to show on each page of the table.
Include Table Search - Toggle this ON if you would like to enable a search bar for your table.
Default Sort Column - Choose from the dropdown your desired default column from which to sort.
Default Sort Ascending - Toggle ON to sort columns by ascending values in the default column, toggle OFF to sort by descending values.
Row Menu - Provides the ability to add Action items on a per row basis.
Header Menu - Provides the ability to add Action items to the table header menu
Button
Button Text - This will display the desired text for your button.
Button Look - Choose between:
Solid - Display as a solid color button.
Outline - Display as a white button with a border color.
Flat - Will only display text without a border or solid color.
Button Type - Choose between Info, Error, Success, Warning, and Inverse. Each will display a different color that corresponds to the button type.
Button Size - Choose between Normal and Small for the desired button size.
Show as Full Width - When toggled ON this will display the button to the full width of the Widget container on the Dashboard.
URL - Enter a URL to apply to your button.
On Click - JavaScript expression to execute on button click. Rows returned from the Data Provider are passed to the expression as data.
Timeline
Content Column - Select a column to populate the main content of each timeline entry.
Date Column - Select a column to populate the date content of each timeline entry.
(Optional) Title Column - Select a column to populate the title content of each timeline entry.
Include Pagination - Determines whether the UI exposes previous/next controls on the timeline. If toggle OFF, all rows are rendered at once, which can affect UI runtime performance.
Rows Per Page - Determines how many rows to display on each page if pagination is enabled.
Include Filtering - When toggled ON, displays filter icon and search bar.
Route - Define a route to navigate the user on timeline entry click.
Insert dynamic column names into the route with
{{...}}:/my-url/{{MyColumn}}?myParam={{MyColumn2}}
Adding Linked Filters and Parameter options
This section allows the creation of parameters that may be passed to the dataset. If the dataset SQL query requires parameters to be passed in, parameters can be defined using the dashboard designer.
Select the +Create New Dashboard Filter button to add a new Dashboard Filter.
Start by specifying the Filter Name and optionally, a Filter Description.
The Filter name must match exactly with the Filter name in the SQL or PostgreSQL query.
Choose the desired Filter Type from one of the two options:
Route - Route Filters navigate the user to a different path respective to the specified Filter. There can only be one route-type Filter per dashboard.
Query - Query Filters append the Filter name and value to the URL and allow multiple Filters to be specified in a single dashboard. This is the recommended option.
Select the Value Type from the list.
The value type must match EXACTLY with the data type of the Filter used in the SQL/PostgreSQL query.
(Optional) Specify a Default Value for this Filter.
Toggle ON/OFF whether this Filter should be Required (i.e. it must be specified and will not accept a NULL value)
Toggle ON/OFF whether it should be Read Only (i.e. it must have a default value and cannot be changed at runtime).
Choose the Input Type from one of the available options from the list:
Server Object - If the parameter is to be a server object ID then the Server Object input type can be selected which will prompt for the class name of the object to select from. At runtime this will prompt with an object browser of the specified type. This option is generally for advanced users.
String, Integer, Float, Date - These options provide a flat input box for the option to be entered.
String Combo, Integer Combo, Float Combo - These options provide a list of options to choose from in the respective data format.
Click Save.
Select your new Dashboard Filter from the Parameter Options dropdown.
Click Save.
Related pages
Last updated
Was this helpful?