BaseFacet
上一篇
BaseTooltip
下一篇
Hierarchy
Loading...
功能描述：当前可视渲染区域。详情
s2.facet.getRealWidth()
| 参数 | 说明 | 类型 | 版本 |
|---|---|---|---|
| spreadsheet | 表格实例 | SpreadSheet | |
| cornerBBox | 角头区域包围盒 | BBox | |
| panelBBox | 数值区域包围盒 | BBox | |
| backgroundGroup | 背景区域 | Group | |
| panelGroup | 数值区域 | Group | |
| foregroundGroup | 前景区域 | Group | |
| getLayoutResult | 获取布局信息 （角头，序号，行头，列头） | () => LayoutResult | |
| viewCellWidths | 单元格宽度信息 | number[] | |
| hScrollBar | 数值区域水平滚动条 | () => Group | |
| hRowScrollBar | 行头区域水平滚动条 | () => Group | |
| vScrollBar | 数值区域垂直滚动条 | () => Group | |
| rowHeader | 行头 | BaseHeaderConfig | |
| columnHeader | 列头 | BaseHeaderConfig | |
| cornerHeader | 角头 | BaseHeaderConfig | |
| seriesNumberHeader | 序号 | BaseHeaderConfig | |
| centerFrame | 框架 | Group | |
| gridInfo | 网格信息 | GridInfo | |
| getViewCellHeights | 获取单元格高度信息 | () => ViewCellHeights | |
| scrollBarTheme | 滚动条主题 | ScrollBarTheme | |
| scrollBarSize | 滚动条大小 | number | |
| hideScrollBar | 隐藏滚动条 | () => void | |
| delayHideScrollBar | 延迟隐藏滚动条 (1s 后） | () => void | |
| delayHideScrollbarOnMobile | 移动端时，延迟隐藏滚动条 (1s 后） | () => void | |
| showVerticalScrollBar | 显示垂直滚动条 | () => void | |
| showHorizontalScrollBar | 显示水平滚动条 | () => void | |
| render | 渲染 | () => void | |
| getSeriesNumberWidth | 获取序号宽度 | () => number | |
| getContentWidth | 获取当前表格实际内容宽度 | () => number | |
| getContentHeight | 获取当前表格实际内容高度 | () => number | |
| getPaginationScrollY | x | () => number | |
| updateScrollOffset | 滚动 | (offsetConfig: ScrollOffsetConfig) => void | |
| scrollWithAnimation | 滚动 （带缓动动画） | (offsetConfig: ScrollOffsetConfig, duration?: number, callback?: () => void) => void | |
| scrollImmediately | 滚动 （无动画） | (offsetConfig: ScrollOffsetConfig) => void | |
| destroy | 卸载 | () => void | |
| getScrollOffset | 获取当前滚动偏移 | () => ScrollOffset | |
| setScrollOffset | 设置当前滚动偏移 | (scrollOffset: ScrollOffset) => void | |
| resetScrollOffset | 重置当前滚动偏移 | () => void | |
| resetScrollX | 重置水平滚动偏移 | () => void | |
| resetScrollY | 重置垂直滚动偏移 | () => void | |
| resetRowScrollX | 重置行头水平滚动偏移 | () => void | |
| emitPaginationEvent | 触发分页事件 | () => void | |
| clipPanelGroup | 裁剪数值区域 Group | () => void | |
| getRealWidth | 获取实际渲染的宽度 | () => number | |
| getRealHeight | 获取实际渲染的高度 | () => number | |
| clearAllGroup | 清空所有 Group | () => void | |
| isScrollOverThePanelArea | 是否在数值区域滚动 | (cellScrollOffset: CellScrollOffset) => boolean | |
| isScrollOverTheCornerArea | 是否在角头区域滚动 | (cellScrollOffset: CellScrollOffset) => boolean | |
| isScrollToLeft | 是否滚动到了最左边 | (cellScrollOffset: CellScrollOffset) => boolean | |
| isScrollToRight | 是否滚动到了最右边 | (cellScrollOffset: CellScrollOffset) => boolean | |
| isScrollToTop | 是否滚动到了顶部 | (deltaY: number) => boolean | |
| isScrollToBottom | 是否滚动到了底部 | (deltaY: number) => boolean | |
| isVerticalScrollOverTheViewport | 是否在数值单元格区域垂直滚动 | (deltaY: number) => boolean | |
| isHorizontalScrollOverTheViewport | 是否在数值单元格区域水平滚动 | (scrollOffset: CellScrollOffset) => boolean | |
| isScrollOverTheViewport | 是否在数值单元格区域滚动 | (cellScrollOffset: CellScrollOffset) => boolean | |
| cancelScrollFrame | 取消当前滚动帧 | () => void | |
| clearScrollFrameIdOnMobile | 取消当前滚动帧 （移动端） | () => void | |
| addCell | 添加单元格 | (cell: BaseCell) => void | |
| drawGrid | 绘制网格 | () => void | |
| getCanvasSize | 获取画布宽高 | {width: number, height: number} | |
| backgroundGroup | 背景颜色区域 group | Group | |
| foregroundGroup | 背景颜色区域 group | Group | |
| panelGroup | 可视范围单元格区域 group | Group | |
| panelScrollGroup | 可视范围单元格滚动区域 group | Group | |
| frozenRowGroup | 行头冻结区域 group | Group | |
| frozenColGroup | 列头冻结区域 group | Group | |
| frozenTrailingRowGroup | 行头底部冻结区域 group | Group | |
| frozenTrailingColGroup | 列头底部冻结区域 group | Group | |
| frozenTopGroup | 顶部冻结区域 group | Group | |
| frozenBottomGroup | 底部冻结区域 group | Group | |
| getHiddenColumnsInfo | 匹配当前节点是否是隐藏节点，如果是，则返回该节点隐藏信息 | (node: Node) => HiddenColumnsInfo | null | |
| getHeaderNodes | 获取表头节点 （角头，序号，行头，列头） （含可视区域） | (ids?: string[]) => Node[] | |
| getSeriesNumberNodes | 获取序号节点 | () => Node[] | |
| getCornerNodes | 获取角头节点 | () => Node[] | 1.40.0 |
| getRowNodes | 获取行头节点 | (level?: number) => Node[] | |
| getRowNodeById | 根据 id 获取单个行头节点 | (id: string) => Node | |
| getRowNodeByIndex | 根据行头索引获取指定列头节点 | (rowIndex: number) => Node | |
| getRowNodesByField | 根据 field 获取行头节点 | (field: string) => Node[] | |
| getRowLeafNodes | 获取行头单元格叶子节点 | () => Node[] | |
| getRowLeafNodeByIndex | 根据行头索引获取指定列头叶子节点 | () => Node[] | |
| getRowTotalsNodes | 获取行头汇总单元格节点 | (level?; number) => Node[] | |
| getRowSubTotalsNodes | 获取行头小计单元格节点 | (level?; number) => Node[] | |
| getRowGrandTotalsNodes | 获取行头总计单元格节点 | (level?: number) => Node[] | |
| getColNodes | 获取列头节点 | (level?: number) => Node[] | |
| getColNodeById | 根据 id 获取单个列头节点 | (id: string) => Node | |
| getColNodeByIndex | 根据行头索引获取指定列头节点 | (colIndex: number) => Node | |
| getColNodesByField | 根据 field 获取列节点 | (field: string) => Node[] | |
| getColLeafNodes | 获取列头单元格叶子节点 | () => Node[] | |
| getColLeafNodeByIndex | 根据列头索引获取指定列头叶子节点 | () => Node[] | |
| getColTotalsNodes | 获取列头汇总单元格节点 | (level?; number) => Node[] | |
| getColSubTotalsNodes | 获取列头小计单元格节点 | (level?; number) => Node[] | |
| getColGrandTotalsNodes | 获取列头总计单元格节点 | (level?: number) => Node[] | |
| getDataCells | 获取数值单元格 （不含可视区域） | () => DataCell[] | |
| getRowCells | 获取行头单元格 （不含可视区域） | () => RowCell[] | |
| getRowLeafCells | 获取行头叶子节点单元格 （不含可视区域） | () => RowCell[] | |
| getColCells | 获取列头单元格 （不含可视区域） | () => ColCell[] | |
| getColCells | 获取列头叶子节点单元格 （不含可视区域） | () => ColCell[] | |
| getMergedCells | 获取合并单元格 （不含可视区域） | () => MergedCell[] | |
| getCornerCells | 获取角头单元格 （不含可视区域） | () => CornerCell[] | |
| getSeriesNumberCells | 获取序号单元格 （不含可视区域） | () => SeriesNumberCell[] | |
| getHeaderCells | 获取表头单元格 （序号，角头，行头，列头） （不含可视区域） | (cellIds?: string[]) => S2CellType[] | |
| getCellById | 根据单元格 id 获取指定单元格 （不含可视区域） | (id: string) => S2CellType[] | |
| getCellsByField | 根据单元格 field 获取指定单元格 （不含可视区域） | (field: string) => S2CellType[] | |
| getCells | 获取所有单元格 （角头，行头，列头，数值） （不含可视区域） | (ids: string[]) => S2CellType[] | |
| getInitColLeafNodes | 获取初始化时的记录的列头叶子节点 | () => Node[] | |
| clearInitColLeafNodes | 清楚初始化时的记录的列头叶子节点 | () => void | |
| getCellMeta | 根据行列索引获取数值单元格信息 | (rowIndex: number, colIndex: number) => ViewMeta |
export interface CellScrollOffset {deltaX?: number;deltaY?: number;offset?: number;offsetX: number;offsetY: number;}
export interface LayoutResult {colNodes: Node[];colsHierarchy: Hierarchy;rowNodes: Node[];rowsHierarchy: Hierarchy;rowLeafNodes: Node[];colLeafNodes: Node[];}
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 GridInfo {cols: number[];rows: number[];}
export interface ViewCellHeights {getCellOffsetY: (index: number) => number;getTotalHeight: () => number;getTotalLength: () => number;getIndexRange: (minHeight: number,maxHeight: number,) => {start: number;end: number;};}
export interface ScrollOffsetConfig {skipScrollEvent?: boolean;rowHeaderOffsetX?: {value: number | undefined;animate?: boolean;};offsetX?: {value: number | undefined;animate?: boolean;};offsetY?: {value: number | undefined;animate?: boolean;};}
export interface ScrollOffset {scrollX?: number;scrollY?: number;rowHeaderScrollX?: number;}