Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Component

A component in the current page.

Hierarchy

Index

Methods

Methods

getChildren

  • Returns Component[]

    The direct children of the component.

getComponent

  • getComponent<U>(...componentNames: string[]): U | undefined
  • getComponent(): this

  • Looks up for a nested component.

    Type parameters

    Parameters

    • Rest ...componentNames: string[]

      A lookup path.

    Returns U | undefined

  • Returns this

getComponentById

  • getComponentById<U>(id: string): U | this | undefined

  • Looks up for a nested component by its id.

    Type parameters

    Parameters

    • id: string

      A component id.

    Returns U | this | undefined

getId

  • getId(): string

  • Returns string

    The component id.

getMeta

  • Returns Meta[]

    The component meta-data collection.

getModels

  • getModels<T>(): T

  • Type parameters

    • T: ComponentModels

    Returns T

    The map of the component models.

getName

  • getName(): string

  • Returns string

    The name of the component.

getParameters

  • getParameters(): ComponentParameters

  • Returns ComponentParameters

    The parameters of the component.

getUrl

  • getUrl(): string | undefined

  • Returns string | undefined

    The link to the partial component model.