Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface IReaderViewTransformManagerOptions

    Options for the ReaderViewTransformManager.

    interface IReaderViewTransformManagerOptions {
        maxPanOffsetHorizontal?: ILength;
        maxPanOffsetVertical?: ILength;
        maxScaleFactor?: number;
        removeTransformAnimationDurationMs?: number;
        removeTransformOnNavigation?: boolean;
    }

    Properties

    maxPanOffsetHorizontal?: ILength

    The maximum horizontal pan offset relative to the width of the ReaderView's safe area, as defined in the ReaderView's contentDisplayAreaOptions.

    If this option is not specified or set to null, the value from IReaderViewOptions.gestureOptions.panZoom.maxPanOffsetHorizontal will be used.

    Example: Setting it to "0%" will not allow the left side of the publication to be panned further right than the left edge of the safe area (and the opposite for the right side).

    Example: Setting it to "50%" will allow the left side of the publication to be panned to the midpoint of the safe area (and the same for the right side).

    Example: Setting it to "100%" will allow the publication to be panned all the way outside the safe area.

    Example: Setting it to 80 CSS_PIXELS (or DEVICE_PIXELS) will not allow the left side of the publication to be panned further right than 80 CSS_PIXELS (or DEVICE_PIXELS) from the left edge of the safe area (and the opposite for the right side).

    null
    maxPanOffsetVertical?: ILength

    The maximum vertical pan offset relative to the height of the ReaderView's safe area, as defined in the ReaderView's contentDisplayAreaOptions.

    If this option is not specified or set to null, the value from IReaderViewOptions.gestureOptions.panZoom.maxPanOffsetVertical will be used.

    Example: Setting it to "0%" will not allow the top of the publication to be panned further down than the top of the safe area (and the opposite for the bottom).

    Example: Setting it to "50%" will allow the top of the publication to be panned to the midpoint of the safe area (and the same for the bottom).

    Example: Setting it to "100%" will allow the publication to be panned all the way outside the safe area.

    Example: Setting it to 80 CSS_PIXELS (or DEVICE_PIXELS) will not allow the top of the publication to be panned further down than 80 CSS_PIXELS (or DEVICE_PIXELS) from the top of the safe area (and the opposite for the bottom).

    null
    maxScaleFactor?: number

    The maximum allowed scale factor. This applies to both pan-zoom gestures and when calling any method on the ReaderViewTransformManager.

    If this option is not specified or set to null, the value from IReaderViewOptions.gestureOptions.panZoom.maxScaleFactor will be used.

    null
    removeTransformAnimationDurationMs?: number

    The default duration of the animation when the active transform is removed.

    300
    removeTransformOnNavigation?: boolean

    If the ReaderView's active transform should be removed before the ReaderView navigates.

    true
    Properties