Skip to content
Types
import type { ScaleRangeLayer } from "@arcgis/core/layers/mixins/ScaleRangeLayer.js";
Subclasses:
BaseDynamicLayer, BaseElevationLayer, BaseTileLayer, BuildingSceneLayer, CSVLayer, CatalogLayer, FeatureLayer, GaussianSplatLayer, GeoJSONLayer, GeoRSSLayer, GraphicsLayer, GroupLayer, ImageryLayer, ImageryTileLayer, IntegratedMesh3DTilesLayer, IntegratedMeshLayer, KMLLayer, KnowledgeGraphLayer, LinkChartLayer, MapImageLayer, MapNotesLayer, MediaLayer, OGCFeatureLayer, WebTileLayer, ParquetLayer, PointCloudLayer, RouteLayer, SceneLayer, StreamLayer, SubtypeGroupLayer, TileLayer, VectorTileLayer, VideoLayer, VoxelLayer, WCSLayer, WFSLayer, WMSLayer, WMTSLayer, CatalogDynamicGroupLayer, CatalogFootprintLayer, KnowledgeGraphSublayer

Mixin for layers that support scale ranges (minScale and maxScale)

Properties

PropertyTypeClass

maxScale

Property
Type
number

The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.

Default value
0
Examples
// The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000
layer.maxScale = 1000;
// The layer's visibility is not restricted to a maximum scale.
layer.maxScale = 0;

minScale

Property
Type
number

The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.

Default value
0
Examples
// The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000
layer.minScale = 3000000;
// The layer's visibility is not restricted to a minimum scale.
layer.minScale = 0;