Class IgbCalloutLayer

Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor.

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

Constructors

IgbCalloutLayer()

Declaration
public IgbCalloutLayer()

Properties

AllowedPositions

Gets or sets the allowed positions that the callout layer is allowed to use.

Declaration
public IgbCalloutPlacementPositionsCollection AllowedPositions { get; set; }
Property Value
Type Description
IgbCalloutPlacementPositionsCollection

AutoCalloutLabelPrecision

Gets or sets the precision to use when values are used for the auto callout labels.

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

AutoCalloutVisibilityMode

Gets or sets the rules for when the callouts should be visible.

Declaration
public AutoCalloutVisibilityMode AutoCalloutVisibilityMode { get; set; }
Property Value
Type Description
AutoCalloutVisibilityMode

CalloutBackground

Gets or sets the brush that specifies how the backgrounds for the callouts of the layer are painted. Leave unset for an automatic value.

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

CalloutBadgeBackground

Gets or sets the badge background in callout annotation.

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

CalloutBadgeCorner

Gets or sets the corner radius of badge in callout annotation

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

CalloutBadgeGap

Gets or sets the gap between badge and text in callout annotation

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

CalloutBadgeHeight

Gets or sets the the badge height in callout annotation.

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

CalloutBadgeImageMemberPath

Gets or sets the mapping property for an image displayed in the badge of callout annotation

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

Examples #1: "DataColumnName" that contains full URL to an image: https://dl.infragistics.com/x/img/flags/USA.png Examples #2: "https://dl.infragistics.com/x/img/flags/{ISO3}.png" where "ISO3" is name of data column that contains image name: USA

CalloutBadgeMatchSeries

Gets or sets whether or not the callout badge matches appearance of target series.

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

CalloutBadgeOutline

Gets or sets the badge outline in callout annotation.

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

CalloutBadgeThickness

Gets or sets the the badge thickness in callout annotation.

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

CalloutBadgeVisible

Gets or sets the badge is visible in callout annotation.

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

CalloutBadgeWidth

Gets or sets the the badge width in callout annotation.

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

CalloutCollisionMode

Gets or sets the strategy to use for avoiding collisions between the callouts in this layer. Leave unset for an automatic value.

Declaration
public CalloutCollisionMode CalloutCollisionMode { get; set; }
Property Value
Type Description
CalloutCollisionMode

CalloutContentUpdating

Declaration
public EventCallback<IgbCalloutContentUpdatingEventArgs> CalloutContentUpdating { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbCalloutContentUpdatingEventArgs>

CalloutContentUpdatingScript

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

CalloutCornerRadius

Gets or sets the corner radius to use for the callout borders.

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

CalloutDarkTextColor

Gets or sets the dark color to use for the callout text. Leave unset for an automatic value.

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

CalloutExpandsAxisBufferEnabled

Gets or sets whether or not callouts expand axis buffer for extra space for their render around data points.

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

CalloutExpandsAxisBufferMaxHeight

Gets or sets the maximum vertical axis buffer for positioning callouts.

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

This property takes precedence over the CalloutExpandsAxisBufferMinHeight property.

CalloutExpandsAxisBufferMaxWidth

Gets or sets the maximum horizontal axis buffer for positioning callouts.

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

This property takes precedence over the CalloutExpandsAxisBufferMinWidth property.

CalloutExpandsAxisBufferMinHeight

Gets or sets the minimum vertical axis buffer for positioning callouts.

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

This property does not take precedence over the CalloutExpandsAxisBufferMaxHeight property.

CalloutExpandsAxisBufferMinWidth

Gets or sets the minimum horizontal axis buffer for positioning callouts.

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

This property does not take precedence over the CalloutExpandsAxisBufferMaxWidth property.

CalloutExpandsAxisBufferOnInitialVisibility

Gets or sets whether or not recalculate callouts expand axis buffer on rendering frame.

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

This property is not used when the CalloutExpandsAxisBufferEnabled property is false or AutoCalloutVisibilityMode is not Dedicated.

CalloutExpandsAxisBufferOnlyWhenVisible

Gets or sets whether or not callouts expand axis buffer only when callouts are visible in the chart.

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

This property is not used when the CalloutExpandsAxisBufferEnabled property is false or AutoCalloutVisibilityMode is not Dedicated.

CalloutInterpolatedValuePrecision

Gets or sets the precision to use displaying values for interpolated crosshair positions.

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

CalloutLabelUpdating

Declaration
public EventCallback<IgbCalloutLabelUpdatingEventArgs> CalloutLabelUpdating { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbCalloutLabelUpdatingEventArgs>

CalloutLabelUpdatingScript

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

CalloutLeaderBrush

Gets or sets the brush that specifies how the leader lines for the callouts of the layer are painted.

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

CalloutLightTextColor

Gets or sets the light color to use for the callout text. Leave unset for an automatic value.

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

CalloutOutline

Gets or sets the brush that specifies how the outlines for the callouts of the layer are painted.

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

CalloutPaddingBottom

Gets or sets the bottom padding to use within the callout. Leaving this NaN will use an automatic value related to the axis label margins.

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

CalloutPaddingLeft

Gets or sets the left padding to use withing the callout. Leaving this NaN will use an automatic value related to the axis label margins.

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

CalloutPaddingRight

Gets or sets the right padding to use within the callout. Leaving this NaN will use an automatic value related to the axis label margins.

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

CalloutPaddingTop

Gets or sets the top padding to use within the callout. Leaving this NaN will use an automatic value related to the axis label margins.

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

CalloutPositionPadding

Gets or sets the padding to add to the callout positioning. Leave unset for an automatic value.

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

CalloutRenderStyleUpdating

Declaration
public EventCallback<IgbCalloutRenderStyleUpdatingEventArgs> CalloutRenderStyleUpdating { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbCalloutRenderStyleUpdatingEventArgs>

CalloutRenderStyleUpdatingScript

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

CalloutSeriesSelecting

Declaration
public EventCallback<IgbCalloutSeriesSelectingEventArgs> CalloutSeriesSelecting { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbCalloutSeriesSelectingEventArgs>

CalloutSeriesSelectingScript

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

CalloutStrokeThickness

Gets or sets the stroke thickness for the callout backing. Leave unset for an automatic value.

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

CalloutStyleUpdating

Declaration
public EventCallback<IgbCalloutStyleUpdatingEventArgs> CalloutStyleUpdating { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbCalloutStyleUpdatingEventArgs>

CalloutStyleUpdatingScript

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

CalloutSuspendedWhenShiftingToVisible

Gets or sets whether or not suspend refresh of callouts while they shift from hidden to visible

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

CalloutTextColor

Gets or sets the color to use for the callout text. Leave unset for an automatic value.

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

CollisionChannel

Gets or sets a channel name to identify other callout layers within the chart to share collision information with.

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

ContentMemberPath

Gets or sets the content mapping property for the callouts.

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

HighlightedValueLabelMode

Gets or sets whether to use values, rather than labels for auto callout labels.

Declaration
public HighlightedValueLabelMode HighlightedValueLabelMode { get; set; }
Property Value
Type Description
HighlightedValueLabelMode

IsAutoCalloutBehaviorEnabled

Gets or sets how to select the final value to annotate.

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

IsCalloutOffsettingEnabled

Gets or sets whether to allow the callouts to be variable distances from the target points, for supporting collision modes.

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

IsCustomCalloutRenderStyleEnabled

Gets or sets whether to allow for custom callout styles.

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

IsCustomCalloutStyleEnabled

Gets or sets whether to allow for custom callout styles.

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

KeyMemberPath

Gets or sets the key mapping property for the callouts.

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

LabelFormat

Gets or sets the label format string to use for the label.

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

LabelFormatSpecifiers

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

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

LabelMemberPath

Gets or sets the label mapping property for the callouts.

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

ShouldTruncateOnBoundaryCollisions

Gets or sets whether the callouts that collide with the boundary should be truncated.

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

TargetSeries

Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously.

Declaration
public IgbSeries TargetSeries { get; set; }
Property Value
Type Description
IgbSeries

TargetSeriesName

Gets or sets the name of the series series to target this annotation to. If null, this annotation targets all series simultaneously.

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

TargetSeriesScript

Provides a means of setting TargetSeries in the JavaScript environment.

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

TextStyle

Gets or sets the stroke thickness for the axis annotation backing. Leave unset for an automatic value.

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

Type

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

UseAutoContrastingLabelColors

Gets or sets whether to the label color is automatically decided between a light and dark option for contrast.

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

UseInterpolatedValueForAutoCalloutLabels

Gets or sets whether to use values, rather than labels for auto callout labels.

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

UseItemColorForFill

Gets or sets whether to the series color as the outline of the callout.

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

UseItemColorForOutline

Gets or sets whether to the series item color as the outline of the callout.

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

UseSeriesColorForOutline

Gets or sets whether to the series color as the outline of the callout.

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

UseValueForAutoCalloutLabels

Gets or sets whether to use values, rather than labels for auto callout labels.

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

XMemberPath

Gets or sets the label mapping property for the callouts.

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

YMemberPath

Gets or sets the label mapping property for the callouts.

Declaration
public string YMemberPath { 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

GetItem(Point)

Declaration
public override object GetItem(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Object
Overrides

GetItemAsync(Point)

Declaration
public override Task<object> GetItemAsync(Point world)
Parameters
Type Name Description
Point world
Returns
Type Description
System.Threading.Tasks.Task<System.Object>
Overrides

GetItemValue(Object, String)

Declaration
public override object GetItemValue(object item, string memberPathName)
Parameters
Type Name Description
System.Object item
System.String memberPathName
Returns
Type Description
System.Object
Overrides

GetItemValueAsync(Object, String)

Declaration
public override Task<object> GetItemValueAsync(object item, string memberPathName)
Parameters
Type Name Description
System.Object item
System.String memberPathName
Returns
Type Description
System.Threading.Tasks.Task<System.Object>
Overrides

GetMemberPathValue(String)

Declaration
public override string GetMemberPathValue(string memberPathName)
Parameters
Type Name Description
System.String memberPathName
Returns
Type Description
System.String
Overrides

GetMemberPathValueAsync(String)

Gets the value of a requested member path from the series.

Declaration
public override Task<string> GetMemberPathValueAsync(string memberPathName)
Parameters
Type Name Description
System.String memberPathName

The property name of a valid member path for the series
Returns
Type Description
System.Threading.Tasks.Task<System.String>
Overrides

GetSeriesValuePosition(Point, Boolean, Boolean)

Declaration
public override Point GetSeriesValuePosition(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
Point
Overrides

GetSeriesValuePositionAsync(Point, Boolean, Boolean)

Declaration
public override Task<Point> GetSeriesValuePositionAsync(Point world, bool useInterpolation, bool skipUnknowns)
Parameters
Type Name Description
Point world
System.Boolean useInterpolation
System.Boolean skipUnknowns
Returns
Type Description
System.Threading.Tasks.Task<Point>
Overrides

InvalidateCalloutContent()

Declaration
public void InvalidateCalloutContent()

InvalidateCalloutContentAsync()

Invalidates content of callout layer

Declaration
public Task InvalidateCalloutContentAsync()
Returns
Type Description
System.Threading.Tasks.Task

RecalculateAxisRangeBuffer()

Declaration
public void RecalculateAxisRangeBuffer()

RecalculateAxisRangeBufferAsync()

Resets actual visiable range margin

Declaration
public Task RecalculateAxisRangeBufferAsync()
Returns
Type Description
System.Threading.Tasks.Task

RefreshAxisBufferAndCalloutPositions()

Declaration
public void RefreshAxisBufferAndCalloutPositions()

RefreshAxisBufferAndCalloutPositionsAsync()

Refresh axis buffer and callouts rendering

Declaration
public Task RefreshAxisBufferAndCalloutPositionsAsync()
Returns
Type Description
System.Threading.Tasks.Task

RefreshLabelPositions()

Declaration
public void RefreshLabelPositions()

RefreshLabelPositionsAsync()

Force the callout labels to reevaluate their positions.

Declaration
public Task RefreshLabelPositionsAsync()
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable