@carbon/charts
    Preparing search index...

    Interface WordCloudChartTooltipOptions

    options specific to world cloud charts

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    alwaysShowRulerTooltip?: boolean

    when true, always shows ruler tooltip instead of individual point tooltips

    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

    customTotalCalculation?: (data: any[]) => number

    custom function for calculating the total value receives all the data corresponding to the tooltip

    enabled?: boolean

    enable or disable tooltip

    groupLabel?: string

    customizes the Group label shown inside tooltips

    showTotal?: boolean

    show total of items

    totalLabel?: string

    customizes the Total label shown inside tooltips

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

    a function to format the tooltip values

    valueLabel?: string

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

    wordLabel?: string

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

    Settings

    Member Visibility

    On This Page

    Properties