func DegreesToRadians(degreesfloat64)float64

func FormatValueHumanize(valuefloat64, decimalsint, ensureTrailingZerosbool)string

func FormatValueHumanizeShort(valuefloat64, decimalsint, ensureTrailingZerosbool)string

func GetDefaultFont() *truetype.Font

func GetFont(fontFamilystring) *truetype.Font

func GetNullValue()float64

func InstallFont(fontFamilystring, data []byte)error

func InstallTheme(namestring, optThemeOption)

func IntSliceToFloat64(slice []int) []float64

func Ptr[Tany](val T) *T

func RadiansToDegrees(valuefloat64)float64

func RenderEChartsToJPG(optionsstring) ([]byte,error)

func RenderEChartsToPNG(optionsstring) ([]byte,error)

func RenderEChartsToSVG(optionsstring) ([]byte,error)

func SetDefaultChartDimensions(width, heightint)

func SetDefaultFont(fontFamilystring)error

func SetDefaultTheme(namestring)error

func SliceToFloat64[Tany](slice []T, conversion func(T)float64) []float64

type BarChartOption struct {// Theme specifies the colors used for the bar chart.ThemeColorPalette// Padding specifies the padding around the chart.PaddingBox// Deprecated: Font is deprecated, instead the font needs to be set on the SeriesLabel, or other specific elements.Font *truetype.Font// SeriesList provides the data population for the chart. Typically constructed using NewSeriesListBar.SeriesListBarSeriesList// StackSeries when *true renders series stacked within one bar.// This ignores some options including BarMargin and SeriesLabelPosition.// MarkLine only renders for the first series and stacking only applies to the first y-axis.StackSeries *bool// SeriesLabelPosition specifies the label position for the series: "top" or "bottom".SeriesLabelPositionstring// XAxis contains options for the x-axis.XAxisXAxisOption// YAxis contains options for the y-axis. At most two y-axes are supported.YAxis []YAxisOption// Title contains options for rendering the chart title.TitleTitleOption// Legend contains options for the data legend.LegendLegendOption// BarWidth specifies the width of each bar. May be reduced to fit all series on the chart.BarWidthint// TODO - v0.6 - Update to float64 to represent a precent// BarMargin specifies the margin between grouped bars. BarWidth takes priority over a set margin.BarMargin *float64// TODO - v0.6 - Update to be percent based// RoundedBarCaps when *true draws bars with rounded top corners.RoundedBarCaps *bool// ValueFormatter defines how float values are rendered to strings, notably for numeric axis labels.ValueFormatterValueFormatter}

funcNewBarChartOptionWithData¶added inv0.4.0

func NewBarChartOptionWithData(data [][]float64)BarChartOption

NewBarChartOptionWithData returns an initialized BarChartOption with the SeriesList set with the provided data slice.

funcNewBarChartOptionWithSeries¶added inv0.5.9

func NewBarChartOptionWithSeries(slBarSeriesList)BarChartOption

NewBarChartOptionWithSeries returns an initialized BarChartOption with the provided SeriesList.

type BarSeries struct {// Values provides the series data values.Values []float64// YAxisIndex is the index for the axis, it must be 0 or 1.YAxisIndexint// Label provides the series labels.LabelSeriesLabel// Name specifies a name for the series.Namestring// MarkPoint provides a configuration for mark points for this series. If Label is also enabled, the MarkPoint// will replace the label where rendered.MarkPointSeriesMarkPoint// MarkLine provides a configuration for mark lines for this series. When using a MarkLine, you will want to// configure padding to the chart on the right for the values.MarkLineSeriesMarkLine// contains filtered or unexported fields}

func (*BarSeries)Summary¶added inv0.5.0

func (b *BarSeries) Summary() populationSummary

type BarSeriesList []BarSeries

funcNewSeriesListBar¶added inv0.4.0

func NewSeriesListBar(values [][]float64, opts ...BarSeriesOption)BarSeriesList

NewSeriesListBar builds a SeriesList for a bar chart. The first dimension of the values indicates the populationof the data, while the second dimension provides the samples for the population (on the X-Axis).

func (BarSeriesList)SetSeriesLabels¶added inv0.5.6

func (bBarSeriesList) SetSeriesLabels(labelSeriesLabel)

SetSeriesLabels sets the label for all elements in the series.

func (BarSeriesList)SumSeries¶added inv0.5.0

func (bBarSeriesList) SumSeries() []float64

SumSeries returns a float64 slice with the sum of each series.

func (BarSeriesList)SumSeriesValues¶added inv0.5.0

func (bBarSeriesList) SumSeriesValues() []float64

SumSeriesValues returns a float64 slice with each series totaled by the value index.

func (BarSeriesList)ToGenericSeriesList¶added inv0.5.0

func (bBarSeriesList) ToGenericSeriesList()GenericSeriesList

type BarSeriesOption struct {LabelSeriesLabelNames     []stringMarkPointSeriesMarkPointMarkLineSeriesMarkLine}

type Box =chartdraw.Box

funcNewBox¶added inv0.4.6

func NewBox(left, top, right, bottomint)Box

NewBox returns a new Box with the specified left, top, right, and bottom values to define the position and dimensions.

funcNewBoxEqual¶added inv0.4.6

func NewBoxEqual(sizeint)Box

NewBoxEqual returns a new box with equal sizes to each side.

type CandlestickChartOption struct {// Theme specifies the colors used for the candlestick chart.ThemeColorPalette// Padding specifies the padding around the chart.PaddingBox// SeriesList provides the OHLC data population for the chart. Typically constructed using NewSeriesListCandlestick.SeriesListCandlestickSeriesList// XAxis contains options for the x-axis.XAxisXAxisOption// YAxis contains options for the y-axis. At most two y-axes are supported.YAxis []YAxisOption// Title contains options for rendering the chart title.TitleTitleOption// Legend contains options for the data legend.LegendLegendOption// CandleWidth sets body width ratio (0.0–1.0, default 0.8).CandleWidthfloat64// ShowWicks controls whether high-low wicks are displayed by default. When nil, wicks are shown.// Individual series can override this setting.ShowWicks *bool// WickWidth sets wick stroke width in pixels (default 1.0).WickWidthfloat64// CandleMargin sets inter-series spacing ratio (0.0–1.0, auto by default).// Only applies with multiple candlestick series.CandleMargin *float64// ValueFormatter formats numeric values.ValueFormatterValueFormatter}

funcNewCandlestickOptionWithData¶added inv0.5.17

func NewCandlestickOptionWithData(data ...[]OHLCData)CandlestickChartOption

NewCandlestickOptionWithData creates a CandlestickChartOption from OHLC data slices.

funcNewCandlestickOptionWithSeries¶added inv0.5.17

func NewCandlestickOptionWithSeries(series ...CandlestickSeries)CandlestickChartOption

NewCandlestickOptionWithSeries returns an initialized CandlestickChartOption with the provided Series.

type CandlestickPatternConfig struct {// PreferPatternLabels controls pattern/user label precedence// true = pattern labels have priority over user labels, false = user labels have priority over pattern labelsPreferPatternLabelsbool// PatternFormatter allows custom formatting, if nil, uses default formatting with theme colors.PatternFormatterPatternFormatter// EnabledPatterns lists specific patterns to detect// nil or empty = no patterns detected (PatternConfig must be set to enable)// Use With* methods to configure patternsEnabledPatterns []string// DojiThreshold is the body-to-range ratio threshold for doji pattern detection.// Default: 0.05 (5% - standard textbook definition)// A candlestick where the body is ≤5% of the total range is considered a doji.DojiThresholdfloat64// ShadowTolerance is the shadow-to-range ratio threshold for patterns requiring minimal shadows.// Used by marubozu patterns to determine acceptable shadow size.// Default: 0.01 (1% of range)ShadowTolerancefloat64// ShadowRatio is the minimum shadow-to-body ratio for patterns requiring long shadows.// Used by hammer, shooting star, and similar patterns.// Default: 2.0 (shadow must be at least 2x the body - standard textbook definition)ShadowRatiofloat64// EngulfingMinSize is the minimum size ratio for engulfing patterns.// The engulfing candle body must be at least this percentage of the engulfed candle body.// Default: 1.0 (100% - must completely engulf the previous body)EngulfingMinSizefloat64}

func (*CandlestickPatternConfig)MergePatterns¶added inv0.5.17

func (c *CandlestickPatternConfig) MergePatterns(other *CandlestickPatternConfig) *CandlestickPatternConfig

MergePatterns creates a new CandlestickPatternConfig by combining the enabled patterns config with another.It returns a union of both pattern sets with the current config taking precedence for other settings.

func (*CandlestickPatternConfig)WithDarkCloudCover¶added inv0.5.17

func (c *CandlestickPatternConfig) WithDarkCloudCover() *CandlestickPatternConfig

WithDarkCloudCover adds the dark cloud cover pattern.

func (*CandlestickPatternConfig)WithDoji¶added inv0.5.17

func (c *CandlestickPatternConfig) WithDoji() *CandlestickPatternConfig

WithDoji adds the doji pattern.

func (*CandlestickPatternConfig)WithDojiThreshold¶added inv0.5.17

func (c *CandlestickPatternConfig) WithDojiThreshold(thresholdfloat64) *CandlestickPatternConfig

WithDojiThreshold sets the doji threshold (default: 0.05).

func (*CandlestickPatternConfig)WithDragonfly¶added inv0.5.17

func (c *CandlestickPatternConfig) WithDragonfly() *CandlestickPatternConfig

WithDragonfly adds the dragonfly doji pattern.

func (*CandlestickPatternConfig)WithEngulfingBear¶added inv0.5.17

func (c *CandlestickPatternConfig) WithEngulfingBear() *CandlestickPatternConfig

WithEngulfingBear adds the bearish engulfing pattern.

func (*CandlestickPatternConfig)WithEngulfingBull¶added inv0.5.17

func (c *CandlestickPatternConfig) WithEngulfingBull() *CandlestickPatternConfig

WithEngulfingBull adds the bullish engulfing pattern.

func (*CandlestickPatternConfig)WithEngulfingMinSize¶added inv0.5.17

func (c *CandlestickPatternConfig) WithEngulfingMinSize(sizefloat64) *CandlestickPatternConfig

WithEngulfingMinSize sets the engulfing minimum size (default: 1.0).

func (*CandlestickPatternConfig)WithEveningStar¶added inv0.5.17

func (c *CandlestickPatternConfig) WithEveningStar() *CandlestickPatternConfig

WithEveningStar adds the evening star pattern.

func (*CandlestickPatternConfig)WithGravestone¶added inv0.5.17

func (c *CandlestickPatternConfig) WithGravestone() *CandlestickPatternConfig

WithGravestone adds the gravestone doji pattern.

func (*CandlestickPatternConfig)WithHammer¶added inv0.5.17

func (c *CandlestickPatternConfig) WithHammer() *CandlestickPatternConfig

WithHammer adds the hammer pattern.

func (*CandlestickPatternConfig)WithInvertedHammer¶added inv0.5.17

func (c *CandlestickPatternConfig) WithInvertedHammer() *CandlestickPatternConfig

WithInvertedHammer adds the inverted hammer pattern.

func (*CandlestickPatternConfig)WithMarubozuBear¶added inv0.5.17

func (c *CandlestickPatternConfig) WithMarubozuBear() *CandlestickPatternConfig

WithMarubozuBear adds the bearish marubozu pattern.

func (*CandlestickPatternConfig)WithMarubozuBull¶added inv0.5.17

func (c *CandlestickPatternConfig) WithMarubozuBull() *CandlestickPatternConfig

WithMarubozuBull adds the bullish marubozu pattern.

func (*CandlestickPatternConfig)WithMorningStar¶added inv0.5.17

func (c *CandlestickPatternConfig) WithMorningStar() *CandlestickPatternConfig

WithMorningStar adds the morning star pattern.

func (*CandlestickPatternConfig)WithPatternFormatter¶added inv0.5.17

func (c *CandlestickPatternConfig) WithPatternFormatter(formatterPatternFormatter) *CandlestickPatternConfig

WithPatternFormatter sets a custom pattern formatter.

func (*CandlestickPatternConfig)WithPatternsAll¶added inv0.5.17

func (c *CandlestickPatternConfig) WithPatternsAll() *CandlestickPatternConfig

WithPatternsAll enables all standard patterns.

func (*CandlestickPatternConfig)WithPatternsBearish¶added inv0.5.17

func (c *CandlestickPatternConfig) WithPatternsBearish() *CandlestickPatternConfig

WithPatternsBearish enables only bearish patterns.

func (*CandlestickPatternConfig)WithPatternsBullish¶added inv0.5.17

func (c *CandlestickPatternConfig) WithPatternsBullish() *CandlestickPatternConfig

WithPatternsBullish enables only bullish patterns.

func (*CandlestickPatternConfig)WithPatternsCore¶added inv0.5.17

func (c *CandlestickPatternConfig) WithPatternsCore() *CandlestickPatternConfig

WithPatternsCore enables only the most reliable patterns that work well without volume.

func (*CandlestickPatternConfig)WithPatternsReversal¶added inv0.5.17

func (c *CandlestickPatternConfig) WithPatternsReversal() *CandlestickPatternConfig

WithPatternsReversal enables only reversal patterns.

func (*CandlestickPatternConfig)WithPatternsTrend¶added inv0.5.17

func (c *CandlestickPatternConfig) WithPatternsTrend() *CandlestickPatternConfig

WithPatternsTrend enables only trend continuation patterns.

func (*CandlestickPatternConfig)WithPiercingLine¶added inv0.5.17

func (c *CandlestickPatternConfig) WithPiercingLine() *CandlestickPatternConfig

WithPiercingLine adds the piercing line pattern.

func (*CandlestickPatternConfig)WithPreferPatternLabels¶added inv0.5.17

func (c *CandlestickPatternConfig) WithPreferPatternLabels(preferbool) *CandlestickPatternConfig

WithPreferPatternLabels sets whether pattern labels have priority over user labels.

func (*CandlestickPatternConfig)WithShadowRatio¶added inv0.5.17

func (c *CandlestickPatternConfig) WithShadowRatio(ratiofloat64) *CandlestickPatternConfig

WithShadowRatio sets the shadow ratio (default: 2.0).

func (*CandlestickPatternConfig)WithShadowTolerance¶added inv0.5.17

func (c *CandlestickPatternConfig) WithShadowTolerance(tolerancefloat64) *CandlestickPatternConfig

WithShadowTolerance sets the shadow tolerance (default: 0.01).

func (*CandlestickPatternConfig)WithShootingStar¶added inv0.5.17

func (c *CandlestickPatternConfig) WithShootingStar() *CandlestickPatternConfig

WithShootingStar adds the shooting star pattern.

type CandlestickSeries struct {// Data provides OHLC data for each time period.Data []OHLCData// YAxisIndex is the index for the axis, it must be 0 or 1.YAxisIndexint// Label provides the series labels.LabelSeriesLabel// Name specifies a name for the series.Namestring// OpenMarkPoint provides mark points for open values.OpenMarkPointSeriesMarkPoint// OpenMarkLine provides mark lines for open values.OpenMarkLineSeriesMarkLine// OpenTrendLine provides trend lines for open values.OpenTrendLine []SeriesTrendLine// HighMarkPoint provides mark points for high values.HighMarkPointSeriesMarkPoint// HighMarkLine provides mark lines for high values.HighMarkLineSeriesMarkLine// HighTrendLine provides trend lines for high values.HighTrendLine []SeriesTrendLine// LowMarkPoint provides mark points for low values.LowMarkPointSeriesMarkPoint// LowMarkLine provides mark lines for low values.LowMarkLineSeriesMarkLine// LowTrendLine provides trend lines for low values.LowTrendLine []SeriesTrendLine// CloseMarkPoint provides mark points for close values.CloseMarkPointSeriesMarkPoint// CloseMarkLine provides mark lines for close values.CloseMarkLineSeriesMarkLine// CloseTrendLine provides trend lines for close values.CloseTrendLine []SeriesTrendLine// ShowWicks hides wicks when false (body only). Overrides chart-level setting.ShowWicks *bool// CandleStyle specifies the visual style: CandleStyleFilled, CandleStyleTraditional, or CandleStyleOutline.CandleStylestring// PatternConfig configures automatic pattern detection and labeling.PatternConfig *CandlestickPatternConfig// contains filtered or unexported fields}

funcAggregateCandlestick¶added inv0.5.17

func AggregateCandlestick(dataCandlestickSeries, factorint)CandlestickSeries

AggregateCandlestick aggregates OHLC data by the specified factor.

func (*CandlestickSeries)ExtractClosePrices¶added inv0.5.17

func (k *CandlestickSeries) ExtractClosePrices() []float64

ExtractClosePrices extracts close prices from OHLC data for use with indicators.

func (*CandlestickSeries)ExtractHighPrices¶added inv0.5.17

func (k *CandlestickSeries) ExtractHighPrices() []float64

ExtractHighPrices extracts high prices from OHLC data.

func (*CandlestickSeries)ExtractLowPrices¶added inv0.5.17

func (k *CandlestickSeries) ExtractLowPrices() []float64

ExtractLowPrices extracts low prices from OHLC data.

func (*CandlestickSeries)ExtractOpenPrices¶added inv0.5.17

func (k *CandlestickSeries) ExtractOpenPrices() []float64

ExtractOpenPrices extracts open prices from OHLC data.

func (*CandlestickSeries)Summary¶added inv0.5.17

func (k *CandlestickSeries) Summary() populationSummary

type CandlestickSeriesList []CandlestickSeries

funcNewSeriesListCandlestick¶added inv0.5.17

func NewSeriesListCandlestick(data [][]OHLCData, opts ...CandlestickSeriesOption)CandlestickSeriesList

NewSeriesListCandlestick builds a SeriesList for candlestick charts from OHLC data.

func (CandlestickSeriesList)SetSeriesLabels¶added inv0.5.17

func (kCandlestickSeriesList) SetSeriesLabels(labelSeriesLabel)

SetSeriesLabels sets the label for all elements in the series.

func (CandlestickSeriesList)SumSeries¶added inv0.5.17

func (kCandlestickSeriesList) SumSeries() []float64

SumSeries returns a float64 slice with the sum of each series.For candlestick series, this sums the High and Low values (used for range calculations).

func (CandlestickSeriesList)ToGenericSeriesList¶added inv0.5.17

func (kCandlestickSeriesList) ToGenericSeriesList()GenericSeriesList

ToGenericSeriesList converts candlestick series to generic series format.Each candlestick is encoded as 4 consecutive float64 values: [Open, High, Low, Close].Invalid OHLC data is encoded with null values to maintain the 4-element structure.

type CandlestickSeriesOption struct {// Label styles the series labels.LabelSeriesLabel// Names provide data names for each series.Names []string// OpenMarkPoint marks open prices.OpenMarkPointSeriesMarkPoint// OpenMarkLine draws reference lines for open prices.OpenMarkLineSeriesMarkLine// OpenTrendLine adds trend lines based on opens.OpenTrendLine []SeriesTrendLine// HighMarkPoint marks high prices.HighMarkPointSeriesMarkPoint// HighMarkLine draws reference lines for highs.HighMarkLineSeriesMarkLine// HighTrendLine adds trend lines based on highs.HighTrendLine []SeriesTrendLine// LowMarkPoint marks low prices.LowMarkPointSeriesMarkPoint// LowMarkLine draws reference lines for lows.LowMarkLineSeriesMarkLine// LowTrendLine adds trend lines based on lows.LowTrendLine []SeriesTrendLine// CloseMarkPoint marks closing prices.CloseMarkPointSeriesMarkPoint// CloseMarkLine draws reference lines for closes.CloseMarkLineSeriesMarkLine// CloseTrendLine adds trend lines based on closes.CloseTrendLine []SeriesTrendLine// CandleStyle sets the drawing style for candles.CandleStylestring// PatternConfig configures candlestick pattern detection.PatternConfig *CandlestickPatternConfig}

type ChartOption struct {// OutputFormat specifies the output type of chart: "svg", "png", or "jpg". Default is "png".OutputFormatstring// Width is the width of the chart.Widthint// Height is the height of the chart.Heightint// Theme specifies the colors used for the chart. Built in themes can be loaded using GetTheme with// "light", "dark", "vivid-light", "vivid-dark", "ant" or "grafana".ThemeColorPalette// Padding specifies the padding for the chart. Default is [20, 20, 20, 20].PaddingBox// XAxis contains options for the x-axis.XAxisXAxisOption// YAxis contains options for the y-axis. At most two y-axes are supported.YAxis []YAxisOption// Title contains options for rendering the chart title.TitleTitleOption// Legend contains options for the data legend.LegendLegendOption// Deprecated: Font is deprecated, instead the font needs to be set on the SeriesLabel, or other specific elements.Font *truetype.Font// Box specifies the drawing area for the chart.BoxBox// SeriesList provides the population data for the chart, constructed through NewSeriesListGeneric.SeriesListGenericSeriesList// StackSeries when set to *true causes series to be layered or stacked.// This significantly changes chart visualization; see specific chart godocs for details.StackSeries *bool// RadarIndicators is the list of radar indicators for radar charts.RadarIndicators []RadarIndicator// Symbol specifies the symbol to draw at data points. Empty (default) varies by chart type.// Specify 'none' to enforce no symbol, or specify a desired symbol: 'circle', 'dot', 'square', 'diamond'.SymbolSymbol// TODO - v0.6 - consider combining symbol with size into a SymbolStyle struct// LineStrokeWidth is the stroke width for line charts.LineStrokeWidthfloat64// FillArea when set to *true fills the area under the line in line charts.FillArea *bool// FillOpacity is the opacity or alpha channel (0-255) of the area fill in line charts.FillOpacityuint8// Deprecated: BarWidth is deprecated, instead use BarSize.BarWidthint// Deprecated: BarHeight is deprecated, instead use BarSize.BarHeightint// BarSize represents the width of bars, or height for horizontal bar charts.BarSizeint// BarMargin specifies the margin between grouped bars. BarSize takes priority over margin.BarMargin *float64// Radius is the target radius for pie and radar charts. Default is "40%".Radiusstring// Children are child charts to render together.Children []ChartOption// ValueFormatter formats numeric values into labels.ValueFormatterValueFormatter// contains filtered or unexported fields}

type Color =drawing.Color

funcColorConvertGo¶added inv0.4.4

func ColorConvertGo(ccolor.RGBA)Color

ColorConvertGo converts Go's built-in colors to our Color struct.Allows easy use of colors defined in image/colornames.

funcColorFromHex¶added inv0.4.4

func ColorFromHex(hexstring)Color

ColorFromHex returns a color from a CSS hex code.Trims a leading '#' character if present.

funcColorFromKnown¶added inv0.4.4

func ColorFromKnown(knownstring)Color

ColorFromKnown returns an internal color from a known (basic) color name.

funcColorFromRGBA¶added inv0.4.4

func ColorFromRGBA(colorstring)Color

ColorFromRGBA returns a color from CSS 'rgb(i,i,i)' or 'rgba(i,i,i,f)' format.

funcColorRGB¶added inv0.4.4

func ColorRGB(r, g, buint8)Color

ColorRGB constructs a fully opaque color with the specified RGB values.

funcParseColor¶added inv0.3.2

func ParseColor(rawColorstring)Color

ParseColor parses a color from a string. Supports hex with '#' prefix (e.g. '#313233'),rgb(i,i,i) or rgba(i,i,i,f) format, or common names (e.g. 'red').

type ColorPalette interface {IsDark()boolGetXAxisStrokeColor()ColorGetYAxisStrokeColor()ColorGetAxisSplitLineColor()ColorGetSeriesColor(int)ColorGetSeriesTrendColor(int)ColorGetBackgroundColor()ColorGetTitleTextColor()ColorGetMarkTextColor()ColorGetLabelTextColor()ColorGetLegendTextColor()ColorGetXAxisTextColor()ColorGetYAxisTextColor()ColorGetTitleBorderColor()ColorGetLegendBorderColor()Color// WithXAxisColor returns a new ColorPalette with the specified x-axis color.// Use WithXAxisTextColor to adjust the text color.WithXAxisColor(Color)ColorPalette// WithYAxisColor returns a new ColorPalette with the specified y-axis color.// Use WithYAxisTextColor to adjust the text color.WithYAxisColor(Color)ColorPalette// WithYAxisSeriesColor returns a new ColorPalette using the specified series color for y-axis and values.WithYAxisSeriesColor(int)ColorPalette// WithTitleTextColor returns a new ColorPalette with the specified title text color.WithTitleTextColor(Color)ColorPalette// WithMarkTextColor returns a new ColorPalette with the specified mark point and line label color.WithMarkTextColor(Color)ColorPalette// WithLabelTextColor returns a new ColorPalette with the specified value label color.WithLabelTextColor(Color)ColorPalette// WithLegendTextColor returns a new ColorPalette with the specified legend text color.WithLegendTextColor(Color)ColorPalette// WithXAxisTextColor returns a new ColorPalette with the specified x-axis label color.WithXAxisTextColor(Color)ColorPalette// WithYAxisTextColor returns a new ColorPalette with the specified y-axis label color.WithYAxisTextColor(Color)ColorPalette// WithSeriesColors returns a new ColorPalette with the specified series colors.// Trend line colors default to match series colors. Use WithSeriesTrendColors for further customization.WithSeriesColors([]Color)ColorPalette// WithSeriesTrendColors returns a new ColorPalette with the specified trend line colors.WithSeriesTrendColors([]Color)ColorPalette// WithBackgroundColor returns a new ColorPalette with the specified background color.WithBackgroundColor(Color)ColorPalette// WithTitleBorderColor returns a new ColorPalette with the specified title border color.WithTitleBorderColor(Color)ColorPalette// WithLegendBorderColor returns a new ColorPalette with the specified legend border color.WithLegendBorderColor(Color)ColorPalette// GetCandleWickColor returns the color for the high-low wicks.GetCandleWickColor()Color// GetSeriesUpDownColors returns distinct "up" and "down" colors for each series index.GetSeriesUpDownColors(indexint) (Color,Color)}

funcGetDefaultTheme¶

func GetDefaultTheme()ColorPalette

GetDefaultTheme returns the default theme.

funcGetTheme¶

func GetTheme(namestring)ColorPalette

GetTheme returns an installed theme by name, or the default if not found.

funcMakeTheme¶

func MakeTheme(optThemeOption)ColorPalette

MakeTheme constructs a theme without installing it into the catalog.

type DoughnutChartOption struct {// Theme specifies the colors used for the doughnut chart.ThemeColorPalette// Padding specifies the padding around the chart.PaddingBox// SeriesList provides the data population for the chart. Typically constructed using NewSeriesListDoughnut.SeriesListDoughnutSeriesList// Title contains options for rendering the chart title.TitleTitleOption// Legend contains options for the data legend.LegendLegendOption// RadiusRing sets the outer radius of the ring, for example "40%".// Default is "40%".RadiusRingstring// RadiusCenter is the radius for the center hole of the doughnut and must be smaller than RadiusRing.RadiusCenterstring// CenterValues specifies what should be rendered in the center of the doughnut,// current options are "none" (default), "labels", "sum".// * labels - Will render the labels on the inside of the circle instead of the outside (more risk of collision).// * sum - Will put the sum count of all the series (formatted using ValueFormatter).CenterValuesstring// CenterValuesFontStyle provides the styling for center values (series labels prefer their specific series styling).CenterValuesFontStyleFontStyle// SegmentGap provides a margin between each series section.SegmentGapfloat64// ValueFormatter defines how float values are rendered to strings, notably for series labels.ValueFormatterValueFormatter}

funcNewDoughnutChartOptionWithData¶added inv0.5.6

func NewDoughnutChartOptionWithData(data []float64)DoughnutChartOption

NewDoughnutChartOptionWithData returns an initialized DoughnutChartOption with the SeriesList set with the provided data slice.

type DoughnutSeries struct {// Value provides the value for the Doughnut section.Valuefloat64// Label provides the series labels.LabelSeriesLabel// Name specifies a name for the series.Namestring// Radius for Doughnut chart, e.g.: 40%, default is "40%"Radiusstring}

type DoughnutSeriesList []DoughnutSeries

funcNewSeriesListDoughnut¶added inv0.5.6

func NewSeriesListDoughnut(values []float64, opts ...DoughnutSeriesOption)DoughnutSeriesList

NewSeriesListDoughnut builds a SeriesList for a doughnut chart.

func (DoughnutSeriesList)MaxValue¶added inv0.5.6

func (dDoughnutSeriesList) MaxValue()float64

MaxValue returns the maximum value within the series, or MinInt64 if no values.

func (DoughnutSeriesList)SetSeriesLabels¶added inv0.5.6

func (dDoughnutSeriesList) SetSeriesLabels(labelSeriesLabel)

SetSeriesLabels sets the label for all elements in the series.

func (DoughnutSeriesList)SumSeries¶added inv0.5.6

func (dDoughnutSeriesList) SumSeries()float64

func (DoughnutSeriesList)ToGenericSeriesList¶added inv0.5.6

func (dDoughnutSeriesList) ToGenericSeriesList()GenericSeriesList

type DoughnutSeriesOption struct {LabelSeriesLabelNames []string}

type EChartStyle struct {Colorstring   `json:"color"`Opacity *float64 `json:"opacity,omitempty"`}

type EChartsAxisLabel struct {Formatterstring `json:"formatter,omitempty"`Show      *bool  `json:"show,omitempty"`Colorstring `json:"color,omitempty"`FontSize  *int   `json:"fontSize,omitempty"`}

type EChartsAxisLine struct {Show      *bool `json:"show,omitempty"`LineStyle struct {Colorstring   `json:"color,omitempty"`Opacity *float64 `json:"opacity,omitempty"`Width   *int     `json:"width,omitempty"`// TODO - add support} `json:"lineStyle,omitempty"`}

type EChartsLabelOption struct {Showbool   `json:"show"`Distanceint    `json:"distance"`Colorstring `json:"color"`}

type EChartsLegend struct {Show            *bool            `json:"show"`Data            []string         `json:"data"`Alignstring           `json:"align"`Orientstring           `json:"orient"`PaddingEChartsPadding   `json:"padding,omitempty"`LeftEChartsPosition  `json:"left"`TopEChartsPosition  `json:"top"`TextStyleEChartsTextStyle `json:"textStyle"`BackgroundColorstring           `json:"backgroundColor,omitempty"`// TODO - add supportBorderColorstring           `json:"borderColor,omitempty"`}

type EChartsMarkData struct {Typestring `json:"type"`// TODO - support position values belowXAxisfloat64 `json:"xAxis,omitempty"`YAxisfloat64 `json:"yAxis,omitempty"`}

func (*EChartsMarkData)UnmarshalJSON¶

func (emd *EChartsMarkData) UnmarshalJSON(data []byte)error

UnmarshalJSON parses mark definitions provided as an object or array.

type EChartsMarkLine struct {Data []EChartsMarkData `json:"data"`}

func (*EChartsMarkLine)ToSeriesMarkLine¶

func (eml *EChartsMarkLine) ToSeriesMarkLine()SeriesMarkLine

ToSeriesMarkLine converts the mark line to the internal representation.

type EChartsMarkPoint struct {SymbolSizeint               `json:"symbolSize"`Data       []EChartsMarkData `json:"data"`}

func (*EChartsMarkPoint)ToSeriesMarkPoint¶

func (emp *EChartsMarkPoint) ToSeriesMarkPoint()SeriesMarkPoint

ToSeriesMarkPoint converts the mark point to the internal representation.

type EChartsOption struct {Typestring         `json:"type"`Themestring         `json:"theme"`FontFamilystring         `json:"fontFamily"`PaddingEChartsPadding `json:"padding"`BoxBox            `json:"box"`Widthint            `json:"width"`Heightint            `json:"height"`Title      struct {Show            *bool            `json:"show,omitempty"`Textstring           `json:"text"`Subtextstring           `json:"subtext"`LeftEChartsPosition  `json:"left"`TopEChartsPosition  `json:"top"`TextStyleEChartsTextStyle `json:"textStyle"`SubtextStyleEChartsTextStyle `json:"subtextStyle"`BackgroundColorstring           `json:"backgroundColor,omitempty"`// TODO - add supportBorderColorstring           `json:"borderColor,omitempty"`} `json:"title"`XAxisEChartsXAxis  `json:"xAxis"`YAxisEChartsYAxis  `json:"yAxis"`LegendEChartsLegend `json:"legend"`Radar  struct {Indicator []RadarIndicator `json:"indicator"`} `json:"radar"`SeriesEChartsSeriesList `json:"series"`BackgroundColorstring            `json:"backgroundColor,omitempty"`Children        []EChartsOption   `json:"children"`}

func (*EChartsOption)ToOption¶

func (eo *EChartsOption) ToOption()ChartOption

ToOption converts the ECharts options into a ChartOption.

type EChartsPadding struct {BoxBox}

func (*EChartsPadding)UnmarshalJSON¶

func (eb *EChartsPadding) UnmarshalJSON(data []byte)error

UnmarshalJSON decodes a padding array into a Box.

type EChartsPositionstring

func (*EChartsPosition)UnmarshalJSON¶

func (p *EChartsPosition) UnmarshalJSON(data []byte)error

UnmarshalJSON decodes a position JSON value that may be a string or number.

type EChartsSeries struct {Data       []EChartsSeriesData `json:"data"`Namestring              `json:"name"`Typestring              `json:"type"`Radiusstring              `json:"radius"`YAxisIndexint                 `json:"yAxisIndex"`ItemStyleEChartStyle         `json:"itemStyle,omitempty"`// TODO - add support// label configurationLabelEChartsLabelOption `json:"label"`MarkPointEChartsMarkPoint   `json:"markPoint"`MarkLineEChartsMarkLine    `json:"markLine"`Max       *float64           `json:"max"`// TODO - add supportMin       *float64           `json:"min"`// TODO - add support}

type EChartsSeriesData struct {ValueEChartsSeriesDataValue `json:"value"`Namestring                 `json:"name"`ItemStyleEChartStyle            `json:"itemStyle,omitempty"`// TODO - add support}

func (*EChartsSeriesData)UnmarshalJSON¶

func (es *EChartsSeriesData) UnmarshalJSON(data []byte)error

UnmarshalJSON parses a series data item that may be a number or object.

type EChartsSeriesDataValue struct {// contains filtered or unexported fields}

func (*EChartsSeriesDataValue)First¶

func (value *EChartsSeriesDataValue) First()float64

First returns the first value or 0 when empty.

func (*EChartsSeriesDataValue)UnmarshalJSON¶

func (value *EChartsSeriesDataValue) UnmarshalJSON(data []byte)error

UnmarshalJSON decodes a series data value that may be a single number or array.

type EChartsSeriesList []EChartsSeries

func (EChartsSeriesList)ToSeriesList¶

func (esListEChartsSeriesList) ToSeriesList()GenericSeriesList

type EChartsTextStyle struct {Colorstring  `json:"color"`FontFamilystring  `json:"fontFamily"`FontSizefloat64 `json:"fontSize"`}

func (*EChartsTextStyle)ToFontStyle¶added inv0.5.0

func (et *EChartsTextStyle) ToFontStyle()FontStyle

ToFontStyle converts the text style to a FontStyle.

type EChartsXAxis struct {Data []EChartsXAxisData}

func (*EChartsXAxis)UnmarshalJSON¶

func (ex *EChartsXAxis) UnmarshalJSON(data []byte)error

UnmarshalJSON decodes x-axis options that may be a single object or an array.

type EChartsXAxisData struct {BoundaryGap *bool            `json:"boundaryGap,omitempty"`SplitNumberint              `json:"splitNumber,omitempty"`AxisLabelEChartsAxisLabel `json:"axisLabel,omitempty"`AxisLineEChartsAxisLine  `json:"axisLine,omitempty"`Data        []string         `json:"data"`Typestring           `json:"type"`}

type EChartsYAxis struct {Data []EChartsYAxisData `json:"data"`}

func (*EChartsYAxis)UnmarshalJSON¶

func (ey *EChartsYAxis) UnmarshalJSON(data []byte)error

UnmarshalJSON decodes y-axis options that may be a single object or an array.

type EChartsYAxisData struct {Min       *float64         `json:"min,omitempty"`Max       *float64         `json:"max,omitempty"`AxisLabelEChartsAxisLabel `json:"axisLabel,omitempty"`AxisLineEChartsAxisLine  `json:"axisLine,omitempty"`Data      []string         `json:"data"`}

type FontStyle =chartdraw.FontStyle

funcNewFontStyleWithSize¶added inv0.4.7

func NewFontStyleWithSize(sizefloat64)FontStyle

NewFontStyleWithSize constructs a new FontStyle with the specified font size. If you want to avoid directlyconstructing the FontStyle struct, you can use this followed by additional `WithX` function calls on the returnedFontStyle.

type FunnelChartOption struct {// Theme specifies the colors used for the chart.ThemeColorPalette// Padding specifies the padding around the chart.PaddingBox// Deprecated: Font is deprecated, instead the font needs to be set on the SeriesLabel, or other specific elements.Font *truetype.Font// SeriesList provides the data population for the chart. Typically constructed using NewSeriesListFunnel.SeriesListFunnelSeriesList// Title contains options for rendering the chart title.TitleTitleOption// Legend contains options for the data legend.LegendLegendOption// Deprecated: ValueFormatter is deprecated, instead set the ValueFormatter at `SeriesList[*].Label.ValueFormatter`.ValueFormatterValueFormatter}

funcNewFunnelChartOptionWithData¶added inv0.4.0

func NewFunnelChartOptionWithData(data []float64)FunnelChartOption

NewFunnelChartOptionWithData returns an initialized FunnelChartOption with the SeriesList set with the provided data slice.

type FunnelSeries struct {// Value provides the value for the funnel section.Valuefloat64// Label provides the series labels.LabelSeriesLabel// Name specifies a name for the series.Namestring}

type FunnelSeriesList []FunnelSeries

funcNewSeriesListFunnel¶added inv0.4.0

func NewSeriesListFunnel(values []float64, opts ...FunnelSeriesOption)FunnelSeriesList

NewSeriesListFunnel builds a series list for funnel charts.

func (FunnelSeriesList)SetSeriesLabels¶added inv0.5.6

func (fFunnelSeriesList) SetSeriesLabels(labelSeriesLabel)

SetSeriesLabels sets the label for all elements in the series.

func (FunnelSeriesList)ToGenericSeriesList¶added inv0.5.0

func (fFunnelSeriesList) ToGenericSeriesList()GenericSeriesList

type FunnelSeriesOption struct {LabelSeriesLabelNames []string}

type GenericSeries struct {// Type is the series chart type. Default is "line".Typestring// Values provides the series data values.// For ChartTypeCandlestick, the Values field must contain OHLC data encoded as groups of 4 consecutive// float64 values: [Open, High, Low, Close, ...]. For N candlesticks, Values must have exactly N*4 elements.Values []float64// YAxisIndex is the y-axis to apply the series to: must be 0 or 1.YAxisIndexint// Label provides the series labels.LabelSeriesLabel// Name specifies a name for the series.Namestring// Radius for circular charts. Default is "40%".Radiusstring// MarkPoint provides a mark point configuration for this series. If Label is enabled, MarkPoint// replaces the label where rendered.MarkPointSeriesMarkPoint// MarkLine provides amark line configuration for this series. When using MarkLine, configure// padding on the chart's right side to ensure space for the values.MarkLineSeriesMarkLine}

type GenericSeriesList []GenericSeries

funcNewSeriesListGeneric¶added inv0.5.0

func NewSeriesListGeneric(values [][]float64, chartTypestring)GenericSeriesList

NewSeriesListGeneric returns a Generic series list for the given values and chart type (used in ChartOption).

func (GenericSeriesList)SetSeriesLabels¶added inv0.5.6

func (gGenericSeriesList) SetSeriesLabels(labelSeriesLabel)

SetSeriesLabels sets the label for all elements in the series.

type HeatMapAxis struct {// Title specifies the title to display next to the axis.Titlestring// TitleFontStyle specifies the font style for the axis title.TitleFontStyleFontStyle// Labels specifies custom labels for the axis. If empty, numeric indices are used.// Must match the data size for the corresponding axis.Labels []string// LabelFontStyle specifies the font style for the axis labels.LabelFontStyleFontStyle// LabelRotation is the rotation angle in radians for labels. Use DegreesToRadians(float64) to convert from degrees.LabelRotationfloat64// LabelCount is the number of labels to show on the axis. Use a smaller count to reduce text collisions.LabelCountint// LabelCountAdjustment specifies relative influence on label count.// Negative values result in cleaner graphs; positive values may cause text collisions.LabelCountAdjustmentint}

type HeatMapOption struct {// Theme specifies the color palette used for rendering the heat map.ThemeColorPalette// BaseColorIndex specifies which color from the theme palette to use as the base for gradients.BaseColorIndexint// Padding specifies the padding around the heat map chart.PaddingBox// Deprecated: Font is deprecated, instead the font needs to be set on the SeriesLabel, or other specific elements.Font *truetype.Font// Title contains options for rendering the chart title.TitleTitleOption// Values provides the 2D data for the heat map.// The outer slice represents the rows (y-axis) and the inner slice represents the columns (x-axis).Values [][]float64// XAxis contains configuration options for the x-axis.XAxisHeatMapAxis// YAxis contains configuration options for the y-axis.YAxisHeatMapAxis// ScaleMinValue overrides the minimum value for color gradient calculation. If nil, calculated from the data.ScaleMinValue *float64// ScaleMaxValue overrides the maximum value for color gradient calculation. If nil, calculated from the data.ScaleMaxValue *float64// ValuesLabel contains configuration for displaying numeric values on heat map cells.ValuesLabelSeriesLabel}

funcNewHeatMapOptionWithData¶added inv0.5.1

func NewHeatMapOptionWithData(data [][]float64)HeatMapOption

NewHeatMapOptionWithData returns an initialized HeatMapOption with the provided data.

type HorizontalBarChartOption struct {// Theme specifies the colors used for the chart.ThemeColorPalette// Padding specifies the padding around the chart.PaddingBox// Deprecated: Font is deprecated, instead the font needs to be set on the SeriesLabel, or other specific elements.Font *truetype.Font// SeriesList provides the data population for the chart. Typically constructed using NewSeriesListHorizontalBar.SeriesListHorizontalBarSeriesList// StackSeries when *true renders the series stacked within one bar.// This causes some options, including BarMargin and SeriesLabelPosition, to be// ignored. MarkLine only renders for the first series.StackSeries *bool// SeriesLabelPosition specifies the label position for the series: "left" or "right".SeriesLabelPositionstring// XAxis contains options for the x-axis.XAxisXAxisOption// YAxis contains options for the y-axis.YAxisYAxisOption// Title contains options for rendering the chart title.TitleTitleOption// Legend contains options for the data legend.LegendLegendOption// BarHeight specifies the height of each horizontal bar. Height may be reduced to ensure all series fit on the chart.BarHeightint// TODO - v0.6 - Update to float64 to represent a precent// BarMargin specifies the margin between grouped bars. BarHeight takes priority over a set margin.BarMargin *float64// TODO - v0.6 - Update to be percent based// ValueFormatter defines how float values are rendered to strings, notably for numeric axis labels.ValueFormatterValueFormatter}

funcNewHorizontalBarChartOptionWithData¶added inv0.4.0

func NewHorizontalBarChartOptionWithData(data [][]float64)HorizontalBarChartOption

NewHorizontalBarChartOptionWithData returns an initialized HorizontalBarChartOption with the SeriesList set with the provided data slice.

type HorizontalBarSeries struct {// Values provides the series data values.Values []float64// Label provides the series labels.LabelSeriesLabel// Name specifies a name for the series.Namestring// MarkLine provides a configuration for mark lines for this series.MarkLineSeriesMarkLine}

func (*HorizontalBarSeries)Summary¶added inv0.5.0

func (h *HorizontalBarSeries) Summary() populationSummary

type HorizontalBarSeriesList []HorizontalBarSeries

funcNewSeriesListHorizontalBar¶added inv0.4.0

func NewSeriesListHorizontalBar(values [][]float64, opts ...BarSeriesOption)HorizontalBarSeriesList

NewSeriesListHorizontalBar builds a SeriesList for a horizontal bar chart. Horizontal bar charts are unique in thatthese Series can not be combined with any other chart type.

func (HorizontalBarSeriesList)SetSeriesLabels¶added inv0.5.6

func (hHorizontalBarSeriesList) SetSeriesLabels(labelSeriesLabel)

SetSeriesLabels sets the label for all elements in the series.

func (HorizontalBarSeriesList)SumSeries¶added inv0.5.0

func (hHorizontalBarSeriesList) SumSeries() []float64

SumSeries returns a float64 slice with the sum of each series.

func (HorizontalBarSeriesList)SumSeriesValues¶added inv0.5.0

func (hHorizontalBarSeriesList) SumSeriesValues() []float64

SumSeriesValues returns a float64 slice with each series totaled by the value index.

func (HorizontalBarSeriesList)ToGenericSeriesList¶added inv0.5.0

func (hHorizontalBarSeriesList) ToGenericSeriesList()GenericSeriesList

type LabelStyle struct {// FontStyle overrides font properties (color, size, family) for this specific label.FontStyleFontStyle// BackgroundColor provides a background color behind the label text.BackgroundColorColor// CornerRadius sets the radius for rounded corners on the background rectangle.CornerRadiusint// BorderColor sets the border color around the label background.BorderColorColor// BorderWidth sets the width of the border around the label background.BorderWidthfloat64}

type LayoutBuilderGrid interface {// CellAt defines a new cell at the specified position with the given name.// The cell defaults to a 1x1 span, adjust larger by calling Span.CellAt(namestring, col, rowint)LayoutBuilderGrid// Span modifies the span of the previously defined cell.// Must be called after CellAt.Span(colSpan, rowSpanint)LayoutBuilderGrid// Offset applies position adjustments to the previously defined cell.// Accepts pixels ("20") or percentages ("10%") - percentages are relative to the cell's own dimensions.// Must be called after CellAt. Useful for fine-tuning and creating overlapping effects.Offset(x, ystring)LayoutBuilderGrid// Build creates child painters based on the defined grid layout.// Returns a map of cell names to their corresponding painters.Build() (map[string]*Painter,error)}

type LayoutBuilderRow interface {// Row starts defining a new row.// If the current row has columns, it commits the row and starts a new one.// If the current row is empty, this is a no-op (prevents accidental empty rows).// Multiple consecutive Row() calls without column definitions are idempotent.Row()LayoutBuilderRow// RowGap adds vertical spacing between rows (pixels or percentage).// Creates an empty row with the specified height (equivalent to Row().Height(height)).RowGap(heightstring)LayoutBuilderRow// Columns adds columns with equal width distribution to the current row. Use Col if you want to set a specific column width.Columns(names ...string)LayoutBuilderRow// Col adds a column with specified width to the current row (pixels, percentage, or empty for auto).Col(namestring, widthstring)LayoutBuilderRow// Height sets the current row height (pixels or percentage).Height(heightstring)LayoutBuilderRow// ColGap adds a horizontal gap in the current row (like adding an invisible column).// If gap is empty (""), it is treated as an auto-width gap and will// match other auto-width columns in the row.ColGap(gapstring)LayoutBuilderRow// RowOffset applies position adjustments to the entire current row. Unlike Offset (which is cell specific),// this adjustment will adjust all rows following.// Accepts pixels ("20") or percentages ("10%") - percentages are relative to the painter height.// Negative values create overlapping effects, positive values create gaps.RowOffset(ystring)LayoutBuilderRow// Offset applies position adjustments to the last added column in the current row.// Accepts pixels ("20") or percentages ("10%") - percentages are relative to the cell's dimensions.// X offset percentage is relative to the cell's width, Y offset percentage is relative to the row's height.// Negative values create overlapping effects. If no columns have been added yet, this is a no-op.Offset(x, ystring)LayoutBuilderRow// Build creates child painters from the entire layout definition.// Returns a map of cell names to their corresponding painters.Build() (map[string]*Painter,error)}

type LegendOption struct {// Show specifies if the legend should be rendered. Set to *false (via Ptr(false)) to hide the legend.Show *bool// Theme specifies the colors used for the legend.ThemeColorPalette// SeriesNames provides the text labels for the data series.SeriesNames []string// FontStyle specifies the font, size, and style for legend text.FontStyleFontStyle// Padding specifies the space around the legend.PaddingBox// Offset specifies the position of the legend relative to the left and top sides.OffsetOffsetStr// Align is the legend marker and text alignment: 'left', 'right', or 'center'. Default is 'left'.Alignstring// Vertical when set to *true makes the legend orientation vertical.Vertical *bool// Symbol defines the icon shape next to each label. Options: 'square', 'dot', 'diamond', 'circle'.SymbolSymbol// TODO - should Symbol configuration be changed now that we support per-series symbols// TODO - v0.6 - consider combining symbol with size into a SymbolStyle struct// OverlayChart when set to *true renders the legend over the chart. Ignored if Vertical is true (Vertical always forces overlay).OverlayChart *bool// BorderWidth can be set to a non-zero value to render a box around the legend.BorderWidthfloat64// contains filtered or unexported fields}

func (*LegendOption)IsEmpty¶

func (opt *LegendOption) IsEmpty()bool

IsEmpty checks if the legend is empty.

type LineChartOption struct {// Theme specifies the colors used for the line chart.ThemeColorPalette// Padding specifies the padding around the chart.PaddingBox// Deprecated: Font is deprecated, instead the font needs to be set on the SeriesLabel, or other specific elements.Font *truetype.Font// SeriesList provides the data population for the chart. Typically constructed using NewSeriesListLine.SeriesListLineSeriesList// StackSeries when true layers each series so the last represents the cumulative sum.// This forces FillArea and ignores options like StrokeSmoothingTension.// MarkLine only renders for the first series, and only the first y-axis is stacked.StackSeries *bool// XAxis contains options for the x-axis.XAxisXAxisOption// YAxis contains options for the y-axis. At most two y-axes are supported.YAxis []YAxisOption// Title contains options for rendering the chart title.TitleTitleOption// Legend contains options for the data legend.LegendLegendOption// Symbol specifies the symbol to draw at data points. Empty (default) varies by dataset.// Options: 'none', 'circle', 'dot', 'square', 'diamond'. Can be overridden per series.SymbolSymbol// TODO - v0.6 - consider combining symbol with size into a SymbolStyle struct// LineStrokeWidth is the width of the rendered line.LineStrokeWidthfloat64// StrokeSmoothingTension controls line smoothing (0-1). 0 creates straight lines, 1 creates heavily smoothed curves.// Smoothing the line may move it from hitting points exactly.// Higher tension values move the line further from exact data points.StrokeSmoothingTensionfloat64// FillArea when set to *true fills the area below the line.FillArea *bool// FillOpacity is the opacity/alpha (0-255) of the area fill.FillOpacityuint8// ValueFormatter defines how float values are rendered to strings, notably for numeric axis labels.ValueFormatterValueFormatter}

funcNewLineChartOptionWithData¶added inv0.4.0

func NewLineChartOptionWithData(data [][]float64)LineChartOption

NewLineChartOptionWithData returns an initialized LineChartOption with the SeriesList set with the provided data slice.

funcNewLineChartOptionWithSeries¶added inv0.5.9

func NewLineChartOptionWithSeries(slLineSeriesList)LineChartOption

NewLineChartOptionWithSeries returns an initialized LineChartOption with the provided SeriesList.

type LineSeries struct {// Values provides the series data values.Values []float64// YAxisIndex is the index for the axis, it must be 0 or 1.YAxisIndexint// Label provides the series labels.LabelSeriesLabel// Name specifies a name for the series.Namestring// MarkPoint provides a configuration for mark points for this series. If Label is also enabled, the MarkPoint// will replace the label where rendered.MarkPointSeriesMarkPoint// MarkLine provides a configuration for mark lines for this series. When using a MarkLine, you will want to// configure padding to the chart on the right for the values.MarkLineSeriesMarkLine// TrendLine provides configurations for trend lines for this series.TrendLine []SeriesTrendLine// Symbol specifies a custom symbol for the series.SymbolSymbol// TODO - v0.6 - consider combining symbol with size into a SymbolStyle struct// contains filtered or unexported fields}

func (*LineSeries)Summary¶added inv0.5.0

func (l *LineSeries) Summary() populationSummary

type LineSeriesList []LineSeries

funcNewSeriesListLine¶added inv0.4.0

func NewSeriesListLine(values [][]float64, opts ...LineSeriesOption)LineSeriesList

NewSeriesListLine builds a SeriesList for a line chart. The first dimension of the values indicates the populationof the data, while the second dimension provides the samples for the population.

func (LineSeriesList)SetSeriesLabels¶added inv0.5.6

func (lLineSeriesList) SetSeriesLabels(labelSeriesLabel)

SetSeriesLabels sets the label for all elements in the series.

func (LineSeriesList)SumSeries¶added inv0.5.0

func (lLineSeriesList) SumSeries() []float64

SumSeries returns a float64 slice with the sum of each series.

func (LineSeriesList)SumSeriesValues¶added inv0.5.0

func (lLineSeriesList) SumSeriesValues() []float64

SumSeriesValues returns a float64 slice with each series totaled by the value index.

func (LineSeriesList)ToGenericSeriesList¶added inv0.5.0

func (lLineSeriesList) ToGenericSeriesList()GenericSeriesList

type LineSeriesOption struct {LabelSeriesLabelNames     []stringMarkPointSeriesMarkPointMarkLineSeriesMarkLineTrendLine []SeriesTrendLine}

type OHLCData struct {// Open is the opening price for the time period.Openfloat64// High is the highest price during the time period.Highfloat64// Low is the lowest price during the time period.Lowfloat64// Close is the closing price for the time period.Closefloat64}

type OffsetInt struct {// Top indicates a vertical spacing adjustment from the top.Topint// Left indicates a horizontal spacing adjustment from the left.Leftint}

func (OffsetInt)WithLeft¶added inv0.3.0

func (oOffsetInt) WithLeft(valint)OffsetInt

WithLeft returns a copy of the offset with the Left value set.

func (OffsetInt)WithTop¶added inv0.3.0

func (oOffsetInt) WithTop(valint)OffsetInt

WithTop returns a copy of the offset with the Top value set.

type OffsetStr struct {// Left is the distance between the component and the left side of the container.// It can be pixel value (20), percentage value (20%), or position description: 'left', 'right', 'center'.Leftstring// Top is the distance between the component and the top side of the container.// It can be pixel value (20), or percentage value (20%), or position description: 'top', 'bottom'.Topstring}

func (OffsetStr)WithLeft¶added inv0.3.0

func (oOffsetStr) WithLeft(valstring)OffsetStr

WithLeft returns a copy of the offset with the Left value set.

func (OffsetStr)WithLeftI¶added inv0.3.0

func (oOffsetStr) WithLeftI(valint)OffsetStr

WithLeftI sets Left using an integer value.

func (OffsetStr)WithTop¶added inv0.3.0

func (oOffsetStr) WithTop(valstring)OffsetStr

WithTop returns a copy of the offset with the Top value set.

func (OffsetStr)WithTopI¶added inv0.3.0

func (oOffsetStr) WithTopI(valint)OffsetStr

WithTopI sets Top using an integer value.

type OptionFunc func(opt *ChartOption)

funcChildOptionFunc¶

func ChildOptionFunc(child ...ChartOption)OptionFunc

ChildOptionFunc adds a Child chart on top of the current one. Use Padding and Box for positioning.

funcDimensionsOptionFunc¶added inv0.4.0

func DimensionsOptionFunc(width, heightint)OptionFunc

DimensionsOptionFunc sets the width and height dimensions of the chart.

funcJPGOutputOptionFunc¶added inv0.5.1

func JPGOutputOptionFunc()OptionFunc

JPGOutputOptionFunc sets JPG as the image output format for the chart.

funcLegendLabelsOptionFunc¶

func LegendLabelsOptionFunc(labels []string)OptionFunc

LegendLabelsOptionFunc sets the legend series name labels of the chart.

funcLegendOptionFunc¶

func LegendOptionFunc(legendLegendOption)OptionFunc

LegendOptionFunc sets the legend of the chart.

funcMarkLineOptionFunc¶

func MarkLineOptionFunc(seriesIndexint, markLineTypes ...string)OptionFunc

MarkLineOptionFunc sets the mark line for series of the chart.

funcMarkPointOptionFunc¶

func MarkPointOptionFunc(seriesIndexint, markPointTypes ...string)OptionFunc

MarkPointOptionFunc sets the mark point for series of the chart.

funcPNGOutputOptionFunc¶added inv0.4.0

func PNGOutputOptionFunc()OptionFunc

PNGOutputOptionFunc sets PNG as the image output format for the chart.

funcPaddingOptionFunc¶

func PaddingOptionFunc(paddingBox)OptionFunc

PaddingOptionFunc sets the padding of the chart.

funcRadarIndicatorOptionFunc¶

func RadarIndicatorOptionFunc(names []string, values []float64)OptionFunc

RadarIndicatorOptionFunc sets the radar indicator of chart

funcSVGOutputOptionFunc¶added inv0.4.0

func SVGOutputOptionFunc()OptionFunc

SVGOutputOptionFunc sets SVG as the image output format for the chart.

funcSeriesShowLabel¶added inv0.4.0

func SeriesShowLabel(showbool)OptionFunc

SeriesShowLabel sets the series show label state for all series.

funcThemeNameOptionFunc¶

func ThemeNameOptionFunc(themestring)OptionFunc

ThemeNameOptionFunc sets the chart theme by name.

funcThemeOptionFunc¶

func ThemeOptionFunc(themeColorPalette)OptionFunc

ThemeOptionFunc sets the theme of the chart.

funcTitleOptionFunc¶

func TitleOptionFunc(titleTitleOption)OptionFunc

TitleOptionFunc sets the title of the chart.

funcTitleTextOptionFunc¶

func TitleTextOptionFunc(textstring, subtext ...string)OptionFunc

TitleTextOptionFunc sets the title text of chart.

funcXAxisLabelsOptionFunc¶added inv0.4.9

func XAxisLabelsOptionFunc(labels []string)OptionFunc

XAxisLabelsOptionFunc sets the x-axis labels of the chart.

funcXAxisOptionFunc¶

func XAxisOptionFunc(xAxisOptionXAxisOption)OptionFunc

XAxisOptionFunc sets the x-axis of the chart.

funcYAxisLabelsOptionFunc¶added inv0.4.9

func YAxisLabelsOptionFunc(labels []string)OptionFunc

YAxisLabelsOptionFunc sets the y-axis labels of the chart.

funcYAxisOptionFunc¶

func YAxisOptionFunc(yAxisOption ...YAxisOption)OptionFunc

YAxisOptionFunc sets the y-axis of chart, supports up to two y-axis.

type Painter struct {// contains filtered or unexported fields}

funcBarRender¶

func BarRender(values [][]float64, opts ...OptionFunc) (*Painter,error)

BarRender renders a bar chart.

funcCandleStickRender¶added inv0.5.17

func CandleStickRender(values [][]OHLCData, opts ...OptionFunc) (*Painter,error)

CandleStickRender renders a candlestick chart.

funcDoughnutRender¶added inv0.5.6

func DoughnutRender(values []float64, opts ...OptionFunc) (*Painter,error)

DoughnutRender renders a doughnut or ring chart.

funcFunnelRender¶

func FunnelRender(values []float64, opts ...OptionFunc) (*Painter,error)

FunnelRender renders a funnel chart.

funcHorizontalBarRender¶

func HorizontalBarRender(values [][]float64, opts ...OptionFunc) (*Painter,error)

HorizontalBarRender renders a horizontal bar chart.

funcLineRender¶

func LineRender(values [][]float64, opts ...OptionFunc) (*Painter,error)

LineRender renders a line chart.

funcNewPainter¶

func NewPainter(optsPainterOptions, opt ...PainterOptionFunc) *Painter

NewPainter creates a painter for rendering charts.

funcPieRender¶

func PieRender(values []float64, opts ...OptionFunc) (*Painter,error)

PieRender renders a pie chart.

funcRadarRender¶

func RadarRender(values [][]float64, opts ...OptionFunc) (*Painter,error)

RadarRender renders a radar chart.

funcRender¶

func Render(optChartOption, opts ...OptionFunc) (*Painter,error)

Render creates and renders a chart based on the provided options.

funcScatterRender¶added inv0.5.0

func ScatterRender(values [][]float64, opts ...OptionFunc) (*Painter,error)

ScatterRender renders a scatter chart.

funcTableOptionRenderDirect¶added inv0.4.0

func TableOptionRenderDirect(optTableChartOption) (*Painter,error)

TableOptionRenderDirect renders a table directly to an image with the provided options.Table options differ from other charts as they include Painter initialization state.To render a table on an existing Painter, use TableOptionRender.

funcTableRenderValues¶added inv0.4.0

func TableRenderValues(header []string, data [][]string, spanMaps ...map[int]int) (*Painter,error)

TableRenderValues renders a table chart with the provided header and data values.

func (*Painter)ArrowDown¶added inv0.4.0

func (p *Painter) ArrowDown(x, y, width, heightint,fillColor, strokeColorColor, strokeWidthfloat64)

ArrowDown draws an arrow at the given point and dimensions pointing down.

func (*Painter)ArrowLeft¶

func (p *Painter) ArrowLeft(x, y, width, heightint,fillColor, strokeColorColor, strokeWidthfloat64)

ArrowLeft draws an arrow at the given point and dimensions pointing left.

func (*Painter)ArrowRight¶

func (p *Painter) ArrowRight(x, y, width, heightint,fillColor, strokeColorColor, strokeWidthfloat64)

ArrowRight draws an arrow at the given point and dimensions pointing right.

func (*Painter)ArrowUp¶added inv0.4.0

func (p *Painter) ArrowUp(x, y, width, heightint,fillColor, strokeColorColor, strokeWidthfloat64)

ArrowUp draws an arrow at the given point and dimensions pointing up.

func (*Painter)BarChart¶added inv0.4.0

func (p *Painter) BarChart(optBarChartOption)error

BarChart renders a bar chart with the provided configuration to the painter.

func (*Painter)Bytes¶

func (p *Painter) Bytes() ([]byte,error)

Bytes returns the final rendered data as a byte slice.

func (*Painter)CandlestickChart¶added inv0.5.17

func (p *Painter) CandlestickChart(optCandlestickChartOption)error

CandlestickChart renders a candlestick chart with the provided configuration to the painter.

func (*Painter)Child¶

func (p *Painter) Child(opt ...PainterOptionFunc) *Painter

Child returns a painter with the provided options applied. Useful for rendering relative to a portion of the canvas via PainterBoxOption.

func (*Painter)Circle¶

func (p *Painter) Circle(radiusfloat64, x, yint, fillColor, strokeColorColor, strokeWidthfloat64)

Circle draws a circle at the given coords with a given radius.

func (*Painter)DashedLineStroke¶added inv0.5.17

func (p *Painter) DashedLineStroke(points []Point, strokeColorColor, strokeWidthfloat64, strokeDashArray []float64)

DashedLineStroke draws line segments through the provided points with dashed strokes.Points with values of math.MaxInt32 are skipped, resulting in a gap.

func (*Painter)Dots¶

func (p *Painter) Dots(points []Point, fillColor, strokeColorColor, strokeWidthfloat64, dotRadiusfloat64)

Dots prints filled circles for the given points.

func (*Painter)DoughnutChart¶added inv0.5.6

func (p *Painter) DoughnutChart(optDoughnutChartOption)error

DoughnutChart renders a doughnut or ring chart with the provided configuration to the painter.

func (*Painter)FillArea¶

func (p *Painter) FillArea(points []Point, fillColorColor)

FillArea draws a filled polygon through the given points, skipping "null" (MaxInt32) break values(filling the area flat between them).

func (*Painter)FilledDiamond¶added inv0.4.9

func (p *Painter) FilledDiamond(cx, cy, width, heightint, fillColor, strokeColorColor, strokeWidthfloat64)

FilledDiamond draws a filled diamond centered at (cx, cy) with the given width and height.

func (*Painter)FilledRect¶added inv0.4.3

func (p *Painter) FilledRect(x1, y1, x2, y2int, fillColor, strokeColorColor, strokeWidthfloat64)

FilledRect draws a filled box with the given coordinates.

func (*Painter)FunnelChart¶added inv0.4.0

func (p *Painter) FunnelChart(optFunnelChartOption)error

FunnelChart renders a funnel chart with the provided configuration to the painter.

func (*Painter)HeatMapChart¶added inv0.5.1

func (p *Painter) HeatMapChart(optHeatMapOption)error

HeatMapChart renders a heat map with the provided configuration to the painter.

func (*Painter)Height¶

func (p *Painter) Height()int

Height returns the drawable height of the painter's box.

func (*Painter)HorizontalBarChart¶added inv0.4.0

func (p *Painter) HorizontalBarChart(optHorizontalBarChartOption)error

HorizontalBarChart renders a horizontal bar chart with the provided configuration to the painter.

func (*Painter)HorizontalMarkLine¶added inv0.4.10

func (p *Painter) HorizontalMarkLine(x, y, widthint, fillColor, strokeColorColor, strokeWidthfloat64, strokeDashArray []float64)

HorizontalMarkLine draws a horizontal line with a small circle and arrow at the right.

func (*Painter)LayoutByGrid¶added inv0.5.19

func (p *Painter) LayoutByGrid(cols, rowsint)LayoutBuilderGrid

LayoutByGrid returns builder for dividing the painter into child painters with a grid based layout.This is typically the easiest way to align multiple charts on to a single Painter.Specify how many rows and columns the painter should be divided into,then define each child painter using CellAt and Span.

func (*Painter)LayoutByRows¶added inv0.5.19

func (p *Painter) LayoutByRows()LayoutBuilderRow

LayoutByRows returns builder for dividing the painter into child painters with a row-based layout.This provides a flexible way to create dashboards and complex layouts where rows are built progressively.The builder starts already in a row context, ready to accept column definitions immediately.

func (*Painter)LineChart¶added inv0.4.0

func (p *Painter) LineChart(optLineChartOption)error

LineChart renders a line chart with the provided configuration to the painter.

func (*Painter)LineStroke¶

func (p *Painter) LineStroke(points []Point, strokeColorColor, strokeWidthfloat64)

LineStroke draws a line in the graph from point to point with the specified stroke color/width.Points with values of math.MaxInt32 are skipped, resulting in a gap.Single or isolated points result in just a dot being drawn at the point.

func (*Painter)MeasureText¶

func (p *Painter) MeasureText(textstring, textRotationfloat64, fontStyleFontStyle)Box

MeasureText returns the rendered size of the text for the provided font style.

func (*Painter)PieChart¶added inv0.4.0

func (p *Painter) PieChart(optPieChartOption)error

PieChart renders a pie chart with the provided configuration to the painter.

func (*Painter)Pin¶

func (p *Painter) Pin(x, y, widthint, fillColor, strokeColorColor, strokeWidthfloat64)

Pin draws a pin shape (circle + curved tail).

func (*Painter)Polygon¶

func (p *Painter) Polygon(centerPoint, radiusfloat64, sidesint, strokeColorColor, strokeWidthfloat64)

Polygon draws a polygon with the specified center, radius, and number of sides.

func (*Painter)RadarChart¶added inv0.4.0

func (p *Painter) RadarChart(optRadarChartOption)error

RadarChart renders a radar chart with the provided configuration to the painter.

func (*Painter)ScatterChart¶added inv0.5.0

func (p *Painter) ScatterChart(optScatterChartOption)error

ScatterChart renders a scatter chart with the provided configuration to the painter.

func (*Painter)SmoothDashedLineStroke¶added inv0.5.17

func (p *Painter) SmoothDashedLineStroke(points []Point, tensionfloat64, strokeColorColor, strokeWidthfloat64, strokeDashArray []float64)

SmoothDashedLineStroke draws a smooth dashed curve through the given points.

func (*Painter)SmoothLineStroke¶

func (p *Painter) SmoothLineStroke(points []Point, tensionfloat64, strokeColorColor, strokeWidthfloat64)

SmoothLineStroke draws a smooth curve through the given points using Quadratic Bézier segments and atension parameter in [0..1] with 0 providing straight lines between midpoints and 1 providing a smoother line.Because tension smooths out the line, the line no longer hits the provided points exactly. The more variablethe points and the higher the tension, the more the line deviates.

func (*Painter)TableChart¶added inv0.4.0

func (p *Painter) TableChart(optTableChartOption)error

TableChart renders a table with the provided configuration to the painter.

func (*Painter)Text¶

func (p *Painter) Text(bodystring, x, yint, radiansfloat64, fontStyleFontStyle)

Text draws the given string at the specified position using the given font style.Specifying radians rotates the text.

func (*Painter)TextFit¶

func (p *Painter) TextFit(bodystring, x, y, widthint, fontStyleFontStyle, textAligns ...string)Box

TextFit draws multi-line text constrained to a given width.

func (*Painter)VerticalMarkLine¶added inv0.4.10

func (p *Painter) VerticalMarkLine(x, y, heightint, fillColor, strokeColorColor, strokeWidthfloat64, strokeDashArray []float64)

VerticalMarkLine draws a vertical line with a small dot at the bottom and an arrow at the top.

func (*Painter)Width¶

func (p *Painter) Width()int

Width returns the drawable width of the painter's box.

type PainterOptionFunc func(*Painter)

funcPainterBoxOption¶

func PainterBoxOption(boxBox)PainterOptionFunc

PainterBoxOption sets a specific drawing area for the Painter.

funcPainterFontOption¶

func PainterFontOption(font *truetype.Font)PainterOptionFunc

PainterFontOption sets the default font face for the Painter.Used when FontStyle in chart configs doesn't specify a font.

funcPainterPaddingOption¶

func PainterPaddingOption(paddingBox)PainterOptionFunc

PainterPaddingOption sets the padding within the painter canvas.

funcPainterThemeOption¶

func PainterThemeOption(themeColorPalette)PainterOptionFunc

PainterThemeOption sets the default theme for the Painter.Used when specific chart options don't have a theme set.

type PainterOptions struct {// OutputFormat specifies the output type: "svg", "png", "jpg". Default is "png".OutputFormatstring// Width is the width of the painter canvas.Widthint// Height is the height of the painter canvas.Heightint// Font is the default font for rendering text.Font *truetype.Font// Theme is the default theme used when charts don't specify one.ThemeColorPalette}

type PatternDetectionResult struct {// Index is the pattern's series data point position.Indexint// PatternName is the display name (e.g., "Doji", "Hammer").PatternNamestring// PatternType is the identifier constant (e.g., CandlestickPatternDoji).PatternTypestring}

type PatternFormatter func(patterns []PatternDetectionResult, seriesNamestring, valuefloat64) (string, *LabelStyle)

type PieChartOption struct {// Theme specifies the colors used for the pie chart.ThemeColorPalette// Padding specifies the padding around the chart.PaddingBox// Deprecated: Font is deprecated, instead the font needs to be set on the SeriesLabel, or other specific elements.Font *truetype.Font// SeriesList provides the data population for the chart. Typically constructed using NewSeriesListPie.SeriesListPieSeriesList// Title contains options for rendering the chart title.TitleTitleOption// Legend contains options for the data legend.LegendLegendOption// Radius sets the pie radius. Default is "40%".Radiusstring// SegmentGap provides the gap between each pie slice.SegmentGapfloat64// Deprecated: ValueFormatter is deprecated, instead set the ValueFormatter at `SeriesList[*].Label.ValueFormatter`.ValueFormatterValueFormatter}

funcNewPieChartOptionWithData¶added inv0.4.0

func NewPieChartOptionWithData(data []float64)PieChartOption

NewPieChartOptionWithData returns an initialized PieChartOption with the SeriesList set with the provided data slice.

type PieSeries struct {// Value provides the value for the pie section.Valuefloat64// Label provides the series labels.LabelSeriesLabel// Name specifies a name for the series.Namestring// Radius for Pie chart, e.g.: 40%, default is "40%"Radiusstring}

type PieSeriesList []PieSeries

funcNewSeriesListPie¶added inv0.4.0

func NewSeriesListPie(values []float64, opts ...PieSeriesOption)PieSeriesList

NewSeriesListPie builds a SeriesList for a pie chart.

func (PieSeriesList)MaxValue¶added inv0.5.0

func (pPieSeriesList) MaxValue()float64

MaxValue returns the maximum value within the series, or MinInt64 if no values.

func (PieSeriesList)SetSeriesLabels¶added inv0.5.6

func (pPieSeriesList) SetSeriesLabels(labelSeriesLabel)

SetSeriesLabels sets the label for all elements in the series.

func (PieSeriesList)SumSeries¶added inv0.5.0

func (pPieSeriesList) SumSeries()float64

func (PieSeriesList)ToGenericSeriesList¶added inv0.5.0

func (pPieSeriesList) ToGenericSeriesList()GenericSeriesList

type PieSeriesOption struct {LabelSeriesLabelNames []string}

type Point =chartdraw.Point

type RadarChartOption struct {// Theme specifies the colors used for the radar chart.ThemeColorPalette// Padding specifies the padding around the chart.PaddingBox// Deprecated: Font is deprecated, instead the font needs to be set on the SeriesLabel, or other specific elements.Font *truetype.Font// SeriesList provides the data population for the chart. Constructed using NewSeriesListRadar.SeriesListRadarSeriesList// Title contains options for rendering the chart title.TitleTitleOption// Legend contains options for the data legend.LegendLegendOption// RadarIndicators provides the radar indicator list.RadarIndicators []RadarIndicator// Radius sets the chart radius. Default is "40%".Radiusstring// ValueFormatter defines how float values are rendered to strings, notably for series labels.ValueFormatterValueFormatter}

funcNewRadarChartOptionWithData¶added inv0.4.0

func NewRadarChartOptionWithData(data [][]float64, names []string, values []float64)RadarChartOption

NewRadarChartOptionWithData returns an initialized RadarChartOption with the SeriesList set with the provided data slice.

type RadarIndicator struct {// Name specifies a name for the indicator.Namestring// Max is the maximum value of indicator.Maxfloat64// Min is the minimum value of indicator.Minfloat64// FontStyle provides the font configuration for the indicator.FontStyleFontStyle}

funcNewRadarIndicators¶

func NewRadarIndicators(names []string, values []float64) []RadarIndicator

NewRadarIndicators returns a radar indicator list.

type RadarSeries struct {// Values provides the series data list.Values []float64// Label provides the series labels.LabelSeriesLabel// Name specifies a name for the series.Namestring}

type RadarSeriesList []RadarSeries

funcNewSeriesListRadar¶added inv0.4.0

func NewSeriesListRadar(values [][]float64, opts ...RadarSeriesOption)RadarSeriesList

NewSeriesListRadar builds a SeriesList for a Radar chart.

func (RadarSeriesList)SetSeriesLabels¶added inv0.5.6

func (rRadarSeriesList) SetSeriesLabels(labelSeriesLabel)

SetSeriesLabels sets the label for all elements in the series.

func (RadarSeriesList)ToGenericSeriesList¶added inv0.5.0

func (rRadarSeriesList) ToGenericSeriesList()GenericSeriesList

type RadarSeriesOption struct {LabelSeriesLabelNames []string}

type ScatterChartOption struct {// Theme specifies the colors used for the scatter chart.ThemeColorPalette// Padding specifies the padding around the chart.PaddingBox// Deprecated: Font is deprecated, instead the font needs to be set on the SeriesLabel, or other specific elements.Font *truetype.Font// SeriesList provides the data population for the chart. Typically constructed using// NewSeriesListScatter or NewSeriesListScatterMultiValue.SeriesListScatterSeriesList// XAxis contains options for the x-axis.XAxisXAxisOption// YAxis contains options for the y-axis. At most two y-axes are supported.YAxis []YAxisOption// Title contains options for rendering the chart title.TitleTitleOption// Legend contains options for the data legend.LegendLegendOption// Symbol specifies the default shape for each data point. Default is 'dot'.// Options: 'circle', 'dot', 'square', 'diamond'. Can be overridden per series.SymbolSymbol// TODO - v0.6 - consider combining symbol with size into a SymbolStyle struct// SymbolSize specifies the size for each data point. Default is 2.0.SymbolSizefloat64// ValueFormatter defines how float values are rendered to strings, notably for numeric axis labels.ValueFormatterValueFormatter}

funcNewScatterChartOptionWithData¶added inv0.5.0

func NewScatterChartOptionWithData(data [][]float64)ScatterChartOption

NewScatterChartOptionWithData returns an initialized ScatterChartOption with the SeriesList set with the provided data slice.

funcNewScatterChartOptionWithSeries¶added inv0.5.9

func NewScatterChartOptionWithSeries(slScatterSeriesList)ScatterChartOption

NewScatterChartOptionWithSeries returns an initialized ScatterChartOption with the provided SeriesList.

type ScatterSeries struct {// Values provides the series data values.Values [][]float64// YAxisIndex is the index for the axis, it must be 0 or 1.YAxisIndexint// Label provides the series labels.LabelSeriesLabel// Name specifies a name for the series.Namestring// MarkLine provides a configuration for mark lines for this series. When using a MarkLine, you will want to// configure padding to the chart on the right for the values.MarkLineSeriesMarkLine// TrendLine provides configurations for trend lines for this series.TrendLine []SeriesTrendLine// Symbol specifies a custom symbol for the series.SymbolSymbol// TODO - v0.6 - consider combining symbol with size into a SymbolStyle struct// contains filtered or unexported fields}

func (*ScatterSeries)Summary¶added inv0.5.0

func (s *ScatterSeries) Summary() populationSummary

type ScatterSeriesList []ScatterSeries

funcNewSeriesListScatter¶added inv0.5.0

func NewSeriesListScatter(values [][]float64, opts ...ScatterSeriesOption)ScatterSeriesList

NewSeriesListScatter builds a SeriesList for a scatter chart. The first dimension of the values indicates the populationof the data, while the second dimension provides the samples for the population.

funcNewSeriesListScatterMultiValue¶added inv0.5.0

func NewSeriesListScatterMultiValue(values [][][]float64, opts ...ScatterSeriesOption)ScatterSeriesList

NewSeriesListScatterMultiValue builds a SeriesList for a scatter charts. The first dimension of the values indicatesthe population of the data, while the second dimension provides the samples for the population. Multiple values fora single sample can be provided using the last dimension.

func (ScatterSeriesList)SetSeriesLabels¶added inv0.5.6

func (sScatterSeriesList) SetSeriesLabels(labelSeriesLabel)

SetSeriesLabels sets the label for all elements in the series.

func (ScatterSeriesList)SumSeries¶added inv0.5.0

func (sScatterSeriesList) SumSeries() []float64

SumSeries returns a float64 slice with the sum of each series.

func (ScatterSeriesList)ToGenericSeriesList¶added inv0.5.6

func (sScatterSeriesList) ToGenericSeriesList()GenericSeriesList

type ScatterSeriesOption struct {LabelSeriesLabelNames     []stringMarkLineSeriesMarkLineTrendLine []SeriesTrendLine}

type SeriesLabel struct {// Show controls whether data labels are displayed for this series.// Use Ptr(true) to show labels, Ptr(false) to hide them, or nil for chart-specific defaults.Show *bool// LabelFormatter provides complete control over label content and per-point styling.// When set, this takes precedence for label production.LabelFormatterSeriesLabelFormatter// Deprecated: FormatTemplate is deprecated, use LabelFormatter instead for better control.// Template string for formatting data labels with placeholders://   {b}: the name of the data item//   {c}: the value of the data item//   {d}: the percentage of the data item (pie/doughnut charts only)// Example: "{b}: {c} ({d})" produces "Sales: 150 (25%)"FormatTemplatestring// ValueFormatter functions as the simplest method of number formatting or customization.// Only utilized when other methods are not set.ValueFormatterValueFormatter// FontStyle specifies the default font styling for labels in this series.// Individual labels can override this via LabelFormatter's LabelStyle return value.FontStyleFontStyle// Distance specifies the pixel distance between the label and its associated data point or chart element.Distanceint// TODO - do we want to replace with just Offset?// Offset specifies an offset from the position.OffsetOffsetInt}

type SeriesLabelFormatter func(indexint, namestring, valfloat64) (string, *LabelStyle)

funcLabelFormatterGradientColor¶added inv0.5.16

func LabelFormatterGradientColor(values []float64, colors ...Color)SeriesLabelFormatter

LabelFormatterGradientColor returns a SeriesLabelFormatter that colors labels with a gradient between multiple colors.The minimum value gets the first color, maximum value gets the last color, and intermediate values are interpolated.For two colors: lowColor -> highColor. For three+ colors: first -> second -> ... -> last.This formatter requires the complete data values to determine the min/max range for color interpolation.

funcLabelFormatterGradientGreenRed¶added inv0.5.16

func LabelFormatterGradientGreenRed(values []float64)SeriesLabelFormatter

LabelFormatterGradientGreenRed returns a SeriesLabelFormatter that colors labels from green (minimum) to red (maximum).This formatter requires the complete data values to determine the min/max range for color interpolation.

funcLabelFormatterGradientRedGreen¶added inv0.5.16

func LabelFormatterGradientRedGreen(values []float64)SeriesLabelFormatter

LabelFormatterGradientRedGreen returns a SeriesLabelFormatter that colors labels from red (minimum) to green (maximum).This formatter requires the complete data values to determine the min/max range for color interpolation.

funcLabelFormatterThresholdMax¶added inv0.5.16

func LabelFormatterThresholdMax(thresholdfloat64)SeriesLabelFormatter

LabelFormatterThresholdMax returns a SeriesLabelFormatter that only shows labels for values at or below the specified threshold.Values above the threshold will have empty labels (effectively hiding them).

funcLabelFormatterThresholdMin¶added inv0.5.16

func LabelFormatterThresholdMin(thresholdfloat64)SeriesLabelFormatter

LabelFormatterThresholdMin returns a SeriesLabelFormatter that only shows labels for values above the specified threshold.Values at or below the threshold will have empty labels (effectively hiding them).

funcLabelFormatterTopN¶added inv0.5.16

func LabelFormatterTopN(values []float64, nint)SeriesLabelFormatter

LabelFormatterTopN returns a SeriesLabelFormatter that only shows labels for the top N highest values in the provided slice.This formatter requires the complete data values to determine which values are in the top N.

type SeriesMark struct {// Type is the mark data type: "max", "min", "average". "average" is only for mark line.Typestring// Global specifies the mark references the sum of all series. Only used when// the Series is "Stacked" and the mark is on the LAST Series of the SeriesList.Globalbool}

type SeriesMarkLine struct {// ValueFormatter is used to produce the label for the Mark Line.ValueFormatterValueFormatter// Lines are the mark lines for the series.LinesSeriesMarkList}

funcNewMarkLine¶

func NewMarkLine(markLineTypes ...string)SeriesMarkLine

NewMarkLine returns a mark line for the provided types. Set on a specific Series instance.

func (*SeriesMarkLine)AddGlobalLines¶added inv0.5.0

func (m *SeriesMarkLine) AddGlobalLines(markTypes ...string)

AddGlobalLines adds "global" mark lines, which reference the sum of all series. These marksare only rendered when the Series is "Stacked" and the mark line is on the LAST Series of the SeriesList.

func (*SeriesMarkLine)AddLines¶added inv0.5.0

func (m *SeriesMarkLine) AddLines(markTypes ...string)

AddLines adds mark lines for the series.

type SeriesMarkList []SeriesMark

funcNewSeriesMarkGlobalList¶added inv0.5.0

func NewSeriesMarkGlobalList(markTypes ...string)SeriesMarkList

NewSeriesMarkGlobalList returns a slice of SeriesMark initialized for the given types with the global flag set.Global marks reference the sum of all series. Only used when the Series is "Stacked" and the mark ison the LAST Series of the SeriesList.

funcNewSeriesMarkList¶added inv0.5.0

func NewSeriesMarkList(markTypes ...string)SeriesMarkList

NewSeriesMarkList returns a SeriesMarkList initialized for the given types.

type SeriesMarkPoint struct {// SymbolSize is the width of symbol, default value is 28.SymbolSizeint// ValueFormatter is used to produce the label for the Mark Point.ValueFormatterValueFormatter// Points are the mark points for the series.PointsSeriesMarkList}

funcNewMarkPoint¶

func NewMarkPoint(markPointTypes ...string)SeriesMarkPoint

NewMarkPoint returns a mark point for the provided types. Set on a specific Series instance.

func (*SeriesMarkPoint)AddGlobalPoints¶added inv0.5.0

func (m *SeriesMarkPoint) AddGlobalPoints(markTypes ...string)

AddGlobalPoints adds "global" mark points, which reference the sum of all series. These marksare only rendered when the Series is "Stacked" and the mark point is on the LAST Series of the SeriesList.

func (*SeriesMarkPoint)AddPoints¶added inv0.5.0

func (m *SeriesMarkPoint) AddPoints(markTypes ...string)

AddPoints adds mark points for the series.

type SeriesTrendLine struct {// LineStrokeWidth is the width of the rendered line.LineStrokeWidthfloat64// StrokeSmoothingTension should be between 0 and 1. At 0 lines are sharp and precise, 1 provides smoother lines.StrokeSmoothingTensionfloat64// LineColor overrides the theme color for this trend line.LineColorColor// DashedLine indicates if the trend line will be a dashed line. Default depends on chart type.DashedLine *bool// Type specifies the trend line type: "linear", "cubic", "sma", "ema", "rsi".Typestring// Deprecated: Window is deprecated, use Period instead.Windowint// Period specifies the number of data points to consider for trend calculations.// Used by moving averages (SMA, EMA), Bollinger Bands, RSI, and other indicators.// For example, Period=20 calculates a 20-period moving average.Periodint}

funcNewTrendLine¶added inv0.5.0

func NewTrendLine(trendTypestring) []SeriesTrendLine

NewTrendLine returns a trend line for the provided type. Set on a specific Series instance.

type Symbolstring

type TableCell struct {// Text is the text content of the table cell.Textstring// FontStyle contains the font configuration for the cell text.FontStyleFontStyle// FillColor sets the background color for this table cell.FillColorColor// Row is the row index of the table cell.Rowint// Column is the column index of the table cell.Columnint}

type TableChartOption struct {// OutputFormat specifies the output type: "svg", "png", "jpg".OutputFormatstring// Theme specifies the colors used for the table.ThemeColorPalette// Padding specifies the padding around the table.PaddingBox// Width specifies the width of the table.Widthint// Header provides header data for the top of the table.Header []string// Data provides the row and column data for the table.Data [][]string// Spans provides the column span for each column.Spans []int// TextAligns specifies the text alignment for each cell.TextAligns []string// FontStyle contains the font configuration for table text.FontStyleFontStyle// HeaderBackgroundColor provides the background color for the header row.HeaderBackgroundColorColor// HeaderFontColor specifies the text color for header text.HeaderFontColorColor// RowBackgroundColors specifies the background colors for each row.RowBackgroundColors []Color// BackgroundColor specifies the general background color.BackgroundColorColor// CellModifier is an optional function to modify TableCell style or content before rendering.CellModifier func(TableCell)TableCell}

type ThemeOption struct {// IsDarkMode indicates whether the theme is designed for dark backgrounds, affecting color adjustments and text visibility.IsDarkModebool// AxisStrokeColor is the default stroke color for both axes.AxisStrokeColorColor// XAxisStrokeColor overrides AxisStrokeColor for the x-axis.XAxisStrokeColorColor// YAxisStrokeColor overrides AxisStrokeColor for the y-axis.YAxisStrokeColorColor// AxisSplitLineColor sets the color of grid lines drawn between ticks.AxisSplitLineColorColor// BackgroundColor sets the chart background.BackgroundColorColor// TextColor is the default font color applied if specific text colors are unset.TextColorColor// TextColorTitle sets the title text color.TextColorTitleColor// TextColorMark sets the color of mark line and point labels.TextColorMarkColor// TextColorLabel defines the color of series labels.TextColorLabelColor// TextColorLegend defines the legend text color.TextColorLegendColor// TextColorXAxis defines the x-axis label text color.TextColorXAxisColor// TextColorYAxis defines the y-axis label text color.TextColorYAxisColor// TitleBorderColor draws an optional border around the title.TitleBorderColorColor// LegendBorderColor draws an optional border around the legend.LegendBorderColorColor// SeriesColors provides the color palette used for series data.SeriesColors []Color// SeriesTrendColors provides the palette for rendered trend lines.SeriesTrendColors []Color// CandleWickColor is the color for the high-low wicks. If not set, uses body color.CandleWickColorColor// SeriesUpDownColors provides distinct up/down (bear/bull) color pairs for each series.SeriesUpDownColors [][2]Color}

type TitleOption struct {// Show specifies if the title should be rendered. Set to *false (via Ptr(false)) to hide the title.Show *bool// Theme specifies the colors used for the title.ThemeColorPalette// Text is the title text. Supports '\n' for line breaks.Textstring// Subtext is additional text below the title. Supports '\n' for line breaks.Subtextstring// Offset specifies the position of the title relative to the left and top sides.OffsetOffsetStr// FontStyle specifies the font, size, and style for the title text.FontStyleFontStyle// SubtextFontStyle specifies the font, size, and style for the subtext.SubtextFontStyleFontStyle// BorderWidth can be set to a non-zero value to render a box around the title.BorderWidthfloat64}

type ValueFormatter func(float64)string

type XAxisOption struct {// Show specifies if the x-axis should be rendered. Set to *false (via Ptr(false)) to hide the axis.Show *bool// Theme specifies the colors used for the x-axis.ThemeColorPalette// Title specifies a name for the axis. If set, the title is rendered below the x-axis.Titlestring// TitleFontStyle specifies the font, size, and color for the axis title.TitleFontStyleFontStyle// Labels provides labels for each value on the x-axis. Indices must match series data indices.Labels []string// DataStartIndex specifies the starting index for data values.DataStartIndexint// Deprecated: Position is deprecated. Currently, when set to `bottom` and the labels would render on the top// side of the axis line. However, the line would remain at the bottom of the chart. This seems confusing, and// attempts to actually move the axis line to the top of the chart are currently very messy looking. For that// reason this is currently deprecated. If a top x-Axis is valuable to you, please open a feature request.Positionstring// BoundaryGap specifies that the chart should have additional space on the left and right, with data points being// centered between two axis ticks. Default is set based on the dataset density / size to produce an easy-to-read// graph. Specify a *bool (through charts.Ptr(false) or charts.Ptr(true)) to enforce a spacing.BoundaryGap *bool// Deprecated: FontStyle is deprecated, use LabelFontStyle.FontStyleFontStyle// LabelFontStyle specifies the font configuration for each label.LabelFontStyleFontStyle// LabelRotation is the rotation angle in radians for labels. Use DegreesToRadians(float64) to convert from degrees.LabelRotationfloat64// LabelOffset is the position offset for each label.LabelOffsetOffsetInt// ValueFormatter defines how float values are rendered to strings, notably for numeric axis labels.ValueFormatterValueFormatter// Unit suggests the axis step size (recommendation only). Larger values result in fewer labels.Unitfloat64// LabelCount is the number of labels to show on the axis. Use a smaller count to reduce text collisions.LabelCountint// LabelCountAdjustment specifies a relative influence on how many labels should be rendered.// Typically, this is negative to result in cleaner graphs, positive values may result in text collisions.LabelCountAdjustmentint}

type YAxisOption struct {// Show specifies if the y-axis should be rendered. Set to *false (via Ptr(false)) to hide the axis.Show *bool// Theme specifies the colors used for the y-axis.ThemeColorPalette// Title specifies a name for the axis. If set, the axis name is rendered on the outside of the y-Axis.Titlestring// TitleFontStyle specifies the font, size, and color for the axis title.TitleFontStyleFontStyle// Min forces the minimum value of the y-axis when set (Use Ptr(float64)).Min *float64// Max forces the maximum value of the y-axis when set (Use Ptr(float64)).Max *float64// RangeValuePaddingScale suggests a padding scale to apply to the max and min values.RangeValuePaddingScale *float64// Labels provides labels for each value on the y-axis.Labels []string// Position describes the y-axis position: 'left' or 'right'.Positionstring// Deprecated: FontStyle is deprecated, use LabelFontStyle.FontStyleFontStyle// LabelFontStyle specifies the font configuration for each label.LabelFontStyleFontStyle// LabelRotation is the rotation angle in radians for labels. Use DegreesToRadians(float64) to convert from degrees.LabelRotationfloat64// Deprecated: Formatter is deprecated, use ValueFormatter instead.Formatterstring// Unit suggests the axis step size (recommendation only). Larger values result in fewer labels.Unitfloat64// LabelCount is the number of labels to show on the axis. Use a smaller count to reduce text collisions.LabelCountint// LabelCountAdjustment specifies relative influence on label count.// Negative values result in cleaner graphs; positive values may cause text collisions.LabelCountAdjustmentint// LabelSkipCount specifies a qty of lines between labels that show only horizontal lines without labels.LabelSkipCountint// SplitLineShow when set to *true shows horizontal axis split lines.SplitLineShow *bool// SpineLineShow controls whether the vertical spine line is shown.// Default is hidden unless it's a category axis.SpineLineShow *bool// ValueFormatter defines how float values are rendered to strings, notably for numeric axis labels.ValueFormatterValueFormatter// contains filtered or unexported fields}