HtmlForgeX

API Reference

Class

ChartJsSankeyDatasetOptions

Namespace HtmlForgeX
Assembly HtmlForgeX

Typed configuration for Sankey datasets.

Inheritance

  • Object
  • ChartJsSankeyDatasetOptions

Constructors

public ChartJsSankeyDatasetOptions() #

Methods

public ChartJsSankeyDatasetOptions SetLabel(String node, String label) #
Returns: ChartJsSankeyDatasetOptions

Sets the label displayed for a node.

Parameters

node System.String requiredposition: 0
label System.String requiredposition: 1
public ChartJsSankeyDatasetOptions SetNodeColor(String node, String color) #
Returns: ChartJsSankeyDatasetOptions

Maps a node to a specific color that is used by the built-in color functions.

Parameters

node System.String requiredposition: 0
color System.String requiredposition: 1
public ChartJsSankeyDatasetOptions SetPriority(String node, Double priority) #
Returns: ChartJsSankeyDatasetOptions

Overrides the rendering priority for a node (lower values render higher).

Parameters

node System.String requiredposition: 0
priority System.Double requiredposition: 1
UseCustomColorFrom 2 overloads
public ChartJsSankeyDatasetOptions UseCustomColorFrom(ChartJsFunction function) #
Returns: ChartJsSankeyDatasetOptions

Uses a raw JavaScript function for the source color.

Parameters

jsFunction System.String requiredposition: 0
UseCustomColorFrom(HtmlForgeX.ChartJsFunction function) #

Uses a raw JavaScript function for the source color.

Parameters

function HtmlForgeX.ChartJsFunction required
UseCustomColorTo 2 overloads
public ChartJsSankeyDatasetOptions UseCustomColorTo(ChartJsFunction function) #
Returns: ChartJsSankeyDatasetOptions

Uses a raw JavaScript function for the target color.

Parameters

jsFunction System.String requiredposition: 0
UseCustomColorTo(HtmlForgeX.ChartJsFunction function) #

Uses a raw JavaScript function for the target color.

Parameters

function HtmlForgeX.ChartJsFunction required

Properties

public Dictionary<String, Double> Priorities { get; } #

Optional per-node priority (smaller = higher column).

public Dictionary<String, String> Labels { get; } #

Optional friendly labels per node.

public Dictionary<String, String> NodeColors { get; set; } #

Optional mapping of node name to color.

public String DefaultNodeColor { get; set; } #

Fallback color used when a node is missing from NodeColors.

public ChartJsFunction ColorFrom { get; set; } #

Custom JavaScript function for determining link color at the source node.

public ChartJsFunction ColorTo { get; set; } #

Custom JavaScript function for determining link color at the target node.

public Nullable<Int32> BorderWidth { get; set; } #

Border width applied to the links.

public String BorderColor { get; set; } #

Border color applied to the links.