Interface ITopToolbarConfig

A structure containing the configuration of the Top toolbar.

Package: @aurigma/design-editor-iframe

Examples

let configuration = {
    widgets: {
        TopToolbar: {
            multiRowModeEnabled:true,
            textShadowButtonEnabled: true,
            textShadow: {
                angle: { max: 70, min: 20, step: 5 },
                distance: { max: 5, min: 0, step: 0.1 },
                size: { max: 2, min: 0, step: 0.1 }
            },
            textStrokeButtonEnabled: false,
            textStroke: { max: 1, min: 0, step: 0.1 }
        }
    }
};

Properties

alignButtonsEnabled

Displays the vertical alignment buttons (**Top**, **Center**, **Bottom**). The default value is true.

Declaration

alignButtonsEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the vertical alignment buttons (**Top**, **Center**, **Bottom**). The default value is true.

barcodeColorButtonEnabled

Displays the **Select barcode color** button. The default value is true.

Declaration

barcodeColorButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Select barcode color** button. The default value is true.

borderColorButtonEnabled

Displays the **Select border color** button in the Top toolbar. The default value is true.

Declaration

borderColorButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Select border color** button in the Top toolbar. The default value is true.

borderWidthButtonEnabled

Displays the **Select border width** button in the Top toolbar. The default value is true.

Declaration

borderWidthButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Select border width** button in the Top toolbar. The default value is true.

changeBarcodeTypeButtonEnabled

Displays the **Change barcode type** drop-down list for barcode placeholders. The default value is true.

Declaration

changeBarcodeTypeButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Change barcode type** drop-down list for barcode placeholders. The default value is true.

cloneButtonEnabled

Displays the **Clone object** button. The default value is false.

Declaration

cloneButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Clone object** button. The default value is false.

closeFontMenuOnClickEnabled

If true, the **Select font** drop-down list closes after a user selects a font; otherwise, it closes only when a user clicks anywhere outside the list. The default value is true.

Declaration

closeFontMenuOnClickEnabled?: boolean;

Property Value

Type	Description
boolean	If true, the **Select font** drop-down list closes after a user selects a font; otherwise, it closes only when a user clicks anywhere outside the list. The default value is true.

deleteButtonEnabled

Displays the **Delete** button. The default value is false.

Declaration

deleteButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Delete** button. The default value is false.

displayAlignButtonsAsDropdown

Displays the alignment buttons as a drop-down list. The default value is true.

Declaration

displayAlignButtonsAsDropdown?: boolean;

Property Value

Type	Description
boolean	Displays the alignment buttons as a drop-down list. The default value is true.

displayCaptionInButtons

Displays button captions in the Top Toolbar. The default value is false.

Declaration

displayCaptionInButtons?: boolean;

Property Value

Type	Description
boolean	Displays button captions in the Top Toolbar. The default value is false.

displayZOrderButtonsAsDropdown

Displays the z-order buttons as a drop-down list. The default value is true.

Declaration

displayZOrderButtonsAsDropdown?: boolean;

Property Value

Type	Description
boolean	Displays the z-order buttons as a drop-down list. The default value is true.

editTextButtonEnabled

Displays the **Edit** button for text elements. The default value is false.

Declaration

editTextButtonEnabled: boolean;

Property Value

Type	Description
boolean	Displays the **Edit** button for text elements. The default value is false.

fillColorButtonEnabled

Displays the **Select fill color** button. The default value is true.

Declaration

fillColorButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Select fill color** button. The default value is true.

fontPreviewSize

The font size used to display font names in the **Select font** drop-down list. The default value is 17.

Declaration

fontPreviewSize?: number;

Property Value

Type	Description
number	The font size used to display font names in the **Select font** drop-down list. The default value is 17.

fontSize

Specifies parameters of the **Font size** spinner.

Declaration

fontSize?: IRangeParams;

Property Value

Type	Description
IRangeParams	Specifies parameters of the **Font size** spinner.

groupButtonEnabled

Displays the **Group/Ungroup** button for items. The default value is true.

Declaration

groupButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Group/Ungroup** button for items. The default value is true.

groupItemsEnabled

Obsolete. Left for compatibility. Works like groupButtonEnabled

Declaration

groupItemsEnabled?: boolean;

Property Value

Type	Description
boolean	Obsolete. Left for compatibility. Works like groupButtonEnabled

historyButtonsEnabled

Displays the **Undo** and **Redo** buttons. The default value is true.

Declaration

historyButtonsEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Undo** and **Redo** buttons. The default value is true.

imageEditButtonEnabled

Displays the **Edit** button for images in the Top toolbar. The default value is true.

Declaration

imageEditButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Edit** button for images in the Top toolbar. The default value is true.

imageSelectButtonEnabled

Displays the **Select image** button for images. The default value is true.

Declaration

imageSelectButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Select image** button for images. The default value is true.

layoutItemSettingsButtonEnabled

Displays the **Smart group** button to configure the auto-layout settings of grouped design elements. The default value is true.

Declaration

layoutItemSettingsButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Smart group** button to configure the auto-layout settings of grouped design elements. The default value is true.

multiRowModeEnabled

Displays the Top toolbar in the multi row mode to fit all the buttons for a screen. The default value is false.

Declaration

multiRowModeEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the Top toolbar in the multi row mode to fit all the buttons for a screen. The default value is false.

opacitySliderEnabled

If true, provides the ability to change layer opacity via the **Select opacity** slider in the Top toolbar. The default value is true.

Declaration

opacitySliderEnabled?: boolean;

Property Value

Type	Description
boolean	If true, provides the ability to change layer opacity via the **Select opacity** slider in the Top toolbar. The default value is true.

overlayColorButtonEnabled

Displays the **Select overlay color** button in the Top toolbar. The default value is true.

Declaration

overlayColorButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Select overlay color** button in the Top toolbar. The default value is true.

placeholderEditButtonEnabled

Displays the **Edit** button for image placeholders in the Top toolbar. The default value is true.

Declaration

placeholderEditButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Edit** button for image placeholders in the Top toolbar. The default value is true.

placeholderResetContentButtonEnabled

Displays the **Reset placeholder content** button for image placeholders. The default value is true.

Declaration

placeholderResetContentButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Reset placeholder content** button for image placeholders. The default value is true.

placeholderRotateContentButtonsEnabled

Displays the **Rotate content** buttons for image placeholders to rotate the content to 90, 180, and 270 degrees. The default value is true.

Declaration

placeholderRotateContentButtonsEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Rotate content** buttons for image placeholders to rotate the content to 90, 180, and 270 degrees. The default value is true.

placeholderScaleButtonEnabled

Displays the **Select placeholder content scale** button for image placeholders. The default value is true.

Declaration

placeholderScaleButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Select placeholder content scale** button for image placeholders. The default value is true.

placeholderSelectButtonEnabled

Displays the **Select image** button for image placeholders. The default value is true.

Declaration

placeholderSelectButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Select image** button for image placeholders. The default value is true.

placeInSafetyAreaButtonEnabled

Displays the **Place in** button to fit the selected design elements to an area bounded by safety lines. The default value is true.

Declaration

placeInSafetyAreaButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Place in** button to fit the selected design elements to an area bounded by safety lines. The default value is true.

revertButtonEnabled

Displays the **Revert** button. The default value is true.

Declaration

revertButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Revert** button. The default value is true.

textAlignmentButtonsEnabled

Displays the text alignment buttons. The default value is true.

Declaration

textAlignmentButtonsEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the text alignment buttons. The default value is true.

textAllowChangeColumnCount

Displays the **Columns** box for rich formatted text. The default value is true.

Declaration

textAllowChangeColumnCount?: boolean;

Property Value

Type	Description
boolean	Displays the **Columns** box for rich formatted text. The default value is true.

textBendButtonEnabled

Displays the **Arched text bend** button to configure the arch bend. The default value is true.

Declaration

textBendButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Arched text bend** button to configure the arch bend. The default value is true.

textEmphasisButtonsEnabled

Displays the faux text style buttons (bold, italic, and underlined). The default value is true.

Declaration

textEmphasisButtonsEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the faux text style buttons (bold, italic, and underlined). The default value is true.

textFillColorButtonEnabled

Displays the **Select text fill color** button. The default value is false.

Declaration

textFillColorButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Select text fill color** button. The default value is false.

textFontColorButtonEnabled

Displays the text color picker. The default value is true.

Declaration

textFontColorButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the text color picker. The default value is true.

textFontFamilyButtonEnabled

Displays the font list. The default value is true.

Declaration

textFontFamilyButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the font list. The default value is true.

textFontSizeButtonEnabled

Displays the font size spinner. The default value is true.

Declaration

textFontSizeButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the font size spinner. The default value is true.

textFontStyleButtonEnabled

Displays the font style list. The default value is true.

Declaration

textFontStyleButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the font style list. The default value is true.

textLeadingButtonEnabled

Displays the **Leading** list for text. The default value is true.

Declaration

textLeadingButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Leading** list for text. The default value is true.

textListButtonsEnabled

Displays the group of buttons to create and manipulate text lists. By default, the Top toolbar displays the list buttons for text elements.

Declaration

textListButtonsEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the group of buttons to create and manipulate text lists. By default, the Top toolbar displays the list buttons for text elements.

textParagraphButtonEnabled

Displays the **Paragraph** button to configure paragraph indents. The default value is true.

Declaration

textParagraphButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Paragraph** button to configure paragraph indents. The default value is true.

textShadow

An angle in degrees, an indent in points, and a blur value in pixels of the text shadow. The default values are calculated based on the text font size.

Declaration

textShadow?: ITextShadowParam;

Property Value

Type	Description
ITextShadowParam	An angle in degrees, an indent in points, and a blur value in pixels of the text shadow. The default values are calculated based on the text font size.

textShadowButtonEnabled

Displays the **Shadow** button. The default value is true.

Declaration

textShadowButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Shadow** button. The default value is true.

textStroke

Min and max values of the text stroke width in points, including the color and the size. The default values are calculated based on the text font size.

Declaration

textStroke?: IDefaultTextStroke;

Property Value

Type	Description
IDefaultTextStroke	Min and max values of the text stroke width in points, including the color and the size. The default values are calculated based on the text font size.

textStrokeButtonEnabled

Displays the **Stroke** button. The default value is true.

Declaration

textStrokeButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Stroke** button. The default value is true.

textStrokeColorButtonEnabled

Displays the **Stroke color** button to change the color of text stroke. If true, the user can change the stroke color. If false, the color is maintained the same as the text color. The default value is true.

Declaration

textStrokeColorButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Stroke color** button to change the color of text stroke. If true, the user can change the stroke color. If false, the color is maintained the same as the text color. The default value is true.

textTrackingButtonEnabled

Displays the **Tracking** list for text. The default value is true.

Declaration

textTrackingButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the **Tracking** list for text. The default value is true.

textVAlignmentButtonsEnabled

Displays the text vertical alignment buttons. The default value is true.

Declaration

textVAlignmentButtonsEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the text vertical alignment buttons. The default value is true.

zOrder

Displays buttons for changing the z-Order of design elements. By default, the Top toolbar displays the z-Order buttons.

Declaration

zOrder?: IZOrderConfig;

Property Value

Type	Description
IZOrderConfig	Displays buttons for changing the z-Order of design elements. By default, the Top toolbar displays the z-Order buttons.