Element: <oj-chart-series>

Oracle® JavaScript Extension Toolkit (JET)
5.2.0
E97691-01

QuickNav

Attributes

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Version:
  • 5.2.0
Since:
  • 5.1.0
Module:
  • ojchart

JET Chart Series

The oj-chart-series element is used to declare series properties in the seriesTemplate slot of oj-chart.


<oj-chart data="[[dataProvider]]">
 <template slot='seriesTemplate'>
   <oj-chart-series
     drilling='on'
     marker-shape='[[ $current.id == "Series 1" ? "square" : "circle" ]]'>
   </oj-chart-series>
 </template>
</oj-chart>

Attributes

area-color :string

The area color of the series. Only applies if series type is area or lineWithArea.
Default Value:
  • null

area-svg-class-name :string

The CSS style class to apply if series type is area or lineWithArea. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the color attribute.
Default Value:
  • null

area-svg-style :Object

The inline style to apply if series type is area or lineWithArea. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the color attribute.
Default Value:
  • null

assigned-to-y2 :string

Defines whether the series is associated with the y2 axis. Only applies to Cartesian bar, line, area, and combo charts.
Supported Values:
Name Type
"off" string
"on" string
Default Value:
  • "off"

border-color :string

The border color of the series.
Default Value:
  • null

border-width :number

The border width of the series.
Default Value:
  • null

box-plot :Object

An object containing the style properties of the box plot series.

box-plot.median-svg-class-name :string

The CSS style class to apply to the median line.
Default Value:
  • null

box-plot.median-svg-style :Object

The CSS inline style to apply to the median line.
Default Value:
  • null

box-plot.q2-color :string

The color of the Q2 segment of the box.
Default Value:
  • null

box-plot.q2-svg-class-name :string

The CSS style class to apply to the Q2 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q2Color attribute.
Default Value:
  • null

box-plot.q2-svg-style :Object

The CSS inline style to apply to the Q2 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q2Color attribute.
Default Value:
  • null

box-plot.q3-color :string

The color of the Q3 segment of the box.
Default Value:
  • null

box-plot.q3-svg-class-name :string

The CSS style class to apply to the Q3 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q3Color attribute.
Default Value:
  • null

box-plot.q3-svg-style :Object

The CSS inline style to apply to the Q3 segment of the box. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the q3Color attribute.
Default Value:
  • null

box-plot.whisker-end-length :string

Specifies the length of the whisker ends in pixels (e.g. '9px') or as a percentage of the box width (e.g. '50%').
Default Value:
  • null

box-plot.whisker-end-svg-class-name :string

The CSS style class to apply to the whisker ends.
Default Value:
  • null

box-plot.whisker-end-svg-style :Object

The CSS inline style to apply to the whisker ends.
Default Value:
  • null

box-plot.whisker-svg-class-name :string

The CSS style class to apply to the whisker stems.
Default Value:
  • null

box-plot.whisker-svg-style :Object

The CSS inline style to apply to the whisker stems.
Default Value:
  • null

categories :Array.<string>

An optional array of category strings corresponding to this series. This allows highlighting and filtering of a series through interactions with legend sections. If not defined, the series id is used.
Default Value:
  • null

color :string

The color of the series.
Default Value:
  • null

display-in-legend :string

Defines whether the series should be shown in the legend. When set to 'auto', the series will not be displayed in the legend if it has null data or if it is a stock, funnel, or pyramid series.
Supported Values:
Name Type
"auto" string
"off" string
"on" string
Default Value:
  • "auto"

drilling :string

Whether drilling is enabled on the series item. Drillable objects will show a pointer cursor on hover and fire an ojDrill event on click. To enable drilling for all series items at once, use the drilling attribute in the top level.
Supported Values:
Name Type
"inherit" string
"off" string
"on" string
Default Value:
  • "inherit"

line-style :string

The line style of the data line. Only applies to line, lineWithArea, scatter, and bubble series.
Supported Values:
Name Type
"dashed" string
"dotted" string
"solid" string
Default Value:
  • "solid"

line-type :string

The line type of the data line or area. Only applies to line, area, scatter, and bubble series. centeredStepped and centeredSegmented are not supported for polar, scatter, and bubble charts.
Supported Values:
Name Type
"auto" string
"centeredSegmented" string
"centeredStepped" string
"curved" string
"none" string
"segmented" string
"stepped" string
"straight" string
Default Value:
  • "auto"

line-width :number

The width of the data line. Only applies to line, lineWithArea, scatter, and bubble series.
Default Value:
  • null

marker-color :string

The color of the data markers, if different from the series color.
Default Value:
  • null

marker-displayed :string

Defines whether the data markers should be displayed. Only applies to line, area, scatter, and bubble series. If auto, the markers will be displayed whenever the data points are not connected by a line.
Supported Values:
Name Type
"auto" string
"off" string
"on" string
Default Value:
  • "auto"

marker-shape :string

The shape of the data markers. In addition to the built-in shapes, it may also take SVG path commands to specify a custom shape. The chart will style the custom shapes the same way as built-in shapes, supporting properties like color and borderColor and applying hover and selection effects. Only 'auto' is supported for range series.
Supported Values:
Name Type Argument
"auto" string <optional>
"circle" string <optional>
"diamond" string <optional>
"human" string <optional>
"plus" string <optional>
"square" string <optional>
"star" string <optional>
"triangleDown" string <optional>
"triangleUp" string <optional>
Default Value:
  • "auto"

marker-size :number

The size of the data markers.
Default Value:
  • null

marker-svg-class-name :string

The CSS style class to apply to the data markers.The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the marker color attribute.
Default Value:
  • null

marker-svg-style :Object

The inline style to apply to the data markers. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the marker color attribute.
Default Value:
  • null

name :string

The name of the series, displayed in the legend and tooltips.
Default Value:
  • null

pattern :string

The pattern used to fill the series. A solid fill is used by default, unless the seriesEffect is 'pattern'.
Supported Values:
Name Type
"auto" string
"largeChecker" string
"largeCrosshatch" string
"largeDiagonalLeft" string
"largeDiagonalRight" string
"largeDiamond" string
"largeTriangle" string
"smallChecker" string
"smallCrosshatch" string
"smallDiagonalLeft" string
"smallDiagonalRight" string
"smallDiamond" string
"smallTriangle" string
Default Value:
  • "auto"

pie-slice-explode :number

A number from 0 to 1 indicating the amount to explode the pie slice. Only applies to pie charts.
Default Value:
  • 0

short-desc :string

The description of this series. This is used for accessibility and for customizing the tooltip text on the corressponding legend item for the series.
Default Value:
  • null

source :string

The URI of the custom image. If specified, it takes precedence over shape.
Default Value:
  • null

source-hover :string

The optional URI for the hover state. If not specified, the source image will be used.
Default Value:
  • null

source-hover-selected :string

The optional URI for the hover selected state. If not specified, the source image will be used.
Default Value:
  • null

source-selected :string

The optional URI for the selected state. If not specified, the source image will be used.
Default Value:
  • null

stack-category :string

In stacked charts, groups series together for stacking. All series without a stackCategory will be assigned to the same stack.
Default Value:
  • null

svg-class-name :string

The CSS style class to apply to the series. For series of type lineWithArea, this style will only be applied to the line if areaClassName is also specified. The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the color attribute.
Default Value:
  • null

svg-style :Object

The inline style to apply to the series. For series of type lineWithArea, this style will only be applied to the line if areaStyle is also specified.The style class and inline style will override any other styling specified through the properties. For tooltips and hover interactivity, it's recommended to also pass a representative color to the color attribute.
Default Value:
  • null

type :string

The type of data objects to display for this series. Only applies to bar, line, area, stock, box plot, and combo charts.
Supported Values:
Name Type
"area" string
"auto" string
"bar" string
"boxPlot" string
"candlestick" string
"line" string
"lineWithArea" string
Default Value:
  • "auto"