Line Of Sight

The LineOfSightAnalysis created or modified by the component.

When connecting the Line Of Sight component to the Scene component, it automatically creates an empty analysis and adds it to the Scene's analyses collection. Whenever the component is destroyed, the analysis is automatically removed from the collection.

Alternatively, a programmatically created analysis can be provided to the component. Then, the application itself needs to add it to and later remove it from the Scene's analyses collection.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
//Create the analysis.
const lineOfSightAnalysis = new LineOfSightAnalysis({
  observer: new LineOfSightAnalysisObserver({
        position: new Point({
        spatialReference: { latestWkid: 3857, wkid: 102100 },
        x: -13624828.3377593,
        y: 4550305.319405007,
        z: 105.55410975124687
        }),
  }),
  targets: [ new LineOfSightAnalysisTarget({
        position: new Point({
        spatialReference: { latestWkid: 3857, wkid: 102100 },
        x: -13624944.17687458,
        y: 4550420.577689567,
        z: 0
        }),
  })
]
});
// Get the Scene and Line Of Sight component and wait until they are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const lineOfSight = document.querySelector("arcgis-line-of-sight");
await lineOfSight.componentOnReady();
// Add the analysis to the Scene component.
viewElement.analyses.add(lineOfSightAnalysis);
// Connect the analysis to the component:
lineOfSight.analysis = lineOfSightAnalysis;

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.

Attribute

auto-destroy-disabled

Default value

false

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

• Calcite Icons

Attribute

icon

Default value

"line-of-sight"

The component's default label.

Attribute

label

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

Attribute

position

By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.

See also

• Associate components with a Map or Scene component

Attribute

reference-element

The component's state. The values mean the following:

• disabled - not ready yet
• ready - ready for analysis
• creating - observer/target points are being placed
• created - finished analysis

Attribute

state

The view associated with the component.

Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this view property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Line Of Sight component will be associated with a map or scene component rather than using the view property.

Clear the current analysis results. After calling this method, the user can set a new observer and targets.

Returns

Promise<void>

Create a promise that resolves once component is fully loaded.

Example

1
2
3
4
const arcgisLineOfSight = document.querySelector("arcgis-line-of-sight");
document.body.append(arcgisLineOfSight);
await arcgisLineOfSight.componentOnReady();
console.log("arcgis-line-of-sight is ready to go!");

Returns

Promise<void>

After stop() was called, this method allows to continue the line of sight analysis and add more targets.

Returns

Promise<void>

Permanently destroy the component.

Returns

Promise<void>

Start a new line of sight analysis.

Returns

Promise<void>

Stop the current placing of line of sight analysis. Any lines added this far are kept in the view. Users can still interact with existing targets and the observer, but they cannot place new target points.

Returns

Promise<void>

Emitted when the value of a property is changed. Use this to listen to changes to properties.

Emitted when the component associated with a map or scene view is ready to be interacted with.