import { regenerateRenderer } from "@arcgis/core/smartMapping/renderers/support/rendererUtils.js";const { regenerateRenderer } = await $arcgis.import("@arcgis/core/smartMapping/renderers/support/rendererUtils.js");- Since
- ArcGIS Maps SDK for JavaScript 4.31
This module provides a function for regenerating renderers based on the current state of the layer and view. This is useful when you want to update a renderer based on changes to the layer's data, the data visible in the view, binning configuration, or the view's scale.
- See also
Functions
| Name | Return Type | Object |
|---|---|---|
| | ||
| |
regenerateRenderer
Regenerates the renderer for a layer based on the current state of the layer and view.
- Signature
-
regenerateRenderer (params: RegenerateRendererParameters): Promise<RendererUnion>
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| params | An object containing the following properties. | |
- Returns
- Promise<RendererUnion>
Returns a promise that resolves with the updated renderer.
Type definitions
RegenerateRendererParameters
- Supertypes
- AbortOptions
renderer
- Type
- RendererUnion | undefined
The renderer to update. If not provided, the renderer will be derived from the layer or feature reduction object.
filter
- Type
- FeatureFilter | undefined
When defined, only features included in the filter
are considered in the attribute and spatial statistics calculations when determining the final renderer.
This is useful when a lot of variation exists in the data
that could result in undesired data ranges. A common use case would be to set a filter that only
includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
geometry filters with an intersects spatial relationship are supported. All other filter types (including where) are ignored.
This parameter is only supported when forBinning is false.
includedParts
- Type
- ("color-variable" | "size-variable" | "class-breaks")[] | undefined
- Since
- ArcGIS Maps SDK for JavaScript 4.33
An array of strings indicating which parts of the renderer to include in the regeneration. If not provided, all parts are included by default. The available options are:
color-variable: Only regenerate the color visual variable.size-variable: Only regenerate the size visual variable.class-breaks: Regenerate the class breaks for the renderer.