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
IgbCalloutLayer
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCalloutLayer : IgbAnnotationLayer, JsonSerializable
Constructors
IgbCalloutLayer()
Declaration
Properties
AllowedPositions
Gets or sets the allowed positions that the callout layer is allowed to use.
Declaration
public IgbCalloutPlacementPositionsCollection AllowedPositions { get; set; }
Property Value
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
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 |
|
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
CalloutContentUpdating
Declaration
public EventCallback<IgbCalloutContentUpdatingEventArgs> CalloutContentUpdating { get; set; }
Property Value
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 |
|
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
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 |
|
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
CalloutRenderStyleUpdatingScript
Declaration
public string CalloutRenderStyleUpdatingScript { get; set; }
Property Value
Type |
Description |
System.String |
|
CalloutSeriesSelecting
Declaration
public EventCallback<IgbCalloutSeriesSelectingEventArgs> CalloutSeriesSelecting { get; set; }
Property Value
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
CalloutStyleUpdatingScript
Declaration
public string CalloutStyleUpdatingScript { get; set; }
Property Value
Type |
Description |
System.String |
|
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 |
|
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 suppporting 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 |
|
LabelMemberPath
Gets or sets the label mapping property for the callouts.
Declaration
public string LabelMemberPath { get; set; }
Property Value
Type |
Description |
System.String |
|
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
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
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 |
|
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
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
InvalidateCalloutContent()
Declaration
public void InvalidateCalloutContent()
InvalidateCalloutContentAsync()
Invalidates content of callout layer
Declaration
public Task InvalidateCalloutContentAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Implements
System.IDisposable