Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTMLTemplate

Hierarchy

Index

Constructors

constructor

Properties

Protected bundler

bundler: HTMLBundler

Methods

Protected attributes

  • attributes(properties: Set<Property>): string

Protected cssClass

Protected forEach

  • forEach<T>(a: object, callback: function, separator?: string): string
  • Type parameters

    • T

    Parameters

    • a: object
    • callback: function
        • (a: T): string
        • Parameters

          • a: T

          Returns string

    • Default value separator: string = ""

    Returns string

generateFilename

  • generateFilename(data: any, options?: any): string
  • Generates a filename for given data

    Parameters

    • data: any

      The data to render

    • Default value options: any = {}

      Some options to pass to the renderer

    Returns string

    The generated filename

Protected instanceOf

isSupporting

  • isSupporting(data: any, options?: any): boolean
  • Checks if this renderer is supporting given data and options

    Parameters

    • data: any

      The data to check support for

    • Default value options: any = {}

    Returns boolean

    Returns whether this renderer is supporting a given element

Protected layout

  • layout(model: ModelElement, options: any, body: string): string

Protected main

  • main(title: string, baseHref: string, roots: Set<ModelElement>, active: string, body: string): string

Protected operations

  • operations(operations: Set<Operation>): string

Protected ref

render

  • render(data: any, options: any, next: function): string
  • Renders any kind of data

    Parameters

    • data: any

      The data to render

    • options: any

      Some options to pass to the renderer

    • next: function

      Calls the next data to be rendered

        • (data: any): void
        • Parameters

          • data: any

          Returns void

    Returns string

    A promise that resolves after finishing the rendering

Protected uriNameFor

Generated using TypeDoc