Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "Projects$Module"
versionInfo: StructureVersionInfo = ...

Accessors

  • get appStoreGuid(): string
  • set appStoreGuid(newValue: string): void
  • 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

  • get appStorePackageIdString(): string
  • set appStorePackageIdString(newValue: string): void
  • get appStoreVersion(): string
  • set appStoreVersion(newValue: string): void
  • get appStoreVersionGuid(): string
  • set appStoreVersionGuid(newValue: string): void
  • get container(): TContainer
  • The parent unit of this unit.

    Returns TContainer

  • get fromAppStore(): boolean
  • set fromAppStore(newValue: boolean): void
  • get isLoadable(): boolean
  • Whether this unit and all of its children (recursively) can be loaded.

    Returns boolean

  • get isLoaded(): boolean
  • Checks whether all attributes are available at this instant; if false, a load is required to access these properties.

    Returns boolean

  • get isReadOnly(): boolean
  • Whether this unit and all of its children (recursively) are editable.

    Returns boolean

  • get isReusableComponent(): boolean
  • set isReusableComponent(newValue: boolean): void
  • get isThemeModule(): boolean
  • set isThemeModule(newValue: boolean): void
  • get model(): TModel
  • Returns TModel

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

  • Parameters

    • newValue: string

    Returns void

  • 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

  • get unit(): this
  • Unit that owns/contains this thing.

    Returns this

Methods

  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • 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(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<T>(visit: (structure: IStructure) => T): null | T
  • traversePublicParts(visit: (structure: IStructure) => void): void
  • 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