@arcgis/charts-model - npm Package Compare versions

Comparing version 4.30.0-next.23 to 4.30.0-next.24

dist/types/chart-model/chart-model.d.ts

@@ -5,5 +5,4 @@ import PQueue from "p-queue";
 import { Color } from "@arcgis/charts-spec";
-import { UpdateFormatProps, FormatKeys, LayerInfo } from "../interfaces/common";
+import { LayerInfo } from "../interfaces/common";
 import { InlineProcessedChartModelParams, LayerChartModelParams, ModelParams } from "../interfaces/chart-interfaces";
-import { FormatConfig } from "../shared/format";
 import { GeneralConfig } from "../shared/general";
@@ -27,7 +26,2 @@ export declare abstract class ChartModel extends EventTarget {
     /**
-     * Format config instance.
-     * @category Protected
-     */
-    protected formatConfig: FormatConfig;
-    /**
      * A queue that forces promises to run based on rate limiting.
@@ -65,4 +59,4 @@ * Used to make all await / async functions run in sequence rather than in parallel.
      */
-    get title(): string;
-    set title(updatedTitle: string);
+    get titleText(): string;
+    set titleText(updatedTitle: string);
     /**
@@ -96,4 +90,4 @@ * Description text.
      */
-    get titleText(): WebChartTextSymbol | undefined;
-    set titleText(newTitle: WebChartTextSymbol | undefined);
+    get title(): WebChartTextSymbol | undefined;
+    set title(newTitle: WebChartTextSymbol | undefined);
     /**
@@ -109,4 +103,4 @@ * Description text symbol. Contains styling information such as font, color, and symbol style.
      */
-    get background(): Color;
-    set background(updatedBackground: Color);
+    get background(): Color | undefined;
+    set background(newBackground: Color | undefined);
     /**
@@ -148,8 +142,3 @@ * A function that loads the configuration objects.
      */
-    protected formatChanged: (keys: string[], value: UpdateFormatProps["value"]) => void;
-    /**
-     * @category Protected
-     */
     protected generalPropsChanged: (key: string, value: string) => void;
-    protected updateFormatTextSymbols: (formatKeys: FormatKeys[], textSymbol?: WebChartTextSymbol) => Promise<void>;
     /**
@@ -156,0 +145,0 @@ * Pause the queue, preventing any new promises from being resolved.

dist/types/gauge-model/gauge-model.d.ts

@@ -1,2 +0,2 @@
-import { WebGaugeChart, WebChartTextSymbol, WebChartGaugeSeries, WebChartLayerDataSource } from "@arcgis/charts-spec";
+import { WebGaugeChart, WebChartTextSymbol, WebChartGaugeSeries, WebChartLayerDataSource, RESTStatisticType } from "@arcgis/charts-spec";
 import { ChartTypes, ChartConfig } from "@arcgis/charts-shared-utils";
@@ -26,112 +26,69 @@ import { ISimpleFillSymbol } from "@arcgis/charts-spec";
     /**
-     * Get the data field of the gauge
+     * The data field for the gauge.
      * @category Public
      */
     get field(): string;
+    set field(newField: string);
     /**
-     * Set the data field of the gauge
+     * The aggregation type for the gauge.
      * @category Public
      */
-    set field(newField: string);
+    get aggregationType(): Exclude<RESTStatisticType, "no_aggregation">;
+    set aggregationType(newAggregationType: Exclude<RESTStatisticType, "no_aggregation">);
     /**
-     * Get the innerRadius of the gauge
+     * The inner radius of the gauge.
      * @category Public
      */
     get innerRadius(): number;
-    /**
-     * Set the innerRadius of the gauge
-     * @category Public
-     * @param newInnerRadius
-     */
     set innerRadius(newInnerRadius: number);
     /**
-     * Get the startAngle of the gauge
+     * The start angle of the gauge.
      * @category Public
      */
     get startAngle(): number;
-    /**
-     * Set the startAngle of the gauge
-     * @category Public
-     * @param newStartAngle
-     */
     set startAngle(newStartAngle: number);
     /**
-     * Get the endAngle of the gauge
+     * The end angle of the gauge.
      * @category Public
      */
     get endAngle(): number;
-    /**
-     * Set the endAngle of the gauge
-     * @category Public
-     * @param newEndAngle
-     */
     set endAngle(newEndAngle: number);
     /**
-     * Get the visibility status of the gauge's needle
+     * Whether the gauge's needle is visible.
      * @category Public
      */
     get needleVisible(): boolean;
-    /**
-     * Set the visibility status of the gauge's needle
-     * @category Public
-     * @param updatedNeedleVisible
-     */
     set needleVisible(updatedNeedleVisible: boolean);
     /**
-     * Get the symbol of the gauge's needle
+     * The symbol used for the gauge's needle.
      * @category Public
      */
     get needleSymbol(): ISimpleFillSymbol;
-    /**
-     * Set the symbol of the gauge's needle
-     * @category Public
-     * @param updatedNeedleSymbol
-     */
     set needleSymbol(updatedNeedleSymbol: ISimpleFillSymbol);
     /**
-     * Get the start width of the gauge's needle
+     * The start width of the gauge's needle.
      * @category Public
      */
     get needleStartWidth(): number;
-    /**
-     * Set the start width of the gauge's needle
-     * @category Public
-     * @param updatedNeedleStartWidth
-     */
     set needleStartWidth(updatedNeedleStartWidth: number);
     /**
-     * Get the end width of the gauge's needle
+     * The end width of the gauge's needle.
      * @category Public
      */
     get needleEndWidth(): number;
-    /**
-     * Set the end width of the gauge's needle
-     * @category Public
-     * @param updatedNeedleEndWidth
-     */
     set needleEndWidth(updatedNeedleEndWidth: number);
     /**
-     * Get the inner radius of the gauge's needle
+     * The inner radius of the gauge's needle.
      * @category Public
      */
     get needleInnerRadius(): number;
-    /**
-     * Set the inner radius of the gauge's needle
-     * @category Public
-     * @param updatedNeedleInnerRadius
-     */
     set needleInnerRadius(updatedNeedleInnerRadius: number);
     /**
-     * Get the visibility status of the pin of the gauge
+     * Whether to display the pin for the gauge's needle.
      * @category Public
      */
     get needleDisplayPin(): boolean;
-    /**
-     * Set the visibility status of the pin of the gauge
-     * @category Public
-     * @param updatedNeedleDisplayPin
-     */
     set needleDisplayPin(updatedNeedleDisplayPin: boolean);
     /**
-     * Get the visibility status of the inner label of the gauge
+     * Whether the inner label is visible.
      * @category Public
@@ -142,44 +99,24 @@ */
     /**
-     * Get the content of the inner label of the gauge
+     * The content of the inner label.
      * @category Public
      */
     get innerLabelContent(): WebChartTextSymbol;
-    /**
-     * Set the content of the inner label of the gauge
-     * @category Public
-     * @param updatedInnerLabelContent
-     */
     set innerLabelContent(updatedInnerLabelContent: WebChartTextSymbol);
     /**
-     * Get the visibility status of the axis tick of the gauge
+     * Whether the axis ticks are visible.
      * @category Public
      */
     get axisTickVisible(): boolean;
-    /**
-     * Set the visibility status of the axis tick of the gauge
-     * @category Public
-     * @param updatedAxisTickVisible
-     */
     set axisTickVisible(updatedAxisTickVisible: boolean);
     /**
-     * Get the labels increment of the gauge
+     * The labels increment of the gauge.
      * @category Public
      */
     get labelsIncrement(): number;
-    /**
-     * Set the labels increment of the gauge
-     * @category Public
-     * @param updatedLabelsIncrement
-     */
     set labelsIncrement(updatedLabelsIncrement: number);
     /**
-     * Get the visibility status of the first and last labels of the gauge
+     * Whether to show only the first and last labels.
      * @category Public
      */
     get onlyShowFirstAndLastLabels(): boolean;
-    /**
-     * Set the visibility status of the first and last labels of the gauge
-     * @category Public
-     * @param updatedOnlyShowFirstAndLastLabels
-     */
     set onlyShowFirstAndLastLabels(updatedOnlyShowFirstAndLastLabels: boolean);
@@ -186,0 +123,0 @@ protected generateDefaultConfig(): Promise<Omit<typeof this._config, "dataSource">>;

dist/types/gauge-model/utils/gauge-data.d.ts

@@ -1,7 +0,21 @@
-import { GaugeChartConfig } from "@arcgis/charts-shared-utils";
+import { ChartConfig } from "@arcgis/charts-shared-utils";
+import { RESTStatisticType, WebChartGaugeSeries } from "@arcgis/charts-spec";
+import { LayerInfo } from "../../interfaces/common";
 /**
+ * Gets the aggregation type from the config.
+ * @param config - the guage chart config
+ */
+export declare const getAggregationType: (config: ChartConfig<WebChartGaugeSeries>) => Exclude<RESTStatisticType, "no_aggregation">;
+/**
+ * Sets the aggregation type to the config.
+ * @param newAggregationType
+ * @param config
+ * @param layerInfo
+ */
+export declare const setAggregationType: (newAggregationType: Exclude<RESTStatisticType, "no_aggregation">, config: ChartConfig<WebChartGaugeSeries>, layerInfo: LayerInfo) => Promise<void>;
+/**
  * get the field from the config
  * @param config - the guage chart config
  */
-export declare const getField: (config: GaugeChartConfig) => string;
+export declare const getField: (config: ChartConfig<WebChartGaugeSeries>) => string;
 /**
@@ -12,3 +26,3 @@ * set the new field to the config
  */
-export declare const setField: (newField: string, config: GaugeChartConfig) => void;
+export declare const setField: (newField: string, config: ChartConfig<WebChartGaugeSeries>, layerInfo: LayerInfo) => Promise<void>;
 /**
@@ -18,3 +32,3 @@ * get the inner radius from the config
  */
-export declare const getInnerRadius: (config: GaugeChartConfig) => number;
+export declare const getInnerRadius: (config: ChartConfig<WebChartGaugeSeries>) => number;
 /**
@@ -25,3 +39,3 @@ * set the new inner radius to the config
  */
-export declare const setInnerRadius: (newInnerRadius: number, config: GaugeChartConfig) => void;
+export declare const setInnerRadius: (newInnerRadius: number, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
@@ -31,3 +45,3 @@ * get the start angle from the config
  */
-export declare const getStartAngle: (config: GaugeChartConfig) => number;
+export declare const getStartAngle: (config: ChartConfig<WebChartGaugeSeries>) => number;
 /**
@@ -38,3 +52,3 @@ * set the new start angle to the config
  */
-export declare const setStartAngle: (newStartAngle: number, config: GaugeChartConfig) => void;
+export declare const setStartAngle: (newStartAngle: number, config: ChartConfig<WebChartGaugeSeries>) => void;
 /**
@@ -44,3 +58,3 @@ * get the end angle from the config
  */
-export declare const getEndAngle: (config: GaugeChartConfig) => number;
+export declare const getEndAngle: (config: ChartConfig<WebChartGaugeSeries>) => number;
 /**
@@ -51,2 +65,2 @@ * set the new end angle to the config
  */
-export declare const setEndAngle: (newEndAngle: number, config: GaugeChartConfig) => void;
+export declare const setEndAngle: (newEndAngle: number, config: ChartConfig<WebChartGaugeSeries>) => void;

dist/types/histogram-model/utils/histogram-data.d.ts

@@ -138,12 +138,1 @@ import { WebChartDataTransformations } from "@arcgis/charts-spec";
 export declare const setShowStandardDevOverlay: (newShowStandardDevOverlay: boolean, config: HistogramConfig) => void;
-/**
- * get the show data labels from the config
- * @param config - the histogram config
- */
-export declare const getShowDataLabels: (config: HistogramConfig) => boolean;
-/**
- * set the show data labels in the config
- * @param newShowDataLabels - the new show data labels
- * @param config - the histogram config
- */
-export declare const setShowDataLabels: (newShowDataLabels: boolean, config: HistogramConfig) => void;

dist/types/interfaces/common.d.ts

@@ -41,3 +41,2 @@ import { Color, ISimpleLineSymbol, IFont, ISimpleFillSymbol, ISimpleMarkerSymbol, IField } from "@arcgis/charts-spec";
 export declare const FormatKeys: {
-    readonly Format: "format";
     readonly TextElements: "textElements";
@@ -48,4 +47,3 @@ readonly XAxisTitle: "xAxisTitle";
     readonly GuideLabels: "guideLabels";
-    readonly TitleText: "titleText";
-    readonly ChartSubtitle: "chartSubtitle";
+    readonly Title: "title";
     readonly LegendText: "legendText";
@@ -55,3 +53,2 @@ readonly LegendTitle: "legendTitle";
     readonly DataLabels: "dataLabels";
-    readonly SymbolElements: "symbolElements";
     readonly Background: "background";
@@ -61,15 +58,2 @@ readonly LeaderLines: "leaderLines";
     readonly GridLines: "gridLines";
-    readonly SelectAll: "selectAll";
-    readonly SymbolColor: "symbolColor";
-    readonly Color: "color";
-    readonly Width: "width";
-    readonly Font: "font";
-    readonly Size: "size";
-    readonly Style: "style";
-    readonly Solid: "solid";
-    readonly Dot: "dot";
-    readonly Dash: "dash";
-    readonly DashDot: "dashDot";
-    readonly LongDashDot: "longDashDot";
-    readonly BackgroundElement: "backgroundElement";
 };
@@ -84,2 +68,3 @@ export type FormatKeys = typeof FormatKeys[keyof typeof FormatKeys];
 export declare const TextFormatKeys: {
+    readonly Title: "title";
     readonly XAxisTitle: "xAxisTitle";
@@ -89,3 +74,2 @@ readonly YAxisTitle: "yAxisTitle";
     readonly GuideLabels: "guideLabels";
-    readonly TitleText: "titleText";
     readonly LegendText: "legendText";
@@ -92,0 +76,0 @@ readonly LegendTitle: "legendTitle";

dist/types/mixins/guides/model-with-guides.d.ts

@@ -21,3 +21,3 @@ import { ISimpleFillSymbol, ISimpleLineSymbol, WebChartTextSymbol } from "@arcgis/charts-spec";
     get guideLabels(): WebChartTextSymbol | undefined;
-    set guideLabels(updatedGuideLabels: WebChartTextSymbol | undefined);
+    set guideLabels(newGuideLabels: WebChartTextSymbol | undefined);
     /**
@@ -24,0 +24,0 @@ * Set show guide.

dist/types/mixins/model-with-basic-x-axis.d.ts

@@ -36,3 +36,3 @@ import { ISimpleLineSymbol, WebChartTextSymbol } from "@arcgis/charts-spec";
     get xAxisTitle(): WebChartTextSymbol | undefined;
-    set xAxisTitle(updatedXAxisTitle: WebChartTextSymbol | undefined);
+    set xAxisTitle(newXAxisTitle: WebChartTextSymbol | undefined);
     /**
@@ -43,3 +43,3 @@ * Axis labels text symbol. Contains styling information such as font, color, and symbol style.
     get axisLabels(): WebChartTextSymbol | undefined;
-    set axisLabels(updatedAxisLabels: WebChartTextSymbol | undefined);
+    set axisLabels(newAxisLabels: WebChartTextSymbol | undefined);
     /**
@@ -50,3 +50,3 @@ * Axis lines symbol. Contains styling information such as line width, line style, and line color.
     get axisLines(): ISimpleLineSymbol | undefined;
-    set axisLines(updatedAxisLines: ISimpleLineSymbol | undefined);
+    set axisLines(newAxisLines: ISimpleLineSymbol | undefined);
 }

dist/types/mixins/model-with-xy-axes.d.ts

@@ -89,3 +89,3 @@ import { XYChartTypes } from "@arcgis/charts-shared-utils";
     get yAxisTitle(): WebChartTextSymbol | undefined;
-    set yAxisTitle(updatedYAxisTitle: WebChartTextSymbol | undefined);
+    set yAxisTitle(newYAxisTitle: WebChartTextSymbol | undefined);
     /**
@@ -96,3 +96,3 @@ * Grid lines symbol. Contains styling information such as line width, line style, and line color.
     get gridLines(): ISimpleLineSymbol | undefined;
-    set gridLines(updatedGridLines: ISimpleLineSymbol | undefined);
+    set gridLines(newGridLines: ISimpleLineSymbol | undefined);
 }

dist/types/pie-chart-model/common-pie-chart-model.d.ts

@@ -47,3 +47,3 @@ import { WebChart, WebChartPieChartSlice, WebChartPieChartGroupSlice, WebChartPieChartSeries, WebChartLayerDataSource, WebChartInlineDataSource } from "@arcgis/charts-spec";
     get leaderLines(): ISimpleLineSymbol | undefined;
-    set leaderLines(updateLeaderLines: ISimpleLineSymbol | undefined);
+    set leaderLines(newLeaderLines: ISimpleLineSymbol | undefined);
     /**
@@ -50,0 +50,0 @@ * The array of slices for the pie chart.

package.json

 {
   "name": "@arcgis/charts-model",
-  "version": "4.30.0-next.23",
+  "version": "4.30.0-next.24",
   "description": "TypeScript library for running operations on an ArcGIS Chart",
@@ -13,3 +13,3 @@ "license": "SEE LICENSE IN LICENSE.md",
   "devDependencies": {
-    "@arcgis/charts-shared-utils": "4.30.0-next.23",
+    "@arcgis/charts-shared-utils": "4.30.0-next.24",
     "@arcgis/core": ">=4.30.0-next <4.31",
@@ -16,0 +16,0 @@ "@babel/core": "^7.14.2",

No alert changes

Improved metrics

Total package byte prevSize

4326227

increased by0.09%

Number of package files

306

increased by1.66%

Worsened metrics

Lines of code

12623

decreased by-0.29%

No dependency changes