Command

New-ChartToolTip

Module PSWriteHTML

Creates a new chart tooltip object with customizable options.

Syntax

New-ChartToolTip [[-MaxValue] <Object>] [[-MinValue] <Object>] [[-Names] <Array>] [[-TitleText] <String>] [[-Type] <datetime|category|numeric>] [[-XAxisFormatPattern] <String>] [[-YAxisFormatPattern] <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

This function defines a chart tooltip object with various options such as names, title text, type, min and max values, X and Y axis format patterns. It allows customization of the tooltip appearance and behavior.

Examples

Authored help example

EXAMPLE 1

New-ChartToolTip -Names @("Name1", "Name2") -TitleText "Tooltip Title" -Type 'datetime' -MinValue 0 -MaxValue 100 -XAxisFormatPattern "HH:mm:ss" -YAxisFormatPattern "function (seriesName) { return seriesName + ': ' + value; }"
Creates a new chart tooltip object with names "Name1" and "Name2", title "Tooltip Title", datetime type, min value of 0, max value of 100, X-axis format pattern "HH:mm:ss", and custom Y-axis format pattern.

EXAMPLE 2

New-ChartToolTip -Names @("Data1", "Data2", "Data3") -TitleText "Data Tooltip" -Type 'numeric' -MinValue 50 -MaxValue 200 -XAxisFormatPattern "MM/dd/yyyy" -YAxisFormatPattern "function (seriesName) { return seriesName + ': ' + value; }"
Creates a new chart tooltip object with names "Data1", "Data2", and "Data3", title "Data Tooltip", numeric type, min value of 50, max value of 200, X-axis format pattern "MM/dd/yyyy", and custom Y-axis format pattern.

Parameters

-MaxValue Object optionalposition: 4: Specifies the maximum value for the chart tooltip.
-MinValue Object optionalposition: 3: Specifies the minimum value for the chart tooltip.
-Names Array optionalposition: 0aliases: Name: Specifies an array of names for the chart tooltip.
-TitleText String optionalposition: 1aliases: Title: Specifies the title text for the chart tooltip.
-Type String optionalposition: 2: Specifies the type of the chart tooltip. Valid values are 'datetime', 'category', or 'numeric'.; Possible values: datetime, category, numeric
-XAxisFormatPattern String optionalposition: 5: Specifies the format pattern for the X-axis in the chart tooltip.
-YAxisFormatPattern String optionalposition: 6: Specifies the format pattern for the Y-axis in the chart tooltip. Default is "function (seriesName) { return ''; }".

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.