Skip to content

Commit c103b1d

Browse files
gvreddy04gvreddy04
authored
API documentation + Code refactor (#9)
* API documentation + Code refactor
1 parent 94ce4ec commit c103b1d

42 files changed

Lines changed: 803 additions & 345 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎BlazorExpress.ChartJS.Demo.RCL/Components/Layout/MainLayout.razor.cs‎

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,36 @@ internal override IEnumerable<NavItem> GetNavItems()
88
{
99
new (){ Id = "1", Text = "Overview", Href = "/charts/overview", IconName = IconName.HouseDoorFill },
1010

11-
new (){ Id = "2", Text = "Getting Started", IconName = IconName.Palette2 },
12-
new (){ Id = "201", Text = "Blazor WebAssembly (.NET 8)", Href = "/charts/getting-started/blazor-webassembly-net-8", IconName = IconName.Palette2, ParentId = "2", Match = NavLinkMatch.All },
13-
new (){ Id = "202", Text = "Blazor WebApp Server (.NET 8)", Href = "/charts/getting-started/blazor-webapp-server-global-net-8", IconName = IconName.Palette2, ParentId = "2", Match = NavLinkMatch.All },
14-
new (){ Id = "202", Text = "Blazor WebApp Auto (.NET 8)", Href = "/charts/getting-started/blazor-webapp-auto-global-net-8", IconName = IconName.Palette2, ParentId = "2", Match = NavLinkMatch.All },
11+
new (){ Id = "2", Text = "Getting Started", IconName = IconName.Rulers },
12+
new (){ Id = "201", Text = "Blazor WebAssembly (.NET 8)", Href = "/charts/getting-started/blazor-webassembly-net-8", IconName = IconName.BrowserEdge, ParentId = "2" },
13+
new (){ Id = "202", Text = "Blazor WebApp Server (.NET 8)", Href = "/charts/getting-started/blazor-webapp-server-global-net-8", IconName = IconName.Pc, ParentId = "2", },
14+
new (){ Id = "202", Text = "Blazor WebApp Auto (.NET 8)", Href = "/charts/getting-started/blazor-webapp-auto-global-net-8", IconName = IconName.BrowserSafari, ParentId = "2" },
1515

1616
new (){ Id = "3", Text = "Bar Chart", IconName = IconName.BarChartLineFill },
17+
new (){ Id = "300", Text = "API Documentation", Href = "/charts/bar-chart/api-documentation", IconName = IconName.FileText, ParentId = "3", },
1718
new (){ Id = "301", Text = "Bar", Href = "/charts/bar-chart", IconName = IconName.BarChartLine, ParentId = "3", Match = NavLinkMatch.All },
18-
new (){ Id = "302", Text = "Horizontal", Href = "/charts/bar-chart/horizontal", IconName = IconName.BarChartLine, ParentId = "3", Match = NavLinkMatch.All },
19-
new (){ Id = "303", Text = "Stacked", Href = "/charts/bar-chart/stacked", IconName = IconName.BarChartLine, ParentId = "3", Match = NavLinkMatch.All },
20-
new (){ Id = "304", Text = "Data labels", Href = "/charts/bar-chart/data-labels", IconName = IconName.BarChartLine, ParentId = "3", Match = NavLinkMatch.All },
21-
new (){ Id = "305", Text = "Locale", Href = "/charts/bar-chart/locale", IconName = IconName.BarChartLine, ParentId = "3", Match = NavLinkMatch.All },
19+
new (){ Id = "302", Text = "Horizontal", Href = "/charts/bar-chart/horizontal", IconName = IconName.BarChartSteps, ParentId = "3", },
20+
new (){ Id = "303", Text = "Stacked", Href = "/charts/bar-chart/stacked", IconName = IconName.ViewStacked, ParentId = "3", },
21+
new (){ Id = "304", Text = "Data labels", Href = "/charts/bar-chart/data-labels", IconName = IconName.Bookmarks, ParentId = "3", },
22+
new (){ Id = "305", Text = "Locale", Href = "/charts/bar-chart/locale", IconName = IconName.Translate, ParentId = "3", },
2223

2324
new (){ Id = "4", Text = "Doughnut Chart", IconName = IconName.CircleFill, },
25+
new (){ Id = "400", Text = "API Documentation", Href = "/charts/doughnut-chart/api-documentation", IconName = IconName.FileText, ParentId = "4", },
2426
new (){ Id = "401", Text = "Doughnut", Href = "/charts/doughnut-chart", IconName = IconName.Circle, ParentId = "4", Match = NavLinkMatch.All },
25-
new (){ Id = "402", Text = "Data labels", Href = "/charts/doughnut-chart/doughnut-labels", IconName = IconName.Circle, ParentId = "4", Match = NavLinkMatch.All },
27+
new (){ Id = "402", Text = "Data labels", Href = "/charts/doughnut-chart/doughnut-labels", IconName = IconName.Bookmarks, ParentId = "4", Match = NavLinkMatch.All },
2628

2729
new (){ Id = "5", Text = "Line Chart", IconName = IconName.GraphUpArrow },
28-
new (){ Id = "500", Text = "Line", Href = "/charts/line-chart", IconName = IconName.GraphUp, ParentId = "5", Match = NavLinkMatch.All },
29-
new (){ Id = "500", Text = "Data labels", Href = "/charts/line-chart/data-labels", IconName = IconName.GraphUp, ParentId = "5", Match = NavLinkMatch.All },
30-
new (){ Id = "500", Text = "Tick configuration", Href = "/charts/line-chart/tick-configuration", IconName = IconName.GraphUp, ParentId = "5", Match = NavLinkMatch.All },
31-
new (){ Id = "500", Text = "Locale", Href = "/charts/line-chart/locale", IconName = IconName.GraphUp, ParentId = "5", Match = NavLinkMatch.All },
30+
new (){ Id = "500", Text = "API Documentation", Href = "/charts/line-chart/api-documentation", IconName = IconName.FileText, ParentId = "5", },
31+
new (){ Id = "501", Text = "Line", Href = "/charts/line-chart", IconName = IconName.GraphUp, ParentId = "5", Match = NavLinkMatch.All },
32+
new (){ Id = "502", Text = "Data labels", Href = "/charts/line-chart/data-labels", IconName = IconName.Bookmarks, ParentId = "5", Match = NavLinkMatch.All },
33+
new (){ Id = "503", Text = "Tick configuration", Href = "/charts/line-chart/tick-configuration", IconName = IconName.GearWideConnected, ParentId = "5", Match = NavLinkMatch.All },
34+
new (){ Id = "504", Text = "Locale", Href = "/charts/line-chart/locale", IconName = IconName.Translate, ParentId = "5", Match = NavLinkMatch.All },
3235

3336
new (){ Id = "6", Text = "Pie Chart", IconName = IconName.PieChartFill },
34-
new (){ Id = "600", Text = "Pie", Href = "/charts/pie-chart", IconName = IconName.PieChart, ParentId = "6", Match = NavLinkMatch.All },
35-
new (){ Id = "600", Text = "Data labels", Href = "/charts/pie-chart/data-labels", IconName = IconName.PieChart, ParentId = "6", Match = NavLinkMatch.All },
36-
new (){ Id = "600", Text = "Legend position", Href = "/charts/pie-chart/legend", IconName = IconName.PieChart, ParentId = "6", Match = NavLinkMatch.All },
37+
new (){ Id = "600", Text = "API Documentation", Href = "/charts/pie-chart/api-documentation", IconName = IconName.FileText, ParentId = "6", },
38+
new (){ Id = "601", Text = "Pie", Href = "/charts/pie-chart", IconName = IconName.PieChart, ParentId = "6", Match = NavLinkMatch.All },
39+
new (){ Id = "602", Text = "Data labels", Href = "/charts/pie-chart/data-labels", IconName = IconName.Bookmarks, ParentId = "6", Match = NavLinkMatch.All },
40+
new (){ Id = "603", Text = "Legend position", Href = "/charts/pie-chart/legend", IconName = IconName.Signpost, ParentId = "6", Match = NavLinkMatch.All },
3741
};
3842

3943
return navItems;

‎BlazorExpress.ChartJS.Demo.RCL/Components/Pages/BarCharts/BarChartDocumentation_00_API_Documentation.razor‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
@attribute [Route(pageUrl)]
2+
3+
<PageHeroSection PageUrl="@pageUrl"
4+
Title="@title"
5+
Heading="@heading"
6+
Description="@description"
7+
ImageUrl="@imageUrl" />
8+
9+
<img src="https://i.imgur.com/IX3bajc.png" class="img-fluid" alt="Blazor Bar Chart - API Documentation" />
10+
11+
<SectionHeading Size="HeadingSize.H4" Text="Parameters" PageUrl="@pageUrl" HashTagName="parameters" />
12+
<DocxTable TItem="BarChart" DocType="DocType.Parameters">
13+
<DocxTRow TItem="BarChart" PropertyName="@nameof(BarChart.Height)" DefaultValue="null" Required="false" Description="Gets or sets chart container height." AddedVersion="1.0.0" />
14+
<DocxTRow TItem="BarChart" PropertyName="@nameof(BarChart.HeightUnit)" PropertyType="Unit" DefaultValue="Unit.Px" Required="false" Description="Gets or sets chart container height unit of measure." AddedVersion="1.0.0" />
15+
<DocxTRow TItem="BarChart" PropertyName="@nameof(BarChart.Width)" DefaultValue="null" Required="false" Description="Gets or sets chart container width." AddedVersion="1.0.0" />
16+
<DocxTRow TItem="BarChart" PropertyName="@nameof(BarChart.WidthUnit)" PropertyType="Unit" DefaultValue="Unit.Px" Required="false" Description="Gets or sets chart container width unit of measure." AddedVersion="1.0.0" />
17+
</DocxTable>
18+
19+
<SectionHeading Size="HeadingSize.H4" Text="Methods" PageUrl="@pageUrl" HashTagName="methods" />
20+
<DocxTable TItem="BarChart" DocType="DocType.Methods">
21+
<DocxTRow TItem="BarChart" MethodName="AddDataAsync(ChartData chartData, string dataLabel, IChartDatasetData data)" ReturnType="Task<ChartData>" Description="Adds data to chart." AddedVersion="1.0.0" />
22+
<DocxTRow TItem="BarChart" MethodName="AddDataAsync(ChartData chartData, string dataLabel, IReadOnlyCollection<IChartDatasetData> data)" ReturnType="Task<ChartData>" Description="Adds dataset to chart." AddedVersion="1.0.0" />
23+
<DocxTRow TItem="BarChart" MethodName="AddDatasetAsync(ChartData chartData, IChartDataset chartDataset, IChartOptions chartOptions)" ReturnType="Task<ChartData>" Description="Adds dataset to chart." AddedVersion="1.10.0" />
24+
<DocxTRow TItem="BarChart" MethodName="InitializeAsync(ChartData chartData, IChartOptions chartOptions, string[]? plugins = null)" ReturnType="Task" Description="Initialize the chat." AddedVersion="1.0.0" />
25+
<DocxTRow TItem="BarChart" MethodName="ResizeAsync(int width, int height, Unit widthUnit = Unit.Px, Unit heightUnit = Unit.Px)" ReturnType="Task" Description="Resize the chart." AddedVersion="1.0.0" />
26+
<DocxTRow TItem="BarChart" MethodName="UpdateAsync(ChartData chartData, IChartOptions chartOptions)" ReturnType="Task" Description="Update the chart." AddedVersion="1.0.0" />
27+
</DocxTable>
28+
29+
<SectionHeading Size="HeadingSize.H4" Text="ChartData Members" PageUrl="@pageUrl" HashTagName="chartdata-Members" />
30+
<DocxTable TItem="ChartData" DocType="DocType.Properties">
31+
<DocxTRow TItem="ChartData" PropertyName="@nameof(ChartData.Datasets)" PropertyType="List<IChartDataset>" DefaultValue="null" Required="true" Description="Gets or sets the Datasets." AddedVersion="1.0.0" />
32+
<DocxTRow TItem="ChartData" PropertyName="@nameof(ChartData.Labels)" PropertyType="List<string>" DefaultValue="null" Required="true" Description="Gets or sets the Labels." AddedVersion="1.0.0" />
33+
</DocxTable>
34+
35+
<SectionHeading Size="HeadingSize.H4" Text="BarChartDataset Members" PageUrl="@pageUrl" HashTagName="barchart-dataset-members" />
36+
<BlazorBootstrap.Callout Color="CalloutColor.Info">
37+
<code>BarChartDataset</code> implements <code>IChartDataset</code>.
38+
</BlazorBootstrap.Callout>
39+
<DocxTable TItem="BarChartDataset" DocType="DocType.Properties">
40+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.BackgroundColor)" PropertyType="List<string>" DefaultValue="null" Required="false" Description="Get or sets the background color." AddedVersion="1.0.0" />
41+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.BarPercentage)" DefaultValue="0.8" Required="false" 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." AddedVersion="1.0.0" />
42+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.BorderColor)" PropertyType="List<string>" DefaultValue="null" Required="false" Description="Get or sets the border color." AddedVersion="1.0.0" />
43+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.BorderRadius)" DefaultValue="0" Required="false" Description="Gets or sets the border radius." AddedVersion="1.0.0" />
44+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.BorderWidth)" PropertyType="List<double>" DefaultValue="null" Required="false" Description="Gets or sets the border width." AddedVersion="1.0.0" />
45+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.CategoryPercentage)" DefaultValue="0.8" Required="false" Description="Percent (0-1) of the available width each category should be within the sample width." AddedVersion="1.0.0" />
46+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.Clip)" DefaultValue="null" Required="false" Description="How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: <code>clip: {left:5, top:false, right:-2, bottom:0}</code>" AddedVersion="1.0.0" />
47+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.Data)" PropertyType="List<double>" DefaultValue="null" Required="false" Description="Get or sets the Data." AddedVersion="1.0.0" />
48+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.Datalabels)" PropertyType="BarChartDatasetDataLabels" DefaultValue="" Required="false" Description="Get or sets the data labels" AddedVersion="1.0.0" />
49+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.Hidden)" DefaultValue="false" Required="false" Description=" Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart." AddedVersion="1.0.0" />
50+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.HoverBackgroundColor)" PropertyType="List<string>" DefaultValue="null" Required="true" Description="Get or sets the HoverBackgroundColor." AddedVersion="1.0.0" />
51+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.HoverBorderColor)" PropertyType="List<string>" DefaultValue="null" Required="true" Description="Get or sets the HoverBorderColor." AddedVersion="1.0.0" />
52+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.HoverBorderWidth)" PropertyType="List<string>" DefaultValue="null" Required="true" Description="Get or sets the HoverBorderWidth." AddedVersion="1.0.0" />
53+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.Label)" DefaultValue="null" Required="false" Description="The label for the dataset which appears in the legend and tooltips." AddedVersion="1.0.0" />
54+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.Type)" DefaultValue="null" Required="true" Description="Get or sets the chart type." AddedVersion="1.0.0" />
55+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.XAxisID)" DefaultValue="null" Required="false" Description="The ID of the x axis to plot this dataset on." AddedVersion="1.0.0" />
56+
<DocxTRow TItem="BarChartDataset" PropertyName="@nameof(BarChartDataset.YAxisID)" DefaultValue="null" Required="false" Description="The ID of the y axis to plot this dataset on." AddedVersion="1.0.0" />
57+
</DocxTable>
58+
59+
<SectionHeading Size="HeadingSize.H4" Text="BarChartDatasetDataLabels Members" PageUrl="@pageUrl" HashTagName="barchart-dataset-data-labels-members" />
60+
<DocxTable TItem="BarChartDatasetDataLabels" DocType="DocType.Properties">
61+
<DocxTRow TItem="BarChartDatasetDataLabels" PropertyName="@nameof(BarChartDatasetDataLabels.Alignment)" PropertyType="Alignment" DefaultValue="Alignment.Center" Required="false" Description="Gets or sets the align." AddedVersion="1.0.0" />
62+
<DocxTRow TItem="BarChartDatasetDataLabels" PropertyName="@nameof(BarChartDatasetDataLabels.Anchor)" PropertyType="Anchor" DefaultValue="Anchor.Center" Required="false" Description="Gets or sets the anchor." AddedVersion="1.0.0" />
63+
</DocxTable>
64+
65+
<SectionHeading Size="HeadingSize.H4" Text="BarChartOptions Members" PageUrl="@pageUrl" HashTagName="barchart-options-members" />
66+
<BlazorBootstrap.Callout Color="CalloutColor.Info">
67+
<code>BarChartOptions</code> implements <code>ChartOptions</code>.
68+
</BlazorBootstrap.Callout>
69+
<DocxTable TItem="BarChartOptions" DocType="DocType.Properties">
70+
<DocxTRow TItem="BarChartOptions" PropertyName="@nameof(BarChartOptions.IndexAxis)" DefaultValue="x" Required="false" Description="The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts." AddedVersion="1.0.0" />
71+
<DocxTRow TItem="BarChartOptions" PropertyName="@nameof(BarChartOptions.Interaction)" PropertyType="Interaction" DefaultValue="" Required="false" Description="Gets or sets the Interaction." AddedVersion="1.0.0" />
72+
<DocxTRow TItem="BarChartOptions" PropertyName="@nameof(BarChartOptions.Layout)" PropertyType="ChartLayout" DefaultValue="" Required="false" Description="Gets or sets the ChartLayout." AddedVersion="1.0.0" />
73+
<DocxTRow TItem="BarChartOptions" PropertyName="@nameof(BarChartOptions.Locale)" DefaultValue="null" Required="false" Description="Gets or sets the locale. By default, the chart is using the default locale of the platform which is running on." AddedVersion="1.0.0" />
74+
<DocxTRow TItem="BarChartOptions" PropertyName="@nameof(BarChartOptions.Plugins)" PropertyType="BarChartPlugins" DefaultValue="" Required="false" Description=" Gets or sets the Plugins." AddedVersion="1.0.0" />
75+
<DocxTRow TItem="BarChartOptions" PropertyName="@nameof(BarChartOptions.Responsive)" DefaultValue="false" Required="false" Description="Gets or sets the Responsive." AddedVersion="1.0.0" />
76+
<DocxTRow TItem="BarChartOptions" PropertyName="@nameof(BarChartOptions.Scales)" PropertyType="Scales" DefaultValue="" Required="false" Description="Gets or sets the Scales." AddedVersion="1.0.0" />
77+
</DocxTable>
78+
79+
@code {
80+
private const string pageUrl = "/charts/bar-chart/api-documentation";
81+
private const string title = "Blazor Bar Chart - API Documentation";
82+
private const string heading = "Blazor Bar Chart - API Documentation";
83+
private const string description = "This documentation provides a comprehensive reference for the Blazor Bar Chart component, guiding you through its functionalities and configuration options.";
84+
private const string imageUrl = "https://i.imgur.com/IX3bajc.png";
85+
}

0 commit comments

Comments
 (0)