@arcgis/charts-components 5.0.0-next.9 → 5.0.0-next.91

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

@@ -3,144 +3,166 @@ import { ISimpleFillSymbol, WebChartTextSymbol } from '../../../spec';
 import { ModelTypes } from '../../interfaces/common';
 /**
  * Gets the visibility of the needle.
- * @param config The chart configuration object
- * @returns {boolean}
- * @remarks If the needle or its visibility is not set, the default value of `true` will be returned.
+ *
+ * **Note**: If the needle or its visibility is not set, the default value of `true` will be returned.
+ *
+ * @param config - The chart configuration object
  */
 export declare const getNeedleVisibility: (config: ChartConfig<typeof ModelTypes.Gauge>) => boolean;
 /**
  * Sets the visibility of the needle.
- * @param visible The visibility to set for the needle
- * @param config The chart configuration object
- * @remarks If the needle is not set, it will be created with the default values.
+ *
+ * **Note**: If the needle is not set, it will be created with the default values.
+ *
+ * @param visible - The visibility to set for the needle
+ * @param config - The chart configuration object
  */
 export declare const setNeedleVisibility: (visible: boolean, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets the symbol of the needle.
- * @param config The chart configuration object
- * @returns {ISimpleFillSymbol | undefined}
+ *
+ * @param config - The chart configuration object
  */
 export declare const getNeedleSymbol: (config: ChartConfig<typeof ModelTypes.Gauge>) => ISimpleFillSymbol | undefined;
 /**
  * Sets the symbol of the needle.
- * @param symbol The symbol to set for the needle
- * @param config The chart configuration object
- * @remarks If the needle is not set, it will be created with the default values.
+ *
+ * **Note**: If the needle is not set, it will be created with the default values.
+ *
+ * @param symbol - The symbol to set for the needle
+ * @param config - The chart configuration object
  */
 export declare const setNeedleSymbol: (symbol: ISimpleFillSymbol | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets the start width of the needle.
- * @param config The chart configuration object
- * @returns {number | null | undefined}
+ *
+ * @param config - The chart configuration object
  */
 export declare const getNeedleStartWidth: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | null | undefined;
 /**
  * Sets the start width of the needle.
- * @param startWidth The start width to set for the needle
- * @param config The chart configuration object
- * @remarks If the needle is not set, it will be created with the default values.
+ *
+ * **Note**: If the needle is not set, it will be created with the default values.
+ *
+ * @param startWidth - The start width to set for the needle
+ * @param config - The chart configuration object
  */
 export declare const setNeedleStartWidth: (width: number | null | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets the end width of the needle.
- * @param config The chart configuration object
- * @returns {number | null | undefined}
+ *
+ * @param config - The chart configuration object
  */
 export declare const getNeedleEndWidth: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | null | undefined;
 /**
  * Sets the end width of the needle.
- * @param width The end width to set for the needle
- * @param config The chart configuration object
- * @remarks If the needle is not set, it will be created with the default values.
+ *
+ * **Note**: If the needle is not set, it will be created with the default values.
+ *
+ * @param width - The end width to set for the needle
+ * @param config - The chart configuration object
  */
 export declare const setNeedleEndWidth: (width: number | null | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets the inner radius of the needle.
- * @param config The chart configuration object
- * @returns {number | null | undefined}
+ *
+ * @param config - The chart configuration object
  */
 export declare const getNeedleInnerRadius: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | null | undefined;
 /**
  * Sets the inner radius of the needle.
- * @param innerRadius The inner radius to set for the needle
- * @param config The chart configuration object
- * @remarks If the needle is not set, it will be created with the default values.
+ *
+ * **Note**: If the needle is not set, it will be created with the default values.
+ *
+ * @param innerRadius - The inner radius to set for the needle
+ * @param config - The chart configuration object
  */
 export declare const setNeedleInnerRadius: (innerRadius: number | null | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets whether to display the pin for the needle.
- * @param config The chart configuration object
- * @returns {boolean}
+ *
+ * @param config - The chart configuration object
  */
 export declare const getNeedleDisplayPin: (config: ChartConfig<typeof ModelTypes.Gauge>) => boolean;
 /**
  * Sets whether to display the pin for the needle.
- * @param displayPin The visibility to set for the needle pin
- * @param config The chart configuration object
- * @remarks If the needle is not set, it will be created with the default values.
+ *
+ * ***Note**: If the needle is not set, it will be created with the default values.
+ *
+ * @param displayPin - The visibility to set for the needle pin
+ * @param config - The chart configuration object
  */
 export declare const setNeedleDisplayPin: (displayPin: boolean, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets whether the gauge inner label is visible.
- * @param config The chart configuration object
- * @returns {boolean}
+ *
+ * @param config - The chart configuration object
  */
 export declare const getInnerLabelVisible: (config: ChartConfig<typeof ModelTypes.Gauge>) => boolean;
 /**
  * Sets whether the gauge inner label is visible.
- * @param visible The visibility to set for the gauge inner label
- * @param config The chart configuration object
- * @remarks If the inner label is not set, it will be created with the default values.
+ *
+ * **Note**: If the inner label is not set, it will be created with the default values.
+ *
+ * @param visible - The visibility to set for the gauge inner label
+ * @param config - The chart configuration object
  */
 export declare const setInnerLabelVisibility: (visible: boolean, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets the content of the gauge inner label.
- * @param config The chart configuration object
- * @returns {WebChartTextSymbol | undefined}
+ *
+ * @param config - The chart configuration object
  */
 export declare const getInnerLabelContent: (config: ChartConfig<typeof ModelTypes.Gauge>) => WebChartTextSymbol | undefined;
 /**
  * Sets the content of the gauge inner label.
- * @param content The content to set for the gauge inner label
- * @param config The chart configuration object
- * @remarks If the inner label is not set, it will be created with the default values.
+ *
+ * **Note**: If the inner label is not set, it will be created with the default values.
+ *
+ * @param content - The content to set for the gauge inner label
+ * @param config - The chart configuration object
  */
 export declare const setInnerLabelContent: (content: WebChartTextSymbol | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets the visibility of the gauge axis ticks.
- * @param config The chart configuration object
- * @returns {boolean}
+ *
+ * @param config - The chart configuration object
  */
 export declare const getAxisTickVisibility: (config: ChartConfig<typeof ModelTypes.Gauge>) => boolean;
 /**
  * Sets the visibility of the gauge axis ticks.
- * @param visible The visibility to set for the gauge axis ticks
- * @param config The chart configuration object
- * @remarks If the ticks are not set, it will be created with the default values.
+ *
+ * **Note**: If the ticks are not set, it will be created with the default values.
+ *
+ * @param visible - The visibility to set for the gauge axis ticks
+ * @param config - The chart configuration object
  */
 export declare const setAxisTickVisibility: (visible: boolean, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets the increment between axis labels.
- * @param config The chart configuration object
- * @returns {number | undefined}
+ *
+ * @param config - The chart configuration object
  */
 export declare const getLabelsIncrement: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | undefined;
 /**
  * Sets the increment between axis labels.
- * @param increment The increment to set for the axis labels
- * @param config The chart configuration object
+ *
+ * @param increment - The increment to set for the axis labels
+ * @param config - The chart configuration object
  */
 export declare const setLabelsIncrement: (increment: number | undefined, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets whether to only show the first and last axis labels.
- * @param config The chart configuration object
- * @returns {boolean}
- * @remarks If the onlyShowFirstAndLastLabels is not set, the default value of `false` will be returned.
+ *
+ * **Note**: If the `onlyShowFirstAndLastLabels` is not set, the default value of `false` will be returned.
+ *
+ * @param config - The chart configuration object
  */
 export declare const getShowOnlyMinMaxLabels: (config: ChartConfig<typeof ModelTypes.Gauge>) => boolean;
 /**
  * Sets whether to only show the first and last axis labels.
- * @param showOnlyFirstAndLastLabels Indicator of whether to only show the first and last axis labels
- * @param config The chart configuration object
+ *
+ * @param showOnlyFirstAndLastLabels - Indicator of whether to only show the first and last axis labels
+ * @param config - The chart configuration object
  */
 export declare const setShowOnlyMinMaxLabels: (showOnlyFirstAndLastLabels: boolean, config: ChartConfig<typeof ModelTypes.Gauge>) => void;

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

@@ -10,15 +10,12 @@ export declare const updateSeries: (props: {
 }) => void;
 /**
  * Gets the aggregation type from the config.
+ *
  * @param config - the guage chart config
  */
 export declare const getAggregationType: (config: ChartConfig<typeof ModelTypes.Gauge>) => WebChartStatisticType;
 /**
  * Sets the aggregation type to the config.
- * @param props.aggregationType
- * @param props.config
- * @param props.layerInfo
- * @param props.commonStrings
  */
 export declare const setAggregationType: (props: {
     aggregationType: WebChartStatisticType;
@@ -29,23 +26,24 @@ export declare const setAggregationType: (props: {
 /**
  * Checks if the feature index is valid.
  *
- * NOTE: It should be a number and greater than or equal to 0.
- * @param { number | undefined } featureIndex - the feature index
+ * **Note**: It should be a number and greater than or equal to 0.
  *
- * @returns boolean
+ * @param featureIndex - the feature index
  */
 export declare const isValidFeatureIndex: (featureIndex?: number) => boolean;
 /**
- * Gets the field from the config
+ * Gets the field from the config.
+ *
  * @param config - the guage chart config
  */
 export declare const getField: (config: ChartConfig<typeof ModelTypes.Gauge>) => string;
 /**
- * Sets the field to the 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
+ * Sets the field to the 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: (props: {
     field: string;
@@ -54,40 +52,45 @@ export declare const setField: (props: {
     commonStrings: CommonStrings;
 }) => void;
 /**
- * Gets the inner radius from the config
+ * Gets the inner radius from the config.
+ *
  * @param config - the guage chart config
  */
 export declare const getInnerRadius: (config: ChartConfig<typeof ModelTypes.Gauge>) => number;
 /**
- * Sets the inner radius to the config
- * @param innerRadius The inner radius to set
- * @param config The guage chart config
+ * Sets the inner radius to the config.
+ *
+ * @param innerRadius - The inner radius to set
+ * @param config - The guage chart config
  */
 export declare const setInnerRadius: (innerRadius: number, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
- * Gets the start angle from the config
- * @param config The guage chart config
+ * Gets the start angle from the config.
+ *
+ * @param config - The guage chart config
  */
 export declare const getStartAngle: (config: ChartConfig<typeof ModelTypes.Gauge>) => number;
 /**
- * Sets the start angle to the config
- * @param startAngle The start angle to set
- * @param config The guage chart config
+ * Sets the start angle to the config.
+ *
+ * @param startAngle - The start angle to set
+ * @param config - The guage chart config
  */
 export declare const setStartAngle: (startAngle: number, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
- * Gets the end angle from the config
- * @param config The guage chart config
+ * Gets the end angle from the config.
+ *
+ * @param config - The guage chart config
  */
 export declare const getEndAngle: (config: ChartConfig<typeof ModelTypes.Gauge>) => number;
 /**
- * Sets the end angle to the config
- * @param endAngle The end angle to set
- * @param config The guage chart config
+ * Sets the end angle to the config.
+ *
+ * @param endAngle - The end angle to set
+ * @param config - The guage chart config
  */
 export declare const setEndAngle: (endAngle: number, config: ChartConfig<typeof ModelTypes.Gauge>) => void;
 /**
  * Gets the proper chart title given the current config.
- * @returns {string}
  */
 export declare function getChartTitle(commonStrings: CommonStrings): string;

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

@@ -2,33 +2,37 @@ 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
- * @param {ChartConfig<typeof ModelTypes.Gauge>} config The gauge chart configuration object
- * @returns {ValueConversion | undefined}
+ * Gets the conversion to apply to the gauge value.
+ *
+ * @param config - The gauge chart configuration object
  */
 export declare const getValueConversion: (config: ChartConfig<typeof ModelTypes.Gauge>) => ValueConversion | undefined;
 /**
- * Sets the conversion to apply to the gauge value
- * @param {ValueConversion} valueConversion The conversion to apply
- * @param {ChartConfig<typeof ModelTypes.Gauge>} config The gauge chart configuration object
+ * Sets the conversion to apply to the gauge value.
+ *
+ * @param valueConversion - The conversion to apply
+ * @param config - The gauge chart configuration object
  */
 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
- * @returns {number | undefined} 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)
+ * For feature-based gauge, if this property is not present, the first feature will be used (`featureIndex = 0`)
+ *
+ * @param config - The gauge chart configuration object
+ * @returns The index of the feature to be rendered
  */
 export declare const getFeatureIndex: (config: ChartConfig<typeof ModelTypes.Gauge>) => number | undefined;
 /**
  * Sets the index of the feature to be rendered.
- * @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).
+ *
+ * This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
+ *
+ * @param props.featureIndex - The index of the feature to be rendered
+ * @param props.config - The gauge chart configuration object
+ * @param props.layerInfo - The layer information
+ * @param props.commonStrings - The common strings
  */
 export declare const setFeatureIndex: (props: {
     featureIndex: number | null | undefined;
@@ -37,9 +41,10 @@ export declare const setFeatureIndex: (props: {
     commonStrings: CommonStrings;
 }) => void;
 /**
- * Gets the type of Gauge chart, like FeatureGauge and StatisticGauge.
- * @param {ChartConfig<typeof ModelTypes.Gauge>} config Tthe chart configuration
- * @returns {GaugeChartSubTypes}
- * @remarks When this property is not specified, it will be defaulted to GaugeChartSubTypes.StatisticGauge.
+ * Gets the type of Gauge chart, like `FeatureGauge` and `StatisticGauge`.
+ *
+ * When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
+ *
+ * @param config - The chart configuration
  */
 export declare const getGaugeSubType: (config: ChartConfig<typeof ModelTypes.Gauge>) => GaugeChartSubTypes;

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

@@ -1,7 +1,7 @@
-import { WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartHeatChartSeries, WebChartLegendPositions } from '../../spec';
+import { ISimpleFillSymbol, WebChart, WebChartCalendarDatePartsBinning, WebChartHeatChartGradient, WebChartHeatChartHeatRulesTypes, WebChartLegendPositions, WebChartNullCategory, WebChartNullPolicyTypes, WebChartStackedKinds, WebChartStatisticType, WebHeatChart } from '../../spec';
 import { ChartConfig } from '../../utils';
 import { ModelParams } from '../interfaces/chart-interfaces';
-import { LayerInfo, ModelTypes } from '../interfaces/common';
+import { LayerInfo, ModelTypes, SerialChartDataSortingKinds, HeatChartDataSortingKinds } 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>;
@@ -10,37 +10,146 @@ export declare class HeatChartModel extends SerialChartModel {
     /**
      * 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 _config: ChartConfig<typeof ModelTypes.HeatChart, WebHeatChart>;
     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);
+    /**
+     * The x axis field used by the heat chart
+     */
+    get xAxisField(): string;
+    set xAxisField(xField: string);
+    /**
+     * The y axis field used by the heat chart
+     */
+    get yAxisField(): string;
+    set yAxisField(yAxisField: string);
+    /**
+     * The x temporal binning used by the heat chart
+     */
     get xTemporalBinning(): WebChartCalendarDatePartsBinning | undefined;
     set xTemporalBinning(binning: WebChartCalendarDatePartsBinning | undefined);
+    /**
+     * The y temporal binning used by the heat chart
+     */
     get yTemporalBinning(): WebChartCalendarDatePartsBinning | undefined;
     set yTemporalBinning(binning: WebChartCalendarDatePartsBinning | undefined);
+    /**
+     * The hide empty rows and columns setting used by the heat chart
+     */
+    get hideEmptyRowsAndColumns(): boolean | undefined;
+    set hideEmptyRowsAndColumns(hideEmptyRowsAndColumns: boolean | undefined);
+    /**
+     * The grid line width used by the heat chart
+     */
     get gridLineWidth(): number | undefined;
     set gridLineWidth(width: number | undefined);
+    /**
+     * The grid line color used by the heat chart
+     */
     get gridLineColor(): number[] | undefined;
     set gridLineColor(color: number[] | undefined);
+    /**
+     * The name of the series that is used by the heat chart
+     */
     get seriesName(): string | undefined;
     set seriesName(seriesName: string | undefined);
+    /**
+     * The heat rules type used by the heat chart
+     */
     get heatRulesType(): WebChartHeatChartHeatRulesTypes | undefined;
     set heatRulesType(heatRulesTypes: WebChartHeatChartHeatRulesTypes | undefined);
+    /**
+     * The grandient rules used by the heat chart
+     */
     get gradientRules(): WebChartHeatChartGradient | undefined;
     set gradientRules(gradientRule: WebChartHeatChartGradient | undefined);
+    /**
+     * The numeric fields used by the heat chart. Only the first field in the array will be used.
+     * An empty string will be ignored.
+     */
+    get numericFields(): string[];
+    set numericFields(fields: string[]);
+    /**
+     * The aggregation type for the heat chart. Must be one of the values allowed by WebChartStatisticType.
+     */
+    get aggregationType(): WebChartStatisticType;
+    set aggregationType(aggregationType: WebChartStatisticType);
+    /**
+     * Split-by field is not used by heat chart
+     */
+    get splitByField(): string;
+    set splitByField(_: string);
+    /**
+     * The heat charts legend's title (not supported yet)
+     */
     set legendTitleText(_: string);
     get legendPosition(): WebChartLegendPositions;
+    /**
+     * The heat charts legend's position
+     */
     set legendPosition(position: WebChartLegendPositions);
-    set rotatedState(_: boolean);
+    get nullPolicy(): WebChartNullPolicyTypes | undefined;
+    /**
+     * The heat charts null policy
+     */
+    set nullPolicy(policy: WebChartNullPolicyTypes | undefined);
+    getSortOrder(): HeatChartDataSortingKinds | SerialChartDataSortingKinds;
+    /**
+     * setSortOrder is not used by heat chart; instead use setXAxisSortOrder for the x axis and setYAxisSortOrder for the y axis
+     */
+    setSortOrder(_newSortOrder: HeatChartDataSortingKinds | SerialChartDataSortingKinds, _orderByList?: string[]): void;
+    /**
+     * Get the sort order on the x axis for the heat chart.
+     * @returns {"Asc" | "Desc" | "customSort"}
+     */
+    getXAxisSortOrder(): HeatChartDataSortingKinds;
+    /**
+     * Sets the sort order on the x axis for the heat chart.
+     * @param {"Asc" | "Desc" | "customSort"}  newSortOrder The new sort order.
+     * @param {string[]} orderByList The list of category's values to order by.
+     */
+    setXAxisSortOrder(newSortOrder: HeatChartDataSortingKinds, orderByList?: string[]): void;
+    /**
+     * Gets the sort order for on the y axis for heat chart.
+     * @returns {"Asc" | "Desc" | "customSort"}
+     */
+    getYAxisSortOrder(): HeatChartDataSortingKinds;
+    /**
+     * Sets the sort order on the y axis for heat chart.
+     * @param {"Asc" | "Desc" | "customSort"}  newSortOrder The new sort order.
+     * @param {string[]} orderByList The list of category's values to order by.
+     */
+    setYAxisSortOrder(newSortOrder: HeatChartDataSortingKinds, orderByList?: string[]): void;
+    get emptyCellText(): string | undefined;
+    /**
+     * The heat charts empty cell text
+     */
+    set emptyCellText(text: string | undefined);
+    get emptyCellSymbol(): ISimpleFillSymbol | undefined;
+    /**
+     * The heat charts empty cell symbol
+     */
+    set emptyCellSymbol(symbol: ISimpleFillSymbol | undefined);
+    /**
+     * The heat chart's second axis (not supported)
+     */
+    setAssignToSecondValueAxis(_assign: boolean, _seriesIndex: number): void;
+    /**
+     * The heat chart's stacked type (not supported)
+     */
+    set stackedType(_stackedType: WebChartStackedKinds | undefined);
+    /**
+     * Bin temporal data for heat chart (not supported)
+     */
+    set binTemporalData(_: boolean);
+    /**
+     * The null category for heat chart (not supported)
+     */
+    set nullCategory(_: WebChartNullCategory);
+    /**
+     * Generates the default config for the heat chart
+     */
     protected generateDefaultConfig(): Omit<typeof this._config, "iLayer">;
 }
 export interface HeatChartModel extends ModelWithTooltips, ModelWithDataLabels {