HtmlForgeX

API Reference

Class

ChartJsAxis

Namespace HtmlForgeX
Assembly HtmlForgeX

Represents an axis configuration.

Inheritance

  • Object
  • ChartJsAxis

Constructors

public ChartJsAxis() #

Methods

public ChartJsAxis SetBeginAtZero(Boolean enabled = true) #
Returns: ChartJsAxis

Sets whether the axis should begin at zero.

Parameters

enabled System.Boolean = true optionalposition: 0
public ChartJsAxis SetDisplay(Boolean display = true) #
Returns: ChartJsAxis

Sets whether the axis is displayed.

Parameters

display System.Boolean = true optionalposition: 0
public ChartJsAxis SetGrid(Action<ChartJsGrid> configure) #
Returns: ChartJsAxis

Configures the grid.

Parameters

configure System.Action{HtmlForgeX.ChartJsGrid} requiredposition: 0
public ChartJsAxis SetPosition(String position) #
Returns: ChartJsAxis

Sets the axis position.

Parameters

position System.String requiredposition: 0
public ChartJsAxis SetRange(Nullable<Double> min = null, Nullable<Double> max = null) #
Returns: ChartJsAxis

Sets the axis range.

Parameters

min System.Nullable{System.Double} = null optionalposition: 0
max System.Nullable{System.Double} = null optionalposition: 1
public ChartJsAxis SetStacked(Boolean stacked = true) #
Returns: ChartJsAxis

Sets whether the axis is stacked.

Parameters

stacked System.Boolean = true optionalposition: 0
public ChartJsAxis SetSuggestedRange(Nullable<Double> min = null, Nullable<Double> max = null) #
Returns: ChartJsAxis

Sets the suggested axis range.

Parameters

min System.Nullable{System.Double} = null optionalposition: 0
max System.Nullable{System.Double} = null optionalposition: 1
public ChartJsAxis SetTicks(Action<ChartJsTicks> configure) #
Returns: ChartJsAxis

Configures the ticks.

Parameters

configure System.Action{HtmlForgeX.ChartJsTicks} requiredposition: 0
public ChartJsAxis SetTitle(String text, Boolean display = true) #
Returns: ChartJsAxis

Sets the axis title.

Parameters

text System.String requiredposition: 0
display System.Boolean = true optionalposition: 1
public ChartJsAxis SetType(String type) #
Returns: ChartJsAxis

Sets the axis type (linear, logarithmic, etc).

Parameters

type System.String requiredposition: 0

Properties

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

Gets or sets the type of scale.

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

Gets or sets whether the axis is displayed.

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

Gets or sets the position of the axis.

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

Gets or sets whether the scale should begin at zero.

public Nullable<Double> Min { get; set; } #
JsonPropertyName("min") JsonIgnore(Condition = 3)

Gets or sets the minimum value.

public Nullable<Double> Max { get; set; } #
JsonPropertyName("max") JsonIgnore(Condition = 3)

Gets or sets the maximum value.

public Nullable<Double> SuggestedMin { get; set; } #
JsonPropertyName("suggestedMin") JsonIgnore(Condition = 3)

Gets or sets the suggested minimum value.

public Nullable<Double> SuggestedMax { get; set; } #
JsonPropertyName("suggestedMax") JsonIgnore(Condition = 3)

Gets or sets the suggested maximum value.

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

Gets or sets whether the axis is stacked.

public ChartJsAxisTitle Title { get; set; } #
JsonPropertyName("title") JsonIgnore(Condition = 3)

Gets or sets the title configuration.

public ChartJsGrid Grid { get; set; } #
JsonPropertyName("grid") JsonIgnore(Condition = 3)

Gets or sets the grid configuration.

public ChartJsTicks Ticks { get; set; } #
JsonPropertyName("ticks") JsonIgnore(Condition = 3)

Gets or sets the ticks configuration.