Interface IEnvironment

An Environment encapsulates access to a specific BAE server with specific credentials.

Hierarchy

IEnvironment

Index

Methods

Methods

createGridEditor

createGridEditor(grid: Grid): IGridTxEditor

- Defined in model.ts:87
Create an empty Grid Editor in the VM. When submitted, the VM will first create the Grid, and then also push the Grid data to the Server.

Parameters
- grid: Grid
  
  Grid Details
Returns IGridTxEditor

getGridEditor

getGridEditor(gridId: number): IGridTxEditor

- Defined in model.ts:76
Get a Grid Editor for a loaded Grid.

Parameters
- gridId: number
  
  Grid ID
Returns IGridTxEditor

getGrids

getGrids(): IGrids

- Defined in model.ts:81
Get the Grid Collection for this Environment.

Returns IGrids

loadGridById

loadGridById(gridId: number): Promise<never>

- Defined in model.ts:62
Load a Grid from the Server by its ID.

Parameters
- gridId: number
  
  Grid ID
Returns Promise<never>

loadGridsById

loadGridsById(gridIds: number[], success: function, faliure: function): void

- Defined in model.ts:70
Load a set of Grids by Grid ID.

Parameters
- gridIds: number[]
  
  Array of Grid IDs
- success: function
  
  Success Handler
  - - (): void
    - Returns void
- faliure: function
  
  Failure Handler
  - - (err?: VmError): void
    - Parameters
      - Optional err: VmError
      Returns void
Returns void

submitGrid

submitGrid(editor: IGridTxEditor, submitPrefs: ISubmitPrefs): Promise<SubmitStatus>

- Defined in model.ts:94
Submit the changes/ manipulations in the Grid Editor to the

Parameters
- editor: IGridTxEditor
  
  Grid Editor to be submitted.
- submitPrefs: ISubmitPrefs
  
  Submit Preferences
Returns Promise<SubmitStatus>

Generated using TypeDoc