Types
import type { CustomParametersMixin } from "@arcgis/core/layers/mixins/CustomParametersMixin.js";
Subclasses
AnnotationFeatureLayer, BuildingSceneLayer, CSVLayer, CatalogLayer, DimensionFeatureLayer, FeatureLayer, GaussianSplatLayer, GeoJSONLayer, ImageryLayer, ImageryTileLayer, IntegratedMesh3DTilesLayer, IntegratedMeshLayer, KnowledgeGraphLayer, MapImageLayer, OGCFeatureLayer, ParquetLayer, PointCloudLayer, SceneLayer, StreamLayer, SubtypeGroupLayer, TileLayer, VectorTileLayer, VideoLayer, VoxelLayer, WCSLayer, WFSLayer
Since
ArcGIS Maps SDK for JavaScript 4.18

Mixin that adds a property to layer types backed by ArcGIS services for storing user-defined parameters to be sent with all requests related to the layer

Properties

customParameters

Property
Type
CustomParameters | null | undefined

An object of custom parameters appended to the URL of all resources fetched by the layer. Each key-value pair has a string value. The layer's refresh() method needs to be called if the customParameters are updated at runtime.

Example
// send a custom parameter to your special service
let layer = new MapImageLayer({
url: serviceUrl,
customParameters: {
"key": "my-special-key"
}
});

Type definitions

CustomParameters

Type definition
Supertypes
Record<string‚ string>