@visactor/vtable 1.19.9-alpha.3 → 1.20.0-alpha.0

package/es/ts-types/base-table.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ts-types/base-table.ts"],"names":[],"mappings":"","file":"base-table.js","sourcesContent":["import type { IBoundsLike, ITextSize } from '@visactor/vutils';\nimport type {\n  RectProps,\n  MaybePromiseOrUndefined,\n  ICellHeaderPaths,\n  CellInfo,\n  CustomCellStyle,\n  CustomCellStyleArrangement,\n  IDimensionInfo\n} from './common';\nimport type {\n  TableEventListener,\n  TableEventHandlersEventArgumentMap,\n  TableEventHandlersReturnMap,\n  EventListenerId,\n  MousePointerCellEvent\n} from './events';\nimport type { MenuListItem, DropDownMenuEventInfo, DropDownMenuHighlightInfo } from './menu';\nimport type { CellStyle } from './style-define';\nimport type { ColumnIconOption } from './icon';\nimport type {\n  ColumnData,\n  ColumnDefine,\n  ColumnsDefine,\n  HeaderData,\n  IndicatorData,\n  SeriesNumberColumnData\n} from './list-table/layout-map/api';\nexport type { HeaderData } from './list-table/layout-map/api';\nimport type { TableTheme } from '../themes/theme-define';\nimport type { ICustomRender } from './customElement';\nimport type { GroupByOption, LayoutObjectId } from './table-engine';\nimport type { Rect } from '../tools/Rect';\nimport type { Scenegraph } from '../scenegraph/scenegraph';\nimport type { StateManager } from '../state/state';\nimport type { EventManager } from '../event/event';\nimport type {\n  CellAddress,\n  CellRange,\n  CellLocation,\n  ColumnTypeOption,\n  DataSourceAPI,\n  FieldData,\n  FieldDef,\n  FieldFormat,\n  FullExtendStyle,\n  HeaderValues,\n  HeightModeDef,\n  HierarchyState,\n  IPivotTableDataConfig,\n  IPagination,\n  ITableThemeDefine,\n  SortState,\n  TableKeyboardOptions,\n  WidthModeDef,\n  IHeaderTreeDefine,\n  IDimension,\n  IIndicator,\n  StickCell,\n  CustomMergeCell,\n  CustomMerge,\n  IColumnDimension,\n  IRowDimension,\n  TableEventOptions,\n  IPivotChartDataConfig,\n  IListTableDataConfig,\n  IRowSeriesNumber,\n  ColumnSeriesNumber,\n  ColumnStyleOption,\n  WidthAdaptiveModeDef,\n  HeightAdaptiveModeDef,\n  ColumnInfo,\n  RowInfo,\n  CellAddressWithBound,\n  Placement,\n  CustomMergeCellFunc\n} from '.';\nimport type { TooltipOptions } from './tooltip';\nimport type { IWrapTextGraphicAttribute } from '../scenegraph/graphic/text';\nimport type { ICustomLayout } from './customLayout';\nimport type { CachedDataSource, DataSource } from '../data';\nimport type { MenuHandler } from '../components/menu/dom/MenuHandler';\nimport type { PivotHeaderLayoutMap } from '../layout/pivot-header-layout';\nimport type { SimpleHeaderLayoutMap } from '../layout';\nimport type { TooltipHandler } from '../components/tooltip/TooltipHandler';\nimport type { BodyHelper } from '../body-helper/body-helper';\nimport type { HeaderHelper } from '../header-helper/header-helper';\nimport type { EventHandler } from '../event/EventHandler';\nimport type { NumberMap } from '../tools/NumberMap';\nimport type { FocusInput } from '../core/FouseInput';\nimport type { ITableLegendOption } from './component/legend';\nimport type { DataSet } from '@visactor/vdataset';\nimport type { Title } from '../components/title/title';\nimport type { ITitle } from './component/title';\nimport type { DiscreteTableLegend } from '../components/legend/discrete-legend/discrete-legend';\nimport type { ContinueTableLegend } from '../components/legend/continue-legend/continue-legend';\nimport type { NumberRangeMap } from '../layout/row-height-map';\nimport type { RowSeriesNumberHelper } from '../core/row-series-number-helper';\nimport type { ReactCustomLayout } from '../components/react/react-custom-layout';\nimport type { ISortedMapItem } from '../data/DataSource';\nimport type { IAnimationAppear, ITableAnimationOption } from './animation/appear';\nimport type { IEmptyTip } from './component/empty-tip';\nimport type { EmptyTip } from '../components/empty-tip/empty-tip';\nimport type { EditManager } from '../edit/edit-manager';\nimport type { TableAnimationManager } from '../core/animation';\nimport type { CustomCellStylePlugin } from '../plugins/custom-cell-style';\nimport type { IVTablePlugin } from '../plugins/interface';\n\nexport interface IBaseTableProtected {\n  element: HTMLElement;\n  // scrollable: Scrollable;\n  handler: EventHandler;\n  focusControl: FocusInput;\n  canvas: HTMLCanvasElement;\n  context: CanvasRenderingContext2D;\n  rowCount: number;\n  colCount: number;\n  frozenColCount: number;\n  unfreezeAllOnExceedsMaxWidth: boolean;\n  allowFrozenColCount: number;\n\n  frozenRowCount: number;\n  rightFrozenColCount: number;\n  bottomFrozenRowCount: number;\n  defaultRowHeight: number | 'auto';\n  /**表头默认行高 可以按逐行设置 如果没有就取defaultRowHeight */\n  defaultHeaderRowHeight: (number | 'auto') | (number | 'auto')[];\n  defaultColWidth: number;\n  defaultHeaderColWidth: (number | 'auto') | (number | 'auto')[];\n  // font?: string;\n  // underlayBackgroundColor?: string;\n  keyboardOptions?: TableKeyboardOptions;\n  eventOptions?: TableEventOptions;\n  rowSeriesNumber?: IRowSeriesNumber;\n  /** 启动复选框级联 */\n  enableCheckboxCascade?: boolean;\n  /** 表头复选框是否级联整列状态 */\n  enableHeaderCheckboxCascade?: boolean;\n  columnSeriesNumber?: ColumnSeriesNumber[];\n  // disableRowHeaderColumnResize?: boolean;\n\n  columnResizeMode?: 'all' | 'none' | 'header' | 'body';\n\n  rowResizeMode?: 'all' | 'none' | 'header' | 'body';\n\n  columnResizeType?: 'column' | 'indicator' | 'all' | 'indicatorGroup';\n\n  rowResizeType?: 'row' | 'indicator' | 'all' | 'indicatorGroup';\n  /** 控制拖拽表头移动位置顺序开关 */\n  dragHeaderMode?: 'all' | 'none' | 'column' | 'row';\n  /** 拖拽表头移动位置 针对冻结部分的规则\n   * \"disabled\"（禁止调整冻结列位置）：不允许其他列的表头移入冻结列，也不允许冻结列移出，冻结列保持不变。\n   * \"adjustFrozenCount\"（根据交互结果调整冻结数量）：允许其他列的表头移入冻结列，及冻结列移出，并根据拖拽的动作调整冻结列的数量。当其他列的表头被拖拽进入冻结列位置时，冻结列数量增加；当其他列的表头被拖拽移出冻结列位置时，冻结列数量减少。\n   * \"fixedFrozenCount\"（可调整冻结列，并维持冻结数量不变）：允许自由拖拽其他列的表头移入或移出冻结列位置，同时保持冻结列的数量不变。\n   */\n  frozenColDragHeaderMode?: 'disabled' | 'adjustFrozenCount' | 'fixedFrozenCount';\n  cachedRecordsRowHeightMap: NumberMap<string | number>; //存储每一条记录对应行的行高，只有当设置为自动换行随内容撑开才会起作用\n  // headerRowHeightsMap: NumberMap<number>; //目前是用来存储了表头各行的高度，从headerRowHeight计算而来，headerRowHeight可以设置为数组的形式\n  _rowHeightsMap: NumberRangeMap; //存储数据条目每行高度\n  _colWidthsMap: NumberMap<string | number>; //存储各列的宽度\n  _colContentWidthsMap: NumberMap<string | number>; //存储各列的内容宽度\n  _colWidthsLimit: {\n    //存储各列的宽度限制\n    [col: number]: {\n      max?: string | number;\n      min?: string | number;\n    };\n  };\n  calcWidthContext: {\n    _: IBaseTableProtected;\n    full: number;\n    // em: number;\n  };\n\n  _rowRangeHeightsMap: Map<string, number>; //存储指定行范围的总高度\n  _colRangeWidthsMap: Map<string, number>; //存储指定列范围的总宽度\n\n  _widthResizedColMap: Set<number | string>; //记录下被手动调整过列宽的列号\n  _heightResizedRowMap: Set<number>; //记录下被手动调整过行高的行号\n\n  bodyHelper: BodyHelper;\n  headerHelper: HeaderHelper;\n  rowSeriesNumberHelper: RowSeriesNumberHelper;\n\n  cellTextOverflows: { [at: string]: string };\n  // headerDescriptions: { [at: string]: string };\n  focusedTable: boolean;\n\n  // scroll: {\n  //   left: number;\n  //   top: number;\n  // };\n  releaseList?: { release: () => void }[] | null;\n  theme: TableTheme;\n  transpose?: boolean; //是否转置\n  // autoRowHeight?: boolean; //是否自动撑开高度 对于设置了autoWrapText的multilineText的列生效\n  pixelRatio?: number;\n  /** 下拉菜单的相关配置。消失时机：显示后点击菜单区域外自动消失*/\n  menu: {\n    /** 代替原来的option.menuType */\n    renderMode?: 'canvas' | 'html';\n    /** 内置下拉菜单的全局设置项 目前只针对基本表格有效 会对每个表头单元格开启默认的下拉菜单功能。代替原来的option.dropDownMenu*/\n    defaultHeaderMenuItems?:\n      | MenuListItem[]\n      | ((args: { row: number; col: number; table: BaseTableAPI }) => MenuListItem[]);\n    /** 右键菜单。代替原来的option.contextmenu */\n    contextMenuItems?:\n      | MenuListItem[]\n      | ((field: FieldDef, row: number, col: number, table?: BaseTableAPI) => MenuListItem[]);\n    /** 设置选中状态的菜单。代替原来的option.dropDownMenuHighlight  */\n    dropDownMenuHighlight?: DropDownMenuHighlightInfo[];\n    /** 右键菜单是否只工作在单元格上。默认true只在单元格上显示右键菜单, 配置false在空白处也弹出右键菜单  */\n    contextMenuWorkOnlyCell?: boolean;\n    parentElement?: HTMLElement;\n  };\n  /** 提示弹框的相关配置。消失时机：显示后鼠标移动到指定区域外或者进入新的单元格后自动消失*/\n  tooltip: {\n    parentElement: HTMLElement;\n    renderMode: 'html' | 'canvas';\n    /** 代替原来hover:isShowTooltip配置 */\n    isShowOverflowTextTooltip: boolean | ((col: number, row: number, table: BaseTableAPI) => boolean);\n    /** 缩略文字提示框 延迟消失时间 */\n    overflowTextTooltipDisappearDelay?: number;\n    /** 弹框是否需要限定在表格区域内 */\n    confine: boolean;\n    position: Placement;\n  };\n\n  dataSourceEventIds?: EventListenerId[];\n  // headerEvents?: EventListenerId[];\n  layoutMap: SimpleHeaderLayoutMap | PivotHeaderLayoutMap;\n  headerValues?: HeaderValues;\n  tooltipHandler: TooltipHandler;\n\n  // headerRowHeight: number[] | number;//移到了BaseTable\n  sortState: SortState | SortState[];\n  multipleSort?: boolean;\n\n  dataSource: DataSource | CachedDataSource;\n  records?: any;\n  allowRangePaste: boolean;\n  //重新思考逻辑：如果为false，行高按设置的rowHeight；如果设置为true，则按lineHeight及是否自动换行综合计算行高 2021.11.19 by：lff\n\n  autoWrapText?: boolean;\n  enableLineBreak?: boolean;\n\n  menuHandler: MenuHandler;\n\n  /**\n   * 计算列宽时 指定最大列宽 可设置boolean或者具体的值 默认为450\n   */\n  limitMaxAutoWidth?: boolean | number;\n\n  /**\n   * 限制列宽最小值。\n   */\n  limitMinWidth?: number;\n\n  limitMinHeight?: number;\n\n  title?: Title;\n  legends?: (DiscreteTableLegend | ContinueTableLegend)[];\n\n  emptyTip?: EmptyTip;\n  //是否开启图表异步渲染\n  renderChartAsync?: boolean;\n  // // 开启图表异步渲染 每批次渐进渲染图表个数\n  // renderChartAsyncBatchCount?: number;\n\n  stick: { changedCells: Map<string, StickCell> };\n\n  customMergeCell?: CustomMergeCellFunc;\n  /**\n   * 'auto':和浏览器滚动行为一致 表格滚动到顶部/底部时 触发浏览器默认行为;\n   *  设置为 'none' 时, 表格滚动到顶部/底部时, 不再触发父容器滚动\n   * */\n  overscrollBehavior?: 'auto' | 'none';\n\n  modifiedViewBoxTransform?: boolean;\n  // react component container\n  bodyDomContainer?: HTMLElement;\n  headerDomContainer?: HTMLElement;\n  frozenBodyDomContainer?: HTMLElement;\n  frozenHeaderDomContainer?: HTMLElement;\n  rightFrozenBodyDomContainer?: HTMLElement;\n  rightFrozenHeaderDomContainer?: HTMLElement;\n  frozenBottomDomContainer?: HTMLElement;\n  bottomDomContainer?: HTMLElement;\n  rightFrozenBottomDomContainer?: HTMLElement;\n\n  // 已使用一行的高度填充所有行\n  useOneRowHeightFillAll?: boolean;\n\n  // 启用树形结构数据内的merge配置\n  enableTreeNodeMerge?: boolean;\n\n  _oldRowCount?: number;\n  _oldColCount?: number;\n\n  columnWidthConfig?: any;\n}\nexport interface BaseTableConstructorOptions {\n  // /** 指定表格的行数 */\n  // rowCount?: number;\n\n  // /** 指定表格的列数 */\n  // colCount?: number;\n  /**\n   * 当前需要冻结的列数 基本表格生效\n   */\n  frozenColCount?: number;\n  frozenRowCount?: number;\n  rightFrozenColCount?: number;\n  bottomFrozenRowCount?: number;\n  /** 最大冻结宽度，固定值 or 百分比。默认为'80%' */\n  maxFrozenWidth?: number | string;\n  /** 超过最大冻结宽度后是否全部解冻，默认true */\n  unfreezeAllOnExceedsMaxWidth?: boolean;\n\n  // /** 待实现 TODO */\n  // frozenRowCount?: number;\n  /** 可冻结列数，表示前多少列会出现冻结操作按钮 基本表格生效 */\n  allowFrozenColCount?: number;\n  /**\n   * 默认行高. 默认 40\n   */\n  defaultRowHeight?: number | 'auto';\n  /** 列表头默认行高 可以按逐行设置 如果没有就取defaultRowHeight */\n  defaultHeaderRowHeight?: (number | 'auto') | (number | 'auto')[];\n  /**\n   * 默认列宽. 默认 80\n   */\n  defaultColWidth?: number;\n  /** 行表头默认列宽 可以按逐列设置 如果没有就取defaultColWidth */\n  defaultHeaderColWidth?: (number | 'auto') | (number | 'auto')[];\n  /** 快捷键功能设置 */\n  keyboardOptions?: TableKeyboardOptions;\n  excelOptions?: {\n    fillHandle?: boolean | ((args: { selectRanges: CellRange[]; table: BaseTableAPI }) => boolean);\n  };\n  /** 事件触发相关设置 */\n  eventOptions?: TableEventOptions;\n  /**\n   * Canvas container\n   */\n  container?: HTMLElement | null;\n\n  /**\n   * @deprecated\n   * 请使用resize.columnResizeMode\n   * 调整列宽 可操作范围。'all' | 'none' | 'header' | 'body'; 整列间隔线|禁止调整|只能在表头处间隔线|只能在body间隔线\n   */\n  columnResizeMode?: 'all' | 'none' | 'header' | 'body';\n  /**\n   * @deprecated\n   * 请使用resize.rowResizeMode\n   */\n  rowResizeMode?: 'all' | 'none' | 'header' | 'body';\n\n  /**\n   * @deprecated\n   * dragOrder.dragHeaderMode\n   * 控制拖拽表头移动位置顺序开关\n   */\n  dragHeaderMode?: 'all' | 'none' | 'column' | 'row';\n\n  /**\n   * 是否显示固定列图钉 基本表格生效\n   */\n  showFrozenIcon?: boolean;\n\n  padding?:\n    | {\n        top?: number;\n        bottom?: number;\n        left?: number;\n        right?: number;\n      }\n    | number;\n  /** hover交互配置 */\n  hover?: {\n    /** hover交互响应模式：十字交叉 整列 整行 或者单个单元格 */\n    highlightMode?: 'cross' | 'column' | 'row' | 'cell';\n    /** 不响应鼠标hover交互 */\n    disableHover?: boolean;\n    /** 单独设置表头不响应鼠标hover交互 */\n    disableHeaderHover?: boolean;\n    /** 单独设置坐标轴不响应鼠标hover交互 */\n    disableAxisHover?: boolean;\n  };\n  /** 选择单元格交互配置 */\n  select?: {\n    /** 高亮范围模式：十字交叉 整列 整行 或者单个单元格。默认`cell` */\n    highlightMode?: 'cross' | 'column' | 'row' | 'cell';\n    /** 点击表头单元格效果\n     * 'inline': 点击行表头则整行选中，选择列表头则整列选中；\n     * 'cell': 仅仅选择当前点击的表头单元格；\n     * 'body': 不选择表头，点击行表头则选择该行所有 body 单元格，点击列表头则选择该列所有 body 单元格。\n     */\n    headerSelectMode?: 'inline' | 'cell' | 'body';\n    /** 点击表头corner单元格效果\n     * 'inline': 点击corner选择列表头则整列选中；\n     * 'cell': 仅仅选择当前点击的corner表头单元格；\n     * 'body': 点击corner列表头则选择该列所有 body 单元格；\n     * 'all': 点击corner选择整个图表。\n     */\n    cornerHeaderSelectMode?: 'inline' | 'cell' | 'body' | 'all';\n    /** 不响应鼠标select交互 */\n    disableSelect?: boolean | ((col: number, row: number, table: BaseTableAPI) => boolean);\n    /** 单独设置表头不响应鼠标select交互 */\n    disableHeaderSelect?: boolean;\n    /** 点击空白区域是否取消选中 */\n    blankAreaClickDeselect?: boolean;\n    /** 点击外部区域是否取消选中 */\n    outsideClickDeselect?: boolean; //\n    /**  禁止拖拽框选 */\n    disableDragSelect?: boolean;\n    /** 是否在选择多行或多列时高亮范围 */\n    highlightInRange?: boolean;\n    /** 是否将选中的单元格自动滚动到视口内 默认为true */\n    makeSelectCellVisible?: boolean;\n  };\n  /** 下拉菜单的相关配置。消失时机：显示后点击菜单区域外自动消失*/\n  menu?: {\n    /** 代替原来的option.menuType  html目前实现较完整 先默认html渲染方式*/\n    renderMode?: 'canvas' | 'html';\n    /** 内置下拉菜单的全局设置项 目前只针对基本表格有效 会对每个表头单元格开启默认的下拉菜单功能。代替原来的option.dropDownMenu*/\n    defaultHeaderMenuItems?:\n      | MenuListItem[]\n      | ((args: { row: number; col: number; table: BaseTableAPI }) => MenuListItem[]);\n    /** 右键菜单。代替原来的option.contextmenu */\n    contextMenuItems?:\n      | MenuListItem[]\n      | ((field: string, row: number, col: number, table?: BaseTableAPI) => MenuListItem[]);\n    /** 设置选中状态的菜单。代替原来的option.dropDownMenuHighlight  */\n    dropDownMenuHighlight?: DropDownMenuHighlightInfo[];\n    /** 右键菜单是否只工作在单元格上。默认true只在单元格上显示右键菜单, 配置false在空白处也弹出右键菜单  */\n    contextMenuWorkOnlyCell?: boolean;\n    parentElement?: HTMLElement;\n  };\n  /** tooltip相关配置 */\n  tooltip?: {\n    parentElement?: HTMLElement;\n    /** html目前实现较完整 先默认html渲染方式 */\n    renderMode?: 'html'; // 目前暂不支持canvas方案\n    /** 是否显示缩略文字提示框。 代替原来hover:isShowTooltip配置 暂时需要将renderMode配置为html才能显示，canvas的还未开发*/\n    isShowOverflowTextTooltip?: boolean | ((col: number, row: number, table: BaseTableAPI) => boolean);\n    /** 缩略文字提示框 延迟消失时间 */\n    overflowTextTooltipDisappearDelay?: number;\n    /** 是否将 tooltip 框限制在画布区域内，默认开启。针对renderMode:\"html\"有效 */\n    confine?: boolean;\n    position?: Placement;\n  };\n  /**\n   * Theme\n   */\n  theme?: ITableThemeDefine;\n  /** 宽度模式 */\n  widthMode?: 'standard' | 'adaptive' | 'autoWidth';\n  /** 高度模式 */\n  heightMode?: 'standard' | 'adaptive' | 'autoHeight';\n  /** 当列宽度不能占满容器时，是否需要自动拉宽来填充容器的宽度。默认false */\n  autoFillWidth?: boolean;\n  /** 当行高度不能占满容器时，是否需要自动拉高来填充容器的高度。默认false */\n  autoFillHeight?: boolean;\n  /** 内容自适应模式，确保表格大小始终等于容器大小，保持原有的列宽/行高不变。默认false */\n  containerFit?: {\n    width?: boolean; // 是否自适应宽度，默认true\n    height?: boolean; // 是否自适应高度，默认true\n  };\n\n  /** adaptive 模式下宽度的适应策略 **/\n  widthAdaptiveMode?: WidthAdaptiveModeDef;\n  /** adaptive 模式下高度的适应策略 **/\n  heightAdaptiveMode?: HeightAdaptiveModeDef;\n  /** 当配置adaptive模式时，默认true，即在计算每行行高的基础上去等比拉伸行高撑满容器宽度的。如果不需要计算行高用默认行高撑满的话请配置为false */\n  autoHeightInAdaptiveMode?: boolean;\n\n  // /** 行高是否根据内容来计算 */\n  // autoRowHeight?: boolean;\n  /** 设备的像素比 不配的话默认获取window.devicePixelRatio */\n  pixelRatio?: number;\n  /** 自定义渲染 函数形式*/\n  customRender?: ICustomRender;\n  /** 开启自动换行 默认false */\n  autoWrapText?: boolean;\n  /** 是否处理换行符 */\n  enableLineBreak?: boolean;\n  /** 单元格中可显示最大字符数 默认200 */\n  maxCharactersNumber?: number; //\n  // /** toolip最大字符数 */\n  // maxTooltipCharactersNumber?: number;\n  /** 最大可操作条目数 如copy操作可复制出最大数据条目数 */\n  maxOperatableRecordCount?: number;\n  /**\n   * 计算列宽时 指定最大列宽 可设置boolean或者具体的值 默认为450。手动拖拽列宽的话不收这个限制\n   */\n  limitMaxAutoWidth?: boolean | number;\n  /**\n   * 限制列宽最小值。如设置为true 则拖拽改变列宽时限制列宽最小为10px，设置为false则不进行限制。默认为10px\n   */\n  limitMinWidth?: boolean | number;\n  limitMinHeight?: boolean | number;\n\n  // maximum number of data items maintained in table instance\n  maintainedDataCount?: number;\n  // maximum number of columns maintained in table instance\n  maintainedColumnCount?: number;\n\n  legends?: ITableLegendOption | ITableLegendOption[];\n  title?: ITitle;\n  emptyTip?: true | IEmptyTip;\n  /** 是否开启图表异步渲染 */\n  renderChartAsync?: boolean;\n  /** 开启图表异步渲染 每批次渐进渲染图表个数  默认是5个 */\n  renderChartAsyncBatchCount?: number;\n\n  customMergeCell?: CustomMergeCell;\n\n  // #region for nodejs\n  mode?: 'node' | 'browser';\n  modeParams?: any;\n  canvasWidth?: number | 'auto';\n  canvasHeight?: number | 'auto';\n  maxCanvasWidth?: number;\n  maxCanvasHeight?: number;\n\n  // #endregion\n  /**\n   * 'auto':和浏览器滚动行为一致 表格滚动到顶部/底部时 触发浏览器默认行为;\n   *  设置为 'none' 时, 表格滚动到顶部/底部时, 不再触发父容器滚动\n   * */\n  overscrollBehavior?: 'auto' | 'none';\n\n  // resize response time\n  resizeTime?: number;\n\n  canvas?: HTMLCanvasElement;\n  viewBox?: IBoundsLike;\n  chartOption?: any;\n  disableInteraction?: boolean;\n\n  // 渲染时的 spec 改变\n  specFormat?: (\n    spec: any,\n    chartInstance: any,\n    chart: any\n  ) => { needFormatSpec: boolean; spec?: any; updateSpec?: boolean };\n  // chart 单元格 的 spec 生成时的转换\n  specTransformInCell?: (spec: any, col: number, row: number) => any;\n\n  beforeRender?: (stage: any) => void;\n  afterRender?: (stage: any) => void;\n  rowSeriesNumber?: IRowSeriesNumber;\n  /** 启用复选框级联 */\n  enableCheckboxCascade?: boolean;\n  /** 表头复选框是否级联整列状态 */\n  enableHeaderCheckboxCascade?: boolean;\n  // columnSeriesNumber?: ColumnSeriesNumber[];\n  customCellStyle?: CustomCellStyle[];\n  customCellStyleArrangement?: CustomCellStyleArrangement[];\n\n  columnWidthComputeMode?: 'normal' | 'only-header' | 'only-body';\n  clearDOM?: boolean;\n  customConfig?: {\n    /** xTable对于没有配置autoWrapText并且有'\\n'的文本，在计算行高是会当做一行处理，但是在渲染时会解析'\\n'；显示效果就是单元格高度为一行文本高度，只显示第一个'\\n'前的文字，后面显示'...'；multilinesForXTable配置实现和该功能对齐的样式 */\n    multilinesForXTable?: boolean;\n    /** 这里可以配置为false 来走flatDataToObject的数据处理逻辑 而不走dataset的分析 */\n    enableDataAnalysis?: boolean;\n    /** 禁用行高列宽计算取整数逻辑 对齐xTable */\n    _disableColumnAndRowSizeRound?: boolean;\n    imageMargin?: number;\n    // 是否创建react custom container\n    createReactContainer?: boolean;\n    // adaptive 模式下优先缩小迷你图\n    shrinkSparklineFirst?: boolean;\n\n    // 行列移动不更新表格\n    notUpdateInColumnRowMove?: boolean;\n\n    // 表格是否限制内容高度\n    limitContentHeight?: boolean;\n\n    // 图片资源请求时是否使用anonymous模式\n    imageAnonymous?: boolean;\n\n    // 滚动到边界是否继续触发滚动事件\n    scrollEventAlwaysTrigger?: boolean;\n\n    // 开启透视结构缓存\n    enablePivotPathCache?: boolean;\n\n    // 是否禁用内置图表激活\n    disableBuildInChartActive?: boolean;\n    /** 强制计算所有行高，用于某些场景下，如vtable-gantt中，需要一次性计算所有行高 */\n    forceComputeAllRowHeight?: boolean;\n  }; // 部分特殊配置，兼容xTable等作用\n\n  animationAppear?: boolean | IAnimationAppear;\n\n  renderOption?: any;\n\n  formatCopyValue?: (value: string) => string;\n  customComputeRowHeight?: (computeArgs: { row: number; table: BaseTableAPI }) => number | 'auto' | undefined;\n  /** 当表格出现抖动情况，请排查是否上层dom容器的宽高是小数引起的。如果不能保证是整数，请配置这个配置项为true */\n  tableSizeAntiJitter?: boolean;\n\n  /**\n   * @deprecated 请使用resize.disableDblclickAutoResizeColWidth\n   */\n  disableDblclickAutoResizeColWidth?: boolean;\n\n  /** resize交互配置 **/\n  resize?: {\n    /**\n     * 调整列宽 可操作范围。'all' | 'none' | 'header' | 'body'; 整列间隔线|禁止调整|只能在表头处间隔线|只能在body间隔线\n     */\n    columnResizeMode?: 'all' | 'none' | 'header' | 'body';\n    rowResizeMode?: 'all' | 'none' | 'header' | 'body';\n    /** 是否禁用双击列边框自动调整列宽 **/\n    disableDblclickAutoResizeColWidth?: boolean;\n  };\n  dragOrder?: {\n    /** 控制拖拽表头移动位置顺序开关 */\n    dragHeaderMode?: 'all' | 'none' | 'column' | 'row';\n    /** 拖拽移动位置结束时进行验证 */\n    validateDragOrderOnEnd?: (source: CellAddress, target: CellAddress) => boolean;\n  };\n  /** 插件配置 */\n  plugins?: IVTablePlugin[];\n}\nexport interface BaseTableAPI {\n  id: string;\n  /** 数据总条目数 */\n  recordsCount: number;\n  /** 表格的行数 */\n  rowCount: number;\n  /** 表格的列数 */\n  colCount: number;\n  /** 表格除去外层frame后的宽度 */\n  tableNoFrameWidth: number;\n  /** 表格除去外层frame后的高度 */\n  tableNoFrameHeight: number;\n  /** 表格的冻结行数 包括表头在内 */\n  frozenRowCount: number;\n  /** 表格的冻结列数 包括表头在内 */\n  frozenColCount: number;\n\n  bottomFrozenRowCount: number;\n  rightFrozenColCount: number;\n  /** 当前表格默认表头行高 */\n  defaultHeaderRowHeight: (number | 'auto') | (number | 'auto')[];\n  /** 当前表格默认行高 */\n  defaultRowHeight: number;\n  /** 当前表格默认列宽 */\n  defaultColWidth: number;\n  /** 当前表格默认表头列宽 */\n  defaultHeaderColWidth: (number | 'auto') | (number | 'auto')[];\n  /** 当前表格快捷键设置 */\n  keyboardOptions: TableKeyboardOptions | null;\n  /** 当前表格事件相关设置 */\n  eventOptions: TableEventOptions | null;\n  /**\n   * 是否显示图钉\n   */\n  showFrozenIcon: boolean;\n  readonly canvas: HTMLCanvasElement;\n  /** 表格可视区域的行数 */\n  readonly visibleRowCount: number;\n  /** 表格可视区域的列数 */\n  readonly visibleColCount: number;\n  /** 表格滚动值left */\n  scrollLeft: number;\n  /** 表格滚动值top */\n  scrollTop: number;\n  /** 用户设置的options 不要修改这个这个 */\n  options: BaseTableConstructorOptions;\n  /** 设置的全局下拉菜单列表项配置 */\n  globalDropDownMenu?: MenuListItem[] | ((args: { row: number; col: number; table: BaseTableAPI }) => MenuListItem[]);\n  /** 设置的全局自定义渲染函数 */\n  customRender?: ICustomRender;\n\n  /** 表格数据管理对象 */\n  dataSource: DataSourceAPI;\n  /** 设置的表格主题 */\n  theme: TableTheme;\n  /** 可允许设置冻结的最大列数 */\n  allowFrozenColCount: number;\n\n  /** 存储内部用到的属性 变量等 */\n  internalProps: IBaseTableProtected;\n  /** 分页信息 */\n  pagination?: IPagination;\n\n  /** 表格偏移像素值 水平方向 */\n  tableX: number;\n  /** 表格偏移像素值 垂直方向 */\n  tableY: number;\n  /** 表格宽度模式 */\n  widthMode: WidthModeDef;\n  /** 表格宽度模式 */\n  heightMode: HeightModeDef;\n  /** 当列宽度不能占满容器时，是否需要自动拉宽来填充容器的宽度。默认false */\n  autoFillWidth: boolean;\n  /** 当行高度不能占满容器时，是否需要自动拉高来填充容器的高度。默认false */\n  autoFillHeight?: boolean;\n  /** 内容自适应模式，确保表格大小始终等于容器大小，保持原有的列宽/行高不变。默认false */\n  containerFit?: { width: boolean; height: boolean };\n\n  /** adaptive 模式下宽度的适应策略 **/\n  widthAdaptiveMode: WidthAdaptiveModeDef;\n  /** adaptive 模式下高度的适应策略 **/\n  heightAdaptiveMode: HeightAdaptiveModeDef;\n\n  isReleased: boolean;\n\n  // rowHeightsMap: NumberMap<number>;\n  rowHeightsMap: NumberRangeMap;\n  colWidthsMap: NumberMap<string | number>;\n  hasListeners: (type: string) => boolean;\n  on: <TYPE extends keyof TableEventHandlersEventArgumentMap>(\n    type: TYPE,\n    listener: TableEventListener<TYPE> //(event: TableEventHandlersEventArgumentMap[TYPE]) => TableEventHandlersReturnMap[TYPE]\n  ) => EventListenerId;\n  // &(<T extends keyof TableEventHandlersEventArgumentMap>(type: string, listener: AnyListener<T>) => EventListenerId);\n\n  _vDataSet?: DataSet;\n  /** 场景树对象 */\n  scenegraph: Scenegraph;\n  /** 状态管理模块 */\n  stateManager: StateManager;\n  /** 事件管理模块 */\n  eventManager: EventManager;\n  /** 动画管理模块 */\n  animationManager: TableAnimationManager;\n\n  editorManager: EditManager;\n  /** 行表头的层数 */\n  rowHeaderLevelCount: number;\n  /** 列表头的层数 */\n  columnHeaderLevelCount: number;\n\n  canvasWidth?: number;\n  canvasHeight?: number;\n\n  columnWidthComputeMode?: 'normal' | 'only-header' | 'only-body';\n\n  _rowRangeHeightsMap: Map<string, number>;\n  _colRangeWidthsMap: Map<string, number>;\n  canvasSizeSeted?: boolean;\n\n  pixelRatio: number;\n  rotateDegree?: number;\n  /** 获取表格绘制的范围 不包括frame的宽度 */\n  getDrawRange: () => Rect;\n  /** 将鼠标坐标值 转换成表格坐标系中的坐标位置 */\n  _getMouseAbstractPoint: (evt: TouchEvent | MouseEvent | undefined) => { x: number; y: number; inTable: boolean };\n  getElement: () => HTMLElement;\n  getContainer: () => HTMLElement;\n\n  setFrozenColCount: (count: number) => void;\n  _setFrozenColCount: (count: number) => void;\n  _updateSize: () => void;\n\n  render: () => void;\n  throttleInvalidate: () => void;\n  getRowHeight: (row: number) => number;\n  getDefaultRowHeight: (row: number) => number | 'auto';\n  getDefaultColumnWidth: (col: number) => number | 'auto';\n  _setRowHeight: (row: number, height: number, clearCache?: boolean) => void;\n  setRowHeight: (row: number, height: number) => void;\n  getColWidth: (col: number) => number;\n  getColWidthDefined: (col: number) => string | number;\n  // setColWidthDefined: (col: number, width: number) => void;\n  getColWidthDefinedNumber: (col: number) => number;\n  // getColWidthDefine: (col: number) => string | number;\n  _setColWidth: (col: number, width: number | string, clearCache?: boolean, skipCheckFrozen?: boolean) => void;\n  setColWidth: (col: number, width: number) => void;\n  _getColContentWidth: (col: number) => number;\n  _setColContentWidth: (col: number, width: number | string, clearCache?: boolean) => void;\n  getMaxColWidth: (col: number) => number;\n  setMaxColWidth: (col: number, maxwidth: string | number) => void;\n  getMinColWidth: (col: number) => number;\n  setMinColWidth: (col: number, minwidth: string | number) => void;\n  getCellRect: (col: number, row: number) => Rect;\n  getCellRelativeRect: (col: number, row: number) => Rect;\n  getCellsRect: (startCol: number, startRow: number, endCol: number, endRow: number) => Rect;\n  getCellRangeRect: (cellRange: CellRange | CellAddress) => Rect;\n  getCellRangeRelativeRect: (cellRange: CellRange | CellAddress) => Rect;\n  getVisibleCellRangeRelativeRect: (cellRange: CellRange | CellAddress) => Rect;\n  isFrozenCell: (col: number, row: number) => { row: boolean; col: boolean } | null;\n  getRowAt: (absoluteY: number) => { top: number; row: number; bottom: number };\n  getColAt: (absoluteX: number) => { left: number; col: number; right: number };\n  getCellAt: (absoluteX: number, absoluteY: number) => CellAddressWithBound;\n  getCellAtRelativePosition: (absoluteX: number, absoluteY: number) => CellAddressWithBound;\n  _makeVisibleCell: (col: number, row: number) => void;\n  // setFocusCursor(col: number, row: number): void;\n  // focusCell(col: number, row: number): void;\n  getCellOverflowText: (col: number, row: number) => string | null;\n  getColsWidth: (startCol: number, endCol: number) => number;\n  getColsWidths: () => number[];\n  getRowsHeight: (startRow: number, endRow: number) => number;\n  _getRangeSizeForContainerFit: (start: number, end: number, totalSize: number, type: 'col' | 'row') => number;\n\n  release: () => void;\n  addReleaseObj: (releaseObj: { release: () => void }) => void;\n  _getCellStyle: (col: number, row: number) => FullExtendStyle;\n  clearCellStyleCache: () => void;\n\n  getFrozenRowsHeight: () => number;\n  getFrozenColsWidth: () => number;\n  getBottomFrozenRowsHeight: () => number;\n  getRightFrozenColsWidth: () => number;\n  selectCell: (\n    col: number,\n    row: number,\n    isShift?: boolean,\n    isCtrl?: boolean,\n    makeSelectCellVisible?: boolean,\n    skipBodyMerge?: boolean\n  ) => void;\n  clearSelected: () => void;\n  selectCells: (cellRanges: CellRange[]) => void;\n  getAllRowsHeight: () => number;\n  getAllColsWidth: () => number;\n\n  off: (id: EventListenerId) => void;\n  getBodyField: (col: number, row: number) => FieldDef | undefined;\n  /**\n   * 根据单元格获取对应的源数据\n   * @param col\n   * @param row\n   * @returns\n   */\n  getRecordByCell: (col: number, row: number) => MaybePromiseOrUndefined;\n  /**\n   * 根据数据源的index 获取显示到表格中的index 行号或者列号（与转置相关）。注：ListTable特有接口\n   * @param recordIndex\n   */\n  getTableIndexByRecordIndex: (recordIndex: number) => number;\n  /**\n   * 根据数据源的field 获取显示到表格中的index 行号或者列号（与转置相关）。注：ListTable特有接口\n   * @param recordIndex\n   */\n  getTableIndexByField: (field: FieldDef) => number;\n  /**\n   * 根据数据源中的index和field获取单元格行列号。注：ListTable特有接口\n   * @param field\n   * @param recordIndex\n   * @returns\n   */\n  getCellAddrByFieldRecord: (field: FieldDef, recordIndex: number) => CellAddress;\n  getRecordShowIndexByCell: (col: number, row: number) => number;\n  getRecordStartRowByRecordIndex: (index: number) => number;\n\n  getHeaderField: (col: number, row: number) => any | undefined;\n\n  _getHeaderCellBySortState: (sortState: SortState) => CellAddress | undefined;\n  getHeaderDefine: (col: number, row: number) => ColumnDefine | IRowSeriesNumber | ColumnSeriesNumber;\n  _getHeaderLayoutMap: (col: number, row: number) => HeaderData | SeriesNumberColumnData;\n  getContext: () => CanvasRenderingContext2D;\n  getCellRange: (col: number, row: number) => CellRange;\n  _resetFrozenColCount: () => void;\n  isCellRangeEqual: (col: number, row: number, targetCol: number, targetRow: number) => boolean;\n  _getLayoutCellId: (col: number, row: number) => LayoutObjectId;\n  _getBodyLayoutMap: (col: number, row: number) => ColumnData | IndicatorData | SeriesNumberColumnData;\n  getBodyColumnDefine: (col: number, row: number) => ColumnDefine | IRowSeriesNumber | ColumnSeriesNumber;\n  getBodyColumnType: (col: number, row: number) => ColumnTypeOption;\n  getCellType: (col: number, row: number) => ColumnTypeOption;\n  fireListeners: <TYPE extends keyof TableEventHandlersEventArgumentMap>(\n    type: TYPE,\n    event: TableEventHandlersEventArgumentMap[TYPE]\n  ) => TableEventHandlersReturnMap[TYPE][];\n\n  //更新分页\n  updatePagination: (cof: IPagination) => void;\n  //hover\n\n  getHeaderDescription: (col: number, row: number) => string | undefined;\n  /** 获取单元格展示值 */\n  getCellValue: (col: number, row: number, skipCustomMerge?: boolean) => string | null;\n  /** 获取单元格展示数据的format前的值 */\n  getCellOriginValue: (col: number, row: number) => any;\n  /** 获取单元格展示数据源最原始值 */\n  getCellRawValue: (col: number, row: number) => FieldData;\n  /** 获取单元格展示数据的format前的record源数据 */\n  getCellOriginRecord: (col: number, row: number) => MaybePromiseOrUndefined;\n  /** 获取单元格展示源数据 */\n  getCellRawRecord: (col: number, row: number) => MaybePromiseOrUndefined;\n\n  _dropDownMenuIsHighlight: (col: number, row: number, index: number) => boolean;\n  // bindEvents(): void;\n  refreshRowColCount: () => void;\n  // getFieldData: (field: FieldDef | FieldFormat | undefined, col: number, row: number) => FieldData;\n  _hasField: (field: FieldDef, col: number, row: number) => boolean;\n  getCellHeaderPaths: (col: number, row: number) => ICellHeaderPaths;\n  getCellLocation: (col: number, row: number) => CellLocation;\n  // isHitIcon(col: number, row: number, x: number, y: number, iconType: IconFuncTypeEnum): boolean;\n  getCellIcons: (col: number, row: number) => ColumnIconOption[];\n\n  getMenuInfo: (col: number, row: number, type: string) => DropDownMenuEventInfo;\n  /**\n   * 获取某个单元格的样式 共业务方调用\n   * @param col\n   * @param row\n   */\n  getCellStyle: (col: number, row: number) => CellStyle; //  计算后style\n\n  getHierarchyState: (col: number, row: number) => HierarchyState | null;\n\n  _canDragHeaderPosition: (col: number, row: number) => boolean;\n\n  isHeader: (col: number, row: number) => boolean;\n\n  isColumnHeader: (col: number, row: number) => boolean;\n\n  isCornerHeader: (col: number, row: number) => boolean;\n\n  isRowHeader: (col: number, row: number) => boolean;\n\n  getCopyValue: () => string;\n\n  getSelectedCellInfos: () => CellInfo[][];\n  getSelectedCellRanges: () => CellRange[];\n  getCellInfo: (col: number, row: number) => Omit<MousePointerCellEvent, 'target'>;\n\n  showTooltip: (col: number, row: number, tooltipOptions?: TooltipOptions) => void;\n\n  measureText: (\n    text: string,\n    font: { fontSize: number; fontWeight?: string | number; fontFamily: string }\n  ) => ITextSize;\n\n  _canResizeColumn: (col: number, row: number) => boolean;\n  _canResizeRow: (col: number, row: number) => boolean;\n\n  getCustomRender: (col: number, row: number) => ICustomRender;\n  getCustomLayout: (col: number, row: number) => ICustomLayout;\n  isListTable: () => boolean;\n  isPivotTable: (() => boolean) & (() => boolean);\n  isPivotChart: (() => boolean) & (() => boolean);\n  _clearColRangeWidthsMap: (col?: number) => void;\n  _clearRowRangeHeightsMap: (row?: number) => void;\n  clearRowHeightCache: () => void;\n  clearColWidthCache: () => void;\n  toggleHierarchyState: (col: number, row: number) => void;\n\n  resize: () => void;\n  /** 直接设置canvas的宽高 不根据容器宽高来决定表格的尺寸 */\n  setCanvasSize: (width: number, height: number) => void;\n  getMergeCellRect: (col: number, row: number) => Rect;\n\n  getTargetColAt: (absoluteX: number) => ColumnInfo | null;\n  getTargetRowAt: (absoluteY: number) => RowInfo | null;\n  getTargetColAtConsiderRightFrozen: (absoluteX: number, isConsider: boolean) => ColumnInfo | null;\n  getTargetRowAtConsiderBottomFrozen: (absoluteY: number, isConsider: boolean) => RowInfo | null;\n  renderWithRecreateCells: () => void;\n  //#endregion  tableAPI\n\n  _adjustColWidth: (col: number, orgWidth: number) => number;\n  _colWidthDefineToPxWidth: (width: string | number) => number;\n  isFrozenColumn: (col: number, row?: number) => boolean;\n  isLeftFrozenColumn: (col: number, row?: number) => boolean;\n  isRightFrozenColumn: (col: number, row?: number) => boolean;\n  isFrozenRow: (col: number, row?: number) => boolean;\n  isTopFrozenRow: (col: number, row?: number) => boolean;\n  isBottomFrozenRow: (col: number, row?: number) => boolean;\n\n  hasCustomMerge: () => boolean;\n  getCustomMerge: (col: number, row: number) => undefined | (Omit<CustomMerge, 'style'> & { style?: FullExtendStyle });\n  /** 获取表格body部分的显示单元格范围 */\n  getBodyVisibleCellRange: () => { rowStart: number; colStart: number; rowEnd: number; colEnd: number };\n  /** 获取表格body部分的显示列号范围 */\n  getBodyVisibleColRange: () => { colStart: number; colEnd: number };\n  /** 获取表格body部分的显示行号范围 */\n  getBodyVisibleRowRange: () => { rowStart: number; rowEnd: number };\n\n  _hasCustomRenderOrLayout: () => boolean;\n  /** 根据表格单元格的行列号 获取在body部分的列索引及行索引 */\n  getBodyIndexByTableIndex: (col: number, row: number) => CellAddress;\n  /** 根据body部分的列索引及行索引，获取单元格的行列号 */\n  getTableIndexByBodyIndex: (col: number, row: number) => CellAddress;\n  /**\n   * 滚动到具体某个单元格位置\n   * @param cellAddr 要滚动到的单元格位置\n   */\n  scrollToCell: (cellAddr: { col?: number; row?: number }, animationOption?: ITableAnimationOption | boolean) => void;\n  scrollToRow: (row: number, animationOption?: ITableAnimationOption | boolean) => void;\n  scrollToCol: (col: number, animationOption?: ITableAnimationOption | boolean) => void;\n  registerCustomCellStyle: (customStyleId: string, customStyle: ColumnStyleOption | undefined | null) => void;\n  arrangeCustomCellStyle: (cellPos: { col?: number; row?: number; range?: CellRange }, customStyleId: string) => void;\n  /** 是否有列是自动计算列宽 */\n  checkHasColumnAutoWidth: () => boolean;\n  _moveHeaderPosition: (\n    source: CellAddress,\n    target: CellAddress\n  ) => {\n    sourceIndex: number;\n    targetIndex: any;\n    sourceSize: any;\n    targetSize: any;\n    moveType: 'column' | 'row';\n  };\n  changeRecordOrder: (source: number, target: number) => void;\n  isSeriesNumber: (col: number, row?: number) => boolean;\n  isHasSeriesNumber: () => boolean;\n  leftRowSeriesNumberCount: number;\n  isAutoRowHeight: (row?: number) => boolean;\n\n  reactCustomLayout?: ReactCustomLayout;\n  checkReactCustomLayout: (removeAllContainer: () => void) => void;\n  setSortedIndexMap: (field: FieldDef, filedMap: ISortedMapItem) => void;\n\n  exportImg: () => string;\n  exportCellImg: (\n    col: number,\n    row: number,\n    options?: { disableBackground?: boolean; disableBorder?: boolean }\n  ) => string;\n  exportCellRangeImg: (cellRange: CellRange) => string;\n  exportCanvas: () => HTMLCanvasElement;\n  setPixelRatio: (pixelRatio: number) => void;\n\n  bodyDomContainer?: HTMLElement;\n  headerDomContainer?: HTMLElement;\n  frozenBodyDomContainer?: HTMLElement;\n  frozenHeaderDomContainer?: HTMLElement;\n  rightFrozenBodyDomContainer?: HTMLElement;\n  rightFrozenHeaderDomContainer?: HTMLElement;\n  frozenBottomDomContainer?: HTMLElement;\n  bottomDomContainer?: HTMLElement;\n  rightFrozenBottomDomContainer?: HTMLElement;\n\n  showMoverLine: (col: number, row: number) => void;\n  hideMoverLine: (col: number, row: number) => void;\n  /** 关闭表格的滚动 */\n  disableScroll: () => void;\n  /** 开启表格的滚动 */\n  enableScroll: () => void;\n\n  customCellStylePlugin?: CustomCellStylePlugin;\n  headerStyleCache: Map<string, any>;\n  bodyBottomStyleCache: Map<string, any>;\n  bodyStyleCache: Map<string, any>;\n  bodyMergeTitleCache: Map<string, any>;\n  isSeriesNumberInBody: (col: number, row: number) => boolean;\n  getGroupTitleLevel: (col: number, row: number) => number | undefined;\n  _getMaxFrozenWidth: () => number;\n  _getComputedFrozenColCount: (frozenColCount: number) => number;\n}\nexport interface ListTableProtected extends IBaseTableProtected {\n  /** 表格数据 */\n  records: any[] | null;\n  dataConfig?: IListTableDataConfig;\n  columns: ColumnsDefine;\n  layoutMap: SimpleHeaderLayoutMap;\n  columnWidthConfig?: {\n    key: string;\n    width: number;\n  }[];\n\n  groupBy: GroupByOption;\n  groupTitleFieldFormat?: (record: any, col?: number, row?: number, table?: BaseTableAPI) => string;\n  groupTitleCustomLayout?: ICustomLayout;\n  enableTreeStickCell?: boolean;\n  groupTitleCheckbox?: boolean;\n}\n\nexport interface PivotTableProtected extends IBaseTableProtected {\n  /** 表格数据 */\n  records: any[] | undefined;\n  recordsIsTwoDimensionalArray?: boolean;\n  layoutMap: PivotHeaderLayoutMap;\n  dataConfig?: IPivotTableDataConfig;\n\n  /** 列表头树型结构 */\n  columnTree?: IHeaderTreeDefine[];\n  /** 行表头树型结构 */\n  rowTree?: IHeaderTreeDefine[];\n  /** 定义行上各个维度具体配置项和样式定义 */\n  rows?: (IRowDimension | string)[]; // (string | IDimension)[]; 后续支持数据分析的透视表 支持string配置\n  /** 定义列上各个维度具体配置项和样式定义 */\n  columns?: (IColumnDimension | string)[]; // (string | IDimension)[];\n  /** 定义指标具体配置项和样式定义 包含表头和body的定义*/\n  indicators?: (IIndicator | string)[]; // (string | IIndicator)[];\n\n  columnWidthConfig?: {\n    dimensions: IDimensionInfo[];\n    width: number;\n  }[];\n  columnWidthConfigForRowHeader?: {\n    dimensions: IDimensionInfo[];\n    width: number;\n  }[];\n}\nexport interface PivotChartProtected extends IBaseTableProtected {\n  /** 表格数据 */\n  records: any[] | Record<string, any[]>;\n  layoutMap: PivotHeaderLayoutMap;\n  dataConfig?: IPivotChartDataConfig;\n  columnTree?: IHeaderTreeDefine[];\n  /** 行表头维度结构 */\n  rowTree?: IHeaderTreeDefine[];\n  /** 定义行上各个维度具体配置项和样式定义 */\n  rows?: (IRowDimension | string)[]; // (string | IDimension)[]; 后续支持数据分析的透视表 支持string配置\n  /** 定义列上各个维度具体配置项和样式定义 */\n  columns?: (IColumnDimension | string)[]; // (string | IDimension)[];\n  /** 定义指标具体配置项和样式定义 包含表头和body的定义*/\n  indicators?: (IIndicator | string)[]; // (string | IIndicator)[];\n  columnWidthConfig?: {\n    dimensions: IDimensionInfo[];\n    width: number;\n  }[];\n  columnWidthConfigForRowHeader?: {\n    dimensions: IDimensionInfo[];\n    width: number;\n  }[];\n}\n"]}
+{"version":3,"sources":["../src/ts-types/base-table.ts"],"names":[],"mappings":"","file":"base-table.js","sourcesContent":["import type { IBoundsLike, ITextSize } from '@visactor/vutils';\nimport type {\n  RectProps,\n  MaybePromiseOrUndefined,\n  ICellHeaderPaths,\n  CellInfo,\n  CustomCellStyle,\n  CustomCellStyleArrangement,\n  IDimensionInfo\n} from './common';\nimport type {\n  TableEventListener,\n  TableEventHandlersEventArgumentMap,\n  TableEventHandlersReturnMap,\n  EventListenerId,\n  MousePointerCellEvent\n} from './events';\nimport type { MenuListItem, DropDownMenuEventInfo, DropDownMenuHighlightInfo } from './menu';\nimport type { CellStyle } from './style-define';\nimport type { ColumnIconOption } from './icon';\nimport type {\n  ColumnData,\n  ColumnDefine,\n  ColumnsDefine,\n  HeaderData,\n  IndicatorData,\n  SeriesNumberColumnData\n} from './list-table/layout-map/api';\nexport type { HeaderData } from './list-table/layout-map/api';\nimport type { TableTheme } from '../themes/theme-define';\nimport type { ICustomRender } from './customElement';\nimport type { GroupByOption, LayoutObjectId } from './table-engine';\nimport type { Rect } from '../tools/Rect';\nimport type { Scenegraph } from '../scenegraph/scenegraph';\nimport type { StateManager } from '../state/state';\nimport type { EventManager } from '../event/event';\nimport type {\n  CellAddress,\n  CellRange,\n  CellLocation,\n  ColumnTypeOption,\n  DataSourceAPI,\n  FieldData,\n  FieldDef,\n  FieldFormat,\n  FullExtendStyle,\n  HeaderValues,\n  HeightModeDef,\n  HierarchyState,\n  IPivotTableDataConfig,\n  IPagination,\n  ITableThemeDefine,\n  SortState,\n  TableKeyboardOptions,\n  WidthModeDef,\n  IHeaderTreeDefine,\n  IDimension,\n  IIndicator,\n  StickCell,\n  CustomMergeCell,\n  CustomMerge,\n  IColumnDimension,\n  IRowDimension,\n  TableEventOptions,\n  IPivotChartDataConfig,\n  IListTableDataConfig,\n  IRowSeriesNumber,\n  ColumnSeriesNumber,\n  ColumnStyleOption,\n  WidthAdaptiveModeDef,\n  HeightAdaptiveModeDef,\n  ColumnInfo,\n  RowInfo,\n  CellAddressWithBound,\n  Placement,\n  CustomMergeCellFunc\n} from '.';\nimport type { TooltipOptions } from './tooltip';\nimport type { IWrapTextGraphicAttribute } from '../scenegraph/graphic/text';\nimport type { ICustomLayout } from './customLayout';\nimport type { CachedDataSource, DataSource } from '../data';\nimport type { MenuHandler } from '../components/menu/dom/MenuHandler';\nimport type { PivotHeaderLayoutMap } from '../layout/pivot-header-layout';\nimport type { SimpleHeaderLayoutMap } from '../layout';\nimport type { TooltipHandler } from '../components/tooltip/TooltipHandler';\nimport type { BodyHelper } from '../body-helper/body-helper';\nimport type { HeaderHelper } from '../header-helper/header-helper';\nimport type { EventHandler } from '../event/EventHandler';\nimport type { NumberMap } from '../tools/NumberMap';\nimport type { FocusInput } from '../core/FouseInput';\nimport type { ITableLegendOption } from './component/legend';\nimport type { DataSet } from '@visactor/vdataset';\nimport type { Title } from '../components/title/title';\nimport type { ITitle } from './component/title';\nimport type { DiscreteTableLegend } from '../components/legend/discrete-legend/discrete-legend';\nimport type { ContinueTableLegend } from '../components/legend/continue-legend/continue-legend';\nimport type { NumberRangeMap } from '../layout/row-height-map';\nimport type { RowSeriesNumberHelper } from '../core/row-series-number-helper';\nimport type { ReactCustomLayout } from '../components/react/react-custom-layout';\nimport type { ISortedMapItem } from '../data/DataSource';\nimport type { IAnimationAppear, ITableAnimationOption } from './animation/appear';\nimport type { IEmptyTip } from './component/empty-tip';\nimport type { EmptyTip } from '../components/empty-tip/empty-tip';\nimport type { EditManager } from '../edit/edit-manager';\nimport type { TableAnimationManager } from '../core/animation';\nimport type { CustomCellStylePlugin } from '../plugins/custom-cell-style';\nimport type { IVTablePlugin } from '../plugins/interface';\nimport type { FederatedPointerEvent } from '@visactor/vrender-core';\n\nexport interface IBaseTableProtected {\n  element: HTMLElement;\n  // scrollable: Scrollable;\n  handler: EventHandler;\n  focusControl: FocusInput;\n  canvas: HTMLCanvasElement;\n  context: CanvasRenderingContext2D;\n  rowCount: number;\n  colCount: number;\n  frozenColCount: number;\n  unfreezeAllOnExceedsMaxWidth: boolean;\n  allowFrozenColCount: number;\n\n  frozenRowCount: number;\n  rightFrozenColCount: number;\n  bottomFrozenRowCount: number;\n  defaultRowHeight: number | 'auto';\n  /**表头默认行高 可以按逐行设置 如果没有就取defaultRowHeight */\n  defaultHeaderRowHeight: (number | 'auto') | (number | 'auto')[];\n  defaultColWidth: number;\n  defaultHeaderColWidth: (number | 'auto') | (number | 'auto')[];\n  // font?: string;\n  // underlayBackgroundColor?: string;\n  keyboardOptions?: TableKeyboardOptions;\n  eventOptions?: TableEventOptions;\n  rowSeriesNumber?: IRowSeriesNumber;\n  /** 启动复选框级联 */\n  enableCheckboxCascade?: boolean;\n  /** 表头复选框是否级联整列状态 */\n  enableHeaderCheckboxCascade?: boolean;\n  columnSeriesNumber?: ColumnSeriesNumber[];\n  // disableRowHeaderColumnResize?: boolean;\n\n  columnResizeMode?: 'all' | 'none' | 'header' | 'body';\n\n  rowResizeMode?: 'all' | 'none' | 'header' | 'body';\n\n  columnResizeType?: 'column' | 'indicator' | 'all' | 'indicatorGroup';\n\n  rowResizeType?: 'row' | 'indicator' | 'all' | 'indicatorGroup';\n  /** 控制拖拽表头移动位置顺序开关 */\n  dragHeaderMode?: 'all' | 'none' | 'column' | 'row';\n  /** 拖拽表头移动位置 针对冻结部分的规则\n   * \"disabled\"（禁止调整冻结列位置）：不允许其他列的表头移入冻结列，也不允许冻结列移出，冻结列保持不变。\n   * \"adjustFrozenCount\"（根据交互结果调整冻结数量）：允许其他列的表头移入冻结列，及冻结列移出，并根据拖拽的动作调整冻结列的数量。当其他列的表头被拖拽进入冻结列位置时，冻结列数量增加；当其他列的表头被拖拽移出冻结列位置时，冻结列数量减少。\n   * \"fixedFrozenCount\"（可调整冻结列，并维持冻结数量不变）：允许自由拖拽其他列的表头移入或移出冻结列位置，同时保持冻结列的数量不变。\n   */\n  frozenColDragHeaderMode?: 'disabled' | 'adjustFrozenCount' | 'fixedFrozenCount';\n  cachedRecordsRowHeightMap: NumberMap<string | number>; //存储每一条记录对应行的行高，只有当设置为自动换行随内容撑开才会起作用\n  // headerRowHeightsMap: NumberMap<number>; //目前是用来存储了表头各行的高度，从headerRowHeight计算而来，headerRowHeight可以设置为数组的形式\n  _rowHeightsMap: NumberRangeMap; //存储数据条目每行高度\n  _colWidthsMap: NumberMap<string | number>; //存储各列的宽度\n  _colContentWidthsMap: NumberMap<string | number>; //存储各列的内容宽度\n  _colWidthsLimit: {\n    //存储各列的宽度限制\n    [col: number]: {\n      max?: string | number;\n      min?: string | number;\n    };\n  };\n  calcWidthContext: {\n    _: IBaseTableProtected;\n    full: number;\n    // em: number;\n  };\n\n  _rowRangeHeightsMap: Map<string, number>; //存储指定行范围的总高度\n  _colRangeWidthsMap: Map<string, number>; //存储指定列范围的总宽度\n\n  _widthResizedColMap: Set<number | string>; //记录下被手动调整过列宽的列号\n  _heightResizedRowMap: Set<number>; //记录下被手动调整过行高的行号\n\n  bodyHelper: BodyHelper;\n  headerHelper: HeaderHelper;\n  rowSeriesNumberHelper: RowSeriesNumberHelper;\n\n  cellTextOverflows: { [at: string]: string };\n  // headerDescriptions: { [at: string]: string };\n  focusedTable: boolean;\n\n  // scroll: {\n  //   left: number;\n  //   top: number;\n  // };\n  releaseList?: { release: () => void }[] | null;\n  theme: TableTheme;\n  transpose?: boolean; //是否转置\n  // autoRowHeight?: boolean; //是否自动撑开高度 对于设置了autoWrapText的multilineText的列生效\n  pixelRatio?: number;\n  /** 下拉菜单的相关配置。消失时机：显示后点击菜单区域外自动消失*/\n  menu: {\n    /** 代替原来的option.menuType */\n    renderMode?: 'canvas' | 'html';\n    /** 内置下拉菜单的全局设置项 目前只针对基本表格有效 会对每个表头单元格开启默认的下拉菜单功能。代替原来的option.dropDownMenu*/\n    defaultHeaderMenuItems?:\n      | MenuListItem[]\n      | ((args: { row: number; col: number; table: BaseTableAPI }) => MenuListItem[]);\n    /** 右键菜单。代替原来的option.contextmenu */\n    contextMenuItems?:\n      | MenuListItem[]\n      | ((field: FieldDef, row: number, col: number, table?: BaseTableAPI) => MenuListItem[]);\n    /** 设置选中状态的菜单。代替原来的option.dropDownMenuHighlight  */\n    dropDownMenuHighlight?: DropDownMenuHighlightInfo[];\n    /** 右键菜单是否只工作在单元格上。默认true只在单元格上显示右键菜单, 配置false在空白处也弹出右键菜单  */\n    contextMenuWorkOnlyCell?: boolean;\n    parentElement?: HTMLElement;\n  };\n  /** 提示弹框的相关配置。消失时机：显示后鼠标移动到指定区域外或者进入新的单元格后自动消失*/\n  tooltip: {\n    parentElement: HTMLElement;\n    renderMode: 'html' | 'canvas';\n    /** 代替原来hover:isShowTooltip配置 */\n    isShowOverflowTextTooltip: boolean | ((col: number, row: number, table: BaseTableAPI) => boolean);\n    /** 缩略文字提示框 延迟消失时间 */\n    overflowTextTooltipDisappearDelay?: number;\n    /** 弹框是否需要限定在表格区域内 */\n    confine: boolean;\n    position: Placement;\n  };\n\n  dataSourceEventIds?: EventListenerId[];\n  // headerEvents?: EventListenerId[];\n  layoutMap: SimpleHeaderLayoutMap | PivotHeaderLayoutMap;\n  headerValues?: HeaderValues;\n  tooltipHandler: TooltipHandler;\n\n  // headerRowHeight: number[] | number;//移到了BaseTable\n  sortState: SortState | SortState[];\n  multipleSort?: boolean;\n\n  dataSource: DataSource | CachedDataSource;\n  records?: any;\n  allowRangePaste: boolean;\n  //重新思考逻辑：如果为false，行高按设置的rowHeight；如果设置为true，则按lineHeight及是否自动换行综合计算行高 2021.11.19 by：lff\n\n  autoWrapText?: boolean;\n  enableLineBreak?: boolean;\n\n  menuHandler: MenuHandler;\n\n  /**\n   * 计算列宽时 指定最大列宽 可设置boolean或者具体的值 默认为450\n   */\n  limitMaxAutoWidth?: boolean | number;\n\n  /**\n   * 限制列宽最小值。\n   */\n  limitMinWidth?: number;\n\n  limitMinHeight?: number;\n\n  title?: Title;\n  legends?: (DiscreteTableLegend | ContinueTableLegend)[];\n\n  emptyTip?: EmptyTip;\n  //是否开启图表异步渲染\n  renderChartAsync?: boolean;\n  // // 开启图表异步渲染 每批次渐进渲染图表个数\n  // renderChartAsyncBatchCount?: number;\n\n  stick: { changedCells: Map<string, StickCell> };\n\n  customMergeCell?: CustomMergeCellFunc;\n  /**\n   * 'auto':和浏览器滚动行为一致 表格滚动到顶部/底部时 触发浏览器默认行为;\n   *  设置为 'none' 时, 表格滚动到顶部/底部时, 不再触发父容器滚动\n   * */\n  overscrollBehavior?: 'auto' | 'none';\n\n  modifiedViewBoxTransform?: boolean;\n  // react component container\n  bodyDomContainer?: HTMLElement;\n  headerDomContainer?: HTMLElement;\n  frozenBodyDomContainer?: HTMLElement;\n  frozenHeaderDomContainer?: HTMLElement;\n  rightFrozenBodyDomContainer?: HTMLElement;\n  rightFrozenHeaderDomContainer?: HTMLElement;\n  frozenBottomDomContainer?: HTMLElement;\n  bottomDomContainer?: HTMLElement;\n  rightFrozenBottomDomContainer?: HTMLElement;\n\n  // 已使用一行的高度填充所有行\n  useOneRowHeightFillAll?: boolean;\n\n  // 启用树形结构数据内的merge配置\n  enableTreeNodeMerge?: boolean;\n\n  _oldRowCount?: number;\n  _oldColCount?: number;\n\n  columnWidthConfig?: any;\n}\nexport interface BaseTableConstructorOptions {\n  // /** 指定表格的行数 */\n  // rowCount?: number;\n\n  // /** 指定表格的列数 */\n  // colCount?: number;\n  /**\n   * 当前需要冻结的列数 基本表格生效\n   */\n  frozenColCount?: number;\n  frozenRowCount?: number;\n  rightFrozenColCount?: number;\n  bottomFrozenRowCount?: number;\n  /** 最大冻结宽度，固定值 or 百分比。默认为'80%' */\n  maxFrozenWidth?: number | string;\n  /** 超过最大冻结宽度后是否全部解冻，默认true */\n  unfreezeAllOnExceedsMaxWidth?: boolean;\n\n  // /** 待实现 TODO */\n  // frozenRowCount?: number;\n  /** 可冻结列数，表示前多少列会出现冻结操作按钮 基本表格生效 */\n  allowFrozenColCount?: number;\n  /**\n   * 默认行高. 默认 40\n   */\n  defaultRowHeight?: number | 'auto';\n  /** 列表头默认行高 可以按逐行设置 如果没有就取defaultRowHeight */\n  defaultHeaderRowHeight?: (number | 'auto') | (number | 'auto')[];\n  /**\n   * 默认列宽. 默认 80\n   */\n  defaultColWidth?: number;\n  /** 行表头默认列宽 可以按逐列设置 如果没有就取defaultColWidth */\n  defaultHeaderColWidth?: (number | 'auto') | (number | 'auto')[];\n  /** 快捷键功能设置 */\n  keyboardOptions?: TableKeyboardOptions;\n  excelOptions?: {\n    fillHandle?: boolean | ((args: { selectRanges: CellRange[]; table: BaseTableAPI }) => boolean);\n  };\n  /** 事件触发相关设置 */\n  eventOptions?: TableEventOptions;\n  /**\n   * Canvas container\n   */\n  container?: HTMLElement | null;\n\n  /**\n   * @deprecated\n   * 请使用resize.columnResizeMode\n   * 调整列宽 可操作范围。'all' | 'none' | 'header' | 'body'; 整列间隔线|禁止调整|只能在表头处间隔线|只能在body间隔线\n   */\n  columnResizeMode?: 'all' | 'none' | 'header' | 'body';\n  /**\n   * @deprecated\n   * 请使用resize.rowResizeMode\n   */\n  rowResizeMode?: 'all' | 'none' | 'header' | 'body';\n\n  /**\n   * @deprecated\n   * dragOrder.dragHeaderMode\n   * 控制拖拽表头移动位置顺序开关\n   */\n  dragHeaderMode?: 'all' | 'none' | 'column' | 'row';\n\n  /**\n   * 是否显示固定列图钉 基本表格生效\n   */\n  showFrozenIcon?: boolean;\n\n  padding?:\n    | {\n        top?: number;\n        bottom?: number;\n        left?: number;\n        right?: number;\n      }\n    | number;\n  /** hover交互配置 */\n  hover?: {\n    /** hover交互响应模式：十字交叉 整列 整行 或者单个单元格 */\n    highlightMode?: 'cross' | 'column' | 'row' | 'cell';\n    /** 不响应鼠标hover交互 */\n    disableHover?: boolean;\n    /** 单独设置表头不响应鼠标hover交互 */\n    disableHeaderHover?: boolean;\n    /** 单独设置坐标轴不响应鼠标hover交互 */\n    disableAxisHover?: boolean;\n  };\n  /** 选择单元格交互配置 */\n  select?: {\n    /** 高亮范围模式：十字交叉 整列 整行 或者单个单元格。默认`cell` */\n    highlightMode?: 'cross' | 'column' | 'row' | 'cell';\n    /** 点击表头单元格效果\n     * 'inline': 点击行表头则整行选中，选择列表头则整列选中；\n     * 'cell': 仅仅选择当前点击的表头单元格；\n     * 'body': 不选择表头，点击行表头则选择该行所有 body 单元格，点击列表头则选择该列所有 body 单元格。\n     */\n    headerSelectMode?: 'inline' | 'cell' | 'body';\n    /** 点击表头corner单元格效果\n     * 'inline': 点击corner选择列表头则整列选中；\n     * 'cell': 仅仅选择当前点击的corner表头单元格；\n     * 'body': 点击corner列表头则选择该列所有 body 单元格；\n     * 'all': 点击corner选择整个图表。\n     */\n    cornerHeaderSelectMode?: 'inline' | 'cell' | 'body' | 'all';\n    /** 不响应鼠标select交互 */\n    disableSelect?: boolean | ((col: number, row: number, table: BaseTableAPI) => boolean);\n    /** 单独设置表头不响应鼠标select交互 */\n    disableHeaderSelect?: boolean;\n    /** 点击空白区域是否取消选中 */\n    blankAreaClickDeselect?: boolean;\n    /** 点击外部区域是否取消选中 */\n    outsideClickDeselect?: boolean; //\n    /**  禁止拖拽框选 */\n    disableDragSelect?: boolean;\n    /** 是否在选择多行或多列时高亮范围 */\n    highlightInRange?: boolean;\n    /** 是否将选中的单元格自动滚动到视口内 默认为true */\n    makeSelectCellVisible?: boolean;\n  };\n  /** 下拉菜单的相关配置。消失时机：显示后点击菜单区域外自动消失*/\n  menu?: {\n    /** 代替原来的option.menuType  html目前实现较完整 先默认html渲染方式*/\n    renderMode?: 'canvas' | 'html';\n    /** 内置下拉菜单的全局设置项 目前只针对基本表格有效 会对每个表头单元格开启默认的下拉菜单功能。代替原来的option.dropDownMenu*/\n    defaultHeaderMenuItems?:\n      | MenuListItem[]\n      | ((args: { row: number; col: number; table: BaseTableAPI }) => MenuListItem[]);\n    /** 右键菜单。代替原来的option.contextmenu */\n    contextMenuItems?:\n      | MenuListItem[]\n      | ((field: string, row: number, col: number, table?: BaseTableAPI) => MenuListItem[]);\n    /** 设置选中状态的菜单。代替原来的option.dropDownMenuHighlight  */\n    dropDownMenuHighlight?: DropDownMenuHighlightInfo[];\n    /** 右键菜单是否只工作在单元格上。默认true只在单元格上显示右键菜单, 配置false在空白处也弹出右键菜单  */\n    contextMenuWorkOnlyCell?: boolean;\n    parentElement?: HTMLElement;\n  };\n  /** tooltip相关配置 */\n  tooltip?: {\n    parentElement?: HTMLElement;\n    /** html目前实现较完整 先默认html渲染方式 */\n    renderMode?: 'html'; // 目前暂不支持canvas方案\n    /** 是否显示缩略文字提示框。 代替原来hover:isShowTooltip配置 暂时需要将renderMode配置为html才能显示，canvas的还未开发*/\n    isShowOverflowTextTooltip?: boolean | ((col: number, row: number, table: BaseTableAPI) => boolean);\n    /** 缩略文字提示框 延迟消失时间 */\n    overflowTextTooltipDisappearDelay?: number;\n    /** 是否将 tooltip 框限制在画布区域内，默认开启。针对renderMode:\"html\"有效 */\n    confine?: boolean;\n    position?: Placement;\n  };\n  /**\n   * Theme\n   */\n  theme?: ITableThemeDefine;\n  /** 宽度模式 */\n  widthMode?: 'standard' | 'adaptive' | 'autoWidth';\n  /** 高度模式 */\n  heightMode?: 'standard' | 'adaptive' | 'autoHeight';\n  /** 当列宽度不能占满容器时，是否需要自动拉宽来填充容器的宽度。默认false */\n  autoFillWidth?: boolean;\n  /** 当行高度不能占满容器时，是否需要自动拉高来填充容器的高度。默认false */\n  autoFillHeight?: boolean;\n  /** 内容自适应模式，确保表格大小始终等于容器大小，保持原有的列宽/行高不变。默认false */\n  containerFit?: {\n    width?: boolean; // 是否自适应宽度，默认true\n    height?: boolean; // 是否自适应高度，默认true\n  };\n\n  /** adaptive 模式下宽度的适应策略 **/\n  widthAdaptiveMode?: WidthAdaptiveModeDef;\n  /** adaptive 模式下高度的适应策略 **/\n  heightAdaptiveMode?: HeightAdaptiveModeDef;\n  /** 当配置adaptive模式时，默认true，即在计算每行行高的基础上去等比拉伸行高撑满容器宽度的。如果不需要计算行高用默认行高撑满的话请配置为false */\n  autoHeightInAdaptiveMode?: boolean;\n\n  // /** 行高是否根据内容来计算 */\n  // autoRowHeight?: boolean;\n  /** 设备的像素比 不配的话默认获取window.devicePixelRatio */\n  pixelRatio?: number;\n  /** 自定义渲染 函数形式*/\n  customRender?: ICustomRender;\n  /** 开启自动换行 默认false */\n  autoWrapText?: boolean;\n  /** 是否处理换行符 */\n  enableLineBreak?: boolean;\n  /** 单元格中可显示最大字符数 默认200 */\n  maxCharactersNumber?: number; //\n  // /** toolip最大字符数 */\n  // maxTooltipCharactersNumber?: number;\n  /** 最大可操作条目数 如copy操作可复制出最大数据条目数 */\n  maxOperatableRecordCount?: number;\n  /**\n   * 计算列宽时 指定最大列宽 可设置boolean或者具体的值 默认为450。手动拖拽列宽的话不收这个限制\n   */\n  limitMaxAutoWidth?: boolean | number;\n  /**\n   * 限制列宽最小值。如设置为true 则拖拽改变列宽时限制列宽最小为10px，设置为false则不进行限制。默认为10px\n   */\n  limitMinWidth?: boolean | number;\n  limitMinHeight?: boolean | number;\n\n  // maximum number of data items maintained in table instance\n  maintainedDataCount?: number;\n  // maximum number of columns maintained in table instance\n  maintainedColumnCount?: number;\n\n  legends?: ITableLegendOption | ITableLegendOption[];\n  title?: ITitle;\n  emptyTip?: true | IEmptyTip;\n  /** 是否开启图表异步渲染 */\n  renderChartAsync?: boolean;\n  /** 开启图表异步渲染 每批次渐进渲染图表个数  默认是5个 */\n  renderChartAsyncBatchCount?: number;\n\n  customMergeCell?: CustomMergeCell;\n\n  // #region for nodejs\n  mode?: 'node' | 'browser';\n  modeParams?: any;\n  canvasWidth?: number | 'auto';\n  canvasHeight?: number | 'auto';\n  maxCanvasWidth?: number;\n  maxCanvasHeight?: number;\n  /** 表格的x偏移量（会影响width）, 内部适配的表格边框或者title等组件的占位不算在内 */\n  contentOffsetX?: number;\n  /** 表格的y偏移量（会影响height）, 内部适配的表格边框或者title等组件的占位不算在内 */\n  contentOffsetY?: number;\n\n  // #endregion\n  /**\n   * 'auto':和浏览器滚动行为一致 表格滚动到顶部/底部时 触发浏览器默认行为;\n   *  设置为 'none' 时, 表格滚动到顶部/底部时, 不再触发父容器滚动\n   * */\n  overscrollBehavior?: 'auto' | 'none';\n\n  // resize response time\n  resizeTime?: number;\n\n  canvas?: HTMLCanvasElement;\n  viewBox?: IBoundsLike;\n  chartOption?: any;\n  disableInteraction?: boolean;\n\n  // 渲染时的 spec 改变\n  specFormat?: (\n    spec: any,\n    chartInstance: any,\n    chart: any\n  ) => { needFormatSpec: boolean; spec?: any; updateSpec?: boolean };\n  // chart 单元格 的 spec 生成时的转换\n  specTransformInCell?: (spec: any, col: number, row: number) => any;\n\n  beforeRender?: (stage: any) => void;\n  afterRender?: (stage: any) => void;\n  rowSeriesNumber?: IRowSeriesNumber;\n  /** 启用复选框级联 */\n  enableCheckboxCascade?: boolean;\n  /** 表头复选框是否级联整列状态 */\n  enableHeaderCheckboxCascade?: boolean;\n  // columnSeriesNumber?: ColumnSeriesNumber[];\n  customCellStyle?: CustomCellStyle[];\n  customCellStyleArrangement?: CustomCellStyleArrangement[];\n\n  columnWidthComputeMode?: 'normal' | 'only-header' | 'only-body';\n  clearDOM?: boolean;\n  customConfig?: {\n    /** xTable对于没有配置autoWrapText并且有'\\n'的文本，在计算行高是会当做一行处理，但是在渲染时会解析'\\n'；显示效果就是单元格高度为一行文本高度，只显示第一个'\\n'前的文字，后面显示'...'；multilinesForXTable配置实现和该功能对齐的样式 */\n    multilinesForXTable?: boolean;\n    /** 这里可以配置为false 来走flatDataToObject的数据处理逻辑 而不走dataset的分析 */\n    enableDataAnalysis?: boolean;\n    /** 禁用行高列宽计算取整数逻辑 对齐xTable */\n    _disableColumnAndRowSizeRound?: boolean;\n    imageMargin?: number;\n    // 是否创建react custom container\n    createReactContainer?: boolean;\n    // adaptive 模式下优先缩小迷你图\n    shrinkSparklineFirst?: boolean;\n\n    // 行列移动不更新表格\n    notUpdateInColumnRowMove?: boolean;\n\n    // 表格是否限制内容高度\n    limitContentHeight?: boolean;\n\n    // 图片资源请求时是否使用anonymous模式\n    imageAnonymous?: boolean;\n\n    // 滚动到边界是否继续触发滚动事件\n    scrollEventAlwaysTrigger?: boolean;\n\n    // 开启透视结构缓存\n    enablePivotPathCache?: boolean;\n\n    // 是否禁用内置图表激活\n    disableBuildInChartActive?: boolean;\n    /** 强制计算所有行高，用于某些场景下，如vtable-gantt中，需要一次性计算所有行高 */\n    forceComputeAllRowHeight?: boolean;\n\n    /** 是否取消当前单元格选中状态的判断钩子，用在table-group文件的pointertap事件中，当点击空白区域时，取消选中状态 */\n    cancelSelectCellHook?: (e: FederatedPointerEvent) => boolean;\n\n    /** 当编辑器没有退出情况时，可继续选中其他单元格，比如在vtable-sheet中，当编辑器没有退出情况时，可继续选中其他单元格 */\n    selectCellWhenCellEditorNotExists?: boolean;\n  }; // 部分特殊配置，兼容xTable等作用\n\n  animationAppear?: boolean | IAnimationAppear;\n\n  renderOption?: any;\n\n  formatCopyValue?: (value: string) => string;\n  customComputeRowHeight?: (computeArgs: { row: number; table: BaseTableAPI }) => number | 'auto' | undefined;\n  /** 当表格出现抖动情况，请排查是否上层dom容器的宽高是小数引起的。如果不能保证是整数，请配置这个配置项为true */\n  tableSizeAntiJitter?: boolean;\n\n  /**\n   * @deprecated 请使用resize.disableDblclickAutoResizeColWidth\n   */\n  disableDblclickAutoResizeColWidth?: boolean;\n\n  /** resize交互配置 **/\n  resize?: {\n    /**\n     * 调整列宽 可操作范围。'all' | 'none' | 'header' | 'body'; 整列间隔线|禁止调整|只能在表头处间隔线|只能在body间隔线\n     */\n    columnResizeMode?: 'all' | 'none' | 'header' | 'body';\n    rowResizeMode?: 'all' | 'none' | 'header' | 'body';\n    /** 是否禁用双击列边框自动调整列宽 **/\n    disableDblclickAutoResizeColWidth?: boolean;\n  };\n  dragOrder?: {\n    /** 控制拖拽表头移动位置顺序开关 */\n    dragHeaderMode?: 'all' | 'none' | 'column' | 'row';\n    /** 拖拽移动位置结束时进行验证 */\n    validateDragOrderOnEnd?: (source: CellAddress, target: CellAddress) => boolean;\n  };\n  /** 插件配置 */\n  plugins?: IVTablePlugin[];\n  /** 默认的鼠标样式 */\n  defaultCursor?: string;\n}\nexport interface BaseTableAPI {\n  id: string;\n  /** 数据总条目数 */\n  recordsCount: number;\n  /** 表格的行数 */\n  rowCount: number;\n  /** 表格的列数 */\n  colCount: number;\n  /** 表格除去外层frame后的宽度 */\n  tableNoFrameWidth: number;\n  /** 表格除去外层frame后的高度 */\n  tableNoFrameHeight: number;\n  /** 表格的冻结行数 包括表头在内 */\n  frozenRowCount: number;\n  /** 表格的冻结列数 包括表头在内 */\n  frozenColCount: number;\n\n  bottomFrozenRowCount: number;\n  rightFrozenColCount: number;\n  /** 当前表格默认表头行高 */\n  defaultHeaderRowHeight: (number | 'auto') | (number | 'auto')[];\n  /** 当前表格默认行高 */\n  defaultRowHeight: number;\n  /** 当前表格默认列宽 */\n  defaultColWidth: number;\n  /** 当前表格默认表头列宽 */\n  defaultHeaderColWidth: (number | 'auto') | (number | 'auto')[];\n  /** 当前表格快捷键设置 */\n  keyboardOptions: TableKeyboardOptions | null;\n  /** 当前表格事件相关设置 */\n  eventOptions: TableEventOptions | null;\n  /**\n   * 是否显示图钉\n   */\n  showFrozenIcon: boolean;\n  readonly canvas: HTMLCanvasElement;\n  /** 表格可视区域的行数 */\n  readonly visibleRowCount: number;\n  /** 表格可视区域的列数 */\n  readonly visibleColCount: number;\n  /** 表格滚动值left */\n  scrollLeft: number;\n  /** 表格滚动值top */\n  scrollTop: number;\n  /** 用户设置的options 不要修改这个这个 */\n  options: BaseTableConstructorOptions;\n  /** 设置的全局下拉菜单列表项配置 */\n  globalDropDownMenu?: MenuListItem[] | ((args: { row: number; col: number; table: BaseTableAPI }) => MenuListItem[]);\n  /** 设置的全局自定义渲染函数 */\n  customRender?: ICustomRender;\n\n  /** 表格数据管理对象 */\n  dataSource: DataSourceAPI;\n  /** 设置的表格主题 */\n  theme: TableTheme;\n  /** 可允许设置冻结的最大列数 */\n  allowFrozenColCount: number;\n\n  /** 存储内部用到的属性 变量等 */\n  internalProps: IBaseTableProtected;\n  /** 分页信息 */\n  pagination?: IPagination;\n\n  /** 表格偏移像素值 水平方向 */\n  tableX: number;\n  /** 表格偏移像素值 垂直方向 */\n  tableY: number;\n  /** 表格宽度模式 */\n  widthMode: WidthModeDef;\n  /** 表格宽度模式 */\n  heightMode: HeightModeDef;\n  /** 当列宽度不能占满容器时，是否需要自动拉宽来填充容器的宽度。默认false */\n  autoFillWidth: boolean;\n  /** 当行高度不能占满容器时，是否需要自动拉高来填充容器的高度。默认false */\n  autoFillHeight?: boolean;\n  /** 内容自适应模式，确保表格大小始终等于容器大小，保持原有的列宽/行高不变。默认false */\n  containerFit?: { width: boolean; height: boolean };\n\n  /** adaptive 模式下宽度的适应策略 **/\n  widthAdaptiveMode: WidthAdaptiveModeDef;\n  /** adaptive 模式下高度的适应策略 **/\n  heightAdaptiveMode: HeightAdaptiveModeDef;\n\n  isReleased: boolean;\n\n  // rowHeightsMap: NumberMap<number>;\n  rowHeightsMap: NumberRangeMap;\n  colWidthsMap: NumberMap<string | number>;\n  hasListeners: (type: string) => boolean;\n  on: <TYPE extends keyof TableEventHandlersEventArgumentMap>(\n    type: TYPE,\n    listener: TableEventListener<TYPE> //(event: TableEventHandlersEventArgumentMap[TYPE]) => TableEventHandlersReturnMap[TYPE]\n  ) => EventListenerId;\n  // &(<T extends keyof TableEventHandlersEventArgumentMap>(type: string, listener: AnyListener<T>) => EventListenerId);\n\n  _vDataSet?: DataSet;\n  /** 场景树对象 */\n  scenegraph: Scenegraph;\n  /** 状态管理模块 */\n  stateManager: StateManager;\n  /** 事件管理模块 */\n  eventManager: EventManager;\n  /** 动画管理模块 */\n  animationManager: TableAnimationManager;\n\n  editorManager: EditManager;\n  /** 行表头的层数 */\n  rowHeaderLevelCount: number;\n  /** 列表头的层数 */\n  columnHeaderLevelCount: number;\n\n  canvasWidth?: number;\n  canvasHeight?: number;\n\n  columnWidthComputeMode?: 'normal' | 'only-header' | 'only-body';\n\n  _rowRangeHeightsMap: Map<string, number>;\n  _colRangeWidthsMap: Map<string, number>;\n  canvasSizeSeted?: boolean;\n\n  pixelRatio: number;\n  rotateDegree?: number;\n  /** 获取表格绘制的范围 不包括frame的宽度 */\n  getDrawRange: () => Rect;\n  /** 将鼠标坐标值 转换成表格坐标系中的坐标位置 */\n  _getMouseAbstractPoint: (evt: TouchEvent | MouseEvent | undefined) => { x: number; y: number; inTable: boolean };\n  getElement: () => HTMLElement;\n  getContainer: () => HTMLElement;\n\n  setFrozenColCount: (count: number) => void;\n  _setFrozenColCount: (count: number) => void;\n  _updateSize: () => void;\n\n  render: () => void;\n  throttleInvalidate: () => void;\n  getRowHeight: (row: number) => number;\n  getDefaultRowHeight: (row: number) => number | 'auto';\n  getDefaultColumnWidth: (col: number) => number | 'auto';\n  _setRowHeight: (row: number, height: number, clearCache?: boolean) => void;\n  setRowHeight: (row: number, height: number) => void;\n  getColWidth: (col: number) => number;\n  getColWidthDefined: (col: number) => string | number;\n  // setColWidthDefined: (col: number, width: number) => void;\n  getColWidthDefinedNumber: (col: number) => number;\n  // getColWidthDefine: (col: number) => string | number;\n  _setColWidth: (col: number, width: number | string, clearCache?: boolean, skipCheckFrozen?: boolean) => void;\n  setColWidth: (col: number, width: number) => void;\n  _getColContentWidth: (col: number) => number;\n  _setColContentWidth: (col: number, width: number | string, clearCache?: boolean) => void;\n  getMaxColWidth: (col: number) => number;\n  setMaxColWidth: (col: number, maxwidth: string | number) => void;\n  getMinColWidth: (col: number) => number;\n  setMinColWidth: (col: number, minwidth: string | number) => void;\n  getCellRect: (col: number, row: number) => Rect;\n  getCellRelativeRect: (col: number, row: number) => Rect;\n  getCellsRect: (startCol: number, startRow: number, endCol: number, endRow: number) => Rect;\n  getCellRangeRect: (cellRange: CellRange | CellAddress) => Rect;\n  getCellRangeRelativeRect: (cellRange: CellRange | CellAddress) => Rect;\n  getVisibleCellRangeRelativeRect: (cellRange: CellRange | CellAddress) => Rect;\n  isFrozenCell: (col: number, row: number) => { row: boolean; col: boolean } | null;\n  getRowAt: (absoluteY: number) => { top: number; row: number; bottom: number };\n  getColAt: (absoluteX: number) => { left: number; col: number; right: number };\n  getCellAt: (absoluteX: number, absoluteY: number) => CellAddressWithBound;\n  getCellAtRelativePosition: (absoluteX: number, absoluteY: number) => CellAddressWithBound;\n  _makeVisibleCell: (col: number, row: number) => void;\n  // setFocusCursor(col: number, row: number): void;\n  // focusCell(col: number, row: number): void;\n  getCellOverflowText: (col: number, row: number) => string | null;\n  getColsWidth: (startCol: number, endCol: number) => number;\n  getColsWidths: () => number[];\n  getRowsHeight: (startRow: number, endRow: number) => number;\n  _getRangeSizeForContainerFit: (start: number, end: number, totalSize: number, type: 'col' | 'row') => number;\n\n  release: () => void;\n  addReleaseObj: (releaseObj: { release: () => void }) => void;\n  _getCellStyle: (col: number, row: number) => FullExtendStyle;\n  clearCellStyleCache: () => void;\n\n  getFrozenRowsHeight: () => number;\n  getFrozenColsWidth: () => number;\n  getBottomFrozenRowsHeight: () => number;\n  getRightFrozenColsWidth: () => number;\n  selectCell: (\n    col: number,\n    row: number,\n    isShift?: boolean,\n    isCtrl?: boolean,\n    makeSelectCellVisible?: boolean,\n    skipBodyMerge?: boolean\n  ) => void;\n  clearSelected: () => void;\n  selectCells: (cellRanges: CellRange[]) => void;\n  getAllRowsHeight: () => number;\n  getAllColsWidth: () => number;\n\n  off: (id: EventListenerId) => void;\n  getBodyField: (col: number, row: number) => FieldDef | undefined;\n  /**\n   * 根据单元格获取对应的源数据\n   * @param col\n   * @param row\n   * @returns\n   */\n  getRecordByCell: (col: number, row: number) => MaybePromiseOrUndefined;\n  /**\n   * 根据数据源的index 获取显示到表格中的index 行号或者列号（与转置相关）。注：ListTable特有接口\n   * @param recordIndex\n   */\n  getTableIndexByRecordIndex: (recordIndex: number) => number;\n  /**\n   * 根据数据源的field 获取显示到表格中的index 行号或者列号（与转置相关）。注：ListTable特有接口\n   * @param recordIndex\n   */\n  getTableIndexByField: (field: FieldDef) => number;\n  /**\n   * 根据数据源中的index和field获取单元格行列号。注：ListTable特有接口\n   * @param field\n   * @param recordIndex\n   * @returns\n   */\n  getCellAddrByFieldRecord: (field: FieldDef, recordIndex: number) => CellAddress;\n  getRecordShowIndexByCell: (col: number, row: number) => number;\n  getRecordStartRowByRecordIndex: (index: number) => number;\n\n  getHeaderField: (col: number, row: number) => any | undefined;\n\n  _getHeaderCellBySortState: (sortState: SortState) => CellAddress | undefined;\n  getHeaderDefine: (col: number, row: number) => ColumnDefine | IRowSeriesNumber | ColumnSeriesNumber;\n  _getHeaderLayoutMap: (col: number, row: number) => HeaderData | SeriesNumberColumnData;\n  getContext: () => CanvasRenderingContext2D;\n  getCellRange: (col: number, row: number) => CellRange;\n  _resetFrozenColCount: () => void;\n  isCellRangeEqual: (col: number, row: number, targetCol: number, targetRow: number) => boolean;\n  _getLayoutCellId: (col: number, row: number) => LayoutObjectId;\n  _getBodyLayoutMap: (col: number, row: number) => ColumnData | IndicatorData | SeriesNumberColumnData;\n  getBodyColumnDefine: (col: number, row: number) => ColumnDefine | IRowSeriesNumber | ColumnSeriesNumber;\n  getBodyColumnType: (col: number, row: number) => ColumnTypeOption;\n  getCellType: (col: number, row: number) => ColumnTypeOption;\n  fireListeners: <TYPE extends keyof TableEventHandlersEventArgumentMap>(\n    type: TYPE,\n    event: TableEventHandlersEventArgumentMap[TYPE]\n  ) => TableEventHandlersReturnMap[TYPE][];\n\n  //更新分页\n  updatePagination: (cof: IPagination) => void;\n  //hover\n\n  getHeaderDescription: (col: number, row: number) => string | undefined;\n  /** 获取单元格展示值 */\n  getCellValue: (col: number, row: number, skipCustomMerge?: boolean) => string | null;\n  /** 获取单元格展示数据的format前的值 */\n  getCellOriginValue: (col: number, row: number) => any;\n  /** 获取单元格展示数据源最原始值 */\n  getCellRawValue: (col: number, row: number) => FieldData;\n  /** 获取单元格展示数据的format前的record源数据 */\n  getCellOriginRecord: (col: number, row: number) => MaybePromiseOrUndefined;\n  /** 获取单元格展示源数据 */\n  getCellRawRecord: (col: number, row: number) => MaybePromiseOrUndefined;\n\n  _dropDownMenuIsHighlight: (col: number, row: number, index: number) => boolean;\n  // bindEvents(): void;\n  refreshRowColCount: () => void;\n  // getFieldData: (field: FieldDef | FieldFormat | undefined, col: number, row: number) => FieldData;\n  _hasField: (field: FieldDef, col: number, row: number) => boolean;\n  getCellHeaderPaths: (col: number, row: number) => ICellHeaderPaths;\n  getCellLocation: (col: number, row: number) => CellLocation;\n  // isHitIcon(col: number, row: number, x: number, y: number, iconType: IconFuncTypeEnum): boolean;\n  getCellIcons: (col: number, row: number) => ColumnIconOption[];\n\n  getMenuInfo: (col: number, row: number, type: string) => DropDownMenuEventInfo;\n  /**\n   * 获取某个单元格的样式 共业务方调用\n   * @param col\n   * @param row\n   */\n  getCellStyle: (col: number, row: number) => CellStyle; //  计算后style\n\n  getHierarchyState: (col: number, row: number) => HierarchyState | null;\n\n  _canDragHeaderPosition: (col: number, row: number) => boolean;\n\n  isHeader: (col: number, row: number) => boolean;\n\n  isColumnHeader: (col: number, row: number) => boolean;\n\n  isCornerHeader: (col: number, row: number) => boolean;\n\n  isRowHeader: (col: number, row: number) => boolean;\n\n  getCopyValue: () => string;\n\n  getSelectedCellInfos: () => CellInfo[][];\n  getSelectedCellRanges: () => CellRange[];\n  getCellInfo: (col: number, row: number) => Omit<MousePointerCellEvent, 'target'>;\n\n  showTooltip: (col: number, row: number, tooltipOptions?: TooltipOptions) => void;\n\n  measureText: (\n    text: string,\n    font: { fontSize: number; fontWeight?: string | number; fontFamily: string }\n  ) => ITextSize;\n\n  _canResizeColumn: (col: number, row: number) => boolean;\n  _canResizeRow: (col: number, row: number) => boolean;\n\n  getCustomRender: (col: number, row: number) => ICustomRender;\n  getCustomLayout: (col: number, row: number) => ICustomLayout;\n  isListTable: () => boolean;\n  isPivotTable: (() => boolean) & (() => boolean);\n  isPivotChart: (() => boolean) & (() => boolean);\n  _clearColRangeWidthsMap: (col?: number) => void;\n  _clearRowRangeHeightsMap: (row?: number) => void;\n  clearRowHeightCache: () => void;\n  clearColWidthCache: () => void;\n  toggleHierarchyState: (col: number, row: number) => void;\n\n  resize: () => void;\n  /** 直接设置canvas的宽高 不根据容器宽高来决定表格的尺寸 */\n  setCanvasSize: (width: number, height: number) => void;\n  getMergeCellRect: (col: number, row: number) => Rect;\n\n  getTargetColAt: (absoluteX: number) => ColumnInfo | null;\n  getTargetRowAt: (absoluteY: number) => RowInfo | null;\n  getTargetColAtConsiderRightFrozen: (absoluteX: number, isConsider: boolean) => ColumnInfo | null;\n  getTargetRowAtConsiderBottomFrozen: (absoluteY: number, isConsider: boolean) => RowInfo | null;\n  renderWithRecreateCells: () => void;\n  //#endregion  tableAPI\n\n  _adjustColWidth: (col: number, orgWidth: number) => number;\n  _colWidthDefineToPxWidth: (width: string | number) => number;\n  isFrozenColumn: (col: number, row?: number) => boolean;\n  isLeftFrozenColumn: (col: number, row?: number) => boolean;\n  isRightFrozenColumn: (col: number, row?: number) => boolean;\n  isFrozenRow: (col: number, row?: number) => boolean;\n  isTopFrozenRow: (col: number, row?: number) => boolean;\n  isBottomFrozenRow: (col: number, row?: number) => boolean;\n\n  hasCustomMerge: () => boolean;\n  getCustomMerge: (col: number, row: number) => undefined | (Omit<CustomMerge, 'style'> & { style?: FullExtendStyle });\n  /** 获取表格body部分的显示单元格范围 */\n  getBodyVisibleCellRange: () => { rowStart: number; colStart: number; rowEnd: number; colEnd: number };\n  /** 获取表格body部分的显示列号范围 */\n  getBodyVisibleColRange: () => { colStart: number; colEnd: number };\n  /** 获取表格body部分的显示行号范围 */\n  getBodyVisibleRowRange: () => { rowStart: number; rowEnd: number };\n\n  _hasCustomRenderOrLayout: () => boolean;\n  /** 根据表格单元格的行列号 获取在body部分的列索引及行索引 */\n  getBodyIndexByTableIndex: (col: number, row: number) => CellAddress;\n  /** 根据body部分的列索引及行索引，获取单元格的行列号 */\n  getTableIndexByBodyIndex: (col: number, row: number) => CellAddress;\n  /**\n   * 滚动到具体某个单元格位置\n   * @param cellAddr 要滚动到的单元格位置\n   */\n  scrollToCell: (cellAddr: { col?: number; row?: number }, animationOption?: ITableAnimationOption | boolean) => void;\n  scrollToRow: (row: number, animationOption?: ITableAnimationOption | boolean) => void;\n  scrollToCol: (col: number, animationOption?: ITableAnimationOption | boolean) => void;\n  registerCustomCellStyle: (customStyleId: string, customStyle: ColumnStyleOption | undefined | null) => void;\n  arrangeCustomCellStyle: (cellPos: { col?: number; row?: number; range?: CellRange }, customStyleId: string) => void;\n  /** 是否有列是自动计算列宽 */\n  checkHasColumnAutoWidth: () => boolean;\n  _moveHeaderPosition: (\n    source: CellAddress,\n    target: CellAddress\n  ) => {\n    sourceIndex: number;\n    targetIndex: any;\n    sourceSize: any;\n    targetSize: any;\n    moveType: 'column' | 'row';\n  };\n  changeRecordOrder: (source: number, target: number) => void;\n  isSeriesNumber: (col: number, row?: number) => boolean;\n  isHasSeriesNumber: () => boolean;\n  leftRowSeriesNumberCount: number;\n  isAutoRowHeight: (row?: number) => boolean;\n\n  reactCustomLayout?: ReactCustomLayout;\n  checkReactCustomLayout: (removeAllContainer: () => void) => void;\n  setSortedIndexMap: (field: FieldDef, filedMap: ISortedMapItem) => void;\n\n  exportImg: () => string;\n  exportCellImg: (\n    col: number,\n    row: number,\n    options?: { disableBackground?: boolean; disableBorder?: boolean }\n  ) => string;\n  exportCellRangeImg: (cellRange: CellRange) => string;\n  exportCanvas: () => HTMLCanvasElement;\n  setPixelRatio: (pixelRatio: number) => void;\n\n  bodyDomContainer?: HTMLElement;\n  headerDomContainer?: HTMLElement;\n  frozenBodyDomContainer?: HTMLElement;\n  frozenHeaderDomContainer?: HTMLElement;\n  rightFrozenBodyDomContainer?: HTMLElement;\n  rightFrozenHeaderDomContainer?: HTMLElement;\n  frozenBottomDomContainer?: HTMLElement;\n  bottomDomContainer?: HTMLElement;\n  rightFrozenBottomDomContainer?: HTMLElement;\n\n  showMoverLine: (col: number, row: number) => void;\n  hideMoverLine: (col: number, row: number) => void;\n  /** 关闭表格的滚动 */\n  disableScroll: () => void;\n  /** 开启表格的滚动 */\n  enableScroll: () => void;\n\n  customCellStylePlugin?: CustomCellStylePlugin;\n  headerStyleCache: Map<string, any>;\n  bodyBottomStyleCache: Map<string, any>;\n  bodyStyleCache: Map<string, any>;\n  bodyMergeTitleCache: Map<string, any>;\n  isSeriesNumberInBody: (col: number, row: number) => boolean;\n  getGroupTitleLevel: (col: number, row: number) => number | undefined;\n  _getMaxFrozenWidth: () => number;\n  _getComputedFrozenColCount: (frozenColCount: number) => number;\n}\nexport interface ListTableProtected extends IBaseTableProtected {\n  /** 表格数据 */\n  records: any[] | null;\n  dataConfig?: IListTableDataConfig;\n  columns: ColumnsDefine;\n  layoutMap: SimpleHeaderLayoutMap;\n  columnWidthConfig?: {\n    key: string;\n    width: number;\n  }[];\n\n  groupBy: GroupByOption;\n  groupTitleFieldFormat?: (record: any, col?: number, row?: number, table?: BaseTableAPI) => string;\n  groupTitleCustomLayout?: ICustomLayout;\n  enableTreeStickCell?: boolean;\n  groupTitleCheckbox?: boolean;\n}\n\nexport interface PivotTableProtected extends IBaseTableProtected {\n  /** 表格数据 */\n  records: any[] | undefined;\n  recordsIsTwoDimensionalArray?: boolean;\n  layoutMap: PivotHeaderLayoutMap;\n  dataConfig?: IPivotTableDataConfig;\n\n  /** 列表头树型结构 */\n  columnTree?: IHeaderTreeDefine[];\n  /** 行表头树型结构 */\n  rowTree?: IHeaderTreeDefine[];\n  /** 定义行上各个维度具体配置项和样式定义 */\n  rows?: (IRowDimension | string)[]; // (string | IDimension)[]; 后续支持数据分析的透视表 支持string配置\n  /** 定义列上各个维度具体配置项和样式定义 */\n  columns?: (IColumnDimension | string)[]; // (string | IDimension)[];\n  /** 定义指标具体配置项和样式定义 包含表头和body的定义*/\n  indicators?: (IIndicator | string)[]; // (string | IIndicator)[];\n\n  columnWidthConfig?: {\n    dimensions: IDimensionInfo[];\n    width: number;\n  }[];\n  columnWidthConfigForRowHeader?: {\n    dimensions: IDimensionInfo[];\n    width: number;\n  }[];\n}\nexport interface PivotChartProtected extends IBaseTableProtected {\n  /** 表格数据 */\n  records: any[] | Record<string, any[]>;\n  layoutMap: PivotHeaderLayoutMap;\n  dataConfig?: IPivotChartDataConfig;\n  columnTree?: IHeaderTreeDefine[];\n  /** 行表头维度结构 */\n  rowTree?: IHeaderTreeDefine[];\n  /** 定义行上各个维度具体配置项和样式定义 */\n  rows?: (IRowDimension | string)[]; // (string | IDimension)[]; 后续支持数据分析的透视表 支持string配置\n  /** 定义列上各个维度具体配置项和样式定义 */\n  columns?: (IColumnDimension | string)[]; // (string | IDimension)[];\n  /** 定义指标具体配置项和样式定义 包含表头和body的定义*/\n  indicators?: (IIndicator | string)[]; // (string | IIndicator)[];\n  columnWidthConfig?: {\n    dimensions: IDimensionInfo[];\n    width: number;\n  }[];\n  columnWidthConfigForRowHeader?: {\n    dimensions: IDimensionInfo[];\n    width: number;\n  }[];\n}\n"]}

package/es/ts-types/events.d.ts

@@ -180,9 +180,15 @@ export interface TableEventHandlersEventArgumentMap {
     dropdown_menu_click: DropDownMenuEventArgs;
     mouseover_chart_symbol: MousePointerSparklineEvent;
     drag_select_end: MousePointerMultiCellEvent;
+    selected_changed: {
+        col: number;
+        row: number;
+        ranges: CellRange[];
+    };
     copy_data: {
         cellRange: CellRange[];
         copyData: string;
+        isCut: boolean;
     };
     drillmenu_click: DrillMenuEventInfo;
     dropdown_icon_click: CellAddress & {
@@ -271,12 +277,17 @@ export interface TableEventHandlersEventArgumentMap {
         options: BaseTableConstructorOptions;
         container: HTMLElement | null;
     };
+    before_update_option: {
+        options: BaseTableConstructorOptions;
+        container: HTMLElement | null;
+    };
     before_set_size: {
         width: number;
         height: number;
     };
     after_render: null;
     initialized: null;
+    updated: null;
     change_cell_value: {
         col: number;
         row: number;
@@ -305,6 +316,11 @@ export interface TableEventHandlersEventArgumentMap {
         pasteData: (string | number)[][];
         changedCellResults: boolean[][];
     };
+    plugin_event: {
+        event: any;
+        plugin: any;
+        pluginEventInfo: any;
+    };
 }
 export interface DrillMenuEventInfo {
     dimensionKey: string | number;
@@ -328,7 +344,7 @@ export interface TableEventHandlersReturnMap {
     mouseleave_cell: void;
     mouseout_cell: void;
     mousemove_cell: void;
-    mousedown_cell: boolean;
+    mousedown_cell: void;
     mouseup_cell: void;
     contextmenu_cell: void;
     contextmenu_canvas: void;
@@ -352,6 +368,7 @@ export interface TableEventHandlersReturnMap {
     dropdown_menu_click: void;
     mouseover_chart_symbol: void;
     drag_select_end: void;
+    selected_changed: void;
     copy_data: void;
     drillmenu_click: void;
     dropdown_icon_click: void;
@@ -374,9 +391,11 @@ export interface TableEventHandlersReturnMap {
     radio_state_change: void;
     switch_state_change: void;
     before_init: void;
+    before_update_option: void;
     before_set_size: void;
     after_render: void;
     initialized: void;
+    updated: void;
     change_cell_value: void;
     mousedown_fill_handle: void;
     drag_fill_handle_end: void;
@@ -388,4 +407,5 @@ export interface TableEventHandlersReturnMap {
     button_click: void;
     before_cache_chart_image: void;
     pasted_data: void;
+    plugin_event: void;
 }

package/es/ts-types/events.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ts-types/events.ts"],"names":[],"mappings":"","file":"events.js","sourcesContent":["import type {\n  CellAddress,\n  CellRange,\n  CellLocation,\n  FieldDef,\n  CellAddressWithBound,\n  ListTableConstructorOptions,\n  PivotTableConstructorOptions\n} from './table-engine';\nimport type { DropDownMenuEventArgs, MenuListItem, PivotInfo } from './menu';\n\nimport type { IDimensionInfo, MergeCellInfo, RectProps, SortOrder } from './common';\nimport type { IconFuncTypeEnum, CellInfo, HierarchyState } from '.';\nimport type { Icon } from '../scenegraph/graphic/icon';\nimport type { FederatedPointerEvent, IEventTarget } from './../vrender';\nimport type { BaseTableConstructorOptions } from './base-table';\n\nexport type KeyboardEventListener = (e: KeyboardEvent) => void;\nexport type TableEventListener<TYPE extends keyof TableEventHandlersEventArgumentMap> = (\n  args: TableEventHandlersEventArgumentMap[TYPE]\n) => TableEventHandlersReturnMap[TYPE]; //AnyFunction;\nexport type EventListenerId = number;\n\nexport type SelectedCellEvent = CellAddress & {\n  ranges: CellRange[];\n};\n\n// export type MouseCellEvent = CellAddress & {\n//   event: MouseEvent | PointerEvent | TouchEvent;\n// };\n\nexport type MenuEvent = CellAddress & {\n  dropDownMenu: MenuListItem[];\n  pivotInfo: PivotInfo;\n};\n\nexport type TouchCellEvent = CellAddress & {\n  event: TouchEvent;\n};\n\nexport type KeydownEvent = {\n  keyCode: number;\n  code: string;\n  event: KeyboardEvent;\n  stopCellMoving?: () => void;\n  scaleRatio?: number;\n};\n\nexport type MousePointerCellEvent = CellAddressWithBound &\n  CellInfo & {\n    scaleRatio?: number;\n    targetIcon?: { name: string; position: RectProps; funcType: string };\n    event?: MouseEvent | PointerEvent | TouchEvent;\n    federatedEvent?: FederatedPointerEvent;\n    target: IEventTarget | undefined;\n\n    mergeCellInfo?: MergeCellInfo;\n  };\n// 多单元格的事件传出参数 需要将当前鼠标处的单元格的信息FocusedCellInfo也带着\nexport type MousePointerMultiCellEvent = MousePointerCellEvent & {\n  cells: CellInfo[][];\n  // menuKey?: string;\n};\n\nexport type MousePointerSparklineEvent = MousePointerCellEvent & {\n  sparkline: {\n    pointData: any;\n  };\n};\n\nexport interface TableEventHandlersEventArgumentMap {\n  selected_cell: SelectedCellEvent;\n  selected_clear: {};\n  click_cell: MousePointerCellEvent;\n  dblclick_cell: MousePointerCellEvent;\n  mouseenter_table: { event?: MouseEvent | PointerEvent | TouchEvent };\n  mouseleave_table: { event?: MouseEvent | PointerEvent | TouchEvent };\n  mousedown_table: { event?: MouseEvent | PointerEvent | TouchEvent };\n  mousemove_table: MousePointerCellEvent;\n  mouseenter_cell: MousePointerCellEvent;\n  mouseleave_cell: MousePointerCellEvent;\n  mousemove_cell: MousePointerCellEvent;\n  mousedown_cell: MousePointerCellEvent;\n  mouseup_cell: MousePointerCellEvent;\n  contextmenu_cell: MousePointerMultiCellEvent;\n  contextmenu_canvas: MousePointerCellEvent;\n  before_keydown: KeydownEvent;\n  keydown: KeydownEvent;\n  scroll: {\n    event: WheelEvent;\n    scrollLeft: number;\n    scrollTop: number;\n    scrollWidth: number;\n    scrollHeight: number;\n    viewWidth: number;\n    viewHeight: number;\n    scrollDirection: 'horizontal' | 'vertical';\n    scrollRatioX?: number;\n    scrollRatioY?: number;\n    dx?: number;\n    dy?: number;\n  };\n  can_scroll: {\n    event: WheelEvent;\n    scrollLeft: number;\n    scrollTop: number;\n    scrollWidth: number;\n    scrollHeight: number;\n    viewWidth: number;\n    viewHeight: number;\n    scrollDirection: 'horizontal' | 'vertical';\n    scrollRatioX?: number;\n    scrollRatioY?: number;\n    dx?: number;\n    dy?: number;\n  };\n  scroll_vertical_end: {\n    scrollLeft: number;\n    scrollTop: number;\n    scrollWidth: number;\n    scrollHeight: number;\n    viewWidth: number;\n    viewHeight: number;\n  };\n  scroll_horizontal_end: {\n    scrollLeft: number;\n    scrollTop: number;\n    scrollWidth: number;\n    scrollHeight: number;\n    viewWidth: number;\n    viewHeight: number;\n  };\n  resize_column: { col: number; colWidth: number };\n  resize_column_end: { col: number; colWidths: number[] };\n  resize_row: { row: number; rowHeight: number };\n  resize_row_end: { row: number; rowHeight: number };\n  change_header_position: { source: CellAddress; target: CellAddress; event: Event };\n  change_header_position_start: {\n    col: number;\n    row: number;\n    x: number;\n    y: number;\n    backX: number;\n    lineX: number;\n    backY: number;\n    lineY: number;\n    event: Event;\n  };\n  changing_header_position: {\n    col: number;\n    row: number;\n    x: number;\n    y: number;\n    backX: number;\n    lineX: number;\n    backY: number;\n    lineY: number;\n    event: Event;\n  };\n  change_header_position_fail: { source: CellAddress; target: CellAddress; event: Event };\n  sort_click: {\n    field: FieldDef;\n    order: SortOrder;\n    event: Event;\n  };\n  after_sort: {\n    field: FieldDef;\n    order: SortOrder;\n    event: Event;\n  };\n  freeze_click: { col: number; row: number; fields: FieldDef[]; colCount: number };\n  dropdown_menu_click: DropDownMenuEventArgs;\n\n  mouseover_chart_symbol: MousePointerSparklineEvent;\n\n  drag_select_end: MousePointerMultiCellEvent;\n  copy_data: { cellRange: CellRange[]; copyData: string };\n  drillmenu_click: DrillMenuEventInfo;\n\n  dropdown_icon_click: CellAddress & { event: Event };\n  dropdown_menu_clear: CellAddress;\n\n  show_menu: {\n    x: number;\n    y: number;\n    col: number;\n    row: number;\n    type: 'dropDown' | 'contextmenu' | 'custom';\n  };\n  hide_menu: [];\n  icon_click: {\n    name: string;\n    col: number;\n    row: number;\n    x: number;\n    y: number;\n    funcType?: IconFuncTypeEnum | string;\n    icon: Icon;\n    event: Event;\n  };\n\n  pivot_sort_click: {\n    col: number;\n    row: number;\n    order: SortOrder;\n    dimensionInfo: IDimensionInfo[];\n    cellLocation: CellLocation;\n    event: Event;\n  };\n  tree_hierarchy_state_change: {\n    col: number;\n    row: number;\n    changeAll?: boolean;\n    hierarchyState: HierarchyState;\n    dimensionInfo?: IDimensionInfo[];\n    /**整条数据-原始数据 */\n    originData?: any;\n    cellLocation?: CellLocation;\n  };\n  vchart_event_type: {\n    eventName: string;\n    col: number;\n    row: number;\n    chartEventArguments: any;\n  };\n  //datasource部分的事件\n  change_order: [];\n  source_length_update: number;\n\n  legend_item_click: { model: any; value: any; event: PointerEvent };\n  legend_item_hover: { model: any; value: any; event: PointerEvent };\n  legend_item_unHover: { model: any; value: any; event: PointerEvent };\n  legend_change: { model: any; value: any; event: PointerEvent };\n\n  mouseenter_axis: MousePointerCellEvent & { axisPosition: 'left' | 'right' | 'top' | 'bottom' };\n  mouseleave_axis: MousePointerCellEvent & { axisPosition: 'left' | 'right' | 'top' | 'bottom' };\n\n  checkbox_state_change: MousePointerCellEvent & { checked: boolean };\n  radio_state_change: MousePointerCellEvent & { radioIndexInCell: number | undefined };\n  switch_state_change: MousePointerCellEvent & { checked: boolean };\n  before_init: { options: BaseTableConstructorOptions; container: HTMLElement | null };\n  before_set_size: { width: number; height: number };\n  after_render: null;\n  initialized: null;\n\n  change_cell_value: {\n    col: number;\n    row: number;\n    rawValue: string | number;\n    currentValue: string | number;\n    changedValue: string | number;\n  };\n\n  mousedown_fill_handle: {};\n  drag_fill_handle_end: { direction?: 'top' | 'bottom' | 'left' | 'right' };\n  dblclick_fill_handle: {};\n\n  empty_tip_click: {};\n  empty_tip_dblclick: {};\n\n  button_click: {\n    col: number;\n    row: number;\n    event: Event;\n  };\n  before_cache_chart_image: { chartInstance: any };\n  pasted_data: {\n    col: number;\n    row: number;\n    pasteData: (string | number)[][];\n    changedCellResults: boolean[][];\n  };\n}\nexport interface DrillMenuEventInfo {\n  dimensionKey: string | number;\n  title: string;\n  drillDown: boolean;\n  drillUp: boolean;\n  col: number;\n  row: number;\n  event: Event;\n}\nexport interface TableEventHandlersReturnMap {\n  selected_cell: void;\n  selected_clear: void;\n  click_cell: void;\n  dblclick_cell: void;\n  mouseenter_table: void;\n  mouseleave_table: void;\n  mousedown_table: void;\n  mousemove_table: void;\n  mouseenter_cell: void;\n  mouseleave_cell: void;\n  // mouseover_cell: void;\n  mouseout_cell: void;\n  mousemove_cell: void;\n  mousedown_cell: boolean;\n  mouseup_cell: void;\n  contextmenu_cell: void;\n  contextmenu_canvas: void;\n  before_keydown: void;\n  keydown: void;\n  scroll: void;\n  can_scroll: void | boolean;\n  focus_table: void;\n  blur_table: void;\n  resize_column: void;\n  resize_column_end: void;\n  resize_row: void;\n  resize_row_end: void;\n  change_header_position: void;\n  change_header_position_start: void;\n  changing_header_position: void;\n  change_header_position_fail: void;\n  sort_click: boolean;\n  after_sort: void;\n  freeze_click: void;\n  dropdown_menu_click: void;\n\n  mouseover_chart_symbol: void;\n  drag_select_end: void;\n  copy_data: void;\n  drillmenu_click: void;\n\n  dropdown_icon_click: void;\n  dropdown_menu_clear: void;\n\n  show_menu: void;\n  hide_menu: void;\n  icon_click: void;\n\n  pivot_sort_click: void;\n\n  tree_hierarchy_state_change: void;\n\n  vchart_event_type: void;\n  //datasource部分的事件\n  change_order: void;\n  source_length_update: void;\n  legend_item_click: void;\n  legend_item_hover: void;\n  legend_item_unHover: void;\n  legend_change: void;\n\n  mouseenter_axis: void;\n  mouseleave_axis: void;\n\n  checkbox_state_change: void;\n  radio_state_change: void;\n  switch_state_change: void;\n  before_init: void;\n  before_set_size: void;\n  after_render: void;\n  initialized: void;\n\n  change_cell_value: void;\n  mousedown_fill_handle: void;\n  drag_fill_handle_end: void;\n  dblclick_fill_handle: void;\n\n  scroll_vertical_end: void;\n\n  scroll_horizontal_end: void;\n\n  empty_tip_click: void;\n  empty_tip_dblclick: void;\n\n  button_click: void;\n  before_cache_chart_image: void;\n  pasted_data: void;\n}\n"]}
+{"version":3,"sources":["../src/ts-types/events.ts"],"names":[],"mappings":"","file":"events.js","sourcesContent":["import type {\n  CellAddress,\n  CellRange,\n  CellLocation,\n  FieldDef,\n  CellAddressWithBound,\n  ListTableConstructorOptions,\n  PivotTableConstructorOptions\n} from './table-engine';\nimport type { DropDownMenuEventArgs, MenuListItem, PivotInfo } from './menu';\n\nimport type { IDimensionInfo, MergeCellInfo, RectProps, SortOrder } from './common';\nimport type { IconFuncTypeEnum, CellInfo, HierarchyState } from '.';\nimport type { Icon } from '../scenegraph/graphic/icon';\nimport type { FederatedPointerEvent, IEventTarget } from './../vrender';\nimport type { BaseTableConstructorOptions } from './base-table';\n\nexport type KeyboardEventListener = (e: KeyboardEvent) => void;\nexport type TableEventListener<TYPE extends keyof TableEventHandlersEventArgumentMap> = (\n  args: TableEventHandlersEventArgumentMap[TYPE]\n) => TableEventHandlersReturnMap[TYPE]; //AnyFunction;\nexport type EventListenerId = number;\n\nexport type SelectedCellEvent = CellAddress & {\n  ranges: CellRange[];\n};\n\n// export type MouseCellEvent = CellAddress & {\n//   event: MouseEvent | PointerEvent | TouchEvent;\n// };\n\nexport type MenuEvent = CellAddress & {\n  dropDownMenu: MenuListItem[];\n  pivotInfo: PivotInfo;\n};\n\nexport type TouchCellEvent = CellAddress & {\n  event: TouchEvent;\n};\n\nexport type KeydownEvent = {\n  keyCode: number;\n  code: string;\n  event: KeyboardEvent;\n  stopCellMoving?: () => void;\n  scaleRatio?: number;\n};\n\nexport type MousePointerCellEvent = CellAddressWithBound &\n  CellInfo & {\n    scaleRatio?: number;\n    targetIcon?: { name: string; position: RectProps; funcType: string };\n    event?: MouseEvent | PointerEvent | TouchEvent;\n    federatedEvent?: FederatedPointerEvent;\n    target: IEventTarget | undefined;\n\n    mergeCellInfo?: MergeCellInfo;\n  };\n// 多单元格的事件传出参数 需要将当前鼠标处的单元格的信息FocusedCellInfo也带着\nexport type MousePointerMultiCellEvent = MousePointerCellEvent & {\n  cells: CellInfo[][];\n  // menuKey?: string;\n};\n\nexport type MousePointerSparklineEvent = MousePointerCellEvent & {\n  sparkline: {\n    pointData: any;\n  };\n};\n\nexport interface TableEventHandlersEventArgumentMap {\n  selected_cell: SelectedCellEvent;\n  selected_clear: {};\n  click_cell: MousePointerCellEvent;\n  dblclick_cell: MousePointerCellEvent;\n  mouseenter_table: { event?: MouseEvent | PointerEvent | TouchEvent };\n  mouseleave_table: { event?: MouseEvent | PointerEvent | TouchEvent };\n  mousedown_table: { event?: MouseEvent | PointerEvent | TouchEvent };\n  mousemove_table: MousePointerCellEvent;\n  mouseenter_cell: MousePointerCellEvent;\n  mouseleave_cell: MousePointerCellEvent;\n  mousemove_cell: MousePointerCellEvent;\n  mousedown_cell: MousePointerCellEvent;\n  mouseup_cell: MousePointerCellEvent;\n  contextmenu_cell: MousePointerMultiCellEvent;\n  contextmenu_canvas: MousePointerCellEvent;\n  before_keydown: KeydownEvent;\n  keydown: KeydownEvent;\n  scroll: {\n    event: WheelEvent;\n    scrollLeft: number;\n    scrollTop: number;\n    scrollWidth: number;\n    scrollHeight: number;\n    viewWidth: number;\n    viewHeight: number;\n    scrollDirection: 'horizontal' | 'vertical';\n    scrollRatioX?: number;\n    scrollRatioY?: number;\n    dx?: number;\n    dy?: number;\n  };\n  can_scroll: {\n    event: WheelEvent;\n    scrollLeft: number;\n    scrollTop: number;\n    scrollWidth: number;\n    scrollHeight: number;\n    viewWidth: number;\n    viewHeight: number;\n    scrollDirection: 'horizontal' | 'vertical';\n    scrollRatioX?: number;\n    scrollRatioY?: number;\n    dx?: number;\n    dy?: number;\n  };\n  scroll_vertical_end: {\n    scrollLeft: number;\n    scrollTop: number;\n    scrollWidth: number;\n    scrollHeight: number;\n    viewWidth: number;\n    viewHeight: number;\n  };\n  scroll_horizontal_end: {\n    scrollLeft: number;\n    scrollTop: number;\n    scrollWidth: number;\n    scrollHeight: number;\n    viewWidth: number;\n    viewHeight: number;\n  };\n  resize_column: { col: number; colWidth: number };\n  resize_column_end: { col: number; colWidths: number[] };\n  resize_row: { row: number; rowHeight: number };\n  resize_row_end: { row: number; rowHeight: number };\n  change_header_position: { source: CellAddress; target: CellAddress; event: Event };\n  change_header_position_start: {\n    col: number;\n    row: number;\n    x: number;\n    y: number;\n    backX: number;\n    lineX: number;\n    backY: number;\n    lineY: number;\n    event: Event;\n  };\n  changing_header_position: {\n    col: number;\n    row: number;\n    x: number;\n    y: number;\n    backX: number;\n    lineX: number;\n    backY: number;\n    lineY: number;\n    event: Event;\n  };\n  change_header_position_fail: { source: CellAddress; target: CellAddress; event: Event };\n  sort_click: {\n    field: FieldDef;\n    order: SortOrder;\n    event: Event;\n  };\n  after_sort: {\n    field: FieldDef;\n    order: SortOrder;\n    event: Event;\n  };\n  freeze_click: { col: number; row: number; fields: FieldDef[]; colCount: number };\n  dropdown_menu_click: DropDownMenuEventArgs;\n\n  mouseover_chart_symbol: MousePointerSparklineEvent;\n\n  drag_select_end: MousePointerMultiCellEvent;\n  selected_changed: {\n    col: number;\n    row: number;\n    ranges: CellRange[];\n  };\n  copy_data: { cellRange: CellRange[]; copyData: string; isCut: boolean };\n  drillmenu_click: DrillMenuEventInfo;\n\n  dropdown_icon_click: CellAddress & { event: Event };\n  dropdown_menu_clear: CellAddress;\n\n  show_menu: {\n    x: number;\n    y: number;\n    col: number;\n    row: number;\n    type: 'dropDown' | 'contextmenu' | 'custom';\n  };\n  hide_menu: [];\n  icon_click: {\n    name: string;\n    col: number;\n    row: number;\n    x: number;\n    y: number;\n    funcType?: IconFuncTypeEnum | string;\n    icon: Icon;\n    event: Event;\n  };\n\n  pivot_sort_click: {\n    col: number;\n    row: number;\n    order: SortOrder;\n    dimensionInfo: IDimensionInfo[];\n    cellLocation: CellLocation;\n    event: Event;\n  };\n  tree_hierarchy_state_change: {\n    col: number;\n    row: number;\n    changeAll?: boolean;\n    hierarchyState: HierarchyState;\n    dimensionInfo?: IDimensionInfo[];\n    /**整条数据-原始数据 */\n    originData?: any;\n    cellLocation?: CellLocation;\n  };\n  vchart_event_type: {\n    eventName: string;\n    col: number;\n    row: number;\n    chartEventArguments: any;\n  };\n  //datasource部分的事件\n  change_order: [];\n  source_length_update: number;\n\n  legend_item_click: { model: any; value: any; event: PointerEvent };\n  legend_item_hover: { model: any; value: any; event: PointerEvent };\n  legend_item_unHover: { model: any; value: any; event: PointerEvent };\n  legend_change: { model: any; value: any; event: PointerEvent };\n\n  mouseenter_axis: MousePointerCellEvent & { axisPosition: 'left' | 'right' | 'top' | 'bottom' };\n  mouseleave_axis: MousePointerCellEvent & { axisPosition: 'left' | 'right' | 'top' | 'bottom' };\n\n  checkbox_state_change: MousePointerCellEvent & { checked: boolean };\n  radio_state_change: MousePointerCellEvent & { radioIndexInCell: number | undefined };\n  switch_state_change: MousePointerCellEvent & { checked: boolean };\n  before_init: { options: BaseTableConstructorOptions; container: HTMLElement | null };\n  before_update_option: { options: BaseTableConstructorOptions; container: HTMLElement | null };\n  before_set_size: { width: number; height: number };\n  after_render: null;\n  initialized: null;\n  updated: null;\n\n  change_cell_value: {\n    col: number;\n    row: number;\n    rawValue: string | number;\n    currentValue: string | number;\n    changedValue: string | number;\n  };\n\n  mousedown_fill_handle: {};\n  drag_fill_handle_end: { direction?: 'top' | 'bottom' | 'left' | 'right' };\n  dblclick_fill_handle: {};\n\n  empty_tip_click: {};\n  empty_tip_dblclick: {};\n\n  button_click: {\n    col: number;\n    row: number;\n    event: Event;\n  };\n  before_cache_chart_image: { chartInstance: any };\n  pasted_data: {\n    col: number;\n    row: number;\n    pasteData: (string | number)[][];\n    changedCellResults: boolean[][];\n  };\n  plugin_event: {\n    event: any;\n    plugin: any;\n    pluginEventInfo: any;\n  };\n}\nexport interface DrillMenuEventInfo {\n  dimensionKey: string | number;\n  title: string;\n  drillDown: boolean;\n  drillUp: boolean;\n  col: number;\n  row: number;\n  event: Event;\n}\nexport interface TableEventHandlersReturnMap {\n  selected_cell: void;\n  selected_clear: void;\n  click_cell: void;\n  dblclick_cell: void;\n  mouseenter_table: void;\n  mouseleave_table: void;\n  mousedown_table: void;\n  mousemove_table: void;\n  mouseenter_cell: void;\n  mouseleave_cell: void;\n  // mouseover_cell: void;\n  mouseout_cell: void;\n  mousemove_cell: void;\n  mousedown_cell: void;\n  mouseup_cell: void;\n  contextmenu_cell: void;\n  contextmenu_canvas: void;\n  before_keydown: void;\n  keydown: void;\n  scroll: void;\n  can_scroll: void | boolean;\n  focus_table: void;\n  blur_table: void;\n  resize_column: void;\n  resize_column_end: void;\n  resize_row: void;\n  resize_row_end: void;\n  change_header_position: void;\n  change_header_position_start: void;\n  changing_header_position: void;\n  change_header_position_fail: void;\n  sort_click: boolean;\n  after_sort: void;\n  freeze_click: void;\n  dropdown_menu_click: void;\n\n  mouseover_chart_symbol: void;\n  drag_select_end: void;\n  selected_changed: void;\n  copy_data: void;\n  drillmenu_click: void;\n\n  dropdown_icon_click: void;\n  dropdown_menu_clear: void;\n\n  show_menu: void;\n  hide_menu: void;\n  icon_click: void;\n\n  pivot_sort_click: void;\n\n  tree_hierarchy_state_change: void;\n\n  vchart_event_type: void;\n  //datasource部分的事件\n  change_order: void;\n  source_length_update: void;\n  legend_item_click: void;\n  legend_item_hover: void;\n  legend_item_unHover: void;\n  legend_change: void;\n\n  mouseenter_axis: void;\n  mouseleave_axis: void;\n\n  checkbox_state_change: void;\n  radio_state_change: void;\n  switch_state_change: void;\n  before_init: void;\n  before_update_option: void;\n  before_set_size: void;\n  after_render: void;\n  initialized: void;\n  updated: void;\n\n  change_cell_value: void;\n  mousedown_fill_handle: void;\n  drag_fill_handle_end: void;\n  dblclick_fill_handle: void;\n\n  scroll_vertical_end: void;\n\n  scroll_horizontal_end: void;\n\n  empty_tip_click: void;\n  empty_tip_dblclick: void;\n\n  button_click: void;\n  before_cache_chart_image: void;\n  pasted_data: void;\n  plugin_event: void;\n}\n"]}

package/es/ts-types/new-data-set.d.ts

@@ -116,6 +116,7 @@ export interface CalculateddFieldRule {
 }
 export type CalculateddFieldRules = CalculateddFieldRule[];
 export interface IListTableDataConfig {
+    addRecordRule: 'Array' | 'Object';
     groupByRules?: string[];
     filterRules?: FilterRules;
 }

package/es/ts-types/new-data-set.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ts-types/new-data-set.ts"],"names":[],"mappings":"AAYA,MAAM,CAAN,IAAY,eAUX;AAVD,WAAY,eAAe;IACzB,oCAAiB,CAAA;IACjB,gCAAa,CAAA;IACb,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,oCAAiB,CAAA;IACjB,8CAA2B,CAAA;AAC7B,CAAC,EAVW,eAAe,KAAf,eAAe,QAU1B;AACD,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB,yBAAa,CAAA;IACb,uBAAW,CAAA;IACX,6BAAiB,CAAA;AACnB,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB","file":"new-data-set.js","sourcesContent":["import type { ColorPropertyDefine } from '.';\nimport type { Either } from '../tools/helper';\nimport type { BaseTableAPI } from './base-table';\n\n//#region 总计小计\nexport interface TotalsStatus {\n  isRowTotal: boolean;\n  isRowSubTotal: boolean;\n  isColTotal: boolean;\n  isColSubTotal: boolean;\n}\n\nexport enum AggregationType {\n  RECORD = 'RECORD',\n  NONE = 'NONE', //不做聚合 只获取其中一条数据作为节点的record 取其field\n  SUM = 'SUM',\n  MIN = 'MIN',\n  MAX = 'MAX',\n  AVG = 'AVG',\n  COUNT = 'COUNT',\n  CUSTOM = 'CUSTOM',\n  RECALCULATE = 'RECALCULATE'\n}\nexport enum SortType {\n  ASC = 'ASC',\n  DESC = 'DESC',\n  NORMAL = 'NORMAL',\n  desc = 'desc',\n  asc = 'asc',\n  normal = 'normal'\n}\nexport interface CalcTotals {\n  aggregationType?: AggregationType; // 聚合方式\n  // calcFunc?: (query: Record<string, any>, arr: Record<string, any>[]) => number;\n}\n\nexport interface Total {\n  /** 是否显示总计; 如果配置了total对象，showGrandTotals默认false */\n  showGrandTotals: boolean;\n  /** 是否显示小计;  如果配置了total对象，showSubTotals默认为true */\n  showSubTotals: boolean;\n\n  // // 计算总计方法\n  // calcGrandTotals?: CalcTotals;\n  // // 计算小计方法\n  // calcSubTotals?: CalcTotals;\n  /** 小计汇总维度定义 */\n  subTotalsDimensions?: string[];\n  /** 汇总节点显示名称  默认'总计' */\n  grandTotalLabel?: string;\n  /** 汇总节点显示名称  默认'小计' */\n  subTotalLabel?: string;\n}\n\nexport interface Totals {\n  row?: Total & {\n    /** 总计显示在上 默认false */\n    showGrandTotalsOnTop?: boolean;\n    /** 小计显示在上 默认false */\n    showSubTotalsOnTop?: boolean;\n  };\n  column?: Total & {\n    /** 总计显示在左 默认false */\n    showGrandTotalsOnLeft?: boolean;\n    /** 小计显示在左 默认false */\n    showSubTotalsOnLeft?: boolean;\n  };\n}\n\n//#endregion 总计小计\n\n//#region 排序规则\n// export interface SortRule {\n//   //排序维度\n//   sortField: string;\n//   //以下均为排序方法\n//   //1. 指定排序类型\n//   sortType?: SortType;\n//   //2. 按维度成员指定排序\n//   sortBy?: string[];\n//   //3. 按指标值排序\n//   sortByIndicator?: string;\n//   //如果按指标值排序，还需要指定另外一个（行或列）方向的底层维度成员具体值\n//   query?: string[];\n//   //4. 自定义排序方法function\n//   sortFunc?: (a: any, b: any) => number;\n// }\n//以下均为排序方法\n//1. 指定排序类型\nexport interface SortTypeRule {\n  /**排序维度 */\n  sortField: string;\n  /**升序降序 ASC or DESC*/\n  sortType?: SortType;\n}\n//2. 按维度成员指定排序\nexport interface SortByRule {\n  /**排序维度 */\n  sortField: string;\n  /**升序降序 ASC or DESC*/\n  sortType?: SortType;\n  /**根据指定具体顺序排序 */\n  sortBy?: string[];\n}\n//3. 按指标值排序\nexport interface SortByIndicatorRule {\n  /**排序维度 */\n  sortField: string;\n  /**升序降序 ASC or DESC*/\n  sortType?: SortType;\n  /**排序根据某个指标值 */\n  sortByIndicator?: string;\n  /**如果按指标值排序，还需要指定另外一个（行或列）方向的底层维度成员具体值。例如按照办公用品下的纸张 ['办公用品', '纸张'] */\n  query?: string[];\n  /**自定义排序函数 否则按自然排序 */\n  sortFunc?: (\n    value_a: string | number,\n    value_b: string | number,\n    path_a: string[],\n    path_b: string[],\n    sortType: SortType\n  ) => number;\n}\n//4. 自定义排序方法function\nexport interface SortFuncRule {\n  /**排序维度 */\n  sortField: string;\n  /**升序降序 ASC or DESC*/\n  sortType?: SortType;\n  /**自定义排序函数 */\n  sortFunc?: (a: any, b: any, sortType: SortType) => number;\n}\n//自定义排序方法参数\n// export interface SortFuncParam extends SortRule {\n//   data: Array<string | Record<string, any>>;\n// }\nexport type SortRule = SortTypeRule | SortByRule | SortByIndicatorRule | SortFuncRule;\nexport type SortRules = SortRule[];\n//#endregion 排序规则\n\n//#region 过滤规则\nexport interface FilterFuncRule {\n  filterFunc?: (row: Record<string, any>) => boolean;\n}\nexport interface FilterValueRule {\n  filterKey?: string;\n  filteredValues?: unknown[];\n}\nexport type FilterRules = Either<FilterFuncRule, FilterValueRule>[];\n//#endregion 过滤规则\n\n//#region 聚合规则\nexport interface AggregationRule<T extends AggregationType> {\n  /** 区别于field 重新起个key值，供配置indicators使用 */\n  indicatorKey: string;\n  // 可以收集单个字段的聚合结果，或者收集多个字段的聚合结果\n  field: string[] | string;\n  aggregationType: string | T;\n  /** aggregationType 配置为 AggregationType.CUSTOM 时，需要配置 aggregationFun。*/\n  aggregationFun?: T extends AggregationType.CUSTOM ? (values: any[], records: any[]) => any : undefined;\n  /**计算结果格式化 */\n  formatFun?: (value: number, col: number, row: number, table: BaseTableAPI) => number | string;\n}\nexport type AggregationRules = AggregationRule<AggregationType>[];\n\n//#endregion 聚合规则\n\n//#region 映射规则\nexport interface MappingRule {\n  label?: LabelMapping;\n  symbol?: SymbolMapping;\n  bgColor?: MappingFuncRule;\n}\nexport type MappingRules = MappingRule[];\nexport interface LabelMapping {\n  text?: MappingFuncRule;\n  color?: MappingFuncRule;\n}\nexport interface SymbolMapping {\n  shape?: 'circle' | 'rect';\n  color?: MappingFuncRule;\n  size?: MappingFuncRule;\n}\n\nexport type MappingFuncRule = {\n  indicatorKey: string;\n  mapping?: ColorPropertyDefine;\n};\n\n//#endregion 映射规则\n\n//#region 派生字段规则\nexport interface DerivedFieldRule {\n  fieldName?: string;\n  derivedFunc?: (record: Record<string, any>) => any;\n}\nexport type DerivedFieldRules = DerivedFieldRule[];\n//#endregion 派生字段规则\n\n//#region 计算字段规则\nexport interface CalculateddFieldRule {\n  /** 唯一标识，可以当做新指标的key，用于配置在 indicators 中在透视表中展示。 */\n  key: string;\n  /** 计算字段依赖的指标，可以是在 records 中具体对应的指标字段 or 不是数据records 中的字段\n   * 如果依赖的指标不在 records 中，则需要在 aggregationRules 中明确配置，具体指明聚合规则和 indicatorKey 以在 dependIndicatorKeys 所使用。 */\n  dependIndicatorKeys: string[];\n  /** 计算字段的计算函数，依赖的指标值作为参数传入，返回值作为计算字段的值。   */\n  calculateFun?: (dependFieldsValue: any) => any;\n}\n\nexport type CalculateddFieldRules = CalculateddFieldRule[];\n//#endregion 计算字段规则\n\n/**\n * 基本表数据处理配置\n */\nexport interface IListTableDataConfig {\n  groupByRules?: string[]; //按照行列维度分组规则；\n  // aggregationRules?: AggregationRules; //按照行列维度聚合值计算规则；\n  // sortRules?: SortTypeRule | SortByRule | SortFuncRule; //排序规则 不能简单的将sortState挪到这里 sort的规则在column中配置的；\n  filterRules?: FilterRules; //过滤规则；\n  // totals?: Totals; //小计或总计；\n  // derivedFieldRules?: DerivedFieldRules;\n}\n/**\n * 透视表数据处理配置\n */\nexport interface IPivotTableDataConfig {\n  aggregationRules?: AggregationRules; //按照行列维度聚合值计算规则；\n  sortRules?: SortRules; //排序规则；\n  filterRules?: FilterRules; //过滤规则；\n  totals?: Totals; //小计或总计；\n  /**\n   * 目前mappding还不太好用  不建议使用  建议先用style\n   */\n  mappingRules?: MappingRules;\n  derivedFieldRules?: DerivedFieldRules;\n  calculatedFieldRules?: CalculateddFieldRules;\n  /** 编辑单元格时是否更新聚合值, 默认为false */\n  updateAggregationOnEditCell?: boolean;\n}\n\n/**\n * 透视图数据处理配置\n */\nexport interface IPivotChartDataConfig extends IPivotTableDataConfig {\n  /**\n   * PivotChart专有\n   */\n  collectValuesBy?: Record<string, CollectValueBy>;\n  /**\n   * PivotChart专有\n   */\n  isPivotChart?: boolean;\n  /**\n   * PivotChart专有\n   */\n  dimensionSortArray?: string[];\n}\n\n/** 在处理数据的过程中 去额外收集某个维度的维度值范围 可为离散值或者连续值范围 */\nexport type CollectValueBy = {\n  /** 要收集的字段按什么进行分组 */\n  by: string[];\n  /** 是否计算一个range范围 true的话对应的收集数据的结果为{max:number,min:number} */\n  range?: boolean;\n  /** 收集是按照sumBy字段相同的进行分组聚合 聚合结果求最大最小值；如果不设置该值 则按单条数据求最大最小值 */\n  sumBy?: string[];\n  /** 帮助计算列宽使用 如果是chart图表 收集的是xFiled的维度值 可以根据维度值的个数乘于图元宽度计算一个最优列宽*/\n  type?: 'xField' | 'yField' | undefined;\n  /** 如果是收集的离散值，离散值的排序依据 */\n  sortBy?: string[];\n  /** chartSpec中设置了markLine autoRange的情况 考虑扩展轴范围 */\n  extendRange?: number | 'sum' | 'max';\n};\nexport type CollectedValue = { max?: number; min?: number } | Array<string>;\n\n//#region 提供给基本表格的类型\nexport type Aggregation = {\n  aggregationType: AggregationType;\n  showOnTop?: boolean;\n  formatFun?: (value: number, col: number, row: number, table: BaseTableAPI) => string | number;\n};\n\nexport type CustomAggregation = {\n  aggregationType: AggregationType.CUSTOM;\n  aggregationFun: (values: any[], records: any[]) => any;\n  showOnTop?: boolean;\n  formatFun?: (value: number, col: number, row: number, table: BaseTableAPI) => string | number;\n};\n//#endregion\n"]}
+{"version":3,"sources":["../src/ts-types/new-data-set.ts"],"names":[],"mappings":"AAYA,MAAM,CAAN,IAAY,eAUX;AAVD,WAAY,eAAe;IACzB,oCAAiB,CAAA;IACjB,gCAAa,CAAA;IACb,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,oCAAiB,CAAA;IACjB,8CAA2B,CAAA;AAC7B,CAAC,EAVW,eAAe,KAAf,eAAe,QAU1B;AACD,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB,yBAAa,CAAA;IACb,uBAAW,CAAA;IACX,6BAAiB,CAAA;AACnB,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB","file":"new-data-set.js","sourcesContent":["import type { ColorPropertyDefine } from '.';\nimport type { Either } from '../tools/helper';\nimport type { BaseTableAPI } from './base-table';\n\n//#region 总计小计\nexport interface TotalsStatus {\n  isRowTotal: boolean;\n  isRowSubTotal: boolean;\n  isColTotal: boolean;\n  isColSubTotal: boolean;\n}\n\nexport enum AggregationType {\n  RECORD = 'RECORD',\n  NONE = 'NONE', //不做聚合 只获取其中一条数据作为节点的record 取其field\n  SUM = 'SUM',\n  MIN = 'MIN',\n  MAX = 'MAX',\n  AVG = 'AVG',\n  COUNT = 'COUNT',\n  CUSTOM = 'CUSTOM',\n  RECALCULATE = 'RECALCULATE'\n}\nexport enum SortType {\n  ASC = 'ASC',\n  DESC = 'DESC',\n  NORMAL = 'NORMAL',\n  desc = 'desc',\n  asc = 'asc',\n  normal = 'normal'\n}\nexport interface CalcTotals {\n  aggregationType?: AggregationType; // 聚合方式\n  // calcFunc?: (query: Record<string, any>, arr: Record<string, any>[]) => number;\n}\n\nexport interface Total {\n  /** 是否显示总计; 如果配置了total对象，showGrandTotals默认false */\n  showGrandTotals: boolean;\n  /** 是否显示小计;  如果配置了total对象，showSubTotals默认为true */\n  showSubTotals: boolean;\n\n  // // 计算总计方法\n  // calcGrandTotals?: CalcTotals;\n  // // 计算小计方法\n  // calcSubTotals?: CalcTotals;\n  /** 小计汇总维度定义 */\n  subTotalsDimensions?: string[];\n  /** 汇总节点显示名称  默认'总计' */\n  grandTotalLabel?: string;\n  /** 汇总节点显示名称  默认'小计' */\n  subTotalLabel?: string;\n}\n\nexport interface Totals {\n  row?: Total & {\n    /** 总计显示在上 默认false */\n    showGrandTotalsOnTop?: boolean;\n    /** 小计显示在上 默认false */\n    showSubTotalsOnTop?: boolean;\n  };\n  column?: Total & {\n    /** 总计显示在左 默认false */\n    showGrandTotalsOnLeft?: boolean;\n    /** 小计显示在左 默认false */\n    showSubTotalsOnLeft?: boolean;\n  };\n}\n\n//#endregion 总计小计\n\n//#region 排序规则\n// export interface SortRule {\n//   //排序维度\n//   sortField: string;\n//   //以下均为排序方法\n//   //1. 指定排序类型\n//   sortType?: SortType;\n//   //2. 按维度成员指定排序\n//   sortBy?: string[];\n//   //3. 按指标值排序\n//   sortByIndicator?: string;\n//   //如果按指标值排序，还需要指定另外一个（行或列）方向的底层维度成员具体值\n//   query?: string[];\n//   //4. 自定义排序方法function\n//   sortFunc?: (a: any, b: any) => number;\n// }\n//以下均为排序方法\n//1. 指定排序类型\nexport interface SortTypeRule {\n  /**排序维度 */\n  sortField: string;\n  /**升序降序 ASC or DESC*/\n  sortType?: SortType;\n}\n//2. 按维度成员指定排序\nexport interface SortByRule {\n  /**排序维度 */\n  sortField: string;\n  /**升序降序 ASC or DESC*/\n  sortType?: SortType;\n  /**根据指定具体顺序排序 */\n  sortBy?: string[];\n}\n//3. 按指标值排序\nexport interface SortByIndicatorRule {\n  /**排序维度 */\n  sortField: string;\n  /**升序降序 ASC or DESC*/\n  sortType?: SortType;\n  /**排序根据某个指标值 */\n  sortByIndicator?: string;\n  /**如果按指标值排序，还需要指定另外一个（行或列）方向的底层维度成员具体值。例如按照办公用品下的纸张 ['办公用品', '纸张'] */\n  query?: string[];\n  /**自定义排序函数 否则按自然排序 */\n  sortFunc?: (\n    value_a: string | number,\n    value_b: string | number,\n    path_a: string[],\n    path_b: string[],\n    sortType: SortType\n  ) => number;\n}\n//4. 自定义排序方法function\nexport interface SortFuncRule {\n  /**排序维度 */\n  sortField: string;\n  /**升序降序 ASC or DESC*/\n  sortType?: SortType;\n  /**自定义排序函数 */\n  sortFunc?: (a: any, b: any, sortType: SortType) => number;\n}\n//自定义排序方法参数\n// export interface SortFuncParam extends SortRule {\n//   data: Array<string | Record<string, any>>;\n// }\nexport type SortRule = SortTypeRule | SortByRule | SortByIndicatorRule | SortFuncRule;\nexport type SortRules = SortRule[];\n//#endregion 排序规则\n\n//#region 过滤规则\nexport interface FilterFuncRule {\n  filterFunc?: (row: Record<string, any>) => boolean;\n}\nexport interface FilterValueRule {\n  filterKey?: string;\n  filteredValues?: unknown[];\n}\nexport type FilterRules = Either<FilterFuncRule, FilterValueRule>[];\n//#endregion 过滤规则\n\n//#region 聚合规则\nexport interface AggregationRule<T extends AggregationType> {\n  /** 区别于field 重新起个key值，供配置indicators使用 */\n  indicatorKey: string;\n  // 可以收集单个字段的聚合结果，或者收集多个字段的聚合结果\n  field: string[] | string;\n  aggregationType: string | T;\n  /** aggregationType 配置为 AggregationType.CUSTOM 时，需要配置 aggregationFun。*/\n  aggregationFun?: T extends AggregationType.CUSTOM ? (values: any[], records: any[]) => any : undefined;\n  /**计算结果格式化 */\n  formatFun?: (value: number, col: number, row: number, table: BaseTableAPI) => number | string;\n}\nexport type AggregationRules = AggregationRule<AggregationType>[];\n\n//#endregion 聚合规则\n\n//#region 映射规则\nexport interface MappingRule {\n  label?: LabelMapping;\n  symbol?: SymbolMapping;\n  bgColor?: MappingFuncRule;\n}\nexport type MappingRules = MappingRule[];\nexport interface LabelMapping {\n  text?: MappingFuncRule;\n  color?: MappingFuncRule;\n}\nexport interface SymbolMapping {\n  shape?: 'circle' | 'rect';\n  color?: MappingFuncRule;\n  size?: MappingFuncRule;\n}\n\nexport type MappingFuncRule = {\n  indicatorKey: string;\n  mapping?: ColorPropertyDefine;\n};\n\n//#endregion 映射规则\n\n//#region 派生字段规则\nexport interface DerivedFieldRule {\n  fieldName?: string;\n  derivedFunc?: (record: Record<string, any>) => any;\n}\nexport type DerivedFieldRules = DerivedFieldRule[];\n//#endregion 派生字段规则\n\n//#region 计算字段规则\nexport interface CalculateddFieldRule {\n  /** 唯一标识，可以当做新指标的key，用于配置在 indicators 中在透视表中展示。 */\n  key: string;\n  /** 计算字段依赖的指标，可以是在 records 中具体对应的指标字段 or 不是数据records 中的字段\n   * 如果依赖的指标不在 records 中，则需要在 aggregationRules 中明确配置，具体指明聚合规则和 indicatorKey 以在 dependIndicatorKeys 所使用。 */\n  dependIndicatorKeys: string[];\n  /** 计算字段的计算函数，依赖的指标值作为参数传入，返回值作为计算字段的值。   */\n  calculateFun?: (dependFieldsValue: any) => any;\n}\n\nexport type CalculateddFieldRules = CalculateddFieldRule[];\n//#endregion 计算字段规则\n\n/**\n * 基本表数据处理配置\n */\nexport interface IListTableDataConfig {\n  addRecordRule: 'Array' | 'Object';\n  groupByRules?: string[]; //按照行列维度分组规则；\n  // aggregationRules?: AggregationRules; //按照行列维度聚合值计算规则；\n  // sortRules?: SortTypeRule | SortByRule | SortFuncRule; //排序规则 不能简单的将sortState挪到这里 sort的规则在column中配置的；\n  filterRules?: FilterRules; //过滤规则；\n  // totals?: Totals; //小计或总计；\n  // derivedFieldRules?: DerivedFieldRules;\n}\n/**\n * 透视表数据处理配置\n */\nexport interface IPivotTableDataConfig {\n  aggregationRules?: AggregationRules; //按照行列维度聚合值计算规则；\n  sortRules?: SortRules; //排序规则；\n  filterRules?: FilterRules; //过滤规则；\n  totals?: Totals; //小计或总计；\n  /**\n   * 目前mappding还不太好用  不建议使用  建议先用style\n   */\n  mappingRules?: MappingRules;\n  derivedFieldRules?: DerivedFieldRules;\n  calculatedFieldRules?: CalculateddFieldRules;\n  /** 编辑单元格时是否更新聚合值, 默认为false */\n  updateAggregationOnEditCell?: boolean;\n}\n\n/**\n * 透视图数据处理配置\n */\nexport interface IPivotChartDataConfig extends IPivotTableDataConfig {\n  /**\n   * PivotChart专有\n   */\n  collectValuesBy?: Record<string, CollectValueBy>;\n  /**\n   * PivotChart专有\n   */\n  isPivotChart?: boolean;\n  /**\n   * PivotChart专有\n   */\n  dimensionSortArray?: string[];\n}\n\n/** 在处理数据的过程中 去额外收集某个维度的维度值范围 可为离散值或者连续值范围 */\nexport type CollectValueBy = {\n  /** 要收集的字段按什么进行分组 */\n  by: string[];\n  /** 是否计算一个range范围 true的话对应的收集数据的结果为{max:number,min:number} */\n  range?: boolean;\n  /** 收集是按照sumBy字段相同的进行分组聚合 聚合结果求最大最小值；如果不设置该值 则按单条数据求最大最小值 */\n  sumBy?: string[];\n  /** 帮助计算列宽使用 如果是chart图表 收集的是xFiled的维度值 可以根据维度值的个数乘于图元宽度计算一个最优列宽*/\n  type?: 'xField' | 'yField' | undefined;\n  /** 如果是收集的离散值，离散值的排序依据 */\n  sortBy?: string[];\n  /** chartSpec中设置了markLine autoRange的情况 考虑扩展轴范围 */\n  extendRange?: number | 'sum' | 'max';\n};\nexport type CollectedValue = { max?: number; min?: number } | Array<string>;\n\n//#region 提供给基本表格的类型\nexport type Aggregation = {\n  aggregationType: AggregationType;\n  showOnTop?: boolean;\n  formatFun?: (value: number, col: number, row: number, table: BaseTableAPI) => string | number;\n};\n\nexport type CustomAggregation = {\n  aggregationType: AggregationType.CUSTOM;\n  aggregationFun: (values: any[], records: any[]) => any;\n  showOnTop?: boolean;\n  formatFun?: (value: number, col: number, row: number, table: BaseTableAPI) => string | number;\n};\n//#endregion\n"]}

package/es/ts-types/style-define.d.ts

@@ -70,3 +70,9 @@ export type CellStyle = {
     _strokeArrayColor: string[];
     _linkColor: CanvasRenderingContext2D['fillStyle'];
 };
+export type CustomSelectionStyle = {
+    cellBorderColor?: string;
+    cellBorderLineWidth?: number;
+    cellBorderLineDash?: number[];
+    cellBgColor?: string;
+};

package/es/ts-types/style-define.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/ts-types/style-define.ts"],"names":[],"mappings":"","file":"style-define.js","sourcesContent":["import type { BaseTableAPI } from './base-table';\nimport type { ColorsDef, ICellHeaderPaths, LineDashsDef, LineWidthsDef, PaddingsDef } from './common';\nimport type { ColumnIconOption } from './icon';\nimport type { FieldData } from './table-engine';\n\n// ****** TextStyle Options *******\nexport type TextOverflow = string /* a char */; //设置一行的省略形式，另外还有clip。如果autoWrapText设置了自动换行，这个无效\nexport type LineClamp = number | 'auto'; //设置单元格显示的行数，如果不设置的话 默认全部展示直到超过了显示范围，会截断暂时文本，如果设置了auto，显示不了的文本会出现省略号\nexport type TextAlignType = 'center' | 'end' | 'left' | 'right' | 'start'; // 设置单元格内文字的水平对齐方式\nexport type TextBaselineType = 'alphabetic' | 'bottom' | 'middle' | 'top'; // 设置单元格内文字的垂直对齐方式\n\nexport interface StylePropertyFunctionArg {\n  row: number;\n  col: number;\n  /** 表格实例 */\n  table: BaseTableAPI;\n  /**有format的话 格式化后或者计算后的值 */\n  value?: FieldData;\n  /**原始值 */\n  dataValue?: FieldData;\n  /** progressbar类型特有，表示当前数值在总体数据范围的比例 */\n  percentile?: number;\n  /** 单元格的表头路径信息 */\n  cellHeaderPaths?: ICellHeaderPaths;\n}\nexport type ColorPropertyDefine =\n  | string\n  | ((args: StylePropertyFunctionArg) => string)\n  | ((args: StylePropertyFunctionArg) => CanvasGradient)\n  | ((args: StylePropertyFunctionArg) => CanvasPattern);\n\nexport type ColorsPropertyDefine =\n  | ColorPropertyDefine\n  | (string | null)[]\n  | ((args: StylePropertyFunctionArg) => (string | null)[]);\n\nexport type LineWidthPropertyDefine = number | ((args: StylePropertyFunctionArg) => number);\n\nexport type LineWidthsPropertyDefine =\n  | LineWidthPropertyDefine\n  | (number | null)[]\n  | ((args: StylePropertyFunctionArg) => (number | null)[]);\n\nexport type LineDashPropertyDefine = Array<number> | ((args: StylePropertyFunctionArg) => Array<number>);\n\nexport type LineDashsPropertyDefine =\n  | LineDashPropertyDefine\n  | (Array<number> | null)[]\n  | ((args: StylePropertyFunctionArg) => (Array<number> | null)[]);\n\n// export type FontPropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\nexport type FontSizePropertyDefine = number | ((args: StylePropertyFunctionArg) => number);\nexport type FontFamilyPropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\nexport type FontWeightPropertyDefine = string | number | ((args: StylePropertyFunctionArg) => string | number);\nexport type FontVariantPropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\nexport type FontStylePropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\n\nexport type TagPropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\n\nexport type CursorPropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\n\nexport type IconPropertyDefine =\n  | string\n  | ColumnIconOption\n  | ((args: StylePropertyFunctionArg) => string | ColumnIconOption);\n\nexport type UnderlinePropertyDefine = boolean | ((args: StylePropertyFunctionArg) => boolean);\nexport type LineThroughPropertyDefine = boolean | ((args: StylePropertyFunctionArg) => boolean);\n\nexport type PaddingPropertyDefine = number | ((args: StylePropertyFunctionArg) => number);\n\nexport type PaddingsPropertyDefine =\n  | PaddingPropertyDefine\n  | (number | null)[]\n  | ((args: StylePropertyFunctionArg) => (number | null)[]);\n\nexport type MarkCellStyle = {\n  /** 标记背景色 默认蓝色*/\n  bgColor?: CanvasRenderingContext2D['fillStyle'];\n  /** 标记形状 默认'sector' */\n  shape?: 'rect' | 'triangle' | 'sector';\n  /** 标记位置 默认'right-top' */\n  position?: 'left-top' | 'left-bottom' | 'right-top' | 'right-bottom';\n  /** 标记大小 默认10 */\n  size?: number;\n  /** 标记偏移量 默认0 */\n  offset?: number;\n};\nexport type MarkedPropertyDefine =\n  | boolean\n  | MarkCellStyle\n  | ((args: StylePropertyFunctionArg) => boolean | MarkCellStyle);\n\nexport type CellStyle = {\n  textAlign: CanvasTextAlign;\n  padding: PaddingsDef;\n  textBaseline: CanvasTextBaseline;\n  color: CanvasRenderingContext2D['fillStyle'];\n  strokeColor?: CanvasRenderingContext2D['fillStyle'];\n  bgColor: CanvasRenderingContext2D['fillStyle'];\n  // font: string;\n  fontSize: number;\n  fontFamily: string;\n  fontWeight: string | number;\n  fontVariant: string;\n  fontStyle: string;\n  // lineHeight: string | number;\n  lineHeight: number;\n  autoWrapText: boolean;\n  lineClamp: LineClamp;\n  textOverflow: TextOverflow;\n  borderColor: ColorsDef;\n  borderLineWidth: LineWidthsDef;\n  borderLineDash: LineDashsDef;\n  underline: boolean;\n  // underlineColor: CanvasRenderingContext2D['strokeStyle'];\n  underlineWidth: number;\n  underlineDash: number[];\n  underlineOffset: number;\n  lineThrough: boolean;\n  // lineThroughColor: CanvasRenderingContext2D['strokeStyle'];\n  // lineThroughDash: number[];\n  lineThroughLineWidth: number;\n\n  _strokeArrayWidth: number[];\n  _strokeArrayColor: string[];\n  _linkColor: CanvasRenderingContext2D['fillStyle'];\n};\n"]}
+{"version":3,"sources":["../src/ts-types/style-define.ts"],"names":[],"mappings":"","file":"style-define.js","sourcesContent":["import type { BaseTableAPI } from './base-table';\nimport type { ColorsDef, ICellHeaderPaths, LineDashsDef, LineWidthsDef, PaddingsDef } from './common';\nimport type { ColumnIconOption } from './icon';\nimport type { FieldData } from './table-engine';\n\n// ****** TextStyle Options *******\nexport type TextOverflow = string /* a char */; //设置一行的省略形式，另外还有clip。如果autoWrapText设置了自动换行，这个无效\nexport type LineClamp = number | 'auto'; //设置单元格显示的行数，如果不设置的话 默认全部展示直到超过了显示范围，会截断暂时文本，如果设置了auto，显示不了的文本会出现省略号\nexport type TextAlignType = 'center' | 'end' | 'left' | 'right' | 'start'; // 设置单元格内文字的水平对齐方式\nexport type TextBaselineType = 'alphabetic' | 'bottom' | 'middle' | 'top'; // 设置单元格内文字的垂直对齐方式\n\nexport interface StylePropertyFunctionArg {\n  row: number;\n  col: number;\n  /** 表格实例 */\n  table: BaseTableAPI;\n  /**有format的话 格式化后或者计算后的值 */\n  value?: FieldData;\n  /**原始值 */\n  dataValue?: FieldData;\n  /** progressbar类型特有，表示当前数值在总体数据范围的比例 */\n  percentile?: number;\n  /** 单元格的表头路径信息 */\n  cellHeaderPaths?: ICellHeaderPaths;\n}\nexport type ColorPropertyDefine =\n  | string\n  | ((args: StylePropertyFunctionArg) => string)\n  | ((args: StylePropertyFunctionArg) => CanvasGradient)\n  | ((args: StylePropertyFunctionArg) => CanvasPattern);\n\nexport type ColorsPropertyDefine =\n  | ColorPropertyDefine\n  | (string | null)[]\n  | ((args: StylePropertyFunctionArg) => (string | null)[]);\n\nexport type LineWidthPropertyDefine = number | ((args: StylePropertyFunctionArg) => number);\n\nexport type LineWidthsPropertyDefine =\n  | LineWidthPropertyDefine\n  | (number | null)[]\n  | ((args: StylePropertyFunctionArg) => (number | null)[]);\n\nexport type LineDashPropertyDefine = Array<number> | ((args: StylePropertyFunctionArg) => Array<number>);\n\nexport type LineDashsPropertyDefine =\n  | LineDashPropertyDefine\n  | (Array<number> | null)[]\n  | ((args: StylePropertyFunctionArg) => (Array<number> | null)[]);\n\n// export type FontPropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\nexport type FontSizePropertyDefine = number | ((args: StylePropertyFunctionArg) => number);\nexport type FontFamilyPropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\nexport type FontWeightPropertyDefine = string | number | ((args: StylePropertyFunctionArg) => string | number);\nexport type FontVariantPropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\nexport type FontStylePropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\n\nexport type TagPropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\n\nexport type CursorPropertyDefine = string | ((args: StylePropertyFunctionArg) => string);\n\nexport type IconPropertyDefine =\n  | string\n  | ColumnIconOption\n  | ((args: StylePropertyFunctionArg) => string | ColumnIconOption);\n\nexport type UnderlinePropertyDefine = boolean | ((args: StylePropertyFunctionArg) => boolean);\nexport type LineThroughPropertyDefine = boolean | ((args: StylePropertyFunctionArg) => boolean);\n\nexport type PaddingPropertyDefine = number | ((args: StylePropertyFunctionArg) => number);\n\nexport type PaddingsPropertyDefine =\n  | PaddingPropertyDefine\n  | (number | null)[]\n  | ((args: StylePropertyFunctionArg) => (number | null)[]);\n\nexport type MarkCellStyle = {\n  /** 标记背景色 默认蓝色*/\n  bgColor?: CanvasRenderingContext2D['fillStyle'];\n  /** 标记形状 默认'sector' */\n  shape?: 'rect' | 'triangle' | 'sector';\n  /** 标记位置 默认'right-top' */\n  position?: 'left-top' | 'left-bottom' | 'right-top' | 'right-bottom';\n  /** 标记大小 默认10 */\n  size?: number;\n  /** 标记偏移量 默认0 */\n  offset?: number;\n};\nexport type MarkedPropertyDefine =\n  | boolean\n  | MarkCellStyle\n  | ((args: StylePropertyFunctionArg) => boolean | MarkCellStyle);\n\nexport type CellStyle = {\n  textAlign: CanvasTextAlign;\n  padding: PaddingsDef;\n  textBaseline: CanvasTextBaseline;\n  color: CanvasRenderingContext2D['fillStyle'];\n  strokeColor?: CanvasRenderingContext2D['fillStyle'];\n  bgColor: CanvasRenderingContext2D['fillStyle'];\n  // font: string;\n  fontSize: number;\n  fontFamily: string;\n  fontWeight: string | number;\n  fontVariant: string;\n  fontStyle: string;\n  // lineHeight: string | number;\n  lineHeight: number;\n  autoWrapText: boolean;\n  lineClamp: LineClamp;\n  textOverflow: TextOverflow;\n  borderColor: ColorsDef;\n  borderLineWidth: LineWidthsDef;\n  borderLineDash: LineDashsDef;\n  underline: boolean;\n  // underlineColor: CanvasRenderingContext2D['strokeStyle'];\n  underlineWidth: number;\n  underlineDash: number[];\n  underlineOffset: number;\n  lineThrough: boolean;\n  // lineThroughColor: CanvasRenderingContext2D['strokeStyle'];\n  // lineThroughDash: number[];\n  lineThroughLineWidth: number;\n\n  _strokeArrayWidth: number[];\n  _strokeArrayColor: string[];\n  _linkColor: CanvasRenderingContext2D['fillStyle'];\n};\nexport type CustomSelectionStyle = {\n  cellBorderColor?: string; //边框颜色\n  cellBorderLineWidth?: number; //边框线宽度\n  cellBorderLineDash?: number[]; //边框线虚线\n  cellBgColor?: string; //选择框背景颜色\n};\n"]}

package/es/ts-types/table-engine.d.ts

@@ -60,7 +60,9 @@ export interface TableKeyboardOptions {
     moveFocusCellOnEnter?: boolean;
     moveEditCellOnArrowKeys?: boolean;
     selectAllOnCtrlA?: boolean | SelectAllOnCtrlAOption;
+    cutSelected?: boolean;
     copySelected?: boolean;
+    showCopyCellBorder?: boolean;
     pasteValueToCell?: boolean;
     moveSelectedCellOnArrowKeys?: boolean;
     ctrlMultiSelect?: boolean;
@@ -132,6 +134,7 @@ export interface IPagination {
 export type HeaderValues = Map<any, any>;
 export interface ListTableConstructorOptions extends BaseTableConstructorOptions {
     records?: any[];
+    addRecordRule?: 'Array' | 'Object';
     dataSource?: CachedDataSource | DataSource;
     showHeader?: boolean;
     columns?: ColumnsDefine;