@antv/s2
Version:
effective spreadsheet render core lib
76 lines (75 loc) • 4.12 kB
TypeScript
/**
* 获取tooltip中需要显示的数据项
*/
import type { FederatedPointerEvent as CanvasEvent } from '@antv/g';
import type * as CSS from 'csstype';
import { CellType } from '../common/constant';
import type { AutoAdjustPositionOptions, Tooltip, TooltipDetailListItem, ViewMeta, ViewMetaData } from '../common/interface';
import type { S2CellType } from '../common/interface/interaction';
import type { BaseTooltipOperatorMenuOptions, SummaryParam, TooltipData, TooltipDataParam, TooltipHeadInfo, TooltipOperation, TooltipOperatorMenuItems, TooltipOperatorOptions, TooltipOptions, TooltipPosition, TooltipSummaryOptions } from '../common/interface/tooltip';
import type { SpreadSheet } from '../sheet-type';
/**
* calculate tooltip show position
*/
export declare const getAutoAdjustPosition: ({ spreadsheet, position, tooltipContainer, autoAdjustBoundary, }: AutoAdjustPositionOptions) => TooltipPosition;
export declare const getTooltipDefaultOptions: <Menu = BaseTooltipOperatorMenuOptions>(options?: TooltipOptions<Menu>) => {
hideSummary?: boolean | undefined;
operator: TooltipOperatorOptions<Menu> | {
menu: {
onClick: (...args: any[]) => void;
items: never[];
selectedKeys: never[];
};
};
isTotals?: boolean | undefined;
onlyShowCellText?: boolean | undefined;
onlyShowOperator?: boolean | undefined;
enableFormat: boolean;
forceRender?: boolean | undefined;
data?: TooltipData | undefined;
};
export declare const getMergedQuery: (meta: ViewMeta | null | undefined) => {
[x: string]: any;
};
export declare const setTooltipContainerStyle: (container: HTMLElement, options: {
visible?: boolean;
style?: CSS.Properties;
className?: string[];
dark?: boolean;
}) => void;
export declare const getListItem: (spreadsheet: SpreadSheet, { data, field, valueField, useCompleteDataForFormatter, targetCell, }: {
data: ViewMetaData;
field: string;
valueField?: string;
useCompleteDataForFormatter?: boolean;
targetCell?: S2CellType;
}) => TooltipDetailListItem;
export declare const getFieldList: (spreadsheet: SpreadSheet, fields: string[], activeData: ViewMetaData) => TooltipDetailListItem[];
/**
* 获取选中格行/列头信息
* @param spreadsheet
* @param activeData
*/
export declare const getHeadInfo: (spreadsheet: SpreadSheet, activeData: ViewMetaData, options?: TooltipOptions) => TooltipHeadInfo;
/**
* 获取数据明细
* @param spreadsheet
* @param activeData
* @param options
*/
export declare const getTooltipDetailList: (spreadsheet: SpreadSheet, activeData: ViewMetaData, options: TooltipOptions, targetCell: S2CellType) => TooltipDetailListItem[];
export declare const getSummaryName: (spreadsheet: SpreadSheet, currentField: string, isTotals?: boolean) => string;
export declare const getSelectedCellIndexes: (spreadsheet: SpreadSheet) => number[][];
export declare const getSelectedCellsData: (spreadsheet: SpreadSheet, targetCell: S2CellType, onlyShowCellText?: boolean) => ViewMetaData[];
export declare const getCustomFieldsSummaries: (summaries: TooltipSummaryOptions[]) => TooltipSummaryOptions[];
export declare const getSummaries: (params: SummaryParam) => TooltipSummaryOptions[];
export declare const getTooltipData: (params: TooltipDataParam) => TooltipData;
export declare const mergeCellInfo: (cells: S2CellType[]) => TooltipData[];
export declare const getCellsTooltipData: (spreadsheet: SpreadSheet) => TooltipData[];
export declare const getTooltipOptionsByCellType: (cellTooltipConfig: Tooltip<import("../common/interface").TooltipContentType, BaseTooltipOperatorMenuOptions> | undefined, cellType: CellType) => Tooltip;
export declare const getTooltipOptions: (spreadsheet: SpreadSheet, event: CanvasEvent | MouseEvent | Event) => Tooltip | null;
export declare const getTooltipVisibleOperator: (operation: TooltipOperation, options: {
defaultMenus?: TooltipOperatorMenuItems;
cell: S2CellType;
}) => TooltipOperatorOptions;
export declare const verifyTheElementInTooltip: (parent: HTMLElement | null, child: Node) => boolean;