JimuLayerView

Class

JimuLayerView is a wrapper class for ArcGIS Maps SDK for JavaScript LayerView . It is created by a JimuMapView using a layer DataSource .

A layer view may have a related data source. If it has the data source, the feature selection will be synced to data source selection and will use the data source URL params. If it does not have the data source, the feature selection will use the feature_selection URL param.

Properties

Property	Type	Notes
`fromRuntime`	`boolean`	true means the JimuLayerView is created from runtime. e.g. The JimuLayerView is created by AddData widget at runtime. false means the layer is a builtin layer of WebMap or WebScene.
`id`	`string`	The id of the JimuLayerView instance. It connects the JimuMapView.id and the JimuLayerId with "-"
`index`	`number`	The order defined in the webmap
`jimuMapViewId`	`string`	The jimuMapViewId is the corresponding JimuMapView instance id.
`layer`	`any`	The layer is the corresponding layer object in ArcGIS JavaScript API View.map.
`layerDataSourceId`	`string`	The layerDataSourceId is the corresponding datasource id. This id always has value, but the layer data source may not be created.
`type`	`string`	The layer type, see [ArcGIS Maps SDK for JavaScript Layer type]]((https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#type))
`view`	`LayerView \| BuildingComponentSublayerView`	The `view` is the ArcGIS Maps SDK for JavaScript `LayerView` .

fromRuntime

Class Property

fromRuntime: boolean

true means the JimuLayerView is created from runtime. e.g. The JimuLayerView is created by AddData widget at runtime. false means the layer is a builtin layer of WebMap or WebScene.

id

Class Property

id: string

The id of the JimuLayerView instance. It connects the JimuMapView.id and the JimuLayerId with "-"

index

Class Property

index: number

The order defined in the webmap

jimuMapViewId

Class Property

jimuMapViewId: string

The jimuMapViewId is the corresponding JimuMapView instance id.

layer

Class Property

layer: any

The layer is the corresponding layer object in ArcGIS JavaScript API View.map.

layerDataSourceId

Class Property

layerDataSourceId: string

The layerDataSourceId is the corresponding datasource id. This id always has value, but the layer data source may not be created.

type

Class Property

type: string

The layer type, see [ArcGIS Maps SDK for JavaScript Layer type]]((https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#type))

view

Class Property

view: LayerView | BuildingComponentSublayerView

The view is the ArcGIS Maps SDK for JavaScript LayerView .

Methods

Method	Returns	Notes
`destroy()`	`void`	Destroy the JimuLayerView instance.
`getAllAncestorJimuLayerViews()`	`JimuLayerView[]`	Get all ancestor JimuLayerViews.
`getLayerDataSource()`	`DataSource`	Return the cooresponding data source of the layer
`getMapSceneView()`	`MapView \| SceneView`	Return the MapView or SceneView of the layer view.
`getParentJimuLayerView()`	`JimuLayerView`	Get parent JimuLayerView.
`isLayerVisible()`	`boolean`	If any layer in the layer tree is invisible, the layer is considered invisible

destroy

Class Method

destroy(): void

Destroy the JimuLayerView instance.

Returns

void

getAllAncestorJimuLayerViews

Class Method

getAllAncestorJimuLayerViews(): JimuLayerView[]

Get all ancestor JimuLayerViews.

Returns

JimuLayerView[]

getLayerDataSource

Class Method

getLayerDataSource(): DataSource

Return the cooresponding data source of the layer

Returns

DataSource

getMapSceneView

Class Method

getMapSceneView(): MapView | SceneView

Return the MapView or SceneView of the layer view.

Returns

MapView | SceneView

getParentJimuLayerView

Class Method

getParentJimuLayerView(): JimuLayerView

Get parent JimuLayerView.

Returns

JimuLayerView

isLayerVisible

Class Method

isLayerVisible(): boolean

If any layer in the layer tree is invisible, the layer is considered invisible

Returns

boolean