@arcgis/map-components
Version:
ArcGIS Map Components
406 lines (405 loc) • 22 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type SizeVariable from "@arcgis/core/renderers/visualVariables/SizeVariable.js";
import type SizeStop from "@arcgis/core/renderers/visualVariables/support/SizeStop.js";
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { ContinuousRendererResult } from "@arcgis/core/smartMapping/renderers/size.js";
import type { HistogramResult } from "@arcgis/core/smartMapping/statistics/types.js";
import type { ArcgisReferenceElement, IconName } from "../types.js";
import type { ThumbDragEvent, ThumbChangeEvent } from "@arcgis/core/widgets/Slider/types.js";
import type { HistogramConfig, ZoomOptions } from "@arcgis/core/widgets/smartMapping/types.js";
import type { LabelFormatFunction, InputParseFunction } from "@arcgis/core/widgets/types.js";
import type { SizeSliderStyle } from "@arcgis/core/widgets/smartMapping/SizeSlider.js";
import type { SmartMappingSliderBaseState } from "@arcgis/core/widgets/smartMapping/SmartMappingSliderBase.js";
/**
* > [!WARNING]
* >
* > This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.
* >
* > A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.
*
* The Size Slider component is intended for authoring and exploring data-driven visualizations in any
* layer that can be rendered with a [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/).
*
* See the image below for a summary of the configurable options available on this slider.
*
* 
*
* The [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including
* [max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#min), [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)
* intervals, and the slider's histogram after the renderer has been created from the result of the
* [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer) method.
*
* ```js
* const sizeRendererCreator = await import("@arcgis/core/smartMapping/renderers/size.js");
* const viewElement = document.querySelector("arcgis-map")!;
* const sizeSlider = document.querySelector("arcgis-slider-size-legacy")!;
*
* const featureLayer = new FeatureLayer({
* url: "https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/USA_Major_Cities_/FeatureServer/0",
* });
*
* await viewElement.viewOnReady();
* viewElement.map?.add(featureLayer);
*
* const params = {
* layer: featureLayer,
* view: viewElement.view,
* field: "POPULATION",
* };
*
* const rendererResult = await sizeRendererCreator.createContinuousRenderer(params);
*
* featureLayer.renderer = rendererResult.renderer;
*
* const histogramResult = await histogram({
* ...params,
* numBins: 30,
* });
*
* sizeSlider.updateFromRendererResult(rendererResult, histogramResult);
* ```
*
* This slider should be used to update a [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)
* in a layer's renderer. It is the responsibility of the app developer
* to set up event listeners that update the size variable of the appropriate renderer.
*
* ```js
* const updateRendererFromSlider = () => {
* const renderer = featureLayer.renderer?.clone();
* if (!renderer || !("visualVariables" in renderer) || !renderer.visualVariables?.[0]) {
* return;
* }
*
* const sizeVariable = renderer.visualVariables[0];
* const updatedSizeVariable = sizeSlider.updateVisualVariable(sizeVariable);
* if (!updatedSizeVariable) {
* return;
* }
*
* renderer.visualVariables = [updatedSizeVariable];
* featureLayer.renderer = renderer;
* };
*
* sizeSlider.addEventListener("arcgisThumbChange", updateRendererFromSlider);
* sizeSlider.addEventListener("arcgisThumbDrag", updateRendererFromSlider);
* sizeSlider.addEventListener("arcgisPropertyChange", updateRendererFromSlider);
* ```
*
* @since 5.0
* @see [sizeRendererCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/)
*/
export abstract class ArcgisSliderSizeLegacy extends LitElement {
/**
* If true, the component will not be destroyed automatically when it is
* disconnected from the document. This is useful when you want to move the
* component to a different place on the page, or temporarily hide it. If this
* is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#destroy) method when you are done to
* prevent memory leaks.
*
* @default false
*/
accessor autoDestroyDisabled: boolean;
/**
* The histogram associated with the data represented on the slider. The bins are typically
* generated using the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/) statistics function.
*
* @example
* ```js
* const histogramResult = await histogram({
* layer: featureLayer,
* field: "fieldName",
* numBins: 30,
* });
*
* slider.histogramConfig = {
* bins: histogramResult.bins
* };
* ```
* @see [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
*/
accessor histogramConfig: HistogramConfig | null | undefined;
/**
* Icon which represents the component.
* Typically used when the component is controlled by another component (e.g. by the Expand component).
*
* @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
*/
accessor icon: IconName;
/**
* A function used to format user inputs. As opposed to [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#labelFormatFunction), which formats
* thumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins
* to edit them.
*
* The image below demonstrates how slider input values resemble corresponding slider values by default
* and won't match the formatting set in `labelFormatFunction`.
*
* 
*
* If you want to format slider input values so they match thumb labels, you can pass the same function set in `labelFormatFunction` to
* `inputFormatFunction` for consistent formatting.
*
* 
*
* However, if an `inputFormatFunction` is specified, you must also write a corresponding
* [inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#inputParseFunction) to parse user inputs to understandable slider values. In most cases, if
* you specify an `inputFormatFunction`, you should set the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#labelFormatFunction) to the same value
* for consistency between labels and inputs.
*
* This property overrides the default input formatter, which formats by calling `toString()` on the input value.
*
*
* @see [inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#inputParseFunction)
* @example
* ```js
* // Formats the slider input to abbreviated numbers with units
* // e.g. a thumb at position 1500 will render with an input label of 1.5k
* slider.inputFormatFunction = (value: number): string => {
* if (value >= 1000000) {
* return (value / 1000000).toPrecision(3) + "m";
* }
* if (value >= 100000) {
* return (value / 1000).toPrecision(3) + "k";
* }
* if (value >= 1000) {
* return (value / 1000).toPrecision(2) + "k";
* }
* return value.toFixed(0);
* };
* ```
*/
accessor inputFormatFunction: LabelFormatFunction | null | undefined;
/**
* Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#inputFormatFunction).
* This property must be set if an `inputFormatFunction` is set. Otherwise the slider values will
* likely not update to their expected positions.
*
* Overrides the default input parses, which is a parsed floating point number.
*
* @see [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#inputFormatFunction)
* @example
* ```js
* // Parses the slider input (a string value) to a number value understandable to the slider
* // This assumes the slider was already configured with an inputFormatFunction
* // For example, if the input is 1.5k this function will parse
* // it to a value of 1500
* colorSlider.inputParseFunction = (value: string): number => {
* const charLength = value.length;
* const valuePrefix = parseFloat(value.substring(0, charLength - 1));
* const finalChar = value.substring(charLength - 1);
*
* if (parseFloat(finalChar) >= 0) {
* return parseFloat(value);
* }
* if (finalChar === "k") {
* return valuePrefix * 1000;
* }
* if (finalChar === "m") {
* return valuePrefix * 1000000;
* }
* return parseFloat(value);
* };
* ```
*/
accessor inputParseFunction: InputParseFunction | null | undefined;
/**
* A function used to format labels on the thumbs, min, max, and average values. Overrides the default label formatter. This function also supports date formatting.
*
* @example
* ```js
* // For thumb values, rounds each label to whole numbers
* slider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {
* return (type === "value") ? value.toFixed(0) : value.toString();
* };
* ```
*/
accessor labelFormatFunction: LabelFormatFunction | null | undefined;
/**
* The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method,
* the user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer
* to set up event listeners that update the size variable of the appropriate renderer.
*
* @example
* ```js
* sizeSlider.max = 150;
* ```
*/
accessor max: number;
/**
* The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method,
* the user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer
* to set up event listeners that update the size variable of the appropriate renderer.
*
* @example
* ```js
* sizeSlider.min = -150;
* ```
*/
accessor min: number;
/**
* Defines how slider thumb values should be rounded. This number indicates the number
* of decimal places slider thumb _values_ should round to when they have been moved.
*
* Keep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.
*
* @default 4
* @example
* ```js
* // Rounds slider thumb values to 7 decimal places
* slider.precision = 7;
* ```
*/
accessor precision: number;
/**
* By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
*
* @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
*/
accessor referenceElement: ArcgisReferenceElement | string | undefined;
/**
* Exposes various properties of the slider that can be styled. The result object from the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer)
* method can be used to match the `trackFillColor` to the current layer symbology.
*
* @see [Color](https://developers.arcgis.com/javascript/latest/references/core/Color/)
* @example
* ```js
* sizeSlider.sliderStyle = {
* trackFillColor: rendererResult.renderer.classBreakInfos[0].symbol.color ?? new Color([149, 149, 149]),
* trackBackgroundColor: new Color([224, 224, 224]),
* };
* ```
*/
accessor sliderStyle: SizeSliderStyle;
/** The current state of the component. */
get state(): SmartMappingSliderBaseState;
/**
* The size stops from the [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/) to link to the slider.
*
* @see [updateVisualVariable()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateVisualVariable)
* @example
* ```js
* sizeSlider.stops = [
* { value: 0, size: 4 },
* { value: 100, size: 8 },
* { value: 1000, size: 16 },
* { value: 10000, size: 32 },
* ];
* ```
*/
accessor stops: Array<SizeStop>;
/**
* Zooms the slider track to the bounds provided in this property. When min and/or max zoom values are provided, the absolute [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#min) and
* [max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#max) slider values are preserved and rendered at their typical positions on the slider. However, the
* slider track itself is zoomed so that thumbs cannot be moved above or below the provided min and max zoomed values.
*
* When a slider is in a zoomed state, the zoomed ends of the track will appear jagged. In the image below, notice how the
* top thumb cannot be moved past the zoom max of `31` even though the slider max is `200`.
*
* 
*
* To exit a zoomed state, the user can click the jagged line or the developer can set the `zoomOptions` to `null`. It
* is up to the developer to provide a UI option for end users to enable zooming on the slider.
*
* Setting the `zoomOptions` is useful when the slider is tied to heavily skewed datasets where the histogram renders only one or two bars because of outliers.
*
* 
*
* You can remove the influence of outliers by zooming the slider and regenerating a histogram based on the zoomed min and max. This will provide a better view of the data
* and make the slider more useful to the end user.
*
* @example
* ```js
* // zooms the slider so thumbs can only be moved to positions between
* // values of 10 and 25 while maintaining the slider's absolute min and max values
* slider.zoomOptions = {
* min: 10,
* max: 25
* };
* ```
* @example
* ```js
* // disables zooming on the slider
* slider.zoomOptions = null;
* ```
* @example
* ```js
* // zooms the slider so thumbs can only be moved to positions above
* // value of 10 while maintaining the slider's absolute min value
* slider.zoomOptions = {
* min: 10
* };
* ```
* @example
* ```js
* // zooms the slider so thumbs can only be moved to positions below
* // value of 25 while maintaining the slider's absolute max value
* slider.zoomOptions = {
* max: 25
* };
* ```
*/
accessor zoomOptions: ZoomOptions | null | undefined;
/** Permanently destroy the component. */
destroy(): Promise<void>;
/**
* A convenience function used to update the properties of a SizeSlider component instance from the
* [result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#ContinuousRendererResult) of
* the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer)
* method. This method is used to configure an empty SizeSlider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.
* Note that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.
*
* @param rendererResult - The result object from the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer)
* method.
* @param histogramResult - The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)
* method.
* @example
* ```js
* const rendererResult = await sizeRendererCreator.createContinuousRenderer(params);
*
* featureLayer.renderer = rendererResult.renderer;
*
* const histogramResult = await histogram({
* ...params,
* numBins: 30,
* });
*
* sizeSlider.updateFromRendererResult(rendererResult, histogramResult);
* ```
*/
updateFromRendererResult(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): void;
/**
* A convenience function used to update the [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)
* to match the values of the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#stops) on the slider.
* The slider stops are automatically updated internally when the user drags a thumb slider.
*
* This is particularly useful for Size visual variables that have a set
* [minDataValue](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/#minDataValue) and
* [maxDataValue](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/#minDataValue).
* This method will properly reconstruct the variable to set on the renderer so it matches the stops on the slider.
*
* @param sizeVariable - The size visual variable
* from the renderer to update to the set [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#stops) on the slider.
* @returns Returns the updated visual variable
* to set back on the renderer.
* @example
* ```js
* const renderer = featureLayer.renderer?.clone();
* const sizeVariable = renderer.visualVariables[0];
* const updatedSizeVariable = sizeSlider.updateVisualVariable(sizeVariable);
* ```
*/
updateVisualVariable(sizeVariable: SizeVariable): null | undefined | SizeVariable;
/** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "histogramConfig" | "max" | "min" | "precision" | "sliderStyle" | "state" | "stops" | "zoomOptions"; }>;
/** Emitted when the component associated with a map or scene view is ready to be interacted with. */
readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
/** Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider. */
readonly arcgisThumbChange: import("@arcgis/lumina").TargetedEvent<this, ThumbChangeEvent>;
/** Fires when a user drags a thumb on the component. */
readonly arcgisThumbDrag: import("@arcgis/lumina").TargetedEvent<this, ThumbDragEvent>;
readonly "@eventTypes": {
arcgisPropertyChange: ArcgisSliderSizeLegacy["arcgisPropertyChange"]["detail"];
arcgisReady: ArcgisSliderSizeLegacy["arcgisReady"]["detail"];
arcgisThumbChange: ArcgisSliderSizeLegacy["arcgisThumbChange"]["detail"];
arcgisThumbDrag: ArcgisSliderSizeLegacy["arcgisThumbDrag"]["detail"];
};
}