Class ChartSubTitle

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

Constructors

ChartSubTitle()

Declaration
public ChartSubTitle()

Properties

Background

Gets or sets the value for Background in chart SubTitle, which sets background for sub title of the chart.

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

Background of sub title.

Border

Gets or sets the value for Border, which provides options to customize the chart title border.

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

Options to customize the border.

EnableTrim

Gets or sets the value for EnableTrim, which trims the sub title when its width exceeds, maximum subtitle width or chart area.

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

Specifies whether to trim the chart sub-title when it exceeds the chart area or the maximum width of the sub-title.

Font

Gets or sets the value for Font, which provides options to customize size, family, weight, color and opacity of font.

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

Options to customize the font.

MaximumWidth

Gets or sets the value for MaximumWidth, which provides option to set maximum width for chart sub title.

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

Maximum width of the sub-title, when the sub-title exceeds this width, the title gets trimmed, when enableTrim is true.

Text

Gets or sets the value for Text in chart SubTitle, which renders sub title text of chart.

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

Text to be displayed in sub title.

TextAlignment

Gets or sets the value for TextAlignment in chart SubTitle, which aligns the chart sub title text in near, far or center.

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

Alignment of sub title text.

TextOverflow

Gets or sets the TextOverflow of the sub-title, which trims or wraps the chart sub title when its width exceeds maximum sub title width.

Declaration
[JsonProperty("textOverflow")]
public ChartTitleTextOverflow TextOverflow { get; set; }
Property Value
Type Description
ChartTitleTextOverflow
Remarks

Specifies the action taken when the sub-title textWidth is more than the maximum subtitle width .

Visible

Gets or sets the value for Visible, which controls the visibility of sub title text of chart.

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

Controls the visibility of chart sub-title.

Methods

ShouldSerializeBorder()

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

ShouldSerializeFont()

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