Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GlyphIcon

Hierarchy

Implements

Index

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

code

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

  • Parameters

    • newValue: number

    Returns any

container

containerAsBottomBarItem

containerAsButton

containerAsControlBarButton

containerAsMenuItem

containerAsWidgetValue

isLoaded

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

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

    Returns boolean

model

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

Static createInBottomBarItemUnderIcon

  • Creates and returns a new GlyphIcon instance in the SDK and on the server. The new GlyphIcon will be automatically stored in the 'icon' property of the parent nativepages.BottomBarItem 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 GlyphIcon

Static createInButtonUnderIcon

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

    Parameters

    Returns GlyphIcon

Static createInControlBarButtonUnderIcon

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

    Parameters

    Returns GlyphIcon

Static createInMenuItemUnderIcon

  • Creates and returns a new GlyphIcon instance in the SDK and on the server. The new GlyphIcon will be automatically stored in the 'icon' property of the parent menus.MenuItem element passed as argument.

    Parameters

    Returns GlyphIcon

Static createInWidgetValueUnderIcon

  • Creates and returns a new GlyphIcon instance in the SDK and on the server. The new GlyphIcon will be automatically stored in the 'icon' property of the parent customwidgets.WidgetValue 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 GlyphIcon

Generated using TypeDoc