Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomWidgetType

Hierarchy

Implements

Index

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

container

containerAsCustomWidget

description

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

  • Parameters

    • newValue: string

    Returns any

experimentalApi

  • get (): boolean
  • set (newValue: boolean): any
  • In version 7.1.0: deleted In version 7.0.0: introduced

    Returns boolean

  • In version 7.1.0: deleted In version 7.0.0: introduced

    Parameters

    • newValue: boolean

    Returns any

helpUrl

  • get (): string
  • set (newValue: string): any
  • In version 8.3.0: introduced

    Returns string

  • In version 8.3.0: introduced

    Parameters

    • newValue: string

    Returns any

isLoaded

  • get (): boolean
  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

labeled

  • get (): boolean
  • set (newValue: boolean): any
  • In version 8.0.0: deleted In version 7.23.0: introduced

    Returns boolean

  • In version 8.0.0: deleted In version 7.23.0: introduced

    Parameters

    • newValue: boolean

    Returns any

model

name

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

  • Parameters

    • newValue: string

    Returns any

needsEntityContext

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

  • Parameters

    • newValue: boolean

    Returns any

objectType

offlineCapable

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

  • Parameters

    • newValue: boolean

    Returns any

phoneGapEnabled

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

  • Parameters

    • newValue: boolean

    Returns any

pluginWidget

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

    Returns boolean

  • In version 7.19.0: introduced

    Parameters

    • newValue: boolean

    Returns any

supportedPlatform

unit

widgetId

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

  • Parameters

    • newValue: string

    Returns any

Methods

allProperties

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

asLoaded

  • asLoaded(): this
  • 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 this

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this
  • Detaches this element from the model, so that it can be attached in a different place.

    Returns this

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>
  • 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: function
        • (elem: this): void
        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

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 create

  • Creates and returns a new CustomWidgetType instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    Returns CustomWidgetType

Static createIn

  • Creates and returns a new CustomWidgetType instance in the SDK and on the server. The new CustomWidgetType will be automatically stored in the 'type' property of the parent CustomWidget element passed as argument.

    Parameters

    Returns CustomWidgetType

Generated using TypeDoc