Class WidgetObject

Hierarchy

Element<IModel>
- WidgetObject

Constructors

constructor

new WidgetObject(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit<IAbstractModel>, container: AbstractElement<IAbstractModel, Container>): WidgetObject

Overrides Element.constructor
Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit<IAbstractModel>
- container: AbstractElement<IAbstractModel, Container>
Returns WidgetObject

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "CustomWidgets$WidgetObject"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

container

get container(): TContainer

Inherited from internal.Element.container
Returns TContainer

containerAsCustomWidget

get containerAsCustomWidget(): CustomWidget

Returns CustomWidget

containerAsWidgetValue

get containerAsWidgetValue(): WidgetValue

Returns WidgetValue

isLoaded

get isLoaded(): boolean

Inherited from internal.Element.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

labelTemplate

get labelTemplate(): null | ClientTemplate
set labelTemplate(newValue: null | ClientTemplate): void

In version 8.1.0: deleted In version 7.23.0: introduced

Returns null | ClientTemplate
In version 8.1.0: deleted In version 7.23.0: introduced

Parameters
- newValue: null | ClientTemplate
Returns void

model

get model(): TModel

Inherited from internal.Element.model
Returns TModel

properties

get properties(): IList<WidgetProperty>

Returns IList<WidgetProperty>

type

get type(): null | WidgetObjectType
set type(newValue: null | WidgetObjectType): void

In version 7.13.0: added optional

Returns null | WidgetObjectType
In version 7.13.0: added optional

Parameters
- newValue: null | WidgetObjectType
Returns void

unit

get unit(): ModelUnit<IAbstractModel>

Inherited from internal.Element.unit
Returns ModelUnit<IAbstractModel>

Methods

allProperties

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

Inherited from Element.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): WidgetObject

Inherited from Element.asLoaded
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 WidgetObject

deepCopy

deepCopy(targetModel: IAbstractModel): WidgetObject

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns WidgetObject

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }

Inherited from Element.deepCopyWithIdMap

Creates a deep copy of this element and its children. Also returns a map from original to new IDs.

Parameters
- targetModel: IAbstractModel
Returns { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }
- copy: Element<IAbstractModel>
- idMap: IMap<Structure<IAbstractModel, null | IContainer>>

delete

delete(): void

Inherited from Element.delete

Deletes this element from the model.

Returns void

detach

detach(): WidgetObject

Inherited from Element.detach

Detaches this element from the model, so that it can be attached in a different place.

Returns WidgetObject

findElementById

findElementById(id: string): null | AbstractElement<IAbstractModel, Container>

Inherited from Element.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns null | AbstractElement<IAbstractModel, Container>

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from Element.getContainerAs
Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: (elem: WidgetObject) => void, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise<WidgetObject>

Inherited from Element.load
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: (elem: WidgetObject) => void
  - - (elem: WidgetObject): void
    - Parameters
      - elem: WidgetObject
      Returns void
- Optional forceRefresh: boolean
Returns void
Inherited from Element.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<WidgetObject>

loadedProperties

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

Inherited from Element.loadedProperties

Returns all properties when this structure is loaded, otherwise just the public properties.

Returns AbstractProperty<any, any>[]

publicProperties

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

Inherited from Element.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Inherited from Element.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 IStructureJSON

traverse

traverse(visit: (structure: IStructure) => void): void

Inherited from Element.traverse

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
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

traverseFind<T>(visit: (structure: IStructure) => T): null | T

Inherited from Element.traverseFind

Traverses this structure, returning immediately when visit returns something other than null.

Type parameters
- T
Parameters
- visit: (structure: IStructure) => T
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns null | T

traversePublicParts

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

Inherited from Element.traversePublicParts

Traverses this structure, only visiting children contained in public properties.

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): WidgetObject

Creates and returns a new WidgetObject 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
- model: IModel
Returns WidgetObject

Static createInCustomWidgetUnderObject

createInCustomWidgetUnderObject(container: CustomWidget): WidgetObject

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

Parameters
- container: CustomWidget
Returns WidgetObject

Static createInWidgetValueUnderObjects

createInWidgetValueUnderObjects(container: WidgetValue): WidgetObject

Creates and returns a new WidgetObject instance in the SDK and on the server. The new WidgetObject will be automatically stored in the 'objects' property of the parent WidgetValue element passed as argument.

Parameters
- container: WidgetValue
Returns WidgetObject

Generated using TypeDoc