Flashboard parameters
Flashboard customizable parameters
The following table describes customizable parameters.
Parameter | Description | Adobe Flash rendering | HTML rendering |
---|---|---|---|
customizable | The parameters specified in the Custom Properties for the Data Visualization field. For example, customizable=1 To use this parameter for a flashboard:
For example, if you enter the following line, users can customize only the chart title and chart type: Value indicating whether to display the user customization flashboard option on the chart:
| ✅️ | ✅️ Supports only Chart Type |
customQual | A custom qualification you specify that overrides the qualification defined in the variable. The customQual parameter is used for real-time data. If you want to query on scheduled data, use varhistoryqual or varsummaryqual. To search for values that are null, use the $NULL$ keyword in the qualification. | ✅️ | ✅️ |
enableDrilldown | Value indicating whether to allow data drill-down:
| ✅️ | ✅️ |
prefixseriesnames | Value indicating how to include a prefix in series names for variables that have a Group By option:
To add a label, enter it in the Label field on Variables panel when creating or editing a flashboard. | ✅️ | ❌️ |
varcustomqual | A custom qualification you specify that overrides the qualification defined in the variable. For example: varcustomqual= varIndex1 : customQual1 : varIndex2 : customQual2 varcustomqual=0:'4'="Demo":1:'2'="User" varindex begins its numbering sequence at 0, and the index is the position at which the variable appears on the Variables panel of the flashboard in Developer Studio. Warning: If you set the varcustomqual parameter to empty (“”), it overrides customQual when you use both parameters at the same time. This can lead to unexpected results. | ✅️ | ❌️ |
vargbvalcolors | A parameter used to set custom colors to each value in a variable. For example: vargbvalcolors= varIndex1:val1-colorStr1-val2-colorStr2-...:varIndex2:... vargbvalcolors=0:0-ff0000-1-00ff00-2-0000ff:1:Demo-LHFF000000FF00-User-RVFFFFFF000000-...:2:... | ✅️ | ❌️ |
varhistoryqual | A qualification used for scheduled data. The values are varindex and historyqual, for example: varhistoryqual=varindex1:historyqual1:varindex2:historyqual2 varindex is 0 to the number of variables in the flashboard, and the index is the position at which it appears on the Variables panel of the flashboard in Developer Studio. The history qualification can contain the following special fields:
For example:'SampleTime' > "10/10/2005" AND 'SampleTime' < "11/10/2005" AND 'PrimaryGBValue' = "john" | ✅️ | ❌️ |
varsummaryqual | A qualification used for scheduled data. The values are varindex and summaryqual, for example: varsummaryqual=varindex1: summaryqual1:varindex2:summaryqual2 varindex is 0 to the number of variables in the flashboard, and the index is the position at which it appears on the Variables panel of the flashboard in Developer Studio. The summary qualifications can contain:
| ✅️ | ❌️ |
Flashboard display parameters
The following table describes display parameters for chart:
Parameter | Description | Adobe Flash rendering | HTML rendering |
---|---|---|---|
axisOrientation | Axis orientation:
| ✅️ | ✅️
|
backgroundColor | Background color, specified as a hexadecimal string in the format RRGGBB, where RR, GG, and BB represent values for red, green and blue, respectively. | ✅️ | ✅️ |
chartBorderWidth | Width of the chart border in pixels. | ✅️ | ❌️ |
chartTitle | Title of the chart. | ✅️ | ✅️ |
chartType | Type of chart:
| ✅️ | ✅️ |
flashboardType | Type of flashboard to be displayed:
| ❌️ | ✅️ |
height | Height of the flashboard image in pixels. | ✅️ | ✅️ |
legendPlacement | Location of legend in display:
| ✅️ | ✅️ |
legendShow | Value indicating whether to display the legend:
| ✅️ | ✅️ |
legendTitle | String to be used as the legend title. | ✅️ | ❌️ |
rangeMaximum | Maximum Y axis value, if yAxisRangeAuto is:
| ✅️ | ✅️ |
rangeMinimum | Minimum Y axis value, if yAxisRangeAuto is:
| ✅️ | ✅️ |
showValues | Value indicating whether to show point values in flashboard:
| ✅️ | ❌️ |
topgbnum | The number of primary Group By values to be drawn on the flashboard and shown on the legend. The default value is 0, which indicates that the top legend values are off. | ✅️ | ❌️ |
topgbshowother | Value indicating whether to show or hide the "Other" item (the consolidated series) and its values:
| ✅️ | ❌️ |
varDataType | The type of variable information to display:
| ✅️ | ❌️ |
width | Width of the flashboard image in pixels. | ✅️ | ✅️ |
xAxisLabel | Label to appear on the X axis. This parameter is not applicable to pie charts, meters, and text. | ✅️ | ✅️ |
xAxisShowGridLines | Value indicating whether to show gridlines on the X axis:
This parameter is not applicable to pie charts, meters, and text. | ✅️ | ✅️ |
yAxisLabel | Label to appear on the Y axis. This parameter is not applicable to pie charts, meters, and text. | ✅️ | ✅️ |
yAxisRangeAuto | Value indicating whether to automatically determine the range of the Y axis:
This parameter is not applicable to pie charts, meters, and text. | ✅️ | ❌️ |
yAxisShowGridLines | Value indicating whether to show gridlines on the Y axis:
This parameter is not applicable to pie charts, meters, and text. | ✅️ | ✅️ |
Flashboard meter parameters
The following table describes parameters that apply to meters:
Parameter | Description | Adobe Flash rendering | HTML rendering |
---|---|---|---|
alertThreshold | Percentage of the meter range dedicated to the alert threshold (red section). | ✅️ | ✅️ |
label | Meter label. | ✅️ | |
meterType | Type of meter displayed:
| ✅️ | |
rangeMaximum | Maximum Y axis value of the variable if yAxisRangeAuto is not set or is set to the maximum value on a meter. | ✅️ | ✅️ |
rangeMinimum | Minimum Y axis value of the variable, if yAxisRangeAuto is not set or is set to the minimum value on a meter. | ✅️ | ✅️ |
title | Meter title. | ✅️ | |
warningThreshold | Percentage of the meter range dedicated to the warning threshold (yellow section). | ✅️ | ✅️ |
Identification parameter | |||
flashboard | Name of the flashboard | ✅️ | ✅️ |