ICustomItemMetaData Interface
When implemented, represents a custom item model.
Declaration
export interface ICustomItemMetaData
Properties
bindings Property
Specifies custom item’s data items (measures, dimensions) and its options.
Declaration
bindings?: Array<ICustomItemBinding>
Property Value
Type | Description |
---|---|
Array<ICustomItemBinding> | An array of data items. |
Remarks
The bindings property contains bindings used to provide data for the custom item.
The code snippet from the FunnelD3 custom item shows how to create custom measures (Values) and dimensions (Arguments):
var funnelMeta = {
bindings: [{
propertyName: 'Values',
dataItemType: 'Measure',
array: true,
enableColoring: true,
displayName: 'DashboardWebCustomItemStringId.Values',
emptyPlaceholder: 'DashboardWebCustomItemStringId.SetValue',
selectedPlaceholder: 'DashboardWebCustomItemStringId.ConfigureValue'
}, {
propertyName: 'Arguments',
dataItemType: 'Dimension',
array: true,
enableInteractivity: true,
enableColoring: true,
displayName: 'DashboardWebCustomItemStringId.Arguments',
emptyPlaceholder: 'DashboardWebCustomItemStringId.SetArgument',
selectedPlaceholder: 'DashboardWebCustomItemStringId.ConfigureArgument'
}],
//...
}
Note
You can find and download the full example on GitHub: FunnelD3.
groupName Property
Specifies a Toolbox group name where a custom item should be located.
Declaration
groupName?: string
Property Value
Type | Description |
---|---|
string | A string that specifies a Toolbox group name. |
icon Property
Specifies a custom item’s icon.
Declaration
icon: string
Property Value
Type | Description |
---|---|
string | A string that contains an id from icon’s svg definition. |
Remarks
The custom item’s icon is used to identify a custom item in the Toolbox, empty dashboards and dashboard groups, etc.
index Property
Specifies an item position inside the specified Toolbox group.
Declaration
index?: number
Property Value
Type | Description |
---|---|
number | A zero-based index that defines an item position inside the specified Toolbox group. |
interactivity Property
Specifies support of the interactivity features (like Master Filtering and Drill-Down).
Declaration
interactivity?: {
filter?: boolean;
drillDown?: boolean;
}
Property Value
Name | Type | Description |
---|---|---|
drillDown | boolean | true, to support drill-down; otherwise, false. |
filter | boolean | true, to support master-filtering; otherwise, false. |
properties Property
Specifies properties used to provide specific settings for the custom item.
Declaration
properties?: Array<ICustomItemProperty>
Property Value
Type | Description |
---|---|
Array<ICustomItemProperty> | An array of custom item’s properties. |
Remarks
Note
You can find the custom property implementation in the FunnelD3 custom dashboard item code: FunnelD3.
title Property
Specifies a custom item title.
Declaration
title: string
Property Value
Type | Description |
---|---|
string | A string value that is a custom item title. |
Remarks
The title property specifies a custom item title that is used in the Toolbox, tooltips, as a default dashboard item caption, etc.