The requested page is not available for the requested platform. You are viewing the content for Default platform.

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.

constructor(_meta)

Declaration

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

Parameters

Name Type Description
_meta ICustomItemMetaData

Optional Parameters

Name Type Default Description
modelJson any null

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

serializer DxDesigner.Analytics.Utils.ModelSerializer null

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

Properties

ItemType Property

Declaration

static ItemType: string

Property Value

Type Description
string

colorScheme Property

Declaration

colorScheme: ko.ObservableArray<ColorSchemeEntry>

Property Value

Type Description
ko.ObservableArray<ColorSchemeEntry>

coloringDimensions Property

Declaration

coloringDimensions: ko.ObservableArray<DataItemLink>

Property Value

Type Description
ko.ObservableArray<DataItemLink>

coloringMeasures Property

Declaration

coloringMeasures: ko.ObservableArray<DataItemLink>

Property Value

Type Description
ko.ObservableArray<DataItemLink>

coloringOptions Property

Declaration

coloringOptions: DashboardItemColoringOptions

Property Value

Type Description
DashboardItemColoringOptions

customBindings Property

Declaration

readonly customBindings: Array<ICustomItemBinding>

Property Value

Type Description
Array<ICustomItemBinding>

customInteractivity Property

Declaration

readonly customInteractivity: any

Property Value

Type Description
any

customItemType Property

Declaration

customItemType: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

customMetadata Property

Declaration

customMetadata: {}

Property Value

Type Description
__type

customProperties Property

Declaration

readonly customProperties: Array<ICustomItemProperty>

Property Value

Type Description
Array<ICustomItemProperty>

getInfo Property

Declaration

getInfo: () => DxDesigner.Analytics.Utils.ISerializationInfoArray

Property Value

Type Description
() => DxDesigner.Analytics.Utils.ISerializationInfoArray

interactivityOptions Property

Declaration

interactivityOptions: any

Property Value

Type Description
any

interactivityTargets Property

Declaration

interactivityTargets: ko.ObservableArray<DataItemLink>

Property Value

Type Description
ko.ObservableArray<DataItemLink>

sliceTables Property

Declaration

sliceTables: ko.ObservableArray<SliceTable>

Property Value

Type Description
ko.ObservableArray<SliceTable>

Methods

getBindingValue(propertyName) Method

Declaration

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

Parameters

Name Type Description
propertyName string

Optional Parameters

Name Type Default Description
index number null

Returns

Type Description
Array<ICustomItemBindingValue>

getPropertyInfo(p) Method

Declaration

static getPropertyInfo(p: ICustomItemProperty): DxDesigner.Analytics.Utils.ISerializationInfo

Parameters

Name Type Description
p ICustomItemProperty

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationInfo

isDrillDownAllowed Method

Declaration

isDrillDownAllowed(): boolean

Returns

Type Description
boolean

isFilterAllowed Method

Declaration

isFilterAllowed(): boolean

Returns

Type Description
boolean

iterateData(action) Method

Declaration

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

Parameters

Name Type Description
action (item: ICustomDataRow) => any

Optional Parameters

Name Type Default Description
sliceTableName string null