@visactor/vtable 0.9.1 → 0.9.2-alpha.1

package/cjs/ts-types/table-engine.js.map

@@ -1 +1 @@
-{"version":3,"sources":["ts-types/table-engine.ts"],"names":[],"mappings":";;;AAiPA,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,8BAAiB,CAAA;IACjB,0BAAa,CAAA;IACb,4BAAe,CAAA;AACjB,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AAED,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,uCAAqB,CAAA;IACrB,+BAAa,CAAA;AACf,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB","file":"table-engine.js","sourcesContent":["import type { RectProps, MaybePromiseOrUndefined, IDimensionInfo, SortOrder } from './common';\nimport type { SvgIcon } from './icon';\nexport type { HeaderData } from './list-table/layout-map/api';\nexport type LayoutObjectId = number | string;\nimport type { Rect } from '../tools/Rect';\nimport type { BaseTableAPI, BaseTableConstructorOptions } from './base-table';\nimport type { IDataConfig } from './new-data-set';\nimport type { Either } from '../tools/helper';\nimport type { ICornerDefine, IDimension, IIndicator, ITitleDefine } from './pivot-table';\nimport type { ColumnsDefine } from './list-table';\n\nexport interface CellAddress {\n  col: number;\n  row: number;\n  rect?: RectProps;\n  x?: number;\n  y?: number;\n}\nexport interface CellRange {\n  start: CellAddress;\n  end: CellAddress;\n}\n\nexport type FieldGetter = (record: any) => any;\nexport type FieldSetter = (record: any, value: any) => void;\nexport interface FieldAssessor {\n  get: FieldGetter;\n  set: FieldSetter;\n}\n\nexport type FieldDef = string | number | string[];\nexport type FieldKeyDef = string | number;\nexport type FieldFormat = FieldGetter | FieldAssessor;\n\nexport type FieldData = MaybePromiseOrUndefined;\n\nexport type WidthModeDef = 'standard' | 'adaptive' | 'autoWidth' | 'standard-aeolus';\nexport type ShowColumnRowType = 'column' | 'row' | 'none';\nexport type CellType = 'body' | 'rowHeader' | 'columnHeader' | 'cornerHeader';\n\nexport interface TableKeyboardOptions {\n  // moveCellOnTab?: boolean;\n  // moveCellOnEnter?: boolean;\n  // deleteCellValueOnDel?: boolean;\n\n  /** 开启快捷键全选 默认：false */\n  selectAllOnCtrlA?: boolean;\n  /** 快捷键复制 */\n  copySelected?: boolean; //这个copy是和浏览器的快捷键一致的\n}\nexport interface DataSourceAPI {\n  clearCurrentIndexedData: () => void;\n  length: number;\n  get: (index: number) => MaybePromiseOrUndefined;\n  getField: <F extends FieldDef>(index: number, field: F) => FieldData;\n  hasField: (index: number, field: FieldDef) => boolean;\n  sort: (field: FieldDef, order: SortOrder, orderFn: (v1: any, v2: any, order: SortOrder) => -1 | 0 | 1) => void;\n  clearSortedMap: () => void;\n  updatePager: (pagerConf: IPagerConf) => void;\n  getIndexKey: (index: number) => number | number[];\n  /** 数据是否为树形结构 且可以展开收起 */\n  enableHierarchyState: boolean;\n}\n\nexport interface SortState {\n  /** 排序依据字段 */\n  field: FieldDef;\n\n  fieldKey?: FieldKeyDef;\n  /** 排序规则 */\n  order: SortOrder;\n}\nexport interface PivotSortState {\n  col: number;\n  row: number;\n  order: SortOrder;\n}\n\n/**\n * 分页配置\n */\nexport interface IPagerConf {\n  /** 数据总条数 */\n  totalCount?: number;\n  /** 每页显示数据条数  */\n  perPageCount: number;\n  /** 每页显示条数 */\n  currentPage?: number;\n}\nexport type HeaderValues = Map<any, any>;\nexport interface ListTableConstructorOptions extends BaseTableConstructorOptions {\n  /**\n   * 是否显示表头\n   */\n  showHeader?: boolean;\n  /**\n   * Simple header property\n   */\n  columns?: ColumnsDefine; //请不要再这个上面修改配置,这里相当于是一个原始值备份，有一个内部专用的protectspace.columns\n  /**\n   *@deprecated 已废弃 请使用columns\n   */\n  header?: ColumnsDefine;\n\n  transpose?: boolean; //是否转置\n  /**\n   * 展示为tree的列 层级缩进值\n   */\n  hierarchyIndent?: number;\n  /** 展开层数 默认为1只显示根节点*/\n  hierarchyExpandLevel?: number;\n\n  /** 分页配置 */\n  pagerConf?: IPagerConf;\n\n  /**\n   * 排序状态\n   */\n  sortState?: SortState | SortState[];\n}\n\nexport interface ListTableAPI extends BaseTableAPI {\n  options: ListTableConstructorOptions;\n  sortState: SortState[] | SortState | null;\n  // internalProps: ListTableProtected;\n  isListTable: () => true;\n  isPivotTable: () => false;\n}\nexport interface PivotTableConstructorOptions extends BaseTableConstructorOptions {\n  /**\n   * 调整列宽的生效范围：'column' | 'indicator' | 'all' | 'indicatorGroup'，单列|按指标|所有列|属于同一维度值的多个指标\n   */\n  columnResizeType?: 'column' | 'indicator' | 'all' | 'indicatorGroup';\n  /** 设置排序状态，只对应按钮展示效果 无数据排序逻辑 */\n  pivotSortState?: {\n    dimensions: IDimensionInfo[];\n    order: SortOrder;\n  }[];\n\n  //#region layout中挪到外层的属性\n  /**层级维度结构显示形式 */\n  rowHierarchyType?: 'grid' | 'tree';\n  /**展开层数 */\n  rowExpandLevel?: number;\n  /**子层级维度缩进距离 */\n  rowHierarchyIndent?: number;\n  /** 列表头维度结构 */\n  columnTree?: IHeaderTreeDefine[];\n  /** 行表头维度结构 */\n  rowTree?: IHeaderTreeDefine[];\n  /** 定义各个维度和各个指标的具体配置项和样式定义 rows 和 dimension 代替掉 */\n  // dimensions?: IDimension[];\n\n  /** 定义行上各个维度具体配置项和样式定义 */\n  rows?: (IDimension | string)[]; // (string | IDimension)[]; 后续支持数据分析的透视表 支持string配置\n  /** 定义列上各个维度具体配置项和样式定义 */\n  columns?: (IDimension | string)[]; // (string | IDimension)[];\n  /** 定义指标具体配置项和样式定义 包含表头和body的定义*/\n  indicators?: (IIndicator | string)[]; // (string | IIndicator)[];\n\n  /** 指标以列展示 ———有数据分析的透视表才需要配置这个 */\n  indicatorsAsCol?: boolean;\n  /** 指标在具体维度展示的层级顺序，从0开始 ———有数据分析的透视表才需要配置这个 */\n  indicatorIndex?: number;\n  /** 是否隐藏指标名称 */\n  hideIndicatorName?: boolean; //\n  /** 指标维度key 注意非具体指标key 数据分析的透视表才需要配置这个 */\n  // indicatorDimensionKey?: string;\n  /** 角头单元格配置项和样式定义 */\n  corner?: ICornerDefine;\n  /**\n   * boolean 是否显示列维度值表头\n   */\n  showColumnHeader?: boolean;\n  /**\n   * boolean 是否显示行维度值表头\n   */\n  showRowHeader?: boolean;\n  /**\n   * 列表头增加一行来显示维度名称 可以自定义或者显示dimensionTitle组合名\n   */\n  columnHeaderTitle?: ITitleDefine;\n  /**\n   * 行表头的增加一列来显示维度名称 可以自定义或者显示dimensionTitle组合名\n   */\n  rowHeaderTitle?: ITitleDefine;\n  //#endregion\n  /** 数据分析相关配置 ———有数据分析的透视表才需要配置这个 */\n  dataConfig?: IDataConfig;\n  /** 是否开始数据分析 ———有数据分析的透视表才需要配置这个 */\n  enableDataAnalysis?: boolean;\n  /** 指标标题 用于显示到角头的值*/\n  indicatorTitle?: string;\n}\n\nexport interface PivotTableAPI extends BaseTableAPI {\n  options: PivotTableConstructorOptions;\n  // internalProps: PivotTableProtected;\n  pivotSortState: PivotSortState[];\n  isListTable: () => false;\n  isPivotTable: () => true;\n  getPivotSortState: (col: number, row: number) => SortOrder;\n  toggleHierarchyState: (col: number, row: number) => void;\n}\n\nexport type SetPasteValueTestData = CellAddress & {\n  table: BaseTableAPI;\n  record: any;\n  value: string;\n\n  oldValue: any;\n};\n\nexport interface InlineAPI {\n  width: (arg: { ctx: CanvasRenderingContext2D }) => number;\n  font: () => string | null;\n  color: () => string | null;\n  canDraw: () => boolean;\n  onReady: (callback: Function) => void;\n\n  draw: (opt: any) => void;\n  canBreak: () => boolean;\n}\n\nexport interface CellContext {\n  readonly col: number;\n  readonly row: number;\n  /**format之后的值 */\n  readonly value: FieldData;\n  /**原始值 */\n  readonly dataValue: FieldData;\n  showIcon?: SvgIcon;\n  getContext: () => CanvasRenderingContext2D;\n  toCurrentContext: () => CellContext;\n  getDrawRect: () => RectProps | null;\n  getRect: () => RectProps;\n  setRectFilter: (rectFilter: (base: RectProps) => RectProps) => void;\n  updateRect: (rect: Rect | RectProps) => void;\n  updateDrawRect: (rect: Rect | RectProps) => void;\n}\n\nexport enum Placement {\n  top = 'top',\n  bottom = 'bottom',\n  left = 'left',\n  right = 'right'\n}\n\nexport enum HierarchyState {\n  expand = 'expand',\n  collapse = 'collapse',\n  none = 'none'\n}\nexport type IHeaderTreeDefine = Either<IDimensionHeaderNode, IIndicatorHeaderNode>;\nexport interface IIndicatorHeaderNode {\n  /**\n   * 指标的key值 对应数据集的字段名\n   */\n  indicatorKey: string | number;\n  /**\n   * 指标名称 如：“销售额”，“例如”， 对应到单元格显示的值。可不填，不填的话 从indicators的对应配置中取值显示\n   */\n  value?: string;\n}\nexport interface IDimensionHeaderNode {\n  /**\n   * 维度的唯一标识，对应数据集的字段名称\n   */\n  dimensionKey: string | number;\n  /** 维度成员值 */\n  value: string;\n  /** 维度成员下的子维度树结构 */\n  children?: IHeaderTreeDefine[] | null;\n  /** 折叠状态 TODO */\n  hierarchyState?: HierarchyState;\n}\n"]}
+{"version":3,"sources":["ts-types/table-engine.ts"],"names":[],"mappings":";;;AAqSA,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,8BAAiB,CAAA;IACjB,0BAAa,CAAA;IACb,4BAAe,CAAA;AACjB,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AAED,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,uCAAqB,CAAA;IACrB,+BAAa,CAAA;AACf,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB","file":"table-engine.js","sourcesContent":["import type { RectProps, MaybePromiseOrUndefined, IDimensionInfo, SortOrder } from './common';\nimport type { SvgIcon } from './icon';\nexport type { HeaderData } from './list-table/layout-map/api';\nexport type LayoutObjectId = number | string;\nimport type { Rect } from '../tools/Rect';\nimport type { BaseTableAPI, BaseTableConstructorOptions } from './base-table';\nimport type { IDataConfig } from './new-data-set';\nimport type { Either } from '../tools/helper';\nimport type { IChartIndicator, ICornerDefine, IDimension, IIndicator, ITitleDefine } from './pivot-table';\nimport type { ColumnsDefine } from './list-table';\nimport type { ICellAxisOption, ITableAxisOption } from './component/axis';\n\nexport interface CellAddress {\n  col: number;\n  row: number;\n  rect?: RectProps;\n  x?: number;\n  y?: number;\n}\nexport interface CellRange {\n  start: CellAddress;\n  end: CellAddress;\n}\n\nexport type FieldGetter = (record: any) => any;\nexport type FieldSetter = (record: any, value: any) => void;\nexport interface FieldAssessor {\n  get: FieldGetter;\n  set: FieldSetter;\n}\n\nexport type FieldDef = string | number | string[];\nexport type FieldKeyDef = string | number;\nexport type FieldFormat = FieldGetter | FieldAssessor;\n\nexport type FieldData = MaybePromiseOrUndefined;\n\nexport type WidthModeDef = 'standard' | 'adaptive' | 'autoWidth';\nexport type HeightModeDef = 'standard' | 'adaptive' | 'autoHeight';\nexport type ShowColumnRowType = 'column' | 'row' | 'none';\nexport type CellType = 'body' | 'rowHeader' | 'columnHeader' | 'cornerHeader' | 'bottomFrozen' | 'rightFrozen';\n\nexport interface TableKeyboardOptions {\n  // moveCellOnTab?: boolean;\n  // moveCellOnEnter?: boolean;\n  // deleteCellValueOnDel?: boolean;\n\n  /** 开启快捷键全选 默认：false */\n  selectAllOnCtrlA?: boolean;\n  /** 快捷键复制 */\n  copySelected?: boolean; //这个copy是和浏览器的快捷键一致的\n}\nexport interface DataSourceAPI {\n  clearCurrentIndexedData: () => void;\n  length: number;\n  get: (index: number) => MaybePromiseOrUndefined;\n  getField: <F extends FieldDef>(index: number, field: F) => FieldData;\n  hasField: (index: number, field: FieldDef) => boolean;\n  sort: (field: FieldDef, order: SortOrder, orderFn: (v1: any, v2: any, order: SortOrder) => -1 | 0 | 1) => void;\n  clearSortedMap: () => void;\n  updatePager: (pagerConf: IPagerConf) => void;\n  getIndexKey: (index: number) => number | number[];\n  /** 数据是否为树形结构 且可以展开收起 */\n  enableHierarchyState: boolean;\n}\n\nexport interface SortState {\n  /** 排序依据字段 */\n  field: FieldDef;\n\n  fieldKey?: FieldKeyDef;\n  /** 排序规则 */\n  order: SortOrder;\n}\nexport interface PivotSortState {\n  col: number;\n  row: number;\n  order: SortOrder;\n}\n\n/**\n * 分页配置\n */\nexport interface IPagerConf {\n  /** 数据总条数 */\n  totalCount?: number;\n  /** 每页显示数据条数  */\n  perPageCount: number;\n  /** 每页显示条数 */\n  currentPage?: number;\n}\nexport type HeaderValues = Map<any, any>;\nexport interface ListTableConstructorOptions extends BaseTableConstructorOptions {\n  /**\n   * 是否显示表头\n   */\n  showHeader?: boolean;\n  /**\n   * Simple header property\n   */\n  columns?: ColumnsDefine; //请不要再这个上面修改配置,这里相当于是一个原始值备份，有一个内部专用的protectspace.columns\n  /**\n   *@deprecated 已废弃 请使用columns\n   */\n  header?: ColumnsDefine;\n\n  transpose?: boolean; //是否转置\n  /**\n   * 展示为tree的列 层级缩进值\n   */\n  hierarchyIndent?: number;\n  /** 展开层数 默认为1只显示根节点*/\n  hierarchyExpandLevel?: number;\n\n  /** 分页配置 */\n  pagerConf?: IPagerConf;\n\n  /**\n   * 排序状态\n   */\n  sortState?: SortState | SortState[];\n}\n\nexport interface ListTableAPI extends BaseTableAPI {\n  options: ListTableConstructorOptions;\n  sortState: SortState[] | SortState | null;\n  // internalProps: ListTableProtected;\n  isListTable: () => true;\n  isPivotTable: () => false;\n}\nexport interface PivotTableConstructorOptions extends BaseTableConstructorOptions {\n  /**\n   * 调整列宽的生效范围：'column' | 'indicator' | 'all' | 'indicatorGroup'，单列|按指标|所有列|属于同一维度值的多个指标\n   */\n  columnResizeType?: 'column' | 'indicator' | 'all' | 'indicatorGroup';\n  /** 设置排序状态，只对应按钮展示效果 无数据排序逻辑 */\n  pivotSortState?: {\n    dimensions: IDimensionInfo[];\n    order: SortOrder;\n  }[];\n\n  //#region layout中挪到外层的属性\n  /**层级维度结构显示形式 */\n  rowHierarchyType?: 'grid' | 'tree';\n  /**展开层数 */\n  rowExpandLevel?: number;\n  /**子层级维度缩进距离 */\n  rowHierarchyIndent?: number;\n  /** 列表头维度结构 */\n  columnTree?: IHeaderTreeDefine[];\n  /** 行表头维度结构 */\n  rowTree?: IHeaderTreeDefine[];\n  /** 定义各个维度和各个指标的具体配置项和样式定义 rows 和 dimension 代替掉 */\n  // dimensions?: IDimension[];\n\n  /** 定义行上各个维度具体配置项和样式定义 */\n  rows?: (IDimension | string)[]; // (string | IDimension)[]; 后续支持数据分析的透视表 支持string配置\n  /** 定义列上各个维度具体配置项和样式定义 */\n  columns?: (IDimension | string)[]; // (string | IDimension)[];\n  /** 定义指标具体配置项和样式定义 包含表头和body的定义*/\n  indicators?: (IIndicator | string)[]; // (string | IIndicator)[];\n\n  /** 指标以列展示 ———有数据分析的透视表才需要配置这个 */\n  indicatorsAsCol?: boolean;\n  /** 指标在具体维度展示的层级顺序，从0开始 ———有数据分析的透视表才需要配置这个 */\n  indicatorIndex?: number;\n  /** 是否隐藏指标名称 */\n  hideIndicatorName?: boolean; //\n  /** 指标维度key 注意非具体指标key 数据分析的透视表才需要配置这个 */\n  // indicatorDimensionKey?: string;\n  /** 角头单元格配置项和样式定义 */\n  corner?: ICornerDefine;\n  /**\n   * boolean 是否显示列维度值表头\n   */\n  showColumnHeader?: boolean;\n  /**\n   * boolean 是否显示行维度值表头\n   */\n  showRowHeader?: boolean;\n  /**\n   * 列表头增加一行来显示维度名称 可以自定义或者显示dimensionTitle组合名\n   */\n  columnHeaderTitle?: ITitleDefine;\n  /**\n   * 行表头的增加一列来显示维度名称 可以自定义或者显示dimensionTitle组合名\n   */\n  rowHeaderTitle?: ITitleDefine;\n  //#endregion\n  /** 数据分析相关配置 ———有数据分析的透视表才需要配置这个 */\n  dataConfig?: IDataConfig;\n  /** 是否开始数据分析 ———有数据分析的透视表才需要配置这个 */\n  enableDataAnalysis?: boolean;\n  /** 指标标题 用于显示到角头的值*/\n  indicatorTitle?: string;\n}\nexport interface PivotChartConstructorOptions extends BaseTableConstructorOptions {\n  /**\n   * 调整列宽的生效范围：'column' | 'indicator' | 'all' | 'indicatorGroup'，单列|按指标|所有列|属于同一维度值的多个指标\n   */\n  columnResizeType?: 'column' | 'indicator' | 'all' | 'indicatorGroup';\n  /** 列表头维度结构 */\n  columnTree?: IHeaderTreeDefine[];\n  /** 行表头维度结构 */\n  rowTree?: IHeaderTreeDefine[];\n  /** 定义各个维度和各个指标的具体配置项和样式定义 rows 和 dimension 代替掉 */\n  // dimensions?: IDimension[];\n\n  /** 定义行上各个维度具体配置项和样式定义 */\n  rows?: (IDimension | string)[]; // (string | IDimension)[]; 后续支持数据分析的透视表 支持string配置\n  /** 定义列上各个维度具体配置项和样式定义 */\n  columns?: (IDimension | string)[]; // (string | IDimension)[];\n  /** 定义指标具体配置项和样式定义 包含表头和body的定义*/\n  indicators?: (IChartIndicator | string)[]; // (string | IIndicator)[];\n\n  /** 指标以列展示 ———有数据分析的透视表才需要配置这个 */\n  indicatorsAsCol?: boolean;\n  /** 是否隐藏指标名称 */\n  hideIndicatorName?: boolean; //\n  /** 角头单元格配置项和样式定义 */\n  corner?: ICornerDefine;\n  /**\n   * boolean 是否显示列维度值表头\n   */\n  showColumnHeader?: boolean;\n  /**\n   * boolean 是否显示行维度值表头\n   */\n  showRowHeader?: boolean;\n  /**\n   * 列表头增加一行来显示维度名称 可以自定义或者显示dimensionTitle组合名\n   */\n  columnHeaderTitle?: ITitleDefine;\n  /**\n   * 行表头的增加一列来显示维度名称 可以自定义或者显示dimensionTitle组合名\n   */\n  rowHeaderTitle?: ITitleDefine;\n  /** 指标标题 用于显示到角头的值*/\n  indicatorTitle?: string;\n\n  axes: ITableAxisOption[];\n}\nexport interface PivotTableAPI extends BaseTableAPI {\n  options: PivotTableConstructorOptions;\n  // internalProps: PivotTableProtected;\n  pivotSortState: PivotSortState[];\n  isListTable: () => false;\n  isPivotTable: () => true;\n  getPivotSortState: (col: number, row: number) => SortOrder;\n  toggleHierarchyState: (col: number, row: number) => void;\n}\nexport interface PivotChartAPI extends BaseTableAPI {\n  options: PivotTableConstructorOptions;\n  // internalProps: PivotTableProtected;\n  isListTable: () => false;\n  isPivotTable: () => true;\n}\nexport type SetPasteValueTestData = CellAddress & {\n  table: BaseTableAPI;\n  record: any;\n  value: string;\n\n  oldValue: any;\n};\n\nexport interface InlineAPI {\n  width: (arg: { ctx: CanvasRenderingContext2D }) => number;\n  font: () => string | null;\n  color: () => string | null;\n  canDraw: () => boolean;\n  onReady: (callback: Function) => void;\n\n  draw: (opt: any) => void;\n  canBreak: () => boolean;\n}\n\nexport interface CellContext {\n  readonly col: number;\n  readonly row: number;\n  /**format之后的值 */\n  readonly value: FieldData;\n  /**原始值 */\n  readonly dataValue: FieldData;\n  showIcon?: SvgIcon;\n  getContext: () => CanvasRenderingContext2D;\n  toCurrentContext: () => CellContext;\n  getDrawRect: () => RectProps | null;\n  getRect: () => RectProps;\n  setRectFilter: (rectFilter: (base: RectProps) => RectProps) => void;\n  updateRect: (rect: Rect | RectProps) => void;\n  updateDrawRect: (rect: Rect | RectProps) => void;\n}\n\nexport enum Placement {\n  top = 'top',\n  bottom = 'bottom',\n  left = 'left',\n  right = 'right'\n}\n\nexport enum HierarchyState {\n  expand = 'expand',\n  collapse = 'collapse',\n  none = 'none'\n}\nexport type IHeaderTreeDefine = Either<IDimensionHeaderNode, IIndicatorHeaderNode>;\nexport interface IIndicatorHeaderNode {\n  /**\n   * 指标的key值 对应数据集的字段名\n   */\n  indicatorKey: string | number;\n  /**\n   * 指标名称 如：“销售额”，“例如”， 对应到单元格显示的值。可不填，不填的话 从indicators的对应配置中取值显示\n   */\n  value?: string;\n}\nexport interface IDimensionHeaderNode {\n  /**\n   * 维度的唯一标识，对应数据集的字段名称\n   */\n  dimensionKey: string | number;\n  /** 维度成员值 */\n  value: string;\n  /** 维度成员下的子维度树结构 */\n  children?: IHeaderTreeDefine[] | null;\n  /** 折叠状态 TODO */\n  hierarchyState?: HierarchyState;\n}\n"]}