[ { "id": "oj-c.LegendItem", "name": "LegendItem", "memberof": "oj-c", "kind": "class", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "ojcomponent": true, "isvcomponent": true, "since": "15.0.0", "longname": "oj-c.LegendItem", "pack": "oj-c", "classdesc": "

\n JET Legend Item\n \n

\n\n

\n The oj-c-legend-item element is used to declare properties for legend items and is only valid as the\n child of a template element for the itemTemplate\n slot of oj-c-legend.\n

\n\n 
\n \n <oj-c-legend data='[[dataProvider]]'>\n  <template slot='itemTemplate'>\n    <oj-c-legend-item  text='[[$current.data.text]]' color='[[$current.data.color]]'>\n    </oj-c-legend-item>\n  </template>\n </oj-c-legend>\n \n
\n\n

\n Accessibility\n \n

\n

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

", "scope": "static", "tagWithoutBrackets": "oj-c-legend-item", "tagWithBrackets": "", "domInterface": "CLegendItemElement", "ojPageTitle": "<oj-c-legend-item>", "camelCaseName": "LegendItem", "ojPageTitlePrefix": "Element: ", "ojtsvcomponent": true, "tstype": { "target": "Type", "value": "interface CLegendItemElement extends JetElement" }, "ojsignature": [ { "target": "Type", "value": "interface CLegendItemElement extends JetElement" } ], "tsdeprecated": [ { "type": "candidate", "since": "17.0.0" } ], "extension": { "catalog": { "category": "Visualizations" } }, "ojmodule": "legend-item", "ojslotcomponent": true }, { "id": "oj-c.LegendItem#text", "name": "text", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#text", "scope": "instance", "type": { "names": [ "string" ] }, "optional": false, "ojdisplayname": "Text", "ojshortdesc": "The legend item text.", "description": "The legend item text. Also used as item aria label if short-desc is not provided." }, { "id": "oj-c.LegendItem#categories", "name": "categories", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#categories", "scope": "instance", "type": { "names": [ "Array" ] }, "optional": true, "ojdisplayname": "Categories", "description": "An array of categories for the legend item. Legend items currently only support a single category.", "defaultvalue": "'[]'" }, { "id": "oj-c.LegendItem#symbolType", "name": "symbolType", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#symbolType", "scope": "instance", "type": { "names": [ "\"marker\"", "\"image\"", "\"line\"", "\"lineWithMarker\"" ] }, "optional": true, "ojdisplayname": "Symbol Type", "description": "The type of legend symbol to display.", "ojvalues": [ { "name": "line", "description": "The legend symbol will be a line.", "displayName": "Line", "type": { "names": [ "string" ] } }, { "name": "lineWithMarker", "description": "The legend symbol will be a line and a marker.", "displayName": "LineWithMarker", "type": { "names": [ "string" ] } }, { "name": "image", "description": "The legend symbol will be an image.", "displayName": "Image", "type": { "names": [ "string" ] } }, { "name": "marker", "description": "The legend symbol will be a marker.", "displayName": "Marker", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'marker'" }, { "id": "oj-c.LegendItem#source", "name": "source", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#source", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "ojdisplayname": "Source", "description": "The URI of the image of the legend symbol." }, { "id": "oj-c.LegendItem#color", "name": "color", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#color", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "ojdisplayname": "Color", "description": "The color of the legend symbol (line or marker). When symbolType is \"lineWithMarker\", this attribute defines the line color and the markerColor attribute defines the marker color." }, { "id": "oj-c.LegendItem#borderColor", "name": "borderColor", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#borderColor", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "ojdisplayname": "Border Color", "ojshortdesc": "The border color of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker.", "description": "The border color of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker", "defaultvalue": "''" }, { "id": "oj-c.LegendItem#lineStyle", "name": "lineStyle", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#lineStyle", "scope": "instance", "type": { "names": [ "\"dashed\"", "\"solid\"", "\"dotted\"" ] }, "optional": true, "ojdisplayname": "Line Style", "description": "The line style. Only applies when the symbolType is \"line\" or \"lineWithMarker\".", "ojvalues": [ { "name": "dotted", "description": "Line will have dotted strokes.", "displayName": "Dotted", "type": { "names": [ "string" ] } }, { "name": "dashed", "description": "Line will have dashed strokes.", "displayName": "Dashed", "type": { "names": [ "string" ] } }, { "name": "solid", "description": "Line will have a solid stroke.", "displayName": "Solid", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'solid'" }, { "id": "oj-c.LegendItem#lineWidth", "name": "lineWidth", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#lineWidth", "scope": "instance", "type": { "names": [ "number" ] }, "optional": true, "ojdisplayname": "Line Width", "description": "The line width in pixels. Only applies when the symbolType is \"line\" or \"lineWithMarker." }, { "id": "oj-c.LegendItem#markerShape", "name": "markerShape", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#markerShape", "scope": "instance", "type": { "names": [ "\"square\"", "\"circle\"", "\"ellipse\"", "\"diamond\"", "\"human\"", "\"plus\"", "\"star\"", "\"triangleDown\"", "\"triangleUp\"", "\"rectangle\"" ] }, "optional": true, "ojdisplayname": "Marker Shape", "description": "The shape of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker\". Does not apply if a custom image is specified.", "ojvalues": [ { "name": "circle", "description": "The marker will be of circular shape.", "displayName": "Circle", "type": { "names": [ "string" ] } }, { "name": "diamond", "description": "The marker will be of diamond shape.", "displayName": "Diamond", "type": { "names": [ "string" ] } }, { "name": "ellipse", "description": "The marker will be of ellipse shape.", "displayName": "Ellipse", "type": { "names": [ "string" ] } }, { "name": "human", "description": "The marker will be of human shape.", "displayName": "Human", "type": { "names": [ "string" ] } }, { "name": "plus", "description": "The marker will be of plus shape.", "displayName": "Plus", "type": { "names": [ "string" ] } }, { "name": "rectangle", "description": "The marker will be of rectangular shape.", "displayName": "Rectangle", "type": { "names": [ "string" ] } }, { "name": "square", "description": "The marker will be of square shape.", "displayName": "Square", "type": { "names": [ "string" ] } }, { "name": "star", "description": "The marker will be of star shape.", "displayName": "Star", "type": { "names": [ "string" ] } }, { "name": "triangleDown", "description": "The marker will be of triangular shape facing down.", "displayName": "Triangle Down", "type": { "names": [ "string" ] } }, { "name": "triangleUp", "description": "The marker will be of triangular shape facing up.", "displayName": "Triangle Up", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'square'" }, { "id": "oj-c.LegendItem#markerColor", "name": "markerColor", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#markerColor", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "ojdisplayname": "sections", "description": "The color of the marker, if different than the line color. Only applies if the symbolType is \"lineWithMarker\"." }, { "id": "oj-c.LegendItem#shortDesc", "name": "shortDesc", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#shortDesc", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "ojdisplayname": "Short Desc", "description": "The description of this legend item. This is used for accessibility and for customizing the datatip text." }, { "id": "oj-c.LegendItem#drilling", "name": "drilling", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "member", "longname": "oj-c.LegendItem#drilling", "scope": "instance", "type": { "names": [ "\"off\"", "\"inherit\"", "\"on\"" ] }, "optional": true, "ojdisplayname": "Drilling", "ojshortdesc": "Whether drilling is enabled on the legend item.", "description": "Whether drilling is enabled on the legend item. Drillable objects will show a pointer cursor on hover and fire ojDrill event on click. To enable drilling for all legend items at once, use the drilling attribute in the top level.", "ojvalues": [ { "name": "inherit", "description": "The drilling behavior is inherited from legend.", "displayName": "Inherit", "type": { "names": [ "string" ] } }, { "name": "off", "description": "The legend item will not be drillable.", "displayName": "Off", "type": { "names": [ "string" ] } }, { "name": "on", "description": "The legend item will be drillable.", "displayName": "On", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'inherit'" }, { "id": "oj-c.LegendItem#setProperty", "name": "setProperty", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "function", "longname": "oj-c.LegendItem#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.LegendItem#getProperty", "name": "getProperty", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "function", "longname": "oj-c.LegendItem#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.LegendItem#setProperties", "name": "setProperties", "memberof": "oj-c.LegendItem", "meta": { "filename": "legend-item.tsx", "path": "/home/jenkins/uitech/workspace/OJET_Code_20.0.2/packages/oraclejet-core-pack/web/components/oj-c/legend-item" }, "kind": "function", "longname": "oj-c.LegendItem#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" ] } } ] } ]