Default theme implementation of TypeDoc. If a theme does not provide a custom [[BaseTheme]] implementation, this theme class will be used.
The base path of this theme.
The name of this component as set by the @Component decorator.
Mappings of reflections kinds to templates used by this theme.
A unique id that identifies this instance.
Return the application / root component instance.
Return the owner of this component.
Return all option declarations emitted by this component.
Initialize this component.
Test whether the given path contains a documentation generated by this theme.
The path of the directory that should be tested.
TRUE if the given path seems to be a previous output directory, otherwise FALSE.
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.
Triggered before the renderer starts rendering a project.
An event object describing the current render operation.
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.
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).
Generate the css classes for the given reflection group and apply them to the [[ReflectionGroup.cssClasses]] property.
The reflection group whose cssClasses property should be generated.
Return the template mapping for the given reflection.
The reflection whose mapping should be resolved.
The found mapping or undefined if no mapping could be found.
Return a url for the given reflection.
The reflection the url should be generated for.
The parent reflection the url generation should stop on.
The separator used to generate the url.
The generated url.
Transform a space separated string into a string suitable to be used as a css class, e.g. "constructor method" > "Constructor-method".
Generated using TypeDoc