+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ new Behavior()
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+This is the base class for creating behaviors. a behavior can be thought of as a model++. +it contains all code/data that's necessary for easily implementing a virtual data source and it's manipulation/analytics
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Members
+ + + +editorTypes :Array.<string>
+ + + + +
+
+
+
+
+ list of default cell editor names
+Type:
+-
+
- + +Array.<string> + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
featureChain :object
+ + + + +
+
+
+
+
+ controller chain of command
+Type:
+-
+
- + +object + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
grid :Hypergrid
+ + + + + + +Type:
+-
+
- + +Hypergrid + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
tableState :object
+ + + + +
+
+
+
+
+ memento for the user configured visual properties of the table
+Type:
+-
+
- + +object + + + +
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Methods
+ + + + + + +_fixedColumnClicked(grid, mouse)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ The fixed column area has been clicked, massage the details and call the real function.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
mouse |
+
+
+ + + +Object + + + + | + + + + + +event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
_fixedRowClicked(grid, mouse)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ The fixed row area has been clicked, massage the details and call the real function.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
mouse |
+
+
+ + + +Object + + + + | + + + + + +event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
_getCellEditorAt(x, y) → {cellEditor}
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
x |
+
+
+ + + +number + + + + | + + + + + +The horizontal cell coordinate. |
+
y |
+
+
+ + + +number + + + + | + + + + + +The vertical cell coordinate. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The cell editor for the cell at cell coordinates x,y
-
+
- + Type + +
- + +cellEditor + + + +
_setScrollPositionX(x)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ Set the scroll position in horizontal dimension and notify listeners.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
x |
+
+
+ + + +number + + + + | + + + + + +the new x value |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
_setScrollPositionY(y)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ Set the scroll position in vertical dimension and notify listeners.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
y |
+
+
+ + + +number + + + + | + + + + + +the new y value |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
beColumnStyle(style)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ bind column editor appropriate css values to arg style
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
style |
+
+
+ + + +HTMLStyleElement + + + + | + + + + + +the style object to enhance |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
buildColumnPicker(div) → {boolean}
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ build and open the editor within the container div argument
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
div |
+
+
+ + + +HTMLDivElement + + + + | + + + + + +the containing div element |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+false prevents editor from opening
-
+
- + Type + +
- + +boolean + + + +
cellClicked(cell, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ A specific cell was clicked; you've been notified.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
cell |
+
+
+ + + +Point + + + + | + + + + + +point of cell coordinates |
+
event |
+
+
+ + + +Object + + + + | + + + + + +all event information |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cellDoubleClicked(cell, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ A specific cell was le double-clicked; you've been notified.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
cell |
+
+
+ + + +Point + + + + | + + + + + +point of cell coordinates |
+
event |
+
+
+ + + +Object + + + + | + + + + + +all event information |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cellFixedColumnPrePaintNotification(cell)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ this function is a hook and is called just before the painting of a fixed column cell occurs
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
cell |
+
+
+ + + +window.fin.rectangular.Point + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cellFixedRowPrePaintNotification(cell)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ this function is a hook and is called just before the painting of a fixed row cell occurs
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
cell |
+
+
+ + + +window.fin.rectangular.Point + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cellPropertiesPrePaintNotification(cell)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ this function is a hook and is called just before the painting of a cell occurs
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
cell |
+
+
+ + + +window.fin.rectangular.Point + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
cellTopLeftPrePaintNotification(cell)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ this function is a hook and is called just before the painting of a top left cell occurs
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
cell |
+
+
+ + + +window.fin.rectangular.Point + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
changed()
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+this function is replaced by the grid on initialization and serves as the callback
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
clearObjectProperties(obj, exportPropsopt)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ utility function to empty an object of its members
+Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
obj |
+
+
+ + + +object + + + + | + + ++ + + + + + | + + + + +the object to empty |
+
exportProps |
+
+
+ + + +boolean + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+
+
|
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
clearState()
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+clear all table state
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
createCellProvider() → {CellProvider}
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+You can override this function and substitute your own cell provider.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + + + +-
+
- + Type + +
- + +CellProvider + + + +
endDragColumnNotification()
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+a dnd column has just been dropped, we've been notified
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
enhanceDoubleClickEvent(event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ this function enhance the double click event just before it's broadcast to listeners
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
event |
+
+
+ + + +Object + + + + | + + + + + +event to enhance |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
getCellProperties(x, y) → {*}
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ First checks to see if something was overridden.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
x |
+
+
+ + + +number + + + + | + + + + + +x coordinate |
+
y |
+
+
+ + + +number + + + + | + + + + + +y coordinate |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The value at x,y for the top left section of the hypergrid.
+-
+
- + Type + +
- + +* + + + +
getCellProvider() → {CellProvider}
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getter for the cell provider
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + + + +-
+
- + Type + +
- + +CellProvider + + + +
getColumnAlignment(x) → {string}
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
x |
+
+
+ + + +number + + + + | + + + + + +The column index of interest. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The column alignment at column x: 'left', 'center' , or 'right'
-
+
- + Type + +
- + +string + + + +
getColumnCount() → {number}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The total number of columns.
+-
+
- + Type + +
- + +number + + + +
getColumnProperties(columnIndex) → {Object}
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
columnIndex |
+
+
+ + + +index + + + + | + + + + + +the column index of interest |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The properties for a specific column. These are used if no cell properties are specified.
+-
+
- + Type + +
- + +Object + + + +
getCursorAt(x, y) → {null}
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
x |
+
+
+ + + +number + + + + | + + + + + +the x coordinate |
+
y |
+
+
+ + + +number + + + + | + + + + + +the y coordinate |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+the cursor at a specific x,y coordinate
+-
+
- + Type + +
- + +null + + + +
getDefaultRowHeight() → {number}
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+The value is lazily initialized and comes from the properties mechanism for 'defaultRowHeight', which should be ~20px.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The row height in pixels.
+-
+
- + Type + +
- + +number + + + +
getDefaultState() → {object}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+Newly created default empty tablestate.
+-
+
- + Type + +
- + +object + + + +
getField(colIndex) → {string}
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
colIndex |
+
+
+ + + +number + + + + | + + + + + +the column index of interest |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The field at colIndex.
-
+
- + Type + +
- + +string + + + +
getFixedColumnCount() → {integer}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The number of fixed columns.
+-
+
- + Type + +
- + +integer + + + +
getFixedColumnsMaxWidth() → {number}
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+This exists to support "floating" columns.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The total width of the fixed columns area.
+-
+
- + Type + +
- + +number + + + +
getFixedColumnsWidth() → {number}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The width of the fixed column area in the hypergrid.
+-
+
- + Type + +
- + +number + + + +
getFixedRowCount() → {integer}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The number of fixed rows.
+-
+
- + Type + +
- + +integer + + + +
getFixedRowsHeight() → {number}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The height in pixels of the fixed rows area of the hypergrid.
+-
+
- + Type + +
- + +number + + + +
getFixedRowsMaxHeight() → {number}
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+This will allow 'floating' fixed rows.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The maximum height of the fixed rows area in the hypergrid.
+-
+
- + Type + +
- + +number + + + +
getFooterRowCount() → {number}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The number of footer rows, consisting entirely of 0 or more bottom totals rows.
+-
+
- + Type + +
- + +number + + + +
getGrid(varname) → {Hypergrid}
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
varname |
+
+
+ + + +type + + + + | + + + + + +descripton |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Deprecated:
- Use `.grid` property instead.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The hypergrid to which this behavior is attached.
+-
+
- + Type + +
- + +Hypergrid + + + +
getHeader(colIndex) → {string}
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
colIndex |
+
+
+ + + +number + + + + | + + + + + +the column index of interest |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The column heading at `colIndex'.
+-
+
- + Type + +
- + +string + + + +
getHeaderColumnCount() → {number}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The number of fixed rows.
+-
+
- + Type + +
- + +number + + + +
getHeaderRowCount() → {number}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The number of header rows.
+A portion of the number returned by getFixedRowCount().
+(The remaining fixed rows are the top totals rows.)
-
+
- + Type + +
- + +number + + + +
getHiddenColumnDescriptors() → {Array.<string>}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+All the currently hidden column header labels.
+-
+
- + Type + +
- + +Array.<string> + + + +
getPrivateState() → {object}
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+getter for a Memento Object
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + + + +-
+
- + Type + +
- + +object + + + +
getRow(y) → {object}
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
y |
+
+
+ + + +number + + + + | + + + + + +the row index of interest |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The object at y index.
+-
+
- + Type + +
- + +object + + + +
getRowCount() → {number}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The number of rows in the hypergrid.
+-
+
- + Type + +
- + +number + + + +
getRowHeight(rowNum) → {number}
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
rowNum |
+
+
+ + + +number + + + + | + + + + + +row index of interest |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The height in pixels of a specific row in the hypergrid.
+-
+
- + Type + +
- + +number + + + +
getValue(x, y) → {*}
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ First check to see if something was overridden.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
x |
+
+
+ + + +number + + + + | + + + + + +x coordinate |
+
y |
+
+
+ + + +number + + + + | + + + + + +y coordinate |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The value at x,y for the top left section of the hypergrid.
-
+
- + Type + +
- + +* + + + +
handleMouseDown(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling mouse down to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
handleMouseExit(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling mouse exit to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
hideColumns(arrayOfIndexes)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ hide columns that are specified by their indexes
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
arrayOfIndexes |
+
+
+ + + +Array + + + + | + + + + + +an array of column indexes to hide |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
highlightCellOnHover(isColumnHovered, isRowHovered) → {boolean}
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
isColumnHovered |
+
+
+ + + +boolean + + + + | + + + + + +the column is hovered or not |
+
isRowHovered |
+
+
+ + + +boolean + + + + | + + + + + +the row is hovered or not |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+true if we should highlight on hover
-
+
- + Type + +
- + +boolean + + + +
initialize(grid)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ this is the callback for the plugin pattern of nested tags
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
initializeFeatureChain(grid)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ create the feature chain - this is the chain of responsibility pattern.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
isColumnReorderable() → {boolean}
+ + + + + + + + + + + + + + + + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+Can re-order columns.
+-
+
- + Type + +
- + +boolean + + + +
onContextMenu(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling tap to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
onDoubleClick(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling double click to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
onHoldPulse(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling hold pulse to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
onKeyDown(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling key down to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
onKeyUp(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling key up to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
onMouseDrag(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling mouse drag to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
onMouseMove(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling mouse move to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
onMouseUp(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling mouse up to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
onTap(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling tap to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
onWheelMoved(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling wheel moved to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
resolveProperty(key) → {*}
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ fetch the value for a property key
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
key |
+
+
+ + + +string + + + + | + + + + + +a property name |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+The value of the given property.
+-
+
- + Type + +
- + +* + + + +
setCellProperties(x, y, value)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ update the data at point x, y with value
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
x |
+
+
+ + + +number + + + + | + + + + + +x coordinate |
+
y |
+
+
+ + + +number + + + + | + + + + + +y coordinate |
+
value |
+
+
+ + + +Object + + + + | + + + + + +the value to use |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setColumnDescriptors(list)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ this is called by the column editor post closing; rebuild the column order indexes
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
list |
+
+
+ + + +Array + + + + | + + + + + +list of column objects from the column editor |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setCursor(grid)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate setting the cursor up the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setFixedColumnCount(n)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ set the number of fixed columns
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
n |
+
+
+ + + +number + + + + | + + + + + +the integer count of how many columns to be fixed |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setFixedRowCount(n) → {number}
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ Set the number of fixed rows, which includes (top to bottom order):
+-
+
- The header rows
-
+
- The header labels row (optional) +
- The filter row (optional) +
- The top total rows (0 or more) +
+ - The non-scrolling rows (externally called "the fixed rows") +
Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
n |
+
+
+ + + +number + + + + | + + + + + +The number of rows. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+Sum of the above or 0 if none of the above are in use.
+-
+
- + Type + +
- + +number + + + +
setGrid(grid)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ setter for the hypergrid
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setHeaderColumnCount(The)
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
The |
+
+
+ + + +number + + + + | + + + + + +number of fixed rows. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setHeaderRowCount(n)
+ + +Set the number of header rows.
+ + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
n |
+
+
+ + + +number + + + + | + + + + + +The number of fixed rows to reserve as header rows. +(The remaining fixed rows are the top totals rows.) |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setNextFeature()
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ add nextFeature to me If I don't have a next node, otherwise pass it along
+Parameters:
+ + +| Type | + + + + + +Description | +
|---|---|
| + + +Feature + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setRenderedColumnCount(count)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ Set the number of columns just rendered, including partially rendered columns.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
count |
+
+
+ + + +number + + + + | + + + + + +how many columns were just rendered |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setRenderedRowCount(count)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ Set the number of rows just rendered, including partially rendered rows.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
count |
+
+
+ + + +number + + + + | + + + + + +how many rows were just rendered |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setRowHeight(rowNum, height)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ set the pixel height of a specific row
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
rowNum |
+
+
+ + + +number + + + + | + + + + + +the row index of interest |
+
height |
+
+
+ + + +number + + + + | + + + + + +pixel height |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setScrollPositionX(x)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ Quietly set the horizontal scroll position.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
x |
+
+
+ + + +number + + + + | + + + + + +The new position in pixels. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setScrollPositionY(y)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ Quietly set the vertical scroll position.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
y |
+
+
+ + + +number + + + + | + + + + + +The new position in pixels. |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setState(memento)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ Restore this table to a previous state. +See the memento pattern.
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
memento |
+
+
+ + + +Object + + + + | + + + + + +an encapsulated representation of table state |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setTotalsValue(x, y, value, areasopt)
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + +Attributes | + + + +Default | + + +Description | +
|---|---|---|---|---|
x |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +column index |
+
y |
+
+
+ + + +number + + + + | + + ++ + + + + + | + + + ++ + | + + +totals row index local to the totals area |
+
value |
+
+
+ + + | + + ++ + + + + + | + + + ++ + | + + ++ |
areas |
+
+
+ + + +Array.<string> + + + + | + + +
+
+ <optional> + + + + + + |
+
+
+
+ + + ['top', 'bottom'] + + | + + +may include |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
setValue(x, y, value)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ update the data at point x, y with value
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
x |
+
+
+ + + +number + + + + | + + + + + +x coordinate |
+
y |
+
+
+ + + +number + + + + | + + + + + +y coordinate |
+
value |
+
+
+ + + +Object + + + + | + + + + + +the value to use |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The data.
+shapeChanged()
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+this function is replaced by the grid on initialization and serves as the callback
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
swapColumns(src, tar)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ swap src and tar columns
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
src |
+
+
+ + + +number + + + + | + + + + + +column index |
+
tar |
+
+
+ + + +number + + + + | + + + + + +column index |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
toggleColumnPicker(grid, event)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ delegate handling double click to the feature chain of responsibility
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
grid |
+
+
+ + + +Hypergrid + + + + | + + + + + ++ |
event |
+
+
+ + + +Object + + + + | + + + + + +the event details |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
toggleSort(x, keys)
+ + + + + + + + + + + + + +Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
x |
+
+
+ + + +number + + + + | + + + + + +The column index. |
+
keys |
+
+
+ + + +Array.<string> + + + + | + + + + + ++ |
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
updateFromColumnPicker(div)
+ + + + + +
+
+
+
+
+
+
+
+
+
+
+ the editor is requesting close; deal with the edits
+Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +
|---|---|---|
div |
+
+
+ + + +HTMLDivElement + + + + | + + + + + +the containing div element |
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:
+ + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+true