Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PageEvent

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

This object will be passed as the rendering context to handlebars templates.

see

[[Renderer.EVENT_BEGIN_PAGE]]

see

[[Renderer.EVENT_END_PAGE]]

Hierarchy

Index

Constructors

constructor

Events

Static BEGIN

BEGIN: string = "beginPage"

Triggered before a document will be rendered.

Static END

END: string = "endPage"

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

Properties

contents

contents: string

The final html content of this page.

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

filename

filename: string

The filename the page will be written to.

model

model: any

The model that should be rendered on this page.

navigation

navigation: NavigationItem

The primary navigation structure of this page.

project

The project the renderer is currently processing.

settings

settings: any

The settings that have been passed to TypeDoc.

template

template: HandlebarsTemplateDelegate

The template that should be used to render this page.

templateName

templateName: string

The name of the template that should be used to render this page.

toc

The table of contents structure of this page.

url

url: string

The url this page will be located at.

Accessors

isDefaultPrevented

  • get isDefaultPrevented(): boolean

isPropagationStopped

  • get isPropagationStopped(): boolean

name

  • get name(): string

Methods

preventDefault

  • preventDefault(): void

stopPropagation

  • stopPropagation(): void

Generated using TypeDoc