Nutrient Web SDK
    Preparing search index...

    Type Alias ZoomConfiguration

    This object contains configuration options for zooming. It allows granular control over the viewer zooming behavior.

    NutrientViewer.load({
      zoom: {
        zoomMode: NutrientViewer.ZoomMode.AUTO,
        wheelZoomMode: NutrientViewer.WheelZoomMode.WITH_CTRL,
        options: {
          enableKeyboardZoom: true,
          enableGestureZoom: true,
        },
      },
    });

    The following example sets the zoom mode to FIT_TO_WIDTH, the scroll zoom mode to DISABLED, and disables the keyboard zooming.

    NutrientViewer.load({
      zoom: {
        zoomMode: NutrientViewer.ZoomMode.FIT_TO_WIDTH,
        wheelZoomMode: NutrientViewer.WheelZoomMode.DISABLED,
        options: {
          enableKeyboardZoom: false,
        },
      },
    });
    type ZoomConfiguration = {
        options?: { enableGestureZoom?: boolean; enableKeyboardZoom?: boolean };
        wheelZoomMode?: IWheelZoomMode;
        zoomMode?: IZoomMode | number;
    }
    Index

    Properties

    options? wheelZoomMode? zoomMode?

    Properties

    options?: { enableGestureZoom?: boolean; enableKeyboardZoom?: boolean }

    The zoom options to use.

    Type Declaration

    • OptionalenableGestureZoom?: boolean

      Enable zooming via touch gestures.

      true
    • OptionalenableKeyboardZoom?: boolean

      Enable zooming via keyboard shortcuts (Ctrl/Cmd + [+-]).

      true
    wheelZoomMode?: IWheelZoomMode

    Defines the scroll zoom mode to use.

    zoomMode?: IZoomMode | number

    Defines the zoom mode to use.

    Settings

    Member Visibility

    On This Page

    Properties