MultiGridTooltip
名稱:MultiGrid Legend(多組資料中的圖例)
說明:MultiGrid 資料類別使用的圖例,使用上和 Grid 資料類別中的
GridLegend
相似,同樣會對應rowLabels
,但差別在 MultiGrid 資料類別dataFormatter$
中的rowLabels
在gridList
欄位底下(會有多組)。
params$
型別:
Partial<MultiGridTooltipParams>
欄位:
名稱 說明 型別 backgroundColorType 底色顏色類別 ColorType
backgroundOpacity 底色透明度 number
strokeColorType 外框顏色類別 ColorType
textColorType 文字顏色類別 ColorType
offset 滑鼠游標相對位置 (x, y) [number, number]
padding 內部間距 number
renderFn 渲染函式,函式可回傳三種格式:
(1) 純文字字串 (string
)
(2) 以陣列字串顯示多行純文字 (string[]
)
(3) SVG標籤內容字串 (string
)(eventData: EventMultiGrid, context: { styles: BaseTooltipStyle; utils: BaseTooltipUtils }) => string[] | string
詳細型別
type ColorType = 'none' | 'label' | 'labelContrast' | 'primary' | 'secondary' | 'background'
interface BaseTooltipStyle {
backgroundColor: string
backgroundOpacity: number
strokeColor: string
offset: [number, number]
padding: number
textColor: string
textSize: number | string // chartParams上的設定
textSizePx: number
seriesColors: string[]
}
interface BaseTooltipUtils {
measureTextWidth (text: string, size?: number): number
}
- 預設值:
{
backgroundColorType: 'background',
strokeColorType: 'primary',
backgroundOpacity: 0.8,
textColorType: 'primary',
offset: [20, 5],
padding: 10,
renderFn: (eventData, { styles, utils }) => {
const bulletWidth = styles.textSizePx * 0.7
const offset = (styles.textSizePx / 2) - (bulletWidth / 2)
const titleSvg = `<g><text dominant-baseline="hanging" font-size="${styles.textSizePx}" fill="${styles.textColor}">${eventData.groupLabel}</text></g>`
const groupLabelTextWidth = utils.measureTextWidth(eventData.groupLabel, styles.textSizePx)
const listTextWidth = eventData.group.reduce((acc, group) => {
const text = `${group.seriesLabel}${utils.toCurrency(group.value)}`
const _maxTextWidth = utils.measureTextWidth(text, styles.textSizePx)
return _maxTextWidth > acc ? _maxTextWidth : acc
}, 0)
const maxTextWidth = Math.max(groupLabelTextWidth, listTextWidth)
const lineEndX = maxTextWidth + styles.textSizePx * 3
const contentSvg = eventData.group
.map((group, i) => {
const y = i * styles.textSizePx * 1.5
const isHighlight = group.id === (eventData.datum && eventData.datum.id)
return `<g transform="translate(0, ${styles.textSizePx * 2})">
<rect width="${bulletWidth}" height="${bulletWidth}" x="${offset}" y="${y + offset}" rx="${bulletWidth / 2}" fill="${group.color}"></rect>
<text x="${styles.textSizePx * 1.5}" y="${y}" font-size="${styles.textSizePx}" dominant-baseline="hanging" fill="${styles.textColor}">
<tspan font-weight="${isHighlight ? 'bold' : ''}">${group.seriesLabel}</tspan>
<tspan font-weight="bold" text-anchor="end" x="${lineEndX}">${utils.toCurrency(group.value)}</tspan>
</text>
</g>`
})
.join('')
return `${titleSvg}
${contentSvg}`
}
}