@kyndryl-design-system/shidoka-charts 2.10.0 → 2.10.2

package/custom-elements.json

@@ -0,0 +1 @@
+{"schemaVersion":"1.0.0","readme":"","modules":[{"kind":"javascript-module","path":"src/index.ts","declarations":[],"exports":[{"kind":"js","name":"KDChart","declaration":{"name":"KDChart","module":"./components/chart"}},{"kind":"js","name":"MermaidDiagram","declaration":{"name":"MermaidDiagram","module":"./components/mermaid"}}]},{"kind":"javascript-module","path":"src/common/helpers/boxplotViolinTableRenderer.ts","declarations":[{"kind":"function","name":"renderBoxplotViolinTableHeader"},{"kind":"function","name":"renderBoxplotViolinTableRow","parameters":[{"name":"label","type":{"text":"string"}},{"name":"values","type":{"text":"number[]"}}]},{"kind":"function","name":"renderBoxplotViolinTable","parameters":[{"name":"labels","type":{"text":"string[]"}},{"name":"datasets","type":{"text":"any[]"}},{"name":"axisLabel","type":{"text":"string"}}]}],"exports":[{"kind":"js","name":"renderBoxplotViolinTableHeader","declaration":{"name":"renderBoxplotViolinTableHeader","module":"src/common/helpers/boxplotViolinTableRenderer.ts"}},{"kind":"js","name":"renderBoxplotViolinTableRow","declaration":{"name":"renderBoxplotViolinTableRow","module":"src/common/helpers/boxplotViolinTableRenderer.ts"}},{"kind":"js","name":"renderBoxplotViolinTable","declaration":{"name":"renderBoxplotViolinTable","module":"src/common/helpers/boxplotViolinTableRenderer.ts"}}]},{"kind":"javascript-module","path":"src/common/helpers/graphTreeTableRenderer.ts","declarations":[{"kind":"function","name":"renderGraphTreeTable","parameters":[{"name":"datasets","type":{"text":"any[]"}}]}],"exports":[{"kind":"js","name":"renderGraphTreeTable","declaration":{"name":"renderGraphTreeTable","module":"src/common/helpers/graphTreeTableRenderer.ts"}}]},{"kind":"javascript-module","path":"src/common/helpers/helpers.ts","declarations":[{"kind":"function","name":"debounce","parameters":[{"name":"fn","type":{"text":"Fn"}},{"name":"ms","default":"100"}]},{"kind":"function","name":"stringToReactHtml","return":{"type":{"text":"{ __html: string }"}},"parameters":[{"name":"value","type":{"text":"string"}}]},{"kind":"function","name":"createOptionsArray","return":{"type":{"text":"T[]"}},"parameters":[{"name":"options","default":"{}","type":{"text":"*"},"description":" imported enums object"}],"description":"Convert an object to an array of only its values.\r\nUsed when importing enums in component stories for populating argType dropdowns."},{"kind":"function","name":"convertChartDataToCSV","return":{"type":{"text":"string | null"}},"parameters":[{"name":"args","type":{"text":"CsvArgs"}}]},{"kind":"function","name":"getRandomData","return":{"type":{"text":"number[]"}},"parameters":[{"name":"arrayLength","default":"6"},{"name":"min","default":"-100"},{"name":"max","default":"100"}]},{"kind":"function","name":"getTextColor","return":{"type":{"text":""}},"parameters":[{"name":"bgHexColor","type":{"text":"string"},"description":"The `bgHexColor` parameter is a string representing a hexadecimal color\r\ncode for the background color."}],"description":"Takes a background hex color as input and returns the appropriate text\r\ncolor (either primary or inversed) based on the brightness of the background color."},{"kind":"function","name":"convertTreeDataToCSV","parameters":[{"name":"datasets","type":{"text":"any[]"}}]},{"kind":"function","name":"convertTreemapDataToCSV","parameters":[{"name":"datasets","type":{"text":"any[]"}}]}],"exports":[{"kind":"js","name":"debounce","declaration":{"name":"debounce","module":"src/common/helpers/helpers.ts"}},{"kind":"js","name":"stringToReactHtml","declaration":{"name":"stringToReactHtml","module":"src/common/helpers/helpers.ts"}},{"kind":"js","name":"createOptionsArray","declaration":{"name":"createOptionsArray","module":"src/common/helpers/helpers.ts"}},{"kind":"js","name":"convertChartDataToCSV","declaration":{"name":"convertChartDataToCSV","module":"src/common/helpers/helpers.ts"}},{"kind":"js","name":"getRandomData","declaration":{"name":"getRandomData","module":"src/common/helpers/helpers.ts"}},{"kind":"js","name":"getTextColor","declaration":{"name":"getTextColor","module":"src/common/helpers/helpers.ts"}},{"kind":"js","name":"convertTreeDataToCSV","declaration":{"name":"convertTreeDataToCSV","module":"src/common/helpers/helpers.ts"}},{"kind":"js","name":"convertTreemapDataToCSV","declaration":{"name":"convertTreemapDataToCSV","module":"src/common/helpers/helpers.ts"}}]},{"kind":"javascript-module","path":"src/common/plugins/htmlLegendPlugin.ts","declarations":[{"kind":"variable","name":"htmlLegendPlugin","type":{"text":"object"},"default":"{\n  id: 'htmlLegend',\n  afterUpdate(chart: Chart, _: any, options: HtmlLegendPluginOptions) {\n    const container = document.getElementById(options.containerId);\n    if (!container) return;\n    renderHTMLLegend(chart, container, options);\n  },\n}"}],"exports":[{"kind":"js","name":"htmlLegendPlugin","declaration":{"name":"htmlLegendPlugin","module":"src/common/plugins/htmlLegendPlugin.ts"}}]},{"kind":"javascript-module","path":"src/common/plugins/sankeyTooltip.ts","declarations":[{"kind":"function","name":"createSankeyTooltipHandler"}],"exports":[{"kind":"js","name":"createSankeyTooltipHandler","declaration":{"name":"createSankeyTooltipHandler","module":"src/common/plugins/sankeyTooltip.ts"}}]},{"kind":"javascript-module","path":"src/components/chart/chart.ts","declarations":[{"kind":"class","description":"Chart.js wrapper component.","name":"KDChart","slots":[{"description":"Slot for custom content between header and chart.","name":"unnamed"},{"description":"Slot for custom controls such as an overflow menu.","name":"controls"},{"description":"Slot for tooltip in header.","name":"tooltip"},{"description":"Slot for widget drag handle.","name":"draghandle"}],"members":[{"kind":"field","name":"chartTitle","type":{"text":"string"},"default":"''","description":"Chart title.","attribute":"chartTitle"},{"kind":"field","name":"description","type":{"text":"string"},"default":"''","description":"Chart description.","attribute":"description"},{"kind":"field","name":"type","type":{"text":"any"},"default":"''","description":"Chart.js chart type.","attribute":"type"},{"kind":"field","name":"labels","type":{"text":"Array<string>"},"description":"Chart.js data.labels.","attribute":"labels"},{"kind":"field","name":"datasets","type":{"text":"Array<any>"},"description":"Chart.js data.datasets.","attribute":"datasets"},{"kind":"field","name":"options","type":{"text":"any"},"default":"{}","description":"Chart.js options. Can override Shidoka defaults.","attribute":"options"},{"kind":"field","name":"plugins","type":{"text":"any"},"default":"[]","description":"Chart.js additional plugins. Must be registerable inline via Chart.plugins array, not globally via Chart.register.","attribute":"plugins"},{"kind":"field","name":"height","type":{"text":"any"},"default":"null","description":"Chart.js canvas height (px). Disables maintainAspectRatio option.","attribute":"height"},{"kind":"field","name":"width","type":{"text":"any"},"default":"null","description":"Chart.js canvas width (px). Disables maintainAspectRatio option.","attribute":"width"},{"kind":"field","name":"hideDescription","type":{"text":"boolean"},"default":"false","description":"Hides the description visually.","attribute":"hideDescription"},{"kind":"field","name":"hideCaptions","type":{"text":"boolean"},"default":"false","description":"Hides the closed captions visually.","attribute":"hideCaptions"},{"kind":"field","name":"hideHeader","type":{"text":"boolean"},"default":"false","description":"Hides the title & description.","attribute":"hideHeader"},{"kind":"field","name":"hideControls","type":{"text":"boolean"},"default":"false","description":"Hides all the controls.","attribute":"hideControls"},{"kind":"field","name":"hideTableControl","type":{"text":"boolean"},"default":"false","description":"Hides the table view control.","attribute":"hideTableControl"},{"kind":"field","name":"hideFullscreenControl","type":{"text":"boolean"},"default":"false","description":"Hides the fullscreen control.","attribute":"hideFullscreenControl"},{"kind":"field","name":"hideDownloadControl","type":{"text":"boolean"},"default":"false","description":"Hides the download control.","attribute":"hideDownloadControl"},{"kind":"field","name":"noBorder","type":{"text":"boolean"},"default":"false","description":"Removes the outer border and padding.","attribute":"noBorder"},{"kind":"field","name":"customLabels","type":{"text":"object"},"default":"{\n    toggleView: 'Toggle View Mode',\n    toggleFullscreen: 'Toggle Fullscreen',\n    downloadMenu: 'Download Menu',\n    downloadCsv: 'Download as CSV',\n    downloadPng: 'Download as PNG',\n    downloadJpg: 'Download as JPG',\n  }","description":"Customizable text labels.","attribute":"customLabels"},{"kind":"field","name":"useHtmlLegend","type":{"text":"boolean"},"default":"false","description":"Use HTML legend instead of Chart.js built-in canvas legend.","privacy":"public","attribute":"useHtmlLegend"},{"kind":"field","name":"htmlLegendMaxHeight","type":{"text":"number"},"default":"100","description":"Max height for HTML legend scroll container (px).","attribute":"htmlLegendMaxHeight","reflects":true},{"kind":"field","name":"htmlLegendOptions","type":{"text":"HtmlLegendOptions"},"default":"{}","description":"Full set of legend customization options","attribute":"htmlLegendOptions"},{"kind":"method","name":"_resizeChart","privacy":"private"},{"kind":"method","name":"generateScrollableLegend","privacy":"private","return":{"type":{"text":"void"}}},{"kind":"method","name":"initChart","privacy":"private","description":"Initializes a bar chart using the Chart.js library with provided labels, datasets,\nand options."},{"kind":"method","name":"mergeOptions","privacy":"private","description":"Merges various chart type options and dataset options to create a\nfinal set of options for a chart."},{"kind":"method","name":"getTableAxisLabel","privacy":"private"},{"kind":"method","name":"handleViewToggle","privacy":"private"},{"kind":"method","name":"checkType","privacy":"private"},{"kind":"method","name":"handleDownloadImage","privacy":"private","parameters":[{"name":"e","type":{"text":"Event"}},{"name":"jpeg","type":{"text":"boolean"}}]},{"kind":"method","name":"exportCanvasOnly","privacy":"private","parameters":[{"name":"imgFormat","type":{"text":"string"}},{"name":"fileExt","type":{"text":"string"}}]},{"kind":"method","name":"exportSimpleCanvasOnly","privacy":"private","parameters":[{"name":"imgFormat","type":{"text":"string"}},{"name":"fileExt","type":{"text":"string"}}]},{"kind":"method","name":"handleDownloadCsv","privacy":"private","parameters":[{"name":"e","type":{"text":"Event"}}]},{"kind":"method","name":"handleFullscreen","privacy":"private"},{"kind":"method","name":"handleFullscreenChange","privacy":"private"}],"events":[{"name":"on-click","type":{"text":"CustomEvent"}}],"attributes":[{"name":"chartTitle","type":{"text":"string"},"default":"''","description":"Chart title.","fieldName":"chartTitle"},{"name":"description","type":{"text":"string"},"default":"''","description":"Chart description.","fieldName":"description"},{"name":"type","type":{"text":"any"},"default":"''","description":"Chart.js chart type.","fieldName":"type"},{"name":"labels","type":{"text":"Array<string>"},"description":"Chart.js data.labels.","fieldName":"labels"},{"name":"datasets","type":{"text":"Array<any>"},"description":"Chart.js data.datasets.","fieldName":"datasets"},{"name":"options","type":{"text":"any"},"default":"{}","description":"Chart.js options. Can override Shidoka defaults.","fieldName":"options"},{"name":"plugins","type":{"text":"any"},"default":"[]","description":"Chart.js additional plugins. Must be registerable inline via Chart.plugins array, not globally via Chart.register.","fieldName":"plugins"},{"name":"height","type":{"text":"any"},"default":"null","description":"Chart.js canvas height (px). Disables maintainAspectRatio option.","fieldName":"height"},{"name":"width","type":{"text":"any"},"default":"null","description":"Chart.js canvas width (px). Disables maintainAspectRatio option.","fieldName":"width"},{"name":"hideDescription","type":{"text":"boolean"},"default":"false","description":"Hides the description visually.","fieldName":"hideDescription"},{"name":"hideCaptions","type":{"text":"boolean"},"default":"false","description":"Hides the closed captions visually.","fieldName":"hideCaptions"},{"name":"hideHeader","type":{"text":"boolean"},"default":"false","description":"Hides the title & description.","fieldName":"hideHeader"},{"name":"hideControls","type":{"text":"boolean"},"default":"false","description":"Hides all the controls.","fieldName":"hideControls"},{"name":"hideTableControl","type":{"text":"boolean"},"default":"false","description":"Hides the table view control.","fieldName":"hideTableControl"},{"name":"hideFullscreenControl","type":{"text":"boolean"},"default":"false","description":"Hides the fullscreen control.","fieldName":"hideFullscreenControl"},{"name":"hideDownloadControl","type":{"text":"boolean"},"default":"false","description":"Hides the download control.","fieldName":"hideDownloadControl"},{"name":"noBorder","type":{"text":"boolean"},"default":"false","description":"Removes the outer border and padding.","fieldName":"noBorder"},{"name":"customLabels","type":{"text":"object"},"default":"{\n    toggleView: 'Toggle View Mode',\n    toggleFullscreen: 'Toggle Fullscreen',\n    downloadMenu: 'Download Menu',\n    downloadCsv: 'Download as CSV',\n    downloadPng: 'Download as PNG',\n    downloadJpg: 'Download as JPG',\n  }","description":"Customizable text labels.","fieldName":"customLabels"},{"name":"useHtmlLegend","type":{"text":"boolean"},"default":"false","description":"Use HTML legend instead of Chart.js built-in canvas legend.","fieldName":"useHtmlLegend"},{"name":"htmlLegendMaxHeight","type":{"text":"number"},"default":"100","description":"Max height for HTML legend scroll container (px).","fieldName":"htmlLegendMaxHeight"},{"name":"htmlLegendOptions","type":{"text":"HtmlLegendOptions"},"default":"{}","description":"Full set of legend customization options","fieldName":"htmlLegendOptions"}],"superclass":{"name":"LitElement","package":"lit"},"tagName":"kd-chart","customElement":true}],"exports":[{"kind":"js","name":"KDChart","declaration":{"name":"KDChart","module":"src/components/chart/chart.ts"}},{"kind":"custom-element-definition","name":"kd-chart","declaration":{"name":"KDChart","module":"src/components/chart/chart.ts"}}]},{"kind":"javascript-module","path":"src/components/chart/index.ts","declarations":[],"exports":[{"kind":"js","name":"KDChart","declaration":{"name":"KDChart","module":"./chart"}}]},{"kind":"javascript-module","path":"src/components/mermaid/index.ts","declarations":[],"exports":[{"kind":"js","name":"MermaidDiagram","declaration":{"name":"MermaidDiagram","module":"./mermaid"}}]},{"kind":"javascript-module","path":"src/components/mermaid/mermaid.ts","declarations":[{"kind":"class","description":"[Mermaid.js](https://mermaid.js.org) diagram wrapper component.\nIncludes a dark/light responsive theme out of the box with fully extensible mermaid.js configuration.","name":"MermaidDiagram","members":[{"kind":"field","name":"diagramSyntax","default":"``","description":"Mermaid configuration object.","attribute":"diagramSyntax"},{"kind":"field","name":"mermaidConfig","type":{"text":"object"},"default":"{}","description":"Mermaid configuration object.","attribute":"mermaidConfig"},{"kind":"method","name":"createRenderRoot"},{"kind":"method","name":"_handleSlotChange","privacy":"private"},{"kind":"method","name":"_getThemeVariables","privacy":"private","return":{"type":{"text":"Record<\n    string,\n    string | Record<string, string>\n  >"}},"description":"Build mermaid themeVariables from the active Shidoka design tokens.\nUses `theme: 'base'` so every variable is respected.\nAny token that fails to resolve is omitted so mermaid uses its own default."},{"kind":"method","name":"_renderDiagram","privacy":"private"}],"attributes":[{"name":"diagramSyntax","default":"``","description":"Mermaid configuration object.","fieldName":"diagramSyntax"},{"name":"mermaidConfig","type":{"text":"object"},"default":"{}","description":"Mermaid configuration object.","fieldName":"mermaidConfig"}],"superclass":{"name":"LitElement","package":"lit"},"tagName":"kyn-mermaid","customElement":true}],"exports":[{"kind":"js","name":"MermaidDiagram","declaration":{"name":"MermaidDiagram","module":"src/components/mermaid/mermaid.ts"}},{"kind":"custom-element-definition","name":"kyn-mermaid","declaration":{"name":"MermaidDiagram","module":"src/components/mermaid/mermaid.ts"}}]}]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kyndryl-design-system/shidoka-charts",
-  "version": "2.10.0",
+  "version": "2.10.2",
   "description": "Shidoka Charts",
   "license": "MIT",
   "main": "index.js",
@@ -76,7 +76,7 @@
     "husky": "^8.0.3",
     "lint-staged": "^13.1.2",
     "lit-analyzer": "^2.0.3",
-    "playwright": "^1.58.2",
+    "playwright": "^1.60.0",
     "postcss": "^8.4.21",
     "prettier": "^2.8.2",
     "react": "^18.2.0",