@cloudscape-design/chart-components 1.0.0

package/internal/api-docs/components/pie-chart.js

@@ -0,0 +1,430 @@
+module.exports = {
+  "name": "PieChart",
+  "dashCaseName": "pie-chart",
+  "releaseStatus": "stable",
+  "regions": [
+    {
+      "name": "fallback",
+      "description": "Custom content that renders when `highcharts=null`. It renders a spinner if not defined.",
+      "isDefault": false
+    }
+  ],
+  "functions": [
+    {
+      "name": "setVisibleSegments",
+      "description": "Controls segments visibility and works with both controlled and uncontrolled visibility modes.",
+      "returnType": "void",
+      "parameters": [
+        {
+          "name": "visibleSegments",
+          "type": "ReadonlyArray<string>"
+        }
+      ]
+    },
+    {
+      "name": "showAllSegments",
+      "description": "Functions similarly to `setVisibleSeries`, but applies to all series and doesn't require series IDs as input.\nUse this when implementing clear-filter actions in no-match states.",
+      "returnType": "void",
+      "parameters": []
+    }
+  ],
+  "properties": [
+    {
+      "name": "ariaDescription",
+      "type": "string",
+      "optional": true,
+      "description": "Defines the ARIA description of the chart container.\nThis property corresponds to [accessibility.description](https://api.highcharts.com/highcharts/accessibility.description),\nand requires the [accessibility module](https://www.highcharts.com/docs/accessibility/accessibility-module)."
+    },
+    {
+      "name": "ariaLabel",
+      "type": "string",
+      "optional": true,
+      "description": "Defines the ARIA label for the chart container.\nThis property corresponds to [lang.chartContainerLabel](https://api.highcharts.com/highcharts/lang.accessibility.chartContainerLabel),\nand requires the [accessibility module](https://www.highcharts.com/docs/accessibility/accessibility-module)."
+    },
+    {
+      "name": "chartHeight",
+      "type": "number",
+      "optional": true,
+      "description": "The height of the chart plot in pixels. It does not include legend and filter."
+    },
+    {
+      "name": "chartMinHeight",
+      "type": "number",
+      "optional": true,
+      "description": "Defines the minimum allowed height of the chart plot. Use this when `fitHeight=true` to\nprevent the chart plot from becoming too small to display its content. When the parent\ncontainer is shorter than the minimum height, a vertical scrollbar appears automatically."
+    },
+    {
+      "name": "chartMinWidth",
+      "type": "number",
+      "optional": true,
+      "description": "Defines the minimum allowed width of the chart plot. When the parent container is narrower than the\nminimum width, the horizontal scrollbar is automatically added."
+    },
+    {
+      "name": "filter",
+      "type": "BaseFilterOptions",
+      "inlineType": {
+        "name": "BaseFilterOptions",
+        "type": "object",
+        "properties": [
+          {
+            "name": "additionalFilters",
+            "optional": true,
+            "type": "React.ReactNode"
+          },
+          {
+            "name": "seriesFilter",
+            "optional": true,
+            "type": "boolean"
+          }
+        ]
+      },
+      "optional": true,
+      "description": "Defines options for filtering in the chart, including:\n* `seriesFilter` (optional, boolean) - Displays default series filter at the top of the chart.\n* `additionalFilters` (optional, slot) - A slot for custom chart filters at the top of the chart."
+    },
+    {
+      "name": "fitHeight",
+      "type": "boolean",
+      "optional": true,
+      "description": "The chart automatically adjusts its height to fill the parent container when this property is set.",
+      "defaultValue": "false"
+    },
+    {
+      "name": "highcharts",
+      "type": "object | null",
+      "optional": false,
+      "description": "The Highcharts instance, which can be obtained using `import Highcharts from \"highcharts\"`.\nSupported Highcharts versions: 12."
+    },
+    {
+      "name": "i18nStrings",
+      "type": "PieI18nStrings",
+      "inlineType": {
+        "name": "PieI18nStrings",
+        "type": "object",
+        "properties": [
+          {
+            "name": "chartRoleDescription",
+            "optional": true,
+            "type": "string"
+          },
+          {
+            "name": "detailPopoverDismissAriaLabel",
+            "optional": true,
+            "type": "string"
+          },
+          {
+            "name": "errorText",
+            "optional": true,
+            "type": "string"
+          },
+          {
+            "name": "legendAriaLabel",
+            "optional": true,
+            "type": "string"
+          },
+          {
+            "name": "loadingText",
+            "optional": true,
+            "type": "string"
+          },
+          {
+            "name": "recoveryText",
+            "optional": true,
+            "type": "string"
+          },
+          {
+            "name": "segmentRoleDescription",
+            "optional": true,
+            "type": "string"
+          },
+          {
+            "name": "seriesFilterLabel",
+            "optional": true,
+            "type": "string"
+          },
+          {
+            "name": "seriesFilterPlaceholder",
+            "optional": true,
+            "type": "string"
+          },
+          {
+            "name": "seriesFilterSelectedAriaLabel",
+            "optional": true,
+            "type": "string"
+          }
+        ]
+      },
+      "optional": true,
+      "description": "An object that contains all of the localized strings required by the component.",
+      "i18nTag": true
+    },
+    {
+      "name": "innerAreaDescription",
+      "type": "string",
+      "optional": true,
+      "description": "Description text displayed in the donut chart's inner area."
+    },
+    {
+      "name": "innerAreaTitle",
+      "type": "string",
+      "optional": true,
+      "description": "Title displayed in the donut chart's inner area."
+    },
+    {
+      "name": "legend",
+      "type": "BaseLegendOptions",
+      "inlineType": {
+        "name": "BaseLegendOptions",
+        "type": "object",
+        "properties": [
+          {
+            "name": "actions",
+            "optional": true,
+            "type": "React.ReactNode"
+          },
+          {
+            "name": "enabled",
+            "optional": true,
+            "type": "boolean"
+          },
+          {
+            "name": "title",
+            "optional": true,
+            "type": "string"
+          }
+        ]
+      },
+      "optional": true,
+      "description": "Defines chart legend options, including:\n* `enabled` (optional, boolean) - Hides legend when set to `false`.\n* `title` (optional, string) - Visible label, shown above the legend.\n* `actions` (optional, slot) - A slot before the legend that can be used to render custom actions."
+    },
+    {
+      "name": "noData",
+      "type": "BaseNoDataOptions",
+      "inlineType": {
+        "name": "BaseNoDataOptions",
+        "type": "object",
+        "properties": [
+          {
+            "name": "empty",
+            "optional": true,
+            "type": "React.ReactNode"
+          },
+          {
+            "name": "error",
+            "optional": true,
+            "type": "React.ReactNode"
+          },
+          {
+            "name": "loading",
+            "optional": true,
+            "type": "React.ReactNode"
+          },
+          {
+            "name": "noMatch",
+            "optional": true,
+            "type": "React.ReactNode"
+          },
+          {
+            "name": "onRecoveryClick",
+            "optional": true,
+            "type": "NonCancelableEventHandler<{}>",
+            "inlineType": {
+              "name": "NonCancelableEventHandler<{}>",
+              "type": "function",
+              "returnType": "void",
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": "NonCancelableCustomEvent<Detail>"
+                }
+              ]
+            }
+          },
+          {
+            "name": "statusType",
+            "optional": true,
+            "type": "string",
+            "inlineType": {
+              "name": "\"finished\" | \"loading\" | \"error\"",
+              "type": "union",
+              "values": [
+                "finished",
+                "loading",
+                "error"
+              ]
+            }
+          }
+        ]
+      },
+      "optional": true,
+      "description": "Defines options to represent empty, no-match, loading, and error state of the chart, including:\n* `statusType` (optional, \"finished\" | \"loading\" | \"error\") - Specifies the current status of loading data.\n* `empty` (optional, ReactNode) - Content displayed when the chart data is empty.\n* `noMatch` (optional, ReactNode) - Content displayed when there is no data to display due to the built-in filtering.\n* `loading` (optional, ReactNode) - Content displayed when `statusType=\"loading\"`. If omitted, the default loading state\nis shown, using `i18n.loadingText` or built-in i18n.\n* `error` (optional, ReactNode) - Content displayed when `statusType=\"error\"`. If omitted, the default error state\nis shown, using `i18n.errorText` and `i18n.recoveryText` (when `onRecoveryClick` is provided), or built-in i18n.\n* `onRecoveryClick` (optional, function) - Called when the user clicks the recovery button that appears when using default error\nstate, and only if `onRecoveryClick` is provided. Use this to enable the user to retry a failed request or provide another option\nfor the user to recover from the error."
+    },
+    {
+      "name": "segmentDescription",
+      "type": "((props: PieChartProps.SegmentDescriptionRenderProps) => string)",
+      "inlineType": {
+        "name": "(props: PieChartProps.SegmentDescriptionRenderProps) => string",
+        "type": "function",
+        "returnType": "string",
+        "parameters": [
+          {
+            "name": "props",
+            "type": "PieChartProps.SegmentDescriptionRenderProps"
+          }
+        ]
+      },
+      "optional": true,
+      "description": "A function determining the segment description displayed on the chart below the segment title."
+    },
+    {
+      "name": "segmentTitle",
+      "type": "((props: PieChartProps.SegmentDescriptionRenderProps) => string)",
+      "inlineType": {
+        "name": "(props: PieChartProps.SegmentDescriptionRenderProps) => string",
+        "type": "function",
+        "returnType": "string",
+        "parameters": [
+          {
+            "name": "props",
+            "type": "PieChartProps.SegmentDescriptionRenderProps"
+          }
+        ]
+      },
+      "optional": true,
+      "description": "A function that determines the title of a segment displayed on the chart. The title appears above the segment\ndescription defined by `segmentDescription`. By default, it displays the segment name. You can hide the title\nby returning an empty string from the function."
+    },
+    {
+      "name": "series",
+      "type": "PieChartProps.SeriesOptions",
+      "inlineType": {
+        "name": "PieChartProps.SeriesOptions",
+        "type": "union",
+        "values": [
+          "PieSeriesOptions",
+          "DonutSeriesOptions"
+        ]
+      },
+      "optional": false,
+      "description": "Defines series options of the chart.\nThis property corresponds to [series](https://api.highcharts.com/highcharts/series), and extends it\nwith an additional \"donut\" series type.\n\nSupported series types:\n* [pie](https://api.highcharts.com/highcharts/series.pie).\n* donut - the pie series with predefined inner radius."
+    },
+    {
+      "name": "tooltip",
+      "type": "PieChartProps.TooltipOptions",
+      "inlineType": {
+        "name": "PieChartProps.TooltipOptions",
+        "type": "object",
+        "properties": [
+          {
+            "name": "body",
+            "optional": true,
+            "type": "((props: TooltipSlotRenderProps) => React.ReactNode)",
+            "inlineType": {
+              "name": "(props: TooltipSlotRenderProps) => React.ReactNode",
+              "type": "function",
+              "returnType": "React.ReactNode",
+              "parameters": [
+                {
+                  "name": "props",
+                  "type": "TooltipSlotRenderProps"
+                }
+              ]
+            }
+          },
+          {
+            "name": "details",
+            "optional": true,
+            "type": "((props: TooltipSlotRenderProps) => ReadonlyArray<BaseTooltipDetail>)",
+            "inlineType": {
+              "name": "(props: TooltipSlotRenderProps) => ReadonlyArray<BaseTooltipDetail>",
+              "type": "function",
+              "returnType": "ReadonlyArray<BaseTooltipDetail>",
+              "parameters": [
+                {
+                  "name": "props",
+                  "type": "TooltipSlotRenderProps"
+                }
+              ]
+            }
+          },
+          {
+            "name": "enabled",
+            "optional": true,
+            "type": "boolean"
+          },
+          {
+            "name": "footer",
+            "optional": true,
+            "type": "((props: TooltipSlotRenderProps) => React.ReactNode)",
+            "inlineType": {
+              "name": "(props: TooltipSlotRenderProps) => React.ReactNode",
+              "type": "function",
+              "returnType": "React.ReactNode",
+              "parameters": [
+                {
+                  "name": "props",
+                  "type": "TooltipSlotRenderProps"
+                }
+              ]
+            }
+          },
+          {
+            "name": "header",
+            "optional": true,
+            "type": "((props: TooltipSlotRenderProps) => React.ReactNode)",
+            "inlineType": {
+              "name": "(props: TooltipSlotRenderProps) => React.ReactNode",
+              "type": "function",
+              "returnType": "React.ReactNode",
+              "parameters": [
+                {
+                  "name": "props",
+                  "type": "TooltipSlotRenderProps"
+                }
+              ]
+            }
+          },
+          {
+            "name": "size",
+            "optional": true,
+            "type": "string",
+            "inlineType": {
+              "name": "\"small\" | \"medium\" | \"large\"",
+              "type": "union",
+              "values": [
+                "small",
+                "medium",
+                "large"
+              ]
+            }
+          }
+        ]
+      },
+      "optional": true,
+      "description": "Defines tooltip options of the chart, including:\n* `enabled` - (optional, boolean) - Hides the tooltip when set to false.\n* `size` - (optional, \"small\" | \"medium\" | \"large\") - Specifies max tooltip size.\n* `details` - (optional, function) - Provides a list of key-value pairs as tooltip's body.\n* `header` - (optional, function) - Renders a custom tooltip header.\n* `body` - (optional, function) - Renders a custom tooltip body.\n* `footer` - (optional, function) - Renders a custom tooltip footer."
+    },
+    {
+      "name": "visibleSegments",
+      "type": "ReadonlyArray<string>",
+      "optional": true,
+      "description": "Specifies which segments to show using their IDs. By default, all segments are visible and managed by the component.\nIf a segment doesn't have an ID, its name is used. When using this property, manage state updates with `onVisibleSegmentsChange`."
+    }
+  ],
+  "events": [
+    {
+      "name": "onVisibleSegmentsChange",
+      "description": "A callback function, triggered when segments visibility changes as a result of user interaction with the legend or filter.",
+      "cancelable": false,
+      "detailType": "{ visibleSegments: Array<string>; }",
+      "detailInlineType": {
+        "name": "{ visibleSegments: Array<string>; }",
+        "type": "object",
+        "properties": [
+          {
+            "name": "visibleSegments",
+            "optional": false,
+            "type": "Array<string>"
+          }
+        ]
+      }
+    }
+  ]
+};