Appearance | Mendix Model SDK

In version 8.0.0: introduced

Hierarchy

Element<IModel>
- Appearance

Index

Constructors

constructor

Properties

Constructors

constructor

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

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

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Pages$Appearance"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

class

get class(): string
set class(newValue: string): void

Returns string
Parameters
- newValue: string
Returns void

container

get container(): TContainer

Inherited from internal.Element.container
Returns TContainer

containerAsControlBarButton

get containerAsControlBarButton(): ControlBarButton

Returns ControlBarButton

containerAsGridColumn

get containerAsGridColumn(): GridColumn

Returns GridColumn

containerAsLayout

get containerAsLayout(): Layout

Returns Layout

containerAsLayoutGridColumn

get containerAsLayoutGridColumn(): LayoutGridColumn

Returns LayoutGridColumn

containerAsLayoutGridRow

get containerAsLayoutGridRow(): LayoutGridRow

Returns LayoutGridRow

containerAsNavigationListItem

get containerAsNavigationListItem(): NavigationListItem

Returns NavigationListItem

containerAsPage

get containerAsPage(): Page

Returns Page

containerAsPageTemplate

get containerAsPageTemplate(): PageTemplate

Returns PageTemplate

containerAsScrollContainerRegion

get containerAsScrollContainerRegion(): ScrollContainerRegion

Returns ScrollContainerRegion

containerAsTableCell

get containerAsTableCell(): pages.TableCell

Returns pages.TableCell

containerAsTableRow

get containerAsTableRow(): pages.TableRow

Returns pages.TableRow

containerAsWidget

get containerAsWidget(): pages.Widget

Returns pages.Widget

designProperties

get designProperties(): IList<DesignPropertyValue>

Returns IList<DesignPropertyValue>

dynamicClasses

get dynamicClasses(): string
set dynamicClasses(newValue: string): void

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 void

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

model

get model(): TModel

Inherited from internal.Element.model
Returns TModel

style

get style(): string
set style(newValue: string): void

Returns string
Parameters
- newValue: string
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(): Appearance

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 Appearance

deepCopy

deepCopy(targetModel: IAbstractModel): Appearance

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns Appearance

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(): Appearance

Inherited from Element.detach

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

Returns Appearance

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: Appearance) => void, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise<Appearance>

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

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): 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: pages.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: pages.TableCell
Returns Appearance

Static createInTableRowUnderAppearance

createInTableRowUnderAppearance(container: pages.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: pages.TableRow
Returns Appearance

Static createInWidgetUnderAppearance

createInWidgetUnderAppearance(container: pages.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: pages.Widget
Returns Appearance

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

model: AbstractModel

structureTypeName: string

id: string

isPartial: boolean

unit: ModelUnit<IAbstractModel>

container: AbstractElement<IAbstractModel, Container>

Returns Appearance

Properties

id

structureTypeName

Static structureTypeName

Static versionInfo

Accessors

class

Returns string

Parameters

newValue: string

Returns void

container

Returns TContainer

containerAsControlBarButton

Returns ControlBarButton

containerAsGridColumn

Returns GridColumn

containerAsLayout

Returns Layout

containerAsLayoutGridColumn

Returns LayoutGridColumn

containerAsLayoutGridRow

Returns LayoutGridRow

containerAsNavigationListItem

Returns NavigationListItem

containerAsPage

Returns Page

containerAsPageTemplate

Returns PageTemplate

containerAsScrollContainerRegion

Returns ScrollContainerRegion

containerAsTableCell

Returns pages.TableCell

containerAsTableRow

Returns pages.TableRow

containerAsWidget

Returns pages.Widget

designProperties

Returns IList<DesignPropertyValue>

dynamicClasses

Returns string

Parameters

newValue: string

Returns void

isLoaded

Returns boolean

model

Returns TModel

style

Returns string

Parameters

newValue: string

Returns void

unit

Returns ModelUnit<IAbstractModel>

Methods

allProperties

Returns AbstractProperty<any, any>[]

asLoaded

Returns Appearance

deepCopy

Parameters

targetModel: IAbstractModel

Returns Appearance