Class IgbCategoryHighlightLayer
Represents an annotation layer that targets a category axis, or all category axes in the chart.
If the axis contains any series that are aligned between major gridlines of the axis (column, waterfall, etc) this will render a shape that fills the current category.
Otherwise it will render a band with an adjustable thickness at the closest gridline to the pointer position.
Setting UseIterpolation to true will cause the x position in the latter case to become affixed to the x position of the pointer.
Inheritance
System.Object
IgbCategoryHighlightLayer
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCategoryHighlightLayer : IgbAnnotationLayer, JsonSerializable, IDisposable
Constructors
IgbCategoryHighlightLayer()
Declaration
public IgbCategoryHighlightLayer()
Properties
BandHighlightWidth
Gets or sets the width to use for the highlight region if drawing a band rather than filling a category.
Declaration
public double BandHighlightWidth { get; set; }
Property Value
| Type |
Description |
| System.Double |
|
TargetAxis
Gets or sets the axis to target this annotation to. If null, this annotation targets all category axes simultaneously.
Declaration
public IgbCategoryAxisBase TargetAxis { get; set; }
Property Value
TargetAxisScript
Provides a means of setting TargetAxis in the JavaScript environment.
Declaration
public string TargetAxisScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Type
Declaration
public override string Type { get; }
Property Value
| Type |
Description |
| System.String |
|
Overrides
UseInterpolation
Gets or sets whether to use value interpolation when drawing a line through the best value for the pointer position.
Declaration
public bool UseInterpolation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
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
Implements
System.IDisposable