FeatureLayerDataSource

Interface

FeatureLayerDataSource is created from a single feature layer of feature service, map service or webmap/webscene.

The source of feature layer data source may be from -

  1. an array directly ( sourceRecords ), isDataInDataSourceInstance is true for such data sources, or,
  2. an ArcGIS Maps SDK for JavaScript feature layer, or,
  3. an AGOL/portal item or a remote database.

Please note, for the 2, the feature layer can be both client-side or server-side.

Inheritance: FeatureLayerDataSourceQueriableDataSourceJSAPILayerMixinItemMixin

Properties

Hide inherited properties
PropertyTypeNotes
addSourceVersion
 inherited 
() => void
addVersion
 inherited 
() => void
() => boolean
belongToDataSource
 inherited 

The data source which this data source derives from.

(gdbVersionstring) => void
() => Promise<DataSource[]>
clearRecords
 inherited 
() => void
clearSourceRecords
 inherited 
() => void
count
 inherited 
number

The total records count depends on the current query

(dataSourceIdstring) => Promise<DataSource>
dataSourceManager
 inherited 

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

dataViewId
 inherited 
string

The data view ID configured in Json.

destroy
 inherited 
() => void
() => DataSource[]
() => DataSource[]
() => number
getChildDataSource
 inherited 
(jimuChildIdstring) => DataSource
getChildDataSources
 inherited 
() => DataSource[]
getCountStatus
 inherited 
getDataSourceJson
 inherited 
() => IMDataSourceJson
() => string
getInfo
 inherited 
() => IMDataSourceInfo
getLabel
 inherited 
() => string
getListenSelection
 inherited 
() => boolean
getLocalDataSource
 inherited 
(localIdstring) => DataSource
getLocalDataSources
 inherited 
() => DataSource[]
getMaxRecordCount
 inherited 
() => number
getRealQueryPages
 inherited 
(pageSizenumber, pagenumber) => number[]
getRecord
 inherited 
(indexnumber) => DataRecord
getRecordById
 inherited 
(idstring) => DataRecord
getRecords
 inherited 
() => DataRecord[]
getRecordsByPage
 inherited 
(pagenumber, pageSizenumber) => DataRecord[]
(pagenumber, pageSizenumber) => DataRecord[]
() => DataRecord[]
getRootDataSource
 inherited 
(excludeWidgetId?string) => QueryParams
getSchema
 inherited 
() => string[]
() => number[]
getSelectedRecords
 inherited 
() => DataRecord[]
() => DataRecord[]
getSourceVersion
 inherited 
() => number
getStatus
 inherited 
getVersion
 inherited 
() => number
id
 inherited 
string

The data source ID.

isDataSourceSet
 inherited 
boolean

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 .

isDataView
 inherited 
boolean

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.

isInAppConfig
 inherited 
() => boolean
isLocal
 inherited 
boolean

True means the data source is a local data source.

isSqlCaseSensitive
 inherited 
boolean

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

FeatureLayer

The ArcGIS Maps SDK for JavaScript FeatureLayer object.

loadById
 inherited 
(idstring, refresh?boolean) => Promise<DataRecord>
localId
 inherited 
string

The local ID of the data source.

order
 inherited 
number

Order in the parent data source.

parentDataSource
 inherited 

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

ready
 inherited 
() => Promise<any>
IFeatureLayer

The Feature Layer JSON object.

setCountStatus
 inherited 
(statusDataSourceStatus) => void
setDataSourceJson
 inherited 
(dsJsonIMDataSourceJson) => void
setListenSelection
 inherited 
(listenboolean) => void
setRecords
 inherited 
(recordsDataRecord[]) => void
(recordsDataRecord[]) => void
setStatus
 inherited 
(statusDataSourceStatus) => void
updateQueryParams
 inherited 
(queryQueryParams, widgetIdstring) => void
updateSelectionInfo
 inherited 
(idsstring[], triggerDataSourceDataSource, forceCheck?boolean) => void
(featuresGraphic | GraphicProperties[], fieldsField | FieldProperties[], objectIdFieldstring, others?Omit<FeatureLayerProperties"source" | "fields" | "objectIdField">) => Promise<void>

addSourceVersion

inherited
Interface Property
addSourceVersion: () => void
Type declaration
    function(): void

    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.

    Returns 
    void

addVersion

optionalinherited
Interface Property
addVersion: () => void
Type declaration
    function(): void

    Update data source version.

    Returns 
    void

areChildDataSourcesCreated

optionalinherited
Interface Property
areChildDataSourcesCreated: () => boolean
Type declaration
    function(): boolean

    Return whether all child data sources (including descendant data sources) are created. Data source has this method only if it is data source set ( dataSource.isDataSourceSet is true).

    Returns 
    boolean

belongToDataSource

optionalinherited
Interface Property
belongToDataSource: DataSource

The data source which this data source derives from.

changeGDBVersion

Interface Property
changeGDBVersion: (gdbVersionstring) => void
Type declaration
    function(gdbVersionstring): void

    Change the layer GDB version.

    Parameters
    ParameterType
    gdbVersion
    string
    Returns 
    void

childDataSourcesReady

optionalinherited
Interface Property
childDataSourcesReady: () => Promise<DataSource[]>
Type declaration
    function(): Promise<DataSource[]>

    All child data sources (including descendant data sources) are ready for use. Data source has this method only if it is data source set ( dataSource.isDataSourceSet is true).

    Returns 
    Promise<DataSource[]>

clearRecords

optionalinherited
Interface Property
clearRecords: () => void
Type declaration
    function(): 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.

    Returns 
    void

clearSourceRecords

inherited
Interface Property
clearSourceRecords: () => void
Type declaration
    function(): void

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

    Returns 
    void

count

optionalinherited
Interface Property
count: number

The total records count depends on the current query

createDataSourceById

optionalinherited
Interface Property
createDataSourceById: (dataSourceIdstring) => Promise<DataSource>
Type declaration
    function(dataSourceIdstring): Promise<DataSource>

    Create a child or a descendant data source by id. Data source has this method only if it is data source set ( dataSource.isDataSourceSet is true).

    Please note will only create the specific data source, won't create descendant data sources of it.

    Parameters
    ParameterType
    dataSourceId
    string
    Returns 
    Promise<DataSource>

dataSourceManager

inherited
Interface Property
dataSourceManager: DataSourceManager

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

dataViewId

optionalinherited
Interface Property
dataViewId: string

The data view ID configured in Json.

destroy

inherited
Interface Property
destroy: () => void
Type declaration
    function(): void

    Destroy the data source.

    Returns 
    void

getAllChildDataSources

optionalinherited
Interface Property
getAllChildDataSources: () => DataSource[]
Type declaration
    function(): DataSource[]

    Return all child data sources of a parent data source, includes the grandchildren

    Returns 
    DataSource[]

getAllDerivedDataSources

inherited
Interface Property
getAllDerivedDataSources: () => DataSource[]
Type declaration

getAutoRefreshInterval

inherited
Interface Property
getAutoRefreshInterval: () => number
Type declaration
    function(): number

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

    Returns 
    number

getChildDataSource

optionalinherited
Interface Property
getChildDataSource: (jimuChildIdstring) => DataSource
Type declaration
    function(jimuChildIdstring): DataSource

    Get child data source by jimuChildId . You can get jimuChildId by getJimuChildId() .

    Parameters
    ParameterType
    jimuChildId
    string
    Returns 
    DataSource

getChildDataSources

optionalinherited
Interface Property
getChildDataSources: () => DataSource[]
Type declaration

getCountStatus

inherited
Interface Property
getCountStatus: () => DataSourceStatus
Type declaration

getDataSourceJson

inherited
Interface Property
getDataSourceJson: () => IMDataSourceJson
Type declaration
    function(): IMDataSourceJson

    The data source JSON object in app config.

    Returns 
    IMDataSourceJson

getGDBVersion

Interface Property
getGDBVersion: () => string
Type declaration
    function(): string

    Return the current GDB version.

    Returns 
    string

getInfo

inherited
Interface Property
getInfo: () => IMDataSourceInfo
Type declaration
    function(): IMDataSourceInfo

    Return the data source info in redux store.

    Returns 
    IMDataSourceInfo

getLabel

inherited
Interface Property
getLabel: () => string
Type declaration
    function(): string

    Return data source label.

    Returns 
    string

getListenSelection

inherited
Interface Property
getListenSelection: () => boolean
Type declaration
    function(): boolean

    Return whether listen selection.

    Returns 
    boolean

getLocalDataSource

inherited
Interface Property
getLocalDataSource: (localIdstring) => DataSource
Type declaration
    function(localIdstring): DataSource

    Get local data source by local ID.

    Parameters
    ParameterType
    localId
    string
    Returns 
    DataSource

getLocalDataSources

inherited
Interface Property
getLocalDataSources: () => DataSource[]
Type declaration
    function(): DataSource[]

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

    Returns 
    DataSource[]

getMaxRecordCount

inherited
Interface Property
getMaxRecordCount: () => number
Type declaration
    function(): number

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

    Returns 
    number

getRealQueryPages

inherited
Interface Property
getRealQueryPages: (pageSizenumber, pagenumber) => number[]
Type declaration
    function(pageSizenumber, pagenumber): number[]

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

    Parameters
    ParameterType
    pageSize
    number
    page
    number
    Returns 
    number[]

getRecord

inherited
Interface Property
getRecord: (indexnumber) => DataRecord
Type declaration
    function(indexnumber): DataRecord

    Get record by index

    Parameters
    ParameterType
    index
    number
    Returns 
    DataRecord

getRecordById

inherited
Interface Property
getRecordById: (idstring) => DataRecord
Type declaration

getRecords

inherited
Interface Property
getRecords: () => DataRecord[]
Type declaration

getRecordsByPage

inherited
Interface Property
getRecordsByPage: (pagenumber, pageSizenumber) => DataRecord[]
Type declaration
    function(pagenumber, pageSizenumber): 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.

    Parameters
    ParameterType
    page
    number
    pageSize
    number
    Returns 
    DataRecord[]

getRecordsByPageWithSelection

inherited
Interface Property
getRecordsByPageWithSelection: (pagenumber, pageSizenumber) => DataRecord[]
Type declaration
    function(pagenumber, pageSizenumber): 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.

    Parameters
    ParameterType
    page
    number
    pageSize
    number
    Returns 
    DataRecord[]

getRecordsWithSelection

inherited
Interface Property
getRecordsWithSelection: () => DataRecord[]
Type declaration
    function(): 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.

    Returns 
    DataRecord[]

getRemoteQueryParams

inherited
Interface Property
getRemoteQueryParams: () => QueryParams
Type declaration

getRootDataSource

inherited
Interface Property
getRootDataSource: () => DataSource
Type declaration

getRuntimeQueryParams

inherited
Interface Property
getRuntimeQueryParams: (excludeWidgetId?string) => QueryParams
Type declaration
    function(excludeWidgetId?string): QueryParams

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

    Parameters
    ParameterType
    excludeWidgetId
    string
    Returns 
    QueryParams

getSchema

inherited
Interface Property
getSchema: () => IMDataSourceSchema
Type declaration
    function(): IMDataSourceSchema

    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.

    Returns 
    IMDataSourceSchema

getSelectedRecordIds

inherited
Interface Property
getSelectedRecordIds: () => string[]
Type declaration
    function(): string[]

    Get selected record IDs

    Returns 
    string[]

getSelectedRecordIndexes

inherited
Interface Property
getSelectedRecordIndexes: () => number[]
Type declaration
    function(): number[]

    Get selected record indexes

    Returns 
    number[]

getSelectedRecords

inherited
Interface Property
getSelectedRecords: () => DataRecord[]
Type declaration

getSourceRecords

Interface Property
getSourceRecords: () => DataRecord[]
Type declaration

getSourceVersion

inherited
Interface Property
getSourceVersion: () => number
Type declaration
    function(): number

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

    Returns 
    number

getStatus

inherited
Interface Property
getStatus: () => DataSourceStatus
Type declaration

getVersion

inherited
Interface Property
getVersion: () => number
Type declaration
    function(): number

    Return data source version.

    Returns 
    number

id

inherited
Interface Property
id: string

The data source ID.

Inherited from QueriableDataSource.id

isDataSourceSet

inherited
Interface Property
isDataSourceSet: boolean

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 .

isDataView

inherited
Interface Property
isDataView: boolean

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.

isInAppConfig

inherited
Interface Property
isInAppConfig: () => boolean
Type declaration
    function(): boolean

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

    Returns 
    boolean

isLocal

inherited
Interface Property
isLocal: boolean

True means the data source is a local data source.

isSqlCaseSensitive

inherited
Interface Property
isSqlCaseSensitive: boolean

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

layer

optional
Interface Property
layer: FeatureLayer

The ArcGIS Maps SDK for JavaScript FeatureLayer object.

loadById

inherited
Interface Property
loadById: (idstring, refresh?boolean) => Promise<DataRecord>
Type declaration
    function(idstring, refresh?boolean): Promise<DataRecord>

    Load record by ID, do not consider other queries.

    Parameters
    ParameterType
    id
    string
    refresh
    boolean
    Returns 
    Promise<DataRecord>

localId

optionalinherited
Interface Property
localId: string

The local ID of the data source.

order

optionalinherited
Interface Property
order: number

Order in the parent data source.

parentDataSource

inherited
Interface Property
parentDataSource: DataSource

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

ready

inherited
Interface Property
ready: () => Promise<any>
Type declaration
    function(): Promise<any>

    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 .

    Returns 
    Promise<any>

restLayer

optional
Interface Property
restLayer: IFeatureLayer

The Feature Layer JSON object.

setCountStatus

optionalinherited
Interface Property
setCountStatus: (statusDataSourceStatus) => void
Type declaration

setDataSourceJson

inherited
Interface Property
setDataSourceJson: (dsJsonIMDataSourceJson) => void
Type declaration
    function(dsJsonIMDataSourceJson): void

    Update data source JSON in data source instance

    Parameters
    ParameterType
    dsJson
    IMDataSourceJson
    Returns 
    void

setListenSelection

inherited
Interface Property
setListenSelection: (listenboolean) => void
Type declaration
    function(listenboolean): 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.

    Parameters
    ParameterType
    listen
    boolean
    Returns 
    void

setRecords

inherited
Interface Property
setRecords: (recordsDataRecord[]) => void
Type declaration
    function(recordsDataRecord[]): void

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

    Parameters
    ParameterType
    records
    DataRecord[]
    Returns 
    void

setSourceRecords

Interface Property
setSourceRecords: (recordsDataRecord[]) => void
Type declaration
    function(recordsDataRecord[]): 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 mthods only when isDataInDataSourceInstance is true.

    Parameters
    ParameterType
    records
    DataRecord[]
    Returns 
    void

setStatus

optionalinherited
Interface Property
setStatus: (statusDataSourceStatus) => void
Type declaration

updateQueryParams

inherited
Interface Property
updateQueryParams: (queryQueryParams, widgetIdstring) => void
Type declaration
    function(queryQueryParams, widgetIdstring): void

    Update the data source query without executing the actual query.

    Parameters
    ParameterType
    query
    QueryParams
    widgetId
    string
    Returns 
    void

updateSelectionInfo

inherited
Interface Property
updateSelectionInfo: (idsstring[], triggerDataSourceDataSource, forceCheck?boolean) => void
Type declaration
    function(idsstring[], triggerDataSourceDataSource, forceCheck?boolean): void

    Update selected record IDs 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 curren 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.

    Parameters
    ParameterType
    ids
    string[]
    triggerDataSource
    DataSource
    forceCheck
    boolean
    Returns 
    void

updateSourceByFeatures

Interface Property
updateSourceByFeatures: (featuresGraphic | GraphicProperties[], fieldsField | FieldProperties[], objectIdFieldstring, others?Omit<FeatureLayerProperties"source" | "fields" | "objectIdField">) => Promise<void>
Type declaration
    function(featuresGraphic | GraphicProperties[], fieldsField | FieldProperties[], objectIdFieldstring, others?Omit<FeatureLayerProperties"source" | "fields" | "objectIdField">): Promise<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.

    Parameters
    ParameterType
    features
    Graphic | GraphicProperties[]
    fields
    Field | FieldProperties[]
    objectIdField
    string
    others
    Omit<FeatureLayerProperties"source" | "fields" | "objectIdField">
    Returns 
    Promise<void>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.