Interface IExcelTemplateContents

In version 11.7.0: removed experimental In version 10.15.0: added public In version 10.6.0: introduced

Hierarchy

ITemplateContents
- IExcelTemplateContents

Implemented by

ExcelTemplateContents

Index

Properties

Methods

Properties

Readonly container

container: IAbstractElement

Readonly containerAsTemplate

containerAsTemplate: ITemplate

id

id: string

isLoaded

isLoaded: boolean

Readonly model

model: IModel

Readonly sheets

sheets: IList<IExcelSheet>

In version 10.15.0: added public

structureTypeName

structureTypeName: string

unit

unit: IAbstractUnit

Unit that owns/contains this thing.

Methods

allProperties

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

Inherited from ITemplateContents.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): ExcelTemplateContents

Overrides ITemplateContents.asLoaded
Returns ExcelTemplateContents

findElementById

findElementById(id: string): null | IAbstractElement

Inherited from ITemplateContents.findElementById
Parameters
- id: string
Returns null | IAbstractElement

load

load(callback: (element: ExcelTemplateContents) => void, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise<ExcelTemplateContents>

Overrides ITemplateContents.load
Parameters
- callback: (element: ExcelTemplateContents) => void
  - - (element: ExcelTemplateContents): void
    - Parameters
      - element: ExcelTemplateContents
      Returns void
- Optional forceRefresh: boolean
Returns void
Overrides ITemplateContents.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<ExcelTemplateContents>

loadedProperties

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

Inherited from ITemplateContents.loadedProperties

Returns all properties when this structure is loaded, otherwise just the public properties.

Returns AbstractProperty<any, any>[]

publicProperties

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

Inherited from ITemplateContents.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): object

Inherited from ITemplateContents.toJSON

Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

Returns object

traverse

traverse(visit: (structure: IStructure) => void): void

Inherited from ITemplateContents.traverse

Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

traverseFind<T>(visit: (structure: IStructure) => T): null | T

Inherited from ITemplateContents.traverseFind

Traverses this structure, returning immediately when visit returns something other than null.

Type parameters
- T
Parameters
- visit: (structure: IStructure) => T
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns null | T

traversePublicParts

traversePublicParts(visit: (structure: IStructure) => void): void

Inherited from ITemplateContents.traversePublicParts

Traverses this structure, only visiting children contained in public properties.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Generated using TypeDoc