import "@arcgis/map-components/components/arcgis-feature";The Feature component displays a graphic according to its PopupTemplate. This component is useful in instances where you want to display information about a feature but without the use of a Popup.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
auto-destroy-disabled | boolean | |
default-popup-template-enabled | boolean | |
| ||
heading-level | number | |
hide-content-attachments | boolean | |
hide-content-expression | boolean | |
hide-content-fields | boolean | |
hide-content-media | boolean | |
hide-content-text | boolean | |
hide-last-edited-info | boolean | |
hideLastEditInfodeprecated | hide-last-edit-info | boolean |
hide-title | boolean | |
icon | string | |
label | string | |
| ||
| ||
position | "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing" | |
reference-element | ||
| ||
statereadonly | state | "disabled" | "error" | "loading" | "ready" |
time-zone | string |
autoDestroyDisabled
autoDestroyDisabled: booleanIf 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
defaultPopupTemplateEnabled
defaultPopupTemplateEnabled: booleanEnables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined.
- Attribute
- default-popup-template-enabled
- Default value
- false
headingLevel
headingLevel: numberIndicates the heading level to use for the title of the feature widget.
- Attribute
- heading-level
- Default value
- 2
hideContentAttachments
hideContentAttachments: booleanIndicates whether to hide all AttachmentsContent.
- Attribute
- hide-content-attachments
- Default value
- false
hideContentExpression
hideContentExpression: booleanIndicates whether to hide all ExpressionContent.
- Attribute
- hide-content-expression
- Default value
- false
hideContentFields
hideContentFields: booleanIndicates whether to hide all FieldsContent.
- Attribute
- hide-content-fields
- Default value
- false
hideContentMedia
hideContentMedia: booleanIndicates whether to hide all MediaContent.
- Attribute
- hide-content-media
- Default value
- false
hideContentText
hideContentText: booleanIndicates whether to hide all TextContent.
- Attribute
- hide-content-text
- Default value
- false
hideLastEditedInfo
hideLastEditedInfo: booleanIndicates whether to hide the lastEditInfo.
- Attribute
- hide-last-edited-info
- Default value
- false
hideLastEditInfo
hideLastEditInfo: boolean- Attribute
- hide-last-edit-info
- Default value
- false
hideTitle
hideTitle: booleanIndicates whether to hide the title associated with the feature.
- Attribute
- hide-title
- Default value
- false
icon
icon: stringIcon 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
- "polygon"
map
map: MapA map is required when the input graphic has a popupTemplate that contains Arcade expressions in ExpressionInfo or ExpressionContent that may use the $map profile variable to access data from layers within a map.
- Default value
- null
position
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"- Attribute
- position
- Default value
- "bottom-left"
referenceElement
referenceElement: HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | stringBy 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
spatialReference
spatialReference: SpatialReferenceThe spatial reference used for Arcade operations.
- Default value
- null
state
state: "disabled" | "error" | "loading" | "ready"The current state of the component.
- Attribute
- state
- Default value
- "disabled"
timeZone
timeZone: stringDates and times displayed in the widget will be displayed in this time zone.
- Attribute
- time-zone
Slots
Events
| Event | Type |
|---|---|
CustomEvent<{ name: "state"; }> | |
CustomEvent<void> |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "state"; }>Emitted when the value of a property is changed. Use this to listen to changes to properties.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
arcgisReady
arcgisReady: CustomEvent<void>Emitted when the component associated with a map or scene view is is ready to be interacted with.
Events triggered on this element will be propagated to their outermost elements.
The event is composable and will propagate across the shadow DOM into the standard DOM.
The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.
Methods
| Method | Signature |
|---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
nextMedia(contentElementIndex: number): Promise<void> | |
previousMedia(contentElementIndex: number): Promise<void> | |
setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>Create a promise that resolves once component is fully loaded.
Example
const arcgisFeature = document.querySelector("arcgis-feature");
document.body.append(arcgisFeature);
await arcgisFeature.componentOnReady();
console.log("arcgis-feature is ready to go!");- Returns
- Promise<void>
nextMedia
nextMedia(contentElementIndex: number): Promise<void>Paginates to the next media info.
Parameters
| Parameter | Type | Optional? |
|---|---|---|
contentElementIndex | number |
- Returns
- Promise<void>
previousMedia
previousMedia(contentElementIndex: number): Promise<void>Paginates to the previous media info.
Parameters
| Parameter | Type | Optional? |
|---|---|---|
contentElementIndex | number |
- Returns
- Promise<void>
setActiveMedia
setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>Paginates to a specified media info object. For example, you may have media content which contains multiple mediaInfos. This method allows you to specify the index of the mediaInfos you wish to display.
Parameters
| Parameter | Type | Optional? |
|---|---|---|
contentElementIndex | number | |
mediaInfoIndex | number |
- Returns
- Promise<void>