Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Module

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Projects$Module"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

appStoreGuid

  • get appStoreGuid(): string
  • set appStoreGuid(newValue: string): void

appStorePackageId

  • get appStorePackageId(): number
  • set appStorePackageId(newValue: number): void

  • In version 11.0.0: deleted In version 8.13.0: introduced

    Returns number

  • In version 11.0.0: deleted In version 8.13.0: introduced

    Parameters

    • newValue: number

    Returns void

appStorePackageIdString

  • get appStorePackageIdString(): string
  • set appStorePackageIdString(newValue: string): void

appStoreVersion

  • get appStoreVersion(): string
  • set appStoreVersion(newValue: string): void

appStoreVersionGuid

  • get appStoreVersionGuid(): string
  • set appStoreVersionGuid(newValue: string): void

container

  • get container(): TContainer

  • The parent unit of this unit.

    Returns TContainer

containerAsFolderBase

containerAsProject

documents

domainModel

exportLevel

folders

fromAppStore

  • get fromAppStore(): boolean
  • set fromAppStore(newValue: boolean): void

isLoadable

  • get isLoadable(): boolean

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

    Returns boolean

isLoaded

  • get isLoaded(): boolean

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

    Returns boolean

isReadOnly

  • get isReadOnly(): boolean

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

    Returns boolean

isReusableComponent

  • get isReusableComponent(): boolean
  • set isReusableComponent(newValue: boolean): void

isThemeModule

  • get isThemeModule(): boolean
  • set isThemeModule(newValue: boolean): void

model

  • get model(): TModel

  • Returns TModel

moduleSecurity

moduleSettings

name

  • get name(): string
  • set name(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

sortIndex

  • get sortIndex(): number
  • set sortIndex(newValue: number): void

  • 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 void

unit

  • get unit(): this

  • Unit that owns/contains this thing.

    Returns this

Methods

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

loadedProperties

publicProperties

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

  • 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: (structure: IStructure) => T): null | T

traversePublicParts

  • traversePublicParts(visit: (structure: IStructure) => void): void

Static createIn

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

    Parameters

    Returns Module

Generated using TypeDoc