The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V18.2
19.1 (preview)
18.2
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

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.

Inheritance

DataDashboardItem
CustomItem

constructor(_meta)

Declaration

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

Parameters

Name Type Description
_meta ICustomItemMetaData

Optional Parameters

Type Name Default Description
any modelJson null

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

DxDesigner.Analytics.Utils.ModelSerializer serializer 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: KnockoutObservableArray<ColorSchemeEntry>

Property Value

Type Description
KnockoutObservableArray<ColorSchemeEntry>

coloringDimensions Property

Declaration

coloringDimensions: KnockoutObservableArray<DataItemLink>

Property Value

Type Description
KnockoutObservableArray<DataItemLink>

coloringMeasures Property

Declaration

coloringMeasures: KnockoutObservableArray<DataItemLink>

Property Value

Type Description
KnockoutObservableArray<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: KnockoutObservable<string>

Property Value

Type Description
KnockoutObservable<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.ISerializationsInfo

Property Value

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

interactivityOptions Property

Declaration

interactivityOptions: any

Property Value

Type Description
any

interactivityTargets Property

Declaration

interactivityTargets: KnockoutObservableArray<DataItemLink>

Property Value

Type Description
KnockoutObservableArray<DataItemLink>

sliceTables Property

Declaration

sliceTables: KnockoutObservableArray<SliceTable>

Property Value

Type Description
KnockoutObservableArray<SliceTable>

Methods

getBindingValue(propertyName) Method

Declaration

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

Parameters

Name Type Description
propertyName string

Optional Parameters

Type Name Default Description
number index 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

Type Name Default Description
string sliceTableName null