Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocumentTemplate

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

canvasWidth

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

container

containerAsFolderBase

containerAsModule

documentation

  • get (): string
  • set (newValue: string): any

excluded

  • get (): boolean
  • set (newValue: boolean): any

exportLevel

footer

  • Returns Footer | null

  • Parameters

    Returns any

header

  • Returns Header | null

  • Parameters

    Returns any

isLoadable

  • get (): boolean

isLoaded

  • get (): boolean

isReadOnly

  • get (): boolean

marginBottomInInch

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

marginLeftInInch

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

marginRightInInch

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

marginTopInInch

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

model

name

  • get (): string
  • set (newValue: string): any

pageHeight

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

pageWidth

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

ppi

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

qualifiedName

  • get (): string | null

showHeaderAndFooterOnFirstPage

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

style

  • Returns Style

  • Parameters

    Returns any

toplevels

unit

  • get (): this

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this

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

    Returns this

delete

  • delete(): void

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>

  • 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: this): void

        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

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