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

\n JET PictoChart\n \n

\n\n

PictoChart uses icons to visualize an absolute number, or the relative sizes of the different parts of a population.

\n\n
\n\n<oj-c-picto-chart\n  data=\"[[dataProvider]]\">\n</oj-c-picto-chart>\n\n
\n\n\n

When using colors as a data dimension for PictoChart, the application needs to ensure that they meet minimum contrast requirements.\n Not all colors in the default value ramp provided by oj.ColorAttributeGroupHandler will meet minimum contrast requirements.\n

\n\n

\n Keyboard 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 \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 \n \n \n \n
KeyAction
TabMove focus to next element.
Shift + TabMove focus to previous element.
UpArrowMove focus and selection to previous item.
DownArrowMove focus and selection to next item.
LeftArrowMove focus and selection to previous item.
RightArrowMove focus and selection to next item.
Shift + UpArrowMove focus and multi-select previous item.
Shift + DownArrowMove focus and multi-select next item.
Shift + LeftArrowMove focus and multi-select previous item.
Shift + RightArrowMove focus and multi-select next item.
Ctrl + UpArrowMove focus to previous item, without changing the current selection.
Ctrl + DownArrowMove focus to next item, without changing the current selection.
Ctrl + LeftArrowMove focus to previous item, without changing the current selection.
Ctrl + RightArrowMove focus to next item, without changing the current selection.
Ctrl + SpacebarMulti-select item with focus.
EnterDrill on item when drilling is enabled..
\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 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\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 \n \n \n
TargetGestureAction
Data ItemTapSelect when selectionMode is enabled.
Open a link when the url for a data item is set.
Press & HoldDisplay context menu on release.
BackgroundPress & HoldDisplay context menu on release.
", "scope": "static", "tagWithoutBrackets": "oj-c-picto-chart", "tagWithBrackets": "", "domInterface": "CPictoChartElement", "ojPageTitle": "<oj-c-picto-chart>", "camelCaseName": "PictoChart", "ojPageTitlePrefix": "Element: ", "ojtsvcomponent": true, "tstype": { "target": "Type", "value": "interface CPictoChartElement extends JetElement>" }, "ojsignature": [ { "target": "Type", "value": "interface CPictoChartElement extends JetElement>" } ], "tsdeprecated": [ { "type": "candidate", "since": "20.0.0" } ], "extension": { "vbdt": { "module": "oj-c/picto-chart", "defaultColumns": 12, "minColumns": 6 }, "oracle": { "icon": "oj-ux-ico-picto-chart", "uxSpecs": [ "picto-chart" ] } }, "ojmodule": "picto-chart" }, { "id": "oj-c.PictoChart#data", "name": "data", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#data", "scope": "instance", "type": { "names": [ "DataProvider|null" ] }, "optional": false, "ojdisplayname": "Data", "ojshortdesc": "Specifies the DataProvider for the sections and items of the picto-chart", "description": "Specifies the DataProvider for the sections and items of the picto-chart.", "defaultvalue": null, "tstype": [ { "target": "Type", "value": "DataProvider|null", "jsdocOverride": true, "module": { "DataProvider": "ojdataprovider" } } ] }, { "id": "oj-c.PictoChart#hiddenCategories", "name": "hiddenCategories", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#hiddenCategories", "scope": "instance", "type": { "names": [ "Array" ] }, "optional": true, "ojdisplayname": "Hidden Categories", "ojwriteback": true, "ojshortdesc": "An array of categories that will be hidden.", "description": "An array of category strings used for highlighting. Data items matching categories in this array will be highlighted.", "defaultvalue": "'[]'" }, { "id": "oj-c.PictoChart#highlightMatch", "name": "highlightMatch", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#highlightMatch", "scope": "instance", "type": { "names": [ "\"all\"", "\"any\"" ] }, "optional": true, "ojdisplayname": "Highlight Match", "ojshortdesc": "The matching condition for the highlightedCategories option. By default, highlightMatch is 'all' and only items whose categories match all of the values specified in the highlightedCategories array will be highlighted. If highlightMatch is 'any', then items that match at least one of the highlightedCategories values will be highlighted.", "description": "The matching condition for the highlightedCategories property. By default, highlightMatch is 'all' and only items whose categories match all of the values specified in the highlightedCategories array will be highlighted. If highlightMatch is 'any', then items that match at least one of the highlightedCategories values will be highlighted.", "defaultvalue": "'all'" }, { "id": "oj-c.PictoChart#highlightedCategories", "name": "highlightedCategories", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#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.PictoChart#hoverBehavior", "name": "hoverBehavior", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#hoverBehavior", "scope": "instance", "type": { "names": [ "\"none\"", "\"dim\"" ] }, "optional": true, "ojdisplayname": "Hover Behavior", "ojshortdesc": "Defines the behavior applied when hovering over data items.", "description": "The behavior applied when hovering over data items.", "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.PictoChart#layout", "name": "layout", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#layout", "scope": "instance", "type": { "names": [ "\"horizontal\"", "\"vertical\"" ] }, "optional": true, "ojdisplayname": "Layout", "description": "The direction in which the items are laid out.", "ojvalues": [ { "name": "vertical", "description": "Items will be vertically placed in available space.", "displayName": "Vertical", "type": { "names": [ "string" ] } }, { "name": "horizontal", "description": "Items will be horizontally stacked.", "displayName": "Horizontal", "type": { "names": [ "string" ] } } ], "ojvalueskeeporder": true, "defaultvalue": "'horizontal'" }, { "id": "oj-c.PictoChart#drilling", "name": "drilling", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#drilling", "scope": "instance", "type": { "names": [ "\"off\"", "\"on\"" ] }, "optional": true, "ojdisplayname": "Drilling", "ojshortdesc": "Drillable items will show a pointer cursor on hover and fire an ojDrill event on click (double click if selection is enabled).", "description": "Whether drilling is enabled. Drillable items will show a pointer cursor on hover and fire an ojDrill event on click (double click if selection is enabled). To enable or disable drilling on individual items, use the drilling attribute in each item.", "defaultvalue": "'off'" }, { "id": "oj-c.PictoChart#layoutOrigin", "name": "layoutOrigin", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#layoutOrigin", "scope": "instance", "type": { "names": [ "\"topStart\"", "\"topEnd\"", "\"bottomStart\"", "\"bottomEnd\"" ] }, "optional": true, "ojdisplayname": "Layout Origin", "description": "Defines where the first item is rendered. The subsequent items follow the first item according to the layout.", "defaultvalue": "'topStart'" }, { "id": "oj-c.PictoChart#columnCount", "name": "columnCount", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#columnCount", "scope": "instance", "type": { "names": [ "number" ] }, "optional": true, "ojdisplayname": "Column Count", "ojshortdesc": "Specifies the column count.", "description": "The number of columns that the picto chart has. The number of columns will be automatically computed if not specified." }, { "id": "oj-c.PictoChart#columnWidth", "name": "columnWidth", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#columnWidth", "scope": "instance", "type": { "names": [ "number|string" ] }, "optional": true, "ojdisplayname": "Column Width", "ojshortdesc": "Specifies the column width.", "description": "The width of a column in pixels. The width of columns will be automatically computed if not specified. Setting this property in a fixed layout (when the element width and height are defined) may cause items to be truncated." }, { "id": "oj-c.PictoChart#contextMenuConfig", "name": "contextMenuConfig", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#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.PictoChart.PictoChartContextMenuConfig", "jsdocOverride": true } ] }, { "id": "oj-c.PictoChart#rowCount", "name": "rowCount", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#rowCount", "scope": "instance", "type": { "names": [ "number" ] }, "optional": true, "ojdisplayname": "Row Count", "ojshortdesc": "Specifies the row count.", "description": "The number of rows that the picto chart has. The number of rows will be automatically computed if not specified." }, { "id": "oj-c.PictoChart#rowHeight", "name": "rowHeight", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#rowHeight", "scope": "instance", "type": { "names": [ "number|string" ] }, "optional": true, "ojdisplayname": "Row Height", "ojshortdesc": "Specifies the row height.", "description": "The height of a row in pixels. The height of rows will be automatically computed if not specified. Setting this property in a fixed layout (when the element width and height are defined) may cause items to be truncated." }, { "id": "oj-c.PictoChart#selectionMode", "name": "selectionMode", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#selectionMode", "scope": "instance", "type": { "names": [ "\"none\"", "\"multiple\"", "\"single\"" ] }, "optional": true, "ojdisplayname": "Selection Mode", "ojshortdesc": "Specifies the selection mode.", "description": "The type of selection behavior that is enabled on the picto chart. This attribute controls the number of selections that can be made via selection gestures at any given time.", "defaultvalue": "'none'" }, { "id": "oj-c.PictoChart#selection", "name": "selection", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#selection", "scope": "instance", "type": { "names": [ "Array" ] }, "optional": true, "ojdisplayname": "Selection", "ojwriteback": true, "description": "An array of id strings, used to define the selected objects.", "defaultvalue": "'[]'", "tstype": [ { "target": "Type", "value": "Array", "jsdocOverride": true } ] }, { "id": "oj-c.PictoChart#setProperty", "name": "setProperty", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "function", "longname": "oj-c.PictoChart#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.PictoChart#getProperty", "name": "getProperty", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "function", "longname": "oj-c.PictoChart#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.PictoChart#setProperties", "name": "setProperties", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "function", "longname": "oj-c.PictoChart#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.PictoChart#event:ojContextMenuAction", "name": "ojContextMenuAction", "kind": "event", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart#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.PictoChart.Item; itemData?: D; type: 'item'; }", "jsdocOverride": true, "for": "contextMenuContext" } ] } ] }, { "id": "oj-c.PictoChart#event:ojContextMenuSelection", "name": "ojContextMenuSelection", "kind": "event", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart#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.PictoChart.Item; itemData?: D; type: 'item'; }", "jsdocOverride": true, "for": "contextMenuContext" } ] }, { "name": "menuSelectionGroupKey", "optional": false, "type": { "names": [ "string" ] } } ] }, { "id": "oj-c.PictoChart#event:ojDrill", "name": "ojDrill", "kind": "event", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart#event:ojDrill", "scope": "instance", "ojshortdesc": "Triggered during a drill gesture (single click on the pictochart item).", "description": "

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

Triggered during a drill gesture (single click on the pictochart item)." }, { "id": "oj-c.PictoChart#itemTemplate", "name": "itemTemplate", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "kind": "member", "longname": "oj-c.PictoChart#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.PictoChart.PictoChartItemTemplateContext]{@link oj-c.PictoChart.PictoChartItemTemplateContext}

\n The itemTemplate slot is used to specify the template for\n creating items. The slot content must be a single <template>\n element.\n

\n

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

\n
    \n
  • \n $current - an object that contains information for the current item.\n (See the table below for a list of properties available on $current)\n
    • \n
  • \n alias - if as attribute was specified, the value will be used to provide an application-named alias for $current.\n
    • \n
\n

\nThe content of the template should only be one <oj-c-picto-chart-item> element. See the oj-picto-chart-item doc for more details.\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.PictoChart.PictoChartItemTemplateContext" }, { "id": "oj-c.PictoChart.touchDoc", "name": "touchDoc", "kind": "member", "longname": "oj-c.PictoChart.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 \n \n \n
TargetGestureAction
Data ItemTapSelect when selectionMode is enabled.
Open a link when the url for a data item is set.
Press & HoldDisplay context menu on release.
BackgroundPress & HoldDisplay context menu on release.
", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "ojfragment": true }, { "id": "oj-c.PictoChart.keyboardDoc", "name": "keyboardDoc", "kind": "member", "longname": "oj-c.PictoChart.keyboardDoc", "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 \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 \n \n \n \n \n
KeyAction
TabMove focus to next element.
Shift + TabMove focus to previous element.
UpArrowMove focus and selection to previous item.
DownArrowMove focus and selection to next item.
LeftArrowMove focus and selection to previous item.
RightArrowMove focus and selection to next item.
Shift + UpArrowMove focus and multi-select previous item.
Shift + DownArrowMove focus and multi-select next item.
Shift + LeftArrowMove focus and multi-select previous item.
Shift + RightArrowMove focus and multi-select next item.
Ctrl + UpArrowMove focus to previous item, without changing the current selection.
Ctrl + DownArrowMove focus to next item, without changing the current selection.
Ctrl + LeftArrowMove focus to previous item, without changing the current selection.
Ctrl + RightArrowMove focus to next item, without changing the current selection.
Ctrl + SpacebarMulti-select item with focus.
EnterDrill on item when drilling is enabled..
", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "ojfragment": true }, { "id": "oj-c.PictoChart.Item", "name": "Item", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.Item", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "id", "description": "The item id should be set by the application if the DataProvider is not being used. The row key will be used as id in the DataProvider case.", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "id" } ] }, { "name": "categories", "description": "An array of category strings corresponding to the picto chart items. This allows highlighting and filtering of items.", "optional": true, "type": { "names": [ "Array" ] }, "ojshortdesc": "An array of category strings corresponding to the picto chart items." }, { "name": "drilling", "description": "Whether drilling is enabled on the item. Drillable items will show a pointer cursor on hover and fire an ojDrill event on click (double click if selection is enabled). To enable drilling for all items at once, use the drilling attribute in the top level.", "optional": true, "type": { "names": [ "\"off\"", "\"inherit\"", "\"on\"" ] }, "ojshortdesc": "Whether drilling is enabled on the item." }, { "name": "color", "description": "The color of the item. Does not apply if custom image is specified.", "optional": true, "type": { "names": [ "string" ] } }, { "name": "columnSpan", "description": "The number of columns each shape (or custom image) spans. Used for creating a picto chart with mixed item sizes.", "optional": true, "type": { "names": [ "string" ] } }, { "name": "count", "description": "Specifies the number of times that the shape (or custom image) is drawn.", "optional": true, "type": { "names": [ "string" ] } }, { "name": "name", "description": "The name of the item. Used for default tooltip and accessibility.", "optional": true, "type": { "names": [ "string" ] } }, { "name": "rowSpan", "description": "The number of rows each shape (or custom image) spans. Used for creating a picto chart with mixed item sizes.", "optional": true, "type": { "names": [ "string" ] }, "ojshortdesc": "The name of the item. Used for default tooltip and accessibility." }, { "name": "shape", "description": "The shape of the item. Can take the name of a built-in shape or the SVG path commands for a custom shape.\n\"None\" will make the item transparent and can be used to create gaps. Does not apply if custom image is specified.", "optional": true, "type": { "names": [ "string" ] }, "ojshortdesc": "The shape of the item. Can take the name of a built-in shape or the SVG path commands for a custom shape." }, { "name": "shortDesc", "description": "The description of the item. This is used for customizing the tooltip text.", "optional": true, "type": { "names": [ "string" ] } } ] }, { "id": "oj-c.PictoChart.MenuItem", "name": "MenuItem", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.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.PictoChart.ContextMenuSeparator", "name": "ContextMenuSeparator", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.ContextMenuSeparator", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "properties": [ { "name": "type", "optional": false, "type": { "names": [ "\"separator\"" ] } } ] }, { "id": "oj-c.PictoChart.MenuSelectItem", "name": "MenuSelectItem", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.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.PictoChart.MenuSelection", "name": "MenuSelection", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.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.PictoChart.SelectMenuItemDetail", "name": "SelectMenuItemDetail", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.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.PictoChart.ContextMenuSelectSingle", "name": "ContextMenuSelectSingle", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.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.PictoChart.SelectMenuItemDetail) => void", "jsdocOverride": true, "for": "onSelection" } ] } ] }, { "id": "oj-c.PictoChart.ContextMenuSelectMultiple", "name": "ContextMenuSelectMultiple", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.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.PictoChart.SelectMenuItemDetail) => void", "jsdocOverride": true, "for": "onSelection" } ] } ] }, { "id": "oj-c.PictoChart.ContextMenuSubMenu", "name": "ContextMenuSubMenu", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.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.PictoChart.ContextMenuItems", "name": "ContextMenuItems", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.ContextMenuItems", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tstype": [ { "target": "Type", "value": "oj-c.PictoChart.MenuItem|oj-c.PictoChart.ContextMenuSeparator|oj-c.PictoChart.ContextMenuSubMenu|oj-c.PictoChart.ContextMenuSelectSingle|oj-c.PictoChart.ContextMenuSelectMultiple", "jsdocOverride": true } ] }, { "id": "oj-c.PictoChart.PictoChartContextMenuConfig", "name": "PictoChartContextMenuConfig", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.PictoChartContextMenuConfig", "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: PictochartContextMenuContext) => Array", "jsdocOverride": true, "for": "items" } ] } ] }, { "id": "oj-c.PictoChart.ContextMenuActionDetail", "name": "ContextMenuActionDetail", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.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.PictoChart.ContextMenuSelectionDetail", "name": "ContextMenuSelectionDetail", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.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.PictoChart.PictoChartItemTemplateContext", "name": "PictoChartItemTemplateContext", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.PictoChartItemTemplateContext", "type": { "names": [ "Object" ] }, "scope": "static", "description": "", "tsgenerictype": { "target": "Type", "value": "", "for": "genericTypeParameters" }, "properties": [ { "name": "data", "description": "The data object of the current item.", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "D", "jsdocOverride": true, "for": "data" } ] }, { "name": "key", "description": "The key of the current item.", "optional": false, "type": { "names": [ "any" ] }, "tstype": [ { "target": "Type", "value": "K", "jsdocOverride": true, "for": "key" } ] }, { "name": "index", "description": "The zero-based index of the current item.", "optional": false, "type": { "names": [ "number" ] } } ] }, { "id": "oj-c.PictoChart.DrillDetail", "name": "DrillDetail", "kind": "typedef", "memberof": "oj-c.PictoChart", "meta": { "filename": "picto-chart.tsx", "path": "web/components/oj-c/picto-chart" }, "longname": "oj-c.PictoChart.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." } ] } ]