Class IgbDataToolTipLayer

Represents an annotation layer that displays grouped tooltips with summaries for series. THIS IS A COMMUNITY TECHNOLOGY PREVIEW, not for use in production.

Inheritance
System.Object
BaseRendererElement
IgbSeries
IgbAnnotationLayer
IgbDataToolTipLayer
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbDataToolTipLayer : IgbAnnotationLayer, JsonSerializable, IDisposable

Constructors

IgbDataToolTipLayer()

Declaration
public IgbDataToolTipLayer()

Properties

ActualGroupedPositionModeX

Gets the actual resolved tooltip position mode on the X axis for grouped series.

Declaration
public DataTooltipGroupedPositionX ActualGroupedPositionModeX { get; set; }
Property Value
Type Description
DataTooltipGroupedPositionX

ActualGroupedPositionModeY

Gets the actual resolved tooltip position mode on the Y axis for grouped series.

Declaration
public DataTooltipGroupedPositionY ActualGroupedPositionModeY { get; set; }
Property Value
Type Description
DataTooltipGroupedPositionY

ActualGroupingMode

Gets the actual resolved tooltip layer grouping mode.

Declaration
public DataToolTipLayerGroupingMode ActualGroupingMode { get; set; }
Property Value
Type Description
DataToolTipLayerGroupingMode

BadgeMarginBottom

Declaration
public double BadgeMarginBottom { get; set; }
Property Value
Type Description
System.Double

BadgeMarginLeft

Declaration
public double BadgeMarginLeft { get; set; }
Property Value
Type Description
System.Double

BadgeMarginRight

Declaration
public double BadgeMarginRight { get; set; }
Property Value
Type Description
System.Double

BadgeMarginTop

Declaration
public double BadgeMarginTop { get; set; }
Property Value
Type Description
System.Double

BadgeShape

Gets or sets the BadgeShape for the data legend.

Declaration
public LegendItemBadgeShape BadgeShape { get; set; }
Property Value
Type Description
LegendItemBadgeShape

DefaultPositionOffsetX

Gets or sets the default offset of the tooltip layer on the X axis.

Declaration
public double DefaultPositionOffsetX { get; set; }
Property Value
Type Description
System.Double

DefaultPositionOffsetY

Gets or sets the default offset of the tooltip layer on the Y axis.

Declaration
public double DefaultPositionOffsetY { get; set; }
Property Value
Type Description
System.Double

ExcludedColumns

Gets or sets names of data columns or their labels to exclude from displaying in the data legend, e.g. "High, Low" or "H, L"

Declaration
public string[] ExcludedColumns { get; set; }
Property Value
Type Description
System.String[]
Remarks

The ExcludedColumns property takes precedences over values of IncludedColumns property

ExcludedSeries

Gets or sets indexes or names of series to exclude from displaying in the data legend, e.g. "0, 1"

Declaration
public string[] ExcludedSeries { get; set; }
Property Value
Type Description
System.String[]
Remarks

The ExcludedSeries property takes precedences over values of IncludedSeries property

GroupedPositionModeX

Gets or sets the tooltip position mode on the X axis for grouped series.

Declaration
public DataTooltipGroupedPositionX GroupedPositionModeX { get; set; }
Property Value
Type Description
DataTooltipGroupedPositionX

GroupedPositionModeY

Gets or sets the tooltip position mode on the Y axis for grouped series.

Declaration
public DataTooltipGroupedPositionY GroupedPositionModeY { get; set; }
Property Value
Type Description
DataTooltipGroupedPositionY

GroupingMode

Gets or sets the grouping mode to apply to use for the tooltip layer.

Declaration
public DataToolTipLayerGroupingMode GroupingMode { get; set; }
Property Value
Type Description
DataToolTipLayerGroupingMode

GroupRowMarginBottom

Declaration
public double GroupRowMarginBottom { get; set; }
Property Value
Type Description
System.Double

GroupRowMarginLeft

Declaration
public double GroupRowMarginLeft { get; set; }
Property Value
Type Description
System.Double

GroupRowMarginRight

Declaration
public double GroupRowMarginRight { get; set; }
Property Value
Type Description
System.Double

GroupRowMarginTop

Declaration
public double GroupRowMarginTop { get; set; }
Property Value
Type Description
System.Double

GroupRowVisible

Declaration
public bool GroupRowVisible { get; set; }
Property Value
Type Description
System.Boolean

GroupTextColor

Declaration
public string GroupTextColor { get; set; }
Property Value
Type Description
System.String

GroupTextFontFamily

Declaration
public string GroupTextFontFamily { get; set; }
Property Value
Type Description
System.String

GroupTextFontSize

Declaration
public double GroupTextFontSize { get; set; }
Property Value
Type Description
System.Double

GroupTextFontStyle

Declaration
public string GroupTextFontStyle { get; set; }
Property Value
Type Description
System.String

GroupTextFontWeight

Declaration
public string GroupTextFontWeight { get; set; }
Property Value
Type Description
System.String

GroupTextMarginBottom

Declaration
public double GroupTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

GroupTextMarginLeft

Declaration
public double GroupTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

GroupTextMarginRight

Declaration
public double GroupTextMarginRight { get; set; }
Property Value
Type Description
System.Double

GroupTextMarginTop

Declaration
public double GroupTextMarginTop { get; set; }
Property Value
Type Description
System.Double

HeaderFormatCulture

Gets or sets globalization culture when displaying header as date time

Declaration
public string HeaderFormatCulture { get; set; }
Property Value
Type Description
System.String
Remarks

This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

HeaderFormatDate

Gets or sets date format for the header

Declaration
public DataLegendHeaderDateMode HeaderFormatDate { get; set; }
Property Value
Type Description
DataLegendHeaderDateMode
Remarks

This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

HeaderFormatSpecifiers

Gets or sets the format specifiers to use with the HeaderFormatString string.

Declaration
public IgbFormatSpecifierCollection HeaderFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

HeaderFormatString

Gets or sets the format string for header text displayed in the data legend.

Declaration
public string HeaderFormatString { get; set; }
Property Value
Type Description
System.String

HeaderFormatTime

Gets or sets time format for the header

Declaration
public DataLegendHeaderTimeMode HeaderFormatTime { get; set; }
Property Value
Type Description
DataLegendHeaderTimeMode
Remarks

This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties

HeaderRowMarginBottom

Declaration
public double HeaderRowMarginBottom { get; set; }
Property Value
Type Description
System.Double

HeaderRowMarginLeft

Declaration
public double HeaderRowMarginLeft { get; set; }
Property Value
Type Description
System.Double

HeaderRowMarginRight

Declaration
public double HeaderRowMarginRight { get; set; }
Property Value
Type Description
System.Double

HeaderRowMarginTop

Declaration
public double HeaderRowMarginTop { get; set; }
Property Value
Type Description
System.Double

HeaderRowVisible

Gets or sets whether to show Header row.

Declaration
public bool HeaderRowVisible { get; set; }
Property Value
Type Description
System.Boolean

HeaderText

Gets or sets the HeaderText for the data legend.

Declaration
public string HeaderText { get; set; }
Property Value
Type Description
System.String

HeaderTextColor

Gets or sets the header text color.

Declaration
public string HeaderTextColor { get; set; }
Property Value
Type Description
System.String

HeaderTextFontFamily

Declaration
public string HeaderTextFontFamily { get; set; }
Property Value
Type Description
System.String

HeaderTextFontSize

Declaration
public double HeaderTextFontSize { get; set; }
Property Value
Type Description
System.Double

HeaderTextFontStyle

Declaration
public string HeaderTextFontStyle { get; set; }
Property Value
Type Description
System.String

HeaderTextFontWeight

Declaration
public string HeaderTextFontWeight { get; set; }
Property Value
Type Description
System.String

HeaderTextMarginBottom

Declaration
public double HeaderTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

HeaderTextMarginLeft

Declaration
public double HeaderTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

HeaderTextMarginRight

Declaration
public double HeaderTextMarginRight { get; set; }
Property Value
Type Description
System.Double

HeaderTextMarginTop

Declaration
public double HeaderTextMarginTop { get; set; }
Property Value
Type Description
System.Double

IncludedColumns

Gets or sets names of data columns or their labels to include in displaying in the data legend, e.g. "High, Low" or "H, L"

Declaration
public string[] IncludedColumns { get; set; }
Property Value
Type Description
System.String[]
Remarks

The ExcludedColumns property takes precedences over values of IncludedColumns property

IncludedSeries

Gets or sets indexes or names of series to include in displaying in the data legend, e.g. "0, 1"

Declaration
public string[] IncludedSeries { get; set; }
Property Value
Type Description
System.String[]

LabelDisplayMode

Gets or sets the mode for displaying labels before series values in the data legend, e.g. O: H: L: C: for financial series

Declaration
public DataLegendLabelMode LabelDisplayMode { get; set; }
Property Value
Type Description
DataLegendLabelMode

LabelTextColor

Gets or sets the units text color.

Declaration
public string LabelTextColor { get; set; }
Property Value
Type Description
System.String

LabelTextFontFamily

Declaration
public string LabelTextFontFamily { get; set; }
Property Value
Type Description
System.String

LabelTextFontSize

Declaration
public double LabelTextFontSize { get; set; }
Property Value
Type Description
System.Double

LabelTextFontStyle

Declaration
public string LabelTextFontStyle { get; set; }
Property Value
Type Description
System.String

LabelTextFontWeight

Declaration
public string LabelTextFontWeight { get; set; }
Property Value
Type Description
System.String

LabelTextMarginBottom

Declaration
public double LabelTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

LabelTextMarginLeft

Declaration
public double LabelTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

LabelTextMarginRight

Declaration
public double LabelTextMarginRight { get; set; }
Property Value
Type Description
System.Double

LabelTextMarginTop

Declaration
public double LabelTextMarginTop { get; set; }
Property Value
Type Description
System.Double

LayoutMode

Declaration
public DataLegendLayoutMode LayoutMode { get; set; }
Property Value
Type Description
DataLegendLayoutMode

PositionOffsetX

Gets or sets the offset of the tooltip layer on the X axis.

Declaration
public double PositionOffsetX { get; set; }
Property Value
Type Description
System.Double

PositionOffsetY

Gets or sets the offset of the tooltip layer on the Y axis.

Declaration
public double PositionOffsetY { get; set; }
Property Value
Type Description
System.Double

ShouldUpdateWhenSeriesDataChanges

Gets or sets whether the data legend should update when the series data is mutated.

Declaration
public bool ShouldUpdateWhenSeriesDataChanges { get; set; }
Property Value
Type Description
System.Boolean

SummaryLabelText

Gets or sets the units text for the data legend.

Declaration
public string SummaryLabelText { get; set; }
Property Value
Type Description
System.String

SummaryLabelTextColor

Gets or sets the units text color.

Declaration
public string SummaryLabelTextColor { get; set; }
Property Value
Type Description
System.String

SummaryLabelTextFontFamily

Declaration
public string SummaryLabelTextFontFamily { get; set; }
Property Value
Type Description
System.String

SummaryLabelTextFontSize

Declaration
public double SummaryLabelTextFontSize { get; set; }
Property Value
Type Description
System.Double

SummaryLabelTextFontStyle

Declaration
public string SummaryLabelTextFontStyle { get; set; }
Property Value
Type Description
System.String

SummaryLabelTextFontWeight

Declaration
public string SummaryLabelTextFontWeight { get; set; }
Property Value
Type Description
System.String

SummaryRowMarginBottom

Declaration
public double SummaryRowMarginBottom { get; set; }
Property Value
Type Description
System.Double

SummaryRowMarginLeft

Declaration
public double SummaryRowMarginLeft { get; set; }
Property Value
Type Description
System.Double

SummaryRowMarginRight

Declaration
public double SummaryRowMarginRight { get; set; }
Property Value
Type Description
System.Double

SummaryRowMarginTop

Declaration
public double SummaryRowMarginTop { get; set; }
Property Value
Type Description
System.Double

SummaryTitleText

Gets or sets the SummaryTitleText for the data legend.

Declaration
public string SummaryTitleText { get; set; }
Property Value
Type Description
System.String

SummaryTitleTextColor

Gets or sets the summary text color.

Declaration
public string SummaryTitleTextColor { get; set; }
Property Value
Type Description
System.String

SummaryTitleTextFontFamily

Declaration
public string SummaryTitleTextFontFamily { get; set; }
Property Value
Type Description
System.String

SummaryTitleTextFontSize

Declaration
public double SummaryTitleTextFontSize { get; set; }
Property Value
Type Description
System.Double

SummaryTitleTextFontStyle

Declaration
public string SummaryTitleTextFontStyle { get; set; }
Property Value
Type Description
System.String

SummaryTitleTextFontWeight

Declaration
public string SummaryTitleTextFontWeight { get; set; }
Property Value
Type Description
System.String

SummaryTitleTextMarginBottom

Declaration
public double SummaryTitleTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

SummaryTitleTextMarginLeft

Declaration
public double SummaryTitleTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

SummaryTitleTextMarginRight

Declaration
public double SummaryTitleTextMarginRight { get; set; }
Property Value
Type Description
System.Double

SummaryTitleTextMarginTop

Declaration
public double SummaryTitleTextMarginTop { get; set; }
Property Value
Type Description
System.Double

SummaryType

Gets or sets the SummaryType for the data legend.

Declaration
public DataLegendSummaryType SummaryType { get; set; }
Property Value
Type Description
DataLegendSummaryType

SummaryUnitsText

Gets or sets the units text for the data legend.

Declaration
public string SummaryUnitsText { get; set; }
Property Value
Type Description
System.String

SummaryUnitsTextColor

Gets or sets the units text color.

Declaration
public string SummaryUnitsTextColor { get; set; }
Property Value
Type Description
System.String

SummaryUnitsTextFontFamily

Declaration
public string SummaryUnitsTextFontFamily { get; set; }
Property Value
Type Description
System.String

SummaryUnitsTextFontSize

Declaration
public double SummaryUnitsTextFontSize { get; set; }
Property Value
Type Description
System.Double

SummaryUnitsTextFontStyle

Declaration
public string SummaryUnitsTextFontStyle { get; set; }
Property Value
Type Description
System.String

SummaryUnitsTextFontWeight

Declaration
public string SummaryUnitsTextFontWeight { get; set; }
Property Value
Type Description
System.String

SummaryValueTextColor

Gets or sets the units text color.

Declaration
public string SummaryValueTextColor { get; set; }
Property Value
Type Description
System.String

SummaryValueTextFontFamily

Declaration
public string SummaryValueTextFontFamily { get; set; }
Property Value
Type Description
System.String

SummaryValueTextFontSize

Declaration
public double SummaryValueTextFontSize { get; set; }
Property Value
Type Description
System.Double

SummaryValueTextFontStyle

Declaration
public string SummaryValueTextFontStyle { get; set; }
Property Value
Type Description
System.String

SummaryValueTextFontWeight

Declaration
public string SummaryValueTextFontWeight { get; set; }
Property Value
Type Description
System.String

TargetAxis

Gets or sets the Axis to target this annotation to. If null, this annotation layer will not render content.

Declaration
public IgbAxis TargetAxis { get; set; }
Property Value
Type Description
IgbAxis

TargetAxisScript

Provides a means of setting TargetAxis in the JavaScript environment.

Declaration
public string TargetAxisScript { get; set; }
Property Value
Type Description
System.String

TitleTextColor

Gets or sets the display text color.

Declaration
public string TitleTextColor { get; set; }
Property Value
Type Description
System.String

TitleTextFontFamily

Declaration
public string TitleTextFontFamily { get; set; }
Property Value
Type Description
System.String

TitleTextFontSize

Declaration
public double TitleTextFontSize { get; set; }
Property Value
Type Description
System.Double

TitleTextFontStyle

Declaration
public string TitleTextFontStyle { get; set; }
Property Value
Type Description
System.String

TitleTextFontWeight

Declaration
public string TitleTextFontWeight { get; set; }
Property Value
Type Description
System.String

TitleTextMarginBottom

Declaration
public double TitleTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

TitleTextMarginLeft

Declaration
public double TitleTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

TitleTextMarginRight

Declaration
public double TitleTextMarginRight { get; set; }
Property Value
Type Description
System.Double

TitleTextMarginTop

Declaration
public double TitleTextMarginTop { get; set; }
Property Value
Type Description
System.Double

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UnitsDisplayMode

Gets or sets the UnitsMode for the data legend.

Declaration
public DataLegendUnitsMode UnitsDisplayMode { get; set; }
Property Value
Type Description
DataLegendUnitsMode

UnitsText

Gets or sets the units text for the data legend.

Declaration
public string UnitsText { get; set; }
Property Value
Type Description
System.String

UnitsTextColor

Gets or sets the units text color.

Declaration
public string UnitsTextColor { get; set; }
Property Value
Type Description
System.String

UnitsTextFontFamily

Declaration
public string UnitsTextFontFamily { get; set; }
Property Value
Type Description
System.String

UnitsTextFontSize

Declaration
public double UnitsTextFontSize { get; set; }
Property Value
Type Description
System.Double

UnitsTextFontStyle

Declaration
public string UnitsTextFontStyle { get; set; }
Property Value
Type Description
System.String

UnitsTextFontWeight

Declaration
public string UnitsTextFontWeight { get; set; }
Property Value
Type Description
System.String

UnitsTextMarginBottom

Declaration
public double UnitsTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

UnitsTextMarginLeft

Declaration
public double UnitsTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

UnitsTextMarginRight

Declaration
public double UnitsTextMarginRight { get; set; }
Property Value
Type Description
System.Double

UnitsTextMarginTop

Declaration
public double UnitsTextMarginTop { get; set; }
Property Value
Type Description
System.Double

UseInterpolation

Gets or sets whether to use value interpolation when drawing the tooltips.

Declaration
public bool UseInterpolation { get; set; }
Property Value
Type Description
System.Boolean

ValueFormatAbbreviation

Gets or sets mode for abbreviating large numbers displayed in the legend

Declaration
public DataAbbreviationMode ValueFormatAbbreviation { get; set; }
Property Value
Type Description
DataAbbreviationMode
Remarks

This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

ValueFormatCulture

Gets or sets globalization culture when displaying values as currencies, e.g. use "en-GB" to display British pound symbol when the ValueFormatMode property is set to 'Currency' mode

Declaration
public string ValueFormatCulture { get; set; }
Property Value
Type Description
System.String
Remarks

This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

ValueFormatMaxFractions

Gets or sets maximum digits for formating numbers displayed in the legend

Declaration
public int ValueFormatMaxFractions { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

ValueFormatMinFractions

Gets or sets minimum digits for formating numbers displayed in the legend

Declaration
public int ValueFormatMinFractions { get; set; }
Property Value
Type Description
System.Int32
Remarks

This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

ValueFormatMode

Gets or sets the mode for displaying values in the data legend, e.g. Currency ($500.25), Decimal (500.25), Integer (500)

Declaration
public DataLegendValueMode ValueFormatMode { get; set; }
Property Value
Type Description
DataLegendValueMode

ValueFormatSpecifiers

Gets or sets the format specifiers to use with the ValueFormatString string.

Declaration
public IgbFormatSpecifierCollection ValueFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

ValueFormatString

Gets or sets the format string for values displayed in the data legend.

Declaration
public string ValueFormatString { get; set; }
Property Value
Type Description
System.String

ValueFormatUseGrouping

Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000

Declaration
public bool ValueFormatUseGrouping { get; set; }
Property Value
Type Description
System.Boolean
Remarks

This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties

ValueRowMarginBottom

Declaration
public double ValueRowMarginBottom { get; set; }
Property Value
Type Description
System.Double

ValueRowMarginLeft

Declaration
public double ValueRowMarginLeft { get; set; }
Property Value
Type Description
System.Double

ValueRowMarginRight

Declaration
public double ValueRowMarginRight { get; set; }
Property Value
Type Description
System.Double

ValueRowMarginTop

Declaration
public double ValueRowMarginTop { get; set; }
Property Value
Type Description
System.Double

ValueRowVisible

Gets or sets whether to show series rows.

Declaration
public bool ValueRowVisible { get; set; }
Property Value
Type Description
System.Boolean

ValueTextColor

Gets or sets the units text color.

Declaration
public string ValueTextColor { get; set; }
Property Value
Type Description
System.String

ValueTextFontFamily

Declaration
public string ValueTextFontFamily { get; set; }
Property Value
Type Description
System.String

ValueTextFontSize

Declaration
public double ValueTextFontSize { get; set; }
Property Value
Type Description
System.Double

ValueTextFontStyle

Declaration
public string ValueTextFontStyle { get; set; }
Property Value
Type Description
System.String

ValueTextFontWeight

Declaration
public string ValueTextFontWeight { get; set; }
Property Value
Type Description
System.String

ValueTextMarginBottom

Declaration
public double ValueTextMarginBottom { get; set; }
Property Value
Type Description
System.Double

ValueTextMarginLeft

Declaration
public double ValueTextMarginLeft { get; set; }
Property Value
Type Description
System.Double

ValueTextMarginRight

Declaration
public double ValueTextMarginRight { get; set; }
Property Value
Type Description
System.Double

ValueTextMarginTop

Declaration
public double ValueTextMarginTop { get; set; }
Property Value
Type Description
System.Double

ValueTextUseSeriesColors

Gets or sets whether to use series colors when displaying values in the legend

Declaration
public bool ValueTextUseSeriesColors { get; set; }
Property Value
Type Description
System.Boolean

ValueTextWhenMissingData

Gets or sets text displayed when data column is missing a value, e.g. "no data"

Declaration
public string ValueTextWhenMissingData { get; set; }
Property Value
Type Description
System.String

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

HideToolTips()

Declaration
public override void HideToolTips()
Overrides

HideToolTipsAsync()

Hides any tooltips presented by the layer, if any.

Declaration
public override Task HideToolTipsAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides

HideToolTipsImmediate()

Declaration
public override void HideToolTipsImmediate()
Overrides

HideToolTipsImmediateAsync()

Hides any tooltips presented by the layer, if any.

Declaration
public override Task HideToolTipsImmediateAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides

Implements

System.IDisposable