@arcgis/map-components 4.34.0-next.8 → 4.34.0-next.81

package/dist/components/arcgis-shadow-cast/customElement.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
-/// <reference types="../../index.d.ts" />
+/// <reference path="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
 import { default as ShadowCast } from '@arcgis/core/widgets/ShadowCast.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
@@ -9,8 +9,8 @@ declare const useShadowCastWidget: (component: LitElement & Pick<ShadowCast, "ic
     state?: unknown;
     viewModel?: __esri.ShadowCastViewModel | undefined;
     closed?: boolean;
-    icon: import('@arcgis/components-utils').Nil | string;
-    label: import('@arcgis/components-utils').Nil | string;
+    icon: import('@arcgis/toolkit/type').nil | string;
+    label: import('@arcgis/toolkit/type').nil | string;
     referenceElement?: ArcgisReferenceElement | string;
     position: __esri.UIPosition;
     arcgisReady: import('@arcgis/lumina').EventEmitter;
@@ -27,7 +27,54 @@ declare const useShadowCastWidget: (component: LitElement & Pick<ShadowCast, "ic
     destroy: () => Promise<void>;
 }) => ShadowCast;
 /**
- * The Shadow Cast component displays the cumulative shadows of 3D features in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ * The Shadow Cast component displays the cumulative shadows of 3D features in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).
+ * This type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.
+ *
+ * The component calculates the cumulative shadows for a time range during a single day. The user can
+ * configure the time range and select a calendar date. This time range and calendar date are only used
+ * for the shadow analysis and are not connected to the lighting in the scene.
+ * To control the lighting in the scene, the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component can be used.
+ * Changing the timezone in the component updates the visualization by interpreting the time range as being
+ * in that timezone. This behavior is different from the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component,
+ * where selecting a timezone updates the [environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) date and time according to the camera position.
+ *
+ * The component provides three [visualization modes](#visualizationType): threshold, duration, and discrete mode.
+ *
+ * In the **threshold** mode, only the areas that receive
+ * shadows for more than a certain amount of time are displayed. In the image below, on May 1, 2021 the red areas receive
+ * shadow for more than 4 hours within the time interval of 10AM to 4PM.
+ *
+ * [![threshold mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-threshold.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
+ *
+ * **Total shadow duration** mode displays the duration of the cumulative shadow using opacity: areas that don't
+ * receive any shadow are fully transparent and areas that receive a maximum amount of shadow have a default opacity
+ * of 0.7. The values in between are interpolated. Hovering over the Scene will display a tooltip showing the
+ * amount of time that location is in shadow, rounded to 15-minute intervals. In this mode, the visualization
+ * can display shadow cast in a continuous way or in 1-hour intervals.
+ *
+ * [![duration mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-duration.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
+ *
+ * **Discrete shadows** is a third visualization mode which displays individual shadows at a given time interval.
+ * For example, setting the time range to 10AM-11AM and the visualization time interval to 30 minutes will display
+ * shadows for 10AM, 10:30AM and 11:00AM.
+ *
+ * [![discrete mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-discrete.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
+ *
+ * The defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay), [endTimeOfDay](#endTimeOfDay), and [visualizationType](#visualizationType) properties.
+ *
+ * **Known limitations**
+ *
+ * * Shadow Cast is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
+ * * Terrain does not cast shadows and it is therefore not taken into account in this analysis.
+ * This influences the results when the start time of the range is before sunrise or when the end time is after the sunset.
+ * * The component does not take into account the daylight savings.
+ * Use the timezone dropdown to adjust the offset from the Coordinated Universal Time (UTC) and account for the daylight saving time.
+ * * The timezone is automatically detected by the component based on the camera location. In some situations, this might not be accurate.
+ * In case of an inaccurate timezone, users can set it manually using the timezone dropdown.
+ *
+ * **See also**
+ *
+ * - [Sample - Shadow cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/)
  */
@@ -42,24 +89,34 @@ export declare class ArcgisShadowCast extends LitElement {
      * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * The calendar date used to calculate the shadow cast. This date excludes the time. If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.
+     * If no date is set, then it defaults to the current date in local system time.
+     *
+     * _See also_
+     *
+     * * [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)
+     */
     get date(): Date;
     set date(value: Date | number | string);
     /**
-     * The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to "discrete".
+     * The configuration used when the component's [visualizationType](#visualizationType)
+     * is set to "discrete".
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions)
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DiscreteOptions.html)
      */
     discreteOptions: __esri.DiscreteOptions;
     /**
-     * The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to "duration".
+     * The configuration used when the component's [visualizationType](#visualizationType)
+     * is set to "duration".
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#durationOptions)
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DurationOptions.html)
      */
     durationOptions: __esri.DurationOptions;
     /**
-     * Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date)) when the shadow cast computation should stop.
+     * Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)
      *
      * @default 16 * 3600 * 1000
      */
@@ -91,69 +148,75 @@ export declare class ArcgisShadowCast extends LitElement {
     /** @default false */
     hideThresholdContextToggle: boolean;
     /**
-     * Icon which represents the widget.
+     * 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](https://developers.arcgis.com/calcite-design-system/icons/)
      *
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      * @default "measure-building-height-shadow"
      */
     icon: string;
-    /**
-     * The widget's default label.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#label)
-     */
+    /** The component's default label. */
     label: string;
     /** @default "bottom-left" */
     position: __esri.UIPosition;
+    /**
+     * 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 [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
+     */
     referenceElement?: ArcgisReferenceElement | string;
     /**
-     * Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date))
-     * when the shadow cast computation should start.
+     * Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should start.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)
      *
      * @default 10 * 3600 * 1000
      */
     startTimeOfDay: number;
     /**
-     * The current state of the view model that can be used for rendering the UI
-     * of the widget.
+     * The component's state. The values mean the following:
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#state)
+     * * `disabled` -  component is being created
+     * * `ready` - component is ready
      *
      * @default "disabled"
      */
     readonly state: "ready" | "disabled";
     /**
-     * The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to "threshold".
+     * The configuration used when the component's [visualizationType](#visualizationType)
+     * is set to "threshold".
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions)
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ThresholdOptions.html)
      */
     thresholdOptions: __esri.ThresholdOptions;
-    /**
-     * The difference in hours between UTC time and the times displayed in the widget.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#utcOffset)
-     */
+    /** The difference in hours between UTC time and the times displayed in the component. */
     utcOffset: number;
     /**
-     * Type of visualization to use when showing the shadows.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType)
+     * Type of visualization to use when showing the shadows. There are 3 types of visualization:
+     * * `threshold` - only displays areas that receive shadows for a period longer than a given threshold value
+     * * `duration` - displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals
+     * * `discrete` - displays individual shadows cast at a given time interval
      *
      * @default "threshold"
      */
     visualizationType: "duration" | "threshold" | "discrete";
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
+    /**
+     * Returns the time (in milliseconds) spent in shadow for a certain point on the screen.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#getDuration)
+     */
     getDuration(point: __esri.Point): Promise<number>;
+    /** Starts the component. While running, it will automatically perform shadow accumulation. */
     start(): Promise<void>;
+    /** Stops the component. */
     stop(): Promise<void>;
     /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state";
     }>;
-    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
     readonly _setterTypes: {
         date?: Date | number | string;

package/dist/components/arcgis-shadow-cast/customElement.js

@@ -3,10 +3,10 @@ import { usePropertyChange as i } from "@arcgis/lumina/controllers";
 import s from "@arcgis/core/widgets/ShadowCast.js";
 import { LitElement as o, createEvent as h, noShadowRoot as d } from "@arcgis/lumina";
 import { m as l } from "../../chunks/useWidget.js";
-import { css as a } from "@lit/reactive-element/css-tag.js";
+import { css as a } from "lit";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.8 */
+v4.34.0-next.81 */
 const r = a`@layer{arcgis-shadow-cast{display:block}}`, n = l(s);
 class m extends o {
   constructor() {

package/dist/components/arcgis-sketch/customElement.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
-/// <reference types="../../index.d.ts" />
+/// <reference path="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
 import { default as GraphicsLayer } from '@arcgis/core/layers/GraphicsLayer.js';
 import { default as Sketch } from '@arcgis/core/widgets/Sketch.js';
@@ -10,8 +10,8 @@ declare const useSketchWidget: (component: LitElement & Pick<Sketch, "icon" | "l
     state?: "ready" | "disabled" | "active" | undefined;
     viewModel?: __esri.SketchViewModel | undefined;
     closed?: boolean;
-    icon: import('@arcgis/components-utils').Nil | string;
-    label: import('@arcgis/components-utils').Nil | string;
+    icon: import('@arcgis/toolkit/type').nil | string;
+    label: import('@arcgis/toolkit/type').nil | string;
     referenceElement?: ArcgisReferenceElement | string;
     position: __esri.UIPosition;
     arcgisReady: import('@arcgis/lumina').EventEmitter;
@@ -39,7 +39,7 @@ export declare class ArcgisSketch extends LitElement {
      *
      * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#activeTool)
      */
-    readonly activeTool: nullish | "rectangle" | "polygon" | "point" | "move" | "circle" | "reshape" | "multipoint" | "polyline" | "mesh" | "transform" | "freehandPolyline" | "freehandPolygon" | "rectangle-selection" | "lasso-selection" | "custom-selection";
+    readonly activeTool: nullish | "polygon" | "multipoint" | "point" | "polyline" | "mesh" | "circle" | "rectangle" | "move" | "reshape" | "transform" | "freehandPolyline" | "freehandPolygon" | "rectangle-selection" | "lasso-selection" | "custom-selection";
     /**
      * 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
@@ -55,7 +55,7 @@ export declare class ArcgisSketch extends LitElement {
      *
      * @default ["point", "polyline", "polygon", "rectangle", "circle"]
      */
-    availableCreateTools: nullish | ("rectangle" | "polygon" | "point" | "circle" | "multipoint" | "polyline" | "mesh" | "freehandPolyline" | "freehandPolygon")[];
+    availableCreateTools: nullish | ("polygon" | "multipoint" | "point" | "polyline" | "mesh" | "circle" | "rectangle" | "freehandPolyline" | "freehandPolygon")[];
     /**
      * The graphic that is being created.
      *
@@ -67,7 +67,7 @@ export declare class ArcgisSketch extends LitElement {
      *
      * @default "continuous"
      */
-    creationMode: "update" | "single" | "continuous";
+    creationMode: "single" | "update" | "continuous";
     /**
      * Default create options set for the Sketch widget.
      *
@@ -155,7 +155,7 @@ export declare class ArcgisSketch extends LitElement {
      *
      * @default "horizontal"
      */
-    layout: "vertical" | "horizontal";
+    layout: "horizontal" | "vertical";
     /**
      * A [SimpleMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html), [PointSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PointSymbol3D.html), [TextSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-TextSymbol.html), [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html), or [WebStyleSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-WebStyleSymbol.html) used for representing the point geometry that is being drawn.
      *
@@ -176,6 +176,11 @@ export declare class ArcgisSketch extends LitElement {
     polylineSymbol: __esri.SimpleLineSymbol | __esri.CIMSymbol | __esri.LineSymbol3D;
     /** @default "bottom-left" */
     position: __esri.UIPosition;
+    /**
+     * 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 [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
+     */
     referenceElement?: ArcgisReferenceElement | string;
     /**
      * Determines the size of widget elements.
@@ -232,7 +237,7 @@ export declare class ArcgisSketch extends LitElement {
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state";
     }>;
-    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
     readonly arcgisRedo: TargetedEvent<this, __esri.SketchRedoEvent>;
     readonly arcgisUndo: TargetedEvent<this, __esri.SketchUndoEvent>;

package/dist/components/arcgis-sketch/customElement.js

@@ -1,27 +1,28 @@
-import { c as s } from "../../chunks/runtime.js";
+import { c as l } from "../../chunks/runtime.js";
 import { usePropertyChange as o } from "@arcgis/lumina/controllers";
-import { reEmitEvent as e } from "@arcgis/lumina/controllers/accessor";
-import l from "@arcgis/core/layers/GraphicsLayer.js";
+import { reEmitEvent as i } from "@arcgis/lumina/controllers/accessor";
+import a from "@arcgis/core/layers/GraphicsLayer.js";
 import n from "@arcgis/core/widgets/Sketch.js";
-import { LitElement as a, createEvent as h, noShadowRoot as d } from "@arcgis/lumina";
-import { m as r } from "../../chunks/useWidget.js";
-import { css as g } from "@lit/reactive-element/css-tag.js";
+import { LitElement as h, createEvent as d, noShadowRoot as r } from "@arcgis/lumina";
+import { m as g } from "../../chunks/useWidget.js";
+import { css as p } from "lit";
+import { watch as c } from "@arcgis/core/core/reactiveUtils.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.8 */
-const p = g`@layer{arcgis-sketch{display:block}}`, c = r(n);
-class m extends a {
+v4.34.0-next.81 */
+const m = p`@layer{arcgis-sketch{display:block}}`, y = g(n);
+class w extends h {
   constructor() {
-    super(), this.widget = c(this), this.viewModel = this.widget.viewModel, this.activeTool = this.widget.activeTool, this.autoDestroyDisabled = !1, this.availableCreateTools = this.widget.availableCreateTools, this.createGraphic = this.widget.createGraphic, this.creationMode = this.widget.creationMode, this.defaultCreateOptions = this.widget.defaultCreateOptions, this.defaultGraphicsLayerDisabled = !1, this.defaultUpdateOptions = this.widget.defaultUpdateOptions, this.hideCreateToolsCircle = this.widget.visibleElements.createTools.circle, this.hideCreateToolsPoint = this.widget.visibleElements.createTools.point, this.hideCreateToolsPolygon = this.widget.visibleElements.createTools.polygon, this.hideCreateToolsPolyline = this.widget.visibleElements.createTools.polyline, this.hideCreateToolsRectangle = this.widget.visibleElements.createTools.rectangle, this.hideDuplicateButton = this.widget.visibleElements.duplicateButton, this.hideDeleteButton = this.widget.visibleElements.deleteButton, this.hideSelectionCountLabel = this.widget.visibleElements.selectionCountLabel, this.hideLabelsToggle = this.widget.visibleElements.labelsToggle, this.hideSelectionToolsLassoSelection = this.widget.visibleElements.selectionTools["lasso-selection"], this.hideSelectionToolsRectangleSelection = this.widget.visibleElements.selectionTools["rectangle-selection"], this.hideSettingsMenu = this.widget.visibleElements.settingsMenu, this.hideSnappingControls = this.widget.visibleElements.snappingControls, this.hideSnappingControlsElementsEnabledToggle = this.widget.visibleElements.snappingControlsElements.enabledToggle, this.hideSnappingControlsElementsFeatureEnabledToggle = this.widget.visibleElements.snappingControlsElements.featureEnabledToggle, this.hideSnappingControlsElementsLayerList = this.widget.visibleElements.snappingControlsElements.layerList, this.hideSnappingControlsElementsSelfEnabledToggle = this.widget.visibleElements.snappingControlsElements.selfEnabledToggle, this.hideTooltipsToggle = this.widget.visibleElements.tooltipsToggle, this.hideUndoRedoMenu = this.widget.visibleElements.undoRedoMenu, this.icon = this.widget.icon, this.label = this.widget.label, this.labelOptions = this.widget.labelOptions, this.layer = this.widget.layer, this.layout = this.widget.layout, this.pointSymbol = this.viewModel.pointSymbol, this.polygonSymbol = this.viewModel.polygonSymbol, this.polylineSymbol = this.viewModel.polylineSymbol, this.position = "bottom-left", this.scale = this.widget.scale, this.toolbarKind = this.widget.toolbarKind, this.showSnappingControlsElementsHeader = this.widget.visibleElements.snappingControlsElements.header, this.snappingOptions = this.widget.snappingOptions, this.state = this.widget.state, this.tooltipOptions = this.widget.tooltipOptions, this.updateGraphics = this.widget.updateGraphics, this.arcgisCreate = e(() => this.widget, "create"), this.arcgisDelete = e(() => this.widget, "delete"), this.arcgisPropertyChange = o()("state"), this.arcgisReady = h(), this.arcgisRedo = e(() => this.widget, "redo"), this.arcgisUndo = e(() => this.widget, "undo"), this.arcgisUpdate = e(() => this.widget, "update"), this.widget.layer = new l({ title: "Sketch Layer" }), this.listen("arcgisReady", this._arcgisReadyHandler);
+    super(), this.widget = y(this), this.viewModel = this.widget.viewModel, this._defaultGraphicsLayer = null, this.activeTool = this.widget.activeTool, this.autoDestroyDisabled = !1, this.availableCreateTools = this.widget.availableCreateTools, this.createGraphic = this.widget.createGraphic, this.creationMode = this.widget.creationMode, this.defaultCreateOptions = this.widget.defaultCreateOptions, this.defaultGraphicsLayerDisabled = !1, this.defaultUpdateOptions = this.widget.defaultUpdateOptions, this.hideCreateToolsCircle = this.widget.visibleElements.createTools.circle, this.hideCreateToolsPoint = this.widget.visibleElements.createTools.point, this.hideCreateToolsPolygon = this.widget.visibleElements.createTools.polygon, this.hideCreateToolsPolyline = this.widget.visibleElements.createTools.polyline, this.hideCreateToolsRectangle = this.widget.visibleElements.createTools.rectangle, this.hideDuplicateButton = this.widget.visibleElements.duplicateButton, this.hideDeleteButton = this.widget.visibleElements.deleteButton, this.hideSelectionCountLabel = this.widget.visibleElements.selectionCountLabel, this.hideLabelsToggle = this.widget.visibleElements.labelsToggle, this.hideSelectionToolsLassoSelection = this.widget.visibleElements.selectionTools["lasso-selection"], this.hideSelectionToolsRectangleSelection = this.widget.visibleElements.selectionTools["rectangle-selection"], this.hideSettingsMenu = this.widget.visibleElements.settingsMenu, this.hideSnappingControls = this.widget.visibleElements.snappingControls, this.hideSnappingControlsElementsEnabledToggle = this.widget.visibleElements.snappingControlsElements.enabledToggle, this.hideSnappingControlsElementsFeatureEnabledToggle = this.widget.visibleElements.snappingControlsElements.featureEnabledToggle, this.hideSnappingControlsElementsLayerList = this.widget.visibleElements.snappingControlsElements.layerList, this.hideSnappingControlsElementsSelfEnabledToggle = this.widget.visibleElements.snappingControlsElements.selfEnabledToggle, this.hideTooltipsToggle = this.widget.visibleElements.tooltipsToggle, this.hideUndoRedoMenu = this.widget.visibleElements.undoRedoMenu, this.icon = this.widget.icon, this.label = this.widget.label, this.labelOptions = this.widget.labelOptions, this.layer = this.widget.layer, this.layout = this.widget.layout, this.pointSymbol = this.viewModel.pointSymbol, this.polygonSymbol = this.viewModel.polygonSymbol, this.polylineSymbol = this.viewModel.polylineSymbol, this.position = "bottom-left", this.scale = this.widget.scale, this.toolbarKind = this.widget.toolbarKind, this.showSnappingControlsElementsHeader = this.widget.visibleElements.snappingControlsElements.header, this.snappingOptions = this.widget.snappingOptions, this.state = this.widget.state, this.tooltipOptions = this.widget.tooltipOptions, this.updateGraphics = this.widget.updateGraphics, this.arcgisCreate = i(() => this.widget, "create"), this.arcgisDelete = i(() => this.widget, "delete"), this.arcgisPropertyChange = o()("state"), this.arcgisReady = d(), this.arcgisRedo = i(() => this.widget, "redo"), this.arcgisUndo = i(() => this.widget, "undo"), this.arcgisUpdate = i(() => this.widget, "update"), this.listen("arcgisReady", this._arcgisReadyHandler);
   }
   static {
     this.properties = { activeTool: 3, autoDestroyDisabled: 5, availableCreateTools: 0, createGraphic: 0, creationMode: 1, defaultCreateOptions: 0, defaultGraphicsLayerDisabled: 5, defaultUpdateOptions: 0, hideCreateToolsCircle: 5, hideCreateToolsPoint: 5, hideCreateToolsPolygon: 5, hideCreateToolsPolyline: 5, hideCreateToolsRectangle: 5, hideDuplicateButton: 5, hideDeleteButton: 5, hideSelectionCountLabel: 5, hideLabelsToggle: 5, hideSelectionToolsLassoSelection: 5, hideSelectionToolsRectangleSelection: 5, hideSettingsMenu: 5, hideSnappingControls: 5, hideSnappingControlsElementsEnabledToggle: 5, hideSnappingControlsElementsFeatureEnabledToggle: 5, hideSnappingControlsElementsLayerList: 5, hideSnappingControlsElementsSelfEnabledToggle: 5, hideTooltipsToggle: 5, hideUndoRedoMenu: 5, icon: 1, label: 1, labelOptions: 0, layer: 0, layout: 1, pointSymbol: 0, polygonSymbol: 0, polylineSymbol: 0, position: 1, referenceElement: 1, scale: 1, toolbarKind: 1, showSnappingControlsElementsHeader: 5, snappingOptions: 0, state: 3, tooltipOptions: 0, updateGraphics: 0 };
   }
   static {
-    this.shadowRootOptions = d;
+    this.shadowRootOptions = r;
   }
   static {
-    this.styles = p;
+    this.styles = m;
   }
   async cancel() {
     this.widget?.cancel();
@@ -29,8 +30,8 @@ class m extends a {
   async complete() {
     this.widget?.complete();
   }
-  async create(t, i) {
-    await this.widget?.create(t, i);
+  async create(t, e) {
+    await this.widget?.create(t, e);
   }
   async delete() {
     this.widget?.delete();
@@ -44,17 +45,24 @@ class m extends a {
   async redo() {
     this.widget?.redo();
   }
-  async triggerUpdate(t, i) {
-    this.widget?.update(t, i);
+  async triggerUpdate(t, e) {
+    this.widget?.update(t, e);
   }
   async undo() {
     this.widget?.undo();
   }
   _arcgisReadyHandler() {
-    this.defaultGraphicsLayerDisabled || this.el.view?.map?.add(this.widget.layer);
+    this.defaultGraphicsLayerDisabled || (this._defaultGraphicsLayer = new a({ title: "Sketch Layer" }), this.widget.layer = this._defaultGraphicsLayer, this.el.view?.map?.add(this.widget.layer), this.manager.onLifecycle(() => c(() => this.el.view?.map, (t, e) => {
+      if (this.widget.layer !== this._defaultGraphicsLayer)
+        return;
+      const s = this._defaultGraphicsLayer;
+      e?.allLayers.includes(s) && e.allLayers.remove(s), t?.add(s);
+    })), this.manager.onDestroy(() => {
+      this._defaultGraphicsLayer && this.el.view?.map?.allLayers.includes(this._defaultGraphicsLayer) && this.el.view?.map?.remove(this._defaultGraphicsLayer), this._defaultGraphicsLayer?.destroy(), this._defaultGraphicsLayer = null;
+    }));
   }
 }
-s("arcgis-sketch", m);
+l("arcgis-sketch", w);
 export {
-  m as ArcgisSketch
+  w as ArcgisSketch
 };

package/dist/components/arcgis-slice/SliceViewModel.d.ts

@@ -30,7 +30,6 @@ declare class SliceViewModel extends AnalysisViewModel<SceneView, SliceAnalysis>
      */
     get tiltEnabled(): boolean;
     set tiltEnabled(enabled: boolean);
-    get layersMode(): LayersMode;
     /**
      * Add layers to this collection to exclude them from the slice. Layers that
      * are draped on the ground surface are not affected by this property

package/dist/components/arcgis-slice/customElement.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
-/// <reference types="../../index.d.ts" />
+/// <reference path="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
 import { PublicLitElement as LitElement, JsxNode, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
@@ -8,28 +8,80 @@ import { HeadingLevel } from '../../support/heading';
 
 declare const useSliceViewModel: (component: LitElement & Pick<SliceViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<SliceViewModel>) => SliceViewModel;
 /**
- * The Slice component is a 3D analysis tool that can be used to reveal occluded content in a 3D view. It applies
+ * The Slice component is a 3D analysis tool that can be used to reveal occluded content in a
+ * [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). It applies
  * [slice analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)
  * to any layer type, making it possible to see inside buildings or to explore geological surfaces.
  *
- * The slicing [shape](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#shape)
+ * [![slice](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/slice.gif)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)
+ *
+ * The slicing [shape](#shape)
  * is always a [plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).
  * By default, the plane is either horizontal or vertical. To allow a tilt angle for the plane, set
- * [tiltEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#tiltEnabled)
+ * [tiltEnabled](#tiltEnabled)
  * to `true`. The slice hides any content in front of the surface. The handles on the sides of the plane can be used to adjust
  * the size, heading, tilt, and position of the slice plane.
  * The [SlicePlane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html)
- * can be set or retrieved using the [shape](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#shape) property.
+ * can be set or retrieved using the [shape](#shape) property.
  *
  * Once the slice plane is applied, layers can be excluded from the slicing. For example, by excluding the sublayers which include
  * columns and floor slabs, the inner structure of a building can investigated.
  *
+ * [![slice-exclude](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/slice-exclude.png)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)
+ *
+ * Holding the `Shift` key while placing a new slice applies it vertically.
+ *
+ * **Known limitation**
+ *
+ * Slice is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.
+ *
+ * **See also**
+ *
+ * - [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)
+ * - [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)
+ * - [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)
+ *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/)
  */
 export declare class ArcgisSlice extends LitElement {
     /**
-     * The [slice analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)
-     * object being created by the component.
+     * The [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)
+     * created or modified by the component.
+     *
+     * When connecting the Slice component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)
+     * component, it automatically creates an empty analysis and adds it to the Scene's
+     * [analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#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.
+     *
+     * ```js
+     * // Create the analysis.
+     * const sliceAnalysis = new SliceAnalysis({
+     *    shape: new SlicePlane({
+     *      position: new Point({
+     *        spatialReference: { latestWkid: 3857, wkid: 102100 },
+     *        x: -13624925.727820931,
+     *        y: 4550341.695170021,
+     *        z: 56
+     *      }),
+     *      tilt: 270,
+     *      width: 310,
+     *      height: 190,
+     *      heading: 45
+     *    })
+     * });
+     * // Get the Scene and Slice component and wait until they are ready.
+     * const viewElement = document.querySelector("arcgis-scene");
+     * await viewElement.viewOnReady();
+     * const slice = document.querySelector("arcgis-slice");
+     * await slice.componentOnReady();
+     * // Add the analysis to the Scene component.
+     * viewElement.analyses.add(sliceAnalysis);
+     * // Connect the analysis to the slice component:
+     * slice.analysis = sliceAnalysis;
+     * ```
      */
     analysis: __esri.SliceAnalysis;
     /**
@@ -54,7 +106,11 @@ export declare class ArcgisSlice extends LitElement {
      * are draped on the ground surface are not affected by this property
      */
     excludedLayers: __esri.Collection<SliceableLayer>;
-    /** @default 3 */
+    /**
+     * Indicates the heading level to use for the "Excluded layers" heading.
+     *
+     * @default 3
+     */
     headingLevel: HeadingLevel;
     /**
      * Icon which represents the component.
@@ -66,21 +122,50 @@ export declare class ArcgisSlice extends LitElement {
     icon?: HTMLCalciteIconElement["icon"];
     /** The component's default label. */
     label?: string;
-    /** Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases. */
+    /**
+     * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
+     */
     messageOverrides?: typeof this._messages._overrides;
     /** @default "bottom-left" */
     position: __esri.UIPosition;
+    /**
+     * 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 [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
+     */
     referenceElement?: ArcgisReferenceElement | string;
     /**
-     * The shape used to slice elements in a 3D scene. Currently the only supported shape is a plane.
-     * Example:
+     * The shape used to slice elements in a 3D scene. Currently the only supported shape is a
+     * [plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).
+     *
+     * @example
+     * ```js
+     * // Create a slice plane programmatically.
+     * const shape = new SlicePlane({
+     *   position: new Point({
+     *      spatialReference: { latestWkid: 3857, wkid: 102100 },
+     *      x: -13624925.727820931,
+     *      y: 4550341.695170021,
+     *      z: 56
+     *   }),
+     *   tilt: 270,
+     *   width: 310,
+     *   height: 190,
+     *   heading: 45
+     * });
+     * // Apply the new shape to the slice component's shape.
+     * slice.shape = shape;
      * ```
-     * // Clone the shape to modify its properties
+     * @example
+     * ```js
+     * // Clone the shape to modify its properties.
      * const shape = slice.shape.clone();
-     * // Set new values for heading and tilt
+     * // Set new values for heading and tilt.
      * shape.heading = 180;
      * shape.tilt = 45;
-     * // Apply the new shape to the slice component's shape
+     * // Apply the new shape to the slice component's shape.
      * slice.shape = shape;
      * ```
      */
@@ -88,12 +173,13 @@ export declare class ArcgisSlice extends LitElement {
     /**
      * The component's state. The values mean the following:
      *
-     * * `disabled` -  not ready yet
+     * * `disabled` - not ready yet
+     * * `excludingLayer` - currently excluding a layer from the slice
      * * `ready` - ready for slicing
      * * `slicing` - currently slicing
-     * * `sliced` - finished slicing
+     * * `sliced` - finished slicing and a valid shape is available
      */
-    state: "ready" | "disabled" | "excludingLayer" | "sliced" | "slicing";
+    readonly state: "ready" | "disabled" | "excludingLayer" | "sliced" | "slicing";
     /**
      * Enable tilting the slice shape. If set to true, the slice shape will orient itself as best as
      * possible to the surface under the cursor when first placing the shape. If set to false, the slice shape is
@@ -103,23 +189,23 @@ export declare class ArcgisSlice extends LitElement {
      */
     tiltEnabled: boolean;
     /**
-     * Clear the [shape](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#shape) of the slice,
-     * effectively removing it from the view. Other properties like [excludedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#excludedLayers)
-     * and [excludeGroundSurface](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#excludeGroundSurface) are not modified.
+     * Clear the [shape](#shape) of the slice, effectively removing it from the view. Other properties like [excludedLayers](#excludedLayers)
+     * and [excludeGroundSurface](#excludeGroundSurface) are not modified.
+     * Calling this method changes the [state](#state) to `ready`.
      */
     clear(): Promise<void>;
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
     /**
-     * Start the interactive creation of a new slice, clearing the previous
-     * [shape](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#shape).
+     * Start the interactive placement of a new slice, clearing the previous [shape](#shape).
+     * Calling this method changes the [state](#state) to `slicing`.
      */
     start(): Promise<void>;
     /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state" | "analysis";
     }>;
-    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
     private _messages;
 }