Skip to content

Commit 3a27b12

Browse files
committed
Update documentation and descriptions in Razor and C# files
Replaced "JetBrains Rider" with "Other" in the prerequisites of several Razor files to broaden IDE acceptance. Enhanced comments and descriptions in `BarChartDataset.cs` for clarity, including rephrasing and reordering for better readability. Added links to relevant documentation to improve usability and guidance for users. NOTE: This commit message is auto-generated using GitHub Copilot.
1 parent 46ba5ca commit 3a27b12

4 files changed

Lines changed: 63 additions & 44 deletions

File tree

BlazorExpress.ChartJS.Demo.RCL/Pages/Docs/GettingStarted/net8/GettingStarted_01_NET_8_WebAssembly_Documentation.razor

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<Block>
1515
<ul>
1616
<li>.NET 8 SDK (<a href="https://dotnet.microsoft.com/download/dotnet/8.0" target="_blank">Download</a>) or later version</li>
17-
<li>Visual Studio 2022 or later / VS Code / JetBrains Rider</li>
17+
<li>Visual Studio 2022 or later / VS Code / Other</li>
1818
<li>Basic knowledge of Blazor WebAssembly</li>
1919
</ul>
2020
</Block>

BlazorExpress.ChartJS.Demo.RCL/Pages/Docs/GettingStarted/net8/GettingStarted_02_NET_8_WebApp_Server_Documentation.razor

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<Block>
1515
<ul>
1616
<li>.NET 8 SDK (<a href="https://dotnet.microsoft.com/download/dotnet/8.0" target="_blank">Download</a>) or later version</li>
17-
<li>Visual Studio 2022 or later / VS Code / JetBrains Rider</li>
17+
<li>Visual Studio 2022 or later / VS Code / Other</li>
1818
<li>Basic knowledge of Blazor WebAssembly</li>
1919
</ul>
2020
</Block>

BlazorExpress.ChartJS.Demo.RCL/Pages/Docs/GettingStarted/net8/GettingStarted_03_NET_8_WebApp_Auto_Documentation.razor

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<h2>Prerequisites</h2>
1414
<ul>
1515
<li>.NET 8 SDK (<a href="https://dotnet.microsoft.com/download/dotnet/8.0" target="_blank">Download</a>)</li>
16-
<li>Visual Studio 2022 (v17.8 or later) / VS Code / JetBrains Rider</li>
16+
<li>Visual Studio 2022 (v17.8 or later) / VS Code / Other</li>
1717
<li>Basic knowledge of Blazor WebApp (Interactive Render Mode: Auto)</li>
1818
</ul>
1919

BlazorExpress.ChartJS/Models/ChartDataset/BarChart/BarChartDataset.cs

Lines changed: 60 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,23 @@
33
/// <summary>
44
/// The bar chart allows a number of properties to be specified for each dataset.
55
/// These are used to set display properties for a specific dataset.
6-
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#dataset-properties" />
7-
/// <seealso href="https://www.chartjs.org/docs/latest/charts/bar.html#general" />
6+
/// <para>
7+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#general" />
8+
/// </para>
9+
/// <para>
10+
/// <seealso href="https://www.chartjs.org/docs/latest/charts/bar.html#dataset-properties" />
11+
/// </para>
812
/// </summary>
913
public class BarChartDataset : ChartDataset<double?>
1014
{
1115
#region Properties, Indexers
1216

1317
/// <summary>
14-
/// Gets or sets the bar background color.
18+
/// The bar background color.
1519
/// <para>
16-
/// Default value is <c>rgba(0, 0, 0, 0.1)</c>.
20+
/// Default value is rgba(0, 0, 0, 0.1).
1721
/// </para>
22+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#styling" />
1823
/// </summary>
1924
[AddedVersion("1.0.0")]
2025
[DefaultValue("rgba(0, 0, 0, 0.1)")]
@@ -24,80 +29,88 @@ public class BarChartDataset : ChartDataset<double?>
2429
public List<string>? BackgroundColor { get; set; }
2530

2631
/// <summary>
27-
/// Gets or sets the percent (0-1) of the available width each bar should be within the category width.
32+
/// Percent (0-1) of the available width each bar should be within the category width.
2833
/// 1.0 will take the whole category width and put the bars right next to each other.
2934
/// <para>
3035
/// Default value is 0.9.
3136
/// </para>
37+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#barpercentage" />
3238
/// </summary>
3339
[AddedVersion("1.0.0")]
3440
[DefaultValue(0.9)]
35-
[Description("Gets or sets the percent (0-1) of the available width each bar should be within the category width.")]
41+
[Description("Percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.")]
3642
public double BarPercentage { get; set; } = 0.9;
3743

3844
/// <summary>
39-
/// Gets or sets the width of each bar, in pixels. When this is enforced, barPercentage and categoryPercentage are ignored.
45+
/// If this value is a number, it is applied to the width of each bar, in pixels.
46+
/// When this is enforced, <see cref="BarPercentage" /> and <see cref="CategoryPercentage" /> are ignored.
4047
/// <para>
4148
/// Default value is <see langword="null" />.
4249
/// </para>
50+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#barthickness" />
4351
/// </summary>
4452
[AddedVersion("1.0.0")]
4553
[DefaultValue(null)]
46-
[Description("Gets or sets the width of each bar, in pixels. When this is enforced, barPercentage and categoryPercentage are ignored.")]
54+
[Description("Gets or sets the width of each bar, in pixels. When this is enforced, <code>BarPercentage</code> and <code>CategoryPercentage</code> are ignored.")]
4755
[ParameterTypeName("double?")]
4856
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
4957
public double? BarThickness { get; set; }
5058

5159
/// <summary>
52-
/// Gets or sets the bar border color.
60+
/// The bar border color.
5361
/// <para>
54-
/// Default value is <c>rgba(0, 0, 0, 0.1)</c>.
62+
/// Default value is rgba(0, 0, 0, 0.1).
5563
/// </para>
64+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#styling" />
5665
/// </summary>
5766
[AddedVersion("1.0.0")]
5867
[DefaultValue("rgba(0, 0, 0, 0.1)")]
59-
[Description("Gets or sets the bar border color.")]
68+
[Description("The bar border color.")]
6069
[ParameterTypeName("List<string>?")]
6170
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
6271
public List<string>? BorderColor { get; set; }
6372

6473
/// <summary>
65-
/// Gets or sets the border radius.
74+
/// The bar border radius (in pixels).
6675
/// <para>
6776
/// Default value is 0.
6877
/// </para>
78+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#styling" />
6979
/// </summary>
7080
[AddedVersion("1.0.0")]
7181
[DefaultValue(0)]
72-
[Description("Gets or sets the border radius.")]
82+
[Description("The bar border radius (in pixels).")]
7383
[ParameterTypeName("List<double>?")]
7484
public List<double>? BorderRadius { get; set; }
7585

86+
//BorderSkipped
87+
//https://www.chartjs.org/docs/latest/charts/bar.html#styling
88+
//https://www.chartjs.org/docs/latest/api/interfaces/BarControllerDatasetOptions.html#borderskipped
89+
7690
/// <summary>
77-
/// Gets or sets the border width (in pixels).
91+
/// The bar border width (in pixels).
7892
/// <para>
7993
/// Default value is 0.
8094
/// </para>
95+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#styling" />
8196
/// </summary>
8297
[AddedVersion("1.0.0")]
8398
[DefaultValue(0)]
84-
[Description("Gets or sets the border width (in pixels).")]
99+
[Description("The bar border width (in pixels).")]
85100
[ParameterTypeName("List<double>?")]
86101
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
87102
public List<double>? BorderWidth { get; set; }
88103

89-
//BorderSkipped
90-
//https://www.chartjs.org/docs/latest/api/interfaces/BarControllerDatasetOptions.html#borderskipped
91-
92104
/// <summary>
93-
/// Gets or sets the percent (0-1) of the available width each category should be within the sample width.
105+
/// Percent (0-1) of the available width each category should be within the sample width.
94106
/// <para>
95107
/// Default value is 0.8.
96108
/// </para>
109+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#categorypercentage" />
97110
/// </summary>
98111
[AddedVersion("1.0.0")]
99112
[DefaultValue(0.8)]
100-
[Description("Gets or sets the percent (0-1) of the available width each category should be within the sample width.")]
113+
[Description("Percent (0-1) of the available width each category should be within the sample width.")]
101114
public double CategoryPercentage { get; set; } = 0.8;
102115

103116
/// <summary>
@@ -114,80 +127,83 @@ public class BarChartDataset : ChartDataset<double?>
114127
public BarChartDatasetDataLabels Datalabels { get; set; } = new();
115128

116129
/// <summary>
117-
/// Gets or sets a value indicating whether the bars should be grouped on the index axis.
118-
/// When <see langword="true" />, all the datasets at the same index value will be placed next to each other centering on that index value.
119-
/// When <see langword="false" />, each bar is placed on its actual index-axis value.
130+
/// Should the bars be grouped on index axis.
131+
/// When true, all the datasets at same index value will be placed next to each other centering on that index value.
132+
/// When false, each bar is placed on its actual index-axis value.
120133
/// <para>
121134
/// Default value is <see langword="true" />.
122135
/// </para>
123136
/// </summary>
124137
[AddedVersion("1.0.0")]
125138
[DefaultValue(true)]
126-
[Description("Gets or sets a value indicating whether the bars should be grouped on the index axis.")]
139+
[Description("Should the bars be grouped on index axis. When <b>true</b>, all the datasets at same index value will be placed next to each other centering on that index value. When <b>false</b>, each bar is placed on its actual index-axis value.")]
127140
public bool Grouped { get; set; } = true;
128141

129142
/// <summary>
130-
/// Gets or sets the bar background color when hovered.
143+
/// The bar background color when hovered.
131144
/// <para>
132145
/// Default value is <see langword="null" />.
133146
/// </para>
147+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#interactions" />
134148
/// </summary>
135149
[AddedVersion("1.0.0")]
136150
[DefaultValue(null)]
137-
[Description("Gets or sets the bar background color when hovered.")]
151+
[Description("The bar background color when hovered.")]
138152
[ParameterTypeName("List<string>?")]
139153
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
140154
public List<string>? HoverBackgroundColor { get; set; }
141155

142156
/// <summary>
143-
/// Gets or sets the bar border color when hovered.
157+
/// The bar border color when hovered.
144158
/// <para>
145159
/// Default value is <see langword="null" />.
146160
/// </para>
161+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#interactions" />
147162
/// </summary>
148163
[AddedVersion("1.0.0")]
149164
[DefaultValue(null)]
150-
[Description("Gets or sets the bar border color when hovered.")]
165+
[Description("The bar border color when hovered.")]
151166
[ParameterTypeName("List<string>?")]
152167
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
153168
public List<string>? HoverBorderColor { get; set; }
154169

155170
/// <summary>
156-
/// Gets or sets the bar border radius when hovered (in pixels).
171+
/// The bar border radius when hovered (in pixels).
157172
/// <para>
158173
/// Default value is 0.
159174
/// </para>
175+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#interactions" />
160176
/// </summary>
161177
[AddedVersion("1.0.0")]
162178
[DefaultValue(0)]
163-
[Description("Gets or sets the bar border radius when hovered (in pixels).")]
179+
[Description("The bar border radius when hovered (in pixels).")]
164180
[ParameterTypeName("List<double>?")]
165181
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
166182
public List<double>? HoverBorderRadius { get; set; }
167183

168184
/// <summary>
169-
/// Gets or sets the bar border width when hovered (in pixels).
185+
/// The bar border width when hovered (in pixels).
170186
/// <para>
171187
/// Default value is 1.
172188
/// </para>
189+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#interactions" />
173190
/// </summary>
174191
[AddedVersion("1.0.0")]
175192
[DefaultValue(1)]
176-
[Description("Gets or sets the bar border width when hovered (in pixels).")]
193+
[Description("The bar border width when hovered (in pixels).")]
177194
[ParameterTypeName("List<double>?")]
178195
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
179196
public List<double>? HoverBorderWidth { get; set; }
180197

181198
/// <summary>
182-
/// Gets or sets the base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.
183-
/// Supported values are 'x' and 'y'.
199+
/// The base axis of the dataset. 'x' for vertical bars and 'y' for horizontal bars.
184200
/// <para>
185-
/// Default value is <see langword="null" />.
201+
/// Default value is 'x'.
186202
/// </para>
187203
/// </summary>
188204
[AddedVersion("1.0.0")]
189-
[DefaultValue(null)]
190-
[Description("Gets or sets the base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts. Supported values are 'x' and 'y'.")]
205+
[DefaultValue("x")]
206+
[Description("The base axis of the dataset. 'x' for vertical bars and 'y' for horizontal bars.")]
191207
[ParameterTypeName("string?")]
192208
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
193209
public string? IndexAxis { get; set; }
@@ -196,32 +212,35 @@ public class BarChartDataset : ChartDataset<double?>
196212
//https://www.chartjs.org/docs/latest/charts/bar.html#inflateamount
197213

198214
/// <summary>
199-
/// Gets or sets the maximum bar thickness to ensure that bars are not sized thicker than this.
215+
/// Set this to ensure that bars are not sized thicker than this.
200216
/// <para>
201217
/// Default value is <see langword="null" />.
202218
/// </para>
219+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#maxbarthickness" />
203220
/// </summary>
204221
[AddedVersion("1.0.0")]
205222
[DefaultValue(null)]
206-
[Description("Gets or sets the maximum bar thickness to ensure that bars are not sized thicker than this.")]
223+
[Description("Set this to ensure that bars are not sized thicker than this.")]
207224
[ParameterTypeName("double?")]
208225
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
209226
public double? MaxBarThickness { get; set; }
210227

211228
/// <summary>
212-
/// Gets or sets the minimum bar length in pixels.
229+
/// Set this to ensure that bars have a minimum length in pixels.
213230
/// <para>
214231
/// Default value is <see langword="null" />.
215232
/// </para>
233+
/// <see href="https://www.chartjs.org/docs/latest/charts/bar.html#styling" />
216234
/// </summary>
217235
[AddedVersion("1.0.0")]
218236
[DefaultValue(null)]
219-
[Description("Gets or sets the minimum bar length in pixels.")]
237+
[Description("Set this to ensure that bars have a minimum length in pixels.")]
220238
[ParameterTypeName("double?")]
221239
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
222240
public double? MinBarLength { get; set; }
223241

224242
//PointStyle
243+
//https://www.chartjs.org/docs/latest/charts/bar.html#styling
225244
//https://www.chartjs.org/docs/latest/configuration/elements.html#point-styles
226245

227246
/// <summary>

0 commit comments

Comments
 (0)