@arcgis/charts-components 4.34.0-next.99 → 5.0.0-next.1

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

@@ -1,4 +1,4 @@
-import { GaugeChartSubTypes, ISimpleFillSymbol, WebChartStatisticType, ValueConversion, WebChartTextSymbol, WebGaugeChart } from '@arcgis/charts-spec';
+import { GaugeChartSubTypes, ISimpleFillSymbol, WebChartStatisticType, ValueConversion, WebChartTextSymbol, WebGaugeChart } from '../../spec';
 import { ChartTypes, ChartConfig } from '../../utils';
 import { ChartModel } from '../chart-model/chart-model';
 import { ModelParams } from '../interfaces/chart-interfaces';
@@ -10,7 +10,7 @@ export declare class GaugeModel extends ChartModel {
      *
      * @returns {string}
      */
-    generateChartTitle(): Promise<string>;
+    generateChartTitle(): string;
     /**
      * Current configuration used for the histogram.
      */
@@ -19,204 +19,112 @@ export declare class GaugeModel extends ChartModel {
     protected _chartType: ChartTypes;
     setup(params: ModelParams<ChartConfig<typeof ModelTypes.Gauge>>): Promise<void>;
     /**
-     * Gets the data field used for the gauge.
-     * @returns {string}
-     */
-    getField(): string;
-    /**
-     * Sets the data field used for the gauge.
-     * @param {string} field The field to set.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
-     */
-    setField(field: string): Promise<void>;
-    /**
-     * Gets the aggregation type used for the gauge.
-     * @returns {WebChartStatisticType}
-     */
-    getAggregationType(): WebChartStatisticType;
-    /**
-     * Sets the aggregation type used for the gauge.
-     * @param {WebChartStatisticType} aggregationType The aggregation type to set. Must be one of the values allowed by `WebChartStatisticType`, excluding `"no_aggregation"`.
-     * @async **This method is `async` and must be awaited for the changes to take effect.**
-     */
-    setAggregationType(aggregationType: WebChartStatisticType): Promise<void>;
-    /**
-     * Gets the inner radius of the gauge.
-     * @returns {number}
-     */
-    getInnerRadius(): number;
-    /**
-     * Sets the inner radius of the gauge.
-     * @param {number} innerRadius The inner radius to set.
+     * Data field used for the gauge.
      */
-    setInnerRadius(innerRadius: number): void;
+    get field(): string;
+    set field(field: string);
     /**
-     * Gets the start angle of the gauge.
-     * @returns {number}
+     * Aggregation type used for the gauge.
+     *
+     * Must be one of the values allowed by `WebChartStatisticType`, excluding `"no_aggregation"`.
      */
-    getStartAngle(): number;
+    get aggregationType(): WebChartStatisticType;
+    set aggregationType(aggregationType: WebChartStatisticType);
     /**
-     * Sets the start angle of the gauge.
-     * @param {number} startAngle The start angle to set.
+     * Inner radius of the gauge.
      */
-    setStartAngle(startAngle: number): void;
+    get innerRadius(): number;
+    set innerRadius(innerRadius: number);
     /**
-     * Gets the end angle of the gauge.
-     * @returns {number}
+     * Start angle of the gauge.
      */
-    getEndAngle(): number;
+    get startAngle(): number;
+    set startAngle(startAngle: number);
     /**
-     * Sets the end angle of the gauge.
-     * @param {number} endAngle The end angle to set.
+     * End angle of the gauge.
      */
-    setEndAngle(endAngle: number): void;
+    get endAngle(): number;
+    set endAngle(endAngle: number);
     /**
-     * Gets the conversion to apply to the gauge value
-     *
-     * @returns {ValueConversion | undefined}
+     * Conversion to apply to the gauge value.
      */
-    getValueConversion(): ValueConversion | undefined;
-    /**
-     * Sets the conversion to apply to the gauge value
-     * @param {ValueConversion} valueConversion The conversion to apply
-     */
-    setValueConversion(valueConversion: ValueConversion): void;
+    get valueConversion(): ValueConversion | undefined;
+    set valueConversion(valueConversion: ValueConversion | undefined);
     /**
      * Gets the index of the feature to be rendered.
-     * @returns {number | undefined}
+     *
      * @remarks
      * This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
      * For feature-based gauge, if this property is not present, the first feature will be used (featureIndex = 0)
      */
-    getFeatureIndex(): number | undefined;
-    /**
-     * Sets the index of the feature to be rendered.
-     * @param {number | null} featureIndex The index of the feature to be rendered
-     * @remarks This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
-     * For feature-based gauge, if this property is not present, the first feature will be used (featureIndex = 0)
-     */
-    setFeatureIndex(featureIndex: number | null): Promise<void>;
+    get featureIndex(): number | undefined;
+    set featureIndex(featureIndex: number | null | undefined);
     /**
      * Removes the existing feature index from the config object
      */
     removeFeatureIndex(): void;
     /**
-     * Gets the type of Gauge chart, like FeatureGauge and StatisticGauge.
-     * @returns {GaugeChartSubTypes}
+     * Type of Gauge chart, like FeatureGauge and StatisticGauge.
+     *
      * @remarks When this property is not specified, it will be defaulted to GaugeChartSubTypes.StatisticGauge.
      */
-    getGaugeSubType(): GaugeChartSubTypes;
-    /**
-     * Gets the visibility of the gauge's needle.
-     * @returns {boolean}
-     */
-    getNeedleVisibility(): boolean;
-    /**
-     * Sets the visibility of the gauge's needle.
-     * @param {boolean} visible The visibility to set.
-     */
-    setNeedleVisibility(visible: boolean): void;
-    /**
-     * Gets the symbol of the gauge's needle.
-     * @returns {ISimpleFillSymbol | undefined}
-     */
-    getNeedleSymbol(): ISimpleFillSymbol | undefined;
-    /**
-     * Sets the symbol of the gauge's needle.
-     * @param {ISimpleFillSymbol | undefined} needleSymbol The needle symbol to set.
-     */
-    setNeedleSymbol(needleSymbol: ISimpleFillSymbol | undefined): void;
-    /**
-     * Gets the start width of the gauge's needle.
-     * @returns {number | null | undefined}
-     */
-    getNeedleStartWidth(): number | null | undefined;
-    /**
-     * Sets the start width of the gauge's needle.
-     * @param {number | null | undefined} width The start width to set.
-     */
-    setNeedleStartWidth(width: number | null | undefined): void;
-    /**
-     * Gets the end width of the gauge's needle.
-     * @returns {number | null | undefined}
-     */
-    getNeedleEndWidth(): number | null | undefined;
-    /**
-     * Sets the end width of the gauge's needle.
-     * @param {number | null | undefined} width The end width to set.
-     */
-    setNeedleEndWidth(width: number | null | undefined): void;
-    /**
-     * Gets the inner radius of the gauge's needle.
-     * @returns {number | null | undefined}
-     */
-    getNeedleInnerRadius(): number | null | undefined;
-    /**
-     * Sets the inner radius of the gauge's needle.
-     * @param {number | null | undefined} innerRadius The inner radius to set.
-     */
-    setNeedleInnerRadius(innerRadius: number): void;
-    /**
-     * Gets whether to display the pin for the gauge's needle.
-     * @returns {boolean}
-     */
-    getNeedleDisplayPin(): boolean;
+    get gaugeSubType(): GaugeChartSubTypes;
     /**
-     * Sets whether to display the pin for the gauge's needle.
-     * @param {boolean} displayPin The display pin state.
+     * Visibility of the gauge's needle.
      */
-    setNeedleDisplayPin(displayPin: boolean): void;
+    get needleVisibility(): boolean;
+    set needleVisibility(visible: boolean);
     /**
-     * Gets whether the inner label is visible.
-     * @returns {boolean}
+     * Symbol of the gauge's needle.
      */
-    getInnerLabelVisible(): boolean;
+    get needleSymbol(): ISimpleFillSymbol | undefined;
+    set needleSymbol(needleSymbol: ISimpleFillSymbol | undefined);
     /**
-     * Sets whether the inner label is visible.
-     * @param {boolean} visible The visibility state to set.
+     * Start width of the gauge's needle.
      */
-    setInnerLabelVisibility(visible: boolean): void;
+    get needleStartWidth(): number | null | undefined;
+    set needleStartWidth(width: number | null | undefined);
     /**
-     * Gets the inner label content symbol.
-     * @returns {WebChartTextSymbol | undefined}
+     * End width of the gauge's needle.
      */
-    getInnerLabelContent(): WebChartTextSymbol | undefined;
+    get needleEndWidth(): number | null | undefined;
+    set needleEndWidth(width: number | null | undefined);
     /**
-     * Sets the inner label content symbol.
-     * @param {WebChartTextSymbol | undefined} innerLabelContent The content symbol to set.
+     * Inner radius of the gauge's needle.
      */
-    setInnerLabelContent(innerLabelContent: WebChartTextSymbol | undefined): void;
+    get needleInnerRadius(): number | null | undefined;
+    set needleInnerRadius(innerRadius: number | null | undefined);
     /**
-     * Gets whether the axis ticks are visible.
-     * @returns {boolean}
+     * Whether to display the pin for the gauge's needle.
      */
-    getAxisTickVisibility(): boolean;
+    get needleDisplayPin(): boolean;
+    set needleDisplayPin(displayPin: boolean);
     /**
-     * Sets whether the axis ticks are visible.
-     * @param {boolean} visibile The visibility state to set.
+     * Whether the inner label is visible.
      */
-    setAxisTickVisibility(visibile: boolean): void;
+    get innerLabelVisible(): boolean;
+    set innerLabelVisible(visible: boolean);
     /**
-     * Gets the labels increment for the gauge.
-     * @returns {number | undefined}
+     * Content symbol for the inner label.
      */
-    getLabelsIncrement(): number | undefined;
+    get innerLabelContent(): WebChartTextSymbol | undefined;
+    set innerLabelContent(innerLabelContent: WebChartTextSymbol | undefined);
     /**
-     * Sets the labels increment for the gauge.
-     * @param {number | undefined} increment The increment to set.
+     * Whether axis ticks are visible.
      */
-    setLabelsIncrement(increment: number | undefined): void;
+    get axisTickVisibility(): boolean;
+    set axisTickVisibility(visibile: boolean);
     /**
-     * Gets whether to only show the first and last labels.
-     * @returns {boolean}
+     * Labels increment for the gauge.
      */
-    getOnlyShowFirstAndLastLabels(): boolean;
+    get labelsIncrement(): number | undefined;
+    set labelsIncrement(increment: number | undefined);
     /**
-     * Sets whether to only show the first and last axis labels.
-     * @param {boolean} showOnlyFirstAndLastLabels Indicator of whether to only show the first and last axis labels
+     * Whether to only show the first and last axis labels.
      */
-    setOnlyShowFirstAndLastLabels(showOnlyFirstAndLastLabels: boolean): void;
-    protected generateDefaultConfig(): Promise<Omit<typeof this._config, "iLayer">>;
+    get onlyShowFirstAndLastLabels(): boolean;
+    set onlyShowFirstAndLastLabels(showOnlyFirstAndLastLabels: boolean);
+    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
 }
 export interface GaugeModel extends ModelWithBasicXAxis, ModelWithXGuides {
 }

package/dist/model/gauge-model/utils/gauge-axes.d.ts

@@ -1,5 +1,5 @@
 import { ChartConfig } from '../../../utils';
-import { ISimpleFillSymbol, WebChartTextSymbol } from '@arcgis/charts-spec';
+import { ISimpleFillSymbol, WebChartTextSymbol } from '../../../spec';
 import { ModelTypes } from '../../interfaces/common';
 /**
  * Gets the visibility of the needle.

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

@@ -1,12 +1,13 @@
-import { ChartConfig } from '../../../utils';
-import { WebChartStatisticType } from '@arcgis/charts-spec';
+import { ChartConfig, CommonStrings } from '../../../utils';
+import { WebChartStatisticType } from '../../../spec';
 import { LayerInfo, ModelTypes } from '../../interfaces/common';
 export declare const updateSeries: (props: {
     config: ChartConfig<typeof ModelTypes.Gauge>;
     layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
     field: string;
     aggregationType: WebChartStatisticType;
-}) => Promise<void>;
+}) => void;
 /**
  * Gets the aggregation type from the config.
  * @param config - the guage chart config
@@ -14,11 +15,17 @@ export declare const updateSeries: (props: {
 export declare const getAggregationType: (config: ChartConfig<typeof ModelTypes.Gauge>) => WebChartStatisticType;
 /**
  * Sets the aggregation type to the config.
- * @param aggregationType
- * @param config
- * @param layerInfo
+ * @param props.aggregationType
+ * @param props.config
+ * @param props.layerInfo
+ * @param props.commonStrings
  */
-export declare const setAggregationType: (aggregationType: WebChartStatisticType, config: ChartConfig<typeof ModelTypes.Gauge>, layerInfo: LayerInfo) => Promise<void>;
+export declare const setAggregationType: (props: {
+    aggregationType: WebChartStatisticType;
+    config: ChartConfig<typeof ModelTypes.Gauge>;
+    layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
+}) => void;
 /**
  * Checks if the feature index is valid.
  *
@@ -35,10 +42,17 @@ export declare const isValidFeatureIndex: (featureIndex?: number) => boolean;
 export declare const getField: (config: ChartConfig<typeof ModelTypes.Gauge>) => string;
 /**
  * Sets the field to the config
- * @param field The field to set
- * @param config The guage chart config
+ * @param props.field The field to set
+ * @param props.config The guage chart config
+ * @param props.layerInfo The layer info
+ * @param props.commonStrings The common strings
  */
-export declare const setField: (field: string, config: ChartConfig<typeof ModelTypes.Gauge>, layerInfo: LayerInfo) => Promise<void>;
+export declare const setField: (props: {
+    field: string;
+    config: ChartConfig<typeof ModelTypes.Gauge>;
+    layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
+}) => void;
 /**
  * Gets the inner radius from the config
  * @param config - the guage chart config
@@ -76,4 +90,4 @@ export declare const setEndAngle: (endAngle: number, config: ChartConfig<typeof
  * Gets the proper chart title given the current config.
  * @returns {string}
  */
-export declare function getChartTitle(): Promise<string>;
+export declare function getChartTitle(commonStrings: CommonStrings): string;

package/dist/model/gauge-model/utils/gauge-series.d.ts

@@ -1,5 +1,5 @@
-import { ChartConfig } from '../../../utils';
-import { ValueConversion, GaugeChartSubTypes } from '@arcgis/charts-spec';
+import { ChartConfig, CommonStrings } from '../../../utils';
+import { ValueConversion, GaugeChartSubTypes } from '../../../spec';
 import { LayerInfo, ModelTypes } from '../../interfaces/common';
 /**
  * Gets the conversion to apply to the gauge value
@@ -12,7 +12,7 @@ export declare const getValueConversion: (config: ChartConfig<typeof ModelTypes.
  * @param {ValueConversion} valueConversion The conversion to apply
  * @param {ChartConfig<typeof ModelTypes.Gauge>} config The gauge chart configuration object
  */
-export declare const setValueConversion: (valueConversion: ValueConversion, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
+export declare const setValueConversion: (valueConversion: ValueConversion | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets the index of the feature to be rendered.
  * @param {ChartConfig<typeof ModelTypes.Gauge>} config The gauge chart configuration object
@@ -24,12 +24,18 @@ export declare const setValueConversion: (valueConversion: ValueConversion, conf
 export declare const getFeatureIndex: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | undefined;
 /**
  * Sets the index of the feature to be rendered.
- * @param {number | null} featureIndex The index of the feature to be rendered
- * @param {ChartConfig<typeof ModelTypes.Gauge>} config The gauge chart configuration object
- * @param {LayerInfo} layerInfo The layer information
+ * @param {number | undefined} props.featureIndex The index of the feature to be rendered
+ * @param {ChartConfig<typeof ModelTypes.Gauge>} props.config The gauge chart configuration object
+ * @param {LayerInfo} props.layerInfo The layer information
+ * @param {CommonStrings} props.commonStrings The common strings
  * @remarks This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
  */
-export declare const setFeatureIndex: (featureIndex: number | null, config: ChartConfig<typeof ModelTypes.Gauge>, layerInfo: LayerInfo) => Promise<void>;
+export declare const setFeatureIndex: (props: {
+    featureIndex: number | null | undefined;
+    config: ChartConfig<typeof ModelTypes.Gauge>;
+    layerInfo: LayerInfo;
+    commonStrings: CommonStrings;
+}) => void;
 /**
  * Gets the type of Gauge chart, like FeatureGauge and StatisticGauge.
  * @param {ChartConfig<typeof ModelTypes.Gauge>} config Tthe chart configuration

package/dist/model/heat-chart-model/heat-chart-model.d.ts

@@ -0,0 +1,47 @@
+import { WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartHeatChartSeries, WebChartLegendPositions } from '../../spec';
+import { ChartConfig } from '../../utils';
+import { ModelParams } from '../interfaces/chart-interfaces';
+import { LayerInfo, ModelTypes } from '../interfaces/common';
+import { ModelWithDataLabels, ModelWithTooltips } from '../mixins';
+import { SerialChartModel } from '../serial-chart-model/serial-chart-model';
+export type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
+export declare class HeatChartModel extends SerialChartModel {
+    generateChartTitle(): string;
+    /**
+     * Current configuration used for the Heat chart.
+     */
+    protected _config: ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
+    /**
+     * Default series for the heat chart. Used in resetting the series styling.
+     * @category Protected
+     */
+    protected defaultSeries: WebChartHeatChartSeries | undefined;
+    protected _chartType: "heatSeries";
+    protected layerInfo: LayerInfo;
+    setup(params: ModelParams<ChartConfig<typeof ModelTypes.HeatChart>>): Promise<void>;
+    get xField(): string | undefined;
+    set xField(xField: string | undefined);
+    get yField(): string | undefined;
+    set yField(yField: string | undefined);
+    get xTemporalBinning(): WebChartCalendarDatePartsBinning | undefined;
+    set xTemporalBinning(binning: WebChartCalendarDatePartsBinning | undefined);
+    get yTemporalBinning(): WebChartCalendarDatePartsBinning | undefined;
+    set yTemporalBinning(binning: WebChartCalendarDatePartsBinning | undefined);
+    get gridLineWidth(): number | undefined;
+    set gridLineWidth(width: number | undefined);
+    get gridLineColor(): number[] | undefined;
+    set gridLineColor(color: number[] | undefined);
+    get seriesName(): string | undefined;
+    set seriesName(seriesName: string | undefined);
+    get heatRulesType(): WebChartHeatChartHeatRulesTypes | undefined;
+    set heatRulesType(heatRulesTypes: WebChartHeatChartHeatRulesTypes | undefined);
+    get gradientRules(): WebChartHeatChartGradient | undefined;
+    set gradientRules(gradientRule: WebChartHeatChartGradient | undefined);
+    set legendTitleText(_: string);
+    get legendPosition(): WebChartLegendPositions;
+    set legendPosition(position: WebChartLegendPositions);
+    set rotatedState(_: boolean);
+    protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
+}
+export interface HeatChartModel extends ModelWithTooltips, ModelWithDataLabels {
+}

package/dist/model/heat-chart-model/utils/heat-chart-data.d.ts

@@ -0,0 +1,114 @@
+import { WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartLegendPositions } from '../../../spec';
+import { ChartConfig } from '../../../utils';
+import { LayerInfo, ModelTypes } from '../../interfaces/common';
+type HeatChartConfig = ChartConfig<typeof ModelTypes.HeatChart, WebChart>;
+/**
+ * Sets the x field
+ * @param xField The numeric field
+ * @param config The heat chart config
+ * @param layerInfo The layer info
+ */
+export declare const setXField: (props: {
+    xField?: string;
+    config: HeatChartConfig;
+    layerInfo: LayerInfo;
+}) => void;
+/**
+ * Gets the x field
+ * @param config the heat chart config
+ */
+export declare const getXField: (config: HeatChartConfig) => string | undefined;
+/**
+ * Sets the heat rule type
+ * @param config the chart config
+ * @param heatRulesTypes the heat rules types
+ */
+export declare const setHeatRulesType: (config: HeatChartConfig, heatRulesTypes?: WebChartHeatChartHeatRulesTypes) => void;
+/**
+ * Gets the heat rule type
+ * @param config the chart config
+ */
+export declare const getHeatRulesType: (config: HeatChartConfig) => WebChartHeatChartHeatRulesTypes | undefined;
+/**
+ * Sets the gradient rules
+ * @param config the chart config
+ * @param gradientRules the gradient rules
+ */
+export declare const setGradientRules: (config: HeatChartConfig, gradientRules?: WebChartHeatChartGradient) => void;
+/**
+ * Gets the gradient rules
+ * @param config the chart config
+ */
+export declare const getGradientRules: (config: HeatChartConfig) => WebChartHeatChartGradient | undefined;
+/**
+ * Sets the y field
+ * @param yField The numeric field
+ * @param config The heat chart config
+ * @param layerInfo The layer info
+ */
+export declare const setYField: (props: {
+    yField?: string;
+    config: HeatChartConfig;
+    layerInfo: LayerInfo;
+}) => void;
+/**
+ * Gets the y field
+ * @param config the heat chart config
+ */
+export declare const getYField: (config: HeatChartConfig) => string | undefined;
+/**
+ * Sets x binning
+ * @param binning the x binning
+ * @param config The heat chart config
+ */
+export declare const setXTemporalBinning: (binning: WebChartCalendarDatePartsBinning | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the x binning
+ * @param config the heat chart config
+ */
+export declare const getXTemporalBinning: (config: HeatChartConfig) => WebChartCalendarDatePartsBinning | undefined;
+/**
+ * Sets y binning
+ * @param binning the y binning
+ * @param config The heat chart config
+ */
+export declare const setYTemporalBinning: (binning: WebChartCalendarDatePartsBinning | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the y binning
+ * @param config the heat chart config
+ */
+export declare const getYTemporalBinning: (config: HeatChartConfig) => WebChartCalendarDatePartsBinning | undefined;
+/**
+ * Sets the grid line width
+ * @param width the grid line width
+ * @param config The heat chart config
+ */
+export declare const setGridLineWidth: (width: number | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the grid line width
+ * @param config the heat chart config
+ */
+export declare const getGridLineWidth: (config: HeatChartConfig) => number | undefined;
+/**
+ * Sets the grid line color
+ * @param color the grid line color
+ * @param config The heat chart config
+ */
+export declare const setGridLineColor: (newColor: number[] | undefined, config: HeatChartConfig) => void;
+/**
+ * Gets the grid line width
+ * @param config the heat chart config
+ */
+export declare const getGridLineColor: (config: HeatChartConfig) => import('../../..').Color | undefined;
+/**
+ * Sets the legend position
+ * @param position the legend position
+ * @param config The heat chart config
+ */
+export declare const setLegendPosition: (position: WebChartLegendPositions, config: HeatChartConfig) => void;
+/**
+ * Gets the legend position
+ * @param config the heat chart config
+ */
+export declare const getLegendPosition: (config: HeatChartConfig) => WebChartLegendPositions;
+export {};