ASP.NET MVC Controls
GridPanel Class
File
wijmo.grid.js
Module
wijmo.grid
Derived Classes
FlexSheetPanel

Represents a logical part of the grid, such as the column headers, row headers, and scrollable data part.

Constructor

Properties

Methods

Constructor

constructor

constructor(g: FlexGrid, cellType: CellType, rows: RowCollection, cols: ColumnCollection, element: HTMLElement): GridPanel

Initializes a new instance of the GridPanel class.

Parameters
Returns
GridPanel

Properties

cellType

Gets the type of cell contained in the panel.

Type
CellType

columns

Gets the panel's column collection.

Type
ColumnCollection

grid

Gets the grid that owns the panel.

Type
FlexGrid

height

Gets the total height of the content in this panel.

Type
number

hostElement

Gets the host element for the panel.

Type
HTMLElement

rows

Gets the panel's row collection.

Type
RowCollection

viewRange

Gets a CellRange that indicates the range of cells currently visible on the panel.

Type
CellRange

width

Gets the total width of the content in the panel.

Type
number

Methods

getCellBoundingRect

getCellBoundingRect(r: number, c: number, raw?: boolean): Rect

Gets a cell's bounds in viewport coordinates.

The returned value is a Rect object which contains the position and dimensions of the cell in viewport coordinates. The viewport coordinates are the same as those used by the getBoundingClientRect method.

Parameters
  • r: number

    The index of the row that contains the cell.

  • c: number

    The index of the column that contains the cell.

  • raw: boolean Optional

    Whether to return the rectangle in raw panel coordinates as opposed to viewport coordinates.

Returns
Rect

getCellData

getCellData(r: number, c: any, formatted: boolean): any

Gets the value stored in a cell in the panel.

Parameters
  • r: number

    The row index of the cell.

  • c: any

    The index, name, or binding of the column that contains the cell.

  • formatted: boolean

    Whether to format the value for display.

Returns
any

getCellElement

getCellElement(r: number, c: number): HTMLElement

Gets the element that represents a cell within this GridPanel.

If the cell is not currently in view, this method returns null.

Parameters
  • r: number

    The index of the row that contains the cell.

  • c: number

    The index of the column that contains the cell.

Returns
HTMLElement

getSelectedState

getSelectedState(r: number, c: number, rng: CellRange): SelectedState

Gets a SelectedState value that indicates the selected state of a cell.

Parameters
  • r: number

    Row index of the cell to inspect.

  • c: number

    Column index of the cell to inspect.

  • rng: CellRange

    CellRange that contains the cell to inspect.

Returns
SelectedState

setCellData

setCellData(r: number, c: any, value: any, coerce?: boolean, invalidate?: boolean): boolean

Sets the content of a cell in the panel.

Parameters
  • r: number

    The index of the row that contains the cell.

  • c: any

    The index, name, or binding of the column that contains the cell.

  • value: any

    The value to store in the cell.

  • coerce: boolean Optional

    Whether to change the value automatically to match the column's data type.

  • invalidate: boolean Optional

    Whether to invalidate the grid to show the change.

Returns
boolean

 

 


Copyright © GrapeCity, inc. All rights reserved.

Product Support Forum |  Documentation Feedback