@arcgis/map-components 4.33.0-next.98 → 4.33.0

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

@@ -1,17 +1,17 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
-import { Nil } from '@arcgis/components-utils';
 import { default as ShadowCast } from '@arcgis/core/widgets/ShadowCast.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useShadowCastWidget: (component: LitElement & Pick<ShadowCast, never> & {
+declare const useShadowCastWidget: (component: LitElement & Pick<ShadowCast, "icon" | "label" | "viewModel" | "headingLevel"> & {
     state?: unknown;
     viewModel?: __esri.ShadowCastViewModel | undefined;
-    icon: Nil | string;
-    label: Nil | string;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    closed?: boolean;
+    icon: import('@arcgis/components-utils').Nil | string;
+    label: import('@arcgis/components-utils').Nil | string;
+    referenceElement?: ArcgisReferenceElement | string;
     position: __esri.UIPosition;
     arcgisReady: import('@arcgis/lumina').EventEmitter;
     arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
@@ -21,57 +21,204 @@ declare const useShadowCastWidget: (component: LitElement & Pick<ShadowCast, nev
         childElem?: HTMLElement & {
             ownedBy?: HTMLElement;
         };
-        view?: __esri.MapView | __esri.SceneView | Nil;
+        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
     };
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
-}, options?: {
-    editConstructorProperties(props: __esri.ShadowCastProperties | undefined): __esri.ShadowCastProperties | Promise<__esri.ShadowCastProperties | undefined> | undefined;
-} | undefined) => ShadowCast;
-/** ShadowCast component displays the cumulative shadows of 3D features in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+}) => ShadowCast;
+/**
+ * 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.
+ * * 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/)
  */
 export declare class ArcgisShadowCast extends LitElement {
     /**
      * 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.
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
-    discreteOptions: __esri.ShadowCastViewModelDiscreteOptions;
-    durationOptions: __esri.ShadowCastViewModelDurationOptions;
+    /**
+     * 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 component's [visualizationType](#visualizationType)
+     * is set to "discrete".
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DiscreteOptions.html)
+     */
+    discreteOptions: __esri.DiscreteOptions;
+    /**
+     * 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-DurationOptions.html)
+     */
+    durationOptions: __esri.DurationOptions;
+    /**
+     * 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)
+     *
+     * @default 16 * 3600 * 1000
+     */
     endTimeOfDay: number;
+    /**
+     * Indicates the heading level to use for the titles "Time range" and "Visualization".
+     *
+     * @default 4
+     */
     headingLevel: number;
+    /** @default false */
     hideColorPicker: boolean;
+    /** @default false */
     hideDatePicker: boolean;
+    /** @default false */
     hideTimeRangeSlider: boolean;
+    /** @default false */
     hideTimezone: boolean;
+    /** @default false */
     hideTooltip: boolean;
+    /** @default false */
     hideVisualizationOptions: boolean;
+    /** @default false */
+    hideThresholdContext: boolean;
+    /** @default false */
+    hideThresholdContextColor: boolean;
+    /** @default false */
+    hideThresholdContextTimeInterval: boolean;
+    /** @default false */
+    hideThresholdContextToggle: boolean;
     /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     * Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
+     * 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/)
+     *
+     * @default "measure-building-height-shadow"
      */
     icon: string;
     /** The component's default label. */
     label: string;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * 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](#date)) when the shadow cast computation should start.
+     *
+     * [Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)
+     *
+     * @default 10 * 3600 * 1000
+     */
     startTimeOfDay: number;
+    /**
+     * The component's state. The values mean the following:
+     *
+     * * `disabled` -  component is being created
+     * * `ready` - component is ready
+     *
+     * @default "disabled"
+     */
     readonly state: "ready" | "disabled";
-    thresholdOptions: __esri.ShadowCastViewModelThresholdOptions;
+    /**
+     * 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-ThresholdOptions.html)
+     */
+    thresholdOptions: __esri.ThresholdOptions;
+    /** 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. 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 */
+    /** 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";
     }>;
-    readonly arcgisReady: TargetedEvent<this, undefined>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
+    readonly _setterTypes: {
+        date?: Date | number | string;
+    };
 }
 export {};

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

@@ -1,34 +1,37 @@
 import { c as t } from "../../chunks/runtime.js";
-import { usePropertyChange as e } from "@arcgis/lumina/controllers";
+import { usePropertyChange as i } from "@arcgis/lumina/controllers";
 import s from "@arcgis/core/widgets/ShadowCast.js";
-import { LitElement as o, createEvent as a, noShadowRoot as h } from "@arcgis/lumina";
-import { m as d } from "../../chunks/useWidget.js";
-import { css as r } from "@lit/reactive-element/css-tag.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";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.33/esri/copyright.txt for details.
-v4.33.0-next.98 */
-const l = r`@layer{arcgis-shadow-cast{display:block}}`, n = d(s);
-class c extends o {
+v4.33.0 */
+const r = a`@layer{arcgis-shadow-cast{display:block}}`, n = l(s);
+class m extends o {
   constructor() {
-    super(...arguments), this.widget = n(this), this.viewModel = this.widget.viewModel, this.autoDestroyDisabled = !1, this.discreteOptions = this.viewModel.discreteOptions, this.durationOptions = this.viewModel.durationOptions, this.endTimeOfDay = this.viewModel.endTimeOfDay, this.headingLevel = this.widget.headingLevel, this.hideColorPicker = this.widget.visibleElements.colorPicker, this.hideDatePicker = this.widget.visibleElements.datePicker, this.hideTimeRangeSlider = this.widget.visibleElements.timeRangeSlider, this.hideTimezone = this.widget.visibleElements.timezone, this.hideTooltip = this.widget.visibleElements.tooltip, this.hideVisualizationOptions = this.widget.visibleElements.visualizationOptions, this.icon = this.widget.icon, this.label = this.widget.label, this.position = "bottom-left", this.startTimeOfDay = this.viewModel.startTimeOfDay, this.state = this.viewModel.state, this.thresholdOptions = this.viewModel.thresholdOptions, this.utcOffset = this.viewModel.utcOffset, this.visualizationType = this.viewModel.visualizationType, this.arcgisPropertyChange = e()("state"), this.arcgisReady = a();
+    super(...arguments), this.widget = n(this), this.viewModel = this.widget.viewModel, this.autoDestroyDisabled = !1, this.discreteOptions = this.viewModel.discreteOptions, this.durationOptions = this.viewModel.durationOptions, this.endTimeOfDay = this.viewModel.endTimeOfDay, this.headingLevel = this.widget.headingLevel, this.hideColorPicker = this.widget.visibleElements.colorPicker, this.hideDatePicker = this.widget.visibleElements.datePicker, this.hideTimeRangeSlider = this.widget.visibleElements.timeRangeSlider, this.hideTimezone = this.widget.visibleElements.timezone, this.hideTooltip = this.widget.visibleElements.tooltip, this.hideVisualizationOptions = this.widget.visibleElements.visualizationOptions, this.hideThresholdContext = this.widget.visibleElements.thresholdContext, this.hideThresholdContextColor = this.widget.visibleElements.thresholdContextColor, this.hideThresholdContextTimeInterval = this.widget.visibleElements.thresholdContextTimeInterval, this.hideThresholdContextToggle = this.widget.visibleElements.thresholdContextToggle, this.icon = this.widget.icon, this.label = this.widget.label, this.position = "bottom-left", this.startTimeOfDay = this.viewModel.startTimeOfDay, this.state = this.viewModel.state, this.thresholdOptions = this.viewModel.thresholdOptions, this.utcOffset = this.viewModel.utcOffset, this.visualizationType = this.viewModel.visualizationType, this.arcgisPropertyChange = i()("state"), this.arcgisReady = h();
   }
   static {
-    this.properties = { autoDestroyDisabled: 5, discreteOptions: 0, durationOptions: 0, endTimeOfDay: 9, headingLevel: 9, hideColorPicker: 5, hideDatePicker: 5, hideTimeRangeSlider: 5, hideTimezone: 5, hideTooltip: 5, hideVisualizationOptions: 5, icon: 1, label: 1, position: 1, referenceElement: 1, startTimeOfDay: 9, state: 3, thresholdOptions: 0, utcOffset: 9, visualizationType: 1 };
+    this.properties = { autoDestroyDisabled: 5, date: 1, discreteOptions: 0, durationOptions: 0, endTimeOfDay: 9, headingLevel: 9, hideColorPicker: 5, hideDatePicker: 5, hideTimeRangeSlider: 5, hideTimezone: 5, hideTooltip: 5, hideVisualizationOptions: 5, hideThresholdContext: 5, hideThresholdContextColor: 5, hideThresholdContextTimeInterval: 5, hideThresholdContextToggle: 5, icon: 1, label: 1, position: 1, referenceElement: 1, startTimeOfDay: 9, state: 3, thresholdOptions: 0, utcOffset: 9, visualizationType: 1 };
   }
   static {
-    this.shadowRootOptions = h;
+    this.shadowRootOptions = d;
   }
   static {
-    this.styles = l;
+    this.styles = r;
+  }
+  get date() {
+    return this.viewModel.date;
+  }
+  set date(e) {
+    this.viewModel.date = e;
   }
-  //#endregion
-  //#region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }
-  async getDuration(i) {
-    return await this.widget?.viewModel.getDuration(i);
+  async getDuration(e) {
+    return await this.widget?.viewModel.getDuration(e);
   }
   async start() {
     this.widget?.viewModel.start();
@@ -37,7 +40,7 @@ class c extends o {
     this.widget?.viewModel.stop();
   }
 }
-t("arcgis-shadow-cast", c);
+t("arcgis-shadow-cast", m);
 export {
-  c as ArcgisShadowCast
+  m as ArcgisShadowCast
 };

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

@@ -1,18 +1,18 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
-import { Nil } from '@arcgis/components-utils';
 import { default as GraphicsLayer } from '@arcgis/core/layers/GraphicsLayer.js';
 import { default as Sketch } from '@arcgis/core/widgets/Sketch.js';
 import { PublicLitElement as LitElement, ToElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useSketchWidget: (component: LitElement & Pick<Sketch, never> & {
+declare const useSketchWidget: (component: LitElement & Pick<Sketch, "icon" | "label" | "viewModel" | "scale" | "layout" | "layer" | "availableCreateTools" | "creationMode" | "defaultCreateOptions" | "defaultUpdateOptions" | "labelOptions" | "toolbarKind" | "snappingOptions" | "tooltipOptions"> & {
     state?: "ready" | "disabled" | "active" | undefined;
     viewModel?: __esri.SketchViewModel | undefined;
-    icon: Nil | string;
-    label: Nil | string;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    closed?: boolean;
+    icon: import('@arcgis/components-utils').Nil | string;
+    label: import('@arcgis/components-utils').Nil | string;
+    referenceElement?: ArcgisReferenceElement | string;
     position: __esri.UIPosition;
     arcgisReady: import('@arcgis/lumina').EventEmitter;
     arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
@@ -22,82 +22,207 @@ declare const useSketchWidget: (component: LitElement & Pick<Sketch, never> & {
         childElem?: HTMLElement & {
             ownedBy?: HTMLElement;
         };
-        view?: __esri.MapView | __esri.SceneView | Nil;
+        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
     };
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
-}, options?: {
-    editConstructorProperties(props: __esri.SketchProperties | undefined): __esri.SketchProperties | Promise<__esri.SketchProperties | undefined> | undefined;
-} | undefined) => Sketch;
-/** Sketch component provides a simple UI for creating and updating graphics on a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+}) => Sketch;
+/**
+ * The Sketch component provides a simple UI for creating and updating graphics on a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-sketch/)
  */
 export declare class ArcgisSketch extends LitElement {
+    /**
+     * When creating new graphics (for example after [create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) has been called),
+     * this property reflects the create tool being used.
+     *
+     * [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";
     /**
      * 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.
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-sketch/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * Property controlling the visibility and order of create tool buttons.
+     *
+     * @default ["point", "polyline", "polygon", "rectangle", "circle"]
+     */
     availableCreateTools: nullish | ("rectangle" | "polygon" | "point" | "circle" | "multipoint" | "polyline" | "mesh" | "freehandPolyline" | "freehandPolygon")[];
+    /**
+     * The graphic that is being created.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#createGraphic)
+     */
     readonly createGraphic: nullish | __esri.Graphic;
+    /**
+     * Defines the default behavior once the [create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) operation is completed.
+     *
+     * @default "continuous"
+     */
     creationMode: "update" | "single" | "continuous";
+    /**
+     * Default create options set for the Sketch widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultCreateOptions)
+     */
     defaultCreateOptions: __esri.SketchDefaultCreateOptions;
     /**
      * By default, sketch will auto-create a new graphics layer if none was
      * provided. Set this prop to true to disable this behavior.
+     *
+     * @default false
      */
     defaultGraphicsLayerDisabled: boolean;
+    /**
+     * Default update options set for the Sketch widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#defaultUpdateOptions)
+     */
     defaultUpdateOptions: __esri.SketchDefaultUpdateOptions;
+    /** @default false */
     hideCreateToolsCircle: boolean;
+    /** @default false */
     hideCreateToolsPoint: boolean;
+    /** @default false */
     hideCreateToolsPolygon: boolean;
+    /** @default false */
     hideCreateToolsPolyline: boolean;
+    /** @default false */
     hideCreateToolsRectangle: boolean;
+    /** @default false */
     hideDuplicateButton: boolean;
+    /** @default false */
     hideDeleteButton: boolean;
+    /** @default false */
     hideSelectionCountLabel: boolean;
+    /** @default false */
     hideLabelsToggle: boolean;
+    /** @default false */
     hideSelectionToolsLassoSelection: boolean;
+    /** @default false */
     hideSelectionToolsRectangleSelection: boolean;
+    /** @default false */
     hideSettingsMenu: boolean;
+    /** @default false */
     hideSnappingControls: boolean;
+    /** @default false */
     hideSnappingControlsElementsEnabledToggle: boolean;
+    /** @default false */
     hideSnappingControlsElementsFeatureEnabledToggle: boolean;
+    /** @default false */
     hideSnappingControlsElementsLayerList: boolean;
+    /** @default false */
     hideSnappingControlsElementsSelfEnabledToggle: boolean;
+    /** @default false */
     hideTooltipsToggle: boolean;
+    /** @default false */
     hideUndoRedoMenu: boolean;
     /**
      * Icon which represents the component.
      * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     * Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "pencil"
      */
     icon: string;
-    /** The component's default label. */
+    /**
+     * The Sketch widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#label)
+     */
     label: string;
+    /**
+     * Options to configure the sketch labels shown next to each segment of the geometry being created or updated.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#labelOptions)
+     */
     labelOptions: __esri.SketchLabelOptions;
+    /**
+     * The [GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) associated with the Sketch widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#layer)
+     */
     layer: GraphicsLayer;
+    /**
+     * Determines the layout/orientation of the Sketch widget.
+     *
+     * @default "horizontal"
+     */
     layout: "vertical" | "horizontal";
+    /**
+     * 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.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#pointSymbol)
+     */
     pointSymbol: __esri.SimpleMarkerSymbol | __esri.PictureMarkerSymbol | __esri.PointSymbol3D | __esri.TextSymbol | __esri.CIMSymbol | __esri.WebStyleSymbol;
+    /**
+     * A [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html), [PolygonSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PolygonSymbol3D.html), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) used for representing the polygon geometry that is being drawn.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polygonSymbol)
+     */
     polygonSymbol: __esri.CIMSymbol | __esri.SimpleFillSymbol | __esri.PolygonSymbol3D;
+    /**
+     * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html), [LineSymbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-LineSymbol3D.html), or [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html) used for representing the polyline geometry that is being drawn.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-SketchViewModel.html#polylineSymbol)
+     */
     polylineSymbol: __esri.SimpleLineSymbol | __esri.CIMSymbol | __esri.LineSymbol3D;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * 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.
+     *
+     * @default "m"
+     */
     scale: "s" | "m" | "l";
+    /**
+     * Controls the appearance of the sketch widget, allowing
+     * the toolbar to adapt its appearance appropriately based on context.
+     *
+     * @default "floating"
+     */
     toolbarKind: "floating" | "docked";
+    /** @default false */
     showSnappingControlsElementsHeader: boolean;
+    /**
+     * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#snappingOptions)
+     */
     snappingOptions: __esri.SnappingOptions;
+    /** The current state of the component. */
     readonly state: "ready" | "disabled" | "active";
+    /**
+     * Options to configure the tooltip shown next to the cursor when creating or updating graphics.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#tooltipOptions)
+     */
     tooltipOptions: __esri.SketchTooltipOptions;
+    /**
+     * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) that are being updated by the Sketch widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#updateGraphics)
+     */
     readonly updateGraphics: __esri.Collection<__esri.Graphic>;
     cancel(): Promise<void>;
     complete(): Promise<void>;
     create(tool: "circle" | "point" | "polygon" | "polyline" | "rectangle", createOptions?: __esri.SketchViewModelCreateCreateOptions): Promise<void>;
     delete(): Promise<void>;
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     duplicate(): Promise<void>;
     redo(): Promise<void>;
@@ -105,10 +230,12 @@ export declare class ArcgisSketch extends LitElement {
     undo(): Promise<void>;
     readonly arcgisCreate: TargetedEvent<this, __esri.SketchCreateEvent>;
     readonly arcgisDelete: TargetedEvent<this, __esri.SketchDeleteEvent>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state";
     }>;
-    readonly arcgisReady: TargetedEvent<this, undefined>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
     readonly arcgisRedo: TargetedEvent<this, __esri.SketchRedoEvent>;
     readonly arcgisUndo: TargetedEvent<this, __esri.SketchUndoEvent>;
     readonly arcgisUpdate: TargetedEvent<this, __esri.SketchUpdateEvent>;