S2

Function description: Tooltip class. details

s2.tooltip.show({
  position: {
    x: 0,
    y: 0,
  },
  content: 'xxx'
})

parameter	illustrate	type
`spreadsheet`	Form example	() => SpreadSheet
`container`	tooltip mount container	HTMLElement
`options`	tooltip configuration	TooltipShowOptions
`position`	coordinate	`{ x: number, y: number }`
`visible`	Display state	`boolean`
`show`	show tooltip	(showOptions: TooltipShowOptions ) => void
`hide`	hide tooltip	`() => void`
`destroy`	Destroy the tooltip, and remove the mounted container	`() => void`
`clearContent`	Empty tooltip content	`() => void`
`disablePointerEvent`	Disable tooltip mouse response	`() => void`

TooltipShowOptions

object is required , default: null Function description: tooltip display configuration

parameter	type	required	Functional description
position	TooltipPosition	✓	tooltip display location
data	TooltipData		tooltip data
cellInfos	`Record<string, any>`		cell information
options	TooltipOptions		Tooltip part configuration
content	`ReactNode \| string` \| or `(cell, defaultTooltipShowOptions: TooltipShowOptions) => ReactNode \| string`		Customize tooltip content
event	`Event`		Current event Event

object is required , default: null Function description: tooltip coordinates

parameter	type	required	Defaults	Functional description
x	`number`	✓		Abscissa
the y	`number`	✓		Y-axis

object optional , default: null function description: tooltip data

parameter	type	Functional description
summaries	TooltipSummaryOptions	List of selected item statistics (differentiated by measure value)
details	ListItem	Data Point Details
headInfo	TooltipHeadInfo	list of axes (row/column headers)
name	`string`	current cell name
tips	`string`	Tips/Instructions
infos	`string`	Prompt information at the bottom (can be used for shortcut key operation prompts)

object is optional , default: null Function description: tooltip List of selected item statistics (differentiated by measurement value)

parameter	type	required	Functional description
name	`string`	✓	name
value	`number \| string`	✓	value
selectedData	`Record<string, any>`	✓	currently selected data list

object optional , default: null function description: tooltip axis (row/column header) list

parameter	type	required	Defaults	Functional description
rows	ListItem	✓		List of outfits
cols	ListItem	✓		header list

object optional , default: null function description: tooltip data point detail data

parameter	type	required	Functional description
name	`string`	✓	name
value	`string \| number`	✓	value
icon	`ReactNode`		custom icon component

object is required , default: null Function description: tooltip partial configuration

parameter	type	Defaults	Functional description
hideSummary	`boolean`	`false`	Whether to hide selected item statistics
operator	TooltipOperatorOptions		Action Bar Configuration
onlyShowOperator	`boolean`	`false`	Whether tooltip only shows action menu items
isTotals	`boolean`	`false`	Is it a total/subtotal cell
onlyShowCellText	`boolean`	`false`	Whether to display cell prompt information
enableFormat	`boolean`	`false`	Whether to enable formatting
forceRender	`boolean`	`false`	Whether to force the dom to be cleared

object optional , default: null Function description: tooltip operation bar configuration

parameter	type	Functional description
menus	TooltipOperatorMenu[]	action item list
onClick	`({ item, key, keyPath, domEvent }) => void`	Click event, transparently transmit onClick of `antd` `Menu` component
selectedKeys	`string[]`	Initially selected menu item key array, transparently transmit the selectedKeys of the `antd` `Menu` component

object is required , default: null Function description: tooltip list of operation items

parameter	type	required	Defaults	Functional description
key	`string`	✓		Uniquely identifies
text	`ReactNode \| string`			name
icon	`ReactNode \| string`			custom icon
visible	`boolean \| (cell) => boolean`		`true`	Whether the operation item is displayed, you can pass in a function to dynamically display it according to the current cell information
onClick	( `cell` : S2CellType : ) => void			Click event callback (cell is the cell corresponding to the current tooltip)
children	TooltipOperatorMenu			submenu list