Class Feature

Represents a record in a data/FeatureSource!FeatureSource. Both spatial and non-spatial features have attributes, while only spatial features have geometry.

Hierarchy (view full)

Constructors

constructor

Properties

_handles _id _itemType @eventTypes attachments attributes expressionFieldValues schema settings

Accessors

attachmentsInitialized description expressionsInitialized failureMode geometry geometryType globalId hasGlobalId hyperlinks id isDestroyed isInitialized itemType presentableAttributes primaryKey relatedFeatures relatedFeaturesInitialized source title type

Methods

_getSerializableProperties _initializableChildCollections _initializeChildren _onDestroy _onInitialize _postInitialize _toPropertyDef addAttachment assignProperties assignPropertiesAsync clearExpressionInfos deleteAttachments destroy fetchAttachments fetchExpressionInfos fetchRelatedFeatures finishAssignProperties format getDefault getDefaults getSerializableProperties initialize toGraphic toItemUri toJSON

Constructors

constructor

Properties

Protected Readonly_handles

_handles: Handles<unknown, ResourceHandle>

Protected_id

_id: string

The unique ID for this entity. Once set, this should never change.

Protected Readonly_itemType

_itemType: string = ItemType.FEATURE

The item type for this entity when it participates in an App.

@eventTypes

@eventTypes: InitializableBaseEvents

Deprecated

Do not directly reference this property. Use EventNames and EventTypes helpers from @arcgis/core/Evented.

Readonlyattachments

attachments: Collection<Attachment>

Attachments associated with this feature. See fetchAttachments.

Readonlyattributes

attributes: CaseInsensitiveObservableMap<unknown>

The feature's attributes, keyed by field name.

ReadonlyexpressionFieldValues

expressionFieldValues: ReadOnlyMap<string, unknown>

The Expression values associated with this feature. See fetchExpressionInfos.

Readonlyschema

schema: Schema

Metadata about the feature, such as fields, domains, geometry type, etc.

Readonlysettings

settings: FeatureSettings

Settings for this feature.

Accessors

attachmentsInitialized

  • get attachmentsInitialized(): boolean

  • Indicates whether attachments have been fetched at least once.

    Returns boolean

description

  • get description(): string

  • A human-readable description for the feature.

    Returns string

expressionsInitialized

  • get expressionsInitialized(): boolean

  • Indicates whether async Arcade expressions have been evaluated at least once.

    Returns boolean

failureMode

geometry

  • get geometry(): GeometryUnion

  • The feature's geometry. For non-spatial features, this will be undefined.

    Returns GeometryUnion

  • set geometry(value): void

  • Parameters

    • value: GeometryUnion

    Returns void

geometryType

  • get geometryType(): string

  • The type of geometry. This property will be undefined if the data is not spatial.

    Returns string

globalId

  • get globalId(): string

  • Returns the feature's global ID if set and supported by its underlying source. If the feature's source does not support global IDs, then reading this value will return undefined, and attempting to set this property will result in an error. Use hasGlobalId to check if it's supported.

    Returns string

  • set globalId(value): void

  • Parameters

    • value: string

    Returns void

hasGlobalId

  • get hasGlobalId(): boolean

  • Determines whether this feature has a global ID field.

    Returns boolean

hyperlinks

  • Hyperlinks associated with the feature. Note: This collection is read-only. To change hyperlinks, modify the hyperlinkTemplates setting instead.

    Returns Collection<Hyperlink>

id

  • get id(): string

  • The unique ID for this entity.

    Returns string

isDestroyed

isInitialized

itemType

  • get itemType(): string

  • The item type for this entity when it participates in an App.

    Returns string

presentableAttributes

primaryKey

  • get primaryKey(): string

  • The attribute value of the Feature's OBJECTID (oid) field.

    Returns string

relatedFeatures

relatedFeaturesInitialized

  • get relatedFeaturesInitialized(): boolean

  • Indicates whether related features have been fetched at least once, if this feature has relationships.

    Returns boolean

source

title

  • get title(): string

  • A human readable title for the feature.

    Returns string

type

  • get type(): FeatureType

  • The Esri API FeatureType object that is associated with this feature.

    Returns FeatureType

Methods

Protected_getSerializableProperties

Protected_initializableChildCollections

Protected_initializeChildren

Protected_onDestroy

  • _onDestroy(): Promise<void>

  • Called to perform cleanup. Subclasses should override this method rather than destroy() to perform custom cleanup.

    Returns Promise<void>

Protected_onInitialize

Protected_postInitialize

  • _postInitialize(): Promise<void>

  • Called after normal initialization. Note: Child items are initialized before this is called.

    Returns Promise<void>

Protected_toPropertyDef

addAttachment

assignProperties

assignPropertiesAsync

clearExpressionInfos

  • clearExpressionInfos(): void

  • Clears the cached values for all "expression info" contained in the PopupTemplate.

    Returns void

deleteAttachments

  • deleteAttachments(attachments): Promise<void>

  • Deletes attachments from the feature.

    Parameters

    • attachments: (string | Attachment)[]

      The attachments or the ids of the attachments to delete.

    Returns Promise<void>

destroy

  • destroy(): Promise<void>

  • A clean-up function that should get called whenever the item is disposed of.

    Returns Promise<void>

fetchAttachments

  • fetchAttachments(): Promise<void>

  • Retrieves attachments that are associated with this feature.

    Returns Promise<void>

fetchExpressionInfos

  • fetchExpressionInfos(watch?): Promise<IHandle>

  • Fetches or updates the cached values for all "expression infos" contained in the PopupTemplate.

    Parameters

    • watch: boolean = false

      If specified "expression infos" will be reevaluated when the feature's attributes change.

    Returns Promise<IHandle>

fetchRelatedFeatures

  • fetchRelatedFeatures(relationships?, options?): Promise<void>

  • Fetches features that are related to this feature. Features are available through Feature.relatedFeatures.

    Parameters

    • Optionalrelationships: string | Relationship | (string | Relationship)[]

      The relationships or relationship IDs to fetch related features for. If omitted, all related features will be fetched.

    • Optionaloptions: FetchRelatedFeaturesOptions

      Additional options that affect fetching related features.

    Returns Promise<void>

finishAssignProperties

format

  • format(format, ...args): string

  • Same as utilities/format/string!StringFormatter.format, except that the format string may also contain field format items, which have this syntax: {field-name[:format]}.

    These items will be substituted with the appropriate field value. Null and undefined values will be converted into empty strings.

    Parameters

    • format: string

      The format string to use.

    • Rest...args: unknown[]

    Returns string

  • format(options, ...args): string

  • Same as utilities/format/string!StringFormatter.format, except that the format string may also contain field format items, which have this syntax: {field-name[:format]}.

    These items will be substituted with the appropriate field value. Null and undefined values will be converted into empty strings.

    Parameters

    Returns string

getDefault

getDefaults

getSerializableProperties

initialize

  • initialize(): Promise<void>

  • Initializes the item.

    Returns Promise<void>

toGraphic

  • toGraphic(): Graphic

  • Converts the feature to an Esri Graphic object.

    Returns Graphic

toItemUri

  • toItemUri(): string

  • Creates an item:// URI reference to this entity.

    Returns string

toJSON

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods