Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GridProps

Hierarchy

  • GridProps

Index

Properties

Optional activeCell

activeCell: CellInterface

Currently active cell

Optional activeCellStrokeWidth

activeCellStrokeWidth: undefined | number

Active Cell Stroke width

Optional borderStyles

borderStyles: StylingProps

Cell styles for border

Optional children

children: undefined | ((props: ScrollCoords) => React.ReactNode)

Custom grid overlays

columnCount

columnCount: number

No of columns in the grid

Optional columnWidth

columnWidth: ItemSizer

Should return width of a column at an index

Optional estimatedColumnWidth

estimatedColumnWidth: undefined | number

Helps in lazy grid width calculation

Optional estimatedRowHeight

estimatedRowHeight: undefined | number

Helps in lazy grid height calculation

Optional frozenColumns

frozenColumns: undefined | number

Number of frozen columns

Optional frozenRows

frozenRows: undefined | number

Number of frozen rows

Optional height

height: undefined | number

Height of the grid

Optional itemRenderer

itemRenderer: undefined | ((props: RendererProps) => React.ReactNode)

Cell renderer. Must be a Konva Component eg: Group, Rect etc

Optional mergedCells

mergedCells: AreaProps[]

Array of merged cells

Optional onBeforeRenderRow

onBeforeRenderRow: undefined | ((rowIndex: number) => void)

Called right before a row is being rendered. Will be called for frozen cells and merged cells

Optional onScroll

onScroll: undefined | ((__namedParameters: { scrollLeft: number; scrollTop: number }) => void)

Called when user scrolls the grid

Optional onViewChange

onViewChange: undefined | ((view: ViewPortProps) => void)

Fired when scroll viewport changes

rowCount

rowCount: number

No of rows in the grid

Optional rowHeight

rowHeight: ItemSizer

Should return height of a row at an index

Optional scrollThrottleTimeout

scrollThrottleTimeout: undefined | number

Scroll throttle wait timeout

Optional scrollbarSize

scrollbarSize: undefined | number

Size of the scrollbar. Default is 13

Optional selectionBackgroundColor

selectionBackgroundColor: undefined | string

Background of selection

Optional selectionBorderColor

selectionBorderColor: undefined | string

Border color of selected area

Optional selectionRenderer

selectionRenderer: undefined | ((props: SelectionProps) => React.ReactNode)

Allow users to customize selected cells design

Optional selectionStrokeWidth

selectionStrokeWidth: undefined | number

Stroke width of the selection

Optional selections

selections: SelectionArea[]

Array of selected cell areas

Optional shadowSettings

shadowSettings: ShapeConfig

Shadow settings

Optional showFrozenShadow

showFrozenShadow: undefined | false | true

Show shadow as you scroll for frozen rows and columns

Optional showScrollbar

showScrollbar: undefined | false | true

Show scrollbars on the left and right of the grid

Optional snap

snap: undefined | false | true

Snap to row and column when scrolling

Optional stageProps

stageProps: Omit<StageConfig, "container">

Props that can be injected to Konva stage

Optional width

width: undefined | number

Width of the grid

Optional wrapper

wrapper: undefined | ((children: React.ReactNode) => React.ReactNode)

Allows users to Wrap stage children in Top level Context

Generated using TypeDoc