BaseFacet

BaseTooltip

Hierarchy

parameter	illustrate	type	Version
spreadsheet	Form example	SpreadSheet
cornerBBox	corner bounding box	BBox
panelBBox	Value area bounding box	BBox
backgroundGroup	background area	Group
panelGroup	Numeric field	Group
foregroundGroup	foreground area	Group
layoutResult	layout information	LayoutResult
viewCellWidths	Cell width information	`number[]`
hScrollBar	Value area horizontal scroll bar	() => Group
hRowScrollBar	Line header area horizontal scroll bar	() => Group
vScrollBar	Value area vertical scroll bar	() => Group
rowHeader	Outfit	BaseHeaderConfig
columnHeader	Header	BaseHeaderConfig
cornerHeader	Corner head	BaseHeaderConfig
seriesNumberHeader	serial number	BaseHeaderConfig
centerFrame	frame	Group
gridInfo	grid information	GridInfo
getViewCellHeights	Get cell height information	( `layoutResult` : LayoutResult ) => ViewCellHeights
scrollBarTheme	scroll bar theme	ScrollBarTheme
scrollBarSize	scroll bar size	`number`
hideScrollBar	hide scrollbar	() => void
delayHideScrollBar	Delay to hide the scrollbar (after 1s)	() => void
delayHideScrollbarOnMobile	On the mobile side, delay hiding the scrollbar (after 1s)	() => void
showVerticalScrollBar	show vertical scrollbar	() => void
showHorizontalScrollBar	Show horizontal scroll bar	() => void
render	rendering	() => void
getSeriesNumberWidth	Get the serial number width	() => number
getContentHeight	Get the height of the currently rendered area	() => number
getPaginationScrollY	x	() => number
updateScrollOffset	scroll	(offsetConfig: ScrollOffsetConfig ) => void
scrollWithAnimation	Scrolling (with easing animation)	(offsetConfig: ScrollOffsetConfig , duration?: number, callback?: () => void) => void
scroll Immediately	scrolling (no animation)	(offsetConfig: ScrollOffsetConfig ) => void
destroy	uninstall	() => void
getScrollOffset	Get the current scroll offset	() => ScrollOffset
setScrollOffset	Set the current scroll offset	(scrollOffset: ScrollOffset ) => void
resetScrollOffset	Reset the current scroll offset	() => void
resetScrollX	reset horizontal scroll offset	() => void
resetScrollY	reset vertical scroll offset	() => void
resetRowScrollX	Reset row header horizontal scroll offset	() => void
emitPaginationEvent	trigger pagination event	() => void
clipPanelGroup	Clipping value range Group	() => void
getRealWidth	Get the actual rendered width	() => number
getRealHeight	Get the actual rendered height	() => number
clearAllGroup	Clear all groups	() => void
isScrollOverThePanelArea	Whether to scroll in the value area	(cellScrollOffset: CellScrollOffset ) => boolean
isScrollOverTheCornerArea	Whether to scroll in the corner header area	(cellScrollOffset: CellScrollOffset ) => boolean
isScrollToLeft	Whether to scroll to the left	(cellScrollOffset: CellScrollOffset ) => boolean
isScrollToRight	Whether to scroll to the far right	(cellScrollOffset: CellScrollOffset ) => boolean
isScrollToTop	Did you scroll to the top	(deltaY: number) => boolean
isScrollToBottom	Did you scroll to the bottom	(deltaY: number) => boolean
isVerticalScrollOverTheViewport	Whether to scroll vertically in the value cell area	(deltaY: number) => boolean
isHorizontalScrollOverTheViewport	Whether to scroll horizontally in the numeric cell area	(scrollOffset: CellScrollOffset ) => boolean
isScrollOverTheViewport	Whether to scroll in the value cell area	(cellScrollOffset: CellScrollOffset ) => boolean
cancelScrollFrame	Cancel the current scroll frame	() => void
clearScrollFrameIdOnMobile	Cancel the current scrolling frame (mobile terminal)	() => void
addCell	add cell	(cell: BaseCell ) => void
drawGrid	draw grid	() => void
getCanvasSize	Get canvas width and height	`{width: number, height: number}`
backgroundGroup	background color area group	Group
foregroundGroup	background color area group	Group
panelGroup	Visible range cell area group	Group
panelScrollGroup	Visible range cell scrolling area group	Group
frozenRowGroup	Header freeze area group	Group
frozenColGroup	Column header freeze area group	Group
frozenTrailingRowGroup	Freezing area group at the bottom of the row header	Group
frozenTrailingColGroup	Freeze area group at the bottom of the column header	Group
frozenTopGroup	top freeze area group	Group
frozenBottomGroup	Bottom freeze area group	Group
getHiddenColumnsInfo	Match whether the current node is a hidden node, if so, return the hidden information of the node	(node: Node ) => HiddenColumnsInfo \| `null`	`1.34.1`
getCornerNodes	Get corner node	() => Node []	`1.40.0`

parameter

illustrate

type

Version

spreadsheet

Form example

SpreadSheet

cornerBBox

corner bounding box

BBox

panelBBox

Value area bounding box

BBox

backgroundGroup

background area

Group

panelGroup

Numeric field

Group

foregroundGroup

foreground area

Group

layoutResult

layout information

LayoutResult

viewCellWidths

Cell width information

number[]

hScrollBar

Value area horizontal scroll bar

() => Group

hRowScrollBar

Line header area horizontal scroll bar

() => Group

vScrollBar

Value area vertical scroll bar

() => Group

rowHeader

Outfit

BaseHeaderConfig

columnHeader

Header

BaseHeaderConfig

cornerHeader

Corner head

BaseHeaderConfig

seriesNumberHeader

serial number

BaseHeaderConfig

centerFrame

frame

Group

gridInfo

grid information

GridInfo

getViewCellHeights

Get cell height information

( layoutResult : LayoutResult ) => ViewCellHeights

scrollBarTheme

scroll bar theme

ScrollBarTheme

scrollBarSize

scroll bar size

number

hideScrollBar

hide scrollbar

() => void

delayHideScrollBar

Delay to hide the scrollbar (after 1s)

() => void

delayHideScrollbarOnMobile

On the mobile side, delay hiding the scrollbar (after 1s)

() => void

showVerticalScrollBar

show vertical scrollbar

() => void

showHorizontalScrollBar

Show horizontal scroll bar

() => void

render

rendering

() => void

getSeriesNumberWidth

Get the serial number width

() => number

getContentHeight

Get the height of the currently rendered area

() => number

getPaginationScrollY

() => number

updateScrollOffset

scroll

(offsetConfig: ScrollOffsetConfig ) => void

scrollWithAnimation

Scrolling (with easing animation)

(offsetConfig: ScrollOffsetConfig , duration?: number, callback?: () => void) => void

scroll Immediately

scrolling (no animation)

(offsetConfig: ScrollOffsetConfig ) => void

destroy

uninstall

() => void

getScrollOffset

Get the current scroll offset

() => ScrollOffset

setScrollOffset

Set the current scroll offset

(scrollOffset: ScrollOffset ) => void

resetScrollOffset

Reset the current scroll offset

() => void

resetScrollX

reset horizontal scroll offset

() => void

resetScrollY

reset vertical scroll offset

() => void

resetRowScrollX

Reset row header horizontal scroll offset

() => void

emitPaginationEvent

trigger pagination event

() => void

clipPanelGroup

Clipping value range Group

() => void

getRealWidth

Get the actual rendered width

() => number

getRealHeight

Get the actual rendered height

() => number

clearAllGroup

Clear all groups

() => void

isScrollOverThePanelArea

Whether to scroll in the value area

(cellScrollOffset: CellScrollOffset ) => boolean

isScrollOverTheCornerArea

Whether to scroll in the corner header area

(cellScrollOffset: CellScrollOffset ) => boolean

isScrollToLeft

Whether to scroll to the left

(cellScrollOffset: CellScrollOffset ) => boolean

isScrollToRight

Whether to scroll to the far right

(cellScrollOffset: CellScrollOffset ) => boolean

isScrollToTop

Did you scroll to the top

(deltaY: number) => boolean

isScrollToBottom

Did you scroll to the bottom

(deltaY: number) => boolean

isVerticalScrollOverTheViewport

Whether to scroll vertically in the value cell area

(deltaY: number) => boolean

isHorizontalScrollOverTheViewport

Whether to scroll horizontally in the numeric cell area

(scrollOffset: CellScrollOffset ) => boolean

isScrollOverTheViewport

Whether to scroll in the value cell area

(cellScrollOffset: CellScrollOffset ) => boolean

cancelScrollFrame

Cancel the current scroll frame

() => void

clearScrollFrameIdOnMobile

Cancel the current scrolling frame (mobile terminal)

() => void

addCell

add cell

(cell: BaseCell ) => void

drawGrid

draw grid

() => void

getCanvasSize

Get canvas width and height

{width: number, height: number}

backgroundGroup

background color area group

Group

foregroundGroup

background color area group

Group

panelGroup

Visible range cell area group

Group

panelScrollGroup

Visible range cell scrolling area group

Group

frozenRowGroup

Header freeze area group

Group

frozenColGroup

Column header freeze area group

Group

frozenTrailingRowGroup

Freezing area group at the bottom of the row header

Group

frozenTrailingColGroup

Freeze area group at the bottom of the column header

Group

frozenTopGroup

top freeze area group

Group

frozenBottomGroup

Bottom freeze area group

Group

getHiddenColumnsInfo

Match whether the current node is a hidden node, if so, return the hidden information of the node

(node: Node ) => HiddenColumnsInfo | null

1.34.1

getCornerNodes

Get corner node

() => Node []

1.40.0

export interface LayoutResult {

colNodes: Node[];

colsHierarchy: Hierarchy;

rowNodes: Node[];

rowsHierarchy: Hierarchy;

rowLeafNodes: Node[];

colLeafNodes: Node[];

getCellMeta: GetCellMeta;

spreadsheet: SpreadSheet;

}

export interface BaseHeaderConfig {

scrollX?: number;

scrollY?: number;

width: number;

height: number;

originalWidth?: number;

originalHeight?: number;

viewportWidth: number;

viewportHeight: number;

position: Point;

data: Node[];

spreadsheet: SpreadSheet;

sortParam?: SortParam;

}

export interface ViewCellHeights {

getCellOffsetY: (index: number) => number;

getTotalHeight: () => number;

getTotalLength: () => number;

getIndexRange: (

minHeight: number,

maxHeight: number,

) => {

start: number;

end: number;

};

}