Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocumentTemplate

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___canvasWidth

___canvasWidth: any

Private ___footer

___footer: any

Private ___header

___header: any

Private ___marginBottomInInch

___marginBottomInInch: any

Private ___marginLeftInInch

___marginLeftInInch: any

Private ___marginRightInInch

___marginRightInInch: any

Private ___marginTopInInch

___marginTopInInch: any

Private ___pageHeight

___pageHeight: any

Private ___pageWidth

___pageWidth: any

Private ___ppi

___ppi: any

Private ___showHeaderAndFooterOnFirstPage

___showHeaderAndFooterOnFirstPage: any

Private ___style

___style: any

Private ___toplevels

___toplevels: any

canvasWidth

canvasWidth: number

container

container: StructuralUnit

containerAsFolderBase

containerAsFolderBase: FolderBase

containerAsModule

containerAsModule: Module

documentation

documentation: string

excluded

excluded: boolean

footer

footer: Footer

header

header: Header

id

id: string

isLoaded

isLoaded: boolean

marginBottomInInch

marginBottomInInch: number

marginLeftInInch

marginLeftInInch: number

marginRightInInch

marginRightInInch: number

marginTopInInch

marginTopInInch: number

model

model: IModel

moduleName

moduleName: string

Returns the module name of the model unit, which is the first section of the qualified name.

name

name: string

pageHeight

pageHeight: string

pageWidth

pageWidth: string

ppi

ppi: number

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

showHeaderAndFooterOnFirstPage

showHeaderAndFooterOnFirstPage: boolean

style

style: Style

toplevels

toplevels: IList<Widget>

typeName

typeName: string

unit

unit:

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

findElementById

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

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

    Type parameters

    Parameters

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

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

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