- Preparing search index...
- The search index is not available
FlexSheetPanel Class
Heirarchy
-
GridPanel
- FlexSheetPanel
Constructors
Properties
Methods
Constructors
constructor
-
Initializes a new instance of the FlexSheetPanel class.
Parameters
-
grid: FlexGrid
The FlexGrid object that owns the panel.
-
cellType: CellType
The type of cell in the panel.
-
rows: RowCollection
The rows displayed in the panel.
-
cols: ColumnCollection
The columns displayed in the panel.
-
element: HTMLElement
The HTMLElement that hosts the cells in the control.
Returns FlexSheetPanel
-
Properties
cellType
Gets the type of cell contained in the panel.
columns
Gets the panel's column collection.
grid
Gets the grid that owns the panel.
height
Gets the total height of the content in this panel.
hostElement
Gets the host element for the panel.
rows
Gets the panel's row collection.
viewRange
Gets a CellRange that indicates the range of cells currently visible on the panel.
width
Gets the total width of the content in the panel.
Methods
getCellBoundingRect
-
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 | string
The index, name, or binding of the column that contains the cell.
-
Optional raw: boolean
Whether to return the rectangle in raw panel coordinates as opposed to viewport coordinates.
Returns Rect
-
getCellData
-
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
-
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 | string
The index, name, or binding of the column that contains the cell.
Returns HTMLElement
-
getSelectedState
-
Gets a SelectedState value that indicates the selected state of a cell.
Overrides this method to support multiple selection showSelectedHeaders for FlexSheet
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
-
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.
-
Optional coerce: boolean
A value indicating whether to change the value automatically to match the column's data type.
-
Optional invalidate: boolean
Whether to invalidate the FlexSheet to show the change.
-
Optional isMapKeyValue: boolean
value passed is already key value of dataMap, don't need re-find.
Returns boolean
Returns true if the value is stored successfully, otherwise false (failed cast).
-
Defines the extension of the GridPanel class, which is used by FlexSheet where the base FlexGrid class uses GridPanel. For example, the cells property returns an instance of this class.