Options
All
  • Public
  • Public/Protected
  • All
Menu

Options related with the presentation of ReaderViewAnnotations.

Hierarchy

  • IReaderViewAnnotationOptions

Index

Properties

Optional containerClassName

containerClassName?: string

Class name 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.

nodefault

Optional containerStyle

containerStyle?: {}

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.

nodefault

Type declaration

  • [property: string]: string

Optional positionClassName

positionClassName?: string

Class name 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.

nodefault

Optional positionStyle

positionStyle?: {}

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 }

nodefault

Type declaration

  • [property: string]: string

Optional rangeClassName

rangeClassName?: string

Class name to add to each rectangle generated by the ReaderViewAnnotation when it represents a range. For example, when an annotation refers to serveral 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.

nodefault

Optional rangeStyle

rangeStyle?: {}

An object with css declarations to apply to rectangles when ReaderViewAnnotation represents a range. For example, when an annotation refers to serveral 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" }

nodefault

Type declaration

  • [property: string]: string

Generated using TypeDoc