JimuMapView

Class

JimuMapView is the view for developers to develop the map-related functions. For example, developers can use the view property of the JimuMapView instance to get the original ArcGIS API for JavaScript View, then use the original view to develop the map-related functions. At the same time, JimuMapView also provides properties such as isActive and status to indicate the current status in the map widget.

JimuMapView is a wrapper class for the ArcGIS API for JavaScript View. It is created by a map widget using a map DataSource.

Use dark colors for code blocksCopy
import { JimuMapView } from 'jimu-arcgis';

// Add the State interface
interface State {
 extent: __esri.Extent
}

// On an active view change, set the extent State property
onActiveViewChange = (jimuMapView: JimuMapView) => {
 if(!this.extentWatch){
  this.extentWatch = jimuMapView.view.watch('extent', extent => {
    this.setState({
      extent
    })
  });
 }
}

// Use the `JimuMapView` instance from the map widget through the `JimuMapViewComponent` React component
<JimuMapViewComponent useMapWidgetId={this.props.useMapWidgetIds[0]} onActiveViewChange={this.onActiveViewChange}></JimuMapViewComponent>

Constructors

new JimuMapView(options: JimuMapViewConstructorOptions): JimuMapView

Parameters

Parameter	Type
`options`	JimuMapViewConstructorOptions

Returns

JimuMapView

Properties

Property	Type	Notes
`dataSourceId`	`string`	The id of the `DataSource` selected to create the map.
`id`	`string`	The id of the `JimuMapView` instance.
`isActive` optional	`boolean`	The `isActive` property indicates whether the map in the map widget is accessible. For example, for a single-source map, there is a single `JimuMapView` instance, therefore, the `isActive` is always true. With a multi-source map, there are two `JimuMapView` instances. In the multi-source map, the property `isActive` is true for the top `JimuMapView` instance, and false for the one beneath. Upon clicking the switch map tool, the `isActive` properties will switch.
`jimuLayerViews` optional	`{ [jimuLayerViewId: string]: JimuLayerView }`	The union for all `JimuLayerView` instances and the layer view object wrapper.
`jimuMapTools`	`JimuMapTool[]`	The created map tools (ArcGIS JavaScript API widgets) for this view.
`mapWidgetId`	`string`	The id of the widget creating the `JimuMapView` instance.
`maxLayerIndex` optional	`number`	The maximum layer index in the `JimuMapView`.
`status`	`JimuMapViewStatus`	The status of the `JimuMapView` instance. `JimuMapViewStatus` enumeration members include `"LOADING"`, `"LOADED"` and `"FAILED"`.
`view`	`MapView \| SceneView`	The `view` is the ArcGIS API for JavaScript `View`, including a`MapView` or a`SceneView`. In the ArcGIS API for JavaScript, the `MapView` and `SceneView` are part of the `__esri` namespace types. Thus, their types are `__esri.MapView` and `__esri.SceneView`.

dataSourceId

dataSourceId: string

The id of the DataSource selected to create the map.

id

id: string

The id of the JimuMapView instance.

isActive optional

isActive: boolean

The isActive property indicates whether the map in the map widget is accessible. For example, for a single-source map, there is a single JimuMapView instance, therefore, the isActive is always true. With a multi-source map, there are two JimuMapView instances. In the multi-source map, the property isActive is true for the top JimuMapView instance, and false for the one beneath. Upon clicking the switch map tool, the isActive properties will switch.

jimuLayerViews optional

jimuLayerViews: { [jimuLayerViewId: string]: JimuLayerView }

The union for all JimuLayerView instances and the layer view object wrapper.

Type declaration

[jimuLayerViewId: string]: JimuLayerView

jimuMapTools

jimuMapTools: JimuMapTool[]

The created map tools (ArcGIS JavaScript API widgets) for this view.

mapWidgetId

mapWidgetId: string

The id of the widget creating the JimuMapView instance.

maxLayerIndex optional

maxLayerIndex: number

The maximum layer index in the JimuMapView.

status

status: JimuMapViewStatus

The status of the JimuMapView instance. JimuMapViewStatus enumeration members include "LOADING", "LOADED" and "FAILED".

view

view: MapView | SceneView

The view is the ArcGIS API for JavaScript View, including aMapView or aSceneView. In the ArcGIS API for JavaScript, the MapView and SceneView are part of the __esri namespace types. Thus, their types are __esri.MapView and __esri.SceneView.

Methods

Method	Returns	Notes
`clearSelectedFeatures()`	`void`	Clear the selected features.
`destroy()`	`void`	Destroy the `JimuMapView` instance and the ArcGIS API for Javascript `View` at the same time.
`drawDataOnMap(newShowOnMapDatas)`	`void`	Draw data on the map, using a dedicated `GraphicsLayer`for every data entry. This will clear the layers drawn previously.
`drawDataRecordSet(dataSet, targetLayerId, title?, symbolOption?)`	`Promise<Graphic[]>`	Draw the features in a `GraphicsLayer`.
`getChildJimuLayerViews(jimuLayerViewId)`	`JimuLayerView[]`	Return all child JimuLayerViews.
`getParentJimuLayerViews(jimuLayerViewId)`	`JimuLayerView[]`	Return all parent JimuLayerViews.
`updateDrawnDataRecordSet(dataSet, targetLayerId, title?, symbolOption?)`	`Promise<Graphic[]>`	Update the drawn `GraphicsLayer`.
`whenJimuMapViewLoaded()`	`Promise<JimuMapView>`	Resolve the JimuMapView when it is loaded.

clearSelectedFeatures

clearSelectedFeatures(): void

Clear the selected features.

Returns

void

destroy

destroy(): void

Destroy the JimuMapView instance and the ArcGIS API for Javascript View at the same time.

Returns

void

drawDataOnMap

drawDataOnMap(newShowOnMapDatas: ShowOnMapDatas): void

Draw data on the map, using a dedicated GraphicsLayerfor every data entry. This will clear the layers drawn previously.

Parameters

Parameter	Type
`newShowOnMapDatas`	ShowOnMapDatas

Returns

void

drawDataRecordSet

drawDataRecordSet(dataSet: DataRecordSet, targetLayerId: string, title?: string, symbolOption?: SymbolOption): Promise<Graphic[]>

Draw the features in a GraphicsLayer.

Parameters

Parameter	Type
`dataSet`	DataRecordSet
`targetLayerId`	string
`title`	string
`symbolOption`	SymbolOption

Returns

Promise<Graphic[]>

getChildJimuLayerViews

getChildJimuLayerViews(jimuLayerViewId: any): JimuLayerView[]

Return all child JimuLayerViews.

Parameters

Parameter	Type
`jimuLayerViewId`	any

Returns

JimuLayerView[]

getParentJimuLayerViews

getParentJimuLayerViews(jimuLayerViewId: string): JimuLayerView[]

Return all parent JimuLayerViews.

Parameters

Parameter	Type
`jimuLayerViewId`	string

Returns

JimuLayerView[]

updateDrawnDataRecordSet

updateDrawnDataRecordSet(dataSet: DataRecordSet, targetLayerId: string, title?: string, symbolOption?: SymbolOption): Promise<Graphic[]>

Update the drawn GraphicsLayer.

Parameters

Parameter	Type
`dataSet`	DataRecordSet
`targetLayerId`	string
`title`	string
`symbolOption`	SymbolOption

Returns

Promise<Graphic[]>

whenJimuMapViewLoaded

whenJimuMapViewLoaded(): Promise<JimuMapView>

Resolve the JimuMapView when it is loaded.

Returns

Promise<JimuMapView>

ArcGIS Experience BuilderAPI Reference

JimuMapView

Was this page helpful?

Was this page helpful?