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

IBottomToolbarConfigParsed Interface

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

A structure containing the configuration of the Bottom toolbar.

example
productDefinition = {
    surfaces: [
        {
            name: "Left",
            printAreas: [{ designFile: "TriFold_Side1" }]
        },
        {
            name: "Middle",
            printAreas: [{ designFile: "TriFold_Side2" }]
        },
        {
            name: "Right",
            printAreas: [{ designFile: "TriFold_Side3" }]
        }
    ]
};

configuration = {
    widgets: {
        BottomToolbar: {

            // Disable buttons in the Bottom Toolbar.
            zoomValueEnabled: false,
            zoomButtonsEnabled: false,
            fullWindowButtonEnabled: false,
            fullScreenButtonEnabled: false,
            safetyLinesCheckboxEnabled: false,
            gridCheckboxEnabled: false,
            snapLinesCheckboxEnabled: false,

            // Enable only page names in the navigation area.
            surfaceSwitch: {
                enabled: true,
                showThumbnails: false,
                showSurfaceNames: true,
                scrollPageButtonsEnabled: false,
                toggleSurfaceButtonsEnabled: false,
                firstAndLastButtonsEnabled: false
            }
        }
    }
};

CustomersCanvas.IframeApi.loadEditor(iframe, productDefinition, configuration);

Properties

Optional fullScreenButtonEnabled

fullScreenButtonEnabled: boolean

Displays the Full screen button; the full screen mode is not supported in Internet Explorer and Safari, so the related button is not displayed in these browsers even if it is enabled. The default value is true.

Optional fullWindowButtonEnabled

fullWindowButtonEnabled: boolean

Displays the Full window button. The default value is true.

Optional gridCheckboxEnabled

gridCheckboxEnabled: boolean

Displays the grid toggle button. The default value is true.

Optional rotateButtonEnabled

rotateButtonEnabled: boolean

Displays the Rotate button to rotate the canvas. The default value is false.

Optional safetyLinesCheckboxEnabled

safetyLinesCheckboxEnabled: boolean

Displays the safety lines toggle button. The default value is true.

Optional snapLinesCheckboxEnabled

snapLinesCheckboxEnabled: boolean

Displays the snap lines checkbox. It turns on/off snap line mode. The default value is true.

Optional surfaceSwitch

surfaceSwitch: ISurfaceSwitchConfigParsed

Defines the pagination control in the Bottom toolbar.

Optional zoomButtonsEnabled

zoomButtonsEnabled: boolean

Displays the Zoom in and Zoom out buttons. The default value is true.

Optional zoomValueEnabled

zoomValueEnabled: boolean

Displays current zoom value. The default value is true.