Skip to content

Commit f019f2b

Browse files
committed
Improve documentation and add Order property in ChartDataset
Enhanced clarity of documentation comments for clipping behavior and the Hidden property. Added a new Order property to manage dataset drawing order. Included links to Chart.js documentation for better dataset configuration guidance. NOTE: This commit message is auto-generated using GitHub Copilot.
1 parent 4b28ccd commit f019f2b

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

BlazorExpress.ChartJS/Models/ChartDataset/ChartDataset.cs

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ public ChartDataset()
2020
#region Properties, Indexers
2121

2222
/// <summary>
23-
/// How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside
24-
/// chartArea. 0 = clip at chartArea.
25-
/// Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}
23+
/// How to clip relative to chartArea. Positive value allows overflow, negative value clips that
24+
/// many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured
25+
/// per side: clip: {left: 5, top: false, right: -2, bottom: 0}
2626
/// <para>
2727
/// Default value is <see langword="null"/>.
2828
/// </para>
@@ -47,14 +47,14 @@ public ChartDataset()
4747
public List<TData>? Data { get; set; }
4848

4949
/// <summary>
50-
/// Configures the visibility state of the dataset. Set it to <see langword="true"/>, to hide the dataset from the chart.
50+
/// Configure the visibility of the dataset. Setting <c>Hidden</c> to <c>true</c> will prevent the dataset from being rendered in the Chart.
5151
/// <para>
5252
/// Default value is <see langword="false"/>.
5353
/// </para>
5454
/// </summary>
5555
[AddedVersion("1.0.0")]
5656
[DefaultValue(false)]
57-
[Description("Configures the visibility state of the dataset. Set it to <code>true</code>, to hide the dataset from the chart.")]
57+
[Description("Configure the visibility of the dataset. Setting Hidden to true will prevent the dataset from being rendered in the Chart.")]
5858
public bool Hidden { get; set; }
5959

6060
/// <summary>
@@ -91,6 +91,9 @@ public ChartDataset()
9191
[Description("The drawing order of dataset. Also affects order for stacking, tooltip and legend.")]
9292
public int Order { get; set; }
9393

94+
//Parsing
95+
//https://www.chartjs.org/docs/latest/general/data-structures.html#dataset-configuration
96+
9497
//Stack
9598
//https://www.chartjs.org/docs/latest/general/data-structures.html#dataset-configuration
9699

0 commit comments

Comments
 (0)