\nTo make your component accessible, the application is required to include contextual information for screen readers using either:\n
\n
aria-labelledby
\n
aria-label
\n
\nIt is also recommended to include appropriate short-desc property values for your items to enhance accessibility.\n\n
\n If your application has custom keyboard and touch shortcuts implemented for the component, these shortcuts can conflict with those of the component.\n It is the application's responsibility to disclose these custom shortcuts, possibly via a datatip or help popup.\n
\n
\n When setting color, applications are responsible for making sure that the color meets the minimum contrast requirements.\n
\n\n
\n Keyboard End User Information\n \n
\n
\n \n
\n
Key
\n
Action
\n
\n \n \n
\n
Tab
\n
Move focus to next element.
\n
\n
\n
Shift + Tab
\n
Move focus to previous element.
\n
\n
\n
UpArrow
\n
Move focus and selection to previous data item.
\n
\n
\n
DownArrow
\n
Move focus and selection to next data item.
\n
\n
\n
LeftArrow
\n
Move focus and selection to previous data item.
\n
\n
\n
RightArrow
\n
Move focus and selection to next data item.
\n
\n
\n
Shift + UpArrow
\n
Move focus and multi-select previous data item.
\n
\n
\n
Shift + DownArrow
\n
Move focus and multi-select next data item.
\n
\n
\n
Shift + LeftArrow
\n
Move focus and multi-select previous data item.
\n
\n
\n
Shift + RightArrow
\n
Move focus and multi-select next data item.
\n
\n
\n
Ctrl + UpArrow
\n
Move focus to previous data item, without changing the current selection.
\n
\n
\n
Ctrl + DownArrow
\n
Move focus to next data item, without changing the current selection.
\n
\n
\n
Ctrl + LeftArrow
\n
Move focus to previous data item, without changing the current selection.
\n
\n
\n
Ctrl + RightArrow
\n
Move focus to next data item, without changing the current selection.
\n
\n
\n
Ctrl + Spacebar
\n
Multi-select data item with focus.
\n
\n
\n
= or +
\n
Zoom in one level if zooming is enabled.
\n
\n
\n
- or _
\n
Zoom out one level if zooming is enabled.
\n
\n
\n
PageUp or Shift + PageUp
\n
Pan left in left-to-right locales. Pan right in right-to-left locales.
\n
\n
\n
PageDown or Shift + PageDown
\n
Pan right in left-to-right locales. Pan left in right-to-left locales.
\n
\n
\n
Enter
\n
Drill on data item, categorical axis label, or legend item when drilling is enabled.
\n
\n
\n
Shift+F10
\n
Launch the context menu if there is one associated with the current item.
\n
\n \n
\n\n
\n Performance\n \n
\n\n
Data Set Size
\n
As a rule of thumb, it's recommended that applications only set usable data densities on the chart. For example,\n it's not recommended to show more than 500 area series on a 500 pixel wide chart, since the areas will be unusably thin.\n While there are several optimizations within the chart to deal with large data sets, it's always more efficient to\n reduce the data set size as early as possible. Future optimizations will focus on improving end user experience as\n well as developer productivity for common use cases.\n
\n\n
Styling
\n
Use the highest level property available. For example, consider setting styling properties on\n styleDefaults or series, instead of styling properties\n on the individual data items. The chart can take advantage of these higher level properties to apply the style properties on\n containers, saving expensive DOM calls.\n
\n\n\n
\nTouch End User Information\n \n
\n\n
\n \n
\n
Target
\n
Gesture
\n
Action
\n
\n \n \n
\n
Data Item
\n
Tap
\n
Select when selectionMode is enabled.
\n
\n
\n
Drill when drilling is enabled and selectionMode is none.
\n
\n
\n
Double Tap
\n
Drill when drilling is enabled and selectionMode is enabled.
\n
\n
\n
Press & Hold
\n
Display datatip.
\n
\n
\n
Display context menu on release.
\n
\n
\n
Categorical Axis Item
\n
Tap
\n
Drill when drilling is enabled.
\n
\n
\n
Press & Hold
\n
Display context menu on release.
\n
\n
\n
Legend Item
\n
Tap
\n
Drill when drilling is enabled.
\n
\n
\n
Filter when hideAndShowBehavior is enabled.
\n
\n
\n
Plot Area
\n
Drag
\n
Pan when panning is enabled and toggled into that mode.
\n
\n
\n
Marquee select when selectionMode is multiple and toggled into that mode.
\n
\n
\n
Pinch-close
\n
Zoom out when zooming is enabled.
\n
\n
\n
Spread-open
\n
Zoom in when zooming is enabled.
\n
\n
\n
Press & Hold
\n
Display context menu on release.
\n
\n
\n
Series Area
\n
Press & Hold
\n
Display context menu on release.
\n
\n
\n
Axis Title
\n
Press & Hold
\n
Display context menu on release.
\n
\n \n
",
"scope": "static",
"tagWithoutBrackets": "oj-c-area-chart",
"tagWithBrackets": "",
"domInterface": "CAreaChartElement",
"ojPageTitle": "<oj-c-area-chart>",
"camelCaseName": "AreaChart",
"ojPageTitlePrefix": "Element: ",
"ojtsvcomponent": true,
"tstype": {
"target": "Type",
"value": "interface CAreaChartElement | any> extends JetElement>"
},
"ojsignature": [
{
"target": "Type",
"value": "interface CAreaChartElement | any> extends JetElement>"
}
],
"tsdeprecated": [
{
"type": "candidate",
"since": "17.0.0"
}
],
"extension": {
"catalog": {
"category": "Visualizations"
},
"vbdt": {
"module": "oj-c/area-chart",
"defaultColumns": 6,
"minColumns": 1
},
"oracle": {
"icon": "oj-ux-ico-area-chart",
"uxSpecs": [
"area-chart"
]
}
},
"ojmodule": "area-chart"
},
{
"id": "oj-c.AreaChart#data",
"name": "data",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#data",
"scope": "instance",
"type": {
"names": [
"DataProvider|null"
]
},
"optional": true,
"ojdisplayname": "Data",
"ojshortdesc": "Specifies the DataProvider for the sections and items of the area-chart.",
"description": "Specifies the DataProvider for the sections and items of the area-chart.\nA progressive loading indicator is shown by the component when the data provider fetch takes longer than a certain time.",
"tstype": [
{
"target": "Type",
"value": "DataProvider|null",
"jsdocOverride": true,
"module": {
"DataProvider": "ojdataprovider"
}
}
]
},
{
"id": "oj-c.AreaChart#seriesComparator",
"name": "seriesComparator",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#seriesComparator",
"scope": "instance",
"type": {
"names": [
"function"
]
},
"optional": true,
"ojdisplayname": "Series Comparator",
"ojshortdesc": "A comparator function that determines the ordering of the chart series when using a DataProvider. If undefined, the series will follow the order in which they are found in the data.",
"description": "A comparator function that determines the ordering of the chart series when using a DataProvider.\nIf undefined, the series will follow the order in which they are found in the data. The series objects will have the same properties as the context for seriesTemplate's $current.\nIf seriesComparator(a, b) is less than 0, chart series a comes before chart series b.\nIf seriesComparator(a, b) is 0, the original order is preserved.\nIf seriesComparator(a, b) is greater than 0, chart series b comes before chart series a.",
"tstype": [
{
"target": "Type",
"value": "(context1: oj-c.AreaChart.ChartSeriesTemplateContext, context2: oj-c.AreaChart.ChartSeriesTemplateContext) => number",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#groupComparator",
"name": "groupComparator",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#groupComparator",
"scope": "instance",
"type": {
"names": [
"function"
]
},
"optional": true,
"ojdisplayname": "Group Comparator",
"ojshortdesc": "A comparator function that determines the ordering of the chart groups when using a DataProvider. If undefined, the group will follow the order in which they are found in the data.",
"description": "A comparator function that determines the ordering of the chart groups when using a DataProvider.\nIf undefined, the group will follow the order in which they are found in the data. The group objects will have the same properties as the context for groupTemplate's $current.\nIf groupComparator(a, b) is less than 0, chart group a comes before chart group b.\nIf groupComparator(a, b) is 0, the original order is preserved.\nIf groupComparator(a, b) is greater than 0, chart group b comes before chart group a.",
"tstype": [
{
"target": "Type",
"value": "(context1: oj-c.AreaChart.ChartGroupTemplateContext, context2: oj-c.AreaChart.ChartGroupTemplateContext) => number",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#stack",
"name": "stack",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#stack",
"scope": "instance",
"type": {
"names": [
"\"off\"",
"\"on\""
]
},
"optional": true,
"ojdisplayname": "Stack",
"description": "Defines whether the data items are stacked.",
"ojvalues": [
{
"name": "on",
"description": "Data items belonging to same group will be stacked.",
"displayName": "On",
"type": {
"names": [
"string"
]
}
},
{
"name": "off",
"description": "Data items will not be stacked.",
"displayName": "Off",
"type": {
"names": [
"string"
]
}
}
],
"ojvalueskeeporder": true,
"defaultvalue": "'off'"
},
{
"id": "oj-c.AreaChart#drilling",
"name": "drilling",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#drilling",
"scope": "instance",
"type": {
"names": [
"\"off\"",
"\"on\""
]
},
"optional": true,
"ojdisplayname": "Drilling",
"ojshortdesc": "Whether drilling is enabled.",
"description": "Whether drilling is enabled. Drillable objects will show a pointer cursor on hover and fire an ojItemDrill, ojSeriesDrill and\nojGroupDrill event on click (double click if selection is enabled). Use \"on\" to enable drilling for all series objects (legend items), group objects (x-axis labels),\nand data items. To enable or disable drilling on individual series, group, or data item, use the drilling attribute in each series, group, or data item.",
"ojvalues": [
{
"name": "on",
"description": "Drilling is enabled on data items, axis labels and legend items.",
"displayName": "On",
"type": {
"names": [
"string"
]
}
},
{
"name": "off",
"description": "Drilling is not enabled.",
"displayName": "Off",
"type": {
"names": [
"string"
]
}
}
],
"ojvalueskeeporder": true,
"defaultvalue": "'off'"
},
{
"id": "oj-c.AreaChart#orientation",
"name": "orientation",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#orientation",
"scope": "instance",
"type": {
"names": [
"\"horizontal\"",
"\"vertical\""
]
},
"optional": true,
"ojdisplayname": "Orientation",
"description": "The orientation of the chart.",
"ojvalues": [
{
"name": "horizontal",
"description": "Chart will be horizontally oriented.",
"displayName": "On",
"type": {
"names": [
"string"
]
}
},
{
"name": "vertical",
"description": "Chart will be vertically oriented.",
"displayName": "Off",
"type": {
"names": [
"string"
]
}
}
],
"ojvalueskeeporder": true,
"defaultvalue": "'vertical'"
},
{
"id": "oj-c.AreaChart#timeAxisType",
"name": "timeAxisType",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#timeAxisType",
"scope": "instance",
"type": {
"names": [
"\"enabled\"",
"\"mixedFrequency\"",
"\"skipGaps\""
]
},
"optional": true,
"ojdisplayname": "TimeAxisType",
"ojshortdesc": "The time axis type of the chart x axis.",
"description": "The type of time axis to display in the chart. If the value is \"enabled\" or \"skipGaps\", the time values must be provided through the \"group-id\" attribute of the\noj-c-area-chart-item element. In this case, stacking is supported. If the value is \"skipGaps\",\nthe groups will be rendered at a regular interval regardless of any time gaps that may exist in the data.\nIf the value is \"mixedFrequency\", the time values must be provided through the \"x\" attribute of the oj-c-area-chart-item\nelement. In this case stacking is not supported.\nThe time values provided must be an ISO date string."
},
{
"id": "oj-c.AreaChart#yAxis",
"name": "yAxis",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#yAxis",
"scope": "instance",
"type": {
"names": [
"object"
]
},
"optional": true,
"ojdisplayname": "Y Axis",
"ojshortdesc": "An object defining y axis properties.",
"description": "An object defining properties for the y axis, tick marks, tick labels, and axis titles.",
"tstype": [
{
"target": "Type",
"value": "oj-c.AreaChart.YAxis",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#y2Axis",
"name": "y2Axis",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#y2Axis",
"scope": "instance",
"type": {
"names": [
"object"
]
},
"optional": true,
"ojdisplayname": "Y2 Axis",
"ojshortdesc": "The y2Axis options for the chart.",
"description": "The y2Axis options for the chart.",
"tstype": [
{
"target": "Type",
"value": "oj-c.AreaChart.Y2Axis",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#splitDualY",
"name": "splitDualY",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#splitDualY",
"scope": "instance",
"type": {
"names": [
"\"off\"",
"\"on\""
]
},
"optional": true,
"ojdisplayname": "Split Dual Y",
"ojshortdesc": "Defines whether the plot area is split into two sections.",
"description": "Defines whether the plot area is split into two sections, so that sets of data assigned to the different Y-axes appear in different parts of the plot area.",
"ojvalues": [
{
"name": "on",
"description": "Plot Area is split into two sections, one for each Y-axis.",
"displayName": "On",
"type": {
"names": [
"string"
]
}
},
{
"name": "off",
"description": "Plot Area is not split.",
"displayName": "Off",
"type": {
"names": [
"string"
]
}
}
],
"ojvalueskeeporder": true,
"defaultvalue": "'off'"
},
{
"id": "oj-c.AreaChart#splitterPosition",
"name": "splitterPosition",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#splitterPosition",
"scope": "instance",
"type": {
"names": [
"number"
]
},
"optional": true,
"ojdisplayname": "Splitter Position",
"ojshortdesc": "Specifies the fraction of the space that is given to the Y-axis subchart.",
"description": "In a split dual-Y chart, specifies the fraction of the space that is given to the Y-axis subchart. Valid values are numbers from 0 to 1.",
"defaultvalue": 0.5
},
{
"id": "oj-c.AreaChart#xAxis",
"name": "xAxis",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#xAxis",
"scope": "instance",
"type": {
"names": [
"object"
]
},
"optional": true,
"ojdisplayname": "X Axis",
"ojshortdesc": "An object defining x axis properties.",
"description": "An object defining properties for the x axis, tick marks, tick labels, and axis titles.",
"tstype": [
{
"target": "Type",
"value": "oj-c.AreaChart.XAxis",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#plotArea",
"name": "plotArea",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#plotArea",
"scope": "instance",
"type": {
"names": [
"object"
]
},
"optional": true,
"ojdisplayname": "Plot Area",
"description": "An object defining the style of the plot area.",
"tstype": [
{
"target": "Type",
"value": "oj-c.AreaChart.PlotArea",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#zoomAndScroll",
"name": "zoomAndScroll",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#zoomAndScroll",
"scope": "instance",
"type": {
"names": [
"\"off\"",
"\"live\""
]
},
"optional": true,
"ojdisplayname": "Zoom And Scroll",
"ojshortdesc": "Specifies the zoom and scroll behavior of the chart.",
"description": "Specifies the zoom and scroll behavior of the chart. \"Live\" behavior means that the chart will be updated continuously as it is being manipulated.\nWhile \"live\" zoom and scroll provides the best end user experience, no guarantess are made about the rendering performance or usability for large data sets or slow client environments."
},
{
"id": "oj-c.AreaChart#valueFormats",
"name": "valueFormats",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#valueFormats",
"scope": "instance",
"type": {
"names": [
"object"
]
},
"optional": true,
"ojdisplayname": "Value Formats",
"ojshortdesc": "An object specifying value formatting and datatip behavior.",
"description": "An object specifying value formatting and datatip behavior, whose keys generally correspond to the attribute names on the data items.",
"tstype": [
{
"target": "Type",
"value": "oj-c.AreaChart.ValueFormats",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#styleDefaults",
"name": "styleDefaults",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#styleDefaults",
"scope": "instance",
"type": {
"names": [
"object"
]
},
"optional": true,
"ojdisplayname": "Style Defaults",
"ojshortdesc": "An object specifying default styles for chart style attributes..",
"description": "Object type defining the default styles for series colors, marker shapes, and other style attributes.\nProperties specified on this object may be overridden by specifications on the data object.",
"tstype": [
{
"target": "Type",
"value": "oj-c.AreaChart.StyleDefaults",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#selectionMode",
"name": "selectionMode",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#selectionMode",
"scope": "instance",
"type": {
"names": [
"\"none\"",
"\"multiple\"",
"\"single\""
]
},
"optional": true,
"ojdisplayname": "Selection Mode",
"ojshortdesc": "Specifies the selection mode.",
"description": "The type of selection behavior that is enabled on the area chart This attribute controls the number of selections that can be made via selection gestures at any given time.",
"ojvalues": [
{
"name": "none",
"description": "No item can be selected.",
"displayName": "None",
"type": {
"names": [
"string"
]
}
},
{
"name": "single",
"description": "Single item can be selected.",
"displayName": "Single",
"type": {
"names": [
"string"
]
}
},
{
"name": "multiple",
"description": "Multiple items can be selected.",
"displayName": "Multiple",
"type": {
"names": [
"string"
]
}
}
],
"ojvalueskeeporder": true,
"defaultvalue": "'none'"
},
{
"id": "oj-c.AreaChart#selection",
"name": "selection",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#selection",
"scope": "instance",
"type": {
"names": [
"Array"
]
},
"optional": true,
"ojdisplayname": "Selection",
"ojwriteback": true,
"description": "An array containing the ids of the initially selected data items.",
"defaultvalue": "'[]'",
"tstype": [
{
"target": "Type",
"value": "Array",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#hiddenCategories",
"name": "hiddenCategories",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#hiddenCategories",
"scope": "instance",
"type": {
"names": [
"Array"
]
},
"optional": true,
"ojdisplayname": "Hidden Categories",
"ojwriteback": true,
"ojshortdesc": "An array of category string used for filtering.",
"description": "An array of category strings used for filtering. Series or data items with any category matching an item in this array will be filtered.",
"defaultvalue": "'[]'"
},
{
"id": "oj-c.AreaChart#dragMode",
"name": "dragMode",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#dragMode",
"scope": "instance",
"type": {
"names": [
"\"off\"",
"\"pan\"",
"\"zoom\"",
"\"select\"",
"\"user\""
]
},
"optional": true,
"ojdisplayname": "Drag Mode",
"ojshortdesc": "The action that is performed when a drag occurs on the chart.",
"description": "The action that is performed when a drag occurs on the chart. Pan and marquee zoom are only available if zoom and scroll is turned on.\nMarquee select is only available if multiple selection is turned on. If the value is set to \"user\" and multiple actions are available,\nbuttons will be displayed on the plot area to let users switch between modes. Only 'select' and 'pan' buttons are shown in mobile, as\nzoom in or out can be performed with 2 finger pinch gesture."
},
{
"id": "oj-c.AreaChart#highlightedCategories",
"name": "highlightedCategories",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#highlightedCategories",
"scope": "instance",
"type": {
"names": [
"Array"
]
},
"optional": true,
"ojdisplayname": "Highlighted Categories",
"ojwriteback": true,
"ojshortdesc": "An array of category string used for highlighting.",
"description": "An array of category strings used for highlighting. Series or data items matching categories in this array will be highlighted.",
"defaultvalue": "'[]'"
},
{
"id": "oj-c.AreaChart#hideAndShowBehavior",
"name": "hideAndShowBehavior",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#hideAndShowBehavior",
"scope": "instance",
"type": {
"names": [
"\"none\"",
"\"withoutRescale\"",
"\"withRescale\""
]
},
"optional": true,
"ojdisplayname": "Hide and Show Behavior",
"ojshortdesc": "Defines the hide and show behavior that is performed when clicking on a leegnd item.",
"description": "Defines the hide and show behavior that is performed when clicking on a legend item. When data items are hidden, the y axes can be optionally rescaled to fit to the remaining data.",
"ojvalues": [
{
"name": "withRescale",
"description": "Rescaling of y axis when items are hidden.",
"displayName": "With Rescale",
"type": {
"names": [
"string"
]
}
},
{
"name": "withoutRescale",
"description": "No rescaling of y axis when items are hidden.",
"displayName": "Without Rescale",
"type": {
"names": [
"string"
]
}
},
{
"name": "none",
"description": "No hide and show behavior.",
"displayName": "None",
"type": {
"names": [
"string"
]
}
}
],
"ojvalueskeeporder": true,
"defaultvalue": "'none'"
},
{
"id": "oj-c.AreaChart#hoverBehavior",
"name": "hoverBehavior",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#hoverBehavior",
"scope": "instance",
"type": {
"names": [
"\"none\"",
"\"dim\""
]
},
"optional": true,
"ojdisplayname": "Hover Behavior",
"description": "Defines the behavior applied when hovering over data items.",
"ojvalues": [
{
"name": "dim",
"description": "Hovered items will be dimmed.",
"displayName": "Dim",
"type": {
"names": [
"string"
]
}
},
{
"name": "none",
"description": "No hover behavior.",
"displayName": "None",
"type": {
"names": [
"string"
]
}
}
],
"ojvalueskeeporder": true,
"defaultvalue": "'none'"
},
{
"id": "oj-c.AreaChart#highlightMatch",
"name": "highlightMatch",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#highlightMatch",
"scope": "instance",
"type": {
"names": [
"\"all\"",
"\"any\""
]
},
"optional": true,
"ojdisplayname": "Highlight Match",
"ojshortdesc": "The matching condition for the highlighted property.",
"description": "The matching condition for the highlightedCategories property.\nBy default, highlightMatch is 'all' and only items whose categories match all of the values specified in the highlightedCategories array will be highlighted.\nIf highlightMatch is 'any', then items that match at least one of the highlightedCategories values will be highlighted.",
"ojvalues": [
{
"name": "any",
"description": "Any matching categories will be highlighted.",
"displayName": "Dim",
"type": {
"names": [
"string"
]
}
},
{
"name": "all",
"description": "Items only with all matching categories will be highlighted.",
"displayName": "None",
"type": {
"names": [
"string"
]
}
}
],
"ojvalueskeeporder": true,
"defaultvalue": "'any'"
},
{
"id": "oj-c.AreaChart#legend",
"name": "legend",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#legend",
"scope": "instance",
"type": {
"names": [
"object"
]
},
"optional": true,
"ojdisplayname": "Legend",
"description": "An object defining the style, positioning, and behavior of the legend.",
"tstype": [
{
"target": "Type",
"value": "oj-c.AreaChart.ChartLegend",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#contextMenuConfig",
"name": "contextMenuConfig",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#contextMenuConfig",
"scope": "instance",
"type": {
"names": [
"object"
]
},
"optional": true,
"ojdisplayname": "Context Menu Config",
"ojshortdesc": "Specifies a context menu configuration.",
"description": "Specifies a context menu configuration.\nIt takes the keys `accessibleLabel` and `items`,\nwhere `accessibleLabel` is optional and items required . `items` function returns an array\nof menu item object representations that indicates what menu items are going to be part of\nmenu based on some specific context menu context.\n
",
"tstype": [
{
"target": "Type",
"value": "oj-c.AreaChart.AreaChartContextMenuConfig",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#datatipConfig",
"name": "datatipConfig",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#datatipConfig",
"scope": "instance",
"type": {
"names": [
"function"
]
},
"optional": true,
"description": "The DatatipConfig object is used to allow applications to control the appearance and behavior of the datatip.",
"tstype": [
{
"target": "Type",
"value": "(context: oj-c.AreaChart.DatatipTemplateContext) => oj-c.AreaChart.DatatipConfig",
"jsdocOverride": true
}
]
},
{
"id": "oj-c.AreaChart#_getYAxis",
"name": "_getYAxis",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "function",
"longname": "oj-c.AreaChart#_getYAxis",
"scope": "instance",
"returns": [
{
"type": {
"names": [
"object|undefined"
]
}
}
],
"description": "Private method to expose y axis properties.",
"ojhidden": true
},
{
"id": "oj-c.AreaChart#_getXAxis",
"name": "_getXAxis",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "function",
"longname": "oj-c.AreaChart#_getXAxis",
"scope": "instance",
"returns": [
{
"type": {
"names": [
"object|undefined"
]
}
}
],
"description": "Private method to expose x axis properties.",
"ojhidden": true
},
{
"id": "oj-c.AreaChart#_getY2Axis",
"name": "_getY2Axis",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "function",
"longname": "oj-c.AreaChart#_getY2Axis",
"scope": "instance",
"returns": [
{
"type": {
"names": [
"object|undefined"
]
}
}
],
"description": "Private method to expose y2Axis properties.",
"ojhidden": true
},
{
"id": "oj-c.AreaChart#setProperty",
"name": "setProperty",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "function",
"longname": "oj-c.AreaChart#setProperty",
"scope": "instance",
"returns": [
{
"type": {
"names": [
"void"
]
}
}
],
"ojshortdesc": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.",
"description": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.",
"params": [
{
"name": "property",
"description": "The property name to set. Supports dot notation for subproperty access.",
"type": {
"names": [
"string"
]
}
},
{
"name": "value",
"description": "The new value to set the property to.",
"type": {
"names": [
"any"
]
}
}
]
},
{
"id": "oj-c.AreaChart#getProperty",
"name": "getProperty",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "function",
"longname": "oj-c.AreaChart#getProperty",
"scope": "instance",
"returns": [
{
"type": {
"names": [
"any"
]
}
}
],
"ojshortdesc": "Retrieves the value of a property or a subproperty.",
"description": "Retrieves the value of a property or a subproperty.",
"params": [
{
"name": "property",
"description": "The property name to get. Supports dot notation for subproperty access.",
"type": {
"names": [
"string"
]
}
}
]
},
{
"id": "oj-c.AreaChart#setProperties",
"name": "setProperties",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "function",
"longname": "oj-c.AreaChart#setProperties",
"scope": "instance",
"returns": [
{
"type": {
"names": [
"void"
]
}
}
],
"ojshortdesc": "Performs a batch set of properties.",
"description": "Performs a batch set of properties.",
"params": [
{
"name": "properties",
"description": "An object containing the property and value pairs to set.",
"type": {
"names": [
"object"
]
}
}
]
},
{
"id": "oj-c.AreaChart#event:ojViewportChange",
"name": "ojViewportChange",
"kind": "event",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"longname": "oj-c.AreaChart#event:ojViewportChange",
"scope": "instance",
"ojshortdesc": "Triggered after the viewport is changed due to a zoom or scroll operation.",
"ojdisplayname": "Viewport Change",
"description": "
Note: The event detail contains the following properties: [oj-c.AreaChart.ViewPortDetail]{@link oj-c.AreaChart.ViewPortDetail}
Triggered after the viewport is changed due to a zoom or scroll operation."
},
{
"id": "oj-c.AreaChart#event:ojItemDrill",
"name": "ojItemDrill",
"kind": "event",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"longname": "oj-c.AreaChart#event:ojItemDrill",
"scope": "instance",
"ojshortdesc": "Triggered on a chart item (double click if selection is enabled, single click otherwise).",
"ojdisplayname": "Item Drill",
"description": "
Note: The event detail contains the following properties: [oj-c.AreaChart.ItemDrillDetail]{@link oj-c.AreaChart.ItemDrillDetail}<K, D>
Triggered on a chart item (double click if selection is enabled, single click otherwise)."
},
{
"id": "oj-c.AreaChart#event:ojGroupDrill",
"name": "ojGroupDrill",
"kind": "event",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"longname": "oj-c.AreaChart#event:ojGroupDrill",
"scope": "instance",
"ojshortdesc": "Triggered on a chart group drill gesture (double click if selection is enabled, single click otherwise).",
"ojdisplayname": "Group Drill",
"description": "
Note: The event detail contains the following properties: [oj-c.AreaChart.GroupDrillDetail]{@link oj-c.AreaChart.GroupDrillDetail}<K>
Triggered on a chart group drill gesture (double click if selection is enabled, single click otherwise)."
},
{
"id": "oj-c.AreaChart#event:ojSeriesDrill",
"name": "ojSeriesDrill",
"kind": "event",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"longname": "oj-c.AreaChart#event:ojSeriesDrill",
"scope": "instance",
"ojshortdesc": "Triggered on a chart series drill gesture (double click if selection is enabled, single click otherwise).",
"ojdisplayname": "Series Drill",
"description": "
Note: The event detail contains the following properties: [oj-c.AreaChart.SeriesDrillDetail]{@link oj-c.AreaChart.SeriesDrillDetail}<K>
Note: When the template is executed for each item, it will have access to the binding context containing the following properties: [oj-c.AreaChart.ChartItemTemplateContext]{@link oj-c.AreaChart.ChartItemTemplateContext}
The itemTemplate slot is used to specify the template for creating each item of the chart. The slot content must be a <template> element.\nThe content of the template should only be one <oj-c-area-chart-item> element. See the oj-c-area-chart-item doc for more details.\nA series-id and group-id must be specified.
\n
When the template is executed for each item, it will have access to the chart's binding context containing the following properties:
\n
\n
$current - an object that contains information for the current item. (See the table below for a list of properties available on $current)
\n
alias - if data-oj-as attribute was specified, the value will be used to provide an application-named alias for $current.
\n
",
"ojshortdesc": "The itemTemplate slot is used to specify the template for creating each item of the chart. See the Help documentation for more information.",
"ojslot": true,
"ojtemplateslotprops": "oj-c.AreaChart.ChartItemTemplateContext"
},
{
"id": "oj-c.AreaChart#seriesTemplate",
"name": "seriesTemplate",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#seriesTemplate",
"scope": "instance",
"ojdisplayname": "Series Template",
"description": "
Note: When the template is executed for each item, it will have access to the binding context containing the following properties: [oj-c.AreaChart.ChartSeriesTemplateContext]{@link oj-c.AreaChart.ChartSeriesTemplateContext}
The seriesTemplate slot is used to specify the template for generating the series properties of the chart. The slot content must be a single <template> element.\nThe content of the template should only be one <oj-c-area-chart-series> element.See the oj-c-area-chart-series doc for more details.
\n
When the template is executed for each series, it will have access to the chart's binding context containing the following properties:
\n
\n
$current - an object that contains information for the current item. (See the table below for a list of properties available on $current)
\n
alias - if data-oj-as attribute was specified, the value will be used to provide an application-named alias for $current.
\n
",
"ojshortdesc": "The seriesTemplate slot is used to specify the template for generating the series properties of the chart. See the Help documentation for more information.",
"ojslot": true,
"ojtemplateslotprops": "oj-c.AreaChart.ChartSeriesTemplateContext"
},
{
"id": "oj-c.AreaChart#groupTemplate",
"name": "groupTemplate",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#groupTemplate",
"scope": "instance",
"ojdisplayname": "Group Template",
"description": "
Note: When the template is executed for each item, it will have access to the binding context containing the following properties: [oj-c.AreaChart.ChartGroupTemplateContext]{@link oj-c.AreaChart.ChartGroupTemplateContext}
The groupTemplate slot is used to specify the template for generating the group properties of the chart. The slot content must be a single <template> element.\nThe content of the template should only be one <oj-c-area-chart-group> element. See the oj-c-area-chart-group doc for more details.
\n
When the template is executed for each group, it will have access to the chart's binding context containing the following properties:
\n
\n
$current - an object that contains information for the current item. (See the table below for a list of properties available on $current)
\n
alias - if data-oj-as attribute was specified, the value will be used to provide an application-named alias for $current.
\n
",
"ojshortdesc": "The groupTemplate slot is used to specify the template for generating the group properties of the chart. See the Help documentation for more information.",
"ojslot": true,
"ojtemplateslotprops": "oj-c.AreaChart.ChartGroupTemplateContext"
},
{
"id": "oj-c.AreaChart#datatipTemplate",
"name": "datatipTemplate",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"kind": "member",
"longname": "oj-c.AreaChart#datatipTemplate",
"scope": "instance",
"description": "
Note: When the template is executed for each item, it will have access to the binding context containing the following properties: [oj-c.AreaChart.DatatipTemplateContext]{@link oj-c.AreaChart.DatatipTemplateContext}
The datatipTemplate slot is used to specify custom datatip content.",
"ojslot": true,
"ojtemplateslotprops": "oj-c.AreaChart.DatatipTemplateContext"
},
{
"id": "oj-c.AreaChart.touchDoc",
"name": "touchDoc",
"kind": "member",
"longname": "oj-c.AreaChart.touchDoc",
"description": "
\n \n
\n
Target
\n
Gesture
\n
Action
\n
\n \n \n
\n
Data Item
\n
Tap
\n
Select when selectionMode is enabled.
\n
\n
\n
Drill when drilling is enabled and selectionMode is none.
\n
\n
\n
Double Tap
\n
Drill when drilling is enabled and selectionMode is enabled.
\n
\n
\n
Press & Hold
\n
Display datatip.
\n
\n
\n
Display context menu on release.
\n
\n
\n
Categorical Axis Item
\n
Tap
\n
Drill when drilling is enabled.
\n
\n
\n
Press & Hold
\n
Display context menu on release.
\n
\n
\n
Legend Item
\n
Tap
\n
Drill when drilling is enabled.
\n
\n
\n
Filter when hideAndShowBehavior is enabled.
\n
\n
\n
Plot Area
\n
Drag
\n
Pan when panning is enabled and toggled into that mode.
\n
\n
\n
Marquee select when selectionMode is multiple and toggled into that mode.
Move focus to previous data item, without changing the current selection.
\n
\n
\n
Ctrl + DownArrow
\n
Move focus to next data item, without changing the current selection.
\n
\n
\n
Ctrl + LeftArrow
\n
Move focus to previous data item, without changing the current selection.
\n
\n
\n
Ctrl + RightArrow
\n
Move focus to next data item, without changing the current selection.
\n
\n
\n
Ctrl + Spacebar
\n
Multi-select data item with focus.
\n
\n
\n
= or +
\n
Zoom in one level if zooming is enabled.
\n
\n
\n
- or _
\n
Zoom out one level if zooming is enabled.
\n
\n
\n
PageUp or Shift + PageUp
\n
Pan left in left-to-right locales. Pan right in right-to-left locales.
\n
\n
\n
PageDown or Shift + PageDown
\n
Pan right in left-to-right locales. Pan left in right-to-left locales.
\n
\n
\n
Enter
\n
Drill on data item, categorical axis label, or legend item when drilling is enabled.
\n
\n
\n
Shift+F10
\n
Launch the context menu if there is one associated with the current item.
\n
\n \n
",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"ojfragment": true
},
{
"id": "oj-c.AreaChart.AreaItem",
"name": "AreaItem",
"kind": "typedef",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"longname": "oj-c.AreaChart.AreaItem",
"type": {
"names": [
"Object"
]
},
"scope": "static",
"description": "",
"tsgenerictype": {
"target": "Type",
"value": "",
"for": "genericTypeParameters"
},
"properties": [
{
"name": "id",
"description": "The item id should be set by the application if the DataProvider is not being used.\nThe row key will be used as id in the DataProvider case.",
"optional": false,
"type": {
"names": [
"string|number"
]
},
"tstype": [
{
"target": "Type",
"value": "K",
"jsdocOverride": true,
"for": "id"
}
]
},
{
"name": "seriesId",
"description": "The id for the series the item belongs to.",
"optional": false,
"type": {
"names": [
"string"
]
}
},
{
"name": "groupId",
"description": "The array of ids for the groups the item belongs to. For hierarchical groups, it will be an array of outermost to innermost group ids. This is also used to specify the date for non mixed frequency time axes. The specified date for non mixed frequency time axes must be an ISO string.",
"optional": false,
"type": {
"names": [
"Array"
]
},
"ojshortdesc": "The array of ids for the groups the item belongs to."
},
{
"name": "value",
"description": "The value for this data item. Null can be specified to skip a data point.",
"optional": false,
"type": {
"names": [
"number"
]
},
"ojshortdesc": "The value of the data item."
},
{
"name": "x",
"description": "The x value. Mainly used to specify the date for mixed-frequency time axis. The date specified in the x value must be an ISO date string.",
"optional": true,
"type": {
"names": [
"string"
]
},
"ojshortdesc": "The x value of the data item."
},
{
"name": "color",
"description": "The color of the data item. This color value is not inherited by chart legend. See chart series color and display-in-legend for more details.",
"optional": true,
"type": {
"names": [
"string"
]
},
"ojshortdesc": "The color of the data item."
},
{
"name": "markerDisplayed",
"description": "Defines whether the data marker is displayed. If auto, the markers will be displayed whenever the data points are not connected by a line.",
"optional": true,
"type": {
"names": [
"\"auto\"",
"\"off\"",
"\"on\""
]
},
"ojshortdesc": "Defines whether the data marker is displayed."
},
{
"name": "markerShape",
"description": "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.",
"optional": true,
"type": {
"names": [
"\"auto\"",
"\"square\"",
"\"circle\"",
"\"diamond\"",
"\"human\"",
"\"plus\"",
"\"star\"",
"\"triangleDown\"",
"\"triangleUp\""
]
},
"ojshortdesc": "The shape of the data markers."
},
{
"name": "markerColor",
"description": "The color of the data markers, if different from the series color.",
"optional": true,
"type": {
"names": [
"string"
]
}
},
{
"name": "markerSize",
"description": "The size of the data markers.",
"optional": true,
"type": {
"names": [
"number"
]
}
},
{
"name": "categories",
"description": "An optional array of category strings corresponding to this data item. This enables highlighting and filtering of individual data items through interactions with the legend or other visualization elements. If not defined, series categories are used.",
"optional": true,
"type": {
"names": [
"Array"
]
},
"ojshortdesc": "An optional array of category strings corresponding to this data item."
},
{
"name": "drilling",
"description": "Whether drilling is enabled for the data item. Drillable objects will show a pointer cursor on hover and fire an ojDrill event on click (double click if selection is enabled). To enable drilling for all data items at once, use the drilling attribute in the top level.",
"optional": true,
"type": {
"names": [
"\"off\"",
"\"inherit\"",
"\"on\""
]
},
"ojshortdesc": "Whether drilling is enabled for the data item."
},
{
"name": "shortDesc",
"description": "The description of this object. This is used for accessibility and also for customizing the datatip text.",
"optional": true,
"type": {
"names": [
"string"
]
}
},
{
"name": "label",
"description": "The label of the data item.",
"optional": true,
"type": {
"names": [
"string"
]
}
}
]
},
{
"id": "oj-c.AreaChart.ChartItemTemplateContext",
"name": "ChartItemTemplateContext",
"kind": "typedef",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"longname": "oj-c.AreaChart.ChartItemTemplateContext",
"type": {
"names": [
"Object"
]
},
"scope": "static",
"description": "",
"tsgenerictype": {
"target": "Type",
"value": "",
"for": "genericTypeParameters"
},
"properties": [
{
"name": "data",
"description": "The data object of the current item.",
"optional": false,
"type": {
"names": [
"any"
]
},
"tstype": [
{
"target": "Type",
"value": "D",
"jsdocOverride": true,
"for": "data"
}
]
},
{
"name": "key",
"description": "The key of the current item.",
"optional": false,
"type": {
"names": [
"any"
]
},
"tstype": [
{
"target": "Type",
"value": "K",
"jsdocOverride": true,
"for": "key"
}
]
},
{
"name": "index",
"description": "The zero-based index of the current item.",
"optional": false,
"type": {
"names": [
"number"
]
}
}
]
},
{
"id": "oj-c.AreaChart.ChartSeriesTemplateContext",
"name": "ChartSeriesTemplateContext",
"kind": "typedef",
"memberof": "oj-c.AreaChart",
"meta": {
"filename": "area-chart.tsx",
"path": "web/components/oj-c/area-chart"
},
"longname": "oj-c.AreaChart.ChartSeriesTemplateContext",
"type": {
"names": [
"Object"
]
},
"scope": "static",
"description": "",
"tsgenerictype": {
"target": "Type",
"value": "",
"for": "genericTypeParameters"
},
"properties": [
{
"name": "items",
"description": "The array of objects which are chart items that belong to this series. The objects will have the following properties",
"optional": false,
"type": {
"names": [
"Array