Class HighlightSettings

Inheritance
System.Object
EJTagHelper
HighlightSettings
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.JavaScript.DataVisualization.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class HighlightSettings : EJTagHelper

Constructors

HighlightSettings()

Declaration
public HighlightSettings()

Properties

Border

Gets or sets the Border of highlightSettings

Declaration
[JsonProperty("border")]
public ChartBorder Border { get; set; }
Property Value
Type Description
ChartBorder
Remarks

Options for customizing the border color and width of highlight rect.

Color

Gets or sets the Color of highlightSettings

Declaration
[JsonProperty("color")]
public string Color { get; set; }
Property Value
Type Description
System.String
Remarks

Color of the series/point on highlight.

CustomPattern

Gets or sets the CustomPattern used for highlighting, which highlights the points or series based on custom pattern.

Declaration
[JsonProperty("customPattern")]
public string CustomPattern { get; set; }
Property Value
Type Description
System.String
Remarks

Custom pattern for the series on highlight.

Enable

Gets or sets the value of Enable property of highlightSettings

Declaration
[JsonProperty("enable")]
public bool Enable { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Enables/disables the ability to highlight the series or data point interactively.

Mode

Gets or sets the Mode of highlighting, which provides an option to highlight the data point or series based on specified mode.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("mode")]
public ChartMode Mode { get; set; }
Property Value
Type Description
ChartMode
Remarks

Specifies whether the series or data point has to be highlighted.

Opacity

Gets or sets the Opacity of highlightSettings

Declaration
[JsonProperty("opacity")]
public double Opacity { get; set; }
Property Value
Type Description
System.Double
Remarks

Opacity of the series/point on highlight.

Pattern

Gets or sets the Pattern used for highlighting, which highlights the point or series based on the specified pattern.

Declaration
[JsonProperty("pattern")]
[JsonConverter(typeof(StringEnumConverter))]
public ChartPattern Pattern { get; set; }
Property Value
Type Description
ChartPattern
Remarks

Specifies the pattern for the series/point on highlight.

Type

Gets or sets the Type of highlighting, which provides an option to highlight single or multiple points based on type of highlight.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("type")]
public ChartSelectionType Type { get; set; }
Property Value
Type Description
ChartSelectionType
Remarks

Specifies whether multiple data points can be highlighted or not.

Methods

ShouldSerializeBorder()

Declaration
public bool ShouldSerializeBorder()
Returns
Type Description
System.Boolean