arcgis-slider-heatmap-legacy | References | ArcGIS Maps SDK for JavaScript

ESM

import "@arcgis/map-components/components/arcgis-slider-heatmap-legacy";

Inheritance:: ArcgisSliderHeatmapLegacy→PublicLitElement

Since: ArcGIS Maps SDK for JavaScript 5.0

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 Heatmap Slider component is intended for authoring and exploring data-driven visualizations in any layer that can be rendered with a HeatmapRenderer.

See the image below for a summary of the configurable options available on this slider.

Heatmap Slider with annotations

const viewElement = document.querySelector("arcgis-map")!;
const heatmapSlider = document.querySelector("arcgis-slider-heatmap-legacy")!;

const layer = new CSVLayer({
  url: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_week.csv",
});

await viewElement.viewOnReady();
viewElement.map?.add(layer);

const params = {
  layer,
  valueExpression: "($feature.mag)",
  view: viewElement.view,
};

const rendererResult = await heatmapRendererCreator.createRenderer(params);

layer.renderer = rendererResult.renderer;

heatmapSlider.stops = rendererResult.renderer.colorStops;

This slider should be used to update the colorStops property in a HeatmapRenderer. It is the responsibility of the app developer to set up event listeners on this slider to update the renderer's colorStops based on how the stops property was recalculated.

const updateRendererFromSlider = () => {
  const renderer = layer.renderer?.clone();
  if (!renderer || !("colorStops" in renderer)) {
    return;
  }
  renderer.colorStops = heatmapSlider.stops;
  layer.renderer = renderer;
};

heatmapSlider.addEventListener("arcgisThumbChange", updateRendererFromSlider);
heatmapSlider.addEventListener("arcgisThumbDrag", updateRendererFromSlider);
heatmapSlider.addEventListener("arcgisPropertyChange", updateRendererFromSlider);

See also

heatmapRendererCreator

Demo

Properties

Property	Attribute	Type
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`icon`	`icon`	`IconName`
`max` readonly		`number`
`min` readonly		`number`
`precision`	`precision`	`number`
`referenceElement`	`reference-element`	`ArcgisReferenceElement \| string \| undefined`
`state` readonly		`SmartMappingSliderBaseState`
`stops`		`Array<HeatmapColorStop>`

autoDestroyDisabled

Property

Type: boolean

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() method when you are done to prevent memory leaks.

Attribute: auto-destroy-disabled
Default value: false

icon

Property

Type: IconName

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

Calcite Icons

Attribute: icon

max

readonly Property

Type: number

The maximum value or upper bound of the slider.

min

readonly Property

Type: number

The minimum value or lower bound of the slider.

precision

Property

Type: 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.

Attribute: precision
Default value: 4

Example

// Rounds slider thumb values to 7 decimal places
slider.precision = 7;

referenceElement

Property

Type: ArcgisReferenceElement | string | undefined

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 also

Associate components with a Map or Scene component

Attribute: reference-element

state

readonly Property

Type: SmartMappingSliderBaseState

The current state of the component.

stops

Property

Type: Array<HeatmapColorStop>

The color stops of the HeatmapRenderer to associate with the slider.

Example

heatmapSlider.stops = rendererResult.renderer.colorStops;

Methods

Method	Signature
`componentOnReady` inherited	`componentOnReady(): Promise<this>`
`destroy`	`destroy(): Promise<void>`

componentOnReady

inherited Method

Signature: componentOnReady (): Promise<this>

Inherited from: PublicLitElement

Creates a promise that resolves once the component is fully loaded.

Returns: Promise<this>

Example

const arcgisSliderHeatmapLegacy = document.querySelector("arcgis-slider-heatmap-legacy");
document.body.append(arcgisSliderHeatmapLegacy);
await arcgisSliderHeatmapLegacy.componentOnReady();
console.log("arcgis-slider-heatmap-legacy is ready to go!");

destroy

Method

Signature: destroy (): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

Events

Name	Type
`arcgisPropertyChange`	CustomEvent<{ name: "precision" \| "state" \| "stops"; }>
`arcgisReady`	CustomEvent<void>
`arcgisThumbChange`	CustomEvent<ThumbChangeEvent>
`arcgisThumbDrag`	CustomEvent<ThumbDragEvent>

arcgisPropertyChange

Event

arcgisPropertyChange: CustomEvent<{ name: "precision" | "state" | "stops"; }>

Emitted when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event

arcgisReady: CustomEvent<void>

Emitted when the component associated with a map or scene view is ready to be interacted with.

arcgisThumbChange

Event

arcgisThumbChange: CustomEvent<ThumbChangeEvent>

Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.

arcgisThumbDrag

Event

arcgisThumbDrag: CustomEvent<ThumbDragEvent>

Fires when a user drags a thumb on the component.