Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Grid

Hierarchy

Implements

Index

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

appearance

  • In version 8.0.0: introduced

    Returns Appearance

  • In version 8.0.0: introduced

    Parameters

    Returns any

class

  • get (): string
  • set (newValue: string): any
  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns any

conditionalVisibilitySettings

container

containerAsBuildingBlock

containerAsDataView

containerAsDivContainer

containerAsGroupBox

containerAsHeader

containerAsLayout

containerAsLayoutCallArgument

containerAsLayoutGridColumn

containerAsListView

containerAsListViewTemplate

containerAsMasterDetailRegion

containerAsNativeLayout

containerAsNativeLayoutCallArgument

containerAsNativeLayoutContent

containerAsNavigationListItem

containerAsReportPane

containerAsScrollContainerRegion

containerAsSnippet

containerAsSplitPane

containerAsTabPage

containerAsTableCell

containerAsTemplateGridContents

containerAsVerticalFlow

containerAsWebLayoutContent

containerAsWidgetValue

controlBar

dataSource

defaultButtonTrigger

isControlBarVisible

  • 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

isPagingEnabled

  • get (): boolean
  • set (newValue: boolean): any
  • In version 8.13.0: deleted

    Returns boolean

  • In version 8.13.0: deleted

    Parameters

    • newValue: boolean

    Returns any

model

name

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

  • Parameters

    • newValue: string

    Returns any

refreshTime

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

  • Parameters

    • newValue: number

    Returns any

selectFirst

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

  • Parameters

    • newValue: boolean

    Returns any

selectionMode

showPagingBar

style

  • get (): string
  • set (newValue: string): any
  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns any

tabIndex

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

  • Parameters

    • newValue: number

    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

Generated using TypeDoc