[ { "id": "oj-c.Legend", "name": "Legend", "memberof": "oj-c", "kind": "class", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "ojcomponent": true, "isvcomponent": true, "since": "15.0.0", "longname": "oj-c.Legend", "pack": "oj-c", "classdesc": "

\n JET Legend\n \n

\nA legend displays an interactive description of symbols, colors, etc used in graphical information representations.\n
<oj-c-legend orientation='vertical' data='[[dataProvider]]'></oj-c-legend>
\n\n

\n Accessibility\n \n

\nTo make your component accessible, the application is required to include contextual information for screen readers using either:\n \nIt is also recommended to include appropriate short-desc property values for your items to enhance accessibility.\n\n

\n When setting color, applications are responsible for making sure that the color meets the\nminimum contrast ratio\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. It is the application's responsibility to disclose these custom shortcuts, possibly via a datatip or help popup.\n

\n

\n In the case of the text truncating, applications should provide the untruncated string or contextual text to the datatip to make the component accessible.\n

\n\n

\n Performance\n \n

\n\n

Shaped Data

\n

As a rule of thumb, it's recommended that applications use shaped data if possible for performance gains.

\n\n

\n Keyboard\n \n

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
KeyAction
TabMove focus to next element.
Shift + TabMove focus to previous element.
UpArrowMove focus to previous item.
DownArrowMove focus to next item.
LeftArrowMove focus to previous item (on left).
RightArrowMove focus to next item (on right).
Enter or SpaceHides or unhides the data associated with the current item.
Shift+F10Launch the context menu if there is one associated with the current item.
\n

\nTouch End User Information\n \n

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TargetGestureAction
Legend ItemTapFilter when hideAndShowBehavior is enabled.
Press & HoldDisplay context menu on release.
BackgroundPress & HoldDisplay context menu on release.
", "scope": "static", "tagWithoutBrackets": "oj-c-legend", "tagWithBrackets": "", "domInterface": "CLegendElement", "ojPageTitle": "<oj-c-legend>", "camelCaseName": "Legend", "ojPageTitlePrefix": "Element: ", "ojtsvcomponent": true, "tstype": { "target": "Type", "value": "interface CLegendElement | oj-c.Legend.Section | any> extends JetElement>" }, "ojsignature": [ { "target": "Type", "value": "interface CLegendElement | oj-c.Legend.Section | any> extends JetElement>" } ], "tsdeprecated": [ { "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" ] } }, "ojmodule": "legend" }, { "id": "oj-c.Legend#data", "name": "data", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#data", "scope": "instance", "type": { "names": [ "DataProvider|null" ] }, "optional": true, "ojdisplayname": "Data", "ojshortdesc": "Specifies the DataProvider for the sections and items of the legend.", "description": "The DataProvider for the sections and items of the legend. It should provide a data tree where each node in the data tree corresponds to a section or item in the legend.\nNodes that are leaves will be treated as items. The row key will be used as the id for legend sections and items.\nThe DataProvider can either have data shape specified by oj-c-legend-item (or oj-c-legend-section) as its data shape,\nin which case no template is required or it can have an arbitrary data shape, in which case an oj-c-legend-item element\n(and oj-c-legend-section element for hierarchical data) must be specified in the itemTemplate (and sectionTemplate) slot", "defaultvalue": null, "tstype": [ { "target": "Type", "value": "DataProvider|null", "jsdocOverride": true, "module": { "DataProvider": "ojdataprovider" } } ] }, { "id": "oj-c.Legend#drilling", "name": "drilling", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#drilling", "scope": "instance", "type": { "names": [ "\"off\"", "\"on\"" ] }, "optional": true, "ojdisplayname": "Drilling", "ojshortdesc": "Specifies whether drilling is enabled.", "description": "Whether drilling is enabled on all legend items.\nDrillable objects will show a background opacity, a pointer cursor on hover, and fire ojDrill event on click.", "ojvalues": [ { "name": "on", "description": "Legend items will be drillable", "displayName": "On", "type": { "names": [ "string" ] } }, { "name": "off", "description": "Legend items will not be drillable", "displayName": "Off", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'off'" }, { "id": "oj-c.Legend#halign", "name": "halign", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#halign", "scope": "instance", "type": { "names": [ "\"center\"", "\"end\"", "\"start\"" ] }, "optional": true, "ojdisplayname": "Halign", "description": "Defines the horizontal alignment of the legend contents.", "ojvalues": [ { "name": "center", "description": "Legend contents will be center aligned", "displayName": "Center", "type": { "names": [ "string" ] } }, { "name": "end", "description": "Legend contents will be end aligned", "displayName": "End", "type": { "names": [ "string" ] } }, { "name": "start", "description": "Legend contents will be start aligned", "displayName": "Start", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'start'" }, { "id": "oj-c.Legend#hiddenCategories", "name": "hiddenCategories", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#hiddenCategories", "scope": "instance", "type": { "names": [ "Array" ] }, "optional": true, "ojdisplayname": "Hidden Categories", "ojwriteback": true, "description": "An array of categories that will be hidden.", "defaultvalue": "'[]'" }, { "id": "oj-c.Legend#hideAndShowBehavior", "name": "hideAndShowBehavior", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#hideAndShowBehavior", "scope": "instance", "type": { "names": [ "\"off\"", "\"on\"" ] }, "optional": true, "ojdisplayname": "Hide And Show Behavior", "description": "Defines whether the legend can be used to initiate hide and show behavior on referenced data items.", "ojvalues": [ { "name": "on", "description": "Legend can be used to initiate hide and show behavior on referenced data items.", "displayName": "On", "type": { "names": [ "string" ] } }, { "name": "off", "description": "legend cannot be used to initiate hide and show behavior on referenced data items.", "displayName": "Off", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'off'" }, { "id": "oj-c.Legend#highlightedCategories", "name": "highlightedCategories", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#highlightedCategories", "scope": "instance", "type": { "names": [ "Array" ] }, "optional": true, "ojdisplayname": "Highlighted Categories", "ojwriteback": true, "description": "An array of categories that will be highlighted.", "defaultvalue": "'[]'" }, { "id": "oj-c.Legend#hoverBehavior", "name": "hoverBehavior", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#hoverBehavior", "scope": "instance", "type": { "names": [ "\"none\"", "\"dim\"" ] }, "optional": true, "ojdisplayname": "Hover Behavior", "description": "Defines the behavior applied when hovering over a legend item.", "ojvalues": [ { "name": "dim", "description": "Dimming hover behavior is applied.", "displayName": "Dim", "type": { "names": [ "string" ] } }, { "name": "none", "description": "No hover behavior will be applied.", "displayName": "None", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'none'" }, { "id": "oj-c.Legend#orientation", "name": "orientation", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#orientation", "scope": "instance", "type": { "names": [ "\"horizontal\"", "\"vertical\"" ] }, "optional": true, "ojdisplayname": "Orientation", "description": "Defines the orientation of the legend, which determines the direction in which the legend items are laid out.", "ojvalues": [ { "name": "horizontal", "description": "Legend items will be horizontally placed in available space.", "displayName": "Horizontal", "type": { "names": [ "string" ] } }, { "name": "vertical", "description": "Legend items will be vertically stacked.", "displayName": "Vertical", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'vertical'" }, { "id": "oj-c.Legend#symbolHeight", "name": "symbolHeight", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#symbolHeight", "scope": "instance", "type": { "names": [ "number" ] }, "optional": true, "ojdisplayname": "Symbol Height", "ojshortdesc": "The height of the legend symbol in pixels.", "description": "The height of the legend symbol in pixels. If the value is 0, it will take the same value as symbolWidth. If both symbolWidth and symbolHeight are 0, then it will use a default value that may vary based on theme.", "defaultvalue": 0 }, { "id": "oj-c.Legend#symbolWidth", "name": "symbolWidth", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#symbolWidth", "scope": "instance", "type": { "names": [ "number" ] }, "optional": true, "ojdisplayname": "Symbol Width", "ojshortdesc": "The width of the legend symbol in pixels.", "description": "The width of the legend symbol in pixels. If the value is 0, it will take the same value as symbolHeight. If both symbolWidth and symbolHeight are 0, then it will use a default value that may vary based on theme", "defaultvalue": 0 }, { "id": "oj-c.Legend#textStyle", "name": "textStyle", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#textStyle", "scope": "instance", "type": { "names": [ "object" ] }, "optional": true, "ojdisplayname": "Text Style", "description": "The CSS style object defining the style of the legend item text.", "tstype": [ { "target": "Type", "value": "Partial>", "jsdocOverride": true } ] }, { "id": "oj-c.Legend#textStyle.color", "name": "textStyle.color", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#textStyle.color", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/color)" }, { "id": "oj-c.Legend#textStyle.fontFamily", "name": "textStyle.fontFamily", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#textStyle.fontFamily", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/font-family)" }, { "id": "oj-c.Legend#textStyle.fontSize", "name": "textStyle.fontSize", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#textStyle.fontSize", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/font-size)" }, { "id": "oj-c.Legend#textStyle.fontStyle", "name": "textStyle.fontStyle", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#textStyle.fontStyle", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/font-style)" }, { "id": "oj-c.Legend#textStyle.fontWeight", "name": "textStyle.fontWeight", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#textStyle.fontWeight", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/font-weight)" }, { "id": "oj-c.Legend#textStyle.textDecoration", "name": "textStyle.textDecoration", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#textStyle.textDecoration", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/text-decoration)" }, { "id": "oj-c.Legend#valign", "name": "valign", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#valign", "scope": "instance", "type": { "names": [ "\"top\"", "\"bottom\"", "\"middle\"" ] }, "optional": true, "ojdisplayname": "valign", "description": "Defines the vertical alignment of the legend contents.", "ojvalues": [ { "name": "middle", "description": "The legend items will be middle aligned.", "displayName": "Middle", "type": { "names": [ "string" ] } }, { "name": "bottom", "description": "The legend items will be bottom aligned.", "displayName": "Bottom", "type": { "names": [ "string" ] } }, { "name": "top", "description": "The legend items will be top aligned.", "displayName": "Top", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'top'" }, { "id": "oj-c.Legend#sectionTitleStyle", "name": "sectionTitleStyle", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#sectionTitleStyle", "scope": "instance", "type": { "names": [ "object" ] }, "optional": true, "ojdisplayname": "Section Title Style", "ojshortdesc": "The CSS style object defining the style of the section titles' text.", "description": "The CSS style object defining the style of the section titles' text.\nThe following style properties are supported: color, fontFamily, fontSize, fontStyle, fontWeight, textDecoration", "tstype": [ { "target": "Type", "value": "Partial>", "jsdocOverride": true } ] }, { "id": "oj-c.Legend#sectionTitleStyle.color", "name": "sectionTitleStyle.color", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#sectionTitleStyle.color", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/color)" }, { "id": "oj-c.Legend#sectionTitleStyle.fontFamily", "name": "sectionTitleStyle.fontFamily", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#sectionTitleStyle.fontFamily", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/font-family)" }, { "id": "oj-c.Legend#sectionTitleStyle.fontSize", "name": "sectionTitleStyle.fontSize", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#sectionTitleStyle.fontSize", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/font-size)" }, { "id": "oj-c.Legend#sectionTitleStyle.fontStyle", "name": "sectionTitleStyle.fontStyle", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#sectionTitleStyle.fontStyle", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/font-style)" }, { "id": "oj-c.Legend#sectionTitleStyle.fontWeight", "name": "sectionTitleStyle.fontWeight", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#sectionTitleStyle.fontWeight", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/font-weight)" }, { "id": "oj-c.Legend#sectionTitleStyle.textDecoration", "name": "sectionTitleStyle.textDecoration", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#sectionTitleStyle.textDecoration", "scope": "instance", "type": { "names": [ "string" ] }, "optional": true, "description": "[MDN Reference](https://developer.mozilla.org/docs/Web/CSS/text-decoration)" }, { "id": "oj-c.Legend#sectionTitleHalign", "name": "sectionTitleHalign", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#sectionTitleHalign", "scope": "instance", "type": { "names": [ "\"center\"", "\"end\"", "\"start\"" ] }, "optional": true, "ojdisplayname": "Section Title Halign", "description": "The horizontal alignment of the section titles.", "ojvalues": [ { "name": "center", "description": "The section title will be center aligned.", "displayName": "Center", "type": { "names": [ "string" ] } }, { "name": "end", "description": "The section title will be end aligned.", "displayName": "End", "type": { "names": [ "string" ] } }, { "name": "start", "description": "The section title will be start aligned.", "displayName": "Start", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'start'" }, { "id": "oj-c.Legend#contextMenuConfig", "name": "contextMenuConfig", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#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\n\n\n\n\n\n\n\n\n
Context Menu Item TypeDef
ContextMenuSeparator{ type: 'separator'}
MenuItem{\ntype?: 'item';\nlabel: string;\nkey: string;\ndisabled?: boolean;\nonAction?: () => void;\nstartIcon?: MenuIcon;\nendIcon?: MenuIcon;\nvariant?: 'standard' | 'destructive';\n};
ContextMenuSubMenu{\ntype: 'submenu';\nlabel?: string;\ndisabled?: boolean;\nstartIcon?: string;\nitems?: Array<ContextMenuItems>;\n};
ContextMenuSelectSingle{\ntype: 'selectsingle';\nkey?: string;\nitems?: Array<MenuSelectItem>;\nselection?: string;\nonSelection?: (detail: { value: string }) => void;\n};
ContextMenuSelectMultiple{\ntype: 'selectmultiple';\nkey?: string;\nitems?: Array<MenuSelectItem>;\nselection?: Array<string>;\nonSelection?: (detail: { value: Array<string> }) => void;\n};
MenuIcon{\ntype?: 'class';\n class: string;\n }\n| {\n type: 'img';\n src: string;\n };
MenuSelectItem{\nlabel: string;\ndisabled?: boolean;\nendIcon?: MenuIcon;\nvalue: string;\n}
", "tstype": [ { "target": "Type", "value": "oj-c.Legend.LegendContextMenuConfig", "jsdocOverride": true } ] }, { "id": "oj-c.Legend#datatipConfig", "name": "datatipConfig", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#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.Legend.DatatipTemplateContext) => oj-c.Legend.DatatipConfig", "jsdocOverride": true } ] }, { "id": "oj-c.Legend#_getPreferredSize", "name": "_getPreferredSize", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "function", "longname": "oj-c.Legend#_getPreferredSize", "scope": "instance", "returns": [ { "type": { "names": [ "object" ] } } ], "description": "", "params": [ { "name": "_width", "type": { "names": [ "number" ] } }, { "name": "_height", "type": { "names": [ "number" ] } } ], "ojhidden": true }, { "id": "oj-c.Legend#setProperty", "name": "setProperty", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "function", "longname": "oj-c.Legend#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.Legend#getProperty", "name": "getProperty", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "function", "longname": "oj-c.Legend#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.Legend#setProperties", "name": "setProperties", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "function", "longname": "oj-c.Legend#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.Legend#event:ojDrill", "name": "ojDrill", "kind": "event", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend#event:ojDrill", "scope": "instance", "ojshortdesc": "Triggered during a drill gesture (single click on the legend item).", "description": "

Note: The event detail contains the following properties: [oj-c.Legend.DrillDetail]{@link oj-c.Legend.DrillDetail}<K>

Triggered during a drill gesture (single click on the legend item)." }, { "id": "oj-c.Legend#event:ojContextMenuAction", "name": "ojContextMenuAction", "kind": "event", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend#event:ojContextMenuAction", "scope": "instance", "bubbles": true, "ojshortdesc": "Triggered when a menu item is clicked, whether by keyboard, mouse, or touch events.", "ojdisplayname": "onOjContextMenuAction", "description": "Triggered when a menu item is clicked, whether by keyboard, mouse, or touch events.", "properties": [ { "name": "menuItemKey", "optional": false, "type": { "names": [ "string" ] } }, { "name": "contextMenuContext", "optional": false, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type: 'background'; }|{ data?: oj-c.Legend.Item; itemData?: D; itemIndexPath: Array; type: 'item'; }", "jsdocOverride": true, "for": "contextMenuContext" } ] } ] }, { "id": "oj-c.Legend#event:ojContextMenuSelection", "name": "ojContextMenuSelection", "kind": "event", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend#event:ojContextMenuSelection", "scope": "instance", "bubbles": true, "ojshortdesc": "Triggered when a select menu item is clicked, whether by keyboard, mouse, or touch events.", "ojdisplayname": "onOjContextMenuSelection", "description": "Triggered when a select menu item is clicked, whether by keyboard, mouse, or touch events.", "properties": [ { "name": "value", "optional": false, "type": { "names": [ "string|Array" ] } }, { "name": "contextMenuContext", "optional": false, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type: 'background'; }|{ data?: oj-c.Legend.Item; itemData?: D; itemIndexPath: Array; type: 'item'; }", "jsdocOverride": true, "for": "contextMenuContext" } ] }, { "name": "menuSelectionGroupKey", "optional": false, "type": { "names": [ "string" ] } } ] }, { "id": "oj-c.Legend#itemTemplate", "name": "itemTemplate", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#itemTemplate", "scope": "instance", "ojdisplayname": "itemTemplate", "description": "

Note: When the template is executed for each item, it will have access to the binding context containing the following properties: [oj-c.Legend.LegendItemTemplateContext]{@link oj-c.Legend.LegendItemTemplateContext}

\n The itemTemplate slot is used to specify the template for\n creating items of the legend. The slot content must be wrapped in a <template>\n element. The content of the template should be a single <oj-c-legend-item> element.\n See the oj-c-legend-item doc for more details.\n

\n

\n When the template is executed for each area, it will have access to the components's\n binding context containing the following properties:\n

\n
    \n
  • \n $current - an object that contains information for the current node.\n (See the table below for a list of properties available on $current)\n
    • \n
  • \n alias - if data-oj-as attribute was specified, the value will be used to provide an\n application-named alias for $current.\n
    • \n
", "ojshortdesc": "The itemTemplate slot is used to map each data item in the component. See the Help documentation for more information.", "ojslot": true, "ojtemplateslotprops": "oj-c.Legend.LegendItemTemplateContext" }, { "id": "oj-c.Legend#sectionTemplate", "name": "sectionTemplate", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#sectionTemplate", "scope": "instance", "ojdisplayname": "sectionTemplate", "description": "

Note: When the template is executed for each item, it will have access to the binding context containing the following properties: [oj-c.Legend.LegendSectionTemplateContext]{@link oj-c.Legend.LegendSectionTemplateContext}

\n The sectionTemplate slot is used to specify the template for\n creating sections of the legend. The slot content must be wrapped in a <template>\n element. The content of the template should be a single <oj-c-legend-section> element.\n See the oj-c-legend-section doc for more details.\n

\n

\n When the template is executed for each area, it will have access to the components's\n binding context containing the following properties:\n

\n
    \n
  • \n $current - an object that contains information for the current node.\n (See the table below for a list of properties available on $current)\n
    • \n
  • \n alias - if data-oj-as attribute was specified, the value will be used to provide an\n application-named alias for $current.\n
    • \n
", "ojshortdesc": "The sectionTemplate slot is used to map each data item in the component. See the Help documentation for more information.", "ojslot": true, "ojtemplateslotprops": "oj-c.Legend.LegendSectionTemplateContext" }, { "id": "oj-c.Legend#datatipTemplate", "name": "datatipTemplate", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "kind": "member", "longname": "oj-c.Legend#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.Legend.DatatipTemplateContext]{@link oj-c.Legend.DatatipTemplateContext}

The datatipTemplate slot is used to specify custom datatip content.", "ojslot": true, "ojtemplateslotprops": "oj-c.Legend.DatatipTemplateContext" }, { "id": "oj-c.Legend.touchDoc", "name": "touchDoc", "kind": "member", "longname": "oj-c.Legend.touchDoc", "description": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TargetGestureAction
Legend ItemTapFilter when hideAndShowBehavior is enabled.
Press & HoldDisplay context menu on release.
BackgroundPress & HoldDisplay context menu on release.
", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "ojfragment": true }, { "id": "oj-c.Legend.Item", "name": "Item", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.Item", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Object type that defines a legend data item.", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "id", "description": "The id of the legend item.", "optional": false, "type": { "names": [ "string|number" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "id" } ] }, { "name": "text", "description": "The legend item text. Also used as item aria label if short-desc is not provided.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "The legend item text." }, { "name": "categories", "description": "An array of categories for the legend item. Legend items currently only support a single category.", "optional": true, "type": { "names": [ "Array" ] } }, { "name": "symbolType", "description": "The type of legend symbol to display.", "optional": true, "type": { "names": [ "\"marker\"", "\"image\"", "\"line\"", "\"lineWithMarker\"" ] }, "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 }, { "name": "source", "description": "The URI of the image of the legend symbol.", "optional": true, "type": { "names": [ "string" ] } }, { "name": "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.", "optional": true, "type": { "names": [ "string" ] } }, { "name": "borderColor", "description": "The border color of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker", "optional": true, "type": { "names": [ "string" ] }, "ojshortdesc": "The border color of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker." }, { "name": "lineStyle", "description": "The line style. Only applies when the symbolType is \"line\" or \"lineWithMarker\".", "optional": true, "type": { "names": [ "\"dashed\"", "\"solid\"", "\"dotted\"" ] }, "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 }, { "name": "lineWidth", "description": "The line width in pixels. Only applies when the symbolType is \"line\" or \"lineWithMarker.", "optional": true, "type": { "names": [ "number" ] } }, { "name": "markerShape", "description": "The shape of the marker. Only applies if symbolType is \"marker\" or \"lineWithMarker\". Does not apply if a custom image is specified.", "optional": true, "type": { "names": [ "\"square\"", "\"circle\"", "\"ellipse\"", "\"diamond\"", "\"human\"", "\"plus\"", "\"star\"", "\"triangleDown\"", "\"triangleUp\"", "\"rectangle\"" ] }, "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 }, { "name": "markerColor", "description": "The color of the marker, if different than the line color. Only applies if the symbolType is \"lineWithMarker\".", "optional": true, "type": { "names": [ "string" ] } }, { "name": "shortDesc", "description": "The description of this legend item. This is used for accessibility and for customizing the datatip text.", "optional": true, "type": { "names": [ "string" ] } }, { "name": "drilling", "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.", "optional": true, "type": { "names": [ "\"off\"", "\"inherit\"", "\"on\"" ] }, "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, "ojshortdesc": "Whether drilling is enabled on the legend item." } ] }, { "id": "oj-c.Legend.Section", "name": "Section", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.Section", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Object type that defines a section data item.", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "id", "description": "The id of the legend section. For the DataProvider case, the key for the node will be used as the id.", "optional": false, "type": { "names": [ "string|number" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "id" } ] }, { "name": "items", "description": "The items of the legend section.", "optional": false, "type": { "names": [ "Array" ] }, "tstype": [ { "target": "Type", "value": "Array>", "jsdocOverride": true, "for": "items" } ] }, { "name": "title", "description": "The title of the legend section.", "optional": false, "type": { "names": [ "string" ] } } ] }, { "id": "oj-c.Legend.LegendItemTemplateContext", "name": "LegendItemTemplateContext", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.LegendItemTemplateContext", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Context for legend item template.", "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 relative to the parent.", "optional": false, "type": { "names": [ "number" ] } }, { "name": "parentData", "description": "An array of data objects of the outermost to innermost parents of the node", "optional": true, "type": { "names": [ "Array" ] }, "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true, "for": "parentData" } ] }, { "name": "parentKey", "description": "The key of the parent node", "optional": true, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "parentKey" } ] } ] }, { "id": "oj-c.Legend.LegendSectionTemplateContext", "name": "LegendSectionTemplateContext", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.LegendSectionTemplateContext", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Context for legend section template.", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "data", "description": "The data object of the current section.", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "D", "jsdocOverride": true, "for": "data" } ] }, { "name": "key", "description": "The key of the current section.", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "key" } ] }, { "name": "index", "description": "The zero-based index of the current section.", "optional": false, "type": { "names": [ "number" ] } } ] }, { "id": "oj-c.Legend.DrillDetail", "name": "DrillDetail", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.DrillDetail", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "id", "description": "The id of the drilled item", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "id" } ], "ojshortdesc": "The id of the drilled item." } ] }, { "id": "oj-c.Legend.MenuItem", "name": "MenuItem", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.MenuItem", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Specifies a standard menu item.", "properties": [ { "name": "type", "description": "Specifies a standard menu item.", "optional": true, "type": { "names": [ "\"item\"" ] }, "ojshortdesc": "Specifies a standard menu item." }, { "name": "label", "description": "The menu item label.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "The menu item label." }, { "name": "key", "description": "A unique key associated with the menu item.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "A unique key associated with the menu item." }, { "name": "disabled", "description": "Specifies if the menu item is disabled (enabled by default).", "optional": true, "type": { "names": [ "boolean" ] }, "ojshortdesc": "Specifies if the menu item is disabled (enabled by default)." }, { "name": "onAction", "description": "Optional callback function associated with the menu item.", "optional": true, "type": { "names": [ "function" ] }, "ojshortdesc": "Optional callback function associated with the menu item." }, { "name": "startIcon", "description": "Optional icon to render at the start of the menu item.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "startIcon" } ], "ojshortdesc": "Optional icon to render at the start of the menu item." }, { "name": "endIcon", "description": "Optional icon to render at the end of the menu item.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "endIcon" } ], "ojshortdesc": "Optional icon to render at the end of the menu item." }, { "name": "variant", "description": "Specifies the menu item behavior.", "optional": true, "type": { "names": [ "\"standard\"", "\"destructive\"" ] }, "ojshortdesc": "Specifies the menu item behavior." } ] }, { "id": "oj-c.Legend.ContextMenuSeparator", "name": "ContextMenuSeparator", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.ContextMenuSeparator", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "type", "optional": false, "type": { "names": [ "\"separator\"" ] } } ] }, { "id": "oj-c.Legend.MenuSelectItem", "name": "MenuSelectItem", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.MenuSelectItem", "type": { "names": [ "Object" ] }, "scope": "static", "description": "Specifies a selectable item in a menu item.", "properties": [ { "name": "label", "description": "The selectable item label.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "The selectable item label." }, { "name": "disabled", "description": "Specifies if the selectable item is disabled (enabled by default).", "optional": true, "type": { "names": [ "boolean" ] }, "ojshortdesc": "Specifies if the selectable item is disabled (enabled by default)." }, { "name": "startIcon", "description": "Optional icon to render at the start of the selectable item.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "startIcon" } ], "ojshortdesc": "Optional icon to render at the start of the selectable item." }, { "name": "endIcon", "description": "Optional icon to render at the end of the selectable item.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "endIcon" } ], "ojshortdesc": "Optional icon to render at the end of the selectable item." }, { "name": "value", "description": "The value associated with the selectable item.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "The value associated with the selectable item." } ] }, { "id": "oj-c.Legend.MenuSelection", "name": "MenuSelection", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.MenuSelection", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "at", "optional": false, "type": { "names": [ "function" ] }, "tstype": [ { "target": "Type", "value": "(index: number) => string | undefined", "jsdocOverride": true, "for": "at" } ] } ] }, { "id": "oj-c.Legend.SelectMenuItemDetail", "name": "SelectMenuItemDetail", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.SelectMenuItemDetail", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "value", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "T", "jsdocOverride": true, "for": "value" } ] }, { "name": "menuSelectionGroupKey", "optional": false, "type": { "names": [ "string" ] } } ] }, { "id": "oj-c.Legend.ContextMenuSelectSingle", "name": "ContextMenuSelectSingle", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.ContextMenuSelectSingle", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "type", "description": "Specifies a select single menu item.", "optional": false, "type": { "names": [ "\"selectsingle\"" ] }, "ojshortdesc": "Specifies a select single menu item." }, { "name": "key", "description": "A unique key associated with the select single.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "A unique key associated with the select single." }, { "name": "items", "description": "Specifies the array of select items that make up the select single.", "optional": true, "type": { "names": [ "Array" ] }, "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true, "for": "items" } ] }, { "name": "selection", "optional": true, "type": { "names": [ "string" ] } }, { "name": "onSelection", "optional": true, "type": { "names": [ "function" ] }, "tstype": [ { "target": "Type", "value": "(detail: oj-c.Legend.SelectMenuItemDetail) => void", "jsdocOverride": true, "for": "onSelection" } ] } ] }, { "id": "oj-c.Legend.ContextMenuSelectMultiple", "name": "ContextMenuSelectMultiple", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.ContextMenuSelectMultiple", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "type", "description": "Specifies a select multiple menu item.", "optional": false, "type": { "names": [ "\"selectmultiple\"" ] }, "ojshortdesc": "Specifies a select multiple menu item." }, { "name": "key", "description": "A unique key associated with the select multiple.", "optional": false, "type": { "names": [ "string" ] }, "ojshortdesc": "A unique key associated with the select multiple." }, { "name": "items", "description": "Specifies the array of select items that make up the select multiple.", "optional": true, "type": { "names": [ "Array" ] }, "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true, "for": "items" } ] }, { "name": "selection", "optional": true, "type": { "names": [ "Array" ] } }, { "name": "onSelection", "optional": true, "type": { "names": [ "function" ] }, "tstype": [ { "target": "Type", "value": "(detail: oj-c.Legend.SelectMenuItemDetail) => void", "jsdocOverride": true, "for": "onSelection" } ] } ] }, { "id": "oj-c.Legend.ContextMenuSubMenu", "name": "ContextMenuSubMenu", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.ContextMenuSubMenu", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "type", "description": "Specifies a submenu menu item.", "optional": false, "type": { "names": [ "\"submenu\"" ] }, "ojshortdesc": "Specifies a submenu menu item." }, { "name": "key", "description": "A unique key associated with the submenu menu item.", "optional": true, "type": { "names": [ "string" ] }, "ojshortdesc": "A unique key associated with the submenu menu item." }, { "name": "label", "description": "The submenu label.", "optional": true, "type": { "names": [ "string" ] }, "ojshortdesc": "The submenu label." }, { "name": "disabled", "description": "Specifies if the submenu is disabled (enabled by default).", "optional": true, "type": { "names": [ "boolean" ] }, "ojshortdesc": "Specifies if the submenu is disabled (enabled by default)." }, { "name": "startIcon", "description": "Optional icon to render at the start of the submenu.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "{ type?: 'class'; class: string; }|{ type: 'img'; src: string; }", "jsdocOverride": true, "for": "startIcon" } ], "ojshortdesc": "Optional icon to render at the start of the submenu." }, { "name": "items", "optional": true, "type": { "names": [ "Array" ] }, "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true, "for": "items" } ] } ] }, { "id": "oj-c.Legend.ContextMenuItems", "name": "ContextMenuItems", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.ContextMenuItems", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tstype": [ { "target": "Type", "value": "oj-c.Legend.MenuItem|oj-c.Legend.ContextMenuSeparator|oj-c.Legend.ContextMenuSubMenu|oj-c.Legend.ContextMenuSelectSingle|oj-c.Legend.ContextMenuSelectMultiple", "jsdocOverride": true } ] }, { "id": "oj-c.Legend.LegendContextMenuConfig", "name": "LegendContextMenuConfig", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.LegendContextMenuConfig", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "accessibleLabel", "optional": true, "type": { "names": [ "string" ] } }, { "name": "items", "optional": false, "type": { "names": [ "function" ] }, "tstype": [ { "target": "Type", "value": "(context: LegendContextMenuContext) => Array", "jsdocOverride": true, "for": "items" } ] } ] }, { "id": "oj-c.Legend.ContextMenuActionDetail", "name": "ContextMenuActionDetail", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.ContextMenuActionDetail", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "menuItemKey", "optional": false, "type": { "names": [ "string" ] } }, { "name": "contextMenuContext", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "C", "jsdocOverride": true, "for": "contextMenuContext" } ] } ] }, { "id": "oj-c.Legend.ContextMenuSelectionDetail", "name": "ContextMenuSelectionDetail", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.ContextMenuSelectionDetail", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "value", "optional": false, "type": { "names": [ "string|Array" ] } }, { "name": "contextMenuContext", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "C", "jsdocOverride": true, "for": "contextMenuContext" } ] }, { "name": "menuSelectionGroupKey", "optional": false, "type": { "names": [ "string" ] } } ] }, { "id": "oj-c.Legend.DatatipTemplateContext", "name": "DatatipTemplateContext", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.DatatipTemplateContext", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "color", "description": "The color of the hovered item.", "optional": true, "type": { "names": [ "string" ] } }, { "name": "text", "description": "The text of the legend item.", "optional": false, "type": { "names": [ "string" ] } }, { "name": "id", "description": "The id of the hovered item.", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "id" } ] }, { "name": "itemData", "description": "The row data object for the hovered item. This will only be set if a DataProvider is being used.", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "D", "jsdocOverride": true, "for": "itemData" } ] }, { "name": "sectionId", "description": "The id of the hovered section.", "optional": true, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "sectionId" } ] }, { "name": "sectionData", "description": "The sectionData of the hovered item.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "oj-c.Legend.Section", "jsdocOverride": true, "for": "sectionData" } ] } ] }, { "id": "oj-c.Legend.DatatipStyle", "name": "DatatipStyle", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.DatatipStyle", "type": { "names": [ "Object" ] }, "scope": "static", "description": "The datatipStyle is used to specify datatip border color.", "properties": [ { "name": "borderColor", "optional": false, "type": { "names": [ "\"transparent\"|\"inherit\"|\"initial\"|\"-moz-initial\"|\"revert\"|\"revert-layer\"|\"unset\"|\"aliceblue\"|\"antiquewhite\"|\"aqua\"|\"aquamarine\"|\"azure\"|\"beige\"|\"bisque\"|\"black\"|\"blanchedalmond\"|\"blue\"|\"blueviolet\"|\"brown\"|\"burlywood\"|\"cadetblue\"|\"chartreuse\"|\"chocolate\"|\"coral\"|\"cornflowerblue\"|\"cornsilk\"|\"crimson\"|\"cyan\"|\"darkblue\"|\"darkcyan\"|\"darkgoldenrod\"|\"darkgray\"|\"darkgreen\"|\"darkgrey\"|\"darkkhaki\"|\"darkmagenta\"|\"darkolivegreen\"|\"darkorange\"|\"darkorchid\"|\"darkred\"|\"darksalmon\"|\"darkseagreen\"|\"darkslateblue\"|\"darkslategray\"|\"darkslategrey\"|\"darkturquoise\"|\"darkviolet\"|\"deeppink\"|\"deepskyblue\"|\"dimgray\"|\"dimgrey\"|\"dodgerblue\"|\"firebrick\"|\"floralwhite\"|\"forestgreen\"|\"fuchsia\"|\"gainsboro\"|\"ghostwhite\"|\"gold\"|\"goldenrod\"|\"gray\"|\"green\"|\"greenyellow\"|\"grey\"|\"honeydew\"|\"hotpink\"|\"indianred\"|\"indigo\"|\"ivory\"|\"khaki\"|\"lavender\"|\"lavenderblush\"|\"lawngreen\"|\"lemonchiffon\"|\"lightblue\"|\"lightcoral\"|\"lightcyan\"|\"lightgoldenrodyellow\"|\"lightgray\"|\"lightgreen\"|\"lightgrey\"|\"lightpink\"|\"lightsalmon\"|\"lightseagreen\"|\"lightskyblue\"|\"lightslategray\"|\"lightslategrey\"|\"lightsteelblue\"|\"lightyellow\"|\"lime\"|\"limegreen\"|\"linen\"|\"magenta\"|\"maroon\"|\"mediumaquamarine\"|\"mediumblue\"|\"mediumorchid\"|\"mediumpurple\"|\"mediumseagreen\"|\"mediumslateblue\"|\"mediumspringgreen\"|\"mediumturquoise\"|\"mediumvioletred\"|\"midnightblue\"|\"mintcream\"|\"mistyrose\"|\"moccasin\"|\"navajowhite\"|\"navy\"|\"oldlace\"|\"olive\"|\"olivedrab\"|\"orange\"|\"orangered\"|\"orchid\"|\"palegoldenrod\"|\"palegreen\"|\"paleturquoise\"|\"palevioletred\"|\"papayawhip\"|\"peachpuff\"|\"peru\"|\"pink\"|\"plum\"|\"powderblue\"|\"purple\"|\"rebeccapurple\"|\"red\"|\"rosybrown\"|\"royalblue\"|\"saddlebrown\"|\"salmon\"|\"sandybrown\"|\"seagreen\"|\"seashell\"|\"sienna\"|\"silver\"|\"skyblue\"|\"slateblue\"|\"slategray\"|\"slategrey\"|\"snow\"|\"springgreen\"|\"steelblue\"|\"tan\"|\"teal\"|\"thistle\"|\"tomato\"|\"turquoise\"|\"violet\"|\"wheat\"|\"white\"|\"whitesmoke\"|\"yellow\"|\"yellowgreen\"|\"ActiveBorder\"|\"ActiveCaption\"|\"AppWorkspace\"|\"Background\"|\"ButtonFace\"|\"ButtonHighlight\"|\"ButtonShadow\"|\"ButtonText\"|\"CaptionText\"|\"GrayText\"|\"Highlight\"|\"HighlightText\"|\"InactiveBorder\"|\"InactiveCaption\"|\"InactiveCaptionText\"|\"InfoBackground\"|\"InfoText\"|\"Menu\"|\"MenuText\"|\"Scrollbar\"|\"ThreeDDarkShadow\"|\"ThreeDFace\"|\"ThreeDHighlight\"|\"ThreeDLightShadow\"|\"ThreeDShadow\"|\"Window\"|\"WindowFrame\"|\"WindowText\"|\"currentcolor\"|string" ] }, "tstype": [ { "target": "Type", "value": "\"transparent\"|\"inherit\"|\"initial\"|\"-moz-initial\"|\"revert\"|\"revert-layer\"|\"unset\"|\"aliceblue\"|\"antiquewhite\"|\"aqua\"|\"aquamarine\"|\"azure\"|\"beige\"|\"bisque\"|\"black\"|\"blanchedalmond\"|\"blue\"|\"blueviolet\"|\"brown\"|\"burlywood\"|\"cadetblue\"|\"chartreuse\"|\"chocolate\"|\"coral\"|\"cornflowerblue\"|\"cornsilk\"|\"crimson\"|\"cyan\"|\"darkblue\"|\"darkcyan\"|\"darkgoldenrod\"|\"darkgray\"|\"darkgreen\"|\"darkgrey\"|\"darkkhaki\"|\"darkmagenta\"|\"darkolivegreen\"|\"darkorange\"|\"darkorchid\"|\"darkred\"|\"darksalmon\"|\"darkseagreen\"|\"darkslateblue\"|\"darkslategray\"|\"darkslategrey\"|\"darkturquoise\"|\"darkviolet\"|\"deeppink\"|\"deepskyblue\"|\"dimgray\"|\"dimgrey\"|\"dodgerblue\"|\"firebrick\"|\"floralwhite\"|\"forestgreen\"|\"fuchsia\"|\"gainsboro\"|\"ghostwhite\"|\"gold\"|\"goldenrod\"|\"gray\"|\"green\"|\"greenyellow\"|\"grey\"|\"honeydew\"|\"hotpink\"|\"indianred\"|\"indigo\"|\"ivory\"|\"khaki\"|\"lavender\"|\"lavenderblush\"|\"lawngreen\"|\"lemonchiffon\"|\"lightblue\"|\"lightcoral\"|\"lightcyan\"|\"lightgoldenrodyellow\"|\"lightgray\"|\"lightgreen\"|\"lightgrey\"|\"lightpink\"|\"lightsalmon\"|\"lightseagreen\"|\"lightskyblue\"|\"lightslategray\"|\"lightslategrey\"|\"lightsteelblue\"|\"lightyellow\"|\"lime\"|\"limegreen\"|\"linen\"|\"magenta\"|\"maroon\"|\"mediumaquamarine\"|\"mediumblue\"|\"mediumorchid\"|\"mediumpurple\"|\"mediumseagreen\"|\"mediumslateblue\"|\"mediumspringgreen\"|\"mediumturquoise\"|\"mediumvioletred\"|\"midnightblue\"|\"mintcream\"|\"mistyrose\"|\"moccasin\"|\"navajowhite\"|\"navy\"|\"oldlace\"|\"olive\"|\"olivedrab\"|\"orange\"|\"orangered\"|\"orchid\"|\"palegoldenrod\"|\"palegreen\"|\"paleturquoise\"|\"palevioletred\"|\"papayawhip\"|\"peachpuff\"|\"peru\"|\"pink\"|\"plum\"|\"powderblue\"|\"purple\"|\"rebeccapurple\"|\"red\"|\"rosybrown\"|\"royalblue\"|\"saddlebrown\"|\"salmon\"|\"sandybrown\"|\"seagreen\"|\"seashell\"|\"sienna\"|\"silver\"|\"skyblue\"|\"slateblue\"|\"slategray\"|\"slategrey\"|\"snow\"|\"springgreen\"|\"steelblue\"|\"tan\"|\"teal\"|\"thistle\"|\"tomato\"|\"turquoise\"|\"violet\"|\"wheat\"|\"white\"|\"whitesmoke\"|\"yellow\"|\"yellowgreen\"|\"ActiveBorder\"|\"ActiveCaption\"|\"AppWorkspace\"|\"Background\"|\"ButtonFace\"|\"ButtonHighlight\"|\"ButtonShadow\"|\"ButtonText\"|\"CaptionText\"|\"GrayText\"|\"Highlight\"|\"HighlightText\"|\"InactiveBorder\"|\"InactiveCaption\"|\"InactiveCaptionText\"|\"InfoBackground\"|\"InfoText\"|\"Menu\"|\"MenuText\"|\"Scrollbar\"|\"ThreeDDarkShadow\"|\"ThreeDFace\"|\"ThreeDHighlight\"|\"ThreeDLightShadow\"|\"ThreeDShadow\"|\"Window\"|\"WindowFrame\"|\"WindowText\"|\"currentcolor\"|string", "jsdocOverride": true } ], "ojvalues": [ { "name": "transparent", "type": { "names": [ "string" ] } }, { "name": "inherit", "type": { "names": [ "string" ] } }, { "name": "initial", "type": { "names": [ "string" ] } }, { "name": "-moz-initial", "type": { "names": [ "string" ] } }, { "name": "revert", "type": { "names": [ "string" ] } }, { "name": "revert-layer", "type": { "names": [ "string" ] } }, { "name": "unset", "type": { "names": [ "string" ] } }, { "name": "aliceblue", "type": { "names": [ "string" ] } }, { "name": "antiquewhite", "type": { "names": [ "string" ] } }, { "name": "aqua", "type": { "names": [ "string" ] } }, { "name": "aquamarine", "type": { "names": [ "string" ] } }, { "name": "azure", "type": { "names": [ "string" ] } }, { "name": "beige", "type": { "names": [ "string" ] } }, { "name": "bisque", "type": { "names": [ "string" ] } }, { "name": "black", "type": { "names": [ "string" ] } }, { "name": "blanchedalmond", "type": { "names": [ "string" ] } }, { "name": "blue", "type": { "names": [ "string" ] } }, { "name": "blueviolet", "type": { "names": [ "string" ] } }, { "name": "brown", "type": { "names": [ "string" ] } }, { "name": "burlywood", "type": { "names": [ "string" ] } }, { "name": "cadetblue", "type": { "names": [ "string" ] } }, { "name": "chartreuse", "type": { "names": [ "string" ] } }, { "name": "chocolate", "type": { "names": [ "string" ] } }, { "name": "coral", "type": { "names": [ "string" ] } }, { "name": "cornflowerblue", "type": { "names": [ "string" ] } }, { "name": "cornsilk", "type": { "names": [ "string" ] } }, { "name": "crimson", "type": { "names": [ "string" ] } }, { "name": "cyan", "type": { "names": [ "string" ] } }, { "name": "darkblue", "type": { "names": [ "string" ] } }, { "name": "darkcyan", "type": { "names": [ "string" ] } }, { "name": "darkgoldenrod", "type": { "names": [ "string" ] } }, { "name": "darkgray", "type": { "names": [ "string" ] } }, { "name": "darkgreen", "type": { "names": [ "string" ] } }, { "name": "darkgrey", "type": { "names": [ "string" ] } }, { "name": "darkkhaki", "type": { "names": [ "string" ] } }, { "name": "darkmagenta", "type": { "names": [ "string" ] } }, { "name": "darkolivegreen", "type": { "names": [ "string" ] } }, { "name": "darkorange", "type": { "names": [ "string" ] } }, { "name": "darkorchid", "type": { "names": [ "string" ] } }, { "name": "darkred", "type": { "names": [ "string" ] } }, { "name": "darksalmon", "type": { "names": [ "string" ] } }, { "name": "darkseagreen", "type": { "names": [ "string" ] } }, { "name": "darkslateblue", "type": { "names": [ "string" ] } }, { "name": "darkslategray", "type": { "names": [ "string" ] } }, { "name": "darkslategrey", "type": { "names": [ "string" ] } }, { "name": "darkturquoise", "type": { "names": [ "string" ] } }, { "name": "darkviolet", "type": { "names": [ "string" ] } }, { "name": "deeppink", "type": { "names": [ "string" ] } }, { "name": "deepskyblue", "type": { "names": [ "string" ] } }, { "name": "dimgray", "type": { "names": [ "string" ] } }, { "name": "dimgrey", "type": { "names": [ "string" ] } }, { "name": "dodgerblue", "type": { "names": [ "string" ] } }, { "name": "firebrick", "type": { "names": [ "string" ] } }, { "name": "floralwhite", "type": { "names": [ "string" ] } }, { "name": "forestgreen", "type": { "names": [ "string" ] } }, { "name": "fuchsia", "type": { "names": [ "string" ] } }, { "name": "gainsboro", "type": { "names": [ "string" ] } }, { "name": "ghostwhite", "type": { "names": [ "string" ] } }, { "name": "gold", "type": { "names": [ "string" ] } }, { "name": "goldenrod", "type": { "names": [ "string" ] } }, { "name": "gray", "type": { "names": [ "string" ] } }, { "name": "green", "type": { "names": [ "string" ] } }, { "name": "greenyellow", "type": { "names": [ "string" ] } }, { "name": "grey", "type": { "names": [ "string" ] } }, { "name": "honeydew", "type": { "names": [ "string" ] } }, { "name": "hotpink", "type": { "names": [ "string" ] } }, { "name": "indianred", "type": { "names": [ "string" ] } }, { "name": "indigo", "type": { "names": [ "string" ] } }, { "name": "ivory", "type": { "names": [ "string" ] } }, { "name": "khaki", "type": { "names": [ "string" ] } }, { "name": "lavender", "type": { "names": [ "string" ] } }, { "name": "lavenderblush", "type": { "names": [ "string" ] } }, { "name": "lawngreen", "type": { "names": [ "string" ] } }, { "name": "lemonchiffon", "type": { "names": [ "string" ] } }, { "name": "lightblue", "type": { "names": [ "string" ] } }, { "name": "lightcoral", "type": { "names": [ "string" ] } }, { "name": "lightcyan", "type": { "names": [ "string" ] } }, { "name": "lightgoldenrodyellow", "type": { "names": [ "string" ] } }, { "name": "lightgray", "type": { "names": [ "string" ] } }, { "name": "lightgreen", "type": { "names": [ "string" ] } }, { "name": "lightgrey", "type": { "names": [ "string" ] } }, { "name": "lightpink", "type": { "names": [ "string" ] } }, { "name": "lightsalmon", "type": { "names": [ "string" ] } }, { "name": "lightseagreen", "type": { "names": [ "string" ] } }, { "name": "lightskyblue", "type": { "names": [ "string" ] } }, { "name": "lightslategray", "type": { "names": [ "string" ] } }, { "name": "lightslategrey", "type": { "names": [ "string" ] } }, { "name": "lightsteelblue", "type": { "names": [ "string" ] } }, { "name": "lightyellow", "type": { "names": [ "string" ] } }, { "name": "lime", "type": { "names": [ "string" ] } }, { "name": "limegreen", "type": { "names": [ "string" ] } }, { "name": "linen", "type": { "names": [ "string" ] } }, { "name": "magenta", "type": { "names": [ "string" ] } }, { "name": "maroon", "type": { "names": [ "string" ] } }, { "name": "mediumaquamarine", "type": { "names": [ "string" ] } }, { "name": "mediumblue", "type": { "names": [ "string" ] } }, { "name": "mediumorchid", "type": { "names": [ "string" ] } }, { "name": "mediumpurple", "type": { "names": [ "string" ] } }, { "name": "mediumseagreen", "type": { "names": [ "string" ] } }, { "name": "mediumslateblue", "type": { "names": [ "string" ] } }, { "name": "mediumspringgreen", "type": { "names": [ "string" ] } }, { "name": "mediumturquoise", "type": { "names": [ "string" ] } }, { "name": "mediumvioletred", "type": { "names": [ "string" ] } }, { "name": "midnightblue", "type": { "names": [ "string" ] } }, { "name": "mintcream", "type": { "names": [ "string" ] } }, { "name": "mistyrose", "type": { "names": [ "string" ] } }, { "name": "moccasin", "type": { "names": [ "string" ] } }, { "name": "navajowhite", "type": { "names": [ "string" ] } }, { "name": "navy", "type": { "names": [ "string" ] } }, { "name": "oldlace", "type": { "names": [ "string" ] } }, { "name": "olive", "type": { "names": [ "string" ] } }, { "name": "olivedrab", "type": { "names": [ "string" ] } }, { "name": "orange", "type": { "names": [ "string" ] } }, { "name": "orangered", "type": { "names": [ "string" ] } }, { "name": "orchid", "type": { "names": [ "string" ] } }, { "name": "palegoldenrod", "type": { "names": [ "string" ] } }, { "name": "palegreen", "type": { "names": [ "string" ] } }, { "name": "paleturquoise", "type": { "names": [ "string" ] } }, { "name": "palevioletred", "type": { "names": [ "string" ] } }, { "name": "papayawhip", "type": { "names": [ "string" ] } }, { "name": "peachpuff", "type": { "names": [ "string" ] } }, { "name": "peru", "type": { "names": [ "string" ] } }, { "name": "pink", "type": { "names": [ "string" ] } }, { "name": "plum", "type": { "names": [ "string" ] } }, { "name": "powderblue", "type": { "names": [ "string" ] } }, { "name": "purple", "type": { "names": [ "string" ] } }, { "name": "rebeccapurple", "type": { "names": [ "string" ] } }, { "name": "red", "type": { "names": [ "string" ] } }, { "name": "rosybrown", "type": { "names": [ "string" ] } }, { "name": "royalblue", "type": { "names": [ "string" ] } }, { "name": "saddlebrown", "type": { "names": [ "string" ] } }, { "name": "salmon", "type": { "names": [ "string" ] } }, { "name": "sandybrown", "type": { "names": [ "string" ] } }, { "name": "seagreen", "type": { "names": [ "string" ] } }, { "name": "seashell", "type": { "names": [ "string" ] } }, { "name": "sienna", "type": { "names": [ "string" ] } }, { "name": "silver", "type": { "names": [ "string" ] } }, { "name": "skyblue", "type": { "names": [ "string" ] } }, { "name": "slateblue", "type": { "names": [ "string" ] } }, { "name": "slategray", "type": { "names": [ "string" ] } }, { "name": "slategrey", "type": { "names": [ "string" ] } }, { "name": "snow", "type": { "names": [ "string" ] } }, { "name": "springgreen", "type": { "names": [ "string" ] } }, { "name": "steelblue", "type": { "names": [ "string" ] } }, { "name": "tan", "type": { "names": [ "string" ] } }, { "name": "teal", "type": { "names": [ "string" ] } }, { "name": "thistle", "type": { "names": [ "string" ] } }, { "name": "tomato", "type": { "names": [ "string" ] } }, { "name": "turquoise", "type": { "names": [ "string" ] } }, { "name": "violet", "type": { "names": [ "string" ] } }, { "name": "wheat", "type": { "names": [ "string" ] } }, { "name": "white", "type": { "names": [ "string" ] } }, { "name": "whitesmoke", "type": { "names": [ "string" ] } }, { "name": "yellow", "type": { "names": [ "string" ] } }, { "name": "yellowgreen", "type": { "names": [ "string" ] } }, { "name": "ActiveBorder", "type": { "names": [ "string" ] } }, { "name": "ActiveCaption", "type": { "names": [ "string" ] } }, { "name": "AppWorkspace", "type": { "names": [ "string" ] } }, { "name": "Background", "type": { "names": [ "string" ] } }, { "name": "ButtonFace", "type": { "names": [ "string" ] } }, { "name": "ButtonHighlight", "type": { "names": [ "string" ] } }, { "name": "ButtonShadow", "type": { "names": [ "string" ] } }, { "name": "ButtonText", "type": { "names": [ "string" ] } }, { "name": "CaptionText", "type": { "names": [ "string" ] } }, { "name": "GrayText", "type": { "names": [ "string" ] } }, { "name": "Highlight", "type": { "names": [ "string" ] } }, { "name": "HighlightText", "type": { "names": [ "string" ] } }, { "name": "InactiveBorder", "type": { "names": [ "string" ] } }, { "name": "InactiveCaption", "type": { "names": [ "string" ] } }, { "name": "InactiveCaptionText", "type": { "names": [ "string" ] } }, { "name": "InfoBackground", "type": { "names": [ "string" ] } }, { "name": "InfoText", "type": { "names": [ "string" ] } }, { "name": "Menu", "type": { "names": [ "string" ] } }, { "name": "MenuText", "type": { "names": [ "string" ] } }, { "name": "Scrollbar", "type": { "names": [ "string" ] } }, { "name": "ThreeDDarkShadow", "type": { "names": [ "string" ] } }, { "name": "ThreeDFace", "type": { "names": [ "string" ] } }, { "name": "ThreeDHighlight", "type": { "names": [ "string" ] } }, { "name": "ThreeDLightShadow", "type": { "names": [ "string" ] } }, { "name": "ThreeDShadow", "type": { "names": [ "string" ] } }, { "name": "Window", "type": { "names": [ "string" ] } }, { "name": "WindowFrame", "type": { "names": [ "string" ] } }, { "name": "WindowText", "type": { "names": [ "string" ] } }, { "name": "currentcolor", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true } ] }, { "id": "oj-c.Legend.DatatipConfig", "name": "DatatipConfig", "kind": "typedef", "memberof": "oj-c.Legend", "meta": { "filename": "legend.tsx", "path": "web/components/oj-c/legend" }, "longname": "oj-c.Legend.DatatipConfig", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "defaultContainer", "description": "Defines if the datatip container is visually shown. For applications requiring full control over the datatip's appearance, the defaultContainer should be set to \"disabled\". In this mode, the content provided by the datatipTemplate slot takes up the whole datatip. This only applies if a datatipTemplate slot is used.", "optional": false, "type": { "names": [ "\"disabled\"", "\"enabled\"" ] } }, { "name": "style", "description": "Defines the style of the datatip container.", "optional": true, "type": { "names": [ "object" ] }, "tstype": [ { "target": "Type", "value": "oj-c.Legend.DatatipStyle", "jsdocOverride": true, "for": "style" } ] }, { "name": "rendered", "description": "Defines if the datatip is rendered.", "optional": true, "type": { "names": [ "\"off\"", "\"on\"" ] } } ] } ]