Types
import type { State, FeatureFormattedAttributes, LastEditInfo, LayerInfo, RelatedInfo } from "@arcgis/core/widgets/Feature/types.js";

Type definitions

State

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
"disabled" | "ready" | "error" | "loading"

FeatureFormattedAttributes

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

global

Property
Type
Record<string, any>
Since
ArcGIS Maps SDK for JavaScript 5.0

The formatted attributes specified at the root level of the PopupTemplate using the PopupTemplate.fieldInfos property.

content

Property
Type
Record<string, any>[]
Since
ArcGIS Maps SDK for JavaScript 5.0

The formatted attributes for an individual content element. This is derived from the PopupTemplate, or per an individual content element. This element is defined with a FieldsContent popup element set on the PopupTemplate's PopupTemplate.content.

LastEditInfo

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

user

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

User who performed the last edit on a feature.

date

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

Date that the edit was performed.

type

Property
Type
"edit" | "create"
Since
ArcGIS Maps SDK for JavaScript 5.0

The type of edit that was performed on the feature.

LayerInfo

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Information about the layer associated with the feature.

fields

Property
Type
Field[]
Since
ArcGIS Maps SDK for JavaScript 5.0

An array of the layer's fields.

relationships

Property
Type
Relationship[]
Since
ArcGIS Maps SDK for JavaScript 5.0

An array of the layer's relationships.

objectIdField

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The object ID field of the layer.

supportsStatistics

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the layer supports statistics.

RelatedInfo

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Information about the features that are related to the current feature.

url

Property
Type
string
Since
ArcGIS Maps SDK for JavaScript 5.0

The URL of the related layer.

outStatistics

Property
Type
StatisticDefinition[] | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

An array of statistics to be calculated for the related features.

relatedFields

Property
Type
string[] | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

An array of related fields that are related to the current feature.

relatedFeatures

Property
Type
Graphic[] | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

An array of features related to the current feature.

relatedStatsFeatures

Property
Type
Graphic[] | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

An array of related features with statistics for the current feature.

relation

Property
Type
Relationship | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The relationship between the current feature and the related features.

layerInfo

Property
Type
LayerInfo | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The layer information for the related features.

sourceSpatialReference

Property
Type
SpatialReference | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

The spatial reference of the source feature.

Abilities

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

This object defines specific abilities for the Feature and Popup widgets.

attachmentsContent

Property
Type
boolean | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicate whether the widget should query and display attachments associated with the feature.

Default value
true

chartAnimation

Property
Type
boolean | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicate whether the widget should display animations for charts residing in media content elements.

Default value
true

customContent

Property
Type
boolean | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicate whether the widget should display any custom content elements.

Default value
true

fieldsContent

Property
Type
boolean | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicate whether the widget should display any fields content elements.

Default value
true

mediaContent

Property
Type
boolean | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicate whether the widget should display any media content elements.

Default value
true

textContent

Property
Type
boolean | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicate whether the widget should display any text content elements.

Default value
true

relationshipContent

Property
Type
boolean | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicate whether the widget should display relationship content elements.

Default value
true

utilityNetworkAssociationsContent

Property
Type
boolean | undefined
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicate whether the widget should display utility network associations content elements.

Default value
true