FeatureLayerDataSource

When current data source is created from an array of records, it will be saved in sourceRecords . Add the version of sourceRecords .setSourceRecords will add the version by default.

Type declaration

function(): void

Returns 

void

Update data source version.

Type declaration

function(): void

Returns 

void

The data source which this data source derives from.

Builds a data record only -- does not add the record into data source.

Type declaration

function(feature: IFeature | Graphic): FeatureDataRecord

Parameters

Parameter	Type
feature	IFeature | Graphic

Returns 

FeatureDataRecord

Change the layer GDB version.

Type declaration

function(gdbVersion: string): void

Parameters

Parameter	Type
gdbVersion	string

Returns 

void

This function will clear the loaded records and won't clear the sourceRecords. Once the loaded records are cleared, the version in the data source info will be updated.

Type declaration

function(): void

Returns 

void

Clear both sourceRecords and loaded records. Both source version and version in data source info will be updated.

Type declaration

function(): void

Returns 

void

The total records count depends on the current query

Default dataSource is the current data source. Default useDataSourceQueryParams is true, that is to say apply the data source's query params to the created ArcGIS Maps SDK for JavaScript layer by default. Default throwError is false, that is to say the method won't throw error and will return undefined if the creation fail.

Type declaration

function(dataSource?: DataSource, useDataSourceQueryParams?: boolean, throwError?: boolean): Promise<Layer | ArcGISSubLayer>

Parameters

Parameter	Type
dataSource	DataSource
useDataSourceQueryParams	boolean
throwError	boolean

Returns 

Promise<Layer | ArcGISSubLayer>

The data source manager, which is used to manage the data source, including create/get/destroy the data source instance.

The data view ID configured in JSON.

Destroy the data source.

Type declaration

function(): void

Returns 

void

Fetch the data schema from an actual data source. If it's a statistic data source, the schema will not be fetched.

Type declaration

function(): Promise<IMDataSourceSchema>

Returns 

Promise<IMDataSourceSchema>

Return the derived data views and local data sources.

Type declaration

function(): DataSource[]

Returns 

DataSource[]

Get records of all the loaded pages.

Type declaration

function(): DataRecord[]

Returns 

DataRecord[]

If the return value > 0, auto refresh is enabled.

Type declaration

function(): number

Returns 

number

Get the user config query parameters.

Type declaration

function(): ArcGISQueryParams

Returns 

ArcGISQueryParams

Return data source count status.

Type declaration

function(): DataSourceStatus

Returns 

DataSourceStatus

Get the current loaded record id, which is used in loadById method.

Type declaration

function(): string

Returns 

string

Get the current query parameters. The current query parameters contain all applied queries.

Type declaration

function(options?: GetCurrentQueryParamsOptions): ArcGISQueryParams

Parameters

Parameter	Type
options	GetCurrentQueryParamsOptions

Returns 

ArcGISQueryParams

The data source JSON object in app config.

Type declaration

function(): IMDataSourceJson

Returns 

IMDataSourceJson

Return the config of the current data source.

Type declaration

function(): IMDataViewJson

Returns 

IMDataViewJson

Override parent interface to get correct type.

Type declaration

function(): ArcGISQueriableDataSource[]

Returns 

ArcGISQueriableDataSource[]

Return the current GDB version.

Type declaration

function(): string

Returns 

string

Return the data source ID field.

Type declaration

function(): string

Returns 

string

Return the data source info in redux store.

Type declaration

function(): IMDataSourceInfo

Returns 

IMDataSourceInfo

Return data source label.

Type declaration

function(): string

Returns 

string

Return whether listen selection.

Type declaration

function(): boolean

Returns 

boolean

Get local data source by local ID.

Type declaration

function(localId: string): DataSource

Parameters

Parameter	Type
localId	string

Returns 

DataSource

Return all local data sources created from a main data source or data view.

Type declaration

function(): DataSource[]

Returns 

DataSource[]

Null means there is no record count limit, and will return all records from the service.

Type declaration

function(): number

Returns 

number

Get real query page depends on the widget's request page.

Type declaration

function(pageSize: number, page: number): number[]

Parameters

Parameter	Type
pageSize	number
page	number

Returns 

number[]

When do query/load, we do not fire the query request directly. Instead, we'll consider the data source's config/current query parameter.

• For load: we'll merge the configured query parameter if it has, and all widget applied queries.
• For query, we'll merge the current query parameter and the configured query parameter it has.

Type declaration

function(query: any, flag: "query" | "load", options?: QueryOptions): ArcGISQueryParams

Parameters

Parameter	Type
query	any
flag	"query" | "load"
options	QueryOptions

Returns 

ArcGISQueryParams

Get record by index

Type declaration

function(index: number): DataRecord

Parameters

Parameter	Type
index	number

Returns 

DataRecord

Get record by ID

Type declaration

function(id: string): DataRecord

Parameters

Parameter	Type
id	string

Returns 

DataRecord

Get records of the loaded continuous pages. If the loaded pages are 1, 2, and 10, will only return records on the page 1 and 2.

Widgets can use different page sizes to query the data source, but the data source has a specific page size to query the service. The data source will save the loaded records by its own page size and split them when widgets doing queries (with different page and page sizes). The method returns continuous page records to make sure the order of the records is correct.

Type declaration

function(): DataRecord[]

Returns 

DataRecord[]

The page size here defines the records this method returns, which are not the actual query pageSize. Will use a fixed pageSize to query and cache data.

Type declaration

function(page: number, pageSize: number): DataRecord[]

Parameters

Parameter	Type
page	number
pageSize	number

Returns 

DataRecord[]

If selected records are not loaded in the current data source, will concat them to the end of records array. See getRecordsWithSelection for details.

Type declaration

function(page: number, pageSize: number): DataRecord[]

Parameters

Parameter	Type
page	number
pageSize	number

Returns 

DataRecord[]

If selected records are not loaded in the current data source, they will be concatenated to the end of records array. For example, record 1 is selected in data view 1 and it is not loaded in data view 2 (record 1 actually matches query params of data view 2), dataView2.getRecordsWithSelection() will return all loaded records in data view 2 and record 1.

Type declaration

function(): DataRecord[]

Returns 

DataRecord[]

Get the query parameters configured in remote (not in exb).

Type declaration

function(): QueryParams

Returns 

QueryParams

Return the root data source.

Type declaration

function(): DataSource

Returns 

DataSource

Get the queries applied in runtime. If the excludeWidgetId is passed in, the queries of this widget will be excluded.

Type declaration

function(excludeWidgetId?: string): QueryParams

Parameters

Parameter	Type
excludeWidgetId	string

Returns 

QueryParams

The schema returned here is the merged result of the configured schema and the fetched schema. The configured schema is the user's changes, such as a new data source name. The fetched schema is the original schema from AGOL/portal item or a remote database, such as the service name, the fields and the filters.

Type declaration

function(): IMDataSourceSchema

Returns 

IMDataSourceSchema

Get selected record IDs

Type declaration

function(): string[]

Returns 

string[]

Get selected record indexes

Type declaration

function(): number[]

Returns 

number[]

Get selected records

Type declaration

function(): DataRecord[]

Returns 

DataRecord[]

Get selection data view

Type declaration

function(): DataSource

Returns 

DataSource

Return the source records

Type declaration

function(): DataRecord[]

Returns 

DataRecord[]

When current data source is created from an array of records, it will be saved in sourceRecords . Return the version of sourceRecords .

Type declaration

function(): number

Returns 

number

Return data source status.

Type declaration

function(): DataSourceStatus

Returns 

DataSourceStatus

Return data source version.

Type declaration

function(): number

Returns 

number

The data source ID.

Whether a data source contains child data sources. A set data source won't create all its child data sources when ready is resolved. To make sure all child data sources are created, please use childDataSourcesReady .

Type declaration

function(): thisisDataSource & SetDataSourceMixin

Returns 

thisisDataSource & SetDataSourceMixin

True means the data source is a data view. For local data source, this is false even the local data source is created from a data view.

Return whether the data source is added in builder and is saved in app config.

Type declaration

function(): boolean

Returns 

boolean

True means the data source is a local data source.

Whether the data source is case-sensitive when doing query by SQL clauses.

The ArcGIS Maps SDK for JavaScript FeatureLayer object.

Execute the query against the service and update the internal data records, pagination is supported. When call this method, the real query is returned by getRealQueryParams .

Pagination: The pagination properties in the passed in query parameter may be not the same as the real query pagination that is sent to the service. The real query pagination is defined in the data source setting.

Type declaration

function(query: ArcGISQueryParams, options?: QueryOptions): Promise<DataRecord[]>

Parameters

Parameter	Type
query	ArcGISQueryParams
options	QueryOptions

Returns 

Promise<DataRecord[]>

Load record by ID, do not consider other queries.

Type declaration

function(id: string, refresh?: boolean): Promise<DataRecord>

Parameters

Parameter	Type
id	string
refresh	boolean

Returns 

Promise<DataRecord>

Load the records count.

Type declaration

function(query: ArcGISQueryParams, options?: QueryOptions): Promise<number>

Parameters

Parameter	Type
query	ArcGISQueryParams
options	QueryOptions

Returns 

Promise<number>

The local ID of the data source.

Merge queries by using AND , and return the merged result. If any query is undefined/null, it will be ignored.

Type declaration

function(queries: ArcGISQueryParams[]): ArcGISQueryParams

Parameters

Parameter	Type
queries	ArcGISQueryParams[]

Returns 

ArcGISQueryParams

Order in the parent data source.

The parent data source of this data source, mull means it's a root data source.

Execute query against the service only, do NOT update the internal data records. The actual query parameters are generated by getRealQueryParams .

To query count, please use queryCount .

Type declaration

function(query: ArcGISQueryParams, options?: QueryOptions): Promise<QueryResult>

Parameters

Parameter	Type
query	ArcGISQueryParams
options	QueryOptions

Returns 

Promise<QueryResult>

Query all records, there is no limit to the number of the records returned in the records array response. You can abort the progress by a abort signal and can use progressCallback to get the progress and the current results.

Type declaration

function(query: QueryParams, signal?: AbortSignal, progressCallback?: QueryProgressCallback, options?: QueryOptions): Promise<QueryResult>

Parameters

Parameter	Type
query	QueryParams
signal	AbortSignal
progressCallback	QueryProgressCallback
options	QueryOptions

Returns 

Promise<QueryResult>

Query record by ID. Will return all fields if not pass in the fields .

Type declaration

function(id: string, fields?: string[]): Promise<DataRecord>

Parameters

Parameter	Type
id	string
fields	string[]

Returns 

Promise<DataRecord>

Query count

Type declaration

function(query: ArcGISQueryParams, options?: QueryOptions): Promise<QueryResult>

Parameters

Parameter	Type
query	ArcGISQueryParams
options	QueryOptions

Returns 

Promise<QueryResult>

Query record IDs, there is no limit to the number of the IDs returned in the ids array response.

Type declaration

function(query: ArcGISQueryParams, options?: QueryOptions): Promise<QueryResult>

Parameters

Parameter	Type
query	ArcGISQueryParams
options	QueryOptions

Returns 

Promise<QueryResult>

Ready is resolved means the data source instance is ready for use. Please note that can not make sure all child data sources are created if a set data source is ready. To make sure all child data sources are created, please use childDataSourcesReady .

Type declaration

function(): Promise<any>

Returns 

Promise<any>

The Feature Layer JSON object.

Select a record by ID. When select record by ID, we can pass in the record. So when the selected record is not loaded, we can add it in.

Type declaration

function(id: string, record?: FeatureDataRecord): void

Parameters

Parameter	Type	Notes
id	string	The ID to be selected. The selection will be cleared if the ID is null.
record	FeatureDataRecord

Returns 

void

Select records by IDs. When select records by IDs, we can pass in the records. So when the selected records are not loaded, we can add them in.

Type declaration

function(ids: string[], records?: FeatureDataRecord[]): void

Parameters

Parameter	Type	Notes
ids	string[]	The IDs to be selected. The selection will be cleared if the IDs are null.
records	FeatureDataRecord[]

Returns 

void

Update data source count status.

Type declaration

function(status: DataSourceStatus): void

Parameters

Parameter	Type
status	DataSourceStatus

Returns 

void

Update data source JSON in data source instance

Type declaration

function(dsJson: IMDataSourceJson): void

Parameters

Parameter	Type
dsJson	IMDataSourceJson

Returns 

void

Whether listen selected records from other data sources which are derived from the same main data source. If true, will update selected record IDs of current data source info when selecting records via other derived data sources. Will also update selected record IDs when selecting records via current data source itself. If false, won't change selected record IDs when selecting records via other derived data sources. Will update selected record IDs only when selecting records via current data source itself.

Main data source and its data views will listen selected records by default, local data source does not listen selected records by default.

Type declaration

function(listen: boolean): void

Parameters

Parameter	Type
listen	boolean

Returns 

void

Update the records in the data source object only, does not update the source data.

Type declaration

function(records: DataRecord[]): void

Parameters

Parameter	Type
records	DataRecord[]

Returns 

void

When current data source is created from an array of features (__esri.Graphic), will save it in an ArcGIS Maps SDK for JavaScript feature layer. This method is used to update the source data. Please note, use this method only when isDataInDataSourceInstance is not true.

Type declaration

function(features: Graphic | GraphicProperties[], others?: Omit<FeatureLayerProperties, "fields" | "source" | "objectIdField">): Promise<void>

Parameters

Parameter	Type
features	Graphic | GraphicProperties[]
others	Omit<FeatureLayerProperties, "fields" | "source" | "objectIdField">

Returns 

Promise<void>

When current data source is created from an array of records ( DataRecord ), will save it in sourceRecords . These two methods are used to update or get the source data. Please note, use these two methods only when isDataInDataSourceInstance is true.

Type declaration

function(records: DataRecord[]): void

Parameters

Parameter	Type
records	DataRecord[]

Returns 

void

Update data source status.

Type declaration

function(status: DataSourceStatus): void

Parameters

Parameter	Type
status	DataSourceStatus

Returns 

void

The type of the data source.

Update the data source query without executing the actual query.

Type declaration

function(query: QueryParams, widgetId: string): void

Parameters

Parameter	Type
query	QueryParams
widgetId	string

Returns 

void

Update selected records in data source info if the current data source listens selection change (see setListenSelection ) or the current data source is the trigger data source (that is to say, select via it).

Before update info, will check whether these selected records match filters of the current data source firstly, and then only set the matched selected records to info. Will skip the check in some cases to improve performance if the forceCheck is not passed in or is false. For example, if the current data source is main data source (we suppose that main data source contains all records, no need to check). But if the forceCheck is true, won't skip the check.

Type declaration

function(options: SelectOptions, triggerDataSource: DataSource, forceCheck?: boolean): void

Parameters

Parameter	Type
options	SelectOptions
triggerDataSource	DataSource
forceCheck	boolean

Returns 

void

The data source URL