Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocumentTemplate

Hierarchy

Implements

Index

Constructors

constructor

Properties

canvasWidth

canvasWidth: number

container

container: StructuralUnit

containerAsFolderBase

containerAsFolderBase: FolderBase

containerAsModule

containerAsModule: Module

documentation

documentation: string

excluded

excluded: boolean

footer

footer: Footer | null

header

header: Header | null

id

id: string

isLoaded

isLoaded: boolean

marginBottomInInch

marginBottomInInch: number

marginLeftInInch

marginLeftInInch: number

marginRightInInch

marginRightInInch: number

marginTopInInch

marginTopInInch: number

model

model: IModel

name

name: string

pageHeight

pageHeight: string

pageWidth

pageWidth: string

ppi

ppi: number

qualifiedName

qualifiedName: string | null

showHeaderAndFooterOnFirstPage

showHeaderAndFooterOnFirstPage: boolean

structureTypeName

structureTypeName: string

style

style: Style

toplevels

toplevels: IList<Widget>

unit

unit:

Static structureTypeName

structureTypeName: string

Static versionInfo

Methods

allProperties

asLoaded

  • asLoaded()
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

delete

  • delete(): void

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    • callback: function
        • (elem: ): void
        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Static createIn

  • Creates a new DocumentTemplate unit in the SDK and on the server. Expects one argument, the projects.IFolderBase in which this unit is contained.

    Parameters

    Returns DocumentTemplate

Generated using TypeDoc