@vivliostyle/core
    Preparing search index...

    Class OPFDoc

    Index

    Properties

    bindings cover documentURLTransformer epageCount epageCountCallback epageIsRenderedPage fallbackMap itemMap itemMapByPath items lang metadata opfXML pageProgression prePaginated pubURL spine store toc

    Methods

    assignAutoPages countEPages createDocumentURLTransformer getCFI getEPageFromPosition getMetadata getPathFromURL resolveEPage resolveFragment setEPageCountMode fromChapters fromWebPubManifest fromXMLDoc

    Properties

    bindings: { [key: string]: string } = {}
    cover: OPFItem = null
    documentURLTransformer: DocumentURLTransformer
    epageCount: number = 0
    epageCountCallback: (p1: number) => void = null
    epageIsRenderedPage: boolean = true
    fallbackMap: { [key: string]: string } = {}
    itemMap: { [key: string]: OPFItem }
    itemMapByPath: { [key: string]: OPFItem }
    items: OPFItem[]
    lang: string = null
    metadata: Meta = {}
    opfXML: XMLDocHolder
    pageProgression: PageProgression = null
    prePaginated: boolean = false
    pubURL: string
    spine: OPFItem[]
    store: EPUBDocStore
    toc: OPFItem = null

    Methods

    • Metadata is organized in the following way: fully-expanded property names (with IRI prefixes prepended) point to an array of values. Array contains at least one element. First element is primary and should be used by default. Element values are objects have the following keys:

      • "v" - item value as string,
      • "s" - scheme,
      • "o" - index in the order of appearing in the source,
      • "r" - refinement submetadata (organized just like the top-level metadata).

      Returns Meta

    • Parameters

      • epageIsRenderedPage: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods