pie

package

v0.12.1 Latest Latest Go to latest Published: Nov 21, 2025 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/perses/plugins

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const PluginKind = "PieChart"

Variables ¶

This section is empty.

Functions ¶

func Chart ¶

func Chart(options ...Option) panel.Option

Types ¶

type Builder ¶

type Builder struct {
	PluginSpec `json:",inline" yaml:",inline"`
}

type ColorMode ¶

type ColorMode string

const (
	FixedMode       ColorMode = "fixed"
	FixedSingleMode ColorMode = "fixed-single"
)

type Legend ¶

type Legend struct {
	Position LegendPosition       `json:"position" yaml:"position"`
	Mode     LegendMode           `json:"mode,omitempty" yaml:"mode,omitempty"`
	Size     LegendSize           `json:"size,omitempty" yaml:"size,omitempty"`
	Values   []common.Calculation `json:"values,omitempty" yaml:"values,omitempty"`
}

type LegendMode ¶

type LegendMode string

const (
	ListMode  LegendMode = "list"
	TableMode LegendMode = "table"
)

type LegendPosition ¶

type LegendPosition string

const (
	BottomPosition LegendPosition = "bottom"
	RightPosition  LegendPosition = "right"
)

type LegendSize ¶

type LegendSize string

const (
	SmallSize  LegendSize = "small"
	MediumSize LegendSize = "medium"
)

type Option ¶

type Option func(plugin *Builder) error

func WithFormat ¶

func WithFormat(format *common.Format) Option

func WithLegend ¶

func WithLegend(legend Legend) Option

func WithQuerySettings ¶

func WithQuerySettings(querySettingsList []QuerySettingsItem) Option

func WithVisual ¶

func WithVisual(visual Visual) Option

type Palette ¶

type Palette struct {
	Mode PaletteMode `json:"mode" yaml:"mode"`
}

type PaletteMode ¶

type PaletteMode string

const (
	AutoMode        PaletteMode = "auto"
	CategoricalMode PaletteMode = "categorical"
)

type PluginMode ¶

type PluginMode string

const (
	ValueMode      PluginMode = "value"
	PercentageMode PluginMode = "percentage"
)

type PluginSpec ¶

type PluginSpec struct {
	Legend        *Legend              `json:"legend,omitempty" yaml:"legend,omitempty"`
	QuerySettings *[]QuerySettingsItem `json:"querySettings,omitempty" yaml:"querySettings,omitempty"`
	Calculation   common.Calculation   `json:"calculation" yaml:"calculation"`
	Format        *common.Format       `json:"format,omitempty" yaml:"format,omitempty"`
	Sort          Sort                 `json:"sort,omitempty" yaml:"sort,omitempty"`
	Mode          PluginMode           `json:"mode,omitempty" yaml:"mode,omitempty"`
	Visual        *Visual              `json:"visual,omitempty" yaml:"visual,omitempty"`
	Radius        int                  `json:"radius" yaml:"radius"`
}

type QuerySettingsItem ¶

type QuerySettingsItem struct {
	QueryIndex uint      `json:"queryIndex" yaml:"queryIndex"`
	ColorMode  ColorMode `json:"colorMode" yaml:"colorMode"`
	ColorValue string    `json:"colorValue" yaml:"colorValue"`
}

type Sort ¶

type Sort string

const (
	AscendingSort  Sort = "asc"
	DescendingSort Sort = "desc"
)

type Visual ¶

type Visual struct {
	Display      VisualDisplay    `json:"display,omitempty" yaml:"display,omitempty"`
	LineWidth    float64          `json:"lineWidth,omitempty" yaml:"lineWidth,omitempty"`
	AreaOpacity  float64          `json:"areaOpacity,omitempty" yaml:"areaOpacity,omitempty"`
	ShowPoints   VisualShowPoints `json:"showPoints,omitempty" yaml:"showPoints,omitempty"`
	Palette      Palette          `json:"palette,omitempty" yaml:"palette,omitempty"`
	PointRadius  float64          `json:"pointRadius,omitempty" yaml:"pointRadius,omitempty"`
	Stack        VisualStack      `json:"stack,omitempty" yaml:"stack,omitempty"`
	ConnectNulls bool             `json:"connectNulls,omitempty" yaml:"connectNulls,omitempty"`
}

type VisualDisplay ¶

type VisualDisplay string

const (
	LineDisplay VisualDisplay = "line"
	BarDisplay  VisualDisplay = "bar"
)

type VisualShowPoints ¶

type VisualShowPoints string

const (
	AutoShowPoints   VisualShowPoints = "auto"
	AlwaysShowPoints VisualShowPoints = "always"
)

type VisualStack ¶

type VisualStack string

const (
	AllStack        VisualStack = "all"
	PercentageStack VisualStack = "percent"
)

Source Files ¶

View all Source files

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

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func Chart ¶

Types ¶

type Builder ¶

type ColorMode ¶

type Legend ¶

type LegendMode ¶

type LegendPosition ¶

type LegendSize ¶

type Option ¶

func WithFormat ¶

func WithLegend ¶

func WithQuerySettings ¶

func WithVisual ¶

type Palette ¶

type PaletteMode ¶

type PluginMode ¶

type PluginSpec ¶

type QuerySettingsItem ¶

type Sort ¶

type Visual ¶

type VisualDisplay ¶

type VisualShowPoints ¶

type VisualStack ¶

Source Files ¶