Class CaptionSettings

Inheritance
System.Object
EJTagHelper
CaptionSettings
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 CaptionSettings : EJTagHelper

Constructors

CaptionSettings()

Declaration
public CaptionSettings()

Properties

EnableTrim

Gets or sets the value of EnableTrim property in Caption.

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

Specifies whether trim the labels will be true or false.

Font

Gets or sets the Font of caption.

Declaration
[JsonProperty("font")]
public BulletFont Font { get; set; }
Property Value
Type Description
BulletFont
Remarks

Contains property to customize the font of caption.

Indicator

Gets or sets the Indicator of bullet graph.

Declaration
[JsonProperty("indicator")]
public Indicator Indicator { get; set; }
Property Value
Type Description
Indicator
Remarks

Contains property to customize the indicator.

Location

Gets or sets the Location of caption.

Declaration
[JsonProperty("location")]
public BulletLocation Location { get; set; }
Property Value
Type Description
BulletLocation
Remarks

Contains property to customize the location.

Padding

Gets or sets the Padding for Caption.

Declaration
[JsonProperty("padding")]
public int Padding { get; set; }
Property Value
Type Description
System.Int32
Remarks

Specifies the padding to be applied when text position is used.

SubTitle

Gets or sets the SubTitle of bullet graph.

Declaration
[JsonProperty("subTitle")]
public SubTitle SubTitle { get; set; }
Property Value
Type Description
SubTitle
Remarks

Contains property to customize the subtitle.

Text

Gets or sets the Text of caption.

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

Specifies the text to be displayed on bullet graph.

TextAlignment

Gets or sets the TextAlignment of Caption.

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

Specifies the alignment of caption text with respect to scale. This property will not be applied when text position is float.

TextAnchor

Gets or sets the TextAnchor of Caption.

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

Specifies caption text anchoring when caption text overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position.

TextAngle

Gets or sets the TextAngle of caption.

Declaration
[JsonProperty("textAngle")]
public int TextAngle { get; set; }
Property Value
Type Description
System.Int32
Remarks

Specifies the angel in which the caption is rendered.

TextPosition

Gets or sets the TextPosition of Caption.

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

Specifies how caption text should be placed.

Methods

ShouldSerializeFont()

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

ShouldSerializeLocation()

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

ShouldSerializeSubTitle()

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