[ { "id": "oj-c.LineChartSeries", "name": "LineChartSeries", "memberof": "oj-c", "kind": "class", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "ojcomponent": true, "isvcomponent": true, "since": "16.0.0", "longname": "oj-c.LineChartSeries", "pack": "oj-c", "classdesc": "

\n JET Line Chart Series\n \n

\n\n

The oj-c-line-chart-series element is used to declare series properties. See the Help documentation for more information

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

\n Accessibility\n \n

\n

\n Read the Accessibility Section of the oj-c-line-chart component for details about making this component accessible.\n

", "scope": "static", "tagWithoutBrackets": "oj-c-line-chart-series", "tagWithBrackets": "", "domInterface": "CLineChartSeriesElement", "ojPageTitle": "<oj-c-line-chart-series>", "camelCaseName": "LineChartSeries", "ojPageTitlePrefix": "Element: ", "ojtsvcomponent": true, "tstype": { "target": "Type", "value": "interface CLineChartSeriesElement extends JetElement" }, "ojsignature": [ { "target": "Type", "value": "interface CLineChartSeriesElement extends JetElement" } ], "tsdeprecated": [ { "type": "candidate", "since": "17.0.0" } ], "extension": { "catalog": { "category": "Visualizations" } }, "ojmodule": "line-chart-series", "ojslotcomponent": true }, { "id": "oj-c.LineChartSeries#assignedToY2", "name": "assignedToY2", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#assignedToY2", "scope": "instance", "type": { "names": [ "\"off\"", "\"on\"" ] }, "optional": true, "ojdisplayname": "Assigned To Y2", "ojshortdesc": "Defines whether the series is associated with the y2 axis", "description": "Defines whether the series is associated with the y2 axis." }, { "id": "oj-c.LineChartSeries#categories", "name": "categories", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#categories", "scope": "instance", "type": { "names": [ "Array" ] }, "optional": true, "ojdisplayname": "Categories", "ojshortdesc": "An array of category strings corresponding to the tag cloud items.", "description": "An array of category strings corresponding to the tag cloud items. This allows highlighting and filtering of items." }, { "id": "oj-c.LineChartSeries#color", "name": "color", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#color", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "ojdisplayname": "Color", "description": "The color of the series. The chart legend item will inherit this color value." }, { "id": "oj-c.LineChartSeries#drilling", "name": "drilling", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#drilling", "scope": "instance", "type": { "names": [ "\"off\"", "\"inherit\"", "\"on\"" ] }, "optional": true, "ojdisplayname": "Drilling", "ojshortdesc": "Whether drilling is enabled on the series item.", "description": "Whether drilling is enabled on the series 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 series items at once, use the drilling attribute in the top level.", "defaultvalue": "'inherit'" }, { "id": "oj-c.LineChartSeries#lineStyle", "name": "lineStyle", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#lineStyle", "scope": "instance", "type": { "names": [ "\"dashed\"", "\"solid\"", "\"dotted\"" ] }, "optional": true, "ojdisplayname": "LineStyle", "description": "The line style of the data line." }, { "id": "oj-c.LineChartSeries#lineType", "name": "lineType", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#lineType", "scope": "instance", "type": { "names": [ "\"curved\"", "\"straight\"" ] }, "optional": true, "ojdisplayname": "Line Type", "description": "The line type of the data of line chart." }, { "id": "oj-c.LineChartSeries#lineWidth", "name": "lineWidth", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#lineWidth", "scope": "instance", "type": { "names": [ "number" ] }, "optional": true, "ojdisplayname": "Line Width", "description": "The width of the data line." }, { "id": "oj-c.LineChartSeries#markerShape", "name": "markerShape", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#markerShape", "scope": "instance", "type": { "names": [ "\"auto\"", "\"square\"", "\"circle\"", "\"diamond\"", "\"human\"", "\"plus\"", "\"star\"", "\"triangleDown\"", "\"triangleUp\"" ] }, "optional": true, "ojdisplayname": "Marker Shape", "ojshortdesc": "The shape of the data markers.", "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." }, { "id": "oj-c.LineChartSeries#markerColor", "name": "markerColor", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#markerColor", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "ojdisplayname": "Marker Color", "description": "The color of the data markers, if different from the series color." }, { "id": "oj-c.LineChartSeries#markerDisplayed", "name": "markerDisplayed", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#markerDisplayed", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "ojdisplayname": "Marker Displayed", "ojshortdesc": "Defines whether the data marker is displayed.", "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." }, { "id": "oj-c.LineChartSeries#markerSize", "name": "markerSize", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#markerSize", "scope": "instance", "type": { "names": [ "number" ] }, "optional": true, "ojdisplayname": "Marker Size", "description": "The size of the data markers." }, { "id": "oj-c.LineChartSeries#name", "name": "name", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#name", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "ojdisplayname": "Name", "description": "The name of the series, displayed in the legend and datatips." }, { "id": "oj-c.LineChartSeries#shortDesc", "name": "shortDesc", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "member", "longname": "oj-c.LineChartSeries#shortDesc", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "ojdisplayname": "Short Desc", "description": "The description of this series. This is used for accessibility and for customizing the datatip text on the corresponding legend item for the series." }, { "id": "oj-c.LineChartSeries#setProperty", "name": "setProperty", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "function", "longname": "oj-c.LineChartSeries#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.LineChartSeries#getProperty", "name": "getProperty", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "function", "longname": "oj-c.LineChartSeries#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.LineChartSeries#setProperties", "name": "setProperties", "memberof": "oj-c.LineChartSeries", "meta": { "filename": "line-chart-series.tsx", "path": "web/components/oj-c/line-chart-series" }, "kind": "function", "longname": "oj-c.LineChartSeries#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" ] } } ] } ]