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:

You can find and download the full example on GitHub:

View Example: ASP.NET CoreView Example: AngularView Example: React

Refer to the following topic for more information on custom items: Custom Item.

Inherited Members

componentName

customProperties

dataItems

dataMember

dataSource

disposed

filterString

formatRules

hiddenDimensions

hiddenMeasures

isDisposed

isMasterFilterCrossDataSource

itemType

name

parentContainer

showCaption

visibleDataFilterString

dispose

getUniqueNamePrefix

Inheritance

SerializableModel TypedSerializableModel DashboardItem DataDashboardItem CustomItem

constructor(_meta)

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

Declaration

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

Parameters

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<DevExpress.Dashboard.Model.DataItemLink>

Property Value

coloringMeasures Property

Declaration

coloringMeasures: ko.ObservableArray<DevExpress.Dashboard.Model.DataItemLink>

Property Value

coloringOptions Property

Declaration

coloringOptions: DevExpress.Dashboard.Model.DashboardItemColoringOptions

Property Value

colorScheme Property

Declaration

colorScheme: ko.ObservableArray<DevExpress.Dashboard.Model.ColorSchemeEntry>

Property Value

customBindings Property

Declaration

get customBindings(): Array<DevExpress.Dashboard.Model.ICustomItemBinding>

Property Value

customInteractivity Property

Declaration

get customInteractivity(): any

Property Value

customItemType Property

Declaration

customItemType: ko.Observable<string>

Property Value

customMetadata Property

Declaration

customMetadata: {}

interactivityOptions Property

Declaration

interactivityOptions: any

Property Value

interactivityTargets Property

Declaration

interactivityTargets: ko.ObservableArray<DevExpress.Dashboard.Model.DataItemLink>

Property Value

ItemType Property

Declaration

static ItemType: string

Property Value

legacyCustomProperties Property

Declaration

get legacyCustomProperties(): Array<DevExpress.Dashboard.Model.ICustomItemProperty>

Property Value

sliceTables Property

Declaration

sliceTables: ko.ObservableArray<DevExpress.Dashboard.Model.SliceTable>

Property Value

Methods

getBindingValue(propertyName) Method

Declaration

getBindingValue(
    propertyName: string,
    index?: number
): Array<DevExpress.Dashboard.Model.ICustomItemBindingValue>

Parameters

Returns

getInfo Method

Declaration

getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

Returns

getPropertyInfo(p) Method

Declaration

static getPropertyInfo(
    p: DevExpress.Dashboard.Model.ICustomItemProperty
): DevExpress.Dashboard.Metadata.IDashboardSerializationInfo

Parameters

Returns

isDrillDownAllowed Method

Declaration

isDrillDownAllowed(): boolean

Returns

isFilterAllowed Method

Declaration

isFilterAllowed(): boolean

Returns

iterateData(action) Method

Declaration

iterateData(
    action: (item: DevExpress.Dashboard.Model.ICustomDataRow) => any,
    sliceTableName?: string
): void

Parameters