Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/opsdashboard
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: DataSourceProxy
[ AMD Module Require | Legacy Module Require ]
require(["esri/opsdashboard/DataSourceProxy"], function(DataSourceProxy) { /* code goes here */ });
Description
(Added at v3.14)
(Currently in Mature Support) DataSourceProxy is a proxy class that represents a operations dashboard data source. Data source instances cannot be directly instantiated. To get a particular data source, extension mixins functions getDataSourceProxy or getDataSourceProxies should be used. The most commonly used function of data source is executeQuery.Samples
Search for samples that use this class.Properties
| Name | Type | Summary |
|---|---|---|
| displayFieldName | String | Read-only: The name of the display field. |
| fields | Field[] | Read-only: The collection of fields. |
| geometryType | String | Read-only: The geometry type. |
| id | String | Read-only: The id of the data source. |
| isBroken | Boolean | Read-only: Indicates if the last query failed and the data source is in a broken state. |
| mapWidgetId | String | Read-only: The mapWidgetId of the data source. |
| name | String | Read-only: The name of the data source. |
| objectIdFieldName | String | Read-only: The name of the object id field. |
| supportsSelection | Boolean | Read-only: Indicates if the data source supports selections. |
| typeIdFieldName | String | Read-only: The name of the type id field. |
| types | FeatureType[] | Read-only: The collection of feature types. |
Methods
| Name | Return type | Summary |
|---|---|---|
| clearSelection() | None | Clear the selection. |
| executeQuery(query) | Promise | Executes a query and get the result. |
| getAdvancedQueryCapabilities() | Promise | An object that contains service level metadata about whether or not the layer supports queries using statistics, order by fields, DISTINCT, pagination, query with distance, and returning queries with extents. |
| getAssociatedSelectionDataSourceId() | Promise | Retrieve the associated id of the data source that supports selection. |
| getPopupInfo() | Promise | Get the associated popupInfo for the data source if any available. See also, PopupTemplate. |
| getRenderer() | Promise | Get the associated render object for the data source if any available. |
| getTypeFromFeature(feature) | Object | Get the feature type from a feature coming from the data source. |
| getValueFromFeature(feature, fieldName) | Number | String | Returns the value corresponding to a field name from a feature coming from the data source. |
| selectFeatures(query) | None | Select features in the data source using a query. |
| selectFeaturesByObjectIds(objectIds) | None | Select features in the data source using a collection of object ids. |
Property Details
<String
StringRead-only: The name of the display field.
<Field[]
Field[]Read-only: The collection of fields.
<String
StringRead-only: The geometry type.
<String
StringRead-only: The id of the data source.
<Boolean
BooleanRead-only: Indicates if the last query failed and the data source is in a broken state.
Default value:
false<String
StringRead-only: The mapWidgetId of the data source. (Added at v3.15)
<String
StringRead-only: The name of the data source.
<String
StringRead-only: The name of the object id field.
<Boolean
BooleanRead-only: Indicates if the data source supports selections.
Default value:
false<String
StringRead-only: The name of the type id field.
<FeatureType[]
FeatureType[]Read-only: The collection of feature types.
Method Details
Clear the selection. Only applicable if the data source is a selection data source, see supportsSelection.
Executes a query and get the result.
Return type:
PromiseParameters:
< |
Required | The query object to apply. |
An object that contains service level metadata about whether or not the layer supports queries using statistics, order by fields, DISTINCT, pagination, query with distance, and returning queries with extents. (Added at v3.15)
Return type:
PromiseRetrieve the associated id of the data source that supports selection. Note: Not all data sources have an associated selection data source id, the result could be null.
Return type:
PromiseGet the associated popupInfo for the data source if any available.
See also, PopupTemplate.
Return type:
PromiseGet the associated render object for the data source if any available.
Return type:
PromiseGet the feature type from a feature coming from the data source.
Return type:
ObjectParameters:
< |
Required | A feature coming from the data source |
Returns the value corresponding to a field name from a feature coming from the data source. Getting the user friendly value can be a complicated series of steps including checking for feature types and/or coded domains.
Select features in the data source using a query. Only applicable if the data source is a selection data source, see supportsSelection.
Parameters:
< |
Required | The query object to apply |
Select features in the data source using a collection of object ids. Only applicable is the data source is a selection data source, see supportsSelection.
Parameters:
< |
Required | The collection of object ids of the features to select. |