@arcgis/map-components
Version:
ArcGIS Map Components
91 lines (90 loc) • 4.99 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type MapView from "@arcgis/core/views/MapView.js";
import type UtilityNetwork from "@arcgis/core/networks/UtilityNetwork.js";
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { ArcgisReferenceElement, IconName } from "../types.js";
import type { UtilityNetworkValidateTopologyExtentOption } from "@arcgis/core/widgets/UtilityNetworkValidateTopology.js";
import type { Icon } from "@esri/calcite-components/components/calcite-icon";
import type { UtilityNetworkValidateTopologyViewModelState } from "@arcgis/core/widgets/UtilityNetworkValidateTopology/UtilityNetworkValidateTopologyViewModel.js";
/**
* > This component is **deprecated**. [arcgis-utility-network-validate-network-topology](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/) is the preferred component for validating utility network topology and should be used for all new development.
*
* The UtilityNetworkValidateTopology component simplifies the process of validating a DirtyArea within a utility network. It offers an intuitive user interface.
*
* > The UtilityNetworkValidateTopology Component does not support proxied feature services or feature services that utilize stored credentials.
*
* @deprecated since 5.1, use [arcgis-utility-network-validate-network-topology](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/) instead.
*/
export abstract class ArcgisUtilityNetworkValidateTopology 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-utility-network-validate-topology/#destroy) method when you are done to
* prevent memory leaks.
*
* @default false
*/
accessor autoDestroyDisabled: boolean;
/**
* Specifies the extent of the validation.
*
* @default "current"
*/
accessor extentToValidate: UtilityNetworkValidateTopologyExtentOption;
/**
* Icon which represents the component.
* Typically used when the component is controlled by another component (e.g. by the Expand component).
*
* @default "check-circle"
* @since 4.27
* @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
*/
get icon(): Icon["icon"];
set icon(value: IconName);
/**
* The component's default label.
*
* @since 4.11
*/
accessor label: 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)
*/
accessor referenceElement: ArcgisReferenceElement | string | undefined;
/**
* The current state of the component.
*
* @default "ready"
* @since 4.27
*/
get state(): UtilityNetworkValidateTopologyViewModelState;
/**
* Determines the utility network to use.
*
* @since 4.27
*/
accessor utilityNetwork: UtilityNetwork | null | undefined;
/**
* The view associated with the component.
* > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-utility-network-validate-topology component will be associated with a map or scene component rather than using the `view` property.
*
* @since 4.27
*/
accessor view: MapView | null | undefined;
/** Permanently destroy the component. */
destroy(): Promise<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 "@eventTypes": {
arcgisPropertyChange: ArcgisUtilityNetworkValidateTopology["arcgisPropertyChange"]["detail"];
arcgisReady: ArcgisUtilityNetworkValidateTopology["arcgisReady"]["detail"];
};
}