JimuLayerView

Class

JimuLayerView is the wrapper class for ArcGIS Maps SDK for JavaScript Layer and 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

PropertyTypeNotes
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.

string

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

number

The order defined in the webmap

string

The jimuMapViewId is the corresponding JimuMapView instance id.

any

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

string

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

string

The layer type, see ArcGIS Maps SDK for JavaScript Layer type.

LayerView | BuildingComponentSublayerView

The view is the ArcGIS Maps SDK for JavaScript LayerView or BuildingComponentSublayerView .

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 data source 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.

view

Class Property
view: LayerView | BuildingComponentSublayerView

The view is the ArcGIS Maps SDK for JavaScript LayerView or BuildingComponentSublayerView .

Methods

MethodReturnsNotes
Promise<DataSource>

Create corresponding data source for the layer.

void

Destroy the JimuLayerView instance.

Get all ancestor JimuLayerViews.

Get the JimuMapView that the current JimuLayerView belongs to.

Return the corresponding data source of the layer.

Get the map data source of the layer.

MapView | SceneView

Return the MapView or SceneView of the layer view.

Get parent JimuLayerView.

boolean

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

createLayerDataSource

Class Method
createLayerDataSource(): Promise<DataSource>

Create corresponding data source for the layer.

Returns 
Promise<DataSource>

destroy

Class Method
destroy(): void

Destroy the JimuLayerView instance.

Returns 
void

getAllAncestorJimuLayerViews

Class Method
getAllAncestorJimuLayerViews(): JimuLayerView[]

Get all ancestor JimuLayerViews.

Returns 
JimuLayerView[]

getJimuMapView

Class Method
getJimuMapView(): JimuMapView

Get the JimuMapView that the current JimuLayerView belongs to.

Returns 
JimuMapView

getLayerDataSource

Class Method
getLayerDataSource(): DataSource

Return the corresponding data source of the layer.

Returns 
DataSource

getMapDataSource

Class Method
getMapDataSource(): MapDataSource

Get the map data source of the layer.

Returns 
MapDataSource

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.