Interface WordCloudChartTooltipOptions

options specific to world cloud charts

interface WordCloudChartTooltipOptions {
    customHTML?: ((data: any, defaultHTML: string, datum: any) => string);
    enabled?: boolean;
    groupLabel?: string;
    showTotal?: boolean;
    totalLabel?: string;
    truncation?: TruncationOptions;
    valueFormatter?: ((value: any, label: string) => string);
    valueLabel?: string;
    wordLabel?: string;
}

Hierarchy (view full)

Properties

customHTML? enabled? groupLabel? showTotal? totalLabel? truncation? valueFormatter? valueLabel? wordLabel?

Properties

OptionalcustomHTML

customHTML?: ((data: any, defaultHTML: string, datum: any) => string)

custom function for returning tooltip HTML passed an array or object with the data, the default tooltip markup and the corresponding datum of the hovered element

Optionalenabled

enabled?: boolean

enable or disable tooltip

OptionalgroupLabel

groupLabel?: string

customizes the Group label shown inside tooltips

OptionalshowTotal

showTotal?: boolean

show total of items

OptionaltotalLabel

totalLabel?: string

customizes the Total label shown inside tooltips

Optionaltruncation

truncation?: TruncationOptions

OptionalvalueFormatter

valueFormatter?: ((value: any, label: string) => string)

a function to format the tooltip values

OptionalvalueLabel

valueLabel?: string

the label that shows up by the value of the highlighted word in the tooltip

OptionalwordLabel

wordLabel?: string

the label that shows up by the highlighted word in the tooltip

Settings

Member Visibility

On This Page

Properties