arcgis-line-of-sight

The LineOfSightAnalysis created or modified by the component.

When connecting the Line Of Sight component to the arcgis-scene component, it automatically creates an empty analysis and adds it to the Scene's arcgis-scene.analyses collection. You can then wait for the LineOfSightAnalysisView3D to be created before accessing the analysis results.

// Get the Scene component and the Line Of Sight component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const lineOfSightElement = document.querySelector("arcgis-line-of-sight");
await lineOfSightElement.componentOnReady();

// Get the LineOfSightAnalysis created by the Line Of Sight component.
const analysis = lineOfSightElement.analysis;

// Get the LineOfSightAnalysisView3D and watch for updates.
const analysisView = await viewElement.whenAnalysisView(analysis);
const handle = reactiveUtils.watch(
  () => analysisView?.results,
  () => {
    console.log("Analysis results:", analysisView.results);
  },
);

Whenever the component is destroyed, the analysis is automatically removed from the collection.

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

// Create the LineOfSightAnalysis.
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 component and the Line Of Sight component, and wait until both are ready.
const viewElement = document.querySelector("arcgis-scene");
await viewElement.viewOnReady();
const lineOfSightElement = document.querySelector("arcgis-line-of-sight");
await lineOfSightElement.componentOnReady();

// Add the analysis to the analyses collection of the Scene component.
viewElement.analyses.add(lineOfSightAnalysis);

// Connect the analysis to the component:
lineOfSightElement.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.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the button that allows the user to continue placing more targets.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the button that ends the current placement will be hidden.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the button that starts a new analysis will be hidden.

Since

ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the component's visualization is hidden in the view.

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

The component's default label.

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

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

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

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

Creates a promise that resolves once the component is fully loaded.

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

Permanently destroy the component.

Start a new line of sight analysis.

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.