Class Title
create a Title class, which includes properties to customize titles of primary and secondary axis.
Inherited Members
Namespace: Syncfusion.JavaScript.DataVisualization.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class Title : EJTagHelper
Constructors
Title()
Declaration
public Title()
Properties
Alignment
Gets or sets the value for Alignment, which provides options to align axis either center, far or near.
Declaration
[JsonProperty("alignment")]
[JsonConverter(typeof(StringEnumConverter))]
public Alignment Alignment { get; set; }
Property Value
Type | Description |
---|---|
Alignment |
Remarks
Specifies the alignment of the axis.
AxisTitlePosition
Gets or sets the value for AxisTitlePosition, to position the title of an axis either inside or outside.
Declaration
[JsonProperty("axisTitlePosition")]
[JsonConverter(typeof(StringEnumConverter))]
public AxisTitlePosition AxisTitlePosition { get; set; }
Property Value
Type | Description |
---|---|
AxisTitlePosition |
Remarks
Specifies the position of the axis title.
EnableTrim
Gets or sets the value for EnableTrim, to trim title of axis when its exceeds maximum title width or chart area.
Declaration
[JsonProperty("enableTrim")]
public bool EnableTrim { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title.
Font
Gets or sets the value for Font, which provides options to customize the style, size, family, weight of font title.
Declaration
[JsonProperty("font")]
public ChartFont Font { get; set; }
Property Value
Type | Description |
---|---|
ChartFont |
Remarks
Options for customizing the title font.
IsReversed
Gets or sets the value for IsReversed, which displays the axis title from left to right or vice versa.
Declaration
[JsonProperty("isReversed")]
public bool IsReversed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Enables or disables RTL for axis title.
MaximumTitleWidth
Gets or sets the value for MaximumTitleWidth, which specifies maximum chart title width and it gets trimmed when it exceeds.
Declaration
[JsonProperty("maximumTitleWidth")]
public double? MaximumTitleWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Double> |
Remarks
Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true.
Offset
Gets or sets the value for Offset, which specified offset value for primary or secondary axis titles.
Declaration
[JsonProperty("offset")]
public double Offset { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Remarks
Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true.
Text
Gets or sets the value for axis title Text, which specifies title text for a primary or secondary axis.
Declaration
[JsonProperty("text")]
public string Text { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Title for the axis.
TextAlignment
Gets or sets the value for TextAlignment, which provides option to align the title of an axis either near, far or center.
Declaration
[JsonProperty("textAlignment")]
[JsonConverter(typeof(StringEnumConverter))]
public TextAlignment TextAlignment { get; set; }
Property Value
Type | Description |
---|---|
TextAlignment |
Remarks
Specifies the text alignment of the axis title.
Visible
Gets or sets the value for Visible, which controls the visibility of title text in primary or seconday axis.
Declaration
[JsonProperty("visible")]
public bool Visible { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Controls the visibility of axis title.
Methods
ShouldSerializeFont()
Declaration
public bool ShouldSerializeFont()
Returns
Type | Description |
---|---|
System.Boolean |