Relationship | @types/arcgis-js-api

Hierarchy

Accessor
- Relationship

Index

Properties

Methods

Properties

cardinality

cardinality: "one-to-one" | "one-to-many" | "many-to-many"

The cardinality which specifies the number of objects in the origin FeatureLayer related to the number of objects in the destination FeatureLayer.

composite

composite: boolean

Indicates whether the relationship is composite.

declaredClass

declaredClass: string

destroyed

destroyed: boolean

id

id: number

The unique ID for the relationship.

initialized

initialized: boolean

keyField

keyField: string

The field used to establish the relate within the FeatureLayer.

keyFieldInRelationshipTable

keyFieldInRelationshipTable: string

The key field in an attributed relationship class table that matches the keyField.

name

name: string

The name of the relationship.

relatedTableId

relatedTableId: number

The unique ID of the related FeatureLayer.

relationshipTableId

relationshipTableId: number

The relationship table id.

role

role: "origin" | "destination"

Indicates whether the table participating in the relationship is the origin or destination table.

Methods

Protected _get

_get(propertyName: string): any
_get<T>(propertyName: string): T

Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:35
Parameters
- propertyName: string
Returns any
Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:36
Type parameters
- T
Parameters
- propertyName: string
Returns T

Protected _set

_set<T>(propertyName: string, value: T): Relationship

Inherited from Accessor._set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns Relationship

destroy

destroy(): void

Inherited from Accessor.destroy
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:26
Returns void

get

get<T>(propertyName: string): T
get(propertyName: string): any

Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:28
Type parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:29
Parameters
- propertyName: string
Returns any

Protected notifyChange

notifyChange(propertyName: string): void

Inherited from Accessor.notifyChange
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:34
Parameters
- propertyName: string
Returns void

set

set<T>(propertyName: string, value: T): Relationship
set(props: HashMap<any>): Relationship

Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:30
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns Relationship
Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:31
Parameters
- props: HashMap<any>
Returns Relationship

watch

watch(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle

Inherited from Accessor.watch
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:32
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle

Hierarchy

Index

Properties

Methods

Properties

cardinality

composite

declaredClass

destroyed

id

initialized

keyField

keyFieldInRelationshipTable

name

relatedTableId

relationshipTableId

role

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type parameters

T

Parameters

propertyName: string

value: T

Returns Relationship

destroy

Returns void

get

Type parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

Protected notifyChange

Parameters

propertyName: string

Returns void

set

Type parameters

T

Parameters

propertyName: string

value: T

Returns Relationship

Parameters

props: HashMap<any>

Returns Relationship

watch

Parameters

path: string | string[]

callback: WatchCallback

Optional sync: boolean

Returns WatchHandle