VoxelLayer | References | ArcGIS Maps SDK for JavaScript

import VoxelLayer from "@arcgis/core/layers/VoxelLayer.js";

Inheritance:: VoxelLayer→Layer→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.22

Overview

A voxel layer represents multidimensional volumetric data. For example, atmospheric or oceanic data, geological underground models, or space-time cubes can be visualized as voxel layer. The VoxelLayer can be visualized in a SceneView with the viewingMode set to local.

Use voxel layers to explore spatial relationships with other content. For example, an underground model visualized as a voxel layer can be viewed together with buildings or subterrain utilities to evaluate the underground for planned construction or maintenance.

voxel-layer

Known Limitations

VoxelLayer requires the EXT_color_buffer_float extension.
Visualizing voxels with data type INT16 or UINT16 additionally requires the EXT_texture_norm16 extension, which is currently only supported by the Chrome browser.
Visualizing voxels with data type FLOAT32 additionally requires the OES_texture_float_linear extension.
For best performance, use Chrome browser and a dedicated graphics card.
Mobile support differs across devices. Voxel scene layers are not recommended for use on mobile.
Measurement widget for both distance and area allows you to choose a point in a voxel layer. However, the point selection and measurement may not be accurate.

Creating a VoxelLayer

From ArcGIS Pro, you can author a voxel layer and publish it as a Scene Service. Scene Services can be hosted on ArcGIS Online or ArcGIS Enterprise by uploading a Scene Layer Package (.slpk) or by sharing it from ArcGIS Pro.

The Scene Service is identified by a service URL or portal item ID and can be used to create an instance of a VoxelLayer.

Reference a service URL

To create a VoxelLayer instance from a service, you must set the url property to the REST endpoint of a VoxelLayer. For a layer to be visible in a view, it must be added to the Map.

const voxelLayer = new VoxelLayer({
   url: "https://tiles.arcgis.com/tiles/z2tnIkrLQ2BRzr6P/arcgis/rest/services/EMU_Caribbean_Voxel/SceneServer"
});
const map = new Map({
   layers: [voxelLayer],
   basemap: {
     baseLayers: [
       new VectorTileLayer({
         url: "https://basemaps.arcgis.com/arcgis/rest/services/OpenStreetMap_GCS_v2/VectorTileServer"
       })
     ]
   }
});

If the voxel service is requested from a different domain, a CORS enabled server or a proxy is required.

Reference an ArcGIS portal Item ID

You can also create a VoxelLayer from the portal item ID.

const voxelLayer = new VoxelLayer({
   portalItem: {
     id: "3a922ed0c7a8489ea4fbe8747ac560ba"
   },
});

Data Visualization

Voxel layers can be visualized as volumes or surfaces using the property renderMode. When set to surfaces, only isosurfaces and sections are displayed, whereas volume draws the full volume.

A voxel layer contains variables representing continuous or discrete data. For example, permeability could be defined as a continuous variable and soil type as a discrete variable. Voxel layer only visualizes one variable at a time. A VoxelVariable describes a single variable in the VoxelLayer. The currentVariableId controls which variable is being rendered.

You can define how a continuous or discrete variable can be rendered. You can apply a data filter to, modify the color scheme of, or add transparency to a continuous variable by using VoxelTransferFunctionStyle. For a discrete variable, you can modify the color and label by using uniqueValues.

Exploring a Voxel Layer

Voxel layers often cover large areas. There are various capabilities you can use to explore the voxel layer in detail.

VoxelSlice

Use VoxelSlice to define an area of interest. You can slice a voxel layer vertically to show a smaller volume, or horizontally slice to reduce the voxel layer to a specific height.

It is possible to have multiple slices in a VoxelLayer by modifying the VoxelVolumeStyle's slices or by authoring slices in ArcGIS Pro before publishing the voxel layer as a scene service.

Slices modified using VoxelVolumeStyle's slices and the slices authored from ArcGIS Pro are persistent in the web scene or layer definition respectively.

Position, tilt and orientation of a VoxelSlice can be modified with real-time rendering updates.

voxellayer_voxelslice

VoxelDynamicSection

A section is a plane which cuts through a voxel volume. Sections can reveal valuable information, such as soil composition and contamination across a subsurface profile. The VoxelDynamicSection allows you to define the properties of an individual dynamic section. You can create VoxelDynamicSection to understand structures in the voxel layer. For example, you can create a cross section diagram to explore an underground model at locations where new construction is planned. VoxelDynamicSection can only be visualized when the renderMode is set to surfaces.

Position, tilt and orientation of a VoxelDynamicSection can be modified with real-time rendering updates.

voxellayer_dynamicsection

VoxelIsosurface

A VoxelIsosurface is a surface representing a specific value within a continuous variable. For example, you can visualize a threshold value for pollutants in the atmosphere as an isosurface. This allows you to identify the location of key values. You can visualize isosurfaces together with sections. VoxelIsosurface can only be visualized when the renderMode is set to surfaces.

By default, the color of an isosurface matches the color in the colorStops for the specific value. You can choose a different color and lock the color by using the property colorLocked in VoxelIsosurface. You can have up to four isosurfaces in a voxel layer.

voxellayer_isosurface

Analysis Tool

The Slice, DirectLineMeasurement3D and AreaMeasurement3D works with VoxelLayer.

Slice

The VoxelLayer treats the slice as an infinite plane and ignores the slice plane extent.

Slice widget allows you to interactively modify a single slice. The visualization created using the Slice widget are temporary and cannot be persisted in a WebScene or in slides.

Below is a comparison between the VoxelSlice and the Slice widget.

	VoxelSlice	Slice widget
Persisted	yes	no
Editable	yes (by modifying the properties of the VoxelSlice)	yes
Multiple slices	yes (by modifying VoxelVolumeStyle's slices)	no

Measurement

The DirectLineMeasurementAnalysis and AreaMeasurementAnalysis and their related components allow selecting points on the VoxelLayer to measure. However, the selection of the points and the measurement results may not be accurate. The measurement results include the verticalExaggeration applied to the VoxelLayer.

Popup

You can explore the properties of individual voxels by creating a customized popup using the popupTemplate. Use the fields to list all available fields that can be used to customize the popup of a VoxelLayer.

VoxelLayer Volume

The voxel layer is structured in dimensional regularly gridded cubes that store one or many variables.

A voxel layer can represent different dimensions. The volumeType property in VoxelVolume defines the dimension of the voxel layer.

X, Y, Z in which each dimension represents a geographic coordinate

voxellayer_xyz

X, Y, T in which X and Y represent a geographic coordinate and T represents time as a level

voxellayer_xyt

X, Y, Z, T in which each dimension represents geographic coordinates and includes a fourth dimension representing time.

voxellayer_xyzt

VoxelLayer and time

A VoxelLayer enables the visualization of time as the fourth dimension if the volumeType is "xyzt". A volumeType of "xyt" is not a time-aware layer. The time is represented along the z dimension.

You can access the temporal data of a VoxelLayer by using the stops in the TimeInfo. The stops indicates time instants that a layer has data for. You can use the stops with the TimeSlider widget or use it to configure the VoxelLayer's timeExtent.

The layer and the view can have a different TimeExtent. The useViewTime determines if the VoxelLayer will show the data based on the view's timeExtent or the layer's timeExtent.

The table below shows an example of how the VoxelLayer chooses the data to draw when the useViewTime is used in conjunction with the view's and the layer's timeExtent.

For example, a VoxelLayer has the following stops on the timeInfo:

[0] 2019-06-01 12

[1] 2019-07-01 12

[2] 2019-08-01 12

useViewTime	view's timeExtent	VoxelLayer's timeExtent	VoxelLayer will draw the data
true	not set	not set	[0] 2019-06-01 12 AM
true	not set	From 2019-07-01 12 AM to 2019-07-01 12 AM	[1] 2019-07-01 12 AM
true	From 2019-06-15 12 AM to 2019-07-15 12 AM	not set	[1] 2019-07-01 12 AM
true	From 2019-06-15 12 AM to 2019-07-15 12 AM	From 2019-08-01 12 AM to 2019-08-01 12 AM	VoxelLayer will not draw because the view's timeExtent does not intersect the VoxelLayer's timeExtent
false	not set	not set	[0] 2019-06-01 12 AM
false	not set	From 2019-07-01 12 AM to 2019-07-01 12 AM	[1] 2019-07-01 12 AM
false	From 2019-06-15 12 AM to 2019-07-15 12 AM	not set	[0] 2019-06-01 12 AM
false	From 2019-06-15 12 AM to 2019-07-15 12 AM	From 2019-08-01 12 AM to 2019-08-01 12 AM	[2] 2019-08-01 12 AM

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`VoxelLayerProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Example

// Typical usage
let layer = new VoxelLayer({
// URL to the service
url: "your voxel service url"
});

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`apiKey` inherited	`string \| null \| undefined`	APIKeyMixin
`copyright` inherited	`string \| null \| undefined`	SceneService
`currentVariableId`	`number`
`customParameters` inherited	`CustomParameters \| null \| undefined`	CustomParametersMixin
`declaredClass` readonly inherited	`string`	Accessor
`enableDynamicSections`	`boolean`
`enableIsosurfaces`	`boolean`
`enableSlices`	`boolean`
`fields` readonly	`Field[]`
`fullExtent` inherited	`Extent \| null \| undefined`	Layer
`id` inherited	`string`	Layer
`layerId` inherited	`number`	SceneService
`legendEnabled`	`boolean`
`listMode` inherited	`LayerListMode`	Layer
`loaded` readonly inherited	`boolean`	Layer
`loadError` readonly inherited	`EsriError \| null \| undefined`	LoadableMixin
`loadStatus` readonly inherited	`"not-loaded" \| "loading" \| "failed" \| "loaded"`	LoadableMixin
`loadWarnings` readonly inherited	`any[]`	LoadableMixin
`maxScale` inherited	`number`	ScaleRangeLayer
`minScale` inherited	`number`	ScaleRangeLayer
`opacity` inherited	`number`	Layer
`parent` inherited	`Map \| Basemap \| Ground \| GroupLayer \| CatalogDynamicGroupLayer \| CatalogLayer \| null \| undefined`	Layer
`persistenceEnabled` inherited	`boolean`	OperationalLayer
`popupEnabled`	`boolean`
`popupTemplate`	`PopupTemplate \| null \| undefined`
`portalItem` inherited	`PortalItem \| null \| undefined`	PortalLayer
`renderMode`	`VoxelRenderMode`
`spatialReference` inherited	`SpatialReference`	SceneService
`timeExtent`	`TimeExtent \| null \| undefined`
`timeInfo` readonly	`TimeInfo \| null \| undefined`
`timeOffset`	`TimeInterval \| null \| undefined`
`title` inherited	`string \| null \| undefined`	Layer
`type` readonly	`"voxel"`
`uid` readonly inherited	`string`	IdentifiableMixin
`url` inherited	`string \| null \| undefined`	SceneService
`useViewTime`	`boolean`
`variables` readonly	`Collection<VoxelVariable>`
`variableStyles`	`Collection<VoxelVariableStyle>`
`version` readonly inherited	`SceneServiceVersion`	SceneService
`visibilityTimeExtent` inherited	`TimeExtent \| null \| undefined`	Layer
`visible` inherited	`boolean`	Layer
`volumes` readonly	`Collection<VoxelVolume>`
`volumeStyles`	`Collection<VoxelVolumeStyle>`

apiKey

inherited Property

Type: string | null | undefined

Inherited from: APIKeyMixin

An authorization string used to access a resource or service. This property will append the API key to all requests made by the layer to the service. API keys are generated and managed in the portal. An API key is tied explicitly to an ArcGIS account; it is also used to monitor service usage. Setting a fine-grained API key on a specific class overrides the global API key.

If loading a secure layer with API authentication via a PortalItem, the API key needs to be set on the layer's portalItem property.

See also

Example

// set the api key to access a protected service
const layer = new FeatureLayer({
  url: serviceUrl,
  apiKey: "YOUR_API_KEY"
});

copyright

inherited Property

Type: string | null | undefined

Inherited from: SceneService

The copyright text as defined by the scene service.

currentVariableId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 4.24

The variable that is being displayed. The currentVariableId must be the id of a VoxelVariable that is in the variables collection of the VoxelLayer.

Default value: 0

customParameters

inherited Property

Type: CustomParameters | null | undefined

Inherited from: CustomParametersMixin

A list of custom parameters appended to the URL of all resources fetched by the layer. It's an object with key-value pairs where value is a string. 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"
  }
});

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

enableDynamicSections

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.25

Controls whether or not to globally disable all dynamic sections in the current VoxelVolumeStyle.

Default value: true

enableIsosurfaces

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.25

Controls whether or not to globally disable all isosurfaces in the current VoxelVariableStyle.

Default value: true

enableSlices

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.25

Controls whether or not to globally disable all slices in the current VoxelVolumeStyle.

Default value: true

fields

readonly Property

Type: Field[]

Since: ArcGIS Maps SDK for JavaScript 4.31

A complete list of fields that consists of fixed voxel fields and the voxel variables. This list is used for the layer's popupTemplate.

The fixed voxel fields used in popups represent the voxel's position, current variable being displayed, depth and time. These fields are prefixed with Voxel. to indicate that they are special fields and to avoid any potential conflict with voxel variable fields.

Below is a list of fixed fields that exists for all VoxelLayer depending on the voxel's volume.

Fixed voxel fields

The Voxel.CurrentVariable field returns the current variable being displayed.
The Voxel.Position field returns the clicked voxel's position.
The Voxel.Depth field returns the depth of the clicked voxel. (Only applicable for XYZ and XYZT volumeType).
The Voxel.LocalTime field returns the local date and/or time of the clicked voxel if the VoxelLayer has a time dimension. (Only applicable for XYT and XYZT volumeType).
The Voxel.SourceTime field returns the source time of the clicked voxel if the VoxelLayer has a time dimension. (Only applicable for XYT and XYZT volumeType).

Example

layer.when(() => {
  // print out field names returned in layer.fields
  layer.fields.forEach((field) => {
    console.log(field.name);
  });
});

fullExtent

autocast inherited Property

Type: Extent | null | undefined

Inherited from: Layer

The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below.

The fullExtent property is always null for GroupLayer.

Example

// Once the layer loads, set the view's extent to the layer's full extent
layer.when(function(){
  view.extent = layer.fullExtent;
});

id

inherited Property

Type: string

Inherited from: Layer

The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.

layerId

inherited Property

Type: number

Inherited from: SceneService

The layer ID, or layer index, of a Scene Service layer. This is particularly useful when loading a single layer with the portalItem property from a service containing multiple layers. You can specify this value in one of two scenarios:

When loading the layer via the portalItem property.
When pointing the layer url directly to the Scene Service.

If a layerId is not specified in either of the above scenarios, then the first layer in the service (layerId = 0) is selected.

Examples

// while these examples use a SceneLayer, the same pattern can be
// used for other layers that may be loaded from portalItem ids

// loads the third layer in the given Portal Item
let layer = new SceneLayer({
  portalItem: {
    id: "73df987984b24094b848d580eb83b0fb"
  },
  layerId: 2
});

// If not specified, the first layer (layerId: 0) will be returned
let layer = new SceneLayer({
  portalItem: {
    id: "73df987984b24094b848d580eb83b0fb"
  }
});

// Can also be used if URL points to service and not layer
let layer = new SceneLayer({
  url: "https://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer",
  layerId: 0  // Notice that the url doesn't end with /2
});

// This code returns the same layer as the previous snippet
let layer = new SceneLayer({
  url: "https://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer/layers/0",
  // The layer id is specified in the URL
});

legendEnabled

Property

Type: boolean

Indicates whether the layer will be included in the legend.

Default value: true

listMode

inherited Property

Type: LayerListMode

Inherited from: Layer

Indicates how the layer should display in the Layer List component. The possible values are listed below.

Value	Description
show	The layer is visible in the table of contents.
hide	The layer is hidden in the table of contents.
hide-children	If the layer is a GroupLayer, BuildingSceneLayer, KMLLayer, MapImageLayer, SubtypeGroupLayer, TileLayer, or WMSLayer, hide the children layers from the table of contents.

Default value: "show"

loaded

readonlyinherited Property

Type: boolean

Inherited from: Layer

Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.

Default value: false

loadError

readonlyinherited Property

Type: EsriError | null | undefined

Inherited from: LoadableMixin

The Error object returned if an error occurred while loading.

loadStatus

readonlyinherited Property

Type: "not-loaded" | "loading" | "failed" | "loaded"

Inherited from: LoadableMixin

Represents the status of a load() operation.

Value	Description
not-loaded	The object's resources have not loaded.
loading	The object's resources are currently loading.
loaded	The object's resources have loaded without errors.
failed	The object's resources failed to load. See loadError for more details.

Default value: "not-loaded"

loadWarnings

readonlyinherited Property

Type: any[]

Inherited from: LoadableMixin

A list of warnings which occurred while loading.

maxScale

inherited Property

Type: number

Inherited from: ScaleRangeLayer

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

inherited Property

Type: number

Inherited from: ScaleRangeLayer

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;

opacity

inherited Property

Type: number

Inherited from: Layer

The opacity of the layer. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.

Known Limitations

In a 3D SceneView, modifying opacity is not supported for DimensionLayer, GaussianSplatLayer, IntegratedMesh3DTilesLayer, IntegratedMeshLayer, LineOfSightLayer, PointCloudLayer, ViewshedLayer, and VoxelLayer.

Default value: 1

Example

// Makes the layer 50% transparent
layer.opacity = 0.5;

parent

inherited Property

Type: Map | Basemap | Ground | GroupLayer | CatalogDynamicGroupLayer | CatalogLayer | null | undefined

Inherited from: Layer

Since: ArcGIS Maps SDK for JavaScript 4.27

The parent to which the layer belongs.

persistenceEnabled

inherited Property

Type: boolean

Inherited from: OperationalLayer

Since: ArcGIS Maps SDK for JavaScript 4.28

Enable persistence of the layer in a WebMap or WebScene.

Default value: true

popupEnabled

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.26

Indicates whether to display popups when voxels in the layer are clicked. The layer needs to have a popupTemplate to define what information should be displayed in the popup. Alternatively, a default popup template may be automatically used if defaultPopupTemplateEnabled is set to true.

Default value: false

popupTemplate

autocast Property

Type: PopupTemplate | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.31

The popup template for the layer. When set on the layer, the popupTemplate allows users to access attributes and display their values using text and/or charts in the view's popup when a voxel is clicked. See this sample for an example of how PopupTemplate interacts with a VoxelLayer.

A default popup template is automatically used if no popupTemplate has been defined when defaultPopupTemplateEnabled is set to true.

See also

portalItem

autocast inherited Property

Type: PortalItem | null | undefined

Inherited from: PortalLayer

The portal item from which the layer is loaded. If the portal item references a feature or scene service, then you can specify a single layer to load with the layer's layerId property.

Loading non-spatial tables

Non-spatial tables can be loaded from service items hosted in ArcGIS Online and ArcGIS Enterprise. This only applies to:

FeatureLayer if the layer's isTable returns true at version 4.17.
SubtypeGroupLayer if the layer's isTable returns true at version 4.32.

Examples

// While this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids.
const layer = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }  // the first layer in the service is returned
});

// Set hostname when using an on-premise portal (default is ArcGIS Online)
// esriConfig.portalUrl = "http://myHostName.esri.com/arcgis";

// While this example uses FeatureLayer, this same pattern can be
// used for SceneLayers.
const layer = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});

// Initialize GeoJSONLayer by referencing a portalItem id pointing to geojson file.
const layer = new GeoJSONLayer({
  portalItem: new PortalItem({
    id: "81e769cd7031482797e1b0768f23c7e1",
    // optionally define the portal, of the item.
    // if not specified, the default portal defined is used.
    // see https://developers.arcgis.com/javascript/latest/references/core/config/#portalUrl
    portal: new Portal({
      url: "https://jsapi.maps.arcgis.com/"
    })
  }
});

// This snippet loads a table hosted in ArcGIS Online.
const table = new FeatureLayer({
  portalItem: { // autocasts as esri/portal/PortalItem
    id: "123f4410054b43d7a0bacc1533ceb8dc"
  }
});

// Before adding the table to the map, it must first be loaded and confirm it is the right type.
table.load().then(() => {
  if (table.isTable) {
    map.tables.add(table);
  }
});

// While this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids.
const layer = new FeatureLayer({
  portalItem: { // autocasts as esri/portal/PortalItem
    id: "caa9bd9da1f4487cb4989824053bb847",
    // Set an API key to access a secure portal item configured with API key authentication.
    apiKey: "APIKEY"
  }
});

renderMode

Property

Type: VoxelRenderMode

Since: ArcGIS Maps SDK for JavaScript 4.24

Current rendering mode for the VoxelLayer. The volume mode draws the full voxel layer volume whereas the surfaces mode draws dynamic sections and isosurfaces only.

Default value: "volume"

spatialReference

autocast inherited Property

Type: SpatialReference

Inherited from: SceneService

The spatial reference of the layer.

timeExtent

autocast Property

Type: TimeExtent | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.30

The layer's time extent. When the layer's useViewTime is false, the layer instructs the view to show data from the layer based on this time extent. You can choose the layer's time extent from the voxel layer's timeInfo.stops.

Example

// Configure the layer to ignore the view's time and instead
// draw using the data from its last time stop
vxlLayer.useViewTime = false;
const lastStopTime = vxlLayer.timeInfo.stops.at(-1);
vxlLayer.timeExtent = new TimeExtent({
   start: lastStopTime,
   end: lastStopTime,
});

timeInfo

readonly Property

Type: TimeInfo | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.30

TimeInfo provides information such as stops the layer has data for and the fullTimeExtent for the layer.

Example

// Configure the timeSlider to use the layer's timeInfo.stops
const vxlLayer = new VoxelLayer({
   url: url,
});
const map = new Map({
   layers: [vxlLayer]
});
const view = new SceneView({
   map: map,
   container: "viewDiv"
});
const timeSlider = new TimeSlider({
   container: "timeSlider",
   view: view,
   mode: "instant",
   playRate: 3000
});
view.whenLayerView(vxlLayer).then((vxlLayerView) => {
   timeSlider.fullTimeExtent = vxlLayer.timeInfo.fullTimeExtent;
   timeSlider.stops = {
     dates: vxlLayer.timeInfo.stops
   };
});

timeOffset

autocast Property

Type: TimeInterval | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.30

A temporary offset of the time data based on a certain TimeInterval. This allows users to overlay data from two or more time-aware layers with different time extents. For example, if a layer has data recorded for the year 1970, an offset value of 2 years would temporarily shift the data to 1972. You can then overlay this data with data recorded in 1972. A time offset can be used for display purposes only. The data shown in popups are not affected by the offset.

Example

// Offset a Voxel layer, adding 2 years
let vxlLayer = new VoxelLayer({
   url: url,
   timeOffset: {
     unit: "years",
     value: 2
   }
})

title

inherited Property

Type: string | null | undefined

Inherited from: Layer

The title of the layer used to identify it in places such as the Layer List component.

If the layer is loaded from a portal item, the title of the portal item will be used. If a layer is loaded as part of a webmap or a webscene, then the title of the layer as stored in the webmap/webscene will be used.

type

readonly Property

Type: "voxel"

The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules.

uid

readonlyinherited Property

Type: string

Inherited from: IdentifiableMixin

Since: ArcGIS Maps SDK for JavaScript 4.33

An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.

url

inherited Property

Type: string | null | undefined

Inherited from: SceneService

The URL of the REST endpoint of the layer or scene service. The URL may either point to a resource on ArcGIS Enterprise or ArcGIS Online.

The layer may be specified using the layerId property when the url points directly to a service and not a specific layer. If layerId is not specified, then it will default to the first layer in the service.

Examples

// Layer from Scene Service on ArcGIS Server
let sceneLayer = new SceneLayer({
  url: "https://services.arcgis.com/V6ZHFr6zdgNZuVG0/arcgis/rest/services/Paris_3D_Local_WSL2/SceneServer/layers/0"
});

// Can also be used if URL points to service and not layer
let layer = new SceneLayer({
  // Notice that the url doesn't end with /0
  url: "https://scenesampleserverdev.arcgis.com/arcgis/rest/services/Hosted/DevA_Trees/SceneServer",
  layerId: 0
});

useViewTime

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.30

Determines if the layer will update its temporal data based on the view's timeExtent. When false, the layer will display its temporal data based on the layer's timeExtent, regardless of changes to the view. If both view and layer time extents are set while this property is true, then the data that fall within the intersection of the view and layer time extents will be displayed. For example, if a layer's time extent is set to display the data between 1970 and 1975 and the view has a time extent set to 1972-1980, the effective time on the voxel layer will be 1972-1975.

Default value: true

Example

if (vxlLayer.useViewTime) {
   console.log("Displaying data between:", view.timeExtent.start, " - ", view.timeExtent.end)
}

variables

readonly Property

Type: Collection<VoxelVariable>

Since: ArcGIS Maps SDK for JavaScript 4.24

The collection of variables that the VoxelLayer has data for.

variableStyles

autocast Property

Type: Collection<VoxelVariableStyle>

Since: ArcGIS Maps SDK for JavaScript 4.25

The collection of variable styles, containing exactly one VoxelVariableStyle for each VoxelVariable.

version

readonlyinherited Property

Type: SceneServiceVersion

Inherited from: SceneService

The version of the scene service specification used for this service.

See also

github.com/Esri/i3s-spec

Example

// Prints the version to the console - e.g. 1.4, 1.5, etc.
console.log(layer.version.versionString);

visibilityTimeExtent

autocast inherited Property

Type: TimeExtent | null | undefined

Inherited from: Layer

Since: ArcGIS Maps SDK for JavaScript 4.30

Specifies a fixed time extent during which a layer should be visible. This property can be used to configure a layer that does not have time values stored in an attribute field to work with time. Once configured, the TimeSlider widget will display the layer within the set time extent. In the case that only one of the TimeExtent.start or TimeExtent.end date values are available, the layer remains visible indefinitely in the direction where there is no time value.

Aerial imagery can capture seasonal variations in vegetation, water bodies, and land use patterns. For example, in agricultural regions, aerial imageries taken during different growing seasons provide insights into crop health and productivity. Defining a fixed time extent on imageries from specific time periods provides temporal context and facilitates focused analysis based on specific time periods or events.

See also

Sample - GraphicsLayer with visibilityTimeExtent

visible

inherited Property

Type: boolean

Inherited from: Layer

Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.

Default value: true

Example

// The layer is no longer visible in the view
layer.visible = false;

// Watch for changes in the layer's visibility
// and set the visibility of another layer when it changes
reactiveUtils.watch(
  () => layer.visible,
  (visible) => {
    if (visible) {
      anotherLayer.visible = true;
    } else {
      anotherLayer.visible = false;
    }
  }
);

volumes

readonly Property

Type: Collection<VoxelVolume>

Since: ArcGIS Maps SDK for JavaScript 4.25

The collection of volumes that the VoxelLayer has variables for. Currently only a single volume is supported.

volumeStyles

autocast Property

Type: Collection<VoxelVolumeStyle>

Since: ArcGIS Maps SDK for JavaScript 4.24

The collection of volume styles. There is currently only one volume and thus also only one VoxelVolumeStyle.

Methods

Method	Signature	Class
`fromArcGISServerUrl` inherited static	`fromArcGISServerUrl(params: string \| FromArcGISServerUrlParameters): Promise<Layer>`	Layer
`fromPortalItem` inherited static	`fromPortalItem(params: LayerFromPortalItemParameters): Promise<Layer>`	Layer
`cancelLoad` inherited	`cancelLoad(): this`	LoadableMixin
`createLayerView` inherited	`createLayerView<T extends LayerView = LayerView>(view: View<T>, options?: AbortOptions): Promise<T>`	Layer
`createPopupTemplate`	`createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate \| null \| undefined`
`destroy` inherited	`destroy(): void`	Layer
`emit` inherited	`emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean`	EventedMixin
`fetchAttributionData` inherited	`fetchAttributionData(): Promise<any>`	Layer
`getColorForContinuousDataValue`	`getColorForContinuousDataValue(variableId: number, dataValue: number, applyOpacityStops: boolean): Color \| null \| undefined`
`getField`	`getField(fieldName: string): Field \| null \| undefined`
`getVariable`	`getVariable(variableId: number \| null \| undefined): VoxelVariable \| null \| undefined`
`getVariableStyle`	`getVariableStyle(variableId: number \| null \| undefined): VoxelVariableStyle \| null \| undefined`
`getVolume`	`getVolume(variableId: number \| null \| undefined): VoxelVolume \| null \| undefined`
`getVolumeStyle`	`getVolumeStyle(variableId: number \| null \| undefined): VoxelVolumeStyle \| null \| undefined`
`hasEventListener` inherited	`hasEventListener<Type extends EventNames<this>>(type: Type): boolean`	EventedMixin
`isFulfilled` inherited	`isFulfilled(): boolean`	EsriPromiseMixin
`isRejected` inherited	`isRejected(): boolean`	EsriPromiseMixin
`isResolved` inherited	`isResolved(): boolean`	EsriPromiseMixin
`load` inherited	`load(options?: AbortOptions \| null \| undefined): Promise<this>`	LoadableMixin
`on` inherited	`on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle`	EventedMixin
`when` inherited	`when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> \| null \| undefined, onRejected?: OnRejectedCallback<TResult2> \| null \| undefined): Promise<TResult1 \| TResult2>`	EsriPromiseMixin

fromArcGISServerUrl

inheritedstatic Method

Signature: fromArcGISServerUrl (params: string | FromArcGISServerUrlParameters): Promise<Layer>

Inherited from: Layer

Creates a new layer instance from an ArcGIS Server URL. Depending on the URL, the returned layer type may be a BuildingSceneLayer, CatalogLayer, ElevationLayer, FeatureLayer, GroupLayer, ImageryLayer, ImageryTileLayer, IntegratedMeshLayer, KnowledgeGraphLayer, MapImageLayer, OrientedImageryLayer, PointCloudLayer, SceneLayer, StreamLayer, SubtypeGroupLayer, TileLayer, or VideoLayer.

This is useful when you work with various ArcGIS Server URLs, but you don't necessarily know which layer type(s) they create. This method creates the appropriate layer type for you. In case of a feature service or a scene service, when the URL points to the service and the service has multiple layers, the returned promise will resolve to a GroupLayer.

Beginning with version 4.17, it is possible to load tables from hosted feature services. This only applies to feature layers, and will successfully load if FeatureLayer.isTable returns true.

The following table details what is returned when loading specific URL types.

URL	Returns
Feature service with one layer	FeatureLayer where FeatureLayer.isTable returns `false`.
Feature service with one table	FeatureLayer where FeatureLayer.isTable returns `true`.
Feature service with more than one layer(s)/table(s)	GroupLayer with layers and tables.
Layers with type other than "Feature Layer" are discarded, e.g. Utility Network Layers	N/A

See also

FeatureLayer.isTable

Parameters

Parameter	Type	Description	Required
params	`string \| FromArcGISServerUrlParameters`	Input parameters for creating the layer.

Returns: Promise<Layer>
Returns a promise that resolves to the new Layer instance.

Examples

// This snippet shows how to add a feature layer from an ArcGIS Server URL
// Get an ArcGIS Server URL from a custom function
const arcgisUrl = getLayerUrl();

Layer.fromArcGISServerUrl({
  url: arcgisUrl,
  properties: {
    // set any layer properties here
    popupTemplate: new PopupTemplate()
  }
}).then(function(layer){
  // add the layer to the map
  map.add(layer);
});

// This snippet shows how to add a table from an ArcGIS Server URL
// Get an ArcGIS Server URL from a custom function
const arcgisUrl = getLayerUrl();

Layer.fromArcGISServerUrl({
  url: arcgisUrl
}).then(function(layer){
  // Load the table before it can be used
  layer.load().then(function() {
    // Check that it is the right type
    if (layer.isTable) {
      // Add table to map's tables collection
      map.tables.add(layer);
    }
  });
});

fromPortalItem

inheritedstatic Method

Signature: fromPortalItem (params: LayerFromPortalItemParameters): Promise<Layer>

Inherited from: Layer

Creates a new layer instance of the appropriate layer class from an ArcGIS Online or ArcGIS Enterprise portal item. If the item points to a feature service with multiple layers, then a GroupLayer is created. If the item points to a service with a single layer, then it resolves to a layer of the same type of class as the service.

Note

At version 4.29, MediaLayer can be loaded from portal items.
At version 4.28, GroupLayer and OrientedImageryLayer can be loaded from portal items.
At version 4.25, CSVLayer and GeoJSONLayer can be loaded from CSV and GeoJSON portal items respectively.
At version 4.17, it is possible to load tables from feature service items hosted in ArcGIS Online and ArcGIS Enterprise. This only applies to feature layers, and will successfully load if FeatureLayer.isTable returns true.

The following table details what is returned when loading specific item types.

Item(s)	Returns
Feature service with one layer	FeatureLayer where FeatureLayer.isTable returns `false`.
Feature service with one table	FeatureLayer where FeatureLayer.isTable returns `true`.
Feature service with more than one layer(s)/table(s)	GroupLayer with layers and tables.
Feature collection with one layer	FeatureLayer where FeatureLayer.isTable returns `false`.
Feature collection with one table	FeatureLayer where FeatureLayer.isTable returns `true`.
Feature collection with more than one layer(s)/table(s)	GroupLayer with layers and tables.

Known Limitations

This method does not currently work with OGCFeatureServer portal items.

See also

Parameters

Parameter	Type	Description	Required
params	`LayerFromPortalItemParameters`	The parameters for loading the portal item.

Returns: Promise<Layer>
Returns a promise which resolves to the new layer instance.

Examples

// Create a layer from a specified portal item and add to the map
Layer.fromPortalItem({
  portalItem: {  // autocasts new PortalItem()
    id: "8444e275037549c1acab02d2626daaee"
  }
}).then(function(layer){
  // add the layer to the map
  map.add(layer);
});

// Create a table from a specified portal item and add it to the map's tables collection
Layer.fromPortalItem({
  portalItem: { // autocasts new PortalItem()
    id: "123f4410054b43d7a0bacc1533ceb8dc" // This is a hosted table stored in a feature service
  }
}).then(function(layer) {
  // Necessary to load the table in order for it to be read correctly
  layer.load().then(function() {
    // Confirm this reads as a table
    if (layer.isTable) {
      // Add the new table to the map's table collection
      map.tables.add(layer);
    }
  });
});

cancelLoad

inherited Method

Signature: cancelLoad (): this

Inherited from: LoadableMixin

Cancels a load() operation if it is already in progress.

Returns: this

createLayerView

inherited Method

Signature: createLayerView <T extends LayerView = LayerView>(view: View<T>, options?: AbortOptions): Promise<T>

Type parameters: <T extends LayerView = LayerView>

Inherited from: Layer

Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. This method is used internally and there is no use case for invoking it directly.

See also

Sample - Custom WebGL layer view

Parameters

Parameter	Type	Description	Required
view	`View`	The parent view.
options	`AbortOptions`	An object specifying additional options. See the object specification table below for the required properties of this object.

Returns: Promise
Resolves with a LayerView instance.

createPopupTemplate

Method

Signature: createPopupTemplate (options?: CreatePopupTemplateOptions): PopupTemplate | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.31

Creates a default popup template for the layer, populated with the default voxel fields and a field for each variable in the layer.

Parameters

Parameter	Type	Description	Required
options	`CreatePopupTemplateOptions`	Options for creating the popup template.

Returns: PopupTemplate | null | undefined
The popup template, or null if the layer does not have any fields.

destroy

inherited Method

Signature: destroy (): void

Inherited from: Layer

Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer). The layer can no longer be used once it has been destroyed.

The destroyed layer will be removed from its parent object like Map, WebMap, WebScene, Basemap, Ground, or GroupLayer.

See also

Returns: void

emit

inherited Method

Signature: emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters

Parameter	Type	Description	Required
type	`Type`	The name of the event.
event	`this["@eventTypes"][Type]`	The event payload.

Returns: boolean
true if a listener was notified

fetchAttributionData

inherited Method

Signature: fetchAttributionData (): Promise<any>

Inherited from: Layer

Fetches custom attribution data for the layer when it becomes available.

Returns: Promise<any>
Resolves to an object containing custom attribution data for the layer.

getColorForContinuousDataValue

Method

Signature: getColorForContinuousDataValue (variableId: number, dataValue: number, applyOpacityStops: boolean): Color | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns a Color for a given value for the continuous VoxelVariable identified by variableId using the variable's VoxelTransferFunctionStyle. The applyOpacityStops parameter determines whether the transfer function's opacity stops are applied or not. Returns null if the variable is not a continuous variable or if the transfer function is not configured correctly.

Parameters

Parameter	Type	Description
variableId	`number`	Voxel variable id for a continuous variable.
dataValue	`number`	The continuous data value to get a color for.
applyOpacityStops	`boolean`	Whether or not to apply the opacity stops to the returned color.

Returns: Color | null | undefined
The color or null if an invalid variableId was passed in.

getField

Method

Signature: getField (fieldName: string): Field | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.31

Returns the Field instance for a field name (case-insensitive).

See also

fields

Parameters

Parameter	Type	Description	Required
fieldName	`string`	Name of the field.

Returns: Field | null | undefined
the matching field or undefined

getVariable

Method

Signature: getVariable (variableId: number | null | undefined): VoxelVariable | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.24

Returns a VoxelVariable based on an id. If you call getVariable(null) the current VoxelVariable is returned.

Parameters

Parameter	Type	Description	Required
variableId	`number \| null \| undefined`	Voxel variable id.

Returns: VoxelVariable | null | undefined
The variable or null if an invalid variableId was passed in.

getVariableStyle

Method

Signature: getVariableStyle (variableId: number | null | undefined): VoxelVariableStyle | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns a VoxelVariableStyle based on an id. If you call getVariableStyle(null) the current VoxelVariableStyle is returned.

Parameters

Parameter	Type	Description	Required
variableId	`number \| null \| undefined`	Voxel variable id.

Returns: VoxelVariableStyle | null | undefined
The variable style or null if an invalid variableId was passed in.

getVolume

Method

Signature: getVolume (variableId: number | null | undefined): VoxelVolume | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns a VoxelVolume based on the id of a VoxelVariable. If you call getVolume(null) the current variable's VoxelVolume is returned.

Parameters

Parameter	Type	Description	Required
variableId	`number \| null \| undefined`	Voxel variable id.

Returns: VoxelVolume | null | undefined
The volume or null if an invalid variableId was passed in.

getVolumeStyle

Method

Signature: getVolumeStyle (variableId: number | null | undefined): VoxelVolumeStyle | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns a VoxelVolumeStyle based on the id of a VoxelVariable. If you call getVolumeStyle(null) the current variable's VoxelVolumeStyle is returned.

Parameters

Parameter	Type	Description	Required
variableId	`number \| null \| undefined`	Voxel variable id.

Returns: VoxelVolumeStyle | null | undefined
The volume style or null if an invalid variableId was passed in.

hasEventListener

inherited Method

Signature: hasEventListener <Type extends EventNames<this>>(type: Type): boolean

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameters

Parameter	Type	Description	Required
type	`Type`	The name of the event.

Returns: boolean
Returns true if the class supports the input event.

isFulfilled

inherited Method

Signature: isFulfilled (): boolean

Inherited from: EsriPromiseMixin

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns: boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected

inherited Method

Signature: isRejected (): boolean

Inherited from: EsriPromiseMixin

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns: boolean
Indicates whether creating an instance of the class has been rejected.

isResolved

inherited Method

Signature: isResolved (): boolean

Inherited from: EsriPromiseMixin

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns: boolean
Indicates whether creating an instance of the class has been resolved.

load

inherited Method

Signature: load (options?: AbortOptions | null | undefined): Promise<this>

Inherited from: LoadableMixin

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.

It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad() can abort it.

Parameters

Parameter	Type	Description	Required
options	`AbortOptions \| null \| undefined`	Additional options.

Returns: Promise<this>
Resolves when the resources have loaded.

on

inherited Method

Signature: on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle

Type parameters: <Type extends EventNames<this>>

Inherited from: EventedMixin

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

Parameter	Type	Description	Required
type	`Type`	An event or an array of events to listen for.
listener	`EventedCallback<this["@eventTypes"][Type]>`	The function to call when the event fires.

Returns

ResourceHandle

Returns an event handler with a remove() method that should be called to stop listening for the event(s).

Property	Type	Description
remove	Function	When called, removes the listener from the event.

Example

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

when

inherited Method

Signature: when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>

Type parameters: <TResult1 = this, TResult2 = never>

Inherited from: EsriPromiseMixin

when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function. The onFulfilled executes when the instance of the class loads. The onRejected executes if the instance of the class fails to load.

Parameters

Parameter	Type	Description	Required
onFulfilled	`OnFulfilledCallback<this, TResult1> \| null \| undefined`	The function to call when the promise resolves.
onRejected	`OnRejectedCallback \| null \| undefined`	The function to execute when the promise fails.

Returns: Promise<TResult1 | TResult2>
Returns a new promise for the result of onFulfilled that may be used to chain additional functions.

Example

// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Events

Name	Type
`layerview-create` inherited	CustomEvent<LayerLayerviewCreateEvent>
`layerview-create-error` inherited	CustomEvent<LayerLayerviewCreateErrorEvent>
`layerview-destroy` inherited	CustomEvent<LayerLayerviewDestroyEvent>

layerview-create

inherited Event

layerview-create: CustomEvent<LayerLayerviewCreateEvent>

Inherited from: Layer

Fires after the layer's LayerView is created and rendered in a view.

See also

View.whenLayerView()

Example

// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
  // The LayerView for the layer that emitted this event
  event.layerView;
});

layerview-create-error

inherited Event

layerview-create-error: CustomEvent<LayerLayerviewCreateErrorEvent>

Inherited from: Layer

Fires when an error emits during the creation of a LayerView after a layer has been added to the map.

See also

View.whenLayerView()

Example

// This function fires when an error occurs during the creation of the layer's layerview
layer.on("layerview-create-error", function(event) {
  console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view);
});

layerview-destroy

inherited Event

layerview-destroy: CustomEvent<LayerLayerviewDestroyEvent>

Inherited from: Layer

Fires after the layer's LayerView is destroyed and no longer renders in a view.

Type definitions

VoxelRenderMode

Type definition

Current rendering mode for the VoxelLayer. The volume mode draws the full voxel layer volume whereas the surfaces mode draws sections and isosurfaces only.

Type: "volume" | "surfaces"