@arcgis/charts-components 5.0.0-next.13 → 5.0.0-next.131

package/dist/model/chart-model/utils/format.d.ts

@@ -1,46 +0,0 @@
-import { Color, WebChartTextSymbol } from '../../../spec';
-import { ChartConfig } from '../../../utils';
-/**
- * Gets the title text symbol from the chart config.
- * @param config The chart config object
- */
-export declare const getTitleSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the title text symbol in the chart config.
- * @param config The chart config object
- * @param textSymbol The title symbol to set
- */
-export declare const setTitleSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
-/**
- * Gets the subtitle text symbol from the chart config.
- * @param config The chart config object
- */
-export declare const getSubtitleSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the subtitle text symbol in the chart config.
- * @param config The chart config object
- * @param textSymbol The subtitle symbol to set
- */
-export declare const setSubtitleSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
-/**
- * Gets the description text symbol from the chart config.
- * @param config The chart config object
- */
-export declare const getDescriptionSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the description text symbol in the chart config.
- * @param config The chart config object
- * @param textSymbol The description symbol to set
- */
-export declare const setDescriptionSymbol: (textSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;
-/**
- * Gets the background color from the chart config.
- * @param config The chart config object
- */
-export declare const getBackgroundColor: (config: ChartConfig) => Color | undefined;
-/**
- * Sets the background color in the chart config.
- * @param config The chart config object
- * @param backgroundColor The background color to set
- */
-export declare const setBackgroundColor: (backgroundColor: Color | undefined, config: ChartConfig) => void;

package/dist/model/chart-model/utils/general.d.ts

@@ -1,85 +0,0 @@
-import { IDrawingInfo } from '../../../spec';
-import { ChartConfig } from '../../../utils';
-/**
- * Gets the version of the chart configuration.
- * @returns {string}
- */
-export declare const getVersion: (config: ChartConfig) => string | undefined;
-/**
- * Gets the title text of the chart from the config
- * @param config The config object
- */
-export declare const getTitleText: (config: ChartConfig) => string;
-/**
- * Sets the title text of the chart
- * @param titleText The title text
- * @param config The config object
- */
-export declare const setTitleText: (titleText: string, config: ChartConfig) => void;
-/**
- * Gets the subtitle text of the chart from the config
- * @param config The config object
- */
-export declare const getSubtitleText: (config: ChartConfig) => string;
-/**
- * Sets the subtitle text of the chart
- * @param subtitleText The subtitle text
- * @param config The config object
- */
-export declare const setSubtitleText: (subtitleText: string, config: ChartConfig) => void;
-/**
- * Gets the description text
- * @param config The config object
- */
-export declare const getDescriptionText: (config: ChartConfig) => string;
-/**
- * Sets the description text of the chart
- * @param descriptionText  The description text
- * @param config The config object
- */
-export declare const setDescriptionText: (descriptionText: string, config: ChartConfig) => void;
-/**
- * Gets whether the chart title is visible.
- * @param config The config object
- */
-export declare const getChartTitleVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets whether to the chart title is visible.
- * @param visibility Whether or not to show the chart title
- * @param config The config object
- */
-export declare const setChartTitleVisibility: (visibility: boolean, config: ChartConfig) => void;
-/**
- * Gets whether the chart subtitle is visible.
- * @param config The config object
- */
-export declare const getChartSubtitleVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets whether to the chart subtitle is visible.
- * @param visibility Whether or not to show the chart subtitle
- * @param config The config object
- */
-export declare const setChartSubtitleVisibility: (visibility: boolean, config: ChartConfig) => void;
-/**
- * Gets whether the description is visible.
- * @param config The config object
- */
-export declare const getDescriptionVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets whether the description is visible.
- * @param visibility Whether or not to show the description
- * @param config The config object
- */
-export declare const setDescriptionVisibility: (visibility: boolean, config: ChartConfig) => void;
-/**
- * Gets the chart renderer from the chart config.
- * @param config  The chart config
- * @returns {IDrawingInfo["renderer"] | undefined} The chart renderer if defined, otherwise undefined.
- */
-export declare const getChartRenderer: (config: ChartConfig) => IDrawingInfo["renderer"] | undefined;
-/**
- * Sets the chart renderer in the chart config.
- * @param renderer The chart renderer to set.
- * @param config The chart config to set the renderer on.
- */
-export declare const setChartRenderer: (renderer: IDrawingInfo["renderer"] | undefined, config: ChartConfig) => void;

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

@@ -1,35 +0,0 @@
-import { WebChartSeriesType, NumberFormatOptions } from '../../../spec';
-import { ChartConfig } from '../../../utils';
-/**
- * Gets the series id from the config
- */
-export declare const getSeriesId: (seriesIndex: number, config: ChartConfig) => string | undefined;
-/**
- * Gets the series index from the config
- */
-export declare const getSeriesIndex: (seriesId: string, config: ChartConfig) => number | undefined;
-/**
- * Gets the length of the series from the config
- */
-export declare const getSeriesLength: (config: ChartConfig) => number;
-/**
- * Gets the visibility of a series from the config
- */
-export declare const getSeriesVisibility: (seriesIndex: number, config: ChartConfig) => boolean;
-/**
- * Returns the data tooltip value format for a series.
- * @param  {WebChartSeriesType[]} series The chart series
- * @param {number} seriesIndex The index of the series to retrieve the value format for
- */
-export declare function getDataTooltipValueFormat(series: WebChartSeriesType[], seriesIndex: number): NumberFormatOptions | undefined;
-/**
- * Sets the data tooltip value format for a series.
- * @param {WebChartSeriesType[]} props.series - The chart series
- * @param {number} props.seriesIndex - The index of the series to set the value format for
- * @param {NumberFormatOptions | undefined} props.valueFormat - The value format to set
- */
-export declare function setDataTooltipValueFormat(props: {
-    series: WebChartSeriesType[];
-    seriesIndex: number;
-    valueFormat: NumberFormatOptions | undefined;
-}): void;

package/dist/model/mixins/model-with-baseline-stacking.d.ts

@@ -1,21 +0,0 @@
-import { ChartConfig } from '../../utils';
-import { ChartModel } from '../chart-model/chart-model';
-import { ModelTypes } from '../interfaces/common';
-export declare abstract class ModelWithBaselineStacking extends ChartModel {
-    protected _config: ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
-    /**
-     * Specify how negative values are treated in stacked series.
-     * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
-     * @param {number} seriesIndex - The index of the series.
-     * @default true
-     * @returns {boolean}
-     */
-    isNegativeValuesStackedToBaseline(seriesIndex: number): boolean;
-    /**
-     * Specify how negative values are treated in stacked series.
-     * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
-     * @param {boolean} stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
-     * @param {number} seriesIndex - The index of the series.
-     */
-    setNegativeValuesStackedToBaseline(stackNegativeValuesToBaseline: boolean, seriesIndex: number): void;
-}

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

@@ -1,47 +0,0 @@
-import { ISimpleLineSymbol, WebChartTextSymbol } from '../../spec';
-import { ChartModel } from '../chart-model/chart-model';
-export declare abstract class ModelWithBasicXAxis extends ChartModel {
-    /**
-     * The x-axis title text.
-     */
-    get xAxisTitleText(): string;
-    set xAxisTitleText(newXAxisTitleText: string);
-    /**
-     * Whether the x-axis title is visible.
-     * true: X-axis title is visible.
-     * false: X-axis title is hidden.
-     */
-    get xAxisTitleVisibility(): boolean;
-    set xAxisTitleVisibility(newXAxisTitleVisibility: boolean);
-    /**
-     * Maximum bound set for the x-axis. Null indicates no explicit maximum.
-     */
-    get maxXBound(): number | null;
-    set maxXBound(newMaxXBound: number | null);
-    /**
-     * Minimum bound set for the x-axis. Null indicates no explicit minimum.
-     */
-    get minXBound(): number | null;
-    set minXBound(newMinXBound: number | null);
-    /**
-     * X-axis title text symbol (font, color, style).
-     */
-    get xAxisTitleSymbol(): WebChartTextSymbol | undefined;
-    set xAxisTitleSymbol(newXAxisTitle: WebChartTextSymbol | undefined);
-    /**
-     * Axis labels text symbol (font, color, style).
-     */
-    get axisLabelsSymbol(): WebChartTextSymbol | undefined;
-    set axisLabelsSymbol(newAxisLabelsSymbol: WebChartTextSymbol | undefined);
-    /**
-     * Axis lines symbol (line width, style, color).
-     */
-    get axisLinesSymbol(): ISimpleLineSymbol | undefined;
-    set axisLinesSymbol(newAxisLinesSymbol: ISimpleLineSymbol | undefined);
-    /**
-     * Generate the proper x-axis title from the current config.
-     *
-     * @returns {string}
-     */
-    abstract generateXAxisTitle(): string;
-}

package/dist/model/mixins/model-with-color-match.d.ts

@@ -1,12 +0,0 @@
-import { ChartModel } from '../chart-model/chart-model';
-export declare abstract class ModelWithColorMatch extends ChartModel {
-    /**
-     * Whether the chart should attempt to match the data source's colors.
-     *
-     * `true`: Attempt to match the data source's colors.
-     *
-     * `false`: Use the colors defined in the config.
-     */
-    get colorMatch(): boolean;
-    set colorMatch(newColorMatch: boolean);
-}

package/dist/model/mixins/model-with-data-labels.d.ts

@@ -1,15 +0,0 @@
-import { WebChartTextSymbol } from '../../spec';
-import { ChartModel } from '../chart-model/chart-model';
-export declare abstract class ModelWithDataLabels extends ChartModel {
-    /**
-     * Whether data labels are visible.
-     * true: visible, false: hidden.
-     */
-    get dataLabelsVisibility(): boolean;
-    set dataLabelsVisibility(newDataLabelsVisibility: boolean);
-    /**
-     * Data labels text symbol (font, color, style).
-     */
-    get dataLabelsSymbol(): WebChartTextSymbol | undefined;
-    set dataLabelsSymbol(newDataLabelsSymbol: WebChartTextSymbol | undefined);
-}

package/dist/model/mixins/model-with-rotation.d.ts

@@ -1,8 +0,0 @@
-import { ChartModel } from '../chart-model/chart-model';
-export declare abstract class ModelWithRotation extends ChartModel {
-    /**
-     * Whether the chart is rotated.
-     */
-    get rotatedState(): boolean;
-    set rotatedState(rotated: boolean);
-}

package/dist/model/mixins/utils/baseline-stacking.d.ts

@@ -1,23 +0,0 @@
-import { ChartConfig } from '../../../utils';
-import { ModelTypes } from '../../interfaces/common';
-/**
- * Specify how negative values are treated in stacked series.
- *  * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- * @default true
- * @returns {boolean}
- */
-export declare const isNegativeValuesStackedToBaseline: (seriesIndex: number, config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>) => boolean;
-/**
- * Specify how negative values are treated in stacked series.
- * **Note:** If true, negative values will be stacked on the base line. If false, negative values will be stacked in relation to their previous values in the stack.
- * @param {boolean} stackNegativeValuesToBaseline - `true` if negative values should be stacked on the base line, `false` otherwise.
- * @param {number} seriesIndex - The index of the series.
- * @param {ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>} config - The chart configuration.
- */
-export declare const setNegativeValuesStackedToBaseline: (props: {
-    stackNegativeValuesToBaseline: boolean;
-    seriesIndex: number;
-    config: ChartConfig<typeof ModelTypes.ComboBarLineChart> | ChartConfig<typeof ModelTypes.LineChart> | ChartConfig<typeof ModelTypes.RadarChart>;
-}) => void;

package/dist/model/mixins/utils/color-match.d.ts

@@ -1,14 +0,0 @@
-import { ChartConfig } from '../../../utils';
-/**
- * Gets the color match.
- *
- * @param config the chart configuration
- */
-export declare const getColorMatch: (config: ChartConfig) => boolean;
-/**
- * Sets the color match by updating the config accordingly.
- *
- * @param newColorMatch the new color match value
- * @param config the chart configuration
- */
-export declare const setColorMatch: (newColorMatch: boolean, config: ChartConfig) => void;

package/dist/model/mixins/utils/data-labels.d.ts

@@ -1,24 +0,0 @@
-import { ChartConfig } from '../../../utils';
-import { WebChartTextSymbol } from '../../../spec';
-/**
- * Gets the data labels visibility from the chart config.
- * @param config
- */
-export declare const getDataLabelsVisibility: (config: ChartConfig) => boolean;
-/**
- * Sets the data labels visibility in the chart config.
- * @param config
- * @param newDataLabelsVisibility
- */
-export declare const setDataLabelsVisibility: (newDataLabelsVisibility: boolean, config: ChartConfig) => void;
-/**
- * Gets the data labels text symbol from the chart config.
- * @param config
- */
-export declare const getDataLabelsSymbol: (config: ChartConfig) => WebChartTextSymbol | undefined;
-/**
- * Sets the data labels text symbol in the chart config.
- * @param config
- * @param newDataLabelsSymbol
- */
-export declare const setDataLabelsSymbol: (newDataLabelsSymbol: WebChartTextSymbol | undefined, config: ChartConfig) => void;

package/dist/test/chart-rendering/test-utils/utils.d.ts

@@ -1,15 +0,0 @@
-/**
- * Provides a way to mock a private function.
- *
- * @param privateFunctionFolder The folder under src containing the private function
- * @param functionName The function to mock
- * @param mockedImplementation The mocked implementation
- */
-export declare function mockPrivateFunction(privateFunctionFolder: string, functionName: string, mockedImplementation: any): Promise<void>;
-/**
- * Resets the mocked implementation of a specific private function
- *
- * @param functionFolder The folder under src containing the private function
- * @param functionName The function to mock
- */
-export declare function resetMockFunction(functionFolder: string, functionName: string): void;

package/dist/test/utils/test-utils/utils.d.ts

@@ -1,13 +0,0 @@
-/**
- * Provides a way to mock a function from the src folder.
- * @param functionFolder The folder under src containing the private function
- * @param functionName The function to mock
- * @param mockedImplementation The mocked implementation
- */
-export declare function mockFunction(functionFolder: string, functionName: string, mockedImplementation: any): Promise<void>;
-/**
- * Resets the mocked implementation of a specific private function
- * @param functionFolder The folder under src containing the private function
- * @param functionName The function to mock
- */
-export declare function resetMockFunction(functionFolder: string, functionName: string): void;

package/dist/types/preact10.d.ts

@@ -1,45 +0,0 @@
-/// <reference types="../index.d.ts" />
-import type { ArcgisChart } from "../components/arcgis-chart";
-import type { ArcgisChartsActionBar } from "../components/arcgis-charts-action-bar";
-import { JSX as PreactJsx } from "preact";
-import type { EventHandler } from "@arcgis/lumina";
-
-/** @deprecated Update to Preact 10.27.2+ or 11+ and consume types/preact file over types/preact10 */
-interface PreactArcgisChart extends Partial<Pick<ArcgisChart, 'actionMode' | 'allowUsingObjectIdStat' | 'autoDisposeChart' | 'autoInverseDataLabelTextColor' | 'chartIndex' | 'chartLimits' | 'chartWillRender' | 'cursorRange' | 'dataLabelFormatter' | 'disableTogglingLegendItems' | 'enableConfiguration' | 'enableResponsiveFeatures' | 'errorPolicy' | 'featureIndex' | 'filterByExtent' | 'filterBySelection' | 'gaugeInnerLabelFormatter' | 'guideTooltipFormatter' | 'hideEmptySeries' | 'hideLicenseWatermark' | 'hideLoaderAnimation' | 'ignoreSmoothRenderingLimit' | 'ignoreViewExtent' | 'layer' | 'layerFieldsChangePolicy' | 'layerFilterChangePolicy' | 'layerItemId' | 'layerRendererChangePolicy' | 'legendPosition' | 'legendValueLabelFormatter' | 'legendVisibility' | 'loaderColors' | 'model' | 'nullAsValid' | 'placeholder' | 'queueChartCreation' | 'replaceNoValueCategoryWithZero' | 'returnFeaturesExtent' | 'returnSelectionIndexes' | 'returnSelectionOIDs' | 'rotation' | 'runtimeDataFilters' | 'secondaryYAxisLabelFormatter' | 'selectionData' | 'selectionTheme' | 'setTimeBinningInfoWhenNotProvided' | 'showUIMessages' | 'syncSelection' | 'syncSelectionsBetweenChartAndLayerViewPolicy' | 'timeZone' | 'tooltipFormatter' | 'updateSplitBySeries' | 'useAnimatedCharts' | 'usePopupTemplateFieldsInfo' | 'view' | 'viewTimeExtentChangePolicy' | 'xAxisLabelFormatter' | 'yAxisLabelFormatter'>>, ArcgisChartSetterTypes, PreactJsx.HTMLAttributes<HTMLArcgisChartElement> {
-  onarcgisAxesMinMaxChange?: EventHandler<HTMLArcgisChartElement["arcgisAxesMinMaxChange"]>;
-  onarcgisBadDataWarningRaise?: EventHandler<HTMLArcgisChartElement["arcgisBadDataWarningRaise"]>;
-  onarcgisChartNotFoundWarning?: EventHandler<HTMLArcgisChartElement["arcgisChartNotFoundWarning"]>;
-  onarcgisConfigChange?: EventHandler<HTMLArcgisChartElement["arcgisConfigChange"]>;
-  onarcgisDataFetchComplete?: EventHandler<HTMLArcgisChartElement["arcgisDataFetchComplete"]>;
-  onarcgisDataProcessComplete?: EventHandler<HTMLArcgisChartElement["arcgisDataProcessComplete"]>;
-  onarcgisDataProcessError?: EventHandler<HTMLArcgisChartElement["arcgisDataProcessError"]>;
-  onarcgisLegendItemVisibilityChange?: EventHandler<HTMLArcgisChartElement["arcgisLegendItemVisibilityChange"]>;
-  onarcgisNoRenderPropChange?: EventHandler<HTMLArcgisChartElement["arcgisNoRenderPropChange"]>;
-  onarcgisRuntimeError?: EventHandler<HTMLArcgisChartElement["arcgisRuntimeError"]>;
-  onarcgisSelectionComplete?: EventHandler<HTMLArcgisChartElement["arcgisSelectionComplete"]>;
-  onarcgisSeriesColorChange?: EventHandler<HTMLArcgisChartElement["arcgisSeriesColorChange"]>;
-  onarcgisSeriesOrder?: EventHandler<HTMLArcgisChartElement["arcgisSeriesOrder"]>;
-  onarcgisUpdateComplete?: EventHandler<HTMLArcgisChartElement["arcgisUpdateComplete"]>;
-}
-type ArcgisChartSetterTypes = ArcgisChart["_setterTypes"]
-
-/** @deprecated Update to Preact 10.27.2+ or 11+ and consume types/preact file over types/preact10 */
-interface PreactArcgisChartsActionBar extends Partial<Pick<ArcgisChartsActionBar, 'actionBarSelectionMode' | 'chartElement' | 'chartType' | 'clearSelectionState' | 'clearSelectionTitle' | 'clearSelectionToggle' | 'disableCSVExportForChartTypes' | 'editChartState' | 'editChartTitle' | 'editChartToggle' | 'expanded' | 'exportActionState' | 'exportAsCSVState' | 'exportAsCSVTitle' | 'exportAsImageState' | 'exportAsImageTitle' | 'filterByExtentState' | 'filterByExtentTitle' | 'filterByExtentToggle' | 'filterBySelectionState' | 'filterBySelectionTitle' | 'filterBySelectionToggle' | 'forceDisableActions' | 'fullExtentState' | 'fullExtentTitle' | 'fullExtentToggle' | 'hiddenActions' | 'legendState' | 'legendTitle' | 'legendToggle' | 'messageOverrides' | 'rotateChartState' | 'rotateChartTitle' | 'rotateChartToggle' | 'selectionState' | 'selectionTitle' | 'selectionToggle' | 'switchSelectionState' | 'switchSelectionTitle' | 'switchSelectionToggle' | 'zoomState' | 'zoomTitle' | 'zoomToggle'>>, PreactJsx.HTMLAttributes<HTMLArcgisChartsActionBarElement> {
-  onarcgisActionBarToggle?: EventHandler<HTMLArcgisChartsActionBarElement["arcgisActionBarToggle"]>;
-  onarcgisDefaultActionSelect?: EventHandler<HTMLArcgisChartsActionBarElement["arcgisDefaultActionSelect"]>;
-}
-
-declare module 'preact' {
-  namespace createElement.JSX {
-    interface IntrinsicElements {
-      "arcgis-chart": PreactArcgisChart;
-      "arcgis-charts-action-bar": PreactArcgisChartsActionBar;
-    }
-  }
-  namespace h.JSX {
-    interface IntrinsicElements {
-      "arcgis-chart": PreactArcgisChart;
-      "arcgis-charts-action-bar": PreactArcgisChartsActionBar;
-    }
-  }
-}