@arcgis/map-components 5.1.0-next.3 → 5.1.0-next.31

package/dist/components/arcgis-feature-templates/customElement.d.ts

@@ -1,215 +0,0 @@
-/// <reference path="../../index.d.ts" />
-import type TemplateItem from "@arcgis/core/widgets/FeatureTemplates/TemplateItem";
-import type SubtypeGroupLayer from "@arcgis/core/layers/SubtypeGroupLayer.js";
-import type TemplateItem2 from "@arcgis/core/widgets/FeatureTemplates/TemplateItem.js";
-import type TemplateItemGroup from "@arcgis/core/widgets/FeatureTemplates/TemplateItemGroup.js";
-import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
-import type { IconName } from "../../utils/action-utils.js";
-import type { SelectEvent } from "@arcgis/core/widgets/FeatureTemplates/FeatureTemplatesViewModel";
-import type { Filter, GroupByType } from "@arcgis/core/widgets/FeatureTemplates/types.js";
-import type { HeadingLevel } from "@arcgis/core/widgets/support/types.js";
-import type { Icon } from "@esri/calcite-components/components/calcite-icon";
-import type { LayerWithFeatureTemplatesUnion } from "@arcgis/core/layers/types.js";
-import type { FeatureTemplatesViewModelState } from "@arcgis/core/widgets/FeatureTemplates/FeatureTemplatesViewModel.js";
-
-/** @internal */
-export abstract class ArcgisFeatureTemplates 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()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-templates/#destroy) method when you are done to
-   * prevent memory leaks.
-   *
-   * @default false
-   */
-  accessor autoDestroyDisabled: boolean;
-  accessor disabledItemFunction: DisabledItemFunction;
-  /**
-   * Indicates whether the list of available feature [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) should scroll within its containing element.
-   *
-   * @default false
-   * @since 4.28
-   */
-  accessor enableListScroll: boolean;
-  /**
-   * [function](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-types.html#Filter) can be defined to help filter
-   * [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) within the component.
-   * A custom function can be used to aid when searching for templates. It takes a function which passes in
-   * an object containing a [name](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html#label)
-   * property of the [template item](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html).
-   *
-   * ![featureTemplatesFilterFunction](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featureTemplatesFilterFunction.png)
-   *
-   * @example
-   * // Filter and display templates only if their labels contain the word `Street`
-   * function myFilterFunction(filter) {
-   *   let containsName = filter.label.includes("Street");
-   *   return containsName;
-   * }
-   *
-   * // Create the FeatureTemplates widget
-   * templates = new FeatureTemplates({
-   *   container: "templatesDiv",
-   *   visibleElements: {
-   *     filter: false, // disable the default filter UI
-   *   },
-   *   layers: [featureLayer], // in this example, one layer is used
-   *   filterFunction: myFilterFunction
-   * });
-   */
-  accessor filterFunction: Filter | null | undefined;
-  /**
-   * Text used to filter items.
-   *
-   * @default ""
-   */
-  accessor filterText: string;
-  /**
-   * It is possible to group [template items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html). This can aid
-   * in managing various template items and how they display within the component. The values are discussed below.
-   *
-   * Type | Description | Example
-   * ----- | ----------- | -------
-   * layer | This is the *default* grouping. Groups template items by layers. | ![featureTemplatesGroupByLayer](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/groupByLayers.png)
-   * geometry | Groups template items by geometry type. | ![FeatureTemplatesGroupByGeometry](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/groupByGeometry.png)
-   * none | The component displays everything in one list with no grouping. | ![featureTemplatesGroupByLayer](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/groupByNone.png)
-   * [GroupByFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-types.html#GroupByFunction) | Custom function that takes an object containing a [FeatureTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) and [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). | ![FeatureTemplatesGroupByCustomGroupFunction](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/groupCustomGroup.png)
-   *
-   * @default "layer"
-   * @example
-   * // This example shows using a function to check if
-   * // the layer title contains the word 'military'. If so,
-   * // return a group of items called "All Military Templates"
-   * function customGroup(grouping) {
-   *   // Consolidate all military layers
-   *   if (grouping.layer.title.toLowerCase().indexOf("military") > -1) {
-   *     return "All Military Templates"
-   *   }
-   * // Otherwise, group by layer title
-   *   return grouping.layer.title;
-   * }
-   *
-   * // Create the FeatureTemplates widget
-   * templates = new FeatureTemplates({
-   *   container: "templatesDiv",
-   *   layers: layers,
-   *   groupBy: customGroup
-   * });
-   */
-  accessor groupBy: GroupByType | null | undefined;
-  /**
-   * Indicates the heading level to use for the labels of grouped feature templates.
-   * By default, the group label is rendered
-   * as a level 4 heading (e.g. `<h4>Group label</h4>`). Depending on the component's placement
-   * in your app, you may need to adjust this heading for proper semantics. This is
-   * important for meeting accessibility standards.
-   *
-   * @default 4
-   * @since 4.20
-   * @see [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
-   * @example
-   * // Group label will render as an <h3>
-   * featureTemplates.headingLevel = 3;
-   */
-  accessor headingLevel: HeadingLevel;
-  /**
-   * Indicates whether the templates filter displays.
-   * ![](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featureTemplatesFilter.png)
-   *
-   * @default false
-   * @since 5.0
-   */
-  accessor hideFilter: boolean;
-  /**
-   * Icon which represents the component.
-   * Typically used when the component is controlled by another component (e.g. by the Expand component).
-   *
-   * @default "list-rectangle"
-   * @since 4.27
-   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-   */
-  get icon(): Icon["icon"];
-  set icon(value: IconName);
-  get items(): Array<TemplateItem2 | TemplateItemGroup>;
-  /**
-   * The component's default label.
-   *
-   * @since 4.11
-   */
-  accessor label: string;
-  /**
-   * An array of [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
-   * to display within the component. The order in which these layers are
-   * set in the array dictates how they display within the component.
-   *
-   * > [!WARNING]
-   * >
-   * > The component is designed to only display layers that are enabled for editing.
-   * > It will not display layers that are enabled to only edit attributes.
-   *
-   * @example
-   * // The layers to display within the widget
-   * let militaryUnits = new FeatureLayer({
-   *   url: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Military/FeatureServer/2"
-   * });
-   *
-   * let militaryHostile = new FeatureLayer({
-   *   url: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Military/FeatureServer/6"
-   * });
-   *
-   * let layers = [militaryUnits, militaryHostile];
-   *
-   * // Create FeatureTemplates widget
-   * templates = new FeatureTemplates({
-   *   container: "templatesDiv",
-   *   layers: layers
-   * });
-   */
-  accessor layers: Array<SubtypeGroupLayer | LayerWithFeatureTemplatesUnion>;
-  /**
-   * 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)
-   */
-  accessor referenceElement: ArcgisReferenceElement | string | undefined;
-  get selectedItem(): TemplateItem2 | undefined;
-  /**
-   * Specifies the selection behavior of list items. The `"single"` selection mode keeps the clicked list item selected. Whereas, `"none"` does not preserve the selection after clicking the list item.
-   *
-   * @default "none"
-   * @since 4.28
-   */
-  accessor selectionMode: "none" | "single" | null | undefined;
-  /**
-   * The current state of the component.
-   *
-   * @default "disabled"
-   */
-  get state(): FeatureTemplatesViewModelState;
-  /** Permanently destroy the component. */
-  destroy(): Promise<void>;
-  /**
-   * Selects the template item to use.
-   *
-   * @param item - The template item to select.
-   */
-  select(item: null | undefined | TemplateItem): void;
-  "@setterTypes": {
-    icon?: IconName;
-  };
-  /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
-  readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "state"; }>;
-  /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
-  readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
-  readonly arcgisSelect: import("@arcgis/lumina").TargetedEvent<this, SelectEvent>;
-  readonly "@eventTypes": {
-    arcgisPropertyChange: ArcgisFeatureTemplates["arcgisPropertyChange"]["detail"];
-    arcgisReady: ArcgisFeatureTemplates["arcgisReady"]["detail"];
-    arcgisSelect: ArcgisFeatureTemplates["arcgisSelect"]["detail"];
-  };
-}
-
-/** @param params */
-export type DisabledItemFunction = (params: Pick<TemplateItem, "layer" | "template">) => boolean;

package/dist/components/arcgis-feature-templates/index.d.ts

@@ -1 +0,0 @@
-export * from "./customElement.js";

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

@@ -1,4 +0,0 @@
-import type Layer from "@arcgis/core/layers/Layer";
-import type BuildingComponentSublayer from "@arcgis/core/layers/buildingSublayers/BuildingComponentSublayer";
-
-export type SliceableLayer = BuildingComponentSublayer | Layer;

package/dist/components/support/goTo.d.ts

@@ -1,37 +0,0 @@
-import type SceneView from "@arcgis/core/views/SceneView";
-import type MapView from "@arcgis/core/views/MapView";
-import type { GoToOptions2D, GoToOptions3D, GoToTarget2D, GoToTarget3D } from "@arcgis/core//views/types.js";
-
-/**
- * @param view
- * @param goToParameters
- */
-export type GoToOverride = (view: GoToOwner & MapViewOrSceneView, goToParameters: GoToParameters) => Promise<void>;
-
-export type GoToOwner = Pick<MapView, "goTo">
-  & Pick<SceneView, "goTo">;
-
-export type MapViewOrSceneView = MapView | SceneView;
-
-export type GoToParameters = GoToParameters2D
-  & GoToParameters3D;
-
-export interface GoToParameters2D {
-  /**
-   * The target location/viewpoint/extent to animate to.
-   *
-   * @since 5.0
-   */
-  target: GoToTarget2D;
-  /**
-   * Options defining the animation and duration of the navigation.
-   *
-   * @since 5.0
-   */
-  options?: GoToOptions2D;
-}
-
-export interface GoToParameters3D {
-  target: GoToTarget3D;
-  options?: GoToOptions3D;
-}

package/dist/controllers/useArcgisLoadError.d.ts

@@ -1,9 +0,0 @@
-import type WebMap from "@arcgis/core/WebMap.js";
-import type WebScene from "@arcgis/core/WebScene.js";
-import type WebLinkChart from "@arcgis/core/WebLinkChart";
-import type Basemap from "@arcgis/core/Basemap.js";
-import type Ground from "@arcgis/core/Ground.js";
-import type Layer from "@arcgis/core/layers/Layer.js";
-
-/** A potential source of load errors. */
-export type LoadErrorSource = Basemap | Ground | Layer | WebLinkChart | WebMap | WebScene;

package/dist/support/heading.d.ts

@@ -1 +0,0 @@
-export type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;

package/dist/support/measurementUtils.d.ts

@@ -1 +0,0 @@
-export type MeasurementState = "disabled" | "measured" | "measuring" | "ready" | "unsupported";

package/dist/utils/action-utils.d.ts

@@ -1,3 +0,0 @@
-import type { Icon as Icon } from "@esri/calcite-components/components/calcite-icon";
-
-export type IconName = Icon["icon"];

package/dist/utils/component-utils.d.ts

@@ -1,5 +0,0 @@
-import type { ArcgisLinkChart } from "../components/arcgis-link-chart/customElement.js";
-import type { ArcgisMap } from "../components/arcgis-map/customElement.js";
-import type { ArcgisScene } from "../components/arcgis-scene/customElement.js";
-
-export type ArcgisReferenceElement = ArcgisLinkChart | ArcgisMap | ArcgisScene;