KC's Workspace
    Preparing search index...

    Class ContextAwareRendererComponentAbstract

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

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    componentName: string

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

    The reflection that is currently processed.

    The project that is currently processed.

    urlPrefix: RegExp

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

    Accessors

    • get owner(): O

      Return the owner of this component.

      Returns O

    Methods

    • 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.

    • Stops listening to an event.

      Type Parameters

      • K extends never

      Parameters

      • event: K

        the event to stop listening to.

      • listener: (this: undefined, ...args: {}[K]) => void

        the function to remove from the listener array.

      Returns void

    • Starts listening to an event.

      Type Parameters

      • K extends never

      Parameters

      • event: K

        the event to listen to.

      • listener: (this: undefined, ...args: {}[K]) => void

        function to be called when an this event is emitted.

      • Optionalpriority: number

        optional priority to insert this hook with. Higher priority is placed earlier in the listener array.

      Returns void

    • Triggered before a document will be rendered.

      Parameters

      • page: PageEvent

        An event object describing the current render operation.

      Returns void

    • Triggered before the renderer starts rendering a project.

      Parameters

      • event: RendererEvent

        An event object describing the current render operation.

      Returns void

    • Emits an event to all currently subscribed listeners.

      Type Parameters

      • K extends never

      Parameters

      • event: K

        the event to emit.

      • ...args: {}[K]

        any arguments required for the event.

      Returns void