Skip to main content

FederationDataSource Class

A federated data source that retrieves data from different data sources.

#Declaration

TypeScript
export class FederationDataSource extends DataSource

#Remarks

When you bind your dashboard to the Federation Data Source, you in fact bind it to many data sources that are united. You can combine any number of SQL Data Source queries, Excel Data Sources, and Object Data Sources, and set up a relation condition between them.

#Inheritance

#constructor

Initializes a new instance of the FederationDataSource class.

#Declaration

TypeScript
constructor(
    dataSourceJSON?: any,
    serializer?: DevExpress.Analytics.Utils.ModelSerializer
)

#Parameters

Name Type Description
dataSourceJSON any

A JSON object used for dashboard deserialization. Do not pass this parameter directly.

serializer ModelSerializer

An object used for dashboard deserialization. Do not pass this parameter directly.

#Properties

#context Property

#Declaration

TypeScript
context: ko.ObservableArray<ContextItem>

#Property Value

Type
ObservableArray<ContextItem>

#queries Property

#Declaration

TypeScript
queries: ko.ObservableArray<QueryNode>

#Property Value

Type
ObservableArray<QueryNode>

#sources Property

#Declaration

TypeScript
sources: ko.ObservableArray<Source>

#Property Value

Type
ObservableArray<Source>

#Methods

#getDisplayNamePrefix Method

Gets the display name of the current data source.

#Declaration

TypeScript
getDisplayNamePrefix(): string

#Returns

Type Description
string

A string that is the display name of the current data source.

#getInfo Method

For internal use.

#Declaration

TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

#Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.