@arcgis/core 5.0.0-next.69 → 5.0.0-next.70

package/views/layers/ViewshedLayerViewMixin.d.ts

@@ -1,98 +0,0 @@
-import type Viewshed from "../../analysis/Viewshed.js";
-import type ViewshedLayer from "../../layers/ViewshedLayer.js";
-import type { AbortOptions } from "../../core/promiseUtils.js";
-import type { ViewshedPlacementResult } from "../3d/analysis/Viewshed/types.js";
-
-export interface ViewshedLayerViewMixinProperties extends Partial<Pick<ViewshedLayerViewMixin, "interactive" | "selectedViewshed">> {}
-
-export abstract class ViewshedLayerViewMixin {
-  constructor(...args: any[]);
-  /**
-   * Enables interactivity for the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ViewshedLayerViewMixin.html#layer). When set to `true` and the layer's
-   * [ViewshedLayer#source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ViewshedLayer.html#source) includes any
-   * valid [ViewshedAnalysis#viewsheds](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ViewshedAnalysis.html#viewsheds), they become selectable and editable.
-   *
-   * @default false
-   */
-  accessor interactive: boolean;
-  /** The layer being viewed. */
-  get layer(): ViewshedLayer;
-  /**
-   * The selected viewshed. If [interactive](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ViewshedLayerViewMixin.html#interactive) is `true`, any viewshed in the
-   * [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ViewshedLayerViewMixin.html#layer) can be selected by clicking on it in the view. As long as [interactive](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ViewshedLayerViewMixin.html#interactive)
-   * remains `true`, the properties of the selected viewshed can be edited by interacting with
-   * manipulators in the view.
-   */
-  accessor selectedViewshed: Viewshed | null | undefined;
-  /**
-   * Starts the interactive creation of new viewsheds and adds them to the layer
-   * [ViewshedLayer#source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ViewshedLayer.html#source).
-   *
-   * The first click in the scene places the observer point and the second sets the viewshed's orientation.
-   *
-   * The creation process will finish when the user double-clicks the mouse or presses the escape key.
-   * To stop the creation programmatically, pass an abort signal as an argument when calling the method.
-   *
-   * This method is similar to the [place()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ViewshedLayerViewMixin.html#place) method, but it allows to create multiple viewsheds in a row.
-   *
-   * Calling this method sets [interactive](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ViewshedLayerViewMixin.html#interactive) to `true`.
-   *
-   * > [!WARNING]
-   * >
-   * > Note that when placing viewsheds interactively, the viewshed is created with a 1.5 meter vertical offset from the scene.
-   * > _This behavior is subject to change in a future release._
-   *
-   * @param options - An object specifying additional options.
-   * @returns A promise which resolves when creation is completed successfully or rejected if it is
-   * canceled.
-   * @example
-   * const abortController = new AbortController();
-   *
-   * try {
-   *   await viewshedLayerView.createViewsheds({ signal: abortController.signal });
-   * } catch (error) {
-   *   if (error.name === "AbortError") {
-   *     console.log("Creation operation was cancelled.");
-   *   }
-   * }
-   *
-   * // cancel the placement operation at some later point
-   * abortController.abort();
-   */
-  createViewsheds(options?: AbortOptions | null | undefined): Promise<void>;
-  /**
-   * Starts the interactive placement of a single viewshed, adding it to the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ViewshedLayerViewMixin.html#layer)'s
-   * [ViewshedLayer#source](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ViewshedLayer.html#source).
-   *
-   * The first click in the scene places the observer point and the second sets the viewshed's orientation.
-   *
-   * The placement operation will finish when the user presses the escape key.
-   * To stop the placing programmatically, pass an abort signal as an argument when calling the method.
-   *
-   * Calling this method sets [interactive](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-ViewshedLayerViewMixin.html#interactive) to `true`.
-   *
-   * > [!WARNING]
-   * >
-   * > Note that when placing viewsheds interactively, the viewshed is created with a 1.5 meter vertical offset from the scene.
-   * > _This behavior is subject to change in a future release._
-   *
-   * @param options - An object specifying additional options.
-   * @returns A promise which
-   * resolves when the operation is completed successfully or rejected if it is canceled.
-   * @since 4.33
-   * @example
-   * const abortController = new AbortController();
-   *
-   * try {
-   *   await viewshedLayerView.place({ signal: abortController.signal });
-   * } catch (error) {
-   *   if (error.name === "AbortError") {
-   *     console.log("Placement operation was cancelled.");
-   *   }
-   * }
-   *
-   * // cancel the placement operation at some later point
-   * abortController.abort();
-   */
-  place(options?: AbortOptions | null | undefined): Promise<ViewshedPlacementResult>;
-}

package/views/layers/ViewshedLayerViewMixin.js

@@ -1,5 +0,0 @@
-/*
-All material copyright Esri, All Rights Reserved, unless otherwise specified.
-See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-*/
-import{__decorate as e}from"tslib";import{createAbortError as s}from"../../core/promiseUtils.js";import{property as i,subclass as t}from"../../core/accessorSupport/decorators.js";const l=l=>{const a=l;let r=class extends a{constructor(...e){super(...e),this.layer=null}get interactive(){return null!=this.analysisView&&this.analysisView.interactive}set interactive(e){null!=this.analysisView&&(this.analysisView.interactive=e)}get selectedViewshed(){return null!=this.analysisView?this.analysisView.selectedViewshed:null}set selectedViewshed(e){null!=this.analysisView&&(this.analysisView.selectedViewshed=e)}async createViewsheds(e){await(this.analysisView?.createViewsheds(e))}place(e){if(null!=this.analysisView)return this.analysisView.place(e);throw s()}};return e([i()],r.prototype,"layer",void 0),e([i()],r.prototype,"interactive",null),e([i()],r.prototype,"selectedViewshed",null),r=e([t("esri.views.layers.ViewshedLayerViewMixin")],r),r};export{l as ViewshedLayerViewMixin};