Class ArcGISRelationship<TProperties>

A data/_Relationship!Relationship that works by querying the queryRelatedRecords endpoint of a FeatureLayer, Table, or ArcGIS Sublayer.

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

_handles _id _itemType _source @eventTypes cardinality destinationForeignKey keyField originForeignKey queryService relatedKeyField relatedSource relationshipTableId relationshipType title

Accessors

failureMode id isAttributed isDestroyed isInitialized itemType source

Methods

_getAllRelatedFeatures _getRelatedFeatures _getSerializableProperties _initializableChildCollections _initializeChildren _onDestroy _onInitialize _postInitialize _toPropertyDef assignProperties assignPropertiesAsync destroy finishAssignProperties getAllRelatedFeatures getDefault getDefaults getRelatedFeatures getSerializableProperties initialize 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.RELATIONSHIP

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

Protected_source

_source: FeatureSource

Inherit Doc

@eventTypes

@eventTypes: InitializableBaseEvents

Deprecated

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

Readonlycardinality

cardinality: Cardinality

The cardinality of the relationship.

ReadonlydestinationForeignKey

destinationForeignKey: string

In attributed relationships, this is the foreign key in the intermediate table that relates the rows of the intermediate table to the destination layer or table. This property will only be exposed if the relationship is attributed.

ReadonlykeyField

keyField: string

The key field in the source.

ReadonlyoriginForeignKey

originForeignKey: string

In an attributed relationship, originForeignKey is the foreign key in the intermediate table, which relates the rows of the intermediate table to the origin layer or table. This property will only be exposed if the relationship is attributed.

queryService

queryService: QueryService

The tasks/query/QueryService!QueryService to use for fetching related features. The service must be configured with a provider that can handle the related source.

ReadonlyrelatedKeyField

relatedKeyField: string

The key field in the related source. Needed for two-sided relationships but isn't needed for one-sided ones.

ReadonlyrelatedSource

relatedSource: FeatureSource

The feature source with related data, if available.

ReadonlyrelationshipTableId

relationshipTableId: number

The ID of the intermediate table in the feature service for attributed relationships. This property will only be exposed if the relationship is attributed.

ReadonlyrelationshipType

relationshipType: string = "ArcGISRelationship"

The type of relationship.

title

title: string

The human-readable name for the relationship.

Accessors

failureMode

id

  • get id(): string

  • The unique ID for this entity.

    Returns string

isAttributed

  • get isAttributed(): boolean

  • Whether the relationship is attributed.

    Returns boolean

isDestroyed

isInitialized

itemType

  • get itemType(): string

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

    Returns string

source

  • get source(): FeatureSource

  • The feature source that owns this relationship.

    Returns FeatureSource

Methods

Protected_getAllRelatedFeatures

Protected_getRelatedFeatures

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

assignProperties

  • assignProperties(properties): void

  • Sets the properties for this item.

    Parameters

    • properties: Partial<TProperties>

      A plain object containing property values to set, keyed by property name.

    Returns void

assignPropertiesAsync

  • assignPropertiesAsync(properties): Promise<void>

  • Sets the properties for this item.

    This version will also await any asynchronous logic that is needed to set the properties.

    Parameters

    • properties: Partial<TProperties>

      A plain object containing property values to set, keyed by property name.

    Returns Promise<void>

destroy

  • destroy(): Promise<void>

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

    Returns Promise<void>

finishAssignProperties

  • finishAssignProperties(): Promise<void>

  • Waits for all deserialization logic initiated thus far to finish, whether invoked by passing properties into the constructor, or by invoking assignProperties() or assignPropertiesAsync().

    Returns Promise<void>

getAllRelatedFeatures

getDefault

  • getDefault<K>(key): TProperties[K]

  • Gets the default value of an object's property.

    Type Parameters

    • K extends string | number | symbol

    Parameters

    • key: K

      The property of the object for which to get the default value.

    Returns TProperties[K]

getDefaults

getRelatedFeatures

getSerializableProperties

initialize

toItemUri

toJSON

  • toJSON(serializeMode?): TProperties

  • Returns a serializable representation of the item.

    Parameters

    • serializeMode: SerializeMode = "all"

      If specified, only properties that are appropriate for the given mode are returned. Otherwise, all properties will be serialized.

    Returns TProperties

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods