Config API updates and improved go docs #5
Merged
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.
These changes are designed to improve consistency and simplicity of chart configuration.
General Changes
Type
has been renamed toOutputFormat
, this better describes the format that you want the chart rendered to.TrueFlag()
andFlaseFlag()
have been renamed to justTrue()
andFalse()
NewFloatPoint(float64)
has been renamed toFloatPointer
Option
in their name have had theOption
removed. This makes names more concise, and forYAxisOptions
renaming toYAxis
made it more consistent when compared toXAxis
.Axis-Specific Changes
YAxis
as mentioned above.FirstAxis
has been renamed to the more descriptiveDataStartIndex
StrokeColor
andSplitLineColor
has been removed (as mentioned above, theme is now used). You can useWithAxisColor(Color)
to easily change an existing theme to a different axis color. We plan to improve this API further.Color
has been renamed to the more descriptiveAxisColor
. Depending on how easy we can make theme adjustments this field may be deprecated. It is preferred to modify the theme usingWithAxisColor(Color)
.Chart-Specific Changes
Opacity
has been renamed to the more descriptiveFillOpacity
(avoid confusion with other shading opacity)Column
andRow
were made plural intoColumns
andRows
Padding
was renamed to the more descriptiveCellPadding
(avoid confusion with chart padding).