Class Section

constructor

• new Section(
      item: SpineItem,
      hooks?: { content: Hook; serialize: Hook },
  ): Section

  Parameters

  • item: SpineItem
  • Optionalhooks: { content: Hook; serialize: Hook }

  Returns Section

canonical

cfiBase

contents

document

hooks

href

idref

index

linear

next

output

prev

properties

request

url

cfiFromElement

• cfiFromElement(el: Element): string

  Get a CFI from an Element in the Section

  Parameters

  • el: Element

  Returns string

  cfi an EpubCFI string

cfiFromRange

• cfiFromRange(_range: Range): string

  Get a CFI from a Range in the Section

  Parameters

  • _range: Range

  Returns string

  cfi an EpubCFI string

destroy

• destroy(): void

  Returns void

find

• find(_query: string): SearchResult[]

  Find a string in a section

  Parameters

  • _query: string

    The query string to find

  Returns SearchResult[]

  A list of matches, with form {cfi, excerpt}

load

• load(_request?: RequestFunction): Promise<Element>

  Load the section from its url

  Parameters

  • Optional_request: RequestFunction

    a request method to use for loading

  Returns Promise<Element>

  a promise with the xml document

reconcileLayoutSettings

• reconcileLayoutSettings(globalLayout: GlobalLayout): Record<string, string>

  Reconciles the current chapters layout properties with the global layout properties.

  Parameters

  • globalLayout: GlobalLayout

    The global layout settings object, chapter properties string

  Returns Record<string, string>

  layoutProperties Object with layout properties

render

• render(_request?: RequestFunction): Promise<string>

  Render the contents of a section

  Parameters

  • Optional_request: RequestFunction

    a request method to use for loading

  Returns Promise<string>

  output a serialized XML Document

search

• search(_query: string, maxSeqEle?: number): SearchResult[]

  Search a string in multiple sequential Element of the section.

  Parameters

  • _query: string

    The query string to search

  • maxSeqEle: number = 5

    The maximum number of Element that are combined for search, default value is 5.

  Returns SearchResult[]

  A list of matches, with form {cfi, excerpt}

unload

• unload(): void

  Unload the section document

  Returns void