Skip to content
This repository has been archived by the owner on Apr 29, 2022. It is now read-only.

Commit

Permalink
Update readme, changelog and package info
Browse files Browse the repository at this point in the history
  • Loading branch information
Joelius300 committed Oct 9, 2019
1 parent efd6eae commit 04195fc
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 22 deletions.
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,31 @@
# Changelog
<details open="open">
<summary>0.10.4</summary>

* We updated everything to .NET Core 3 which means this library has no more preview dependencies.
* The issue with static assets has been resolved. The readme has been updated to include how you can include the static assets without copying.
* More special enums have been implemented for a more typesafe experience. Also some were renamed to their respective singular name.
* ChartTypes -> ChartType
* Positions -> Position
* AxisDisplay
* BorderAlign
* BorderCapStyle
* BorderJoinStyle
* CubicInterpolationMode
* FontStyle
* PointStyle
* ScaleBound
* We reworked the Tooltips which means it's now more complete (but there are still things missing like callbacks which may be implemented later on in the original repo) and it's also available for every chart-option.
* We reworked the bar-chart. There were some side-effects of this since the axes which were used for the line-chart.
* Move all Axes from the specific chart to the Common namespace. This affects line- and polar-area-charts.
* Some common classes like `SubTicks`, `Minor-` and `MajorTicks` have been moved around in the common namespace because there is now `Common.Axes` and `Common.Axes.Ticks`.
* Bar-charts accept all cartesian axes but there are some extra properties for bar-axes. For this reason there are specific axes for bar-charts in the `BarChart.Axes` namespace which derive from the cartesian axes.
* All Time related classes except for the `TimeAxis` and the `TimeTicks` were moved to `Common.Time`.
* Generally make more complete by adding new properties to axes and bar-charts. Lots of refactoring is also always something required in a rework.

</details>

<details>
<summary>0.10.3</summary>

* Remove unnecessary highlight.js
Expand Down
11 changes: 7 additions & 4 deletions ChartJs.Blazor/ChartJs.Blazor.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ Supports both client- and server-side projects. See the (soon to be existing) sa
Supports:
Line-Chart, Bar-Chart, Radar-Chart, Doughnut- and Pie-Chart, Bubble-Chart, Mixed-Chart, PolarArea-Chart.

Chart legend with custom handler for Item generation and events - Javascript and .Net handlers supported.</Description>
Chart legend with custom handler for Item generation and events - Javascript and .Net handlers supported.

Disclaimer: This is the last published Version. Further development will take place in the original repository at https://github.com/mariusmuntean/ChartJs.Blazor.
</Description>
<RepositoryUrl>https://github.com/Joelius300/ChartJSBlazor</RepositoryUrl>
<PackageProjectUrl>https://github.com/Joelius300/ChartJSBlazor</PackageProjectUrl>
<PackageTags>ChartJS; Blazor; ASP.Net-Core</PackageTags>
Expand All @@ -25,9 +28,9 @@ Chart legend with custom handler for Item generation and events - Javascript and
<AssemblyName>ChartJs.Blazor</AssemblyName>
<RootNamespace>ChartJs.Blazor</RootNamespace>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<Version>0.10.3-preview</Version>
<AssemblyVersion>0.10.3.0</AssemblyVersion>
<FileVersion>0.10.3.0</FileVersion>
<Version>0.10.4</Version>
<AssemblyVersion>0.10.4.0</AssemblyVersion>
<FileVersion>0.10.4.0</FileVersion>
<NeutralLanguage />
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<ApplicationIcon />
Expand Down
30 changes: 12 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,28 +23,22 @@ Since it has now become apparent that the old repo is not maintained anymore, th
## Changelog

### Latest changes
**0.10.3:**

* Remove unnecessary highlight.js
* Lots of XML-documentation improvements
* Lots of bug-fixes
* Make the canvas-id read-only
* Rename classes to comply with the consistent naming conventions. From XXChartYY to XXYY.
* Lots of general improvements (refactoring, remove redundancies, etc)
* Implement [indexable options](https://www.chartjs.org/docs/latest/general/options.html#indexable-options)
* Update to preview9
* Rework Pie-Chart
* Remove Doughnut-Chart
* Rework Polar-Area-Chart
**0.10.4:**

* Update to .NET Core 3.0
* Fix static assets issue (the issue was our description)
* Expand Tooltip-configuration and add them to all charts
* Rework bar-chart
* This had some side-effects regarding namespaces.

The detailed changelog can be found [here](https://github.com/Joelius300/ChartJSBlazor/blob/master/CHANGELOG.md).

#### How to update (breaking changes):
* Remove any assignment of the charts `CanvasId`. It will be handled automatically for you using a GUID string.
* Use pie-chart-classes anywhere you used dougnut chart and either manually set the `CutoutPercentage` to 50 or pass in `true` for the `PieOptions` constructor. It will yield the exact same results unless you have made manual changes to the chart.js-defaults using your own js.
* Many classes and properties have been removed, added, moved, renamed and more. You might have to add new using-directives and use the new class names. This is especially the case for the charts we've reworked (Pie (& Doughnut), Polar-Area, Line). Also a typo was fixed from `TimeTupel` to `TimeTuple`. The properties should all comply with the ones from chart.js written in PascalCase ([chart.js documentation](https://www.chartjs.org/docs/latest/)).
For more details take a look at the detailed changelog, the chart.js-docs and our samples.
* **If you aren't referencing the js-interop-file dynamically using `_content`, you need to copy the new file manually from [here](https://github.com/Joelius300/ChartJSBlazor/blob/master/ChartJs.Blazor/wwwroot/ChartJsInterop.js) (there were two bug fixes).**
* For any property that used a simple type like `string` or a very open type like `object`, there might be new enum for that which allows for type-safe customization. Check those, many of them should yield compiler errors anyway.
* Correctly include the static assets (see the usage section below) since it wasn't described correctly before.
* If you used any time related classes except for the axis and the ticks, you might need to include the namespace `Common.Time`.
* For line- and polar-area-charts the axes namespaces have been removed since they were actually common classes. They have been moved to `Common.Axes` and `Common.Axes.Ticks`. Check if you need to include/remove certain namespaces.
* Since some properties on the `BarOptions` were in the wrong place, they were removed. You can use those again (and they will now actually work) if you specify them in an Axis from the `BarChart.Axes` namespace.

## Please keep in mind that this is still a preview. Expect breaking changes during the next releases. We're reworking all the charts because most of them contain errors and inconsistencies.

Expand Down

0 comments on commit 04195fc

Please sign in to comment.