Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Renderer

The renderer processes a ProjectReflection using a [[BaseTheme]] instance and writes the emitted html documents to a output directory. You can specify which theme should be used using the --theme <name> commandline argument.

Subclasses of [[BasePlugin]] that have registered themselves in the [[Renderer.PLUGIN_CLASSES]] will be automatically initialized. Most of the core functionality is provided as separate plugins.

Renderer is a subclass of EventDispatcher and triggers a series of events while a project is being processed. You can listen to these events to control the flow or manipulate the output.

  • [[Renderer.EVENT_BEGIN]]
    Triggered before the renderer starts rendering a project. The listener receives an instance of RendererEvent. By calling RendererEvent.preventDefault the entire render process can be canceled.

    • [[Renderer.EVENT_BEGIN_PAGE]]
      Triggered before a document will be rendered. The listener receives an instance of PageEvent. By calling PageEvent.preventDefault the generation of the document can be canceled.

    • [[Renderer.EVENT_END_PAGE]]
      Triggered after a document has been rendered, just before it is written to disc. The listener receives an instance of PageEvent. When calling PageEvent.preventDefault the the document will not be saved to disc.

  • [[Renderer.EVENT_END]]
    Triggered after the renderer has written all documents. The listener receives an instance of RendererEvent.

Hierarchy

Implements

Index

Constructors

constructor

Properties

componentName

componentName: string

The name of this component as set by the @Component decorator.

disableOutputCheck

disableOutputCheck: boolean

entryPoint

entryPoint: string

gaID

gaID: string

gaSite

gaSite: string

hideGenerator

hideGenerator: boolean

theme

theme: Theme

The theme that is used to render the documentation.

themeName

themeName: string

toc

toc: string[]

Accessors

application

owner

Methods

addComponent

  • addComponent<T>(name: string, componentClass: T | ComponentClass<T>): T

Protected bubble

getComponent

getComponents

getOptionDeclarations

hasComponent

  • hasComponent(name: string): boolean

initialize

  • initialize(): void

listenTo

listenToOnce

off

  • off(): any
  • off(eventMap: EventMap, context?: any): any
  • off(name: string, callback?: EventCallback, context?: any): any

on

  • on(eventMap: EventMap, context?: any): any
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: number): any
  • on(name: string, callback: EventCallback, context?: any, priority?: number): any

once

  • once(eventMap: EventMap, context?: any): any
  • once(name: string, callback: EventCallback, context?: any, priority?: any): any
  • Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns any

Private prepareOutputDirectory

  • prepareOutputDirectory(directory: string): boolean
  • Prepare the output directory. If the directory does not exist, it will be created. If the directory exists, it will be emptied.

    Parameters

    • directory: string

      The path to the directory that should be prepared.

    Returns boolean

    TRUE if the directory could be prepared, otherwise FALSE.

Private prepareTheme

  • prepareTheme(): boolean
  • Ensure that a theme has been setup.

    If a the user has set a theme we try to find and load it. If no theme has been specified we load the default theme.

    Returns boolean

    TRUE if a theme has been setup, otherwise FALSE.

removeAllComponents

  • removeAllComponents(): void

removeComponent

render

  • Render the given project reflection to the specified output directory.

    Parameters

    • project: ProjectReflection

      The project that should be rendered.

    • outputDirectory: string

      The path of the directory the documentation should be rendered to.

    Returns void

Private renderDocument

  • Render a single page.

    Parameters

    • page: PageEvent

      An event describing the current page.

    Returns boolean

    TRUE if the page has been saved to disc, otherwise FALSE.

stopListening

trigger

  • Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

    Parameters

    Returns this

Static getDefaultTheme

  • getDefaultTheme(): string
  • Return the path to the default theme.

    Returns string

    The path to the default theme.

Static getThemeDirectory

  • getThemeDirectory(): string
  • Return the path containing the themes shipped with TypeDoc.

    Returns string

    The path to the theme directory.

Generated using TypeDoc