Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Module

Hierarchy

Implements

Index

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

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

containerAsFolderBase

containerAsProject

documents

domainModel

folders

fromAppStore

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

  • Parameters

    • newValue: boolean

    Returns any

isLoadable

  • get (): boolean

isLoaded

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

    Returns boolean

isReadOnly

  • get (): boolean

isReusableComponent

  • get (): boolean
  • set (newValue: boolean): any
  • In version 8.5.0: introduced

    Returns boolean

  • In version 8.5.0: introduced

    Parameters

    • newValue: boolean

    Returns any

model

moduleSecurity

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

Methods

allProperties

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

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

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

loadedProperties

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

publicProperties

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

toJSON

traverse

  • traverse(visit: function): void

traverseFind

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

traversePublicParts

  • traversePublicParts(visit: function): 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