Interface IBottomToolbarConfig

A structure containing the configuration of the Bottom toolbar.

Package: @aurigma/design-editor-iframe

Examples

This is how you can disable all the buttons and enable only page names in the navigation area.

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

const configuration = {
   widgets: {
       BottomToolbar: {
           // Disable buttons in the Bottom Toolbar.
           zoomValueEnabled: false,
           zoomButtonsEnabled: false,
           rotateButtonEnabled: false,
           fullScreenButtonEnabled: false,
           safetyLinesCheckboxEnabled: false,
           previewModeCheckboxEnabled: false,
           gridCheckboxEnabled: false,
           snapLinesItemsCheckboxEnabled: false,
           snapLinesPrintAreaCheckboxEnabled: false,
           snapLinesSafetyLinesCheckboxEnabled: 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

flatMarkingMenuEnabled

Displays the marking menu flat.

Declaration

flatMarkingMenuEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the marking menu flat.

fullScreenButtonEnabled

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.

Declaration

fullScreenButtonEnabled?: boolean;

Property Value

Type	Description
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.

fullWindowButtonEnabled

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

Declaration

fullWindowButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the Full window button. The default value is true.

gridCheckboxEnabled

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

Declaration

gridCheckboxEnabled?: boolean | ICheckboxConfig;

Property Value

Type	Description
boolean | ICheckboxConfig	Displays the grid toggle button. The default value is true.

previewModeCheckboxEnabled

Displays the **Preview mode** check box on the **Marking** menu. The default value is false.

Declaration

previewModeCheckboxEnabled?: boolean | ICheckboxConfig;

Property Value

Type	Description
boolean | ICheckboxConfig	Displays the **Preview mode** check box on the **Marking** menu. The default value is false.

rotateButtonEnabled

Displays the Rotate button to rotate the canvas at the angle predefined in IRotationConfig. The default value is false.

Declaration

rotateButtonEnabled?: boolean;

Property Value

Type	Description
boolean	Displays the Rotate button to rotate the canvas at the angle predefined in IRotationConfig. The default value is false.

safetyLinesCheckboxEnabled

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

Declaration

safetyLinesCheckboxEnabled?: boolean | ICheckboxConfig;

Property Value

Type	Description
boolean | ICheckboxConfig	Displays the safety lines toggle button. The default value is true.

snapLinesInteractiveZonesCheckboxEnabled

Displays the **Snap to interactive zones** check box on the **Marking** menu. The default value is true.

Declaration

snapLinesInteractiveZonesCheckboxEnabled?: boolean | ICheckboxConfig;

Property Value

Type	Description
boolean | ICheckboxConfig	Displays the **Snap to interactive zones** check box on the **Marking** menu. The default value is true.

snapLinesItemsCheckboxEnabled

Displays the **Snap to items** check box on the **Marking** menu. The default value is true.

Declaration

snapLinesItemsCheckboxEnabled?: boolean | ICheckboxConfig;

Property Value

Type	Description
boolean | ICheckboxConfig	Displays the **Snap to items** check box on the **Marking** menu. The default value is true.

snapLinesPrintAreaCheckboxEnabled

Displays the **Snap to page** check box on the **Marking** menu. The default value is true.

Declaration

snapLinesPrintAreaCheckboxEnabled?: boolean | ICheckboxConfig;

Property Value

Type	Description
boolean | ICheckboxConfig	Displays the **Snap to page** check box on the **Marking** menu. The default value is true.

snapLinesSafetyLinesCheckboxEnabled

Displays the **Snap to safety lines** check box on the **Marking** menu. The default value is true.

Declaration

snapLinesSafetyLinesCheckboxEnabled?: boolean | ICheckboxConfig;

Property Value

Type	Description
boolean | ICheckboxConfig	Displays the **Snap to safety lines** check box on the **Marking** menu. The default value is true.

surfaceSwitch

Defines the pagination control in the Bottom toolbar.

Declaration

surfaceSwitch?: ISurfaceSwitchConfig;

Property Value

Type	Description
ISurfaceSwitchConfig	Defines the pagination control in the Bottom toolbar.

zoomButtonsEnabled

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

Declaration

zoomButtonsEnabled?: boolean;

Property Value

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

zoomValueEnabled

Displays current zoom value. The default value is true.

Declaration

zoomValueEnabled?: boolean;

Property Value

Type	Description
boolean	Displays current zoom value. The default value is true.