types

package
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 29, 2026 License: MIT Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BarChartConfig

type BarChartConfig struct {
	ChartConfig
	Data        []DataPoint `json:"data"`
	Orientation string      `json:"orientation,omitempty"` // "vertical" or "horizontal"
	Grouped     bool        `json:"grouped,omitempty"`
	Stacked     bool        `json:"stacked,omitempty"`
	Color       string      `json:"color,omitempty"`
}

BarChartConfig configuration for bar charts

type BoxPlotConfig added in v1.1.0

type BoxPlotConfig struct {
	ChartConfig
	Data         []BoxPlotDataSet `json:"data"`
	ShowOutliers bool             `json:"show_outliers,omitempty"`
	ShowMean     bool             `json:"show_mean,omitempty"`
}

BoxPlotConfig configuration for box plots

type BoxPlotDataSet added in v1.1.0

type BoxPlotDataSet struct {
	Label  string    `json:"label"`
	Values []float64 `json:"values"`
}

BoxPlotDataSet represents data for one box in a box plot

type CandlestickConfig added in v1.1.0

type CandlestickConfig struct {
	ChartConfig
	Data       []CandlestickDataPoint `json:"data"`
	ShowVolume bool                   `json:"show_volume,omitempty"`
}

CandlestickConfig configuration for candlestick charts

type CandlestickDataPoint added in v1.1.0

type CandlestickDataPoint struct {
	Date   string  `json:"date"`
	Open   float64 `json:"open"`
	High   float64 `json:"high"`
	Low    float64 `json:"low"`
	Close  float64 `json:"close"`
	Volume float64 `json:"volume,omitempty"`
}

CandlestickDataPoint represents one candlestick

type ChartConfig

type ChartConfig struct {
	Title  string `json:"title,omitempty"`
	Width  int    `json:"width,omitempty"`
	Height int    `json:"height,omitempty"`
	Theme  string `json:"theme,omitempty"`
}

ChartConfig represents common chart configuration

type ChartOutput

type ChartOutput struct {
	SVG      string            `json:"svg"`
	Metadata map[string]string `json:"metadata,omitempty"`
}

ChartOutput represents the output of a chart generation

type ChordConfig added in v1.1.0

type ChordConfig struct {
	ChartConfig
	Entities  []ChordEntity   `json:"entities"`
	Relations []ChordRelation `json:"relations"`
}

ChordConfig configuration for chord diagrams

type ChordEntity added in v1.1.0

type ChordEntity struct {
	ID    string `json:"id"`
	Label string `json:"label"`
	Color string `json:"color,omitempty"`
}

ChordEntity represents an entity in chord diagram

type ChordRelation added in v1.1.0

type ChordRelation struct {
	Source string  `json:"source"`
	Target string  `json:"target"`
	Value  float64 `json:"value"`
}

ChordRelation represents a relation in chord diagram

type CirclePackingConfig added in v1.1.0

type CirclePackingConfig struct {
	ChartConfig
	Data       TreeNode `json:"data"`
	ShowLabels bool     `json:"show_labels,omitempty"`
}

CirclePackingConfig configuration for circle packing charts

type CircularBarConfig added in v1.1.0

type CircularBarConfig struct {
	ChartConfig
	Data        []CircularBarPoint `json:"data"`
	InnerRadius float64            `json:"inner_radius,omitempty"`
}

CircularBarConfig configuration for circular bar plots

type CircularBarPoint added in v1.1.0

type CircularBarPoint struct {
	Label string  `json:"label"`
	Value float64 `json:"value"`
	Color string  `json:"color,omitempty"`
}

CircularBarPoint represents a point in circular bar plot

type ConnectedScatterConfig added in v1.1.0

type ConnectedScatterConfig struct {
	ChartConfig
	Series []ConnectedScatterSeries `json:"series"`
}

ConnectedScatterConfig configuration for connected scatter plots

type ConnectedScatterPoint added in v1.1.0

type ConnectedScatterPoint struct {
	X     float64 `json:"x"`
	Y     float64 `json:"y"`
	Label string  `json:"label,omitempty"`
}

ConnectedScatterPoint represents a point in connected scatter

type ConnectedScatterSeries added in v1.1.0

type ConnectedScatterSeries struct {
	Points     []ConnectedScatterPoint `json:"points"`
	Label      string                  `json:"label,omitempty"`
	Color      string                  `json:"color,omitempty"`
	MarkerType string                  `json:"marker_type,omitempty"`
}

ConnectedScatterSeries represents a series

type CorrelogramConfig added in v1.1.0

type CorrelogramConfig struct {
	ChartConfig
	Variables []string    `json:"variables"`
	Matrix    [][]float64 `json:"matrix"`
}

CorrelogramConfig configuration for correlograms

type DataPoint

type DataPoint struct {
	Label string  `json:"label"`
	Value float64 `json:"value"`
}

DataPoint represents a simple labeled value

type DendrogramConfig added in v1.1.0

type DendrogramConfig struct {
	ChartConfig
	Root        *DendrogramNode `json:"root"`
	Orientation string          `json:"orientation,omitempty"`
}

DendrogramConfig configuration for dendrograms

type DendrogramNode added in v1.1.0

type DendrogramNode struct {
	Label    string            `json:"label,omitempty"`
	Height   float64           `json:"height"`
	Children []*DendrogramNode `json:"children,omitempty"`
}

DendrogramNode represents a node in dendrogram (recursive)

type DensityConfig added in v1.1.0

type DensityConfig struct {
	ChartConfig
	Data     []DensityDataSet `json:"data"`
	ShowFill bool             `json:"show_fill,omitempty"`
	ShowRug  bool             `json:"show_rug,omitempty"`
}

DensityConfig configuration for density plots

type DensityDataSet added in v1.1.0

type DensityDataSet struct {
	Values []float64 `json:"values"`
	Label  string    `json:"label,omitempty"`
	Color  string    `json:"color,omitempty"`
}

DensityDataSet represents a density distribution

type HeatmapConfig

type HeatmapConfig struct {
	ChartConfig
	Data      MatrixData `json:"data"`
	ColorMap  string     `json:"color_map,omitempty"` // "viridis", "plasma", etc.
	ShowValue bool       `json:"show_value,omitempty"`
}

HeatmapConfig configuration for heatmaps

type HistogramConfig added in v1.1.0

type HistogramConfig struct {
	ChartConfig
	Values []float64 `json:"values"`
	Bins   int       `json:"bins,omitempty"`
}

HistogramConfig configuration for histogram charts

type IcicleConfig added in v1.1.0

type IcicleConfig struct {
	ChartConfig
	Data        TreeNode `json:"data"`
	Orientation string   `json:"orientation,omitempty"` // "vertical" or "horizontal"
	ShowLabels  bool     `json:"show_labels,omitempty"`
}

IcicleConfig configuration for icicle charts

type LineChartConfig

type LineChartConfig struct {
	ChartConfig
	Series []Series `json:"series"`
	XLabel string   `json:"x_label,omitempty"`
	YLabel string   `json:"y_label,omitempty"`
	Area   bool     `json:"area,omitempty"` // Fill area under line
}

LineChartConfig configuration for line charts

type LollipopConfig added in v1.1.0

type LollipopConfig struct {
	ChartConfig
	Values     []LollipopPoint `json:"values"`
	Color      string          `json:"color,omitempty"`
	Horizontal bool            `json:"horizontal,omitempty"`
}

LollipopConfig configuration for lollipop charts

type LollipopPoint added in v1.1.0

type LollipopPoint struct {
	Label string  `json:"label"`
	Value float64 `json:"value"`
	Color string  `json:"color,omitempty"`
}

LollipopPoint represents a single lollipop

type MatrixData

type MatrixData struct {
	Rows    []string    `json:"rows"`
	Columns []string    `json:"columns"`
	Values  [][]float64 `json:"values"`
}

MatrixData represents matrix/heatmap data

type OHLCConfig added in v1.1.0

type OHLCConfig struct {
	ChartConfig
	Data []CandlestickDataPoint `json:"data"` // Reuse same data structure
}

OHLCConfig configuration for OHLC bar charts

type ParallelAxis added in v1.1.0

type ParallelAxis struct {
	Label string  `json:"label"`
	Min   float64 `json:"min"`
	Max   float64 `json:"max"`
}

ParallelAxis represents an axis in parallel coordinates

type ParallelConfig added in v1.1.0

type ParallelConfig struct {
	ChartConfig
	Axes []ParallelAxis      `json:"axes"`
	Data []ParallelDataPoint `json:"data"`
}

ParallelConfig configuration for parallel coordinates

type ParallelDataPoint added in v1.1.0

type ParallelDataPoint struct {
	Values []float64 `json:"values"`
	Color  string    `json:"color,omitempty"`
}

ParallelDataPoint represents a data point

type PieChartConfig

type PieChartConfig struct {
	ChartConfig
	Data  []DataPoint `json:"data"`
	Donut bool        `json:"donut,omitempty"`
}

PieChartConfig configuration for pie charts

type Point

type Point struct {
	X interface{} `json:"x"` // Can be number, string, or time
	Y float64     `json:"y"`
}

Point represents an X,Y coordinate

type RadarAxis added in v1.1.0

type RadarAxis struct {
	Label string  `json:"label"`
	Min   float64 `json:"min"`
	Max   float64 `json:"max"`
}

RadarAxis represents an axis in radar chart

type RadarConfig added in v1.1.0

type RadarConfig struct {
	ChartConfig
	Axes   []RadarAxis   `json:"axes"`
	Series []RadarSeries `json:"series"`
}

RadarConfig configuration for radar charts

type RadarSeries added in v1.1.0

type RadarSeries struct {
	Label  string    `json:"label"`
	Values []float64 `json:"values"`
	Color  string    `json:"color,omitempty"`
}

RadarSeries represents a data series

type RidgelineConfig added in v1.1.0

type RidgelineConfig struct {
	ChartConfig
	Data       []RidgelineDataSet `json:"data"`
	Overlap    float64            `json:"overlap,omitempty"`
	ShowLabels bool               `json:"show_labels,omitempty"`
}

RidgelineConfig configuration for ridgeline plots

type RidgelineDataSet added in v1.1.0

type RidgelineDataSet struct {
	Label  string    `json:"label"`
	Values []float64 `json:"values"`
}

RidgelineDataSet represents one ridge in a ridgeline plot

type SankeyConfig added in v1.1.0

type SankeyConfig struct {
	ChartConfig
	Nodes []SankeyNode `json:"nodes"`
	Links []SankeyLink `json:"links"`
}

SankeyConfig configuration for Sankey diagrams

type SankeyLink struct {
	Source string  `json:"source"`
	Target string  `json:"target"`
	Value  float64 `json:"value"`
	Color  string  `json:"color,omitempty"`
}

SankeyLink represents a link in Sankey diagram

type SankeyNode added in v1.1.0

type SankeyNode struct {
	ID    string `json:"id"`
	Label string `json:"label"`
	Color string `json:"color,omitempty"`
}

SankeyNode represents a node in Sankey diagram

type ScatterPlotConfig

type ScatterPlotConfig struct {
	ChartConfig
	Data   []XYPoint `json:"data"`
	XLabel string    `json:"x_label,omitempty"`
	YLabel string    `json:"y_label,omitempty"`
}

ScatterPlotConfig configuration for scatter plots

type Series

type Series struct {
	Name  string  `json:"name"`
	Data  []Point `json:"data"`
	Color string  `json:"color,omitempty"`
}

Series represents a named data series

type StackedAreaConfig added in v1.1.0

type StackedAreaConfig struct {
	ChartConfig
	Points []StackedAreaPoint  `json:"points"`
	Series []StackedAreaSeries `json:"series"`
}

StackedAreaConfig configuration for stacked area charts

type StackedAreaPoint added in v1.1.0

type StackedAreaPoint struct {
	X      float64   `json:"x"`
	Values []float64 `json:"values"`
}

StackedAreaPoint represents a point with multiple values

type StackedAreaSeries added in v1.1.0

type StackedAreaSeries struct {
	Label string `json:"label"`
	Color string `json:"color,omitempty"`
}

StackedAreaSeries represents series metadata

type StreamChartConfig added in v1.1.0

type StreamChartConfig struct {
	ChartConfig
	Points []StackedAreaPoint  `json:"points"` // Reuse stacked area point
	Series []StackedAreaSeries `json:"series"` // Reuse stacked area series
	Layout string              `json:"layout,omitempty"`
}

StreamChartConfig configuration for stream charts

type SunburstConfig added in v1.1.0

type SunburstConfig struct {
	ChartConfig
	Data       TreeNode `json:"data"`
	ShowLabels bool     `json:"show_labels,omitempty"`
}

SunburstConfig configuration for sunburst charts

type TreeNode added in v1.1.0

type TreeNode struct {
	Name     string      `json:"name"`
	Value    float64     `json:"value,omitempty"`
	Children []*TreeNode `json:"children,omitempty"`
}

TreeNode represents hierarchical tree data

type TreemapConfig added in v1.1.0

type TreemapConfig struct {
	ChartConfig
	Data       TreeNode `json:"data"`
	ShowLabels bool     `json:"show_labels,omitempty"`
}

TreemapConfig configuration for treemap charts

type ViolinPlotConfig added in v1.1.0

type ViolinPlotConfig struct {
	ChartConfig
	Data       []BoxPlotDataSet `json:"data"` // Reuse BoxPlotDataSet structure
	ShowBox    bool             `json:"show_box,omitempty"`
	ShowMedian bool             `json:"show_median,omitempty"`
}

ViolinPlotConfig configuration for violin plots

type WordCloudConfig added in v1.1.0

type WordCloudConfig struct {
	ChartConfig
	Words  []WordCloudWord `json:"words"`
	Layout string          `json:"layout,omitempty"`
}

WordCloudConfig configuration for word clouds

type WordCloudWord added in v1.1.0

type WordCloudWord struct {
	Text      string  `json:"text"`
	Frequency float64 `json:"frequency"`
	Color     string  `json:"color,omitempty"`
}

WordCloudWord represents a word in word cloud

type XYPoint

type XYPoint struct {
	X     float64 `json:"x"`
	Y     float64 `json:"y"`
	Label string  `json:"label,omitempty"`
	Size  float64 `json:"size,omitempty"` // For bubble charts
}

XYPoint represents a point in 2D space

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL