@limetech/lime-elements 40.0.3 → 40.1.0

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

@@ -9,6 +9,7 @@ import { ChartItem } from './chart.types';
  * @exampleComponent limel-example-chart-stacked-bar
  * @exampleComponent limel-example-chart-orientation
  * @exampleComponent limel-example-chart-max-value
+ * @exampleComponent limel-example-chart-display-item-percentage
  * @exampleComponent limel-example-chart-type-bar
  * @exampleComponent limel-example-chart-type-dot
  * @exampleComponent limel-example-chart-type-area
@@ -73,6 +74,13 @@ export declare class Chart {
      * Only affects chart types with X and Y axes, such as area, bar, and line charts.
      */
     displayItemValue: 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.
+     */
+    displayItemPercentage: boolean;
     /**
      * List of items in the chart,
      * each representing a data point.
@@ -88,13 +96,19 @@ export declare class Chart {
      */
     orientation?: 'landscape' | 'portrait';
     /**
-     * Specifies the range that items' values could be in.
-     * This is used in calculation of the size of the items in the chart.
-     * When not provided, the sum of all values in the items will be considered as the range.
+     * 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`.
      */
     maxValue?: number;
     /**
-     * Specifies the increment for the axis lines.
+     * Sets the axis increment for `bar`, `dot`, `area`, and `line` charts.
+     * Has no effect on other chart types.
      */
     axisIncrement?: number;
     /**
@@ -136,6 +150,15 @@ export declare class Chart {
     private getItemText;
     private renderTooltip;
     private calculateRange;
+    /**
+     * The range of a chart whose items are parts of one whole: `maxValue`
+     * when set, otherwise the combined item values or range extents. The value
+     * is a scale, not a cap, so the combined size can exceed it. The whole is
+     * not rounded to an axis step, since these types draw no axis and an item's
+     * size has to be its exact share.
+     */
+    private calculateWholeRange;
+    private isPartOfWhole;
     private calculateAxisIncrement;
     private calculateNiceStep;
     private axisSpan;
@@ -145,6 +168,7 @@ export declare class Chart {
     private getYValue;
     private getMinimumValue;
     private getMaximumValue;
+    private getValueSpan;
     private isRangeItem;
     handleChange(): void;
     private recalculateRangeData;

package/dist/types/components.d.ts

@@ -518,6 +518,7 @@ export namespace Components {
      * @exampleComponent limel-example-chart-stacked-bar
      * @exampleComponent limel-example-chart-orientation
      * @exampleComponent limel-example-chart-max-value
+     * @exampleComponent limel-example-chart-display-item-percentage
      * @exampleComponent limel-example-chart-type-bar
      * @exampleComponent limel-example-chart-type-dot
      * @exampleComponent limel-example-chart-type-area
@@ -554,7 +555,7 @@ export namespace Components {
          */
         "accessibleValuesLabel"?: string;
         /**
-          * Specifies the increment for the axis lines.
+          * Sets the axis increment for `bar`, `dot`, `area`, and `line` charts. Has no effect on other chart types.
          */
         "axisIncrement"?: number;
         /**
@@ -562,6 +563,11 @@ export namespace Components {
           * @default false
          */
         "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.
+          * @default true
+         */
+        "displayItemPercentage": boolean;
         /**
           * Makes the `text` of chart items constantly visible, By default, item texts are displayed in a tooltip, when the item is hovered or focused. Only affects chart types with X and Y axes, such as area, bar, and line charts.
           * @default false
@@ -587,7 +593,7 @@ export namespace Components {
          */
         "loading": boolean;
         /**
-          * Specifies the range that items' values could be in. This is used in calculation of the size of the items in the chart. When not provided, the sum of all values in the items will be considered as the range.
+          * 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`.
          */
         "maxValue"?: number;
         /**
@@ -4563,6 +4569,7 @@ declare global {
      * @exampleComponent limel-example-chart-stacked-bar
      * @exampleComponent limel-example-chart-orientation
      * @exampleComponent limel-example-chart-max-value
+     * @exampleComponent limel-example-chart-display-item-percentage
      * @exampleComponent limel-example-chart-type-bar
      * @exampleComponent limel-example-chart-type-dot
      * @exampleComponent limel-example-chart-type-area
@@ -7097,6 +7104,7 @@ declare namespace LocalJSX {
      * @exampleComponent limel-example-chart-stacked-bar
      * @exampleComponent limel-example-chart-orientation
      * @exampleComponent limel-example-chart-max-value
+     * @exampleComponent limel-example-chart-display-item-percentage
      * @exampleComponent limel-example-chart-type-bar
      * @exampleComponent limel-example-chart-type-dot
      * @exampleComponent limel-example-chart-type-area
@@ -7133,7 +7141,7 @@ declare namespace LocalJSX {
          */
         "accessibleValuesLabel"?: string;
         /**
-          * Specifies the increment for the axis lines.
+          * Sets the axis increment for `bar`, `dot`, `area`, and `line` charts. Has no effect on other chart types.
          */
         "axisIncrement"?: number;
         /**
@@ -7141,6 +7149,11 @@ declare namespace LocalJSX {
           * @default false
          */
         "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.
+          * @default true
+         */
+        "displayItemPercentage"?: boolean;
         /**
           * Makes the `text` of chart items constantly visible, By default, item texts are displayed in a tooltip, when the item is hovered or focused. Only affects chart types with X and Y axes, such as area, bar, and line charts.
           * @default false
@@ -7166,7 +7179,7 @@ declare namespace LocalJSX {
          */
         "loading"?: boolean;
         /**
-          * Specifies the range that items' values could be in. This is used in calculation of the size of the items in the chart. When not provided, the sum of all values in the items will be considered as the range.
+          * 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`.
          */
         "maxValue"?: number;
         /**
@@ -10991,6 +11004,7 @@ declare namespace LocalJSX {
         "displayAxisLabels": boolean;
         "displayItemText": boolean;
         "displayItemValue": boolean;
+        "displayItemPercentage": boolean;
         "type": | 'area'
         | 'bar'
         | 'doughnut'
@@ -11813,6 +11827,7 @@ declare module "@stencil/core" {
              * @exampleComponent limel-example-chart-stacked-bar
              * @exampleComponent limel-example-chart-orientation
              * @exampleComponent limel-example-chart-max-value
+             * @exampleComponent limel-example-chart-display-item-percentage
              * @exampleComponent limel-example-chart-type-bar
              * @exampleComponent limel-example-chart-type-dot
              * @exampleComponent limel-example-chart-type-area

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@limetech/lime-elements",
-  "version": "40.0.3",
+  "version": "40.1.0",
   "description": "Lime Elements",
   "author": "Lime Technologies",
   "license": "Apache-2.0",
@@ -93,7 +93,7 @@
     "postal-mime": "^3.0.0",
     "prettier": "^3.8.3",
     "prosemirror-example-setup": "^1.2.3",
-    "prosemirror-markdown": "^1.13.6",
+    "prosemirror-markdown": "^1.13.7",
     "prosemirror-model": ">=1.25.11",
     "prosemirror-schema-basic": "^1.2.4",
     "prosemirror-tables": "^1.8.5",