Class Appearance

In version 8.0.0: introduced

Hierarchy

Element<IModel>

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Appearance(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit, container: AbstractElement): Appearance

Overwrites Element.constructor

Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit
- container: AbstractElement
Returns Appearance

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

class

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

Returns string
Parameters
- newValue: string
Returns any

container

get (): AbstractElement

Inherited from AbstractUnit.container

Returns AbstractElement

containerAsControlBarButton

get (): ControlBarButton

Returns ControlBarButton

containerAsGridColumn

get (): GridColumn

Returns GridColumn

containerAsLayout

get (): Layout

Returns Layout

containerAsLayoutGridColumn

get (): LayoutGridColumn

Returns LayoutGridColumn

containerAsLayoutGridRow

get (): LayoutGridRow

Returns LayoutGridRow

containerAsNavigationListItem

get (): NavigationListItem

Returns NavigationListItem

containerAsPage

get (): Page

Returns Page

containerAsPageTemplate

get (): PageTemplate

Returns PageTemplate

containerAsScrollContainerRegion

get (): ScrollContainerRegion

Returns ScrollContainerRegion

containerAsTableCell

get (): TableCell

Returns TableCell

containerAsTableRow

get (): TableRow

Returns TableRow

containerAsWidget

get (): Widget

Returns Widget

designProperties

get (): IList<DesignPropertyValue>

Returns IList<DesignPropertyValue>

dynamicClasses

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

The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

In version 8.13.0: introduced

Returns string
The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

In version 8.13.0: introduced

Parameters
- newValue: string
Returns any

isLoaded

get (): boolean

Inherited from Element.isLoaded

Overwrites AbstractElement.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

model

get (): IModel

Inherited from AbstractUnit.model

Returns IModel

style

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

Returns string
Parameters
- newValue: string
Returns any

unit

get (): ModelUnit<IAbstractModel>

Inherited from Element.unit

Overwrites AbstractUnit.unit

Returns ModelUnit<IAbstractModel>

Methods

allProperties

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

Implementation of IElement.allProperties

Inherited from AbstractUnit.allProperties

Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): this

Implementation of IElement.asLoaded

Inherited from ModelUnit.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 this

deepCopy

deepCopy(targetModel: IAbstractModel): this

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns this

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): object

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 object
- copy: Element
- idMap: IMap<Structure>

delete

delete(): void

Inherited from AbstractElement.delete

Overwrites AbstractUnit.delete

Deletes this element from the model.

Returns void

detach

detach(): this

Inherited from Element.detach

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

Returns this

findElementById

findElementById(id: string): AbstractElement | null

Implementation of IElement.findElementById

Inherited from AbstractElement.findElementById

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

Parameters
- id: string
Returns AbstractElement | null

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from AbstractUnit.getContainerAs

Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: function, forceRefresh?: undefined | false | true): void
load(forceRefresh?: undefined | false | true): Promise<this>

Inherited from ModelUnit.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: function
  - - (elem: this): void
    - Parameters
      - elem: this
      Returns void
- Optional forceRefresh: undefined | false | true
Returns void
Implementation of IElement.load

Inherited from ModelUnit.load

Parameters
- Optional forceRefresh: undefined | false | true
Returns Promise<this>

loadedProperties

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

Implementation of IElement.loadedProperties

Inherited from AbstractUnit.loadedProperties

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of IElement.publicProperties

Inherited from AbstractUnit.publicProperties

Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Implementation of IElement.toJSON

Inherited from AbstractUnit.toJSON

Returns IStructureJSON

traverse

traverse(visit: function): void

Inherited from AbstractUnit.traverse

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

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

Inherited from AbstractUnit.traverseFind

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

traversePublicParts

traversePublicParts(visit: function): void

Inherited from AbstractUnit.traversePublicParts

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): Appearance

Creates and returns a new Appearance 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 Appearance

Static createInControlBarButtonUnderAppearance

createInControlBarButtonUnderAppearance(container: ControlBarButton): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: ControlBarButton
Returns Appearance

Static createInGridColumnUnderAppearance

createInGridColumnUnderAppearance(container: GridColumn): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: GridColumn
Returns Appearance

Static createInLayoutGridColumnUnderAppearance

createInLayoutGridColumnUnderAppearance(container: LayoutGridColumn): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: LayoutGridColumn
Returns Appearance

Static createInLayoutGridRowUnderAppearance

createInLayoutGridRowUnderAppearance(container: LayoutGridRow): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: LayoutGridRow
Returns Appearance

Static createInLayoutUnderAppearance

createInLayoutUnderAppearance(container: Layout): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: Layout
Returns Appearance

Static createInNavigationListItemUnderAppearance

createInNavigationListItemUnderAppearance(container: NavigationListItem): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: NavigationListItem
Returns Appearance

Static createInPageTemplateUnderAppearance

createInPageTemplateUnderAppearance(container: PageTemplate): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: PageTemplate
Returns Appearance

Static createInPageUnderAppearance

createInPageUnderAppearance(container: Page): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: Page
Returns Appearance

Static createInScrollContainerRegionUnderAppearance

createInScrollContainerRegionUnderAppearance(container: ScrollContainerRegion): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: ScrollContainerRegion
Returns Appearance

Static createInTableCellUnderAppearance

createInTableCellUnderAppearance(container: TableCell): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: TableCell
Returns Appearance

Static createInTableRowUnderAppearance

createInTableRowUnderAppearance(container: TableRow): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: TableRow
Returns Appearance

Static createInWidgetUnderAppearance

createInWidgetUnderAppearance(container: Widget): Appearance

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

Warning! Can only be used on models with the following Mendix meta model versions: 8.0.0 and higher

Parameters
- container: Widget
Returns Appearance

Generated using TypeDoc