{ "name": "legend", "version": "20.0.2", "jetVersion": "^20.0.2", "pack": "oj-c", "type": "composite", "dependencyScope": "runtime", "license": "https://opensource.org/licenses/UPL", "implements": [ "CLegendElement" ], "description": "A legend displays an interactive description of symbols, colors, etc., used in graphical information representations.", "displayName": "Legend", "main": "oj-c/legend", "help": "oj-c.Legend.html", "status": [ { "type": "candidate", "since": "17.0.0" } ], "extension": { "catalog": { "category": "Visualizations" }, "vbdt": { "module": "oj-c/legend", "defaultColumns": 2, "minColumns": 1 }, "oracle": { "icon": "oj-ux-ico-legend", "uxSpecs": [ "legend" ] }, "webelement": { "package": "@oracle/oraclejet-core-pack", "version": "20.0.2", "docUrl": "https://www.oracle.com/webfolder/technetwork/jet/cpwdtsdoc/classes/LegendWebElement.html", "export": "findLegend", "main": "@oracle/oraclejet-core-pack/webdriver" } }, "propertyLayout": [ { "propertyGroup": "common", "items": [ "orientation", "halign", "valign", "hoverBehavior", "style" ] }, { "propertyGroup": "data", "items": [ "data" ] } ], "since": "15.0.0", "requirements": [ { "type": "anyOf", "label": "accessibility", "properties": [ "aria-label", "aria-labelledby" ] } ], "properties": { "data": { "type": "DataProvider|null", "description": "Specifies the DataProvider for the sections and items of the legend.", "displayName": "Data", "help": "#data", "extension": { "webelement": { "exceptionStatus": [ { "type": "deprecated", "since": "17.1.0", "description": "Data sets from a DataProvider cannot be sent to WebDriverJS; use ViewModels or page variables instead." } ] } }, "value": null }, "drilling": { "type": "string", "description": "Specifies whether drilling is enabled.", "displayName": "Drilling", "help": "#drilling", "propertyEditorValues": { "on": { "description": "Legend items will be drillable", "displayName": "On" }, "off": { "description": "Legend items will not be drillable", "displayName": "Off" } }, "enumValues": [ "off", "on" ], "value": "off" }, "halign": { "type": "string", "description": "Defines the horizontal alignment of the legend contents.", "displayName": "Halign", "help": "#halign", "propertyEditorValues": { "center": { "description": "Legend contents will be center aligned", "displayName": "Center" }, "end": { "description": "Legend contents will be end aligned", "displayName": "End" }, "start": { "description": "Legend contents will be start aligned", "displayName": "Start" } }, "enumValues": [ "center", "end", "start" ], "value": "start" }, "hiddenCategories": { "type": "Array", "description": "An array of categories that will be hidden.", "displayName": "Hidden Categories", "help": "#hiddenCategories", "writeback": true, "value": [] }, "hideAndShowBehavior": { "type": "string", "description": "Defines whether the legend can be used to initiate hide and show behavior on referenced data items.", "displayName": "Hide And Show Behavior", "help": "#hideAndShowBehavior", "propertyEditorValues": { "on": { "description": "Legend can be used to initiate hide and show behavior on referenced data items.", "displayName": "On" }, "off": { "description": "legend cannot be used to initiate hide and show behavior on referenced data items.", "displayName": "Off" } }, "enumValues": [ "off", "on" ], "value": "off" }, "highlightedCategories": { "type": "Array", "description": "An array of categories that will be highlighted.", "displayName": "Highlighted Categories", "help": "#highlightedCategories", "writeback": true, "value": [] }, "hoverBehavior": { "type": "string", "description": "Defines the behavior applied when hovering over a legend item.", "displayName": "Hover Behavior", "help": "#hoverBehavior", "propertyEditorValues": { "dim": { "description": "Dimming hover behavior is applied.", "displayName": "Dim" }, "none": { "description": "No hover behavior will be applied.", "displayName": "None" } }, "enumValues": [ "none", "dim" ], "value": "none" }, "orientation": { "type": "string", "description": "Defines the orientation of the legend, which determines the direction in which the legend items are laid out.", "displayName": "Orientation", "help": "#orientation", "propertyEditorValues": { "horizontal": { "description": "Legend items will be horizontally placed in available space.", "displayName": "Horizontal" }, "vertical": { "description": "Legend items will be vertically stacked.", "displayName": "Vertical" } }, "enumValues": [ "horizontal", "vertical" ], "value": "vertical" }, "symbolHeight": { "type": "number", "description": "The height of the legend symbol in pixels.", "displayName": "Symbol Height", "help": "#symbolHeight", "value": 0 }, "symbolWidth": { "type": "number", "description": "The width of the legend symbol in pixels.", "displayName": "Symbol Width", "help": "#symbolWidth", "value": 0 }, "textStyle": { "type": "object", "description": "The CSS style object defining the style of the legend item text.", "displayName": "Text Style", "help": "#textStyle", "properties": { "color": { "type": "string" }, "fontFamily": { "type": "string" }, "fontSize": { "type": "string" }, "fontStyle": { "type": "string" }, "fontWeight": { "type": "string" }, "textDecoration": { "type": "string" } } }, "valign": { "type": "string", "description": "Defines the vertical alignment of the legend contents.", "displayName": "valign", "help": "#valign", "propertyEditorValues": { "middle": { "description": "The legend items will be middle aligned.", "displayName": "Middle" }, "bottom": { "description": "The legend items will be bottom aligned.", "displayName": "Bottom" }, "top": { "description": "The legend items will be top aligned.", "displayName": "Top" } }, "enumValues": [ "top", "bottom", "middle" ], "value": "top" }, "sectionTitleStyle": { "type": "object", "description": "The CSS style object defining the style of the section titles' text.", "displayName": "Section Title Style", "help": "#sectionTitleStyle", "properties": { "color": { "type": "string" }, "fontFamily": { "type": "string" }, "fontSize": { "type": "string" }, "fontStyle": { "type": "string" }, "fontWeight": { "type": "string" }, "textDecoration": { "type": "string" } } }, "sectionTitleHalign": { "type": "string", "description": "The horizontal alignment of the section titles.", "displayName": "Section Title Halign", "help": "#sectionTitleHalign", "propertyEditorValues": { "center": { "description": "The section title will be center aligned.", "displayName": "Center" }, "end": { "description": "The section title will be end aligned.", "displayName": "End" }, "start": { "description": "The section title will be start aligned.", "displayName": "Start" } }, "enumValues": [ "center", "end", "start" ], "value": "start" }, "contextMenuConfig": { "type": "object", "description": "Specifies a context menu configuration.", "displayName": "Context Menu Config", "help": "#contextMenuConfig", "properties": { "accessibleLabel": { "type": "string" }, "items": { "type": "function" } } }, "datatipConfig": { "type": "function", "description": "The DatatipConfig object is used to allow applications to control the appearance and behavior of the datatip." } }, "slots": { "itemTemplate": { "description": "The itemTemplate slot is used to map each data item in the component. See the Help documentation for more information.", "displayName": "itemTemplate", "help": "#itemTemplate", "maxItems": 1, "preferredContent": [ "CLegendItemElement" ], "data": { "data": { "type": "any" }, "key": { "type": "any" }, "index": { "type": "number" }, "parentData": { "type": "Array" }, "parentKey": { "type": "any" } } }, "sectionTemplate": { "description": "The sectionTemplate slot is used to map each data item in the component. See the Help documentation for more information.", "displayName": "sectionTemplate", "help": "#sectionTemplate", "maxItems": 1, "preferredContent": [ "CLegendSectionElement" ], "data": { "data": { "type": "any" }, "key": { "type": "any" }, "index": { "type": "number" } } }, "datatipTemplate": { "description": "The datatipTemplate slot is used to specify custom datatip content.", "data": { "color": { "type": "string" }, "text": { "type": "string" }, "id": { "type": "any" }, "itemData": { "type": "any" }, "sectionId": { "type": "any" }, "sectionData": { "type": "object", "properties": { "id": { "type": "any" }, "items": { "type": "Array", "extension": { "vbdt": { "itemProperties": { "id": { "type": "any" }, "text": { "type": "string", "description": "The legend item text.", "displayName": "Text", "help": "#text", "required": true, "translatable": true }, "categories": { "type": "Array", "description": "An array of categories for the legend item. Legend items currently only support a single category.", "displayName": "Categories", "help": "#categories" }, "symbolType": { "type": "string", "description": "The type of legend symbol to display.", "displayName": "Symbol Type", "help": "#symbolType", "propertyEditorValues": { "line": { "description": "The legend symbol will be a line.", "displayName": "Line" }, "lineWithMarker": { "description": "The legend symbol will be a line and a marker.", "displayName": "LineWithMarker" }, "image": { "description": "The legend symbol will be an image.", "displayName": "Image" }, "marker": { "description": "The legend symbol will be a marker.", "displayName": "Marker" } }, "enumValues": [ "marker", "image", "line", "lineWithMarker" ] }, "source": { "type": "string", "description": "The URI of the image of the legend symbol.", "displayName": "Source", "help": "#source" }, "color": { "type": "string", "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.", "displayName": "Color", "help": "#color" }, "borderColor": { "type": "string", "description": "The border color of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker.", "displayName": "Border Color", "help": "#borderColor" }, "lineStyle": { "type": "string", "description": "The line style. Only applies when the symbolType is \"line\" or \"lineWithMarker\".", "displayName": "Line Style", "help": "#lineStyle", "propertyEditorValues": { "dotted": { "description": "Line will have dotted strokes.", "displayName": "Dotted" }, "dashed": { "description": "Line will have dashed strokes.", "displayName": "Dashed" }, "solid": { "description": "Line will have a solid stroke.", "displayName": "Solid" } }, "enumValues": [ "dashed", "solid", "dotted" ] }, "lineWidth": { "type": "number", "description": "The line width in pixels. Only applies when the symbolType is \"line\" or \"lineWithMarker.", "displayName": "Line Width", "help": "#lineWidth" }, "markerShape": { "type": "string", "description": "The shape of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker\". Does not apply if a custom image is specified.", "displayName": "Marker Shape", "help": "#markerShape", "propertyEditorValues": { "circle": { "description": "The marker will be of circular shape.", "displayName": "Circle" }, "diamond": { "description": "The marker will be of diamond shape.", "displayName": "Diamond" }, "ellipse": { "description": "The marker will be of ellipse shape.", "displayName": "Ellipse" }, "human": { "description": "The marker will be of human shape.", "displayName": "Human" }, "plus": { "description": "The marker will be of plus shape.", "displayName": "Plus" }, "rectangle": { "description": "The marker will be of rectangular shape.", "displayName": "Rectangle" }, "square": { "description": "The marker will be of square shape.", "displayName": "Square" }, "star": { "description": "The marker will be of star shape.", "displayName": "Star" }, "triangleDown": { "description": "The marker will be of triangular shape facing down.", "displayName": "Triangle Down" }, "triangleUp": { "description": "The marker will be of triangular shape facing up.", "displayName": "Triangle Up" } }, "enumValues": [ "square", "circle", "ellipse", "diamond", "human", "plus", "star", "triangleDown", "triangleUp", "rectangle" ] }, "markerColor": { "type": "string", "description": "The color of the marker, if different than the line color. Only applies if the symbolType is \"lineWithMarker\".", "displayName": "sections", "help": "#sections" }, "shortDesc": { "type": "string", "description": "The description of this legend item. This is used for accessibility and for customizing the datatip text.", "displayName": "Short Desc", "help": "#shortDesc", "translatable": true }, "drilling": { "type": "string", "description": "Whether drilling is enabled on the legend item.", "displayName": "Drilling", "help": "#drilling", "propertyEditorValues": { "inherit": { "description": "The drilling behavior is inherited from legend.", "displayName": "Inherit" }, "off": { "description": "The legend item will not be drillable.", "displayName": "Off" }, "on": { "description": "The legend item will be drillable.", "displayName": "On" } }, "enumValues": [ "off", "inherit", "on" ] } } } } }, "title": { "type": "string" } } } } } }, "events": { "ojDrill": { "description": "Triggered during a drill gesture (single click on the legend item).", "help": "#event:drill", "detail": { "id": { "type": "any", "description": "The id of the drilled item." } } }, "ojContextMenuAction": { "bubbles": true, "description": "Triggered when a menu item is clicked, whether by keyboard, mouse, or touch events.", "eventGroup": "common", "displayName": "onOjContextMenuAction", "help": "#event:ojContextMenuAction", "detail": { "menuItemKey": { "type": "string" }, "contextMenuContext": { "type": "object" } } }, "ojContextMenuSelection": { "bubbles": true, "description": "Triggered when a select menu item is clicked, whether by keyboard, mouse, or touch events.", "eventGroup": "common", "displayName": "onOjContextMenuSelection", "help": "#event:ojContextMenuSelection", "detail": { "value": { "type": "string|Array" }, "contextMenuContext": { "type": "object" }, "menuSelectionGroupKey": { "type": "string" } } } }, "methods": { "_getPreferredSize": { "params": [ { "name": "_width", "type": "number" }, { "name": "_height", "type": "number" } ], "return": "object" }, "setProperty": { "description": "Sets a property or a single subproperty for complex properties and notifies the component of the change, triggering a corresponding event.", "help": "#setProperty", "params": [ { "name": "property", "description": "The property name to set. Supports dot notation for subproperty access.", "type": "string" }, { "name": "value", "description": "The new value to set the property to.", "type": "any" } ], "return": "void" }, "getProperty": { "description": "Retrieves the value of a property or a subproperty.", "help": "#getProperty", "params": [ { "name": "property", "description": "The property name to get. Supports dot notation for subproperty access.", "type": "string" } ], "return": "any" }, "setProperties": { "description": "Performs a batch set of properties.", "help": "#setProperties", "params": [ { "name": "properties", "description": "An object containing the property and value pairs to set.", "type": "object" } ], "return": "void" } } }