Class NavigationDocument

See: relevant section in reference guide

Hierarchy

ProjectDocument

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new NavigationDocument(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, container: IProject): NavigationDocument

Overwrites ProjectDocument.constructor

Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- container: IProject
Returns NavigationDocument

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

container

get (): StructuralUnit

Inherited from AbstractUnit.container

Returns StructuralUnit

containerAsProject

get (): Project

Overwrites ProjectDocument.containerAsProject

Returns Project

desktopProfile

get (): NavigationProfile
set (newValue: NavigationProfile): any

In version 7.2.0: deleted

Returns NavigationProfile
In version 7.2.0: deleted

Parameters
- newValue: NavigationProfile
Returns any

hybridPhoneProfile

get (): NavigationProfile
set (newValue: NavigationProfile): any

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
- newValue: NavigationProfile
Returns any

hybridPhoneProfile6

get (): NavigationProfile
set (newValue: NavigationProfile): any

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
- newValue: NavigationProfile
Returns any

hybridTabletProfile

get (): NavigationProfile
set (newValue: NavigationProfile): any

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
- newValue: NavigationProfile
Returns any

hybridTabletProfile6

get (): NavigationProfile
set (newValue: NavigationProfile): any

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
- newValue: NavigationProfile
Returns any

isLoadable

get (): boolean

Inherited from ModelUnit.isLoadable

Returns boolean

isLoaded

get (): boolean

Inherited from ModelUnit.isLoaded

Overwrites AbstractElement.isLoaded

Returns boolean

isReadOnly

get (): boolean

Inherited from ModelUnit.isReadOnly

Returns boolean

model

get (): IModel

Inherited from AbstractUnit.model

Returns IModel

offlinePhoneProfile

get (): NavigationProfile
set (newValue: NavigationProfile): any

In version 7.0.2: deleted

Returns NavigationProfile
In version 7.0.2: deleted

Parameters
- newValue: NavigationProfile
Returns any

phoneProfile

get (): NavigationProfile
set (newValue: NavigationProfile): any

In version 7.2.0: deleted

Returns NavigationProfile
In version 7.2.0: deleted

Parameters
- newValue: NavigationProfile
Returns any

profiles

get (): IList<NavigationProfileBase>

In version 7.2.0: introduced

Returns IList<NavigationProfileBase>

tabletProfile

get (): NavigationProfile
set (newValue: NavigationProfile): any

In version 7.2.0: deleted

Returns NavigationProfile
In version 7.2.0: deleted

Parameters
- newValue: NavigationProfile
Returns any

unit

get (): this

Inherited from ModelUnit.unit

Overwrites AbstractUnit.unit

Returns this

Methods

allProperties

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

Implementation of INavigationDocument.allProperties

Inherited from AbstractUnit.allProperties

Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): this

Implementation of INavigationDocument.asLoaded

Inherited from ModelUnit.asLoaded
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

Implementation of INavigationDocument.delete

Inherited from ModelUnit.delete

Overwrites AbstractElement.delete

Deletes this element from the model.

Returns void

findElementById

findElementById(id: string): AbstractElement | null

Implementation of INavigationDocument.findElementById

Inherited from ModelUnit.findElementById

Overwrites AbstractElement.findElementById

Parameters
- id: string
Returns AbstractElement | null

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from AbstractUnit.getContainerAs

Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

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

Inherited from ModelUnit.load
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
Implementation of INavigationDocument.load

Inherited from ModelUnit.load

Parameters
- Optional forceRefresh: undefined | false | true
Returns Promise<this>

loadedProperties

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

Implementation of INavigationDocument.loadedProperties

Inherited from AbstractUnit.loadedProperties

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of INavigationDocument.publicProperties

Inherited from AbstractUnit.publicProperties

Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IAbstractElementJson

Implementation of INavigationDocument.toJSON

Inherited from ModelUnit.toJSON

Overwrites AbstractUnit.toJSON

Returns IAbstractElementJson

traverse

traverse(visit: function): void

Inherited from AbstractUnit.traverse

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

traverseFind<T>(visit: function): T | null

Inherited from AbstractUnit.traverseFind

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

traversePublicParts

traversePublicParts(visit: function): void

Inherited from AbstractUnit.traversePublicParts

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static createIn

createIn(container: IProject): NavigationDocument

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
- container: IProject
Returns NavigationDocument

Generated using TypeDoc