Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JournalEntryPage

The client-side JournalEntryPage document which extends the common BaseJournalEntryPage document model.

mixes

ClientDocumentMixin

see

JournalEntry The JournalEntry document type which contains JournalEntryPage embedded documents.

Hierarchy

  • any
    • JournalEntryPage

Index

Constructors

Accessors

Methods

Properties

Constructors

constructor

  • Returns JournalEntryPage

Accessors

toc

  • get toc(): any

  • The table of contents for this JournalEntryPage.

    Returns any

permission

  • get permission(): any
  • inheritdoc

    Returns any

sceneNote

  • get sceneNote(): Note

  • Return a reference to the Note instance for this Journal Entry Page in the current Scene, if any. If multiple notes are placed for this Journal Entry, only the first will be returned.

    Returns Note

Methods

_createDocumentLink

  • _createDocumentLink(eventData: any, __namedParameters?: { relativeTo: any; label: any }): any
  • inheritdoc

    Parameters

    • eventData: any
    • __namedParameters: { relativeTo: any; label: any } = {}
      • relativeTo: any
      • label: any

    Returns any

_onClickDocumentLink

  • _onClickDocumentLink(event: any): any
  • inheritdoc

    Parameters

    • event: any

    Returns any

_onUpdate

  • _onUpdate(changed: any, options: any, userId: any): void
  • inheritdoc

    Parameters

    • changed: any
    • options: any
    • userId: any

    Returns void

Static slugifyHeading

  • slugifyHeading(heading: string | HTMLHeadingElement): string

  • Convert a heading into slug suitable for use as an identifier.

    Parameters

    • heading: string | HTMLHeadingElement

      The heading element or some text content.

    Returns string

Static buildTOC

  • buildTOC(html: HTMLElement[], [options]?: { includeElement: boolean }): any

  • Build a table of contents for the given HTML content.

    Parameters

    • html: HTMLElement[]

      The HTML content to generate a ToC outline for.

    • [options]: { includeElement: boolean } = {}

      Additional options to configure ToC generation.

      • includeElement: boolean

    Returns any

Static Protected _flattenTOC

  • Flatten the tree structure into a single object with each node's slug as the key.

    Parameters

    Returns any

Static Protected _makeHeadingNode

  • Construct a table of contents node from a heading element.

    Parameters

    • heading: HTMLHeadingElement

      The heading element.

    • [options]: { includeElement: boolean } = {}

      Additional options to configure the returned node.

      • includeElement: boolean

    Returns JournalEntryPageHeading

Properties

Protected _toc

_toc: any

The cached table of contents for this JournalEntryPage.