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
--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.
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.
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.
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.
Triggered after the renderer has written all documents. The listener receives an instance of RendererEvent.
The name of this component as set by the @Component decorator.
The theme that is used to render the documentation.
Return the application / root component instance.
Return the owner of this component.
Retrieve a plugin instance.
The instance of the plugin or undefined if no plugin with the given class is attached.
Return all option declarations emitted by this component.
Create a new Renderer instance.
Inversion-of-control versions of
on. Tell this object to listen to
an event in another object... keeping track of what it's listening to
for easier unbinding later.
Remove one or many callbacks. If
context is null, removes all
callbacks with that function. If
callback is null, removes all
callbacks for the event. If
name is null, removes all bound
callbacks for all events.
Bind an event to a
callback function. Passing
"all" will bind
the callback to all events fired.
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.
Prepare the output directory. If the directory does not exist, it will be created. If the directory exists, it will be emptied.
The path to the directory that should be prepared.
TRUE if the directory could be prepared, otherwise FALSE.
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.
TRUE if a theme has been setup, otherwise FALSE.
Render the given project reflection to the specified output directory.
The project that should be rendered.
The path of the directory the documentation should be rendered to.
Render a single page.
An event describing the current page.
TRUE if the page has been saved to disc, otherwise FALSE.
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).
Return the path to the default theme.
The path to the default theme.
Return the path containing the themes shipped with TypeDoc.
The path to the theme directory.
Generated using TypeDoc