@arcgis/map-components 5.2.0-next.0 → 5.2.0-next.1
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/{J23UDIAN.js → 43Q3TUPX.js} +1 -1
- package/dist/cdn/{NLHFLEWT.js → 6NEHIRSM.js} +1 -1
- package/dist/cdn/72IUGDSR.js +2 -0
- package/dist/cdn/BDDXZ4ML.js +2 -0
- package/dist/cdn/{YMUQ7JSB.js → CWWTUOR7.js} +1 -1
- package/dist/cdn/EWYSBOXF.js +2 -0
- package/dist/cdn/GVOCIBLC.js +2 -0
- package/dist/cdn/{WTGXVWSL.js → IAPVYBIO.js} +1 -1
- package/dist/cdn/{IGXBF2RY.js → J6G5UUNA.js} +1 -1
- package/dist/cdn/{25DYY7HH.js → NEXYYXWU.js} +1 -1
- package/dist/cdn/{NGGYUKKX.js → PRZ7EKB7.js} +1 -1
- package/dist/cdn/{AKNID6WJ.js → QZPKGHKG.js} +1 -1
- package/dist/cdn/{OFUAKDTE.js → X4COPBRD.js} +1 -1
- package/dist/cdn/index.js +1 -1
- package/dist/chunks/esri-main.js +2 -2
- package/dist/chunks/slots.js +1 -1
- package/dist/chunks/useLayerById.js +5 -5
- package/dist/components/arcgis-directions/customElement.d.ts +5 -5
- package/dist/components/arcgis-directions/customElement.js +3 -3
- package/dist/components/arcgis-feature/customElement.d.ts +4 -1
- package/dist/components/arcgis-feature-next/customElement.d.ts +27 -65
- package/dist/components/arcgis-feature-table/customElement.d.ts +27 -20
- package/dist/components/arcgis-feature-table/customElement.js +36 -30
- package/dist/components/arcgis-features/customElement.d.ts +10 -11
- package/dist/components/arcgis-features-next/customElement.d.ts +59 -126
- package/dist/components/arcgis-link-chart-nonspatial-visibility-toggle/customElement.js +1 -1
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.d.ts +12 -12
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.js +23 -20
- package/dist/components/arcgis-popup/customElement.d.ts +5 -9
- package/dist/components/arcgis-search/customElement.d.ts +7 -0
- package/dist/components/arcgis-search/customElement.js +33 -33
- 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 +4 -4
- package/dist/types/lumina.d.ts +6 -6
- package/dist/types/preact.d.ts +6 -6
- package/dist/types/react.d.ts +6 -6
- package/dist/types/stencil.d.ts +6 -6
- package/package.json +4 -4
- package/dist/cdn/274IEJH2.js +0 -2
- package/dist/cdn/IHDWD72J.js +0 -2
- package/dist/cdn/M4CPJTHZ.js +0 -2
- package/dist/cdn/UZ3CMTNE.js +0 -2
|
@@ -1,15 +1,13 @@
|
|
|
1
1
|
/// <reference path="../../index.d.ts" />
|
|
2
2
|
import type ActionButton from "@arcgis/core/support/actions/ActionButton.js";
|
|
3
3
|
import type Collection from "@arcgis/core/core/Collection.js";
|
|
4
|
-
import type Features from "@arcgis/core/popup/Features.js";
|
|
5
4
|
import type ActionToggle from "@arcgis/core/support/actions/ActionToggle.js";
|
|
6
5
|
import type Graphic from "@arcgis/core/Graphic.js";
|
|
7
6
|
import type FeatureAbilities from "@arcgis/core/popup/support/FeatureAbilities.js";
|
|
8
7
|
import type Map from "@arcgis/core/Map.js";
|
|
9
8
|
import type SpatialReference from "@arcgis/core/geometry/SpatialReference.js";
|
|
10
|
-
import type { ActionEvent
|
|
9
|
+
import type { ActionEvent } from "@arcgis/core/widgets/Popup/types.js";
|
|
11
10
|
import type { ArcgisReferenceElement, IconName, HeadingLevel } from "../types.js";
|
|
12
|
-
import type { ScreenPoint } from "@arcgis/core/core/types.js";
|
|
13
11
|
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
|
|
14
12
|
import type { ArcgisFeatureNext } from "../arcgis-feature-next/customElement.js";
|
|
15
13
|
import type { T9nMeta } from "@arcgis/lumina/controllers";
|
|
@@ -18,25 +16,30 @@ import type { GoToOverride } from "@arcgis/core/widgets/support/types.js";
|
|
|
18
16
|
import type { MapViewOrSceneView } from "@arcgis/core/views/MapViewOrSceneView.js";
|
|
19
17
|
|
|
20
18
|
/**
|
|
21
|
-
*
|
|
22
|
-
*
|
|
19
|
+
* > [!WARNING]
|
|
20
|
+
* > The Features (next) component is the successor to the Features component, provided to you early for testing and feedback. In version 6.0, the implementation of [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) will be updated under the hood to that of [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/), and this component will be removed. To update at version 6.0, simply remove `-next` from the component name.
|
|
21
|
+
*
|
|
22
|
+
* The Features (next) component allows users to view a feature's popupTemplate content such as attributes,
|
|
23
|
+
* actions, related records, etc., without living inside a view component.
|
|
23
24
|
* This component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component,
|
|
24
|
-
* however unlike Popup, the Features component can be placed outside of
|
|
25
|
+
* however unlike Popup, the Features (next) component can be placed outside of a view component.
|
|
25
26
|
* For example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/),
|
|
26
27
|
* the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opens within the map whether it is docked
|
|
27
28
|
* or anchored to the selected feature.
|
|
28
|
-
* With the Features component, the same information that Popup provides is shown in a separate container from the map, such as
|
|
29
|
-
* a HTML div within a Calcite Design System
|
|
29
|
+
* With the Features (next) component, the same information that Popup provides is shown in a separate container from the map, such as a Calcite Design System
|
|
30
30
|
* [Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).
|
|
31
31
|
*
|
|
32
|
-
* If multiple features are passed into the Features component, the component provides buttons to page though the features and a feature menu that allows the
|
|
32
|
+
* If multiple features are passed into the Features (next) component, the component provides buttons to page though the features and a feature menu that allows the
|
|
33
33
|
* list of features to be displayed so the user can choose which feature content to display in the component. The component also respects
|
|
34
34
|
* feature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate).
|
|
35
35
|
*
|
|
36
|
-
* The Features component should be used if needing to use the Popup functionality outside of the map or scene component.
|
|
37
|
-
* actions, related records, clustering configuration, etc., then use the [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) component.
|
|
36
|
+
* The Features (next) component should be used if needing to use the Popup functionality outside of the map or scene component. To show a single feature's content without
|
|
37
|
+
* actions, related records, clustering configuration, etc., then use the [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/) component.
|
|
38
38
|
*
|
|
39
39
|
* @see [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/)
|
|
40
|
+
* @see [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/)
|
|
41
|
+
* @see [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/)
|
|
42
|
+
* @beta
|
|
40
43
|
* @since 5.1
|
|
41
44
|
*/
|
|
42
45
|
export abstract class ArcgisFeaturesNext extends LitElement {
|
|
@@ -67,15 +70,14 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
67
70
|
*/
|
|
68
71
|
accessor autoDestroyDisabled: boolean;
|
|
69
72
|
/**
|
|
70
|
-
*
|
|
73
|
+
* Indicates whether to disable chart animation in the component.
|
|
71
74
|
*
|
|
72
75
|
* @default false
|
|
73
|
-
* @since 5.1
|
|
74
76
|
*/
|
|
75
77
|
accessor chartAnimationDisabled: boolean | undefined;
|
|
76
78
|
/**
|
|
77
79
|
* Indicates whether the component displays its content. If `true`, only the header displays.
|
|
78
|
-
* This property is only honored if [
|
|
80
|
+
* This property is only honored if [showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#showCollapseButton) is `true`.
|
|
79
81
|
*
|
|
80
82
|
* @default false
|
|
81
83
|
*/
|
|
@@ -98,50 +100,39 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
98
100
|
* For example, previously a date that may have appeared as `"December 30, 1997"` will now appear as `"12/30/1997 6:00 PM"`.
|
|
99
101
|
*
|
|
100
102
|
* @default false
|
|
101
|
-
* @since 5.1
|
|
102
103
|
*/
|
|
103
104
|
accessor defaultPopupTemplateEnabled: boolean;
|
|
104
105
|
/**
|
|
105
|
-
* The heading currently displayed for the selected feature. This value resolves to the
|
|
106
|
+
* The heading currently displayed for the selected feature. This value resolves to the selected feature's [PopupTemplate title](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#title) when available, otherwise it falls back to the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading).
|
|
106
107
|
*
|
|
107
108
|
* @since 5.1
|
|
108
109
|
* @see [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading)
|
|
109
110
|
* @see [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature)
|
|
110
111
|
*/
|
|
111
112
|
get effectiveHeading(): string | null | undefined;
|
|
112
|
-
/**
|
|
113
|
-
* The number of [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) available in the component.
|
|
114
|
-
*
|
|
115
|
-
* @since 5.1
|
|
116
|
-
*/
|
|
113
|
+
/** The number of [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) available in the component. */
|
|
117
114
|
accessor featureCount: number;
|
|
118
|
-
/** Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/references/core/
|
|
115
|
+
/** Defines the specific [abilities](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FeatureAbilities/) that can be used when querying and displaying content. */
|
|
119
116
|
accessor featureItemAbilities: FeatureAbilities | null | undefined;
|
|
120
117
|
/**
|
|
121
118
|
* This property enables multiple features in the component to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features. This value will only be honored if [initialDisplayMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#initialDisplayMode) is set to "feature".
|
|
122
119
|
*
|
|
123
120
|
* @default false
|
|
124
|
-
* @since 5.1
|
|
125
121
|
*/
|
|
126
122
|
accessor featureMenuOpen: boolean;
|
|
127
|
-
/**
|
|
128
|
-
* Sets the title to display on the component while viewing the feature menu.
|
|
129
|
-
*
|
|
130
|
-
* @since 5.1
|
|
131
|
-
*/
|
|
123
|
+
/** Sets the title to display on the component while viewing the feature menu. */
|
|
132
124
|
accessor featureMenuTitle: string | undefined;
|
|
133
125
|
/**
|
|
134
126
|
* Indicates whether the feature navigation arrows are displayed at the top of the component.
|
|
135
127
|
* By default, the navigation arrows are displayed at the bottom of the component.
|
|
136
128
|
*
|
|
137
129
|
* @default false
|
|
138
|
-
* @since 5.1
|
|
139
130
|
*/
|
|
140
131
|
accessor featureNavigationTop: boolean;
|
|
141
132
|
/**
|
|
142
|
-
* An array of
|
|
133
|
+
* An array of graphics associated with the component. Each graphic in this array must have a valid [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) set. They may share the same [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) or have unique [PopupTemplates](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) depending on their attributes. The [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#content) and [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading) of the component is set based on the `content` and `title` properties of each graphic's respective [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).
|
|
143
134
|
*
|
|
144
|
-
* When more than one graphic exists in this array, the current content of the component is set based on the value of the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature)
|
|
135
|
+
* When more than one graphic exists in this array, the current content of the component is set based on the value of the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature).
|
|
145
136
|
*
|
|
146
137
|
* This value is `null` if no features are associated with the component.
|
|
147
138
|
*
|
|
@@ -183,16 +174,14 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
183
174
|
* ```
|
|
184
175
|
*/
|
|
185
176
|
accessor goToOverride: GoToOverride | null | undefined;
|
|
186
|
-
/**
|
|
177
|
+
/** A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of [action buttons](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionButton/) or [action toggles](https://developers.arcgis.com/javascript/latest/references/core/support/actions/ActionToggle/) that are displayed in the header of the component. Each action may be executed by clicking the icon or image symbolizing them. The order of each action is the order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/). The [@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#event-arcgisTriggerAction) event fires each time an action is clicked. */
|
|
187
178
|
accessor headerActions: Collection<ActionButton | ActionToggle>;
|
|
188
179
|
/**
|
|
189
180
|
* The title of the Features component. This can be set to any string value no
|
|
190
|
-
* matter the features that are selected. If the [
|
|
191
|
-
* has a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/), then the title set in the
|
|
192
|
-
* corresponding template is used here.
|
|
181
|
+
* matter the features that are selected. If the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature)
|
|
182
|
+
* has a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/), then the title set in the corresponding template is used here.
|
|
193
183
|
*
|
|
194
|
-
* @see [
|
|
195
|
-
* @since 5.1
|
|
184
|
+
* @see [headingLevel](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#headingLevel)
|
|
196
185
|
* @example
|
|
197
186
|
* ```js
|
|
198
187
|
* // This title will display in the component unless a selected feature's
|
|
@@ -202,26 +191,21 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
202
191
|
*/
|
|
203
192
|
accessor heading: string | null | undefined;
|
|
204
193
|
/**
|
|
205
|
-
* Indicates the heading level to use for the
|
|
206
|
-
* By default, the heading is rendered
|
|
207
|
-
* as a level 2 heading (e.g. `<h2>Popup title</h2>`). Depending on the component's placement
|
|
208
|
-
* in your app, you may need to adjust this heading for proper semantics. This is
|
|
209
|
-
* important for meeting accessibility standards.
|
|
194
|
+
* Indicates the heading level to use for the headings in the component.
|
|
210
195
|
*
|
|
211
196
|
* @default 2
|
|
212
197
|
*/
|
|
213
198
|
accessor headingLevel: HeadingLevel;
|
|
214
199
|
/**
|
|
215
|
-
* Indicates whether to hide the action bar that holds the feature's [
|
|
200
|
+
* Indicates whether to hide the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions).
|
|
216
201
|
*
|
|
217
202
|
* @default false
|
|
218
203
|
*/
|
|
219
204
|
accessor hideActionBar: boolean;
|
|
220
205
|
/**
|
|
221
|
-
*
|
|
206
|
+
* Indicates whether to hide [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.
|
|
222
207
|
*
|
|
223
208
|
* @default false
|
|
224
|
-
* @since 5.1
|
|
225
209
|
*/
|
|
226
210
|
accessor hideAttachmentsContent: boolean | undefined;
|
|
227
211
|
/**
|
|
@@ -231,31 +215,27 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
231
215
|
*/
|
|
232
216
|
accessor hideCloseButton: boolean;
|
|
233
217
|
/**
|
|
234
|
-
*
|
|
218
|
+
* Indicates whether to hide the component's content.
|
|
235
219
|
*
|
|
236
220
|
* @default false
|
|
237
|
-
* @since 5.1
|
|
238
221
|
*/
|
|
239
222
|
accessor hideContent: boolean;
|
|
240
223
|
/**
|
|
241
|
-
*
|
|
224
|
+
* Indicates whether to hide [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.
|
|
242
225
|
*
|
|
243
226
|
* @default false
|
|
244
|
-
* @since 5.1
|
|
245
227
|
*/
|
|
246
228
|
accessor hideCustomContent: boolean | undefined;
|
|
247
229
|
/**
|
|
248
|
-
*
|
|
230
|
+
* Indicates whether to hide [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.
|
|
249
231
|
*
|
|
250
232
|
* @default false
|
|
251
|
-
* @since 5.1
|
|
252
233
|
*/
|
|
253
234
|
accessor hideExpressionContent: boolean;
|
|
254
235
|
/**
|
|
255
236
|
* Indicates whether to hide the group heading for a list of multiple features.
|
|
256
237
|
*
|
|
257
238
|
* @default false
|
|
258
|
-
* @since 5.1
|
|
259
239
|
*/
|
|
260
240
|
accessor hideFeatureListLayerTitle: boolean;
|
|
261
241
|
/**
|
|
@@ -271,30 +251,27 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
271
251
|
*/
|
|
272
252
|
accessor hideFeatureNavigation: boolean;
|
|
273
253
|
/**
|
|
274
|
-
*
|
|
254
|
+
* Indicates whether to hide [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.
|
|
275
255
|
*
|
|
276
256
|
* @default false
|
|
277
|
-
* @since 5.1
|
|
278
257
|
*/
|
|
279
258
|
accessor hideFieldsContent: boolean | undefined;
|
|
280
259
|
/**
|
|
281
|
-
* Indicates whether to hide the heading
|
|
260
|
+
* Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading).
|
|
282
261
|
*
|
|
283
262
|
* @default false
|
|
284
263
|
*/
|
|
285
264
|
accessor hideHeading: boolean;
|
|
286
265
|
/**
|
|
287
|
-
*
|
|
266
|
+
* Indicates whether to hide the last edited info in the component.
|
|
288
267
|
*
|
|
289
268
|
* @default false
|
|
290
|
-
* @since 5.1
|
|
291
269
|
*/
|
|
292
270
|
accessor hideLastEditedInfo: boolean;
|
|
293
271
|
/**
|
|
294
|
-
*
|
|
272
|
+
* Indicates whether to hide [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.
|
|
295
273
|
*
|
|
296
274
|
* @default false
|
|
297
|
-
* @since 5.1
|
|
298
275
|
*/
|
|
299
276
|
accessor hideMediaContent: boolean | undefined;
|
|
300
277
|
/**
|
|
@@ -308,7 +285,6 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
308
285
|
* Indicates whether to hide the *select feature* action when viewing associated and related features.
|
|
309
286
|
*
|
|
310
287
|
* @default false
|
|
311
|
-
* @since 5.1
|
|
312
288
|
*/
|
|
313
289
|
accessor hideSelectFeature: boolean;
|
|
314
290
|
/**
|
|
@@ -318,10 +294,9 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
318
294
|
*/
|
|
319
295
|
accessor hideSpinner: boolean;
|
|
320
296
|
/**
|
|
321
|
-
*
|
|
297
|
+
* Indicates whether to hide [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.
|
|
322
298
|
*
|
|
323
299
|
* @default false
|
|
324
|
-
* @since 5.1
|
|
325
300
|
*/
|
|
326
301
|
accessor hideTextContent: boolean | undefined;
|
|
327
302
|
/**
|
|
@@ -332,11 +307,10 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
332
307
|
*/
|
|
333
308
|
accessor hideUtilityNetworkContent: boolean | undefined;
|
|
334
309
|
/**
|
|
335
|
-
* Indicates whether to highlight the [
|
|
336
|
-
* [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)
|
|
310
|
+
* Indicates whether to highlight the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature) in the associated
|
|
311
|
+
* [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) component.
|
|
337
312
|
*
|
|
338
313
|
* @default false
|
|
339
|
-
* @since 5.1
|
|
340
314
|
*/
|
|
341
315
|
accessor highlightDisabled: boolean;
|
|
342
316
|
/**
|
|
@@ -351,7 +325,6 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
351
325
|
* In order to disable any default actions, it is necessary to set `includeDefaultActionsDisabled` to `true`.
|
|
352
326
|
*
|
|
353
327
|
* @default false
|
|
354
|
-
* @since 5.1
|
|
355
328
|
*/
|
|
356
329
|
accessor includeDefaultActionsDisabled: boolean;
|
|
357
330
|
/**
|
|
@@ -363,9 +336,9 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
363
336
|
/** The component's default label. */
|
|
364
337
|
accessor label: string | undefined;
|
|
365
338
|
/**
|
|
366
|
-
* A map is required when the input [
|
|
339
|
+
* A map is required when the input [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) have a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/references/core/popup/ExpressionInfo/) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) that may use the `$map` profile variable to access data from layers within a map. Without a map, expressions that use `$map` will throw an error.
|
|
367
340
|
*
|
|
368
|
-
* Alternatively, the [
|
|
341
|
+
* Alternatively, the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#view) property can be used to provide the map instance for this property.
|
|
369
342
|
*
|
|
370
343
|
* @default null
|
|
371
344
|
* @see [Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)
|
|
@@ -381,8 +354,6 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
381
354
|
* Replace localized message strings with your own strings.
|
|
382
355
|
*
|
|
383
356
|
* _**Note**: Individual message keys may change between releases._
|
|
384
|
-
*
|
|
385
|
-
* @since 5.1
|
|
386
357
|
*/
|
|
387
358
|
accessor messageOverrides: {
|
|
388
359
|
componentLabel?: string | undefined;
|
|
@@ -477,11 +448,8 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
477
448
|
/**
|
|
478
449
|
* Indicates whether the component is visible. This property is `true` when the component is querying for results, even if it is not open. Use this property to check if the component is visible.
|
|
479
450
|
*
|
|
480
|
-
* When setting the [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#content) and [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading) directly, it is recommended to call [clear()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#clear) before setting `open` to `true` to remove any existing promises, features, heading, location, and content from the component. Otherwise, the old content will display.
|
|
481
|
-
*
|
|
482
451
|
* @default false
|
|
483
|
-
* @see [
|
|
484
|
-
* @see [active](https://developers.arcgis.com/javascript/latest/references/core/popup/Features/#active)
|
|
452
|
+
* @see [active](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#active)
|
|
485
453
|
* @see [clear()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#clear)
|
|
486
454
|
* @since 5.0
|
|
487
455
|
* @example
|
|
@@ -489,7 +457,6 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
489
457
|
* // Listen for clicks on the view and open the component at the clicked location with custom content.
|
|
490
458
|
* viewElement.addEventListener("arcgisViewClick", (event) => {
|
|
491
459
|
* const { mapPoint } = event.detail;
|
|
492
|
-
* component.clear();
|
|
493
460
|
* component.location = mapPoint;
|
|
494
461
|
* component.heading = "You clicked here";
|
|
495
462
|
* component.content = "Latitude: " + mapPoint.latitude.toFixed(3) + ", Longitude: " + mapPoint.longitude.toFixed(3);
|
|
@@ -498,13 +465,6 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
498
465
|
* ```
|
|
499
466
|
*/
|
|
500
467
|
accessor open: boolean;
|
|
501
|
-
/**
|
|
502
|
-
* An array of pending Promises that have not yet been fulfilled. If there are
|
|
503
|
-
* no pending promises, the value is `null`. When the pending promises are
|
|
504
|
-
* resolved they are removed from this array and the features they return
|
|
505
|
-
* are pushed into the [arcgis-features.features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) array.
|
|
506
|
-
*/
|
|
507
|
-
accessor promises: Array<Promise<Array<Graphic>>>;
|
|
508
468
|
/**
|
|
509
469
|
* 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.
|
|
510
470
|
*
|
|
@@ -532,7 +492,7 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
532
492
|
*/
|
|
533
493
|
get selectedFeatureComponent(): ArcgisFeatureNext | undefined;
|
|
534
494
|
/**
|
|
535
|
-
* Index of the feature that is [
|
|
495
|
+
* Index of the feature that is [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) are set,
|
|
536
496
|
* the first index is automatically selected.
|
|
537
497
|
*/
|
|
538
498
|
accessor selectedFeatureIndex: number;
|
|
@@ -546,7 +506,7 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
546
506
|
* The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.
|
|
547
507
|
* This property should be set if the Features component executes Arcade expressions that contain [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/).
|
|
548
508
|
*
|
|
549
|
-
* Alternatively, the [
|
|
509
|
+
* Alternatively, the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#view) property can be used to provide the spatial reference instance for this property.
|
|
550
510
|
*
|
|
551
511
|
* @default null
|
|
552
512
|
* @see [Type system](https://developers.arcgis.com/arcade/guide/types/#featuresetcollection)
|
|
@@ -561,7 +521,7 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
561
521
|
get state(): State;
|
|
562
522
|
/**
|
|
563
523
|
* Dates and times displayed in the component will be displayed in this time zone. By default this time zone is
|
|
564
|
-
* inherited from [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) if the [
|
|
524
|
+
* inherited from [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) if the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#view) property is set. When a MapView is not associated with the component
|
|
565
525
|
* then the property will fallback to the `system` time zone.
|
|
566
526
|
*
|
|
567
527
|
* **Possible Values**
|
|
@@ -573,7 +533,7 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
573
533
|
*/
|
|
574
534
|
accessor timeZone: string;
|
|
575
535
|
/**
|
|
576
|
-
* Indicates whether to update the feature location when the [
|
|
536
|
+
* Indicates whether to update the feature location when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeatureIndex) changes.
|
|
577
537
|
*
|
|
578
538
|
* @default false
|
|
579
539
|
* @since 5.1
|
|
@@ -582,21 +542,18 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
582
542
|
/**
|
|
583
543
|
* A reference to the [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/) or [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).
|
|
584
544
|
* The Features component requires a `view` to be set if:
|
|
585
|
-
* - The [
|
|
545
|
+
* - The [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) have a popupTemplate containing Arcade expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/references/core/popup/ExpressionInfo/) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) that may use [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) or reference the `$map` profile variable (i.e. access data from layers within a map). Alternatively, set the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#map) property.
|
|
586
546
|
* - Content is displayed from the popup template of an [aggregate feature](https://developers.arcgis.com/javascript/latest/references/core/Graphic/#isAggregate) (i.e. a [cluster](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/) or [bin](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/)).
|
|
587
547
|
* - Values from `date` and `timestamp-offset` fields should respect the view's [time zone](https://developers.arcgis.com/javascript/latest/references/core/views/View/#timeZone).
|
|
588
|
-
* Alternatively, set the [
|
|
589
|
-
* - Using the
|
|
590
|
-
* - Using the `Zoom to` default action. If the `view` is not specified, set the [arcgis-features.includeDefaultActionsDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#includeDefaultActionsDisabled) property to `true` to remove this default action.
|
|
548
|
+
* Alternatively, set the [timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#timeZone) property.
|
|
549
|
+
* - Using the `Zoom to` default action. If the `view` is not specified, set the [includeDefaultActionsDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#includeDefaultActionsDisabled) property to `true` to remove this default action.
|
|
591
550
|
*
|
|
592
551
|
* @since 5.1
|
|
593
552
|
*/
|
|
594
553
|
accessor view: MapViewOrSceneView | null | undefined;
|
|
595
|
-
/** @since 5.1 */
|
|
596
|
-
accessor viewModel: Features;
|
|
597
554
|
/**
|
|
598
|
-
* Removes [
|
|
599
|
-
* [
|
|
555
|
+
* Removes [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#content), and
|
|
556
|
+
* [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading) from the component.
|
|
600
557
|
*/
|
|
601
558
|
clear(): void;
|
|
602
559
|
/** A convenience method to close the component. */
|
|
@@ -604,39 +561,15 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
604
561
|
/** Permanently destroy the component. */
|
|
605
562
|
destroy(): Promise<void>;
|
|
606
563
|
/**
|
|
607
|
-
*
|
|
608
|
-
*
|
|
609
|
-
* @param screenPoint
|
|
610
|
-
* @param options
|
|
611
|
-
* @see [open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#open)
|
|
612
|
-
* @example
|
|
613
|
-
* ```js
|
|
614
|
-
* const viewElement = document.querySelector("arcgis-map");
|
|
615
|
-
* // Get viewElement's click event
|
|
616
|
-
* reactiveUtils.on(()=>viewElement, "arcgisViewClick", async (event)=>{
|
|
617
|
-
* // Call fetchFeatures on the component and pass in the click event detail
|
|
618
|
-
* await component.fetchFeatures(event.detail);
|
|
619
|
-
* });
|
|
620
|
-
* // Watch for changes to the features property and open the component when features are available.
|
|
621
|
-
* reactiveUtils.watch(
|
|
622
|
-
* () => component.features,
|
|
623
|
-
* () => {
|
|
624
|
-
* component.open = component.features ? true : false;
|
|
625
|
-
* },
|
|
626
|
-
* );
|
|
627
|
-
* ```
|
|
628
|
-
*/
|
|
629
|
-
fetchFeatures(screenPoint?: ScreenPoint, options?: FetchFeaturesOptions): Promise<void>;
|
|
630
|
-
/**
|
|
631
|
-
* Selects the feature at the next index in relation to the [arcgis-features.selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature).
|
|
564
|
+
* Selects the feature at the next index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature).
|
|
632
565
|
*
|
|
633
|
-
* @see [
|
|
566
|
+
* @see [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeatureIndex)
|
|
634
567
|
*/
|
|
635
568
|
next(): void;
|
|
636
569
|
/**
|
|
637
|
-
* Selects the feature at the previous index in relation to the [
|
|
570
|
+
* Selects the feature at the previous index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature).
|
|
638
571
|
*
|
|
639
|
-
* @see [
|
|
572
|
+
* @see [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeatureIndex)
|
|
640
573
|
*/
|
|
641
574
|
previous(): void;
|
|
642
575
|
/**
|
|
@@ -646,8 +579,8 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
646
579
|
*/
|
|
647
580
|
setFocus(): Promise<void>;
|
|
648
581
|
/**
|
|
649
|
-
* Triggers the [
|
|
650
|
-
* at the specified index in the [
|
|
582
|
+
* Triggers the [@arcgisTriggerAction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#event-arcgisTriggerAction) event and executes the action
|
|
583
|
+
* at the specified index in the [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions) array.
|
|
651
584
|
*
|
|
652
585
|
* @param action
|
|
653
586
|
*/
|
|
@@ -662,9 +595,9 @@ export abstract class ArcgisFeaturesNext extends LitElement {
|
|
|
662
595
|
* Fires after the user clicks on an action in the component.
|
|
663
596
|
* This event may be used to define a custom function to execute when particular actions are clicked.
|
|
664
597
|
*
|
|
665
|
-
* @see [
|
|
598
|
+
* @see [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions)
|
|
666
599
|
* @see [PopupTemplate.actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions)
|
|
667
|
-
* @see [
|
|
600
|
+
* @see [open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#open)
|
|
668
601
|
* @example
|
|
669
602
|
* ```js
|
|
670
603
|
* // Fires each time an action is clicked
|
|
@@ -130,32 +130,32 @@ export abstract class ArcgisOrientedImageryViewer extends LitElement {
|
|
|
130
130
|
* The layer contains the feature data and oriented imagery properties required by the viewer to load the image and generate the associated graphics.
|
|
131
131
|
*
|
|
132
132
|
* > [!WARNING]
|
|
133
|
-
* > Use `layer`, `
|
|
133
|
+
* > Use `layer`, `mapLayerId`, and `orientedImageryLayerItemId` independently; only one should be set at a time.
|
|
134
134
|
*/
|
|
135
135
|
accessor layer: OrientedImageryLayer | null | undefined;
|
|
136
|
+
/**
|
|
137
|
+
* Indicates if the map-image location tool is available in the component.
|
|
138
|
+
* When `true`, the user can select a point on the map and the corresponding location in pixel space will be displayed in the image, and vice versa.
|
|
139
|
+
*
|
|
140
|
+
* @default false
|
|
141
|
+
*/
|
|
142
|
+
accessor mapImageConversionToolState: boolean;
|
|
136
143
|
/**
|
|
137
144
|
* The layer ID of a Oriented Imagery Layer in the associated map.
|
|
138
145
|
* When set, the component will attempt to find and use the layer with the provided ID from the map.
|
|
139
146
|
*
|
|
140
147
|
* > [!WARNING]
|
|
141
|
-
* > Use `layer`, `
|
|
148
|
+
* > Use `layer`, `mapLayerId`, and `orientedImageryLayerItemId` independently; only one should be set at a time.
|
|
142
149
|
*
|
|
143
150
|
* @since 5.1
|
|
144
151
|
* @example
|
|
145
152
|
* ```html
|
|
146
153
|
* <arcgis-scene item-id="aa1c036445824e06a2d1b0e12e02a924">
|
|
147
|
-
* <arcgis-oriented-imagery-viewer slot="top-right" layer-id="1962adf1de1-layer-82"></arcgis-oriented-imagery-viewer>
|
|
154
|
+
* <arcgis-oriented-imagery-viewer slot="top-right" map-layer-id="1962adf1de1-layer-82"></arcgis-oriented-imagery-viewer>
|
|
148
155
|
* </arcgis-scene>
|
|
149
156
|
* ```
|
|
150
157
|
*/
|
|
151
|
-
accessor
|
|
152
|
-
/**
|
|
153
|
-
* Indicates if the map-image location tool is available in the component.
|
|
154
|
-
* When `true`, the user can select a point on the map and the corresponding location in pixel space will be displayed in the image, and vice versa.
|
|
155
|
-
*
|
|
156
|
-
* @default false
|
|
157
|
-
*/
|
|
158
|
-
accessor mapImageConversionToolState: boolean;
|
|
158
|
+
accessor mapLayerId: string | undefined;
|
|
159
159
|
/**
|
|
160
160
|
* When `true`, the navigation tool is available in the component.
|
|
161
161
|
* The navigation tool can be used to explore the images that contain the selected location on the map using a compass.
|
|
@@ -169,7 +169,7 @@ export abstract class ArcgisOrientedImageryViewer extends LitElement {
|
|
|
169
169
|
* The portal item ID of an Oriented Imagery Layer to load and use in the component.
|
|
170
170
|
*
|
|
171
171
|
* > [!WARNING]
|
|
172
|
-
* > Use `layer`, `
|
|
172
|
+
* > Use `layer`, `mapLayerId`, and `orientedImageryLayerItemId` independently; only one should be set at a time.
|
|
173
173
|
*/
|
|
174
174
|
accessor orientedImageryLayerItemId: string | undefined;
|
|
175
175
|
/**
|