examples/

go-analyze/charts Examples

Examples are our primary method for demonstrating the starting point our use and configuration. Find an example close to your use case and use it as a starting place to find the relevant API's. Our API's include godocs, review the descriptions of each field to understand possible options.

Our library offers two primary ways to configure charts:

1. The "Painter API" allows you to initialize a "Painter" using NewPainter, then build chart configuration structs and apply them with function calls on the Painter. This API is designed to be easy to learn and navigate, with fields being named and formed to be natural for the chart type.
2. Also offered is ChartOption, which is built providing functions to modify the very generic chart struct. This API can be useful when representing the same data, and similar chart configuration, but changing the chart types.

For most use cases the Painter API is recommended. In our examples we demonstrate rendering chart types using both methods, see either examples in the 1-Painter directory or 2-OptionFun.

Painter API Example List

• bar_chart-1-basic - Basic bar chart.
• bar_chart-2-size_margin - Showing the visual impact of different bar sizes and margins.
• bar_chart-3-label_position-round_caps - Showing the different label positions and rounded caps.
• bar_chart-4-mark - Bar chart with included mark points and mark lines.
• bar_chart-5-stacked - A bar chart with "Stacked" series enabled, collapsing the bars into a single layered bar.
• funnel_chart-1-basic - Basic funnel chart.
• heat_map_chart-1-basic - Basic heat map chart.
• horizontal_bar_chart-1-basic - Basic horizontal bar chart.
• horizontal_bar_chart-2-size_margin - Showing the visual impact of different bar sizes and margins.
• horizontal_bar_chart-3-mark - Horizontal bar chart with included mark lines.
• horizontal_bar_chart-4-stacked - A horizontal bar chart with "Stacked" series, collapsing the bars into a single layered bar.
• line_chart-1-basic - Basic line chart with some simple styling changes and a demonstration of null values.
• line_chart-2-symbols - Basic line chart which sets a different symbol for each series item.
• line_chart-3-smooth - Basic line chart with thick smooth lines drawn.
• line_chart-4-mark - Line chart with included mark points and mark lines.
• line_chart-5-area - Line chart with the area below the line shaded.
• line_chart-6-stacked - Line chart with "Stacked" series enabled, making each series a layer on the chart and the top line showing the sum.
• line_chart-7-boundary_gap - Showing the visual difference on the line chart of enabling or disabling the x-axis boundary gap.
• line_chart-8-dual_y_axis - Basic line chart with two series, one rendered to the left axis and one to a second y axis on the right.
• line_chart-9-custom - Line chart with dense data and most default rendering disabled, instead rendering labels manually on the Painter.
• multiple_charts-1 - Example of manually building a painter so that you can render 4 charts on the same image.
• multiple_charts-2 - Shows how to use a single set of data and demonstrate it with multiple chart types.
• pie_chart-1-basic - Pie chart with a variety of customization demonstrated including positioning the legend in the bottom right corner.
• pie_chart-2-radius - Pie chart which varies the series radius by the percentage of the series.
• radar_chart-1-basic - Basic radar chart.
• scatter_chart-1-basic - Basic scatter chart with some simple styling changes and a demonstration of null values.
• scatter_chart-2-symbols - Basic scatter chart showing per-series symbols.
• scatter_chart-3-dense_data - Scatter chart with dense data, trend lines, and more custom styling configured.
• table-1 - Table with a variety of table specific configuration and styling demonstrated.

ChartOption / OptionFunc Example List

• bar_chart-1-basic - Bar chart with included mark points and mark lines.
• chinese - Line chart with chinese characters that uses a custom font (must be downloaded by user, see comment in code).
• funnel_chart-1-basic - Basic funnel chart.
• horizontal_bar_chart-1-basic - Basic horizontal bar chart.
• line_chart-1-basic - Basic line chart with some simple styling changes and a demonstration of null values.
• line_chart-2-dense_data - Line chart with dense data and more custom styling configured.
• line_chart-3-area - Line chart with the area below the line shaded.
• multiple_charts-1 - Combining two charts together by writting one chart over the other.
• multiple_charts-2 - An alternative API for overlaying two charts together in the same image.
• pie_chart-1-basic - Pie chart with a variety of customization demonstrated including positioning the legend in the bottom right corner.
• radar_chart-1-basic - Basic radar chart.
• scatter_chart-1-basic - Basic scatter chart with some simple styling changes and a demonstration of null values.
• table-1 - Table with a variety of table specific configuration and styling demonstrated.
• web-1 - Hosts an example http server which will render the charts to the web page.

chartdraw/examples

The examples in the root examples directory serves as our primary examples. These examples are the best representation of our library and what we are aiming to support and improve. If you're intereted in exploring the underline chartdraw implementation you can also check out chartdraw/examples. These are examples from the implementation based off wcharczuk/go-chart. These examples illustrate an alternative styling, which over time we aim to merge and unify with our charts package API.

If you find you prefer the chartdraw styling, configuration schema, or anything else, please open an Issue so that we can make sure we retain the best of both implementations as we seek unifying our API.