@cloudscape-design/chart-components 1.0.114 → 1.0.116

package/internal/manifest.json

@@ -1,3 +1,3 @@
 {
-  "commit": "b7905d65e92618850157c312644dfa6521eb293a"
+  "commit": "53bc6e7659cc87d4218d10602194c0a821f39722"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudscape-design/chart-components",
-  "version": "1.0.114",
+  "version": "1.0.116",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/cloudscape-design/chart-components.git"

package/pie-chart/interfaces.d.ts

@@ -1,5 +1,5 @@
 import * as CoreTypes from "../core/interfaces";
-import { NonCancelableEventHandler } from "../internal/events";
+import { NonCancelableEventHandler } from "../types/events";
 export interface PieChartProps extends CoreTypes.BaseChartOptions, CoreTypes.WithPieI18nStrings {
     /**
      * Defines series options of the chart.

package/pie-chart/interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/pie-chart/interfaces.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC","sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\n\nimport * as CoreTypes from \"../core/interfaces\";\nimport { NonCancelableEventHandler } from \"../internal/events\";\n\n// PieChartProps is the type for PieChart React component properties. Unlike in Highcharts API,\n// we pass options directly to the component, instead of grouping them all into a single \"options\" property.\n// We do still organize related options in groups, e.g.: \"SeriesOptions\", \"TooltipOptions\".\nexport interface PieChartProps extends CoreTypes.BaseChartOptions, CoreTypes.WithPieI18nStrings {\n  /**\n   * Defines series options of the chart.\n   * This property corresponds to [series](https://api.highcharts.com/highcharts/series), and extends it\n   * with an additional \"donut\" series type.\n   *\n   * Supported series types:\n   * * [pie](https://api.highcharts.com/highcharts/series.pie).\n   * * donut - the pie series with predefined inner radius.\n   */\n  series: null | PieChartProps.SeriesOptions;\n\n  /**\n   * 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.\n   */\n  tooltip?: PieChartProps.TooltipOptions;\n\n  /**\n   * Specifies which segments to show using their IDs. By default, all segments are visible and managed by the component.\n   * If a segment doesn't have an ID, its name is used. When using this property, manage state updates with `onVisibleSegmentsChange`.\n   */\n  visibleSegments?: readonly string[];\n\n  /**\n   * A callback function, triggered when segments visibility changes as a result of user interaction with the legend or filter.\n   */\n  onVisibleSegmentsChange?: NonCancelableEventHandler<{ visibleSegments: string[] }>;\n\n  /**\n   * A function that determines the title of a segment displayed on the chart. The title appears above the segment\n   * description defined by `segmentDescription`. By default, it displays the segment name. You can hide the title\n   * by returning an empty string from the function.\n   */\n  segmentTitle?: (props: PieChartProps.SegmentTitleRenderProps) => string;\n\n  /**\n   * A function determining the segment description displayed on the chart below the segment title.\n   */\n  segmentDescription?: (props: PieChartProps.SegmentDescriptionRenderProps) => string;\n\n  /**\n   * Title displayed in the donut chart's inner area.\n   */\n  innerAreaTitle?: string;\n\n  /**\n   * Description text displayed in the donut chart's inner area.\n   */\n  innerAreaDescription?: string;\n}\n\nexport namespace PieChartProps {\n  export interface Ref {\n    /**\n     * Controls segments visibility and works with both controlled and uncontrolled visibility modes.\n     */\n    setVisibleSegments(visibleSegments: readonly string[]): void;\n    /**\n     * Functions similarly to `setVisibleSeries`, but applies to all series and doesn't require series IDs as input.\n     * Use this when implementing clear-filter actions in no-match states.\n     */\n    showAllSegments(): void;\n  }\n\n  export type SeriesOptions = PieSeriesOptions | DonutSeriesOptions;\n\n  export type PieSeriesOptions = CoreTypes.PieSeriesOptions;\n\n  export type DonutSeriesOptions = CoreTypes.DonutSeriesOptions;\n\n  export type PieSegmentOptions = CoreTypes.PieSegmentOptions;\n\n  export interface TooltipOptions {\n    enabled?: boolean;\n    size?: \"small\" | \"medium\" | \"large\";\n    details?: (props: TooltipDetailsRenderProps) => readonly TooltipDetail[];\n    header?: (props: TooltipHeaderRenderProps) => React.ReactNode;\n    body?: (props: TooltipBodyRenderProps) => React.ReactNode;\n    footer?: (props: TooltipFooterRenderProps) => React.ReactNode;\n  }\n\n  export type TooltipDetailsRenderProps = TooltipSlotRenderProps;\n  export type TooltipHeaderRenderProps = TooltipSlotRenderProps;\n  export type TooltipBodyRenderProps = TooltipSlotRenderProps;\n  export type TooltipFooterRenderProps = TooltipSlotRenderProps;\n  interface TooltipSlotRenderProps {\n    segmentId?: string;\n    segmentName: string;\n    segmentValue: number;\n    totalValue: number;\n  }\n\n  export type TooltipDetail = CoreTypes.BaseTooltipDetail;\n\n  export type SegmentTitleRenderProps = SegmentDescriptionRenderProps;\n  export interface SegmentDescriptionRenderProps {\n    segmentId?: string;\n    segmentName: string;\n    segmentValue: number;\n    totalValue: number;\n  }\n\n  export type LegendOptions = CoreTypes.BaseLegendOptions;\n\n  export type FilterOptions = CoreTypes.BaseFilterOptions;\n\n  export type NoDataOptions = CoreTypes.BaseNoDataOptions;\n}\n"]}
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/pie-chart/interfaces.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC","sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\n\nimport * as CoreTypes from \"../core/interfaces\";\nimport { NonCancelableEventHandler } from \"../types/events\";\n\n// PieChartProps is the type for PieChart React component properties. Unlike in Highcharts API,\n// we pass options directly to the component, instead of grouping them all into a single \"options\" property.\n// We do still organize related options in groups, e.g.: \"SeriesOptions\", \"TooltipOptions\".\nexport interface PieChartProps extends CoreTypes.BaseChartOptions, CoreTypes.WithPieI18nStrings {\n  /**\n   * Defines series options of the chart.\n   * This property corresponds to [series](https://api.highcharts.com/highcharts/series), and extends it\n   * with an additional \"donut\" series type.\n   *\n   * Supported series types:\n   * * [pie](https://api.highcharts.com/highcharts/series.pie).\n   * * donut - the pie series with predefined inner radius.\n   */\n  series: null | PieChartProps.SeriesOptions;\n\n  /**\n   * 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.\n   */\n  tooltip?: PieChartProps.TooltipOptions;\n\n  /**\n   * Specifies which segments to show using their IDs. By default, all segments are visible and managed by the component.\n   * If a segment doesn't have an ID, its name is used. When using this property, manage state updates with `onVisibleSegmentsChange`.\n   */\n  visibleSegments?: readonly string[];\n\n  /**\n   * A callback function, triggered when segments visibility changes as a result of user interaction with the legend or filter.\n   */\n  onVisibleSegmentsChange?: NonCancelableEventHandler<{ visibleSegments: string[] }>;\n\n  /**\n   * A function that determines the title of a segment displayed on the chart. The title appears above the segment\n   * description defined by `segmentDescription`. By default, it displays the segment name. You can hide the title\n   * by returning an empty string from the function.\n   */\n  segmentTitle?: (props: PieChartProps.SegmentTitleRenderProps) => string;\n\n  /**\n   * A function determining the segment description displayed on the chart below the segment title.\n   */\n  segmentDescription?: (props: PieChartProps.SegmentDescriptionRenderProps) => string;\n\n  /**\n   * Title displayed in the donut chart's inner area.\n   */\n  innerAreaTitle?: string;\n\n  /**\n   * Description text displayed in the donut chart's inner area.\n   */\n  innerAreaDescription?: string;\n}\n\nexport namespace PieChartProps {\n  export interface Ref {\n    /**\n     * Controls segments visibility and works with both controlled and uncontrolled visibility modes.\n     */\n    setVisibleSegments(visibleSegments: readonly string[]): void;\n    /**\n     * Functions similarly to `setVisibleSeries`, but applies to all series and doesn't require series IDs as input.\n     * Use this when implementing clear-filter actions in no-match states.\n     */\n    showAllSegments(): void;\n  }\n\n  export type SeriesOptions = PieSeriesOptions | DonutSeriesOptions;\n\n  export type PieSeriesOptions = CoreTypes.PieSeriesOptions;\n\n  export type DonutSeriesOptions = CoreTypes.DonutSeriesOptions;\n\n  export type PieSegmentOptions = CoreTypes.PieSegmentOptions;\n\n  export interface TooltipOptions {\n    enabled?: boolean;\n    size?: \"small\" | \"medium\" | \"large\";\n    details?: (props: TooltipDetailsRenderProps) => readonly TooltipDetail[];\n    header?: (props: TooltipHeaderRenderProps) => React.ReactNode;\n    body?: (props: TooltipBodyRenderProps) => React.ReactNode;\n    footer?: (props: TooltipFooterRenderProps) => React.ReactNode;\n  }\n\n  export type TooltipDetailsRenderProps = TooltipSlotRenderProps;\n  export type TooltipHeaderRenderProps = TooltipSlotRenderProps;\n  export type TooltipBodyRenderProps = TooltipSlotRenderProps;\n  export type TooltipFooterRenderProps = TooltipSlotRenderProps;\n  interface TooltipSlotRenderProps {\n    segmentId?: string;\n    segmentName: string;\n    segmentValue: number;\n    totalValue: number;\n  }\n\n  export type TooltipDetail = CoreTypes.BaseTooltipDetail;\n\n  export type SegmentTitleRenderProps = SegmentDescriptionRenderProps;\n  export interface SegmentDescriptionRenderProps {\n    segmentId?: string;\n    segmentName: string;\n    segmentValue: number;\n    totalValue: number;\n  }\n\n  export type LegendOptions = CoreTypes.BaseLegendOptions;\n\n  export type FilterOptions = CoreTypes.BaseFilterOptions;\n\n  export type NoDataOptions = CoreTypes.BaseNoDataOptions;\n}\n"]}

package/types/events.d.ts

@@ -0,0 +1,2 @@
+export type NonCancelableCustomEvent<DetailType> = Omit<CustomEvent<DetailType>, "preventDefault">;
+export type NonCancelableEventHandler<Detail = {}> = (event: NonCancelableCustomEvent<Detail>) => void;

package/types/events.js

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export {};
+//# sourceMappingURL=events.js.map

package/types/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/types/events.ts"],"names":[],"mappings":"AAAA,qEAAqE;AACrE,sCAAsC","sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\n\nexport type NonCancelableCustomEvent<DetailType> = Omit<CustomEvent<DetailType>, \"preventDefault\">;\n\n// eslint-disable-next-line @typescript-eslint/no-empty-object-type\nexport type NonCancelableEventHandler<Detail = {}> = (event: NonCancelableCustomEvent<Detail>) => void;\n"]}