This documentation supports the 9.0 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

Display parameters for charts

The following table describes chart parameters.

Display parameters for charts

Parameter Description Powered by Adobe Flash Image-based
Default format and color scheme 7.1.00/7.0.01 color scheme 7.1.00/7.0.01 color and format
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
+ + +
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 Chart title. + + +
chartType

Type of chart:

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

Value indicating whether to display the flashboard in 3D:

  • 0 — Do not display in three dimensions (default).
  • 1 — Display in three dimensions.
+
displayTable

Value that indicates whether to display chart data in table form:

  • 0 — Do not display chart data in table form (default).
  • 1 — Always display chart data in table form.
+ + +
endDate

Time frame custom end date, in seconds, since January 1, 1970, 00:00:00 GMT. You can change this parameter only if the timeFrame parameter is set to Custom. Optionally, you can also set the end date using the following format:MM/DD/YYYY HH:NN:SS For example: endDate = 11/30/2011 16:55:11

Note

Applies only to trend charts.

+ + +
fgTransparency Foreground transparency level for the flashboard. This value must be a real number between 0 and 1. + +
flashboardType

Type of flashboard to be displayed:

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

Foreground color, specified as a hexadecimal string in the RRGGBB format, where RR, GG, and BB represent values for red, green, and blue, respectively.

Note

You can specify the foreground color for meters, but not for other types of flashboards.

+ +
gbcolors Specifies the colors of the chart elements, such as individual bars, for the Group By variables. The color order is dependent on the Group By order. The gbcolors parameter is specified as a hexadecimal list separated by spaces in the RRGGBB format, where RR, GG, and BB represent values for red, green, and blue, respectively. For example, a value of FF0000 designates a red color, a value of 00FF00 designates a blue color, and 0000FF designates a green color. The syntax for this example would be:gbcolors=FF0000 00FF00 0000FF In this example, the resulting chart displays a bar chart with red, blue, and green bars for the corresponding Group By order. + + +
height Height of the flashboard image in pixels. +
label Label for meters or text boxes. +
legendBorderWidth Width of the legend border 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. + + +
outlineLegendKeys

Value indicating whether to draw an outline around legend keys:

  • 0 — Do not draw outline.
  • 1 — Draw an outline (default).
+ + +
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).
+ +
sortType

Type of sorting:

  • 0 — (default) Do not use the sorting option.
  • 1 — Sort by Value.
  • 2 — Sort by Attribute.
+ +
sortOrder

Sort order:

  • 0 — Ascending (default)
  • 1 — Descending
+ +
sortAttribute Text value from the secondary Group by field. + +
sortIsAttributeEnum

Whether the value of the secondary Group by field is enum or non-enum:

  • 0 — Value in secondary Group by field is non-enum.
  • 1 — Value in secondary Group by field is enum.
+ +
startDate

Time frame custom start date, in seconds, since January 1, 1970, 00:00:00 GMT.

Note

This parameter is valid only when the timeFrame parameter value is set to "Custom".

Optionally, you can set the start date using the following format:MM/DD/YYYY HH:NN:SS For example: startDate = 11/30/2011 16:55:11

Note

This parameter applies only to charts that show trends.

+ + +
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.
+ + +
topgbsort

Value indicating the sort order for the legend:

  • 0 — Ascending order; shows the bottom n values (default).
  • 1 — Descending order; shows the top n values.
+ + +
topgbotheralias The alias for the "Other" Group By value in the legend and tooltips. The default is Other. The format is as follows: topgbotheralias= string + + +
topggbothercolor The color value to be used while drawing the "Other" item. The default is auto color choosing. The format is as follows:topggbothercolor= c olorString + + +
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.

+ +
xAxisTime

Value indicating whether to display time on the X axis:

  • 0 — Do not display time.
  • 1 — Display time.

This parameter is not applicable to pie charts, meters, and text. With xAxisTime set to 1, you can create a real-time-based chart when you group by a date/time or date field.

+ + +
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.

+ +

Was this page helpful? Yes No Submitting... Thank you

Comments