@arcgis/map-components/dist/components/arcgis-utility-network-associations/customElement.d.ts

ArcGIS Map Components

/// <reference path="../../index.d.ts" />
import type MapView from "@arcgis/core/views/MapView.js";
import type SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol.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 { Icon } from "@esri/calcite-components/components/calcite-icon";

/**
 * The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.
 *
 * > The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials.
 *
 * @since 4.28
 */
export abstract class ArcgisUtilityNetworkAssociations 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-associations/#destroy) method when you are done to
   * prevent memory leaks.
   *
   * @default false
   */
  accessor autoDestroyDisabled: boolean;
  /**
   * Indicates whether to show a toggle to automatically show associations every time the map
   * extent changes, or an action button to show associations within the current map extent on demand.
   *
   * @default false
   * @since 4.26
   */
  accessor autoRefreshAssociationsDisabled: boolean;
  /**
   * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleLineSymbol/) used for representing the polyline geometry that is being
   * drawn for connectivity associations.
   *
   * @since 4.26
   */
  accessor connectivityAssociationsLineSymbol: SimpleLineSymbol;
  /**
   * If true, hides the connectivity association color picker.
   *
   * @default false
   * @since 5.0
   */
  accessor hideConnectivityAssociationsSettingsColorPicker: boolean;
  /**
   * If true, hides the connectivity association style picker.
   *
   * @default false
   * @since 5.0
   */
  accessor hideConnectivityAssociationsSettingsStylePicker: boolean;
  /**
   * If true, hides the connectivity association width input.
   *
   * @default false
   * @since 5.0
   */
  accessor hideConnectivityAssociationsSettingsWidthInput: boolean;
  /**
   * If true, hides the structural attachment associations color picker.
   *
   * @default false
   * @since 5.0
   */
  accessor hideStructuralAttachmentAssociationsSettingsColorPicker: boolean;
  /**
   * If true, hides the structural attachment associations style picker.
   *
   * @default false
   * @since 5.0
   */
  accessor hideStructuralAttachmentAssociationsSettingsStylePicker: boolean;
  /**
   * If true, hides the structural attachment associations width input.
   *
   * @default false
   * @since 5.0
   */
  accessor hideStructuralAttachmentAssociationsSettingsWidthInput: boolean;
  /**
   * Icon which represents the component.
   * Typically used when the component is controlled by another component (e.g. by the Expand component).
   *
   * @default "view-associations"
   * @since 4.27
   * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
   */
  get icon(): Icon["icon"];
  set icon(value: IconName);
  /**
   * Indicates whether to query and display connectivity associations.
   *
   * @default false
   * @since 4.26
   */
  accessor includeConnectivityAssociationsDisabled: boolean;
  /**
   * Indicates whether to query and display structural attachment associations.
   *
   * @default false
   * @since 4.26
   */
  accessor includeStructuralAttachmentAssociationsDisabled: boolean;
  /**
   * The component's default label.
   *
   * @since 4.26
   */
  accessor label: string;
  /**
   * The maximum number of associations that can be returned from the server.
   *
   * @default 250
   * @since 4.26
   */
  accessor maxAllowableAssociations: number;
  /**
   * The maximum value or upper bound of the Maximum allowable associations slider.
   *
   * If the value in the constructor is less than or equal to the value set for
   * [maxAllowableAssociationsSliderMin](https://developers.arcgis.com/javascript/latest/references/core/widgets/UtilityNetworkAssociations/#maxAllowableAssociationsSliderMin), the property will be set to a default value (1000).
   *
   * @since 4.26
   */
  accessor maxAllowableAssociationsSliderMax: number;
  /**
   * The minimum value or lower bound of the Maximum allowable associations slider.
   *
   * If the value in the constructor is less than 0, the property will be set to a default value (250).
   * If the value in the constructor is greater than or equal to [maxAllowableAssociationsSliderMax](https://developers.arcgis.com/javascript/latest/references/core/widgets/UtilityNetworkAssociations/#maxAllowableAssociationsSliderMax),
   * the property will be set to a default value (250).
   *
   * @since 4.26
   */
  accessor maxAllowableAssociationsSliderMin: number;
  /**
   * Specifies the interval to move the maximum allowable associations slider with the up, or down keys.
   *
   * @since 4.26
   */
  accessor maxAllowableAssociationsSliderStep: number;
  /**
   * 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;
  /**
   * Indicates whether to show arrows for connectivity associations.
   *
   * @default false
   * @since 4.26
   */
  accessor showArrowsConnectivity: boolean;
  /**
   * Indicates whether to show arrows for structural attachment associations.
   *
   * @default false
   * @since 4.26
   */
  accessor showArrowsStructuralAttachment: boolean;
  /**
   * When `autoRefreshAssociations` is `true`, indicates whether to automatically show associations
   * every time the current map extent changes.
   *
   * @default false
   * @since 4.26
   */
  accessor showAssociationsEnabled: boolean;
  /**
   * If true, shows the connectivity association arrows toggle.
   *
   * @default false
   * @since 5.0
   */
  accessor showConnectivityAssociationsSettingsArrowsToggle: boolean;
  /**
   * If true, shows the connectivity association cap select.
   *
   * @default false
   * @since 5.0
   */
  accessor showConnectivityAssociationsSettingsCapSelect: boolean;
  /**
   * If true, hides the max allowable associations slider.
   *
   * @default false
   * @since 5.0
   */
  accessor showMaxAllowableAssociationsSlider: boolean;
  /**
   * If true, shows the structural attachment associations arrow toggle.
   *
   * @default false
   * @since 5.0
   */
  accessor showStructuralAttachmentAssociationsSettingsArrowsToggle: boolean;
  /**
   * If true, shows the structural attachment associations cap select.
   *
   * @default false
   * @since 5.0
   */
  accessor showStructuralAttachmentAssociationsSettingsCapSelect: boolean;
  /**
   * A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleLineSymbol/) used for representing the polyline geometry that is being drawn for structural attachment associations.
   *
   * @since 4.26
   */
  accessor structuralAttachmentAssociationsLineSymbol: SimpleLineSymbol;
  /**
   * Determines the utility network to use.
   *
   * @since 4.26
   */
  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-associations component will be associated with a map or scene component rather than using the `view` property.
   *
   * @since 4.26
   */
  accessor view: MapView | null | undefined;
  /** Permanently destroy the component. */
  destroy(): Promise<void>;
  "@setterTypes": {
    icon?: IconName;
  };
  /** 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": {
    arcgisReady: ArcgisUtilityNetworkAssociations["arcgisReady"]["detail"];
  };
}