Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "Reports$BasicReport"
versionInfo: StructureVersionInfo = ...

Accessors

  • In version 8.0.0: introduced

    Returns Appearance

  • In version 8.0.0: introduced

    Parameters

    Returns void

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

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns void

  • get container(): TContainer
  • Returns TContainer

  • Returns BuildingBlock

  • Returns DivContainer

  • Returns GroupBox

  • Returns pages.Header

  • get containerAsLayout(): Layout
  • Returns Layout

  • Returns ListView

  • get containerAsMasterDetailRegion(): MasterDetailRegion
  • Returns MasterDetailRegion

  • get containerAsNativeLayout(): NativeLayout
  • Returns NativeLayout

  • get containerAsNativeLayoutCallArgument(): NativeLayoutCallArgument
  • Returns NativeLayoutCallArgument

  • Returns ReportPane

  • Returns Snippet

  • Returns SplitPane

  • Returns TabPage

  • Returns VerticalFlow

  • Returns WidgetValue

  • Returns null | IDataSet

  • Parameters

    Returns void

  • get dataSetQualifiedName(): null | string
  • Returns null | string

  • get generateOnLoad(): boolean
  • set generateOnLoad(newValue: boolean): void
  • In version 6.10.0: introduced

    Returns boolean

  • In version 6.10.0: introduced

    Parameters

    • newValue: boolean

    Returns void

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

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

    Returns boolean

  • get isPagingEnabled(): boolean
  • set isPagingEnabled(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get model(): TModel
  • Returns TModel

  • get name(): string
  • set name(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • get pageSize(): number
  • set pageSize(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get showExportButton(): boolean
  • set showExportButton(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

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

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns void

  • get tabIndex(): number
  • set tabIndex(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

Methods

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

  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • load(callback: (elem: BasicReport) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<BasicReport>
  • 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

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<BasicReport>

  • toJSON(): IStructureJSON
  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

  • traverse(visit: (structure: IStructure) => void): void
  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

  • traversePublicParts(visit: (structure: IStructure) => void): void
  • Creates and returns a new BasicReport 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

    • model: IModel

    Returns BasicReport

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • createInMasterDetailRegionUnderWidget(container: MasterDetailRegion): BasicReport
  • Creates and returns a new BasicReport instance in the SDK and on the server. The new BasicReport will be automatically stored in the 'widget' property of the parent pages.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

    • container: MasterDetailRegion

    Returns BasicReport

  • createInNativeLayoutCallArgumentUnderWidgets(container: NativeLayoutCallArgument): BasicReport
  • Creates and returns a new BasicReport instance in the SDK and on the server. The new BasicReport 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

    • container: NativeLayoutCallArgument

    Returns BasicReport

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

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

    Parameters

    Returns BasicReport

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

  • createInNativeLayoutUnderHeaderWidget(container: NativeLayout): BasicReport
  • Creates and returns a new BasicReport instance in the SDK and on the server. The new BasicReport 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

    • container: NativeLayout

    Returns BasicReport

  • createInNativeLayoutUnderWidgets(container: NativeLayout): BasicReport
  • Creates and returns a new BasicReport instance in the SDK and on the server. The new BasicReport 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

    • container: NativeLayout

    Returns BasicReport

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • Creates and returns a new BasicReport instance in the SDK and on the server. The new BasicReport 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 BasicReport

Generated using TypeDoc