MapDataSource

Interface

Interface for map related data sources. It contains a JS API Map instance.

Inheritance: MapDataSourceDataSourceSetDataSourceMixin

Properties

PropertyTypeNotes
() => 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).

(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).

() => Promise<IMDataSourceSchema>

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

() => Promise<void>

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 .

The type of the data source.

childDataSourcesReady

Interface Property
childDataSourcesReady: () => 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).

Type declaration

createDataSourceById

Interface Property
createDataSourceById: (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.

Type declaration
    function(dataSourceIdstring): Promise<DataSource>
    Parameters
    ParameterType
    dataSourceId
    string
    Returns 
    Promise<DataSource>

fetchSchema

Interface Property
fetchSchema: () => Promise<IMDataSourceSchema>

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

Type declaration

ready

Interface Property
ready: () => Promise<void>

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<void>
    Returns 
    Promise<void>

type

Interface Property
type: DataSourceTypes

The type of the data source.

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close