Feature

Use dark colors for code blocksCopy
import "@arcgis/map-components/components/arcgis-feature";

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
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`defaultPopupTemplateEnabled`	`default-popup-template-enabled`	`boolean`
`graphic`		`Graphic`
`headingLevel`	`heading-level`	`number`
`hideContentAttachments`	`hide-content-attachments`	`boolean`
`hideContentExpression`	`hide-content-expression`	`boolean`
`hideContentFields`	`hide-content-fields`	`boolean`
`hideContentMedia`	`hide-content-media`	`boolean`
`hideContentText`	`hide-content-text`	`boolean`
`hideLastEditInfo`	`hide-last-edit-info`	`boolean`
`hideTitle`	`hide-title`	`boolean`
`icon`	`icon`	`string`
`label`	`label`	`string`
`location`		`Point`
`map`		`Map`
`position`	`position`	`"bottom-leading" \| "bottom-left" \| "bottom-right" \| "bottom-trailing" \| "manual" \| "top-leading" \| "top-left" \| "top-right" \| "top-trailing"`
`referenceElement`	`reference-element`	`ArcgisLinkChart \| ArcgisMap \| ArcgisScene \| string`
`spatialReference`		`SpatialReference`
`state` readonly	`state`	`"disabled" \| "error" \| "loading" \| "ready"`

autoDestroyDisabled

Property

autoDestroyDisabled: 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

defaultPopupTemplateEnabled

Property

defaultPopupTemplateEnabled: boolean

Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined.

Attribute: default-popup-template-enabled
Default value: false

graphic

Property

graphic: Graphic

The Graphic used to represent the feature.

Default value: null

headingLevel

Property

headingLevel: number

Indicates the heading level to use for the title of the feature widget.

Attribute: heading-level
Default value: 2

hideContentAttachments

Property

hideContentAttachments: boolean

Attribute: hide-content-attachments
Default value: false

hideContentExpression

Property

hideContentExpression: boolean

Attribute: hide-content-expression
Default value: false

hideContentFields

Property

hideContentFields: boolean

Attribute: hide-content-fields
Default value: false

hideContentMedia

Property

hideContentMedia: boolean

Attribute: hide-content-media
Default value: false

hideContentText

Property

hideContentText: boolean

Attribute: hide-content-text
Default value: false

hideLastEditInfo

Property

hideLastEditInfo: boolean

Attribute: hide-last-edit-info
Default value: false

hideTitle

Property

hideTitle: boolean

Attribute: hide-title
Default value: false

icon

Property

icon: string

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component). Search Calcite Icons for possible values.

Attribute: icon
Default value: "polygon"

label

Property

label: string

The component's default label.

Attribute: label

location

Property

location: Point

The Point representing the location of the MapView interaction used to trigger the opening of the widget.

Default value: null

map

Property

map: Map

A 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

Property

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

Property

referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string

Attribute: reference-element

spatialReference

Property

spatialReference: SpatialReference

The spatial reference used for Arcade operations.

Default value: null

state

readonly

Property

state: "disabled" | "error" | "loading" | "ready"

The view model's state.

Attribute: state
Default value: "disabled"

Methods

Method	Signature
`componentOnReady`	`componentOnReady(): Promise<void>`
`destroy`	`destroy(): Promise<void>`
`nextMedia`	`nextMedia(contentElementIndex: number): Promise<void>`
`previousMedia`	`previousMedia(contentElementIndex: number): Promise<void>`
`setActiveMedia`	`setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>`

componentOnReady

Method

componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns: Promise<void>

destroy

Method

destroy(): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

nextMedia

Method

nextMedia(contentElementIndex: number): Promise<void>

Parameters

Parameter	Type	Optional?
contentElementIndex	`number`

Returns: Promise<void>

previousMedia

Method

previousMedia(contentElementIndex: number): Promise<void>

Parameters

Parameter	Type	Optional?
contentElementIndex	`number`

Returns: Promise<void>

setActiveMedia

Method

setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>

Parameters

Parameter	Type	Optional?
contentElementIndex	`number`
mediaInfoIndex	`number`

Returns: Promise<void>

Events

Event	Type
`arcgisPropertyChange`	`{ name: "state"; }`
`arcgisReady`	`undefined`

arcgisPropertyChange

Event

arcgisPropertyChange: { name: "state"; }

Emitted when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event

arcgisReady: undefined

Emitted when the component associated with a map view is is ready to be interacted with.