import "@arcgis/map-components/components/arcgis-utility-network-associations";- Inheritance:
- ArcgisUtilityNetworkAssociations→
PublicLitElement
- Since
- ArcGIS Maps SDK for JavaScript 4.28
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.
Properties
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | ||
auto-refresh-associations-disabled | ||
| ||
hide-connectivity-associations-settings-color-picker | ||
hide-connectivity-associations-settings-style-picker | ||
hide-connectivity-associations-settings-width-input | ||
hide-structural-attachment-associations-settings-color-picker | ||
hide-structural-attachment-associations-settings-style-picker | ||
hide-structural-attachment-associations-settings-width-input | ||
icon | Icon["icon"] | |
include-connectivity-associations-disabled | ||
include-structural-attachment-associations-disabled | ||
label | ||
max-allowable-associations | ||
max-allowable-associations-slider-max | ||
max-allowable-associations-slider-min | ||
max-allowable-associations-slider-step | ||
reference-element | ||
show-arrows-connectivity | ||
show-arrows-structural-attachment | ||
show-associations-enabled | ||
show-connectivity-associations-settings-arrows-toggle | ||
show-connectivity-associations-settings-cap-select | ||
show-max-allowable-associations-slider | ||
show-structural-attachment-associations-settings-arrows-toggle | ||
show-structural-attachment-associations-settings-cap-select | ||
| ||
| ||
|
autoDestroyDisabled
- Type
- boolean
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.
- Attribute
- auto-destroy-disabled
- Default value
- false
autoRefreshAssociationsDisabled
- Type
- 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.
- Attribute
- auto-refresh-associations-disabled
- Default value
- false
connectivityAssociationsLineSymbol
- Type
- SimpleLineSymbol
A SimpleLineSymbol used for representing the polyline geometry that is being drawn for connectivity associations.
hideConnectivityAssociationsSettingsColorPicker
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, hides the connectivity association color picker.
- Attribute
- hide-connectivity-associations-settings-color-picker
- Default value
- false
hideConnectivityAssociationsSettingsStylePicker
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, hides the connectivity association style picker.
- Attribute
- hide-connectivity-associations-settings-style-picker
- Default value
- false
hideConnectivityAssociationsSettingsWidthInput
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, hides the connectivity association width input.
- Attribute
- hide-connectivity-associations-settings-width-input
- Default value
- false
hideStructuralAttachmentAssociationsSettingsColorPicker
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, hides the structural attachment associations color picker.
- Attribute
- hide-structural-attachment-associations-settings-color-picker
- Default value
- false
hideStructuralAttachmentAssociationsSettingsStylePicker
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, hides the structural attachment associations style picker.
- Attribute
- hide-structural-attachment-associations-settings-style-picker
- Default value
- false
hideStructuralAttachmentAssociationsSettingsWidthInput
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, hides the structural attachment associations width input.
- Attribute
- hide-structural-attachment-associations-settings-width-input
- Default value
- false
icon
- Type
- Icon["icon"]
Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).
- See also
- Attribute
- icon
- Default value
- "view-associations"
includeConnectivityAssociationsDisabled
- Type
- boolean
Indicates whether to query and display connectivity associations.
- Attribute
- include-connectivity-associations-disabled
- Default value
- false
includeStructuralAttachmentAssociationsDisabled
- Type
- boolean
Indicates whether to query and display structural attachment associations.
- Attribute
- include-structural-attachment-associations-disabled
- Default value
- false
maxAllowableAssociations
- Type
- number
The maximum number of associations that can be returned from the server.
- Attribute
- max-allowable-associations
- Default value
- 250
maxAllowableAssociationsSliderMax
- Type
- 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, the property will be set to a default value (1000).
- Attribute
- max-allowable-associations-slider-max
maxAllowableAssociationsSliderMin
- Type
- 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, the property will be set to a default value (250).
- Attribute
- max-allowable-associations-slider-min
maxAllowableAssociationsSliderStep
- Type
- number
Specifies the interval to move the maximum allowable associations slider with the up, or down keys.
- Attribute
- max-allowable-associations-slider-step
referenceElement
- Type
- ArcgisReferenceElement | string | undefined
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.
- Attribute
- reference-element
showArrowsConnectivity
- Type
- boolean
Indicates whether to show arrows for connectivity associations.
- Attribute
- show-arrows-connectivity
- Default value
- false
showArrowsStructuralAttachment
- Type
- boolean
Indicates whether to show arrows for structural attachment associations.
- Attribute
- show-arrows-structural-attachment
- Default value
- false
showAssociationsEnabled
- Type
- boolean
When autoRefreshAssociations is true, indicates whether to automatically show associations
every time the current map extent changes.
- Attribute
- show-associations-enabled
- Default value
- false
showConnectivityAssociationsSettingsArrowsToggle
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, shows the connectivity association arrows toggle.
- Attribute
- show-connectivity-associations-settings-arrows-toggle
- Default value
- false
showConnectivityAssociationsSettingsCapSelect
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, shows the connectivity association cap select.
- Attribute
- show-connectivity-associations-settings-cap-select
- Default value
- false
showMaxAllowableAssociationsSlider
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, hides the max allowable associations slider.
- Attribute
- show-max-allowable-associations-slider
- Default value
- false
showStructuralAttachmentAssociationsSettingsArrowsToggle
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, shows the structural attachment associations arrow toggle.
- Attribute
- show-structural-attachment-associations-settings-arrows-toggle
- Default value
- false
showStructuralAttachmentAssociationsSettingsCapSelect
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 5.0
If true, shows the structural attachment associations cap select.
- Attribute
- show-structural-attachment-associations-settings-cap-select
- Default value
- false
structuralAttachmentAssociationsLineSymbol
- Type
- SimpleLineSymbol
A SimpleLineSymbol used for representing the polyline geometry that is being drawn for structural attachment associations.
utilityNetwork
- Type
- UtilityNetwork | null | undefined
Determines the utility network to use.
view
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
viewproperty 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 theviewproperty.
Methods
| Method | Signature |
|---|---|
componentOnReady inherited | componentOnReady(): Promise<this> |
destroy(): Promise<void> |
componentOnReady
- Signature
-
componentOnReady (): Promise<this>
Creates a promise that resolves once the component is fully loaded.
- Returns
- Promise<this>
Example
const arcgisUtilityNetworkAssociations = document.querySelector("arcgis-utility-network-associations");document.body.append(arcgisUtilityNetworkAssociations);await arcgisUtilityNetworkAssociations.componentOnReady();console.log("arcgis-utility-network-associations is ready to go!");Events
| Name | Type |
|---|---|
arcgisReady
arcgisReady: CustomEvent<void> Emitted when the component associated with a map or scene view is ready to be interacted with.