CustomItem Class

A custom item that allows you to implement and embed any additional items into the Web Dashboard.

Declaration

export class CustomItem extends DataDashboardItem

Remarks

In addition to numerous built-in dashboard items, you can implement and embed your own items into the Web Dashboard - custom items.

The image below demonstrates the FunnelD3 custom item that supports data binding, master filtering, and coloring:

CustomItem_Funnel_Main

See Custom Item for more information.

Inherited Members

DevExpress.Dashboard.Model.DataDashboardItem.componentName
DevExpress.Dashboard.Model.DataDashboardItem.customProperties
DevExpress.Dashboard.Model.DataDashboardItem.name
DevExpress.Dashboard.Model.DataDashboardItem.parentContainer
DevExpress.Dashboard.Model.DataDashboardItem.showCaption
DevExpress.Dashboard.Model.DataDashboardItem.getUniqueNamePrefix

Inheritance

constructor(_meta)

Initializes a new instance of the CustomItem class with specified settings.

Declaration

constructor(_meta: ICustomItemMetaData, modelJson?: any, serializer?: DevExpress.Analytics.Utils.ModelSerializer)

Parameters

Name Type Description
_meta ICustomItemMetaData
modelJson 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

coloringDimensions Property

Declaration

coloringDimensions: ko.ObservableArray<DataItemLink>

Property Value

Type
ObservableArray<DataItemLink>

coloringMeasures Property

Declaration

coloringMeasures: ko.ObservableArray<DataItemLink>

Property Value

Type
ObservableArray<DataItemLink>

coloringOptions Property

Declaration

coloringOptions: DashboardItemColoringOptions

Property Value

Type
DashboardItemColoringOptions

colorScheme Property

Declaration

colorScheme: ko.ObservableArray<ColorSchemeEntry>

Property Value

Type
ObservableArray<ColorSchemeEntry>

customBindings Property

Declaration

readonly customBindings: Array<ICustomItemBinding>

Property Value

Type
Array<ICustomItemBinding>

customInteractivity Property

Declaration

readonly customInteractivity: any

Property Value

Type
any

customItemType Property

Declaration

customItemType: ko.Observable<string>

Property Value

Type
Observable<string>

customMetadata Property

Declaration

customMetadata: {}

interactivityOptions Property

Declaration

interactivityOptions: any

Property Value

Type
any

interactivityTargets Property

Declaration

interactivityTargets: ko.ObservableArray<DataItemLink>

Property Value

Type
ObservableArray<DataItemLink>

ItemType Property

Declaration

static ItemType: string

Property Value

Type
string

legacyCustomProperties Property

Declaration

readonly legacyCustomProperties: Array<ICustomItemProperty>

Property Value

Type
Array<ICustomItemProperty>

sliceTables Property

Declaration

sliceTables: ko.ObservableArray<SliceTable>

Property Value

Type
ObservableArray<SliceTable>

Methods

getBindingValue(propertyName) Method

Declaration

getBindingValue(propertyName: string, index?: number): Array<ICustomItemBindingValue>

Parameters

Name Type
propertyName string
index number

Returns

Type
Array<ICustomItemBindingValue>

getInfo Method

Declaration

getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

Returns

Type
ISerializationInfoArray

getPropertyInfo(p) Method

Declaration

static getPropertyInfo(p: ICustomItemProperty): IDashboardSerializationInfo

Parameters

Name Type
p ICustomItemProperty

Returns

Type
IDashboardSerializationInfo

isDrillDownAllowed Method

Declaration

isDrillDownAllowed(): boolean

Returns

Type
boolean

isFilterAllowed Method

Declaration

isFilterAllowed(): boolean

Returns

Type
boolean

iterateData(action) Method

Declaration

iterateData(action: (item: ICustomDataRow) => any, sliceTableName?: string): void

Parameters

Name Type
action (item: ICustomDataRow) => any
sliceTableName string