@arcgis/map-components 5.2.0-next.163 → 5.2.0-next.165
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cdn/2MPZWW4A.js +2 -0
- package/dist/cdn/3IZHAJN7.js +2 -0
- package/dist/cdn/67UW6MJM.js +2 -0
- package/dist/cdn/73NABILZ.js +2 -0
- package/dist/cdn/{VF23MMWZ.js → AALEZAW5.js} +1 -1
- package/dist/cdn/BPTZ6LBO.js +2 -0
- package/dist/cdn/FGQJD346.js +2 -0
- package/dist/cdn/OBFJ4JUW.js +2 -0
- package/dist/cdn/RMKPKUPL.js +2 -0
- package/dist/cdn/WEY7JGX2.js +2 -0
- package/dist/cdn/YXFFWLE5.js +2 -0
- package/dist/cdn/index.js +1 -1
- package/dist/chunks/utils5.js +2 -2
- package/dist/components/arcgis-coordinate-conversion/customElement.d.ts +5 -0
- package/dist/components/arcgis-coordinate-conversion-next/customElement.d.ts +6 -5
- package/dist/components/arcgis-feature-attachments/customElement.js +18 -18
- package/dist/components/arcgis-feature-next/customElement.d.ts +1 -1
- package/dist/components/arcgis-features-next/customElement.js +14 -15
- package/dist/components/arcgis-search/customElement.d.ts +12 -0
- package/dist/components/arcgis-search/customElement.js +3 -0
- package/dist/components/arcgis-selection-toolbar/customElement.d.ts +8 -0
- package/dist/components/arcgis-selection-toolbar/customElement.js +23 -17
- package/dist/components/arcgis-time-bar/customElement.d.ts +486 -409
- package/dist/components/arcgis-time-bar/types.d.ts +36 -15
- package/dist/components/arcgis-time-bar-slider/customElement.d.ts +179 -162
- package/dist/components/arcgis-time-slider/customElement.d.ts +1 -0
- package/dist/components/arcgis-time-slider/customElement.js +8 -7
- package/dist/components/arcgis-utility-network-trace-aggregated-geometry-result-item/customElement.d.ts +7 -0
- package/dist/components/arcgis-utility-network-trace-aggregated-geometry-result-item/customElement.js +8 -5
- package/dist/components/arcgis-utility-network-trace-analysis/customElement.d.ts +45 -2
- package/dist/components/arcgis-utility-network-trace-analysis/customElement.js +23 -20
- package/dist/components/arcgis-utility-network-trace-configuration-picker/customElement.d.ts +125 -12
- package/dist/components/arcgis-utility-network-trace-elements-result-item/customElement.d.ts +9 -2
- package/dist/components/arcgis-utility-network-trace-elements-result-item/customElement.js +60 -57
- package/dist/components/arcgis-utility-network-trace-functions-result-item/customElement.d.ts +7 -0
- package/dist/components/arcgis-utility-network-trace-functions-result-item/customElement.js +12 -9
- package/dist/components/arcgis-utility-network-trace-inputs/customElement.d.ts +217 -14
- package/dist/components/arcgis-utility-network-trace-inputs/customElement.js +119 -108
- package/dist/components/arcgis-utility-network-trace-locations/customElement.d.ts +155 -8
- package/dist/components/arcgis-utility-network-trace-results/customElement.d.ts +9 -73
- package/dist/components/arcgis-utility-network-trace-results/customElement.js +132 -125
- package/dist/components/arcgis-utility-network-trace-results-pane/customElement.d.ts +161 -2
- package/dist/docs/api.json +1 -1
- package/dist/docs/docs.json +1 -1
- package/dist/docs/vscode.html-custom-data.json +1 -1
- package/dist/docs/web-types.json +1 -1
- package/dist/loader.js +5 -5
- package/dist/types/lumina.d.ts +2 -2
- package/dist/types/preact.d.ts +2 -2
- package/dist/types/react.d.ts +2 -2
- package/dist/types/stencil.d.ts +2 -2
- package/package.json +6 -6
- package/dist/cdn/24P3B56P.js +0 -2
- package/dist/cdn/4TTVR7UK.js +0 -2
- package/dist/cdn/7PMSUAOO.js +0 -2
- package/dist/cdn/EQX7MHI6.js +0 -2
- package/dist/cdn/ERO6VEJC.js +0 -2
- package/dist/cdn/JQL6EOCO.js +0 -2
- package/dist/cdn/K664I5PA.js +0 -2
- package/dist/cdn/NV6GXURX.js +0 -2
- package/dist/cdn/S3LQLHD6.js +0 -2
- package/dist/cdn/X5PDNDLF.js +0 -2
- package/dist/components/arcgis-time-bar/TimeBarViewModel.d.ts +0 -73
|
@@ -4,12 +4,171 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
|
|
|
4
4
|
import type { FlowItem } from "@esri/calcite-components/components/calcite-flow-item";
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* A container for one or more [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/) components and custom content.
|
|
8
|
+
* Use this component for custom trace workflows that need functionality beyond
|
|
9
|
+
* [arcgis-utility-network-trace-analysis](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/), such as displaying the results of multiple
|
|
10
|
+
* traces at once.
|
|
8
11
|
*
|
|
9
|
-
*
|
|
12
|
+
* ## Use in a custom app outside the trace analysis component
|
|
13
|
+
*
|
|
14
|
+
* To use [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/) outside of the trace analysis component,
|
|
15
|
+
* slot it into this pane's [default slot](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results-pane/#slot-).
|
|
16
|
+
* This is useful in custom trace workflow applications that display multiple trace results at once or
|
|
17
|
+
* configure each results component independently. Add one trace results component for each trace result
|
|
18
|
+
* and set its properties directly. The pane provides the results container; it does not run traces or
|
|
19
|
+
* set the results components' properties. Your application supplies each component's
|
|
20
|
+
* [arcgis-utility-network-trace-results.traceResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResult),
|
|
21
|
+
* [arcgis-utility-network-trace-results.traceError](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceError),
|
|
22
|
+
* [arcgis-utility-network-trace-results.utilityNetwork](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#utilityNetwork), and
|
|
23
|
+
* [arcgis-utility-network-trace-results.view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#view), and
|
|
24
|
+
* manages setting properties on any trace result items.
|
|
25
|
+
*
|
|
26
|
+
* The [arcgis-utility-network-trace-results.view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#view) property is required for elements and aggregated
|
|
27
|
+
* geometry results. The [arcgis-utility-network-trace-results.utilityNetwork](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#utilityNetwork) property is required
|
|
28
|
+
* to query features for elements results.
|
|
29
|
+
*
|
|
30
|
+
* Each trace results component instance renders in its own
|
|
31
|
+
* [Calcite Block](https://developers.arcgis.com/calcite-design-system/components/block/).
|
|
32
|
+
* Set [arcgis-utility-network-trace-results.expandable](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#expandable) and
|
|
33
|
+
* [arcgis-utility-network-trace-results.expanded](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#expanded) on each results component instance
|
|
34
|
+
* to control whether its content is expandable and initially expanded.
|
|
35
|
+
* Both properties default to `false` (collapsed and non-expandable), matching the Calcite Block defaults.
|
|
36
|
+
*
|
|
37
|
+
* See the [multiple trace results example](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results-pane/#multiple-trace-results-example).
|
|
38
|
+
*
|
|
39
|
+
* ### Adding custom flow items
|
|
40
|
+
*
|
|
41
|
+
* The pane renders its content inside a
|
|
42
|
+
* [Calcite Flow](https://developers.arcgis.com/calcite-design-system/components/flow/).
|
|
43
|
+
* The default slot is rendered in the root flow item. To control the custom content displayed in
|
|
44
|
+
* the pane, add [Calcite Flow Item](https://developers.arcgis.com/calcite-design-system/components/flow-item/)
|
|
45
|
+
* elements to its [flowItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results-pane/#flowItems) collection.
|
|
46
|
+
*
|
|
47
|
+
* The trace analysis component's results tab works the same way: add flow items to its
|
|
48
|
+
* [arcgis-utility-network-trace-analysis.flowItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#flowItems) collection
|
|
49
|
+
* to display custom content in that tab.
|
|
50
|
+
*
|
|
51
|
+
* @slot - Default slot for one or more [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/) components.
|
|
10
52
|
* @since 5.2
|
|
53
|
+
* @example
|
|
54
|
+
* <span id="multiple-trace-results-example"></span>
|
|
55
|
+
*
|
|
56
|
+
* Display two trace results in the default slot of a results pane, without a trace analysis component.
|
|
57
|
+
* Each results component has its own heading and display settings. Neither component uses `slot="results"`
|
|
58
|
+
* because both are assigned to the pane's default slot.
|
|
59
|
+
* The upstream component uses the default result items. The downstream component uses slotted
|
|
60
|
+
* elements and functions result items, so aggregated geometry results are not displayed.
|
|
61
|
+
* Set display properties directly on the slotted result items.
|
|
62
|
+
* ```html
|
|
63
|
+
* <arcgis-utility-network-trace-results-pane id="trace-results-pane">
|
|
64
|
+
* <arcgis-utility-network-trace-results
|
|
65
|
+
* id="upstream-results"
|
|
66
|
+
* heading="Upstream trace"
|
|
67
|
+
* expandable
|
|
68
|
+
* expanded
|
|
69
|
+
* hide-action-bar
|
|
70
|
+
* ></arcgis-utility-network-trace-results>
|
|
71
|
+
* <arcgis-utility-network-trace-results
|
|
72
|
+
* id="downstream-results"
|
|
73
|
+
* heading="Downstream trace"
|
|
74
|
+
* expandable
|
|
75
|
+
* expanded
|
|
76
|
+
* >
|
|
77
|
+
* <arcgis-utility-network-trace-elements-result-item
|
|
78
|
+
* disable-highlight
|
|
79
|
+
* ></arcgis-utility-network-trace-elements-result-item>
|
|
80
|
+
* <arcgis-utility-network-trace-functions-result-item></arcgis-utility-network-trace-functions-result-item>
|
|
81
|
+
* </arcgis-utility-network-trace-results>
|
|
82
|
+
* </arcgis-utility-network-trace-results-pane>
|
|
83
|
+
* <calcite-button id="clear-trace-results">Clear results</calcite-button>
|
|
84
|
+
* ```
|
|
85
|
+
*
|
|
86
|
+
* In the following JavaScript, `view` is the application's MapView, `utilityNetwork` is its loaded utility
|
|
87
|
+
* network, and `upstreamTraceResult` and `downstreamTraceResult` are `TraceResult` objects returned by the application's
|
|
88
|
+
* trace workflow. Set the view and utility network before assigning each trace result.
|
|
89
|
+
* ```js
|
|
90
|
+
* const pane = document.getElementById("trace-results-pane");
|
|
91
|
+
* const upstreamResults = document.getElementById("upstream-results");
|
|
92
|
+
* const downstreamResults = document.getElementById("downstream-results");
|
|
93
|
+
* const resultsComponents = [upstreamResults, downstreamResults];
|
|
94
|
+
*
|
|
95
|
+
* await Promise.all([pane.componentOnReady(), ...resultsComponents.map((results) => results.componentOnReady())]);
|
|
96
|
+
*
|
|
97
|
+
* for (const results of resultsComponents) {
|
|
98
|
+
* results.view = view;
|
|
99
|
+
* results.utilityNetwork = utilityNetwork;
|
|
100
|
+
* }
|
|
101
|
+
*
|
|
102
|
+
* upstreamResults.traceResult = upstreamTraceResult;
|
|
103
|
+
* downstreamResults.traceResult = downstreamTraceResult;
|
|
104
|
+
*
|
|
105
|
+
* document.getElementById("clear-trace-results").addEventListener("click", () => {
|
|
106
|
+
* for (const results of resultsComponents) {
|
|
107
|
+
* results.clearResults();
|
|
108
|
+
* results.traceResult = undefined;
|
|
109
|
+
* results.traceError = undefined;
|
|
110
|
+
* }
|
|
111
|
+
* });
|
|
112
|
+
* ```
|
|
113
|
+
* @example
|
|
114
|
+
* <span id="custom-flow-item-example"></span>
|
|
115
|
+
*
|
|
116
|
+
* Using the results pane from the previous example, add a button to display custom content in a flow item.
|
|
117
|
+
* The flow item replaces the visible results until the user navigates back, which removes it from the
|
|
118
|
+
* `flowItems` collection and shows the results again.
|
|
119
|
+
* ```html
|
|
120
|
+
* <calcite-button id="show-trace-comparison">Compare traces</calcite-button>
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* ```js
|
|
124
|
+
* const pane = document.getElementById("trace-results-pane");
|
|
125
|
+
* await pane.componentOnReady();
|
|
126
|
+
*
|
|
127
|
+
* const flowItem = document.createElement("calcite-flow-item");
|
|
128
|
+
* flowItem.heading = "Trace comparison";
|
|
129
|
+
*
|
|
130
|
+
* const content = document.createElement("p");
|
|
131
|
+
* content.textContent = "Compare the results of your upstream and downstream traces here.";
|
|
132
|
+
* flowItem.append(content);
|
|
133
|
+
*
|
|
134
|
+
* document.getElementById("show-trace-comparison").addEventListener("click", () => {
|
|
135
|
+
* pane.flowItems.add(flowItem);
|
|
136
|
+
* });
|
|
137
|
+
*
|
|
138
|
+
* flowItem.addEventListener("calciteFlowItemBack", () => {
|
|
139
|
+
* pane.flowItems.remove(flowItem);
|
|
140
|
+
* });
|
|
141
|
+
* ```
|
|
142
|
+
* @see [arcgis-utility-network-trace-analysis](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/)
|
|
143
|
+
* @see [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/)
|
|
144
|
+
* @see [arcgis-utility-network-trace-aggregated-geometry-result-item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/)
|
|
145
|
+
* @see [arcgis-utility-network-trace-elements-result-item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/)
|
|
146
|
+
* @see [arcgis-utility-network-trace-functions-result-item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/)
|
|
147
|
+
* @see [Calcite Flow](https://developers.arcgis.com/calcite-design-system/components/flow/)
|
|
148
|
+
* @see [Calcite Block](https://developers.arcgis.com/calcite-design-system/components/block/)
|
|
11
149
|
*/
|
|
12
150
|
export abstract class ArcgisUtilityNetworkTraceResultsPane extends LitElement {
|
|
151
|
+
/**
|
|
152
|
+
* Additional [Calcite Flow Item](https://developers.arcgis.com/calcite-design-system/components/flow-item/)
|
|
153
|
+
* elements displayed after the root flow item for drilldown navigation.
|
|
154
|
+
* The root flow item contains the pane's default slot and is not included in this collection.
|
|
155
|
+
*
|
|
156
|
+
* This property is read-only, but the returned
|
|
157
|
+
* [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) is mutable.
|
|
158
|
+
* Add or remove `calcite-flow-item` elements through the collection rather than replacing it.
|
|
159
|
+
* Adding items deselects the root flow item if it is selected. Call
|
|
160
|
+
* [removeAll()](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/#removeAll) on
|
|
161
|
+
* [flowItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results-pane/#flowItems) to remove all custom flow items
|
|
162
|
+
* without removing the slotted results components.
|
|
163
|
+
*
|
|
164
|
+
* This collection is for custom flow items in an independently used results pane.
|
|
165
|
+
* To add flow items to the results tab of [arcgis-utility-network-trace-analysis](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/),
|
|
166
|
+
* use that component's [arcgis-utility-network-trace-analysis.flowItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#flowItems) property instead.
|
|
167
|
+
*
|
|
168
|
+
* See the [custom flow item example](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results-pane/#custom-flow-item-example).
|
|
169
|
+
*
|
|
170
|
+
* @since 5.2
|
|
171
|
+
*/
|
|
13
172
|
get flowItems(): Collection<FlowItem>;
|
|
14
173
|
/**
|
|
15
174
|
* Whether to log console errors about unexpected child elements.
|