[v0.5] API Changes #44
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jan 27, 2025
jentfoo
force-pushed
the
v0.5-dev
branch
5 times, most recently
from
3ab64e3 to
268dafe
Compare
This change matches other configuration where we accept bool pointers. Allowing the default (nil) to be able to be enabled or disabled depending on other configuration (specifically if the series is stacked). But also allowing a user to override this option and force a behavior.
Because of the horizontal layout two Y axis's do not make sense for this chart. Prior to this API change it would result in a confusing / bugged chart if a second Y-Axis is specified.
This commit updates the minimum supported go version to 1.18 so that we can include the use of generics. With that ability, the following functions have been replaced: * `True()` * `False()` * `BoolPointer()` * `FloatPointer()` Instead these are all done through the generic `Ptr` function as shown in the examples.
These two helper functions help make an easy conversion to the []float64 slice needed for our chart values.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes the changes for the future v0.5 release. Changes included for this release:
True(),False(),BoolPointer(bool), andFloatPointer(float64)have been replaced bycharts.PtrSeries.Label.Formatterwas replaced withSeries.Label.FormatTemplateSeries.Label.Positionwas replaced withSeriesLabelPositionon the chart Options struct (only bar and horizontal bar use this field)SeriesList.GetMinMaxwas removed, use the betterSeries.Summary()function.drawing.ColorFromRGBreplaced withcharts.ColorFromRGBA(supporting both formats now)drawingpackage had several functions expected to be unused externally that were removedLineChartOptions.FillAreais now a bool pointer, set withcharts.True()HorizontalBarChart.YAxisis now a single struct field instead of a slice. Only a single Y axis is supported on this chart. (previously in PR [v0.5] Horizontal Bar Chart: only accept a single Y Axis #40)Before merging we will describe all API changes on our version migration guide here: https://github.com/go-analyze/charts/wiki/Version-Migration-Guide