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:

See Custom Item for more information.

Inherited Members

componentName

dataItems

dataMember

dataSource

filterString

formatRules

hiddenDimensions

hiddenMeasures

isMasterFilterCrossDataSource

itemType

name

parentContainer

showCaption

getUniqueNamePrefix

Inheritance

DashboardItem

DataDashboardItem

CustomItem

constructor(_meta)

Declaration

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

Parameters

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

Properties

coloringDimensions Property

Declaration

coloringDimensions: KnockoutObservableArray<DataItemLink>

Property Value

Type
KnockoutObservableArray<DataItemLink>

coloringMeasures Property

Declaration

coloringMeasures: KnockoutObservableArray<DataItemLink>

Property Value

Type
KnockoutObservableArray<DataItemLink>

coloringOptions Property

Declaration

coloringOptions: DashboardItemColoringOptions

Property Value

Type
DashboardItemColoringOptions

colorScheme Property

Declaration

colorScheme: KnockoutObservableArray<ColorSchemeEntry>

Property Value

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

Property Value

Type
KnockoutObservable<string>

customMetadata Property

Declaration

customMetadata: {}

customProperties Property

Declaration

readonly customProperties: Array<ICustomItemProperty>

Property Value

Type
Array<ICustomItemProperty>

getInfo Property

Declaration

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

Property Value

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

interactivityOptions Property

Declaration

interactivityOptions: any

Property Value

Type
any

interactivityTargets Property

Declaration

interactivityTargets: KnockoutObservableArray<DataItemLink>

Property Value

Type
KnockoutObservableArray<DataItemLink>

ItemType Property

Declaration

static ItemType: string

Property Value

Type
string

sliceTables Property

Declaration

sliceTables: KnockoutObservableArray<SliceTable>

Property Value

Type
KnockoutObservableArray<SliceTable>

Methods

getBindingValue(propertyName) Method

Declaration

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

Parameters

Name	Type
propertyName	string
index	number

Returns

Type
Array<ICustomItemBindingValue>

getPropertyInfo(p) Method

Declaration

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

Parameters

Name	Type
p	ICustomItemProperty

Returns

Type
DxDesigner.Analytics.Utils.ISerializationInfo

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