Flashboard parameters


Flashboard parameters provide a dynamic nature to flashboards. The flashboard parameters enable you to tweak the flashboard's look and feel, and even behavior.  You can use the flashboard parameters outlined on this topic.

Related topics

Configuring the flashboard display using 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:

  1. In Developer Studio, open the form.
  2. Select the Data Visualization field that references the flashboard.
  3. In the Properties tab, click Custom Properties, and enter the expression customizableparams= followed by the customizable options to display (in lowercase and separated by single spaces).

For example, if you enter the following line, users can customize only the chart title and chart type: 
customizableparams=charttitle charttype

Value indicating whether to display the user customization flashboard option on the chart:

  • 0—Do not display the flashboard customization option
  • 1—Display the flashboard customization option. If this option is enabled, users see a flashboard that contains a Customize Chart button and two fields that allow users to select the type of change and the value for the change. The customize options and values are:
  • Chart Title—Any value.
  • Chart Type—The values are:
    • Line Chart
    • Bar Chart
    • Stacked Bar Chart
    • Area Chart
    • Stacked Area Chart
    • Pie Chart
  • Legend Title—Any value.
  • X Axis label—Any value.
  • Y Axis label—Any value.

✅️

✅️

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:

  • 0—Disable drill-down.
  • 1—Enable drill-down.

✅️

✅️

prefixseriesnames

Value indicating how to include a prefix in series names for variables that have a Group By option:

  • 0 (default)—The variable label and name appears only if a series with the same name already exists.
  • 1—The variable label is added at the front of all series' names (set by the Group By option) in the legend (if shown) or when the user moves the cursor over the flashboard. If a label is not entered in the Label field, the variable name is displayed.

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:

  • Value—The statistical value.
  • SampleTime—The time at which the history sample was taken.
  • PrimaryGBVal—The primary Group By value.
  • SecondaryGBVal—The secondary Group By value (Even though this value is not plotted, one can still use it for qualifications, history, and summary).

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:

  • Value—The statistical value.
  • PeriodStartTime—The starting time for the summary interval.
  • PeriodEndTime—The ending time for the summary interval.
  • PrimaryGBVal—The primary Group By value.
  • SecondaryGBVal—The secondary Group By value.

✅️

❌️

Flashboard display parameters

The following table describes display parameters for chart:

Parameter

Description

Adobe Flash

rendering

HTML rendering

axisOrientation

Axis orientation:

  • 0—X bottom Y left
  • 1—X top Y left
  • 2—X top Y right
  • 3—X bottom Y right
  • 4—Y bottom X left
  • 5—Y top X left
  • 6—Y top X right
  • 7—Y bottom X right

✅️

✅️

  • 0—X bottom Y left
  • 1—X top Y left
  • 4—Y bottom X left

backgroundColor

Background color, specified as a hexadecimal string in the format RRGGBB, where RRGG, 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:

  • 0—Line
  • 1—Bar
  • 2—Stacked bar
  • 3—Area
  • 4—Stacked area
  • 5—Pie

✅️

✅️

flashboardType

Type of flashboard to be displayed:

  • 0—Chart
  • 1—Meter
  • 2—Text

❌️

✅️

height

Height of the flashboard image in pixels.

✅️

✅️

legendPlacement

Location of legend in display:

  • 0—Right
  • 1—Left
  • 2—Top
  • 3—Bottom

✅️

✅️


legendShow

Value indicating whether to display the legend:

  • 0—Do not show legend (default).
  • 1—Show legend.

✅️

✅️

legendTitle

String to be used as the legend title.

✅️

❌️

rangeMaximum

Maximum Y axis value, if yAxisRangeAuto is:

  • Not set.
  • Maximum value on a meter.

✅️

✅️

rangeMinimum

Minimum Y axis value, if yAxisRangeAuto is:

  • Not set.
  • Minimum value on a meter.

✅️

✅️

showValues

Value indicating whether to show point values in flashboard:

  • 0—Do not show point values on chart (default).
  • 1—Show point values on chart (values display only in line, bar, and pie charts, not in stacked charts).

✅️

❌️

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:

  • 0 (default)—Do not show the Other item; show only the number of graph series set in the topgbnum parameter.
  • 1--Show the Other item.

✅️

❌️

varDataType

The type of variable information to display:

  • 0—Real time
  • 1—History
  • 2—Summary
  • 3—History till date

✅️

❌️

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:

  • 0—Do not show gridlines (default).
  • 1—Show gridlines.

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:

  • 0—Do not automatically determine range.
  • 1—Automatically determine range (default).

This parameter is not applicable to pie charts, meters, and text.

✅️

❌️

yAxisShowGridLines

Value indicating whether to show gridlines on the Y axis:

  • 0—Do not show gridlines (default).
  • 1—Show gridlines.

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:

  • 0—Pie (part of a circle)
  • 1—Circle (full circle)
  • 2—Chord (half circle)
  • 3—Thermometer

✅️

❌️

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

✅️

✅️

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*