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

    Interface IReaderViewStateData

    The ReaderView state as a JSON serializable object.

    interface IReaderViewStateData {
        activeGestureType: ReaderViewGestureType;
        activeNavigationAction: NavigationAction;
        activeRendererName: string;
        activeTransform: ITransformData;
        allowedGestureTypes: ReaderViewGestureType[];
        atEnd: boolean;
        atStart: boolean;
        canPerformGoTo: boolean;
        canPerformNext: boolean;
        canPerformPrevious: boolean;
        canTransform: boolean;
        contentSelectionEnabled: boolean;
        destroyed: boolean;
        name: string;
        offscreenContentRendering: boolean;
        pageProgressionDirection: ReaderViewPageProgressionDirection;
        readingAreaRange: ISimpleLocatorData;
        readingPosition: ISimpleLocatorData;
        responsiveRendererSelectionEnabled: boolean;
        scriptedContentDocumentEventHandlersEnabled: boolean;
        scrollState: IReaderViewScrollStateData;
        visibleContentRendering: boolean;
        visiblePages: IVisiblePageData[];
        visibleRange: ISimpleLocatorData;
    }

    Properties

    activeGestureType: ReaderViewGestureType

    The current active user gesture if any.

    activeNavigationAction: NavigationAction

    The current navigation action being performed if any.

    activeRendererName: string

    The name of the current active renderer.

    activeTransform: ITransformData

    The current active transform applied to the ReaderView, if any.

    allowedGestureTypes: ReaderViewGestureType[]

    The types of gestures that are allowed to be performed on this ReaderView.

    atEnd: boolean

    Check if this ReaderView is currently showing the last content in the last reader document added to the ReaderView.

    atStart: boolean

    If this ReaderView is currently showing the first content in the first reader document added to the ReaderView.

    canPerformGoTo: boolean

    If the goTo() or goToStart() action can be performed right now.

    canPerformNext: boolean

    If the next() action can be performed right now.

    canPerformPrevious: boolean

    If the previous() action can be performed right now.

    canTransform: boolean

    If the ReaderViewTransformManager can be used to apply transforms right now.

    contentSelectionEnabled: boolean

    If the user is able to select content in content documents.

    destroyed: boolean

    If this ReaderView has been destroyed.

    name: string

    Get the name of the ReaderView

    offscreenContentRendering: boolean

    If offscreen content is currently rendering.

    pageProgressionDirection: ReaderViewPageProgressionDirection

    The page progression direction used by the ReaderView.

    readingAreaRange: ISimpleLocatorData

    The locator describing the range of the reading area

    readingPosition: ISimpleLocatorData

    The current reading position.

    responsiveRendererSelectionEnabled: boolean

    If the ReaderView will choose the activeRenderer based on the ResponsiveViewRules associated with each added renderer. See ReaderView.addRenderer() for more details.

    scriptedContentDocumentEventHandlersEnabled: boolean

    If the scripted content document event handlers are allowed to receive events. Note that regardless if it is true or false, you will still receive EngineEvents.

    scrollState: IReaderViewScrollStateData

    Information about a renderer's current scroll state. Note that the scrollTop value is not up-to-date while scrolling is true.

    visibleContentRendering: boolean

    If visible content is currently rendering.

    visiblePages: IVisiblePageData[]

    Information about the current visible pages.

    visibleRange: ISimpleLocatorData

    The locator describing the range of the visible content

    Properties