Parameter | Values | Description |
---|---|---|
type: | pie stacked cluster line area combo | Defines the type of chart to display. Required |
showLegend: | true false | Defines if the chart should have a legend displayed. Optional (default is true) |
legendPosition: | left right bottom top | Defines where the legend should appear. Optional (default is right) Setting position to left or right will automatically render it vertically. Setting position to top or bottom will automatically render it horizontally. |
legendBorder: | true false | Defines if the legend should display with a border around it. Optional (default is false ) |
depth: | true false | A value of true indicates a 3 dimensional depth for the chart. Optional (default false, which is a 2 dimensional chart) |
animate: | true false | A value of true indicates that the graph should animate when displayed. Optional (default is true). When using large data sets, consider disabling animation. |
dataCursor: | on off | A value of on enables hovering anywhere in the graph. Optional (default is off). It is not applicable to pie charts. |
orientation: | horizontal | Defines the chart orientation. This only applies to bar, line, area, combo charts. E.g., oraChart="type:cluster; orientation:horizontal", defines horizontal cluster chart. Optional (default is vertical). |
Parameter | Values | Description |
---|---|---|
list: | XPath value | Defines the XPath to the list in the XML that contains the data to chart. Required only for HTML definitions in UI Maps. Data explorer values are derived from the columns for the zone. |
amount: | Cn Pn XPath value | Defines the element containing the amount to chart. For data explorers, this will be a SQL or post-processing column identifier. For HTML definitions, the XPath of the element must be specified. Required |
xaxis: | Cn Pn XPath value | Defines the element containing the x-axis data. For data explorers, this will be a SQL or post-processing column identifier. For HTML definitions, the XPath of the element is specified. Required for Stacked, Cluster, Line, Area and Combo charts. |
xaxisFormat: | date dateTime time localDate string | Defines the x-axis data format. If it is date, dateTime or time then the value is presented in the format as defined on the user’s display profile. In case of localDate or string the data is displayed as is with no special formatting. Optional (Default is date). |
label: | Text value | Defines the label for the amount being charted. Either this setting or labelPath: must be defined. |
labelPath: | Cn Pn XPath value | Defines the element that provides the label for the amount being charted. For data explorers, this will be a SQL or post-processing column identifier. For HTML definitions, the XPath of the element must be specified. Either this setting or label: must be defined. |
currency: | A valid Currency code | Defines the currency code for the amount being charted. Optional. |
currencyPath: | Cn Pn XPath value | Defines the element that provides the currency code for the amount being charted. For data explorers, this will be a SQL or post-processing column identifier. For HTML definitions, the XPath of the element must be specified. Optional. |
hoverText: | Text value | Defines the hover text for the chart element. Optional (A default hover text is always available.) Ignored if hoverTextPath: is defined. The following substitution variables are available. • $label This will be replaced with the label text as determined by the label: or labelPath: setting. • $amount This will be replaced with the amount text as specified by the amount: setting. • $axis This will be replaced with the x-axis text. • $% This will be replaced by the percentage "slice" of the pie or bar. • $newline This will force a line break. If the hover text defined contains any of the above values, they will be replaced by the equivalent text prior to being displayed. Example: "hoverText:$label$newline$amount" |
hoverTextPath: | Cn Pn XPath value | Defines the element that provides the hover text for the chart element. For data explorers, this will be a SQL or post-processing column identifier. For HTML definitions, the XPath of the element must be specified. The hover text in the element can utilize all the substitution functionality described above in the hoverText: description. Optional. |
type: | bar line area | This attribute is used for the combo chart type only. It defines how each series on the combo chart should be presented. The following example defines a combo chart where one series is rendered as bars and another one as area. oraChart="type:combo;" oraChartSeries1="xaxis:C3; label:C2; amount:C1;type:bar" oraChartSeries2="xaxis:C3; label:C2; amount:C1;type:area" |
navOpt: | A valid Navigation Option code. | Defines a navigation option to be activated when the chart element is clicked. Optional. |
navOptPath: | Cn Pn XPath value | Defines the element that provides the navigation option to be activated when the chart element is clicked. For data explorers, this will be a SQL or post-processing column identifier. For HTML definitions, the XPath of the element must be specified. Optional Note that both navOpt: and navOptPath: may be configured. The navOptPath: navigation option is processed first. If a value is found it is used, otherwise the value in the navOpt: setting is used. This means that the chart definition can include a default navigation option and a navigation option present in the data will override it. |
key: | Cn Pn XPath value | Defines the element that contains the key field data to be used in a navigation option. For data explorers, this will be a SQL or post-processing column identifier. For HTML definitions, the XPath of the element must be specified. This is required if either navOpt: or navOptPath: is defined. Note: Only one key field can be configured for a navigation option. |
script: | A BPA script name | Defines a BPA script to be activated when the chart element is clicked. Optional When a script is executed, all the elements from the chart data will be made available to the script as temporary variables. |
scriptPath: | Cn Pn XPath value | Defines the element that provides the BPA script to be activated when the chart element is clicked. For data explorers, this will be a SQL or post-processing column identifier. For HTML definitions, the XPath of the element must be specified. Optional Note that both script: and scriptPath: can be configured. The scriptPath: script option is processed first. If a value is found it is used, otherwise the value in the script: setting is used. This means the chart definition can include a default script and a script present in the data will override it. |
color: | HTML Color code / RGB value | Optional (default colors applied) Defines the color for the series. The format is a valid HTML color code, e.g. green or blue. All valid color names are defined in this link: http://www.w3schools.com/htmL/html_colornames.asp. Alternatively an RGB format may be used. (00FF00 is green and 0000FF is blue) Note: Refer to Color Contrast for information about the use of the HTML color 'red' and its impact on accessibility. |
colorPath: | Cn Pn XPath value | Defines the element containing a color for the series. For data explorers, this will be a SQL or post-processing column identifier. For HTML definitions, the XPath of the element must be specified. The valid formats as described in the color: setting apply. Optional (default colors applied) |
pieColors: | HTML color code / RGB values | Defines the colors for the pie series. Any number of HTML color codes or RGB color values can be specified, separated by spaces. Examples: pieColors: green blue pieColors: 00FF00 0000FF Optional (default colors are applied if the series exceeds the values specified) |