@readium/shared/types/src/publication/presentation/Properties.d.ts

Shared models to be used across other Readium projects and implementations in Typescript

import { Fit, Orientation, Overflow, Page, Spread } from './Presentation';
declare module '../Properties' {
    interface Properties {
        /**
         * Specifies whether or not the parts of a linked resource that flow out of the viewport are
         * clipped.
         */
        getClipped(): boolean | undefined;
        /**
         * Suggested method for constraining a resource inside the viewport.
         */
        getFit(): Fit | undefined;
        /**
         * Suggested orientation for the device when displaying the linked resource.
         */
        getOrientation(): Orientation | undefined;
        /**
         * Suggested method for handling overflow while displaying the linked resource.
         */
        getOverflow(): Overflow | undefined;
        /**
         * Indicates how the linked resource should be displayed in a reading environment that displays
         * synthetic spreads.
         */
        getPage(): Page | undefined;
        /**
         * Indicates the condition to be met for the linked resource to be rendered within a synthetic
         * spread.
         */
        getSpread(): Spread | undefined;
    }
}