Perses
Docs

TimeSeries Panel Builder

Constructor

import "github.com/perses/perses/go-sdk/panel/time-series"

var options []timeseries.Option
timeseries.Chart(options...)

Need a list of options.

Default options

  • None

Available options

WithLegend

import "github.com/perses/perses/go-sdk/common"
import "github.com/perses/perses/go-sdk/panel/time-series"

timeseries.WithLegend(timeseries.Legend{...})

Define legend properties of the chart.

WithTooltip

import "github.com/perses/perses/go-sdk/common"
import "github.com/perses/perses/go-sdk/panel/time-series"

timeseries.WithTooltip(timeseries.Tooltip{...})

Define tooltip properties of the chart.

WithYAxis

import "github.com/perses/perses/go-sdk/common"
import "github.com/perses/perses/go-sdk/panel/time-series"

timeseries.WithYAxis(timeseries.YAxis{...})

Define Y axis properties of the chart.

Thresholds

import "github.com/perses/perses/go-sdk/common"
import "github.com/perses/perses/go-sdk/panel/time-series"

timeseries.Thresholds(common.Thresholds{...})

Define chart thresholds.

WithVisual

import "github.com/perses/perses/go-sdk/panel/time-series"

timeseries.WithVisual(timeseries.Visual{...})

Define visual properties of the chart.

WithQuerySettings

import "github.com/perses/perses/go-sdk/panel/time-series"

timeseries.WithQuerySettings([]timeseries.QuerySettingsItem{...})

Define settings for the queries.

Example

package main

import (
	"github.com/perses/perses/go-sdk/dashboard"
	panelgroup "github.com/perses/perses/go-sdk/panel-group"
	timeseries "github.com/perses/perses/go-sdk/panel/time-series"
)

func main() {
	dashboard.New("Example Dashboard",
		dashboard.AddPanelGroup("Resource usage",
			panelgroup.AddPanel("Container memory",
				timeseries.Chart(
					timeseries.WithLegend(timeseries.Legend{
						Position: timeseries.BottomPosition,
						Mode:     timeseries.ListMode,
						Size:     timeseries.SmallSize,
					}),
					timeseries.WithTooltip(timeseries.Tooltip{
						EnablePinning: false,
					}),
				),
			),
		),
	)
}
Prev
Text Variable builder
Next
User