@limetech/lime-elements 40.20.1 → 40.21.0

package/dist/types/components/chart/chart.d.ts

@@ -6,7 +6,7 @@ import { ChartItem, ChartType } from './chart.types';
  * visual symbols such as such bars, dots, lines, or slices, represent
  * each data point, in comparison to others.
  *
- * @exampleComponent limel-example-chart-stacked-bar
+ * @exampleComponent limel-example-chart-type-proportion-bar
  * @exampleComponent limel-example-chart-orientation
  * @exampleComponent limel-example-chart-max-value
  * @exampleComponent limel-example-chart-display-item-percentage
@@ -77,7 +77,7 @@ export declare class Chart {
      * Set to `false` to hide the percentage in item tooltips.
      * The percentage is an item's value or range extent as a share of the
      * whole. The whole is `maxValue` when set and the combined items otherwise.
-     * Applies to `stacked-bar`, `pie`, `doughnut`, and `ring` charts.
+     * Applies to `proportion-bar`, `pie`, `doughnut`, and `ring` charts.
      */
     displayItemPercentage: boolean;
     /**
@@ -87,6 +87,8 @@ export declare class Chart {
     items: ChartItem[];
     /**
      * Defines how items are visualized in the chart.
+     * `stacked-bar` is the old name of `proportion-bar`. It still works, but
+     * logs a warning.
      */
     type?: ChartType;
     /**
@@ -96,7 +98,7 @@ export declare class Chart {
     orientation?: 'landscape' | 'portrait';
     /**
      * Sets the value used to scale item values.
-     * For `stacked-bar`, `pie`, `doughnut`, and `ring`, it is the denominator
+     * For `proportion-bar`, `pie`, `doughnut`, and `ring`, it is the denominator
      * used as the whole. It defaults to the combined item values or range
      * extents. The combined size can exceed `maxValue` and produce a total
      * above 100%.
@@ -143,6 +145,8 @@ export declare class Chart {
     componentDidRender(): void;
     disconnectedCallback(): void;
     protected warnAboutAxisIncrement(): void;
+    protected warnAboutOldTypeName(): void;
+    private get chartType();
     private getAxisIncrementWarning;
     render(): any;
     private renderCaption;

package/dist/types/components/chart/chart.types.d.ts

@@ -1,9 +1,12 @@
 import { Color } from '../../global/shared-types/color.types';
 /**
  * The kinds of chart that `limel-chart` can draw.
+ *
+ * `stacked-bar` is the old name of `proportion-bar`. It still works, but
+ * logs a warning.
  * @beta
  */
-export type ChartType = 'area' | 'bar' | 'doughnut' | 'line' | 'nps' | 'pie' | 'ring' | 'dot' | 'scatter' | 'stacked-bar';
+export type ChartType = 'area' | 'bar' | 'doughnut' | 'line' | 'nps' | 'pie' | 'ring' | 'dot' | 'scatter' | 'proportion-bar' | 'stacked-bar';
 /**
  * Chart component props.
  * @beta

package/dist/types/components/chart/options.d.ts

@@ -1,7 +1,8 @@
 import type { BarSeriesOption, GaugeSeriesOption, LineSeriesOption, PieSeriesOption, ScatterSeriesOption } from 'echarts/charts';
 import type { GridComponentOption, PolarComponentOption, TooltipComponentOption } from 'echarts/components';
 import { type ComposeOption } from 'echarts/core';
-import { ChartItem, ChartType } from './chart.types';
+import { ChartItem } from './chart.types';
+import { DrawnChartType } from './scale';
 import { ChartTheme } from './theme';
 type SeriesOption = BarSeriesOption | GaugeSeriesOption | LineSeriesOption | PieSeriesOption | ScatterSeriesOption;
 export type ChartOption = ComposeOption<SeriesOption | GridComponentOption | PolarComponentOption | TooltipComponentOption>;
@@ -11,7 +12,7 @@ export type ChartOption = ComposeOption<SeriesOption | GridComponentOption | Pol
 export interface ChartSettings {
     /** The items, each with its color resolved by the theme. */
     items: ChartItem[];
-    type: ChartType;
+    type: DrawnChartType;
     orientation: 'landscape' | 'portrait';
     maxValue?: number;
     axisIncrement?: number;
@@ -31,7 +32,7 @@ export interface ChartDrawing {
     option: ChartOption;
     /** The series that draws the items, when they are not series of their own. */
     seriesIndex: number;
-    /** Whether every item is a series of its own, as in a stacked bar. */
+    /** Whether every item is a series of its own, as in a proportion bar. */
     itemsAreSeries: boolean;
     /** The axis that shows the texts of the items, when they are shown on one. */
     itemTextAxis?: 'xAxis' | 'yAxis';

package/dist/types/components/chart/scale.d.ts

@@ -3,6 +3,11 @@ import { ChartItem, ChartType } from './chart.types';
  * The most steps that an `axisIncrement` may divide a value axis into.
  */
 export declare const MAX_AXIS_STEPS = 100;
+/**
+ * The chart types that are drawn. `stacked-bar` is only an old name, which
+ * `limel-chart` turns into `proportion-bar` before drawing.
+ */
+export type DrawnChartType = Exclude<ChartType, 'stacked-bar'>;
 export interface AxisRange {
     minValue: number;
     maxValue: number;
@@ -14,13 +19,13 @@ export interface AxisRange {
  * Whether the items of a chart of this type are parts of one whole.
  * @param type - the chart type
  */
-export declare function isPartOfWhole(type: ChartType): boolean;
+export declare function isPartOfWhole(type: DrawnChartType): boolean;
 /**
  * Whether a chart of this type draws its value axis in steps of
  * `axisIncrement`.
  * @param type - the chart type
  */
-export declare function usesAxisIncrement(type: ChartType): boolean;
+export declare function usesAxisIncrement(type: DrawnChartType): boolean;
 /**
  * Whether the item has a `[start, end]` range, or an `[x, y]` point in a
  * `scatter` chart, as its value.
@@ -97,5 +102,5 @@ export declare function getShare(item: ChartItem, whole: AxisRange): number;
  * @param item - the item
  * @param type - the chart type
  */
-export declare function formatValue(item: ChartItem, type: ChartType): string;
+export declare function formatValue(item: ChartItem, type: DrawnChartType): string;
 //# sourceMappingURL=scale.d.ts.map

package/dist/types/components.d.ts

@@ -524,7 +524,7 @@ export namespace Components {
      * A chart is a graphical representation of data, in which
      * visual symbols such as such bars, dots, lines, or slices, represent
      * each data point, in comparison to others.
-     * @exampleComponent limel-example-chart-stacked-bar
+     * @exampleComponent limel-example-chart-type-proportion-bar
      * @exampleComponent limel-example-chart-orientation
      * @exampleComponent limel-example-chart-max-value
      * @exampleComponent limel-example-chart-display-item-percentage
@@ -572,7 +572,7 @@ export namespace Components {
          */
         "displayAxisLabels": boolean;
         /**
-          * Set to `false` to hide the percentage in item tooltips. The percentage is an item's value or range extent as a share of the whole. The whole is `maxValue` when set and the combined items otherwise. Applies to `stacked-bar`, `pie`, `doughnut`, and `ring` charts.
+          * Set to `false` to hide the percentage in item tooltips. The percentage is an item's value or range extent as a share of the whole. The whole is `maxValue` when set and the combined items otherwise. Applies to `proportion-bar`, `pie`, `doughnut`, and `ring` charts.
           * @default true
          */
         "displayItemPercentage": boolean;
@@ -601,7 +601,7 @@ export namespace Components {
          */
         "loading": boolean;
         /**
-          * Sets the value used to scale item values. For `stacked-bar`, `pie`, `doughnut`, and `ring`, it is the denominator used as the whole. It defaults to the combined item values or range extents. The combined size can exceed `maxValue` and produce a total above 100%. For `bar`, `dot`, `area`, and `line`, it is the requested upper bound. The chart can round that bound up to the next `axisIncrement`. Has no effect on `nps` or `scatter`.
+          * Sets the value used to scale item values. For `proportion-bar`, `pie`, `doughnut`, and `ring`, it is the denominator used as the whole. It defaults to the combined item values or range extents. The combined size can exceed `maxValue` and produce a total above 100%. For `bar`, `dot`, `area`, and `line`, it is the requested upper bound. The chart can round that bound up to the next `axisIncrement`. Has no effect on `nps` or `scatter`.
          */
         "maxValue"?: number;
         /**
@@ -610,8 +610,8 @@ export namespace Components {
          */
         "orientation"?: 'landscape' | 'portrait';
         /**
-          * Defines how items are visualized in the chart.
-          * @default 'stacked-bar'
+          * Defines how items are visualized in the chart. `stacked-bar` is the old name of `proportion-bar`. It still works, but logs a warning.
+          * @default 'proportion-bar'
          */
         "type"?: ChartType;
     }
@@ -4985,7 +4985,7 @@ declare global {
      * A chart is a graphical representation of data, in which
      * visual symbols such as such bars, dots, lines, or slices, represent
      * each data point, in comparison to others.
-     * @exampleComponent limel-example-chart-stacked-bar
+     * @exampleComponent limel-example-chart-type-proportion-bar
      * @exampleComponent limel-example-chart-orientation
      * @exampleComponent limel-example-chart-max-value
      * @exampleComponent limel-example-chart-display-item-percentage
@@ -7758,7 +7758,7 @@ declare namespace LocalJSX {
      * A chart is a graphical representation of data, in which
      * visual symbols such as such bars, dots, lines, or slices, represent
      * each data point, in comparison to others.
-     * @exampleComponent limel-example-chart-stacked-bar
+     * @exampleComponent limel-example-chart-type-proportion-bar
      * @exampleComponent limel-example-chart-orientation
      * @exampleComponent limel-example-chart-max-value
      * @exampleComponent limel-example-chart-display-item-percentage
@@ -7806,7 +7806,7 @@ declare namespace LocalJSX {
          */
         "displayAxisLabels"?: boolean;
         /**
-          * Set to `false` to hide the percentage in item tooltips. The percentage is an item's value or range extent as a share of the whole. The whole is `maxValue` when set and the combined items otherwise. Applies to `stacked-bar`, `pie`, `doughnut`, and `ring` charts.
+          * Set to `false` to hide the percentage in item tooltips. The percentage is an item's value or range extent as a share of the whole. The whole is `maxValue` when set and the combined items otherwise. Applies to `proportion-bar`, `pie`, `doughnut`, and `ring` charts.
           * @default true
          */
         "displayItemPercentage"?: boolean;
@@ -7835,7 +7835,7 @@ declare namespace LocalJSX {
          */
         "loading"?: boolean;
         /**
-          * Sets the value used to scale item values. For `stacked-bar`, `pie`, `doughnut`, and `ring`, it is the denominator used as the whole. It defaults to the combined item values or range extents. The combined size can exceed `maxValue` and produce a total above 100%. For `bar`, `dot`, `area`, and `line`, it is the requested upper bound. The chart can round that bound up to the next `axisIncrement`. Has no effect on `nps` or `scatter`.
+          * Sets the value used to scale item values. For `proportion-bar`, `pie`, `doughnut`, and `ring`, it is the denominator used as the whole. It defaults to the combined item values or range extents. The combined size can exceed `maxValue` and produce a total above 100%. For `bar`, `dot`, `area`, and `line`, it is the requested upper bound. The chart can round that bound up to the next `axisIncrement`. Has no effect on `nps` or `scatter`.
          */
         "maxValue"?: number;
         /**
@@ -7848,8 +7848,8 @@ declare namespace LocalJSX {
          */
         "orientation"?: 'landscape' | 'portrait';
         /**
-          * Defines how items are visualized in the chart.
-          * @default 'stacked-bar'
+          * Defines how items are visualized in the chart. `stacked-bar` is the old name of `proportion-bar`. It still works, but logs a warning.
+          * @default 'proportion-bar'
          */
         "type"?: ChartType;
     }
@@ -12965,7 +12965,7 @@ declare module "@stencil/core" {
              * A chart is a graphical representation of data, in which
              * visual symbols such as such bars, dots, lines, or slices, represent
              * each data point, in comparison to others.
-             * @exampleComponent limel-example-chart-stacked-bar
+             * @exampleComponent limel-example-chart-type-proportion-bar
              * @exampleComponent limel-example-chart-orientation
              * @exampleComponent limel-example-chart-max-value
              * @exampleComponent limel-example-chart-display-item-percentage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-elements",
-  "version": "40.20.1",
+  "version": "40.21.0",
   "description": "Lime Elements",
   "author": "Lime Technologies",
   "license": "Apache-2.0",