TimeSeriesChart Go SDK

Constructor#

import "github.com/perses/plugins/timeserieschart/sdk/go"

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"
    "github.com/perses/plugins/timeserieschart/sdk/go"
)

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

Define legend properties of the chart.

WithTooltip#

import (
    "github.com/perses/perses/go-sdk/common"
    "github.com/perses/plugins/timeserieschart/sdk/go"
)

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

Define tooltip properties of the chart.

WithYAxis#

import (
    "github.com/perses/perses/go-sdk/common"
    "github.com/perses/plugins/timeserieschart/sdk/go"
)

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

Define Y axis properties of the chart.

Thresholds#

import (
    "github.com/perses/perses/go-sdk/common"
    "github.com/perses/plugins/timeserieschart/sdk/go"
)

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

Define chart thresholds.

WithVisual#

import "github.com/perses/plugins/timeserieschart/sdk/go"

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

Define visual properties of the chart.

WithQuerySettings#

import "github.com/perses/plugins/timeserieschart/sdk/go"

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"
	"github.com/perses/plugins/timeserieschart/sdk/go"
)

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,
					}),
				),
			),
		),
	)
}