Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Appearance

In version 8.0.0: introduced

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

id

id: string

model

model: IModel

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

class

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

  • Parameters

    • newValue: string

    Returns any

containerAsControlBarButton

containerAsGridColumn

containerAsLayout

containerAsLayoutGridColumn

containerAsLayoutGridRow

containerAsNavigationListItem

containerAsPage

containerAsPageTemplate

containerAsScrollContainerRegion

containerAsTableCell

containerAsTableRow

containerAsWidget

designProperties

isLoaded

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

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

    Returns boolean

style

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

  • Parameters

    • newValue: string

    Returns any

unit

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 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

    Returns Appearance

Static createInControlBarButtonUnderAppearance

  • 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

    Returns Appearance

Static createInGridColumnUnderAppearance

  • 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

    Returns Appearance

Static createInLayoutGridColumnUnderAppearance

  • 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

    Returns Appearance

Static createInLayoutGridRowUnderAppearance

  • 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

    Returns Appearance

Static createInLayoutUnderAppearance

  • 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

    Returns Appearance

Static createInNavigationListItemUnderAppearance

  • 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

    Returns Appearance

Static createInPageTemplateUnderAppearance

  • 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

    Returns Appearance

Static createInPageUnderAppearance

  • 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

    Returns Appearance

Static createInScrollContainerRegionUnderAppearance

  • 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

    Returns Appearance

Static createInTableCellUnderAppearance

  • 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

    Returns Appearance

Static createInTableRowUnderAppearance

  • 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

    Returns Appearance

Static createInWidgetUnderAppearance

  • 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

    Returns Appearance

Generated using TypeDoc