CustomControlsCollectionItem

The interface implemented by an item in the com.ibm.bi.authoring.customControls collection. All members are optional except for containerId and id. Other member values will fall back to the defaults for custom controls if not provided.

See How to create the extension for more details.

Example

{
	"containerId": "com.ibm.bi.authoring.customControls",
	"id": "print",
	"label": "Print button",
	"tooltip": "Print button",
	"icon": "def_print_icon",
	"symbols": "v1/ext/ExtensionName/symbols.svg",
	"designModule": "v1/ext/ExtensionName/designModule.js"
}

Members

(readonly) containerId :String

This must be "com.ibm.bi.authoring.customControls"

Type:
  • String

(readonly) designModule :String

This member is optional. References a file that implements the CustomControlDesignModule interface.

Type:
  • String

(readonly) icon :String

The control's icon. This is an SVG symbol ID of one of the symbols located in the file referenced by the symbols member. See the sample SVG symbols file for an example. This member is optional.

Type:
  • String

(readonly) id :String

The control's ID. This ID is the value used for the refControl attribute on the <customControl/>. See Error handling for how bad references are handled.

Type:
  • String
Example

The "refControl" attribute is used to maintain the link between the custom control element in the spec and the description of the control in the "com.ibm.bi.authoring.customControls" collection.

<customControl refControl="print" path="PrintButton.js"/>

(readonly) label :String

The control's label This member is optional.

Type:
  • String

(readonly) symbols :String|Array.<String>

The control's symbols. This can either be a single path as a string or multiple paths as an array of strings. See the sample SVG symbols file for an example. This member is optional.

Type:
  • String | Array.<String>

(readonly) tooltip :String

The control's tooltip This member is optional.

Type:
  • String