SceneLayerDataSource
Interface
SceneLayerDataSource is created from a single scene layer of scene service or webscene.
Properties
| Property | Type | Notes |
|---|---|---|
() => void | ||
() => void | ||
() => boolean | ||
The data source which this data source derives from. | ||
(gdbVersion: string) => void | ||
() => Promise<DataSource[]> | ||
() => void | ||
() => void | ||
number | The total records count depends on the current query | |
(dataSourceId: string) => Promise<DataSource> | ||
string | The data view ID configured in Json. | |
() => DataSource[] | ||
() => DataSource[] | ||
() => number | ||
(jimuChildId: string) => DataSource | ||
() => DataSource[] | ||
() => DataSourceStatus | ||
() => IMDataSourceJson | ||
() => string | ||
() => IMDataSourceInfo | ||
() => string | ||
() => boolean | ||
(localId: string) => DataSource | ||
() => DataSource[] | ||
() => number | ||
(pageSize: number, page: number) => number[] | ||
(index: number) => DataRecord | ||
(id: string) => DataRecord | ||
() => DataRecord[] | ||
(page: number, pageSize: number) => DataRecord[] | ||
(page: number, pageSize: number) => DataRecord[] | ||
() => DataRecord[] | ||
() => QueryParams | ||
() => DataSource | ||
(excludeWidgetId?: string) => QueryParams | ||
() => IMDataSourceSchema | ||
() => string[] | ||
() => number[] | ||
() => DataRecord[] | ||
() => DataRecord[] | ||
() => number | ||
() => DataSourceStatus | ||
() => number | ||
string | The data source ID. | |
boolean | Whether a data source contains child data sources.
A dataset data source should create all its child data sources before | |
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. | |
() => boolean | ||
boolean | True means the data source is a local data source. | |
boolean | Whether the data source is case-sensitive when doing query by SQL clauses. | |
(id: string, refresh?: boolean) => Promise<DataRecord> | ||
string | The local ID of the data source. | |
number | Order in the parent data source. | |
The parent data source of this data source, mull means it's a root data source. | ||
() => Promise<any> | ||
(status: DataSourceStatus) => void | ||
(dsJson: IMDataSourceJson) => void | ||
(listen: boolean) => void | ||
(records: DataRecord[]) => void | ||
(records: DataRecord[]) => void | ||
(status: DataSourceStatus) => void | ||
(query: QueryParams, widgetId: string) => void | ||
(ids: string[], triggerDataSource: DataSource, forceCheck?: boolean) => void |
addVersion
addVersion: () => voidType declaration
function(): voidUpdate data source version.
Returns
voidareChildDataSourcesCreated
areChildDataSourcesCreated: () => booleanType declaration
function(): booleanReturn 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
booleanbelongToDataSource
belongToDataSource: DataSourceThe data source which this data source derives from.
changeGDBVersion
Interface PropertychangeGDBVersion: (gdbVersion: string) => voidType declaration
function(gdbVersion: string): voidChange the layer GDB version.
Parameters
| Parameter | Type |
|---|---|
gdb | string |
Returns
voidchildDataSourcesReady
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
clearRecords: () => voidType declaration
function(): voidThis 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
voidclearSourceRecords
clearSourceRecords: () => voidType declaration
function(): voidClear both sourceRecords and loaded records. Both source version and version in data source info will be updated.
Returns
voidcount
count: numberThe total records count depends on the current query
createDataSourceById
createDataSourceById: (dataSourceId: string) => Promise<DataSource>Type declaration
function(dataSourceId: string): 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
| Parameter | Type |
|---|---|
data | string |
Returns
Promise<DataSource>getAllChildDataSources
getAllChildDataSources: () => DataSource[]Type declaration
function(): DataSource[]Return all child data sources of a parent data source, includes the grandchildren
Returns
DataSource[]getAllDerivedDataSources
getAllDerivedDataSources: () => DataSource[]Type declaration
function(): DataSource[]Return the derived data views and local data sources.
Returns
DataSource[]getAutoRefreshInterval
getAutoRefreshInterval: () => numberType declaration
function(): numberIf the return value > 0, auto refresh is enabled.
Returns
numbergetChildDataSource
getChildDataSource: (jimuChildId: string) => DataSourceType declaration
function(jimuChildId: string): DataSourceGet child data source by jimuChildId . You can get jimuChildId by getJimuChildId() .
Parameters
| Parameter | Type |
|---|---|
jimu | string |
Returns
DataSourcegetChildDataSources
getChildDataSources: () => DataSource[]Type declaration
function(): DataSource[]Return child data sources of a parent data source.
Returns
DataSource[]getCountStatus
getCountStatus: () => DataSourceStatusType declaration
function(): DataSourceStatusReturn data source count status.
Returns
DataSourceStatusgetDataSourceJson
getDataSourceJson: () => IMDataSourceJsonType declaration
function(): IMDataSourceJsonThe data source JSON object in app config.
Returns
IMDataSourceJsongetGDBVersion
Interface PropertygetGDBVersion: () => stringType declaration
function(): stringReturn the current GDB version.
Returns
stringgetInfo
getInfo: () => IMDataSourceInfoType declaration
function(): IMDataSourceInfoReturn the data source info in redux store.
Returns
IMDataSourceInfogetLabel
getLabel: () => stringType declaration
function(): stringReturn data source label.
Returns
stringgetListenSelection
getListenSelection: () => booleanType declaration
function(): booleanReturn whether listen selection.
Returns
booleangetLocalDataSource
getLocalDataSource: (localId: string) => DataSourceType declaration
function(localId: string): DataSourceGet local data source by local ID.
Parameters
| Parameter | Type |
|---|---|
local | string |
Returns
DataSourcegetLocalDataSources
getLocalDataSources: () => DataSource[]Type declaration
function(): DataSource[]Return all local data sources created from a main data source or data view.
Returns
DataSource[]getMaxRecordCount
getMaxRecordCount: () => numberType declaration
function(): numberNull means there is no record count limit, and will return all records from the service.
Returns
numbergetRealQueryPages
getRealQueryPages: (pageSize: number, page: number) => number[]Type declaration
function(pageSize: number, page: number): number[]Get real query page depends on the widget's request page.
Parameters
| Parameter | Type |
|---|---|
page | number |
page | number |
Returns
number[]getRecord
getRecord: (index: number) => DataRecordType declaration
function(index: number): DataRecordGet record by index
Parameters
| Parameter | Type |
|---|---|
index | number |
Returns
DataRecordgetRecordById
getRecordById: (id: string) => DataRecordType declaration
function(id: string): DataRecordGet record by ID
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
DataRecordgetRecords
getRecords: () => DataRecord[]Type declaration
function(): DataRecord[]Get records
Returns
DataRecord[]getRecordsByPage
getRecordsByPage: (page: number, pageSize: number) => DataRecord[]Type declaration
function(page: number, pageSize: number): 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
| Parameter | Type |
|---|---|
page | number |
page | number |
Returns
DataRecord[]getRecordsByPageWithSelection
getRecordsByPageWithSelection: (page: number, pageSize: number) => DataRecord[]Type declaration
function(page: number, pageSize: number): 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
| Parameter | Type |
|---|---|
page | number |
page | number |
Returns
DataRecord[]getRecordsWithSelection
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
getRemoteQueryParams: () => QueryParamsType declaration
function(): QueryParamsGet the query parameters configured in remote (not in exb).
Returns
QueryParamsgetRootDataSource
getRootDataSource: () => DataSourceType declaration
function(): DataSourceReturn the root data source.
Returns
DataSourcegetRuntimeQueryParams
getRuntimeQueryParams: (excludeWidgetId?: string) => QueryParamsType declaration
function(excludeWidgetId?: string): QueryParamsGet the queries applied in runtime. If the excludeWidgetId is passed in, the queries of this widget will be excluded.
Parameters
| Parameter | Type |
|---|---|
exclude | string |
Returns
QueryParamsgetSchema
getSchema: () => IMDataSourceSchemaType declaration
function(): IMDataSourceSchemaThe schema returned here is the merged result of the configured schema and the fetched schema.
Returns
IMDataSourceSchemagetSelectedRecordIds
getSelectedRecordIds: () => string[]Type declaration
function(): string[]Get selected record IDs
Returns
string[]getSelectedRecordIndexes
getSelectedRecordIndexes: () => number[]Type declaration
function(): number[]Get selected record indexes
Returns
number[]getSelectedRecords
getSelectedRecords: () => DataRecord[]Type declaration
function(): DataRecord[]Get selected records
Returns
DataRecord[]getSourceRecords
getSourceRecords: () => DataRecord[]Type declaration
function(): DataRecord[]Return the source records
Returns
DataRecord[]getSourceVersion
getSourceVersion: () => numberType declaration
function(): numberWhen current data source is created from an array of records, it will be saved in sourceRecords .
Return the version of sourceRecords .
Returns
numbergetStatus
getStatus: () => DataSourceStatusType declaration
function(): DataSourceStatusReturn data source status.
Returns
DataSourceStatusgetVersion
getVersion: () => numberType declaration
function(): numberReturn data source version.
Returns
numberisDataSourceSet
isDataSourceSet: booleanWhether a data source contains child data sources.
A dataset data source should create all its child data sources before ready() is resolved.
isDataView
isDataView: booleanTrue 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
isInAppConfig: () => booleanType declaration
function(): booleanReturn whether the data source is added in builder and is saved in app config.
Returns
booleanisLocal
isLocal: booleanTrue means the data source is a local data source.
isSqlCaseSensitive
isSqlCaseSensitive: booleanWhether the data source is case-sensitive when doing query by SQL clauses.
loadById
loadById: (id: string, refresh?: boolean) => Promise<DataRecord>Type declaration
function(id: string, refresh?: boolean): Promise<DataRecord>Load record by ID, do not consider other queries.
Parameters
| Parameter | Type |
|---|---|
id | string |
refresh | boolean |
Returns
Promise<DataRecord>parentDataSource
parentDataSource: DataSourceThe parent data source of this data source, mull means it's a root data source.
ready
ready: () => Promise<any>Type declaration
function(): Promise<any>Ready is resolved means the data source instance is ready for use.
Returns
Promise<any>setCountStatus
setCountStatus: (status: DataSourceStatus) => voidType declaration
function(status: DataSourceStatus): voidUpdate data source count status.
Parameters
| Parameter | Type |
|---|---|
status | DataSourceStatus |
Returns
voidsetDataSourceJson
setDataSourceJson: (dsJson: IMDataSourceJson) => voidType declaration
function(dsJson: IMDataSourceJson): voidUpdate data source JSON in data source instance
Parameters
| Parameter | Type |
|---|---|
d | IMDataSourceJson |
Returns
voidsetListenSelection
setListenSelection: (listen: boolean) => voidType declaration
function(listen: boolean): voidWhether 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
| Parameter | Type |
|---|---|
listen | boolean |
Returns
voidsetRecords
setRecords: (records: DataRecord[]) => voidType declaration
function(records: DataRecord[]): voidUpdate the records in the data source object only, does not update the source data.
Parameters
| Parameter | Type |
|---|---|
records | DataRecord[] |
Returns
voidsetSourceRecords
setSourceRecords: (records: DataRecord[]) => voidType declaration
function(records: DataRecord[]): voidWhen current data source is created from an array of records, will save it in sourceRecords .
These two methods are used to update or get the source data.
Parameters
| Parameter | Type |
|---|---|
records | DataRecord[] |
Returns
voidsetStatus
setStatus: (status: DataSourceStatus) => voidType declaration
function(status: DataSourceStatus): voidUpdate data source status.
Parameters
| Parameter | Type |
|---|---|
status | DataSourceStatus |
Returns
voidupdateQueryParams
updateQueryParams: (query: QueryParams, widgetId: string) => voidType declaration
function(query: QueryParams, widgetId: string): voidUpdate the data source query without executing the actual query.
Parameters
| Parameter | Type |
|---|---|
query | QueryParams |
widget | string |
Returns
voidupdateSelectionInfo
updateSelectionInfo: (ids: string[], triggerDataSource: DataSource, forceCheck?: boolean) => voidType declaration
function(ids: string[], triggerDataSource: DataSource, forceCheck?: boolean): voidUpdate 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
| Parameter | Type |
|---|---|
ids | string[] |
trigger | DataSource |
force | boolean |
Returns
void
addSourceVersion: () => voidType declaration
function(): voidWhen current data source is created from an array of records, it will be saved in
sourceRecords. Add the version ofsourceRecords.setSourceRecordswill add the version by default.Returns
void