new RibbonItem(properties)
Creates a new instance of RibbonItem.
Parameters:
| Name |
Type |
Description |
properties |
Object
|
An object that contains the properties of the Ribbon Item.
Properties
| Name |
Type |
Argument |
Description |
dataElement |
string
|
<optional>
|
The data element of the ribbon item. |
title |
string
|
<optional>
|
The tooltip of the ribbon item. |
disabled |
boolean
|
<optional>
|
Whether the item is disabled or not. |
label |
string
|
<optional>
|
The label of the item. |
img |
string
|
<optional>
|
The icon of the item. |
toolbarGroup |
string
|
<optional>
|
The group that the item belongs to. |
isActive |
boolean
|
<optional>
|
Whether the item is active or not. |
groupedItems |
Array.<UI.Components.Item>
|
<optional>
|
Grouped Items to be contained by the RibbonItem. |
|
Example
const ribbonItem = new instance.UI.Components.RibbonItem({
dataElement: 'toolbarGroup-Annotate',
title: 'Annotate',
type: 'ribbonItem',
label: 'Annotate',
groupedItems: [
'annotateGroupedItems'
],
toolbarGroup: 'toolbarGroup-Annotate'
});