HtmlForgeX

API Reference

Class

ChartJsTitle

Namespace HtmlForgeX
Assembly HtmlForgeX

Represents the title configuration for a Chart.js chart.

Inheritance

  • Object
  • ChartJsTitle

Constructors

public ChartJsTitle() #

Methods

Color 2 overloads
public ChartJsTitle Color(RGBColor color) #
Returns: ChartJsTitle

Sets the title color using a CSS string.

Parameters

color System.String requiredposition: 0
Color(HtmlForgeX.RGBColor color) #

Sets the title color using an RGB value.

Parameters

color HtmlForgeX.RGBColor required
public ChartJsTitle Display(Boolean display = true) #
Returns: ChartJsTitle

Sets whether the title is displayed.

Parameters

display System.Boolean = true optionalposition: 0
public ChartJs End() #
Returns: ChartJs

Returns control to the owning chart for continued chaining.

public ChartJsTitle FontSize(Int32 size) #
Returns: ChartJsTitle

Sets the title font size (in pixels).

Parameters

size System.Int32 requiredposition: 0
public ChartJsTitle FontWeight(ChartJsFontWeight weight) #
Returns: ChartJsTitle

Sets the title font weight.

Parameters

weight HtmlForgeX.ChartJsFontWeight requiredposition: 0
public ChartJsTitle Padding(Action<ChartJsLayoutPadding> configure) #
Returns: ChartJsTitle

Configures padding using Chart.js layout semantics.

Parameters

configure System.Action{HtmlForgeX.ChartJsLayoutPadding} requiredposition: 0
public ChartJsTitle Position(ChartJsPosition position) #
Returns: ChartJsTitle

Sets the title position.

Parameters

position HtmlForgeX.ChartJsPosition requiredposition: 0
public ChartJsTitle Text(String text, Boolean display = true) #
Returns: ChartJsTitle

Sets the title text and toggles its visibility.

Parameters

text System.String requiredposition: 0
display System.Boolean = true optionalposition: 1

Properties

public Nullable<Boolean> IsDisplayed { get; set; } #
JsonPropertyName("display") JsonIgnore(Condition = 3)

Gets or sets whether to display the title.

public Object TitleText { get; set; } #
JsonPropertyName("text") JsonIgnore(Condition = 3)

Gets or sets the title text.

public Nullable<ChartJsPosition> TitlePosition { get; set; } #
JsonPropertyName("position") JsonIgnore(Condition = 3) JsonConverter(typeof(ChartJsPositionNullableConverter))

Gets or sets the position of the title.

public ChartJsFont Font { get; set; } #
JsonPropertyName("font") JsonIgnore(Condition = 3)

Gets or sets the font configuration.

public String TitleColor { get; set; } #
JsonPropertyName("color") JsonIgnore(Condition = 3)

Gets or sets the color.

public Object TitlePadding { get; set; } #
JsonPropertyName("padding") JsonIgnore(Condition = 3)

Gets or sets the padding.