Options
All
  • Public
  • Public/Protected
  • All
Menu

Module api/registry/layout

Index

Type aliases

Functions

Type aliases

LayoutCapabilities

LayoutCapabilities: { hasTaskPane: boolean }

Capabilities of a viewer layout template

since

0.14

Type declaration

  • Readonly hasTaskPane: boolean

    Indicates if this viewer layout template has a task pane

LayoutFactory

LayoutFactory: () => JSX.Element

Type declaration

    • (): JSX.Element

    • A react layout template component factory function signature

      Returns JSX.Element

Functions

getLayout

  • Gets the registerd react layout template component factory function for the given template name

    export

    Parameters

    • name: string

    Returns LayoutFactory

getLayoutCapabilities

  • Gets the capabilities of the given layout template

    since

    0.14

    Parameters

    • name: string

    Returns LayoutCapabilities | undefined

registerLayout

  • Register the given react layout template component factory function for the given template name

    export
    since

    0.14

    Parameters

    Returns void

Generated using TypeDoc