Skip to content

Commit ea70b55

Browse files
gvreddy04gvreddy04
committed
Add chart events docs and enhance chart property metadata
Updated documentation for all chart components to include "Events" and "ChartClickEventArgs Properties" sections. Enhanced BlazorBootstrapChart property metadata with [AddedVersion], [DefaultValue], and [Description] attributes for Height, HeightUnit, Width, and WidthUnit. Improved remarks to clarify default values.
1 parent aff1918 commit ea70b55

8 files changed

Lines changed: 70 additions & 2 deletions

File tree

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Charts/BarCharts/BarChart_Doc_01_Documentation.razor‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@
2222
<DocxTable TItem="BarChart" DocType="DocType.Methods" />
2323
</Section>
2424

25+
<Section Class="p-0" Size="HeadingSize.H3" Name="BarChart Events" PageUrl="@pageUrl" Link="bar-chart-events">
26+
<DocxTable TItem="BarChart" DocType="DocType.Events" />
27+
</Section>
28+
29+
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartClickEventArgs Properties" PageUrl="@pageUrl" Link="chart-click-event-args-properties">
30+
<DocxTable TItem="ChartClickEventArgs" DocType="DocType.Properties" />
31+
</Section>
32+
2533
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartData Properties" PageUrl="@pageUrl" Link="chart-data-properties">
2634
<DocxTable TItem="ChartData" DocType="DocType.Properties" />
2735
</Section>

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Charts/DoughnutCharts/DoughnutChart_Doc_01_Documentation.razor‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@
2222
<DocxTable TItem="DoughnutChart" DocType="DocType.Methods" />
2323
</Section>
2424

25+
<Section Class="p-0" Size="HeadingSize.H3" Name="DoughnutChart Events" PageUrl="@pageUrl" Link="doughnut-chart-events">
26+
<DocxTable TItem="DoughnutChart" DocType="DocType.Events" />
27+
</Section>
28+
29+
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartClickEventArgs Properties" PageUrl="@pageUrl" Link="chart-click-event-args-properties">
30+
<DocxTable TItem="ChartClickEventArgs" DocType="DocType.Properties" />
31+
</Section>
32+
2533
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartData Properties" PageUrl="@pageUrl" Link="chart-data-properties">
2634
<DocxTable TItem="ChartData" DocType="DocType.Properties" />
2735
</Section>

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Charts/LineCharts/LineChart_Doc_01_Documentation.razor‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@
2222
<DocxTable TItem="LineChart" DocType="DocType.Methods" />
2323
</Section>
2424

25+
<Section Class="p-0" Size="HeadingSize.H3" Name="LineChart Events" PageUrl="@pageUrl" Link="line-chart-events">
26+
<DocxTable TItem="LineChart" DocType="DocType.Events" />
27+
</Section>
28+
29+
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartClickEventArgs Properties" PageUrl="@pageUrl" Link="chart-click-event-args-properties">
30+
<DocxTable TItem="ChartClickEventArgs" DocType="DocType.Properties" />
31+
</Section>
32+
2533
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartData Properties" PageUrl="@pageUrl" Link="chart-data-properties">
2634
<DocxTable TItem="ChartData" DocType="DocType.Properties" />
2735
</Section>

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Charts/PieCharts/PieChart_Doc_01_Documentation.razor‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@
2222
<DocxTable TItem="PieChart" DocType="DocType.Methods" />
2323
</Section>
2424

25+
<Section Class="p-0" Size="HeadingSize.H3" Name="PieChart Events" PageUrl="@pageUrl" Link="pie-chart-events">
26+
<DocxTable TItem="PieChart" DocType="DocType.Events" />
27+
</Section>
28+
29+
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartClickEventArgs Properties" PageUrl="@pageUrl" Link="chart-click-event-args-properties">
30+
<DocxTable TItem="ChartClickEventArgs" DocType="DocType.Properties" />
31+
</Section>
32+
2533
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartData Properties" PageUrl="@pageUrl" Link="chart-data-properties">
2634
<DocxTable TItem="ChartData" DocType="DocType.Properties" />
2735
</Section>

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Charts/PolarAreaCharts/PolarAreaChart_Doc_01_Documentation.razor‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@
2222
<DocxTable TItem="PolarAreaChart" DocType="DocType.Methods" />
2323
</Section>
2424

25+
<Section Class="p-0" Size="HeadingSize.H3" Name="PolarAreaChart Events" PageUrl="@pageUrl" Link="polar-area-chart-events">
26+
<DocxTable TItem="PolarAreaChart" DocType="DocType.Events" />
27+
</Section>
28+
29+
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartClickEventArgs Properties" PageUrl="@pageUrl" Link="chart-click-event-args-properties">
30+
<DocxTable TItem="ChartClickEventArgs" DocType="DocType.Properties" />
31+
</Section>
32+
2533
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartData Properties" PageUrl="@pageUrl" Link="chart-data-properties">
2634
<DocxTable TItem="ChartData" DocType="DocType.Properties" />
2735
</Section>

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Charts/RadarCharts/RadarChart_Doc_01_Documentation.razor‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@
2222
<DocxTable TItem="RadarChart" DocType="DocType.Methods" />
2323
</Section>
2424

25+
<Section Class="p-0" Size="HeadingSize.H3" Name="RadarChart Events" PageUrl="@pageUrl" Link="radar-chart-events">
26+
<DocxTable TItem="RadarChart" DocType="DocType.Events" />
27+
</Section>
28+
29+
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartClickEventArgs Properties" PageUrl="@pageUrl" Link="chart-click-event-args-properties">
30+
<DocxTable TItem="ChartClickEventArgs" DocType="DocType.Properties" />
31+
</Section>
32+
2533
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartData Properties" PageUrl="@pageUrl" Link="chart-data-properties">
2634
<DocxTable TItem="ChartData" DocType="DocType.Properties" />
2735
</Section>

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Charts/ScatterCharts/ScatterChart_Doc_01_Documentation.razor‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,14 @@
2222
<DocxTable TItem="ScatterChart" DocType="DocType.Methods" />
2323
</Section>
2424

25+
<Section Class="p-0" Size="HeadingSize.H3" Name="ScatterChart Events" PageUrl="@pageUrl" Link="scatter-chart-events">
26+
<DocxTable TItem="ScatterChart" DocType="DocType.Events" />
27+
</Section>
28+
29+
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartClickEventArgs Properties" PageUrl="@pageUrl" Link="chart-click-event-args-properties">
30+
<DocxTable TItem="ChartClickEventArgs" DocType="DocType.Properties" />
31+
</Section>
32+
2533
<Section Class="p-0" Size="HeadingSize.H3" Name="ChartData Properties" PageUrl="@pageUrl" Link="chart-data-properties">
2634
<DocxTable TItem="ChartData" DocType="DocType.Properties" />
2735
</Section>

‎blazorbootstrap/Components/Charts/BlazorBootstrapChart.cs‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,11 @@ private object GetChartDataObject(ChartData chartData)
214214
/// To change the unit of measure see <see cref="HeightUnit" />.
215215
/// </summary>
216216
/// <remarks>
217-
/// Default value is null.
217+
/// Default value is <see langword="null"/>.
218218
/// </remarks>
219+
[AddedVersion("1.0.0")]
220+
[DefaultValue(null)]
221+
[Description("Gets or sets chart container height. The default unit of measure is <code>Unit.Px</code>. To change the unit of measure see <b>HeightUnit</b>.")]
219222
[Parameter]
220223
public int? Height { get; set; }
221224

@@ -225,6 +228,9 @@ private object GetChartDataObject(ChartData chartData)
225228
/// <remarks>
226229
/// Default value is <see cref="Unit.Px" />.
227230
/// </remarks>
231+
[AddedVersion("1.0.0")]
232+
[DefaultValue(Unit.Px)]
233+
[Description("Gets or sets chart container height unit of measure.")]
228234
[Parameter]
229235
public Unit HeightUnit { get; set; } = Unit.Px;
230236

@@ -234,8 +240,11 @@ private object GetChartDataObject(ChartData chartData)
234240
/// To change the unit of measure see <see cref="WidthUnit" />.
235241
/// </summary>
236242
/// <remarks>
237-
/// Default value is null.
243+
/// Default value is <see langword="null"/>.
238244
/// </remarks>
245+
[AddedVersion("1.0.0")]
246+
[DefaultValue(null)]
247+
[Description("Get or sets chart container width. The default unit of measure is <code>Unit.Px</code>. To change the unit of measure see <b>WidthUnit</b>.")]
239248
[Parameter]
240249
public int? Width { get; set; }
241250

@@ -245,6 +254,9 @@ private object GetChartDataObject(ChartData chartData)
245254
/// <remarks>
246255
/// Default value is <see cref="Unit.Px" />.
247256
/// </remarks>
257+
[AddedVersion("1.0.0")]
258+
[DefaultValue(Unit.Px)]
259+
[Description("Gets or sets chart container width unit of measure.")]
248260
[Parameter]
249261
public Unit WidthUnit { get; set; } = Unit.Px;
250262

0 commit comments

Comments
 (0)