Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NavigationDocument

Hierarchy

Implements

Index

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

container

containerAsProject

desktopProfile

hybridPhoneProfile

  • In version 7.2.0: deleted In version 7.0.2: introduced

    Returns NavigationProfile

  • In version 7.2.0: deleted In version 7.0.2: introduced

    Parameters

    Returns any

hybridPhoneProfile6

  • In version 7.0.0: deleted In version 6.10.4: introduced

    Returns NavigationProfile

  • In version 7.0.0: deleted In version 6.10.4: introduced

    Parameters

    Returns any

hybridTabletProfile

  • In version 7.2.0: deleted In version 7.0.2: introduced

    Returns NavigationProfile

  • In version 7.2.0: deleted In version 7.0.2: introduced

    Parameters

    Returns any

hybridTabletProfile6

  • In version 7.0.0: deleted In version 6.10.4: introduced

    Returns NavigationProfile

  • In version 7.0.0: deleted In version 6.10.4: introduced

    Parameters

    Returns any

isLoadable

  • get (): boolean

isLoaded

  • get (): boolean

isReadOnly

  • get (): boolean

model

offlinePhoneProfile

phoneProfile

profiles

tabletProfile

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 NavigationDocument unit in the SDK and on the server. Expects one argument, the projects.IProject in which this unit is contained.

    Parameters

    Returns NavigationDocument

Generated using TypeDoc