Skip to main content

Interface: IBottomToolbarConfig

A structure containing the configuration of the Bottom toolbar.

Example​

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​

fullWindowButtonEnabled?​

optional fullWindowButtonEnabled?: boolean

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

fullScreenButtonEnabled?​

optional 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.

zoomValueEnabled?​

optional zoomValueEnabled?: boolean

Displays current zoom value. The default value is true.

zoomButtonsEnabled?​

optional zoomButtonsEnabled?: boolean

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

rotateButtonEnabled?​

optional rotateButtonEnabled?: boolean

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

safetyLinesCheckboxEnabled?​

optional safetyLinesCheckboxEnabled?: boolean | ICheckboxConfig

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

previewModeCheckboxEnabled?​

optional previewModeCheckboxEnabled?: boolean | ICheckboxConfig

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

gridCheckboxEnabled?​

optional gridCheckboxEnabled?: boolean | ICheckboxConfig

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

snapLinesPrintAreaCheckboxEnabled?​

optional snapLinesPrintAreaCheckboxEnabled?: boolean | ICheckboxConfig

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

snapLinesSafetyLinesCheckboxEnabled?​

optional snapLinesSafetyLinesCheckboxEnabled?: boolean | ICheckboxConfig

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

snapLinesItemsCheckboxEnabled?​

optional snapLinesItemsCheckboxEnabled?: boolean | ICheckboxConfig

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

snapLinesInteractiveZonesCheckboxEnabled?​

optional snapLinesInteractiveZonesCheckboxEnabled?: boolean | ICheckboxConfig

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

surfaceSwitch?​

optional surfaceSwitch?: ISurfaceSwitchConfig

Defines the pagination control in the Bottom toolbar.

flatMarkingMenuEnabled?​

optional flatMarkingMenuEnabled?: boolean

Displays the marking menu flat.

Was this page helpful?