View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

ITopToolbarConfigParsed Interface

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

A structure containing the configuration of the Top toolbar.

example
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

Optional alignButtonsEnabled

alignButtonsEnabled: boolean

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

Optional barcodeColorButtonEnabled

barcodeColorButtonEnabled: boolean

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

Optional borderColorButtonEnabled

borderColorButtonEnabled: boolean

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

Optional borderWidthButtonEnabled

borderWidthButtonEnabled: boolean

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

Optional changeBarcodeTypeButtonEnabled

changeBarcodeTypeButtonEnabled: boolean

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

Optional cloneButtonEnabled

cloneButtonEnabled: boolean

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

Optional closeFontMenuOnClickEnabled

closeFontMenuOnClickEnabled: 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.

Optional deleteButtonEnabled

deleteButtonEnabled: boolean

Displays the Delete button. The default value is false.

Optional displayAlignButtonsAsDropdown

displayAlignButtonsAsDropdown: boolean

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

Optional displayCaptionInButtons

displayCaptionInButtons: boolean

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

Optional displayZOrderButtonsAsDropdown

displayZOrderButtonsAsDropdown: boolean

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

Optional editTextButtonEnabled

editTextButtonEnabled: boolean

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

Optional fontPreviewSize

fontPreviewSize: number

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

Optional fontSize

fontSize: IRangeParamsParsed

Specifies parameters of the Font size spinner.

Optional historyButtonsEnabled

historyButtonsEnabled: boolean

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

Optional imageEditButtonEnabled

imageEditButtonEnabled: boolean

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

Optional imageSelectButtonEnabled

imageSelectButtonEnabled: boolean

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

Optional layoutItemSettingsButtonEnabled

layoutItemSettingsButtonEnabled: boolean

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

Optional multiRowModeEnabled

multiRowModeEnabled: boolean

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

Optional opacitySliderEnabled

opacitySliderEnabled: boolean

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

Optional placeInSafetyAreaButtonEnabled

placeInSafetyAreaButtonEnabled: boolean

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

Optional placeholderEditButtonEnabled

placeholderEditButtonEnabled: boolean

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

Optional placeholderResetContentButtonEnabled

placeholderResetContentButtonEnabled: boolean

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

Optional placeholderRotateContentButtonsEnabled

placeholderRotateContentButtonsEnabled: boolean

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

Optional placeholderScaleButtonEnabled

placeholderScaleButtonEnabled: boolean

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

Optional placeholderSelectButtonEnabled

placeholderSelectButtonEnabled: boolean

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

Optional revertButtonEnabled

revertButtonEnabled: boolean

Displays the Revert button. The default value is true.

Optional textAlignmentButtonsEnabled

textAlignmentButtonsEnabled: boolean

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

Optional textAllowChangeColumnCount

textAllowChangeColumnCount: boolean

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

Optional textEmphasisButtonsEnabled

textEmphasisButtonsEnabled: boolean

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

Optional textFontColorButtonEnabled

textFontColorButtonEnabled: boolean

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

Optional textFontFamilyButtonEnabled

textFontFamilyButtonEnabled: boolean

Displays the font list. The default value is true.

Optional textFontSizeButtonEnabled

textFontSizeButtonEnabled: boolean

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

Optional textFontStyleButtonEnabled

textFontStyleButtonEnabled: boolean

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

Optional textLeadingButtonEnabled

textLeadingButtonEnabled: boolean

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

textParagraphButtonEnabled

textParagraphButtonEnabled: boolean

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

Optional textShadow

textShadow: ITextShadowParamParsed

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.

Optional textShadowButtonEnabled

textShadowButtonEnabled: boolean

Displays the Shadow button. The default value is true.

Optional textStroke

textStroke: IRangeParamsParsed

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

Optional textStrokeButtonEnabled

textStrokeButtonEnabled: boolean

Displays the Stroke button. The default value is true.

Optional textTrackingButtonEnabled

textTrackingButtonEnabled: boolean

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

Optional textVAlignmentButtonsEnabled

textVAlignmentButtonsEnabled: boolean

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

Optional zOrder

zOrder: IZOrderConfigParsed

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