Class PageEvent<Model>

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

See

Type Parameters

  • out Model = unknown

Hierarchy (view full)

Constructors

constructor

Properties

filename model pageHeadings project url contents?

Accessors

isDefaultPrevented isPropagationStopped name

Methods

preventDefault stopPropagation

Events

BEGIN END

Constructors

constructor

Properties

filename

filename: string

The filename the page will be written to.

Readonly model

model: Model

The model that should be rendered on this page.

pageHeadings

pageHeadings: {
    link: string;
    text: string;
    classes?: string;
    kind?: ReflectionKind;
    level?: number;
}[] = []

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

Type declaration

  • link: string
  • text: string
  • Optional classes?: string
  • Optional kind?: ReflectionKind
  • Optional level?: number

project

project: Models.ProjectReflection

The project the renderer is currently processing.

url

url: string

The url this page will be located at.

Optional contents

contents?: string

The final html content of this page.

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

Accessors

isDefaultPrevented

isPropagationStopped

name

Methods

preventDefault

stopPropagation

Events

Static Readonly BEGIN

BEGIN: "beginPage" = "beginPage"

Triggered before a document will be rendered.

Static Readonly END

END: "endPage" = "endPage"

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

Settings

Member Visibility

Theme

On This Page

constructorfilenamemodelpageHeadingsprojecturlcontentsisDefaultPreventedisPropagationStoppednamepreventDefaultstopPropagationBEGINEND