Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataView

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___closeOnSaveOrCancel

___closeOnSaveOrCancel: any

Private ___controlBar

___controlBar: any

Private ___editable

___editable: any

Private ___footerWidget

___footerWidget: any

Private ___labelWidth

___labelWidth: any

Private ___noEntityMessage

___noEntityMessage: any

Private ___readOnlyStyle

___readOnlyStyle: any

Private ___showControlBar

___showControlBar: any

Private ___showFooter

___showFooter: any

Private ___useSchema

___useSchema: any

Private ___widget

___widget: any

class

class: string

closeOnSaveOrCancel

closeOnSaveOrCancel: boolean

In version 6.7.0: deleted

conditionalVisibilitySettings

conditionalVisibilitySettings: ConditionalVisibilitySettings

container

container: AbstractElement

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

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

controlBar

controlBar: DataViewControlBar

In version 6.7.0: deleted In version 6.5.0: added optional

dataSource

dataSource: DataSource

editable

editable: boolean

footerWidget

footerWidget: Widget

In version 6.7.0: introduced

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

labelWidth

labelWidth: number

model

model: IModel

name

name: string

noEntityMessage

noEntityMessage: Text

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

readOnlyStyle

readOnlyStyle: DataViewReadOnlyStyle

In version 6.9.0: introduced

showControlBar

showControlBar: boolean

In version 6.7.0: deleted

showFooter

showFooter: boolean

In version 6.7.0: introduced

style

style: string

tabIndex

tabIndex: number

typeName

typeName: string

unit

unit: ModelUnit

useSchema

useSchema: boolean

versionInfo

versionInfo: StructureVersionInfo

widget

widget: Widget

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

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

    Type parameters

    Parameters

    • callback: function
        • (elem: T): void

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new DataView 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 DataView

Static createInDataViewUnderFooterWidget

  • Creates and returns a new DataView instance in the SDK and on the server. The new DataView 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, 6.8.0, 6.9.0, 6.10.0]

    Parameters

    Returns DataView

Static createInDataViewUnderWidget

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

    Parameters

    Returns DataView

Static createInDivContainerUnderWidget

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

    Parameters

    Returns DataView

Static createInGroupBoxUnderWidget

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

    Parameters

    Returns DataView

Static createInHeaderUnderLeftWidget

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

    Parameters

    Returns DataView

Static createInHeaderUnderRightWidget

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

    Parameters

    Returns DataView

Static createInLayoutCallArgumentUnderWidget

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

    Parameters

    Returns DataView

Static createInLayoutGridColumnUnderWidget

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

    Parameters

    Returns DataView

Static createInLayoutUnderWidget

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

    Parameters

    Returns DataView

Static createInListViewTemplateUnderWidget

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

    Parameters

    Returns DataView

Static createInListViewUnderWidget

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

    Parameters

    Returns DataView

Static createInNavigationListItemUnderWidget

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

    Parameters

    Returns DataView

Static createInReportPaneUnderParameterWidget

  • Creates and returns a new DataView instance in the SDK and on the server. The new DataView 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, 6.0.1, 6.1.0, 6.2.0, 6.3.0, 6.4.0, 6.4.1, 6.5.0, 6.6.0, 6.7.0, 6.8.0, 6.9.0]

    Parameters

    Returns DataView

Static createInReportPaneUnderReportWidget

  • Creates and returns a new DataView instance in the SDK and on the server. The new DataView 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, 6.0.1, 6.1.0, 6.2.0, 6.3.0, 6.4.0, 6.4.1, 6.5.0, 6.6.0, 6.7.0, 6.8.0, 6.9.0]

    Parameters

    Returns DataView

Static createInScrollContainerRegionUnderWidget

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

    Parameters

    Returns DataView

Static createInSnippetUnderWidget

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

    Parameters

    Returns DataView

Static createInSplitPaneUnderFirstWidget

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

    Parameters

    Returns DataView

Static createInSplitPaneUnderSecondWidget

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

    Parameters

    Returns DataView

Static createInTabPageUnderWidget

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

    Parameters

    Returns DataView

Static createInTableCellUnderWidget

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

    Parameters

    Returns DataView

Static createInTemplateGridContentsUnderWidget

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

    Parameters

    Returns DataView

Static createInVerticalFlowUnderWidgets

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

    Parameters

    Returns DataView

Generated using TypeDoc