ChartTooltipSettingsBuilder
Methods
AutoHide(System.Boolean)
Specifies if the tooltip will be hidden when the mouse leaves the target element. If set to false, a Close button will be shown within tooltip.
Parameters
value - System.Boolean
The value for AutoHide
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
Background(System.String)
The background color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
Parameters
value - System.String
The value for Background
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
Border(System.Action)
The border configuration options.
Parameters
configurator - System.Action<ChartTooltipBorderSettingsBuilder>
The configurator for the border setting.
RETURNS
Returns the current instance of ChartTooltipSettingsBuilder .
Color(System.String)
The text color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
Parameters
value - System.String
The value for Color
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
Font(System.String)
The tooltip font.
Parameters
value - System.String
The value for Font
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
Format(System.String)
The format of the labels. Uses kendo.format.Format placeholders: Area, bar, column, funnel, pyramid, line and pie{0} - value; Bubble{0} - x value{1} - y value{2} - size value{3} - category name; Bullet{0} - value{1} - target value; Scatter and scatterLine{0} - x value{1} - y value; Candlestick and OHLC{0} - open value{1} - high value{2} - low value{3} - close value{4} - category name or RangeArea, rangeBar, rangeColumn{0} - from value{1} - to value.
Parameters
value - System.String
The value for Format
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
Opacity(System.Double)
The opacity of the tooltip.
Parameters
value - System.Double
The value for Opacity
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
Padding(System.Action)
The padding of the tooltip. A numeric value will set all paddings.
Parameters
configurator - System.Action<ChartTooltipPaddingSettingsBuilder>
The configurator for the padding setting.
RETURNS
Returns the current instance of ChartTooltipSettingsBuilder .
Shared(System.Boolean)
If set to true the chart will display a single tooltip for every category.
Parameters
value - System.Boolean
The value for Shared
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
Shared()
If set to true the chart will display a single tooltip for every category.
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
SharedTemplate(System.String)
The template which renders the shared tooltip.The fields which can be used in the template are: points - the category points or category - the category name.
Parameters
value - System.String
The value for SharedTemplate
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
SharedTemplateId(System.String)
The template which renders the shared tooltip.The fields which can be used in the template are: points - the category points or category - the category name.
Parameters
templateId - System.String
The ID of the template element for SharedTemplate
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
SharedTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template which renders the shared tooltip.The fields which can be used in the template are: points - the category points or category - the category name.
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for SharedTemplate
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
SharedTemplateHandler(System.String)
The template which renders the shared tooltip.The fields which can be used in the template are: points - the category points or category - the category name.
Parameters
templateHandler - System.String
The handler that returs the template for SharedTemplate
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
SharedTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template which renders the shared tooltip.The fields which can be used in the template are: points - the category points or category - the category name.
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the sharedtemplate.
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
Template(System.String)
The template which renders the tooltip.The fields which can be used in the template are: category - the category name; dataItem - the original data item used to construct the point. Will be null if binding to array.; series - the data series; value - the point value (either a number or an object); runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..
Parameters
value - System.String
The value for Template
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
TemplateId(System.String)
The template which renders the tooltip.The fields which can be used in the template are: category - the category name; dataItem - the original data item used to construct the point. Will be null if binding to array.; series - the data series; value - the point value (either a number or an object); runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..
Parameters
templateId - System.String
The ID of the template element for Template
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
TemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
The template which renders the tooltip.The fields which can be used in the template are: category - the category name; dataItem - the original data item used to construct the point. Will be null if binding to array.; series - the data series; value - the point value (either a number or an object); runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..
Parameters
templateView - Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for Template
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
TemplateHandler(System.String)
The template which renders the tooltip.The fields which can be used in the template are: category - the category name; dataItem - the original data item used to construct the point. Will be null if binding to array.; series - the data series; value - the point value (either a number or an object); runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..
Parameters
templateHandler - System.String
The handler that returs the template for Template
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
Template(Kendo.Mvc.UI.Fluent.TemplateBuilder)
The template which renders the tooltip.The fields which can be used in the template are: category - the category name; dataItem - the original data item used to construct the point. Will be null if binding to array.; series - the data series; value - the point value (either a number or an object); runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..
Parameters
template - TemplateBuilder<TModel>
A Template component that configures the template.
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
Visible(System.Boolean)
If set to true the chart will display the series tooltip. By default the series tooltip is not displayed.
Parameters
value - System.Boolean
The value for Visible
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.
Visible()
If set to true the chart will display the series tooltip. By default the series tooltip is not displayed.
RETURNS
Returns the current ChartTooltipSettingsBuilder instance.