Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConditionalVisibilitySettings

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

attribute

attributeQualifiedName

  • get (): string | null

conditions

containerAsConditionallyEditableWidget

containerAsConditionallyVisibleWidget

containerAsControlBarButton

containerAsCustomWidget

containerAsLayoutGridRow

containerAsNavigationListItem

containerAsTabPage

containerAsTableRow

expression

  • get (): string
  • set (newValue: string): any
  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    In version 7.0.1: introduced

    Returns string

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

    In version 7.0.1: introduced

    Parameters

    • newValue: string

    Returns any

expressionModel

ignoreSecurity

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

  • Parameters

    • newValue: boolean

    Returns any

isLoaded

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

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

    Returns boolean

moduleRoles

moduleRolesQualifiedNames

  • get (): string[]
  • Returns string[]

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

Static createInConditionallyVisibleWidgetUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInControlBarButtonUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInCustomWidgetUnderConditionalVisibilitySettings

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

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInLayoutGridRowUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInNavigationListItemUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInTabPageUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInTableRowUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Generated using TypeDoc