NavigationDocument | Mendix Model SDK

See: relevant section in reference guide

Hierarchy

ProjectDocument
- NavigationDocument

Implements

INavigationDocument

Constructors

constructor

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

Overrides 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 = "Navigation$NavigationDocument"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

container

get container(): TContainer

Implementation of INavigationDocument.container
Inherited from projects.ProjectDocument.container

The parent unit of this unit.

Returns TContainer

containerAsProject

get containerAsProject(): Project

Implementation of INavigationDocument.containerAsProject
Overrides projects.ProjectDocument.containerAsProject
Returns Project

desktopProfile

get desktopProfile(): NavigationProfile
set desktopProfile(newValue: NavigationProfile): void

In version 7.2.0: deleted

Returns NavigationProfile
In version 7.2.0: deleted

Parameters
- newValue: NavigationProfile
Returns void

hybridPhoneProfile

get hybridPhoneProfile(): NavigationProfile
set hybridPhoneProfile(newValue: NavigationProfile): void

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 void

hybridPhoneProfile6

get hybridPhoneProfile6(): NavigationProfile
set hybridPhoneProfile6(newValue: NavigationProfile): void

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 void

hybridTabletProfile

get hybridTabletProfile(): NavigationProfile
set hybridTabletProfile(newValue: NavigationProfile): void

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 void

hybridTabletProfile6

get hybridTabletProfile6(): NavigationProfile
set hybridTabletProfile6(newValue: NavigationProfile): void

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 void

isLoadable

get isLoadable(): boolean

Implementation of INavigationDocument.isLoadable
Inherited from projects.ProjectDocument.isLoadable

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

Returns boolean

isLoaded

get isLoaded(): boolean

Implementation of INavigationDocument.isLoaded
Inherited from projects.ProjectDocument.isLoaded

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

Returns boolean

isReadOnly

get isReadOnly(): boolean

Implementation of INavigationDocument.isReadOnly
Inherited from projects.ProjectDocument.isReadOnly

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

Returns boolean

model

get model(): TModel

Implementation of INavigationDocument.model
Inherited from projects.ProjectDocument.model
Returns TModel

offlinePhoneProfile

get offlinePhoneProfile(): NavigationProfile
set offlinePhoneProfile(newValue: NavigationProfile): void

In version 7.0.2: deleted

Returns NavigationProfile
In version 7.0.2: deleted

Parameters
- newValue: NavigationProfile
Returns void

phoneProfile

get phoneProfile(): NavigationProfile
set phoneProfile(newValue: NavigationProfile): void

In version 7.2.0: deleted

Returns NavigationProfile
In version 7.2.0: deleted

Parameters
- newValue: NavigationProfile
Returns void

profiles

get profiles(): IList<NavigationProfileBase>

Implementation of INavigationDocument.profiles

In version 7.2.0: introduced

Returns IList<NavigationProfileBase>

tabletProfile

get tabletProfile(): NavigationProfile
set tabletProfile(newValue: NavigationProfile): void

In version 7.2.0: deleted

Returns NavigationProfile
In version 7.2.0: deleted

Parameters
- newValue: NavigationProfile
Returns void

unit

get unit(): this

Implementation of INavigationDocument.unit
Inherited from projects.ProjectDocument.unit

Unit that owns/contains this thing.

Returns this

Methods

allProperties

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

Implementation of INavigationDocument.allProperties
Inherited from ProjectDocument.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): NavigationDocument

Implementation of INavigationDocument.asLoaded
Inherited from ProjectDocument.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 NavigationDocument

delete

delete(): void

Implementation of INavigationDocument.delete
Inherited from ProjectDocument.delete

Deletes this element from the model.

Returns void

findElementById

findElementById(id: string): null | AbstractElement<IAbstractModel, Container>

Implementation of INavigationDocument.findElementById
Inherited from ProjectDocument.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns null | AbstractElement<IAbstractModel, Container>

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from ProjectDocument.getContainerAs
Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: (elem: NavigationDocument) => void, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise<NavigationDocument>

Implementation of INavigationDocument.load
Inherited from ProjectDocument.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: (elem: NavigationDocument) => void
  - - (elem: NavigationDocument): void
    - Parameters
      - elem: NavigationDocument
      Returns void
- Optional forceRefresh: boolean
Returns void
Implementation of INavigationDocument.load
Inherited from ProjectDocument.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<NavigationDocument>

loadedProperties

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

Implementation of INavigationDocument.loadedProperties
Inherited from ProjectDocument.loadedProperties

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

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of INavigationDocument.publicProperties
Inherited from ProjectDocument.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IAbstractElementJson

Implementation of INavigationDocument.toJSON
Inherited from ProjectDocument.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 IAbstractElementJson

traverse

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

Implementation of INavigationDocument.traverse
Inherited from ProjectDocument.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

Implementation of INavigationDocument.traverseFind
Inherited from ProjectDocument.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

Implementation of INavigationDocument.traversePublicParts
Inherited from ProjectDocument.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

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

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

model: AbstractModel

structureTypeName: string

id: string

isPartial: boolean

container: IProject

Returns NavigationDocument

Properties

id

structureTypeName

Static structureTypeName

Static versionInfo

Accessors

container

Returns TContainer

containerAsProject

Returns Project

desktopProfile

Returns NavigationProfile

Parameters

newValue: NavigationProfile

Returns void

hybridPhoneProfile

Returns NavigationProfile

Parameters

newValue: NavigationProfile

Returns void

hybridPhoneProfile6

Returns NavigationProfile

Parameters

newValue: NavigationProfile

Returns void

hybridTabletProfile

Returns NavigationProfile

Parameters

newValue: NavigationProfile

Returns void

hybridTabletProfile6

Returns NavigationProfile

Parameters

newValue: NavigationProfile

Returns void

isLoadable

Returns boolean

isLoaded

Returns boolean

isReadOnly

Returns boolean

model

Returns TModel

offlinePhoneProfile

Returns NavigationProfile

Parameters

newValue: NavigationProfile

Returns void

phoneProfile

Returns NavigationProfile

Parameters

newValue: NavigationProfile

Returns void

profiles

Returns IList<NavigationProfileBase>

tabletProfile

Returns NavigationProfile

Parameters

newValue: NavigationProfile

Returns void

unit

Returns this

Methods

allProperties