@arcgis/map-components
Version:
ArcGIS Map Components
240 lines (238 loc) • 11.4 kB
TypeScript
/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../index.d.ts" />
import { Use } from '@arcgis/lumina/controllers';
import { default as UtilityNetworkAssociations } from '@arcgis/core/widgets/UtilityNetworkAssociations.js';
import { ToElement, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
import { PropertyValues } from 'lit';
import { ArcgisReferenceElement } from '../../utils/component-utils';
declare const useUtilityNetworkAssociationsWidget: (component: LitElement & Pick<UtilityNetworkAssociations, "icon" | "label" | "viewModel" | "utilityNetwork" | "connectivityAssociationsLineSymbol" | "maxAllowableAssociations" | "maxAllowableAssociationsSliderMax" | "maxAllowableAssociationsSliderMin" | "maxAllowableAssociationsSliderStep" | "showArrowsConnectivity" | "showArrowsStructuralAttachment" | "showAssociationsEnabled" | "structuralAttachmentAssociationsLineSymbol"> & {
state?: unknown;
viewModel?: __esri.UtilityNetworkAssociationsViewModel | undefined;
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<{
name: string;
}> | undefined;
el: HTMLElement & {
childElem?: HTMLElement & {
ownedBy?: HTMLElement;
};
view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
};
autoDestroyDisabled: boolean;
destroy: () => Promise<void>;
}) => UtilityNetworkAssociations;
/**
* 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.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-associations/)
*/
export declare 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/arcgis-utility-network-associations/#destroy) method when you are done to
* prevent memory leaks.
*
* @default false
*/
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.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#autoRefreshAssociations)
*
* @default false
*/
autoRefreshAssociationsDisabled: boolean;
/**
* A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being
* drawn for connectivity associations.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#connectivityAssociationsLineSymbol)
*/
connectivityAssociationsLineSymbol: __esri.SimpleLineSymbol;
/**
* Indicates whether to query and display connectivity associations.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#includeConnectivityAssociations)
*
* @default false
*/
includeConnectivityAssociationsDisabled: boolean;
/**
* Indicates whether to query and display structural attachment associations.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#includeStructuralAttachmentAssociations)
*
* @default false
*/
includeStructuralAttachmentAssociationsDisabled: boolean;
/**
* The maximum number of associations that can be returned from the server.
*
* @default 250
*/
maxAllowableAssociations: number;
/**
* The maximum value or upper bound of the Maximum allowable associations slider.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMax)
*/
maxAllowableAssociationsSliderMax: number;
/**
* The minimum value or lower bound of the Maximum allowable associations slider.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderMin)
*/
maxAllowableAssociationsSliderMin: number;
/**
* Specifies the interval to move the maximum allowable associations slider with the up, or down keys.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#maxAllowableAssociationsSliderStep)
*/
maxAllowableAssociationsSliderStep: number;
/** @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;
/**
* Indicates whether to show arrows for connectivity associations.
*
* @default false
*/
showArrowsConnectivity: boolean;
/**
* Indicates whether to show arrows for structural attachment associations.
*
* @default false
*/
showArrowsStructuralAttachment: boolean;
/**
* When `autoRefreshAssociations` is `true`, indicates whether to automatically show associations
* every time the current map extent changes.
*
* @default false
*/
showAssociationsEnabled: boolean;
/**
* A [SimpleLineSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleLineSymbol.html) used for representing the polyline geometry that is being drawn for structural attachment associations.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#structuralAttachmentAssociationsLineSymbol)
*/
structuralAttachmentAssociationsLineSymbol: __esri.SimpleLineSymbol;
/**
* Determines the utility network to use.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#utilityNetwork)
*/
utilityNetwork: nullish | __esri.UtilityNetwork;
/** @default false */
showConnectivityAssociationsSettingsArrowsToggle: boolean;
/**
* @deprecated since 4.32, showConnectivityAssociationsSettingsArrowsToggle instead
* @default false
*/
visibleElementsConnectivityAssociationsSettingsArrowsToggle: boolean;
/** @default false */
showConnectivityAssociationsSettingsCapSelect: boolean;
/**
* @deprecated since 4.32, use showConnectivityAssociationsSettingsCapSelect instead
* @default false
*/
visibleElementsConnectivityAssociationsSettingsCapSelect: boolean;
/** @default false */
hideConnectivityAssociationsSettingsColorPicker: boolean;
/**
* @deprecated since 4.32, use hideConnectivityAssociationsSettingsColorPicker instead
* @default true
*/
visibleElementsConnectivityAssociationsSettingsColorPicker: boolean;
/** @default false */
hideConnectivityAssociationsSettingsStylePicker: boolean;
/**
* @deprecated since 4.32, use hideConnectivityAssociationsSettingsStylePicker instead
* @default true
*/
visibleElementsConnectivityAssociationsSettingsStylePicker: boolean;
/** @default false */
hideConnectivityAssociationsSettingsWidthInput: boolean;
/**
* @deprecated since 4.32, use hideConnectivityAssociationsSettingsWidthInput instead
* @default true
*/
visibleElementsConnectivityAssociationsSettingsWidthInput: boolean;
/** @default false */
showMaxAllowableAssociationsSlider: boolean;
/**
* @deprecated since 4.32, use showMaxAllowableAssociationsSlider instead
* @default false
*/
visibleElementsMaxAllowableAssociationsSlider: boolean;
/** @default false */
showStructuralAttachmentAssociationsSettingsArrowsToggle: boolean;
/**
* @deprecated since 4.32, use showStructuralAttachmentAssociationsSettingsArrowsToggle instead
* @default false
*/
visibleElementsStructuralAttachmentAssociationsSettingsArrowsToggle: boolean;
/** @default false */
showStructuralAttachmentAssociationsSettingsCapSelect: boolean;
/**
* @deprecated since 4.32, use showStructuralAttachmentAssociationsSettingsCapSelect instead
* @default false
*/
visibleElementsStructuralAttachmentAssociationsSettingsCapSelect: boolean;
/** @default false */
hideStructuralAttachmentAssociationsSettingsColorPicker: boolean;
/**
* @deprecated since 4.32, use hideStructuralAttachmentAssociationsSettingsColorPicker instead
* @default true
*/
visibleElementsStructuralAttachmentAssociationsSettingsColorPicker: boolean;
/** @default false */
hideStructuralAttachmentAssociationsSettingsStylePicker: boolean;
/**
* @deprecated since 4.32, use hideStructuralAttachmentAssociationsSettingsStylePicker instead
* @default true
*/
visibleElementsStructuralAttachmentAssociationsSettingsStylePicker: boolean;
/** @default false */
hideStructuralAttachmentAssociationsSettingsWidthInput: boolean;
/**
* @deprecated since 4.32, use hideStructuralAttachmentAssociationsSettingsWidthInput instead
* @default true
*/
visibleElementsStructuralAttachmentAssociationsSettingsWidthInput: boolean;
/**
* Icon which represents the component.
* Typically used when the component is controlled by another component (e.g. by the Expand component).
*
* @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
* @default "view-associations"
*/
icon: string;
/**
* The widget's default label.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkAssociations.html#label)
*/
label: string;
/** Permanently destroy the component. */
destroy(): Promise<void>;
/** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
readonly arcgisReady: TargetedEvent<this, void>;
}
export {};