Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ContextAwareRendererComponent

A plugin for the renderer that reads the current render context.

Hierarchy

Implements

Index

Constructors

constructor

Properties

componentName

componentName: string

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

Private location

location: string

The url of the document that is being currently generated.

Protected project

The project that is currently processed.

Protected reflection

The reflection that is currently processed.

Protected urlPrefix

urlPrefix: RegExp = /^(http|ftp)s?:\/\//

Regular expression to test if a string looks like an external url.

Accessors

application

owner

Methods

Protected bubble

getOptionDeclarations

getRelativeUrl

  • getRelativeUrl(absolute: string): string
  • Transform the given absolute path into a relative path.

    Parameters

    • absolute: string

      The absolute path to transform.

    Returns string

    A path relative to the document currently processed.

Protected 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

Protected onBeginPage

  • Triggered before a document will be rendered.

    Parameters

    • page: PageEvent

      An event object describing the current render operation.

    Returns void

Protected onBeginRenderer

  • Triggered before the renderer starts rendering a project.

    Parameters

    • event: RendererEvent

      An event object describing the current render operation.

    Returns void

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

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

Generated using TypeDoc