Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDocument

Hierarchy

Implemented by

Index

Properties

container

container: IStructuralUnit

containerAsFolderBase

containerAsFolderBase: IFolderBase

containerAsModule

containerAsModule: IModule

id

id: string

isLoadable

isLoadable: boolean

Whether this unit and all of its children (recursively) can be loaded.

isLoaded

isLoaded: boolean

Whether this unit has been completely loaded and does not consist of the unit's interface (which corresponds to the unit being partial).

isReadOnly

isReadOnly: boolean

Whether this unit and all of its children (recursively) are editable.

model

model: IModel

name

name: string

qualifiedName

qualifiedName: string | null

Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

structureTypeName

structureTypeName: string

unit

Unit that owns/contains this thing.

Methods

allProperties

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

asLoaded

delete

  • delete(): void

load

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

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]
  • Returns all properties when this structure is loaded, otherwise just the public properties.

    Returns AbstractProperty<any, any>[]

publicProperties

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

toJSON

  • toJSON(): object
  • 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: function): void
  • 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

    Returns void

traverseFind

  • traverseFind<T>(visit: function): T | null
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Generated using TypeDoc