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

    Interface IReaderViewAnnotationOptions

    Options related with the presentation of ReaderViewAnnotations.

    interface IReaderViewAnnotationOptions {
        containerClassName?: string;
        containerStyle?: { [property: string]: string };
        positionClassName?: string;
        positionStyle?: { [property: string]: string };
        rangeClassName?: string;
        rangeStyle?: { [property: string]: string };
    }

    Properties

    containerClassName?: string

    A class name or space-separated class names to add to the ReaderViewAnnotation container elements. This element defines the bounding box for all ranges and points created by the ReaderViewAnnotation for a page.

    For more details about the DOM structure of the rendered ReaderViewAnnotationLayer and how you can affect styling using custom class names, see ReaderViewAnnotationLayer documentation.

    containerStyle?: { [property: string]: string }

    CSS style declarations to add to the ReaderViewAnnotation container element. This element defines the bounding box for all ranges and points created by the ReaderViewAnnotation for a page.

    For more details about the DOM structure of the rendered ReaderViewAnnotationLayer, see ReaderViewAnnotationLayer documentation.

    positionClassName?: string

    A class name or space-separated class names to add to each rectangle generated by the ReaderViewAnnotation when it represents a position.

    For more details about the DOM structure of the rendered ReaderViewAnnotationLayer and how you can affect styling using custom class names, see ReaderViewAnnotationLayer documentation.

    positionStyle?: { [property: string]: string }

    An object with css declarations to apply to rectangles when ReaderViewAnnotation represents a position.

    For more details about the DOM structure of the rendered ReaderViewAnnotationLayer, see ReaderViewAnnotationLayer documentation.

    Example: { "background-color": "violet", width: 16px; height: 16px }

    rangeClassName?: string

    A class name or space-separated class names to add to each rectangle generated by the ReaderViewAnnotation when it represents a range. For example, when an annotation refers to several lines of text, one element will be rendered per line.

    For more details about the DOM structure of the rendered ReaderViewAnnotationLayer and how you can affect styling using custom class names, see ReaderViewAnnotationLayer documentation.

    rangeStyle?: { [property: string]: string }

    An object with css declarations to apply to rectangles when ReaderViewAnnotation represents a range. For example, when an annotation refers to several lines of text, one element will be rendered per line.

    For more details about the DOM structure of the rendered ReaderViewAnnotationLayer, see ReaderViewAnnotationLayer documentation.

    Example: { "background-color": "violet" }

    Properties