Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataGrid

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

appearance

appearance: Appearance

In version 8.0.0: introduced

caption

In version 8.0.0: introduced

class

class: string

In version 8.0.0: deleted

columns

columns: IList<GridColumn>

conditionalVisibilitySettings

conditionalVisibilitySettings: ConditionalVisibilitySettings | null

container

container: AbstractElement

containerAsBuildingBlock

containerAsBuildingBlock: BuildingBlock

containerAsDataView

containerAsDataView: DataView

containerAsDivContainer

containerAsDivContainer: DivContainer

containerAsGroupBox

containerAsGroupBox: GroupBox

containerAsHeader

containerAsHeader: Header

containerAsLayout

containerAsLayout: Layout

containerAsLayoutCallArgument

containerAsLayoutCallArgument: LayoutCallArgument

containerAsLayoutGridColumn

containerAsLayoutGridColumn: LayoutGridColumn

containerAsListView

containerAsListView: ListView

containerAsListViewTemplate

containerAsListViewTemplate: ListViewTemplate

containerAsMasterDetailRegion

containerAsMasterDetailRegion: MasterDetailRegion

containerAsNativeLayout

containerAsNativeLayout: NativeLayout

containerAsNativeLayoutCallArgument

containerAsNativeLayoutCallArgument: NativeLayoutCallArgument

containerAsNativeLayoutContent

containerAsNativeLayoutContent: NativeLayoutContent

containerAsNavigationListItem

containerAsNavigationListItem: NavigationListItem

containerAsReportPane

containerAsReportPane: ReportPane

containerAsScrollContainerRegion

containerAsScrollContainerRegion: ScrollContainerRegion

containerAsSnippet

containerAsSnippet: Snippet

containerAsSplitPane

containerAsSplitPane: SplitPane

containerAsTabPage

containerAsTabPage: TabPage

containerAsTableCell

containerAsTableCell: TableCell

containerAsTemplateGridContents

containerAsTemplateGridContents: TemplateGridContents

containerAsVerticalFlow

containerAsVerticalFlow: VerticalFlow

containerAsWebLayoutContent

containerAsWebLayoutContent: WebLayoutContent

containerAsWidgetValue

containerAsWidgetValue: WidgetValue

controlBar

controlBar: GridControlBar

dataSource

dataSource: DataSource

defaultButtonTrigger

defaultButtonTrigger: ClickTypeType

id

id: string

isControlBarVisible

isControlBarVisible: boolean

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

isPagingEnabled

isPagingEnabled: boolean

model

model: IModel

name

name: string

numberOfRows

numberOfRows: number

refreshTime

refreshTime: number

selectFirst

selectFirst: boolean

selectionMode

selectionMode: GridSelectionMode

showEmptyRows

showEmptyRows: boolean

structureTypeName

structureTypeName: string

style

style: string

In version 8.0.0: deleted

tabIndex

tabIndex: number

tooltipPage

tooltipPage: IPage | null

tooltipPageQualifiedName

tooltipPageQualifiedName: string | null

unit

unit: ModelUnit

widthUnit

widthUnit: UnitEnum

Static structureTypeName

structureTypeName: string

Static versionInfo

Methods

allProperties

asLoaded

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

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

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise
  • 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: ): void
        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

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

Static createInBuildingBlockUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.7.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInBuildingBlockUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInDataViewUnderFooterWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.7.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInDataViewUnderFooterWidgets

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

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

    Parameters

    Returns DataGrid

Static createInDataViewUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInDataViewUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInDivContainerUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInDivContainerUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInGroupBoxUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInGroupBoxUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInHeaderUnderLeftWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInHeaderUnderLeftWidgets

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

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

    Parameters

    Returns DataGrid

Static createInHeaderUnderRightWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInHeaderUnderRightWidgets

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

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

    Parameters

    Returns DataGrid

Static createInLayoutCallArgumentUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInLayoutCallArgumentUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInLayoutGridColumnUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInLayoutGridColumnUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInLayoutUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInLayoutUnderWidgets

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 to 7.23.0

    Parameters

    Returns DataGrid

Static createInListViewTemplateUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInListViewTemplateUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInListViewUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInListViewUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInMasterDetailRegionUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.1.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInNativeLayoutCallArgumentUnderWidgets

  • Creates and returns a new DataGrid instance in the SDK and on the server. The new DataGrid will be automatically stored in the 'widgets' property of the parent nativepages.NativeLayoutCallArgument element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.23.0 to 7.23.0

    Parameters

    Returns DataGrid

Static createInNativeLayoutContentUnderWidgets

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

Static createInNativeLayoutUnderHeaderWidget

  • Creates and returns a new DataGrid instance in the SDK and on the server. The new DataGrid will be automatically stored in the 'headerWidget' property of the parent nativepages.NativeLayout element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.22.0 to 7.23.0

    Parameters

    Returns DataGrid

Static createInNativeLayoutUnderWidgets

  • Creates and returns a new DataGrid instance in the SDK and on the server. The new DataGrid will be automatically stored in the 'widgets' property of the parent nativepages.NativeLayout element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.21.0 to 7.23.0

    Parameters

    Returns DataGrid

Static createInNavigationListItemUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInNavigationListItemUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInReportPaneUnderParameterWidget

  • Creates and returns a new DataGrid instance in the SDK and on the server. The new DataGrid will be automatically stored in the 'parameterWidget' property of the parent reports.ReportPane element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 6.9.0

    Parameters

    Returns DataGrid

Static createInReportPaneUnderReportWidget

  • Creates and returns a new DataGrid instance in the SDK and on the server. The new DataGrid will be automatically stored in the 'reportWidget' property of the parent reports.ReportPane element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 6.9.0

    Parameters

    Returns DataGrid

Static createInScrollContainerRegionUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInScrollContainerRegionUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInSnippetUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInSnippetUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInSplitPaneUnderFirstWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInSplitPaneUnderFirstWidgets

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 to 7.23.0

    Parameters

    Returns DataGrid

Static createInSplitPaneUnderSecondWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInSplitPaneUnderSecondWidgets

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

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 to 7.23.0

    Parameters

    Returns DataGrid

Static createInTabPageUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInTabPageUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInTableCellUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInTableCellUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInTemplateGridContentsUnderWidget

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInTemplateGridContentsUnderWidgets

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

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

    Parameters

    Returns DataGrid

Static createInVerticalFlowUnderWidgets

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.14.0

    Parameters

    Returns DataGrid

Static createInWebLayoutContentUnderWidgets

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

Static createInWidgetValueUnderWidgets

  • Creates and returns a new DataGrid instance in the SDK and on the server. The new DataGrid will be automatically stored in the 'widgets' 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.2.0 and higher

    Parameters

    Returns DataGrid

Generated using TypeDoc