JoinTableDataSource | References | ArcGIS Maps SDK for JavaScript

import JoinTableDataSource from "@arcgis/core/rest/layerSources/JoinTableDataSource.js";

Inheritance:: JoinTableDataSource→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

The result of an on-the-fly join operation at runtime. Nested joins are supported. To use nested joins, set either leftTableSource or rightTableSource to join-table.

See also

Example

let layer = new MapImageLayer({
  url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer",
  sublayers: [{
    id: 0,
    renderer: renderer,
    opacity: 0.9,
    source: {
      type: "data-layer",
      dataSource: {
        type: "join-table",
        leftTableSource: {
          type: "map-layer",
          mapLayerId: 3
        },
        rightTableSource: {
          type: "data-layer",
          dataSource: {
            type: "table",
            workspaceId: "CensusFileGDBWorkspaceID",
            dataSourceName: "ancestry"
          }
        },
        leftTableKey: "STATE_NAME",
        rightTableKey: "State",
        joinType: "left-outer-join"
      }
    }
  }]
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`JoinTableDataSourceProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`joinType`	`JoinType`
`leftTableKey`	`string`
`leftTableSource`	`DynamicMapLayer \| DynamicDataLayer`
`rightTableKey`	`string`
`rightTableSource`	`DynamicMapLayer \| DynamicDataLayer`
`type` readonly	`"join-table"`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

joinType

Property

Type: JoinType

The type of join that will be performed.

Possible Value	Description
left-outer-join	Unmatched records in the left table source are preserved and joined with `null` values in the right table source.
left-inner-join	Records in the left table source are discarded if they are unmatched with records in the right table source.

leftTableKey

Property

Type: string

The field name used for joining or matching records in the left table to records in the right table.

leftTableSource

Property

Type: DynamicMapLayer | DynamicDataLayer

The left table for joining to the right table source. This can either be a dynamic map layer or a dynamic data layer. The dynamic data layer may contain another join data source used for nested joining.

rightTableKey

Property

Type: string

The field name used for joining or matching records in the right table to records in the left table.

rightTableSource

Property

Type: DynamicMapLayer | DynamicDataLayer

The right table for joining to the left table source. This can either be a dynamic map layer or a dynamic data layer. The dynamic data layer may contain another join data source used for nested joining.

type

readonly Property

Type: "join-table"

This value is always join-table and is inferred when other join table properties of this object are set.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.

Type definitions

JoinType

Type definition

Type: "left-inner-join" | "left-outer-join"