A data source that provides data for the dashboard.
export abstract class DataSource extends TypedSerializableModel implements IDashboardComponentThe Web Dashboard does not allow you to create data sources on the client from scratch. You can use the existing data sources to supply dashboard items with data.
The following example shows how to get the existing data source from the opened dashboard and use it as a data source for dashboard items.
// Use the line below for a modular approach:
// import * as Model from 'devexpress-dashboard/model'
// Use the line below for an approach with global namespaces:
// var Model = DevExpress.Dashboard.Model;
// ...
public createDataSource() {
var dashboard = this.webDashboard.dashboard();
// Get the existing data sources.
var sqlDataSource = <Model.SqlDataSource>dashboard.dataSources()[0];
var excelDataSource = <Model.SqlDataSource>dashboard.dataSources()[1];
// Create data items for the Grid.
var gridCategoryName = new Model.Dimension();
gridCategoryName.dataMember("CategoryName");
var gridUnitPrice = new Model.Measure();
gridUnitPrice.dataMember("UnitPrice");
// Create the Grid dashboard item and bind it to data.
var gridItem = new Model.GridItem();
gridItem.dataSource(sqlDataSource.componentName());
gridItem.dataMember(sqlDataSource.queries()[0].name());
// Create data items for the Geo Point Map.
var geoPointMapImport = new Model.Measure();
geoPointMapImport.dataMember("Import");
var geoPointMapLatitude = new Model.Dimension();
geoPointMapLatitude.dataMember("Latitude");
var geoPointMapLongitude = new Model.Dimension();
geoPointMapLongitude.dataMember("Longitude");
// Create the Geo Point Map dashboard item and bind it to data.
var geoPointMapItem = new Model.GeoPointMapItem();
geoPointMapItem.dataSource(excelDataSource.componentName());
// ...
}
Initializes a new instance of the DataSource class.
constructor(dataSourceJSON?: any, serializer?: DevExpress.Analytics.Utils.ModelSerializer)| Name | Type | Default | Description |
|---|---|---|---|
| dataSourceJSON | any | null | A JSON object used for dashboard deserialization. Do not pass this parameter directly. |
| serializer | ModelSerializer | null | An object used for dashboard deserialization. Do not pass this parameter directly. |
Provides access to data source's calculated fields.
calculatedFields: ko.ObservableArray<CalculatedField>| Type | Description |
|---|---|
| ko.ObservableArray<CalculatedField> | An array of the CalculatedField objects that are calculated fields. |
See Web Dashboard - Creating Calculated Fields for information about calculated fields.
componentName: ko.Observable<string>| Type | Description |
|---|---|
| ko.Observable<string> |
filter: ko.Observable<string>| Type | Description |
|---|---|
| ko.Observable<string> |
hasCalculatedFields: boolean| Type | Description |
|---|---|
| boolean |
hasFilter: boolean| Type | Description |
|---|---|
| boolean |
name: ko.Observable<string>| Type | Description |
|---|---|
| ko.Observable<string> |
supportDataMembers: boolean| Type | Description |
|---|---|
| boolean |
Gets the display name of the current data source.
abstract getDisplayNamePrefix(): string| Type | Description |
|---|---|
| string | A string that is the display name of the current data source. |
For internal use.
abstract getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray| Type | Description |
|---|---|
| ISerializationInfoArray | An array of objects that provide serialization info. |
getJson(): any| Type | Description |
|---|---|
| any |
getUniqueNamePrefix(): string| Type | Description |
|---|---|
| string |