DataGridXL — API

Classes

Renderer

Class

Overview

This is an overview of the class.

Used by:

DataGridXLEditor

Options

javascript
undefined

Methods

javascript
undefined

Items

adjustPanes

()

adjust panes

adjustScroll

(amount)

Adds amount in pixels to scrollLeft

adjustScrollLeft

(amount)

Adds amount in pixels to scrollLeft

adjustScrollTop

(amount)

Adds amount in pixels to scrollTop

calculateVirtualPaneHeights

()

[todo:move to private] Calculate virtual pane heights

calculateVirtualPaneWidths

()

[todo:move to private] Calculate virtual pane widths

disablePointerArea

()

Disable pointer area

drawFilterState

()

[todo:fix] Draw filter state (display indicators in column headers)

drawSortState

()

[todo:fix] Draw sort state (display indicators in column headers)

enablePointerArea

()

Enable pointer area

getCellBounds

(cellCoords)

[todo:fix colWidth/rowHeight] get cell bounds

getCellBoundsInViewport

()

Get cell bounds in viewport

getCellCoords

(pointerX,pointerY)

Get cell coordinates by pointer position

getCellPosition

(cellCoords)

[todo:fix width/height] Get cell position in pixels by cell coordinates

getCellPositionInViewport

(cellCoords)

[todo:fix width/height] Get cell position *in viewport* in pixels by cell coordinates

getColCoord

(pointerX,[halfWay])

Get column coordinate by pointer position

getColHeaderHeight

()

Get height in pixels of column header

getColHeaderSpace

()

Get space in pixels of column header zone

getColPosition

(colCoord)

Get column position in pixels by column coordinate

getColPositionInViewport

(colCoord)

[todo:fix width] Get column position *in viewport* in pixels by column coordinate

getColRangeSpace

(colRange)

Get column range space (width) in pixels

getColWidthById

(colId)

Get column width by ID

getDefaultColWidth

()

Get default column width

getDefaultRowHeight

()

Get default row height

getFirstVisibleCellCoords

()

Get first visible cell coords

getInnerViewportBounds

()

Get viewport bounds in pixels (document)

getInnerViewportHeight

()

Get height of viewport minus scrollbars

getInnerViewportWidth

()

Get width of viewport minus scrollbars

getLastFullyVisibleCellCoords

()

Get last fully-visible cell coords

getPaneXfromCellCoords

(cellCoords)

Get pane X from cell coordinates

getPaneYfromCellCoords

(cellCoords)

Get pane Y from cell coordinates

getRenderPositionX

()

Get render position X from cell coordinates

getRenderPositionY

()

Get render position Y from cell coordinates

getRowCoord

(pointerY,[halfWay])

Get row coordinate by pointer position

getRowHeaderSpace

()

Get space in pixels of row header zone

getRowHeaderWidth

()

Get width in pixels of row header

getRowHeightById

(rowId)

Get row height by ID

getRowPosition

(rowCoord)

Get row position in pixels by row coordinate

getRowPositionInViewport

(rowCoord)

[todo:fix width] Get row position *in viewport* in pixels by row coordinate

getRowRangeSpace

(rowRange)

Get row range space (height) in pixels

getSectionDividerXOffset

()

Get position of section divider X

getSectionDividerYOffset

()

Get position of section divider Y

getViewportBounds

()

Get viewport bounds in pixels (document)

getViewportHeight

()

Get height of total viewport

getViewportWidth

()

Get width of total viewport

isScrolling

()

Is scrolling

isViewportConnectedToLeftPane

()

Check if (center) viewport is connected to left pane

isViewportConnectedToTopPane

()

Check if (center) viewport is connected to top pane

moveViewportToIncludeCell

(cellCoords)

Moves viewport so that it includes given cell

scrollToLeft

()

Scroll viewport to start position (x)

scrollToTop

()

Scroll viewport to start position (y)

updateColView

()

Updates colView array

updatePaneIds

()

Updates pane IDs (after state change)

updateRowView

()

Updates rowView array

Events

javascript
undefined

Items

contextmenu

dblclick

dblclickcell

dblclickcolheaderedge

hit

hitcell

hitcellpickerbutton

hitcolheader

hitcolheaderedge

WIPhitcolheaderfilterbutton

hitcolheaderlabel

hitcolheadersortbutton

hitemptycanvas

hitfillhandle

hitheadercorner

hithiddencolgroupindicator

hithiddenrowgroupindicator

hitrowheader

hitsectiondividerx

hitsectiondividery

mouseentercell

mouseenterpointerarea

mouseleave

mouseleavecell

mouseleavepointerarea

scroll

scrollstop

viewportpositionchange