Class IgbCategoryItemHighlightLayer
Represents an annotation layer that highlights items in a series that use a category axis
either by drawing a banded shape at their position, or by rendering a marker at their position.
Depending on the type of series, the default highlight will be affected. To override
the type of highlight used, you can set the HighlightType property.
Inheritance
System.Object
IgbCategoryItemHighlightLayer
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCategoryItemHighlightLayer : IgbAnnotationLayer, JsonSerializable
Constructors
IgbCategoryItemHighlightLayer()
Declaration
public IgbCategoryItemHighlightLayer()
Properties
BandHighlightWidth
Gets or sets the width to use for the highlight region if highlighting items in a grid aligned series (line, spline, etc), with a banded shape.
Declaration
public double BandHighlightWidth { get; set; }
Property Value
Type |
Description |
System.Double |
|
HighlightType
Gets or sets which type of highlight shape to use when highlighting items.
Declaration
public CategoryItemHighlightType HighlightType { get; set; }
Property Value
MarkerBrush
Gets or sets which color to use for the marker when highlighting items, if appropriate.
Declaration
public string MarkerBrush { get; set; }
Property Value
Type |
Description |
System.String |
|
MarkerOutline
Gets or sets which outline color to use for the marker when highlighting items, if appropriate.
Declaration
public string MarkerOutline { get; set; }
Property Value
Type |
Description |
System.String |
|
MarkerTemplate
Gets or sets the template to use for marker visuals for the current series object.
Declaration
public object MarkerTemplate { get; set; }
Property Value
Type |
Description |
System.Object |
|
MarkerTemplateScript
Provides a means of setting MarkerTemplate in the JavaScript environment.
Declaration
public string MarkerTemplateScript { get; set; }
Property Value
Type |
Description |
System.String |
|
MarkerType
Gets or sets which type of marker to use when highlighting items, if appropriate.
Declaration
public MarkerType MarkerType { get; set; }
Property Value
SkipUnknownValues
Gets or sets whether to skip unknown values when searching for series values.
Declaration
public bool SkipUnknownValues { 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
TargetSeriesName
Gets or sets the name of the 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 |
|
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