▾
import LineOfSightLayerView from "@arcgis/core/views/layers/LineOfSightLayerView.js";const LineOfSightLayerView = await $arcgis.import("@arcgis/core/views/layers/LineOfSightLayerView.js");Represents the LayerView of a LineOfSightLayer after it has been added to a Map in a SceneView.
The line of sight layer view controls whether the LineOfSightAnalysis in its associated LineOfSightLayer.analysis can be created or edited interactively.
It allows to create an observer and/or targets interactively using the place() method, query the results, or make an existing analysis editable by enabling the interactive property.
The view for the layer can be retrieved using SceneView.whenLayerView().
// create new layer and add it to the mapconst lineOfSightLayer = new LineOfSightLayer();view.map.add(lineOfSightLayer);
// retrieve layer view for the layerconst layerView = await view.whenLayerView(lineOfSightLayer);Things to consider:
- Snapping, tooltips, display units, and input units used during interactive placement and editing are inherited from
ViewOptions.
- Snapping is enabled by default. This can be temporarily disabled by holding the
CTRLkey. - Layer types currently supported for snapping are: FeatureLayer, GraphicsLayer (except Mesh geometries), GeoJSONLayer, WFSLayer, CSVLayer, 3D Object SceneLayer, and BuildingSceneLayer.
- Snapping is enabled by default. This can be temporarily disabled by holding the
Properties
| Property | Type | Class |
|---|---|---|
| readonly inherited | ||
| | ||
| readonly | | |
| readonly | | |
| readonly inherited | ||
| readonly inherited | ||
| readonly inherited | ||
| readonly inherited | ||
| readonly inherited | ||
| inherited | ||
| readonly inherited | ||
| readonly inherited |
interactive
- Type
- boolean
Enables interactivity for the layer.
When set to true, and the layer includes a valid LineOfSightLayer.observer and any
LineOfSightLayer.targets, they become selectable and editable and the manipulators will be displayed.
Targets can be removed by right-clicking on them or with the Delete key.
The observer and the last target cannot be deleted interactively.
This property is automatically set to true when the LineOfSightLayer.analysis is assigned to a
Line Of Sight component.
- Default value
- false
results
- Type
- Collection<LineOfSightAnalysisResult | null | undefined>
Analysis results for each target.
The order of results matches the order of targets, so if the index of the target is known the collection can be indexed directly:
const layerView = await view.whenLayerView(lineOfSightLayer);const result = layerView.results.at(targetIdx);Given a target object, the results collection can also be searched:
const result = layerView.results.find((result) => result.target === targetObject); spatialReferenceSupported
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.23
Indicates if the spatialReference of the MapView or
Map component is supported by the layer view.
When false layer view will be suspended.
Known Limitations
This property is not supported for layer views of a 3D SceneView or Scene component.
- See also
suspended
- Type
- boolean
Indicates whether the layer view is suspended. While suspended, the layer is not rendered
in the associated view and is excluded from the results of the
Map
and Scene
component's hitTest() methods.
Data already loaded by the layer view may be retained for reuse when the layer view is no longer suspended.
uid
- Type
- string
- 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.
updating
- Type
- boolean
Indicates if the layer view is making any updates that will impact what is displayed on the map.
For example, this value is true when renderer, definitionExpression, filter or effect is changed or
if the layer view is in the process of the fetching data.
Watch FeatureLayerView.dataUpdating property instead to only know when the data has been updated (e.g. to run statistics query on all feature available in the layer view).
- Default value
- false
- Example
- // Check for the first time layerView.updating becomes false. Then query for// features that are visible within the view associated with the layer view.await reactiveUtils.whenOnce(() => !layerView.updating);const query = layerView.createQuery();query.geometry = layerView.view.extent;const result = layerView.queryFeatures(query);
view
- Type
- MapViewOrSceneView
- Since
- ArcGIS Maps SDK for JavaScript 4.28
A reference to the MapView or SceneView associated with the layer view.
- Example
- // Check for the first time layerView.updating becomes false. Then query for// features that are visible within the view associated with the layer view.await reactiveUtils.whenOnce(() => !layerView.updating);const query = layerView.createQuery();query.geometry = layerView.view.extent;const result = layerView.queryFeatures(query);
visibleAtCurrentScale
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.30
When true, the layer is visible in the view at the current scale. This applies to layers that have minScale and maxScale properties set.
Known Limitations
This property isn’t supported for tiled layers in 3D SceneView or in the Scene component
- Default value
- true
visibleAtCurrentTimeExtent
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.30
When true, the layer is visible in the view's View.timeExtent. This applies to layers that have a Layer.visibilityTimeExtent.
- See also
- Default value
- true
Methods
| Method | Signature | Class |
|---|---|---|
| inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
| inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
| inherited | isFulfilled(): boolean | |
| inherited | isRejected(): boolean | |
| inherited | isResolved(): boolean | |
| inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
| place(options?: LineOfSightPlacementOptions | null | undefined): Promise<LineOfSightPlacementResult> | | |
| inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
- Since
- ArcGIS Maps SDK for JavaScript 4.5
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
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
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify whether the promise has been fulfilled (either resolved or rejected).
- Returns
- boolean
Whether the promise has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify whether the promise has been rejected.
- Returns
- boolean
Whether the promise has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify whether the promise has resolved.
- Returns
- boolean
Whether the promise has resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
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);});
place
- Signature
-
place (options?: LineOfSightPlacementOptions | null | undefined): Promise<LineOfSightPlacementResult>
- Since
- ArcGIS Maps SDK for JavaScript 4.33
Starts the interactive placement of an observer and targets on the layer's LineOfSightLayer.analysis.
If the layer does not have a valid LineOfSightLayer.observer yet, this method will allow placing an observer, which can be followed by zero or more targets. Otherwise, if it already has a valid observer, it will allow placing targets. An observer is valid when it has a position. Placing an observer without any targets is a productive operation.
The placement operation will finish when the user presses the escape key. Pressing escape after placing an observer or target finalizes a productive operation. Pressing escape before a valid observer is placed rejects the promise. To stop the placing programmatically, pass an abort signal as an argument when calling the method. The promise resolves when the operation is productive, i.e. an observer or any targets were added. Otherwise, if nothing was added or signal was aborted, the promise is rejected.
By default, the observer and targets are created at absolute height. Optionally, by specifying the options of the method, you can change the elevation info.
Calling this method sets interactive to true.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| options | An object specifying additional placement options, including elevation information and an abort signal. | |
- Returns
- Promise<LineOfSightPlacementResult>
A promise which resolves when the operation is completed successfully - i.e. the user places an observer and/or target(s), leaving the analysis in a valid state. Otherwise, the promise is rejected.
- Example
- const abortController = new AbortController();try {await layerView.place({signal: abortController.signal,// optional elevation infoelevationInfo: { mode: "relative-to-ground", offset: 1.5 },});} catch (error) {if (error.name === "AbortError") {console.log("Placement operation was cancelled.");}}// cancel the placement operation at some later pointabortController.abort();
when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
- Since
- ArcGIS Maps SDK for JavaScript 4.6
when() may be used with an instance of this class. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled function executes when the promise resolves. The
onRejected function executes if the promise is rejected.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat 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 waylet 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});