Skip to main content
A newer version of this page is available. .

DataDashboardItem Class

Serves as the base class for data-bound dashboard items.

Declaration

export abstract class DataDashboardItem extends DashboardItem implements IDataItemProvider, IMasterFilterItemsProvider, IColorSignaturesProvider, IDataSourceConsumer

constructor

Initializes a new instance of the DataDashboardItem class.

Declaration

constructor(
    dashboardItemJSON?: any,
    serializer?: DxDesigner.Analytics.Utils.ModelSerializer,
    info?: DxDesigner.Analytics.Utils.ISerializationsInfo
)

Parameters

Name Type Description
dashboardItemJSON any

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

serializer DxDesigner.Analytics.Utils.ModelSerializer

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

info DxDesigner.Analytics.Utils.ISerializationsInfo

Properties

coloringOptions Property

Declaration

coloringOptions: DashboardItemColoringOptions

Property Value

Type
DashboardItemColoringOptions

colorScheme Property

Declaration

colorScheme: KnockoutObservableArray<ColorSchemeEntry>

Property Value

Type
KnockoutObservableArray<ColorSchemeEntry>

dataItems Property

Declaration

dataItems: KnockoutObservableArray<DataItem>

Property Value

Type
KnockoutObservableArray<DataItem>

dataMember Property

Declaration

dataMember: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

dataSource Property

Declaration

dataSource: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

filterString Property

Declaration

filterString: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

formatRules Property

Declaration

formatRules: KnockoutObservableArray<DashboardItemFormatRule>

Property Value

Type
KnockoutObservableArray<DashboardItemFormatRule>

hiddenDimensions Property

Declaration

hiddenDimensions: KnockoutObservableArray<Dimension>

Property Value

Type
KnockoutObservableArray<Dimension>

hiddenMeasures Property

Declaration

hiddenMeasures: KnockoutObservableArray<Measure>

Property Value

Type
KnockoutObservableArray<Measure>

isMasterFilterCrossDataSource Property

Declaration

isMasterFilterCrossDataSource: KnockoutObservable<boolean>

Property Value

Type
KnockoutObservable<boolean>