Class Module

See: relevant section in reference guide

Hierarchy

FolderBase

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

Overwrites FolderBase.constructor

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

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

appStoreGuid

get (): string
set (newValue: string): any

Returns string
Parameters
- newValue: string
Returns any

appStorePackageId

get (): number
set (newValue: number): any

In version 8.13.0: introduced

Returns number
In version 8.13.0: introduced

Parameters
- newValue: number
Returns any

appStoreVersion

get (): string
set (newValue: string): any

Returns string
Parameters
- newValue: string
Returns any

appStoreVersionGuid

get (): string
set (newValue: string): any

Returns string
Parameters
- newValue: string
Returns any

container

get (): StructuralUnit

Inherited from AbstractUnit.container

Returns StructuralUnit

containerAsFolderBase

get (): FolderBase

Inherited from FolderBase.containerAsFolderBase

Returns FolderBase

containerAsProject

get (): Project

Overwrites FolderBase.containerAsProject

Returns Project

documents

get (): IList<IDocument>

Inherited from FolderBase.documents

Returns IList<IDocument>

domainModel

get (): IDomainModel
set (newValue: IDomainModel): any

Returns IDomainModel
Parameters
- newValue: IDomainModel
Returns any

exportLevel

get (): ModuleExportLevel
set (newValue: ModuleExportLevel): any

In version 9.8.0: deleted In version 9.3.0: introduced

Returns ModuleExportLevel
In version 9.8.0: deleted In version 9.3.0: introduced

Parameters
- newValue: ModuleExportLevel
Returns any

folders

get (): IList<IFolder>

Inherited from FolderBase.folders

Returns IList<IFolder>

fromAppStore

get (): boolean
set (newValue: boolean): any

Returns boolean
Parameters
- newValue: boolean
Returns any

isLoadable

get (): boolean

Inherited from AbstractUnit.isLoadable

Returns boolean

isLoaded

get (): boolean

Inherited from AbstractUnit.isLoaded

Overwrites Structure.isLoaded

Checks whether all attributes are available at this instant; if false, a load is required to access these properties.

Returns boolean

isReadOnly

get (): boolean

Inherited from AbstractUnit.isReadOnly

Returns boolean

isReusableComponent

get (): boolean
set (newValue: boolean): any

In version 9.1.0: deleted In version 8.5.0: introduced

Returns boolean
In version 9.1.0: deleted In version 8.5.0: introduced

Parameters
- newValue: boolean
Returns any

isThemeModule

get (): boolean
set (newValue: boolean): any

In version 9.3.0: introduced

Returns boolean
In version 9.3.0: introduced

Parameters
- newValue: boolean
Returns any

model

get (): IModel

Inherited from AbstractUnit.model

Returns IModel

moduleSecurity

get (): IModuleSecurity
set (newValue: IModuleSecurity): any

Returns IModuleSecurity
Parameters
- newValue: IModuleSecurity
Returns any

moduleSettings

get (): IModuleSettings
set (newValue: IModuleSettings): any

In version 9.8.0: introduced

Returns IModuleSettings
In version 9.8.0: introduced

Parameters
- newValue: IModuleSettings
Returns any

name

get (): string
set (newValue: string): any

Returns string
Parameters
- newValue: string
Returns any

sortIndex

get (): number
set (newValue: number): any

The index of where this Module appears in the project. This property is required, and of type double. Also, its value needs to be unique among its siblings (meaning, in code: containerAsProject.modules) in the project. In other words: containerAsProject.modules.map(m => m.sortedIndex) (TS syntax) needs to be a list with unique values.

Returns number
The index of where this Module appears in the project. This property is required, and of type double. Also, its value needs to be unique among its siblings (meaning, in code: containerAsProject.modules) in the project. In other words: containerAsProject.modules.map(m => m.sortedIndex) (TS syntax) needs to be a list with unique values.

Parameters
- newValue: number
Returns any

unit

get (): this

Inherited from StructuralUnit.unit

Overwrites AbstractUnit.unit

Returns this

Methods

allProperties

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

Implementation of IModule.allProperties

Inherited from AbstractUnit.allProperties

Returns AbstractProperty<any, any>[]

deepCopyInto

deepCopyInto(newParent: IStructuralUnit): AbstractUnit

Inherited from StructuralUnit.deepCopyInto

Overwrites AbstractUnit.deepCopyInto

Parameters
- newParent: IStructuralUnit
Returns AbstractUnit

delete

delete(): void

Implementation of IModule.delete

Inherited from StructuralUnit.delete

Overwrites AbstractUnit.delete

Returns void

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from AbstractUnit.getContainerAs

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

loadedProperties

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

Implementation of IModule.loadedProperties

Inherited from AbstractUnit.loadedProperties

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of IModule.publicProperties

Inherited from AbstractUnit.publicProperties

Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IAbstractElementJson

Implementation of IModule.toJSON

Inherited from StructuralUnit.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): Module

Creates a new Module unit in the SDK and on the server. Expects one argument, the IProject in which this unit is contained.

Parameters
- container: IProject
Returns Module

Generated using TypeDoc