DataGridXL - API

SnapRenderer

Description

The SnapRenderer is the default (and currently only) renderer for DataGridXL. It renders the Sheet, the CellSelector and other important members. It inherits all Renderer Methods and Renderer Events.

Usage

Your DataGridXL instance contains a property renderer.

javascript
// create DataGridXL instance
const grid = new DataGridXL(...);
// work with the SnapRenderer instance
grid.renderer.renderAtCell({x: 0, y: 100});
NOTE: You don't need to create a SnapRenderer instance yourself — it is provided by the grid automatically.

Methods

adjustPanes()

Adjust panes (after `freezeRows` action or `freezeCols` action)

disableHoverEffects()

Disable hover effects (for instance, when user is performing a drag action)

disableScroll()

Disable scroll (for instance, when a grid dialog is displayed)

enableHoverEffects()

Enable hover effects

enableScroll()

Enable scroll

redraw()

Trigger a redraw

renderAtCell(cellCoords)

Draw renderer at given cell coordinates

Arguments

cellCoords
CellCoordsCell Coordinates
renderAtCellOnScroll(cellCoords)

Draw renderer at given cell coordinates (without updating scroll position)

Arguments

cellCoords
CellCoordsCell Coordinates
updateDimensions(width, height)

Update dimensions of renderer, triggering redraw

Arguments

width
numberWidth of render surface in pixels
height
numberHeight of render surface in pixels
No generated events found for SnapRenderer.