TypeDoc API - v0.28.1

    Class PageEvent<Model>

    An event emitted by the Renderer class before and after the markup of a page is rendered.

    Type Parameters

    Index

    Constructors

    constructor

    Events

    BEGIN END

    Methods

    isReflectionEvent startNewSection

    Properties

    filename model pageHeadings pageKind pageSections project url contents?

    Constructors

    Events

    BEGIN: "beginPage"

    Triggered before a document will be rendered.

    END: "endPage"

    Triggered after a document has been rendered, just before it is written to disc.

    Methods

    • Start a new section of the page. Sections are collapsible within the "On This Page" sidebar.

      Parameters

      • title: string

      Returns void

    Properties

    filename: string

    The filename the page will be written to.

    model: Model

    The model that should be rendered on this page.

    pageHeadings: PageHeading[] = []

    Links to content within this page that should be rendered in the page navigation. This is built when rendering the document content.

    pageKind: PageKind

    The type of page this is.

    pageSections: { headings: PageHeading[]; title: string }[] = ...

    Sections of the page, generally set by @groups

    project: Models.ProjectReflection

    The project the renderer is currently processing.

    url: string

    The url this page will be located at.

    contents?: string

    The final html content of this page.

    Should be rendered by layout templates and can be modified by plugins.

    Settings

    Member Visibility

    On This Page

    Constructors
    Events
    Methods
    Properties
    MMNEPVFCICPMFPCPTTAAATR