HtmlForgeX

API Reference

Class

ApexLegendOptions

Namespace HtmlForgeX
Assembly HtmlForgeX

Options controlling the chart legend display when rendering ApexCharts graphs.

Inheritance

  • Object
  • ApexLegendOptions

Constructors

public ApexLegendOptions() #

Methods

public ApexLegendOptions Position(ApexPosition position) #
Returns: ApexLegendOptions

Sets the legend position.

Parameters

position HtmlForgeX.ApexPosition requiredposition: 0
The position.

Returns

The current ApexLegendOptions instance.

public ApexLegendOptions SetFloating(Boolean floating) #
Returns: ApexLegendOptions

Sets whether the legend is floating.

Parameters

floating System.Boolean requiredposition: 0
Whether the legend should float.

Returns

The current ApexLegendOptions instance.

public ApexLegendOptions SetFontSize(String size) #
Returns: ApexLegendOptions

Sets the font size.

Parameters

size System.String requiredposition: 0
The font size.

Returns

The current ApexLegendOptions instance.

public ApexLegendOptions SetHorizontalAlign(String align) #
Returns: ApexLegendOptions

Sets the horizontal alignment.

Parameters

align System.String requiredposition: 0
The alignment (center, left, right).

Returns

The current ApexLegendOptions instance.

public ApexLegendOptions ShowLegend(Boolean value) #
Returns: ApexLegendOptions

Enables or disables the legend.

Parameters

value System.Boolean requiredposition: 0
Whether to show the legend.

Returns

The current ApexLegendOptions instance.

Properties

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

Gets or sets a value indicating whether the legend is visible.

public Nullable<ApexPosition> LegendPosition { get; set; } #
JsonPropertyName("position") JsonIgnore(Condition = 3) JsonConverter(typeof(ApexEnumConverter<ApexPosition>))

Gets or sets the legend position.

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

Gets or sets whether the legend is floating.

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

Gets or sets the horizontal alignment.

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

Gets or sets the font size.