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

Member Table: Custom Item

The following table lists members related to creating the custom item:

Custom Item Metadata

Use the following properties of the ICustomItemMetaData class to create a custom item model.

Name

Description

bindings

Specifies custom item's data items (measures, dimensions) and its options.

properties

Specifies properties used to provide specific settings for the custom item.

interactivity

Specifies support of the interactivity features (like Master Filtering and Drill-Down).

icon

Specifies a custom item's icon.

title

Specifies a custom item title.

groupName

Specifies a Toolbox group name where a custom item should be located.

index

Specifies an item position inside the specified Toolbox group.

Custom Item Viewer

Methods

Use the following members of the CustomItemViewer class to create a viewer representation.

Name

Description

Basic

renderContent($element, changeExisting)

Renders the custom dashboard item.

Data

iterateData

Iterates data rows for a custom item.

getBindingValue(propertyName)

Returns an array of objects that allows you to get information about the binding value.

getPropertyValue(propertyName)

Returns an array of objects that allows you to get information about the custom property value.

subscribe(propertyName, callback)

Allows you to react on and subscribe to property changes.

View

contentWidth

Returns the item content width.

contentHeight

Returns the item content height (without header).

setSize(width, height)

Sets the content size.

Interactivity

canMasterFilter

Indicates whether end-users can filter data by clicking on the custom item's UI object. This object should be associated with a specified data row.

canDrillDown

Indicates whether end-users can drill down by clicking on the custom item's UI object. This object should be associated with a specified data row.

setMasterFilter

Allows you to set a master filter for the custom item's UI object. This object should be associated with a specified data row.

drillDown

Allows you to display detail data for the custom item's UI object. This object should be associated with a specified data row.

isSelected(row)

Specifies whether the custom item's UI object is selected. This object should be associated with a specified data row.

clearSelection

Allows you to clear a selection in the custom item.

Interactivity

allowExportSingleItem

Specifies whether end-users can export a custom item as a single dashboard item.

getExportInfo

Returns an object that is used as an export result.

Interfaces

The following interfaces are used to create a viewer representation:

Name

Description

ICustomDataRow

When implemented, represents a custom data row.

ICustomItemBindingValue

When implemented, represents a data binding.

ICustomItemBinding

When implemented, represents a data binding used to provide data for the dashboard item.

ICustomItemProperty

When implemented, represents a custom property used to configure a custom item.