IEpubCharactersContentPositionTimelineMappingOptions | Colibrio Reader Framework API

Options used when creating EPUB ContentPositionTimeline objects with CHARACTERS as unit of measurement.

In publications with lots of media, it might be desirable to count media elements (or other replaced elements) as x number of characters to get a better estimation of the "length" of the rendered publication. By default each replaced element is counted as 50 characters.

Many HTML documents may contain lots of whitespace that is not visible in the rendered publication. By default, multiple adjacent whitespaces are collapsed and counted as a single whitespace.

Hierarchy

IEpubCharactersContentPositionTimelineMappingOptions

Index

Properties

Optional audioElementWeight

audioElementWeight?: number

The number of characters each audio element should be counted as.

int
default: 50

Optional iframeElementWeight

iframeElementWeight?: number

The number of characters each iframe element should be counted as.

int
default: 50

Optional imageElementWeight

imageElementWeight?: number

The number of characters each image element should be counted as.

int
default: 50

Optional videoElementWeight

videoElementWeight?: number

The number of characters each video element should be counted as.

int
default: 50

Optional whitespaceBehaviour

whitespaceBehaviour?: EpubContentPositionTimelineWhitespaceBehavior

Defines how whitespace characters should be handled.

Many HTML documents may contain lots of whitespace that is not visible in the rendered publication. By default, multiple adjacent whitespaces are collapsed and counter as a single whitespace.

default: COLLAPSE