common

package
v0.0.0-...-30bcf85 Latest Latest
Warning

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

Go to latest
Published: Nov 28, 2024 License: Apache-2.0 Imports: 6 Imported by: 18

Documentation

Index

Constants

View Source
const TimeZoneBrowser = "browser"

Use the timezone defined by end user web browser

View Source
const TimeZoneUtc = "utc"

Use UTC/GMT timezone

Variables

This section is empty.

Functions

func AxisConfigConverter

func AxisConfigConverter(input AxisConfig) string

AxisConfigConverter accepts a `AxisConfig` object and generates the Go code to build this object using builders.

func BarConfigConverter

func BarConfigConverter(input BarConfig) string

BarConfigConverter accepts a `BarConfig` object and generates the Go code to build this object using builders.

func BaseDimensionConfigConverter

func BaseDimensionConfigConverter(input BaseDimensionConfig) string

BaseDimensionConfigConverter accepts a `BaseDimensionConfig` object and generates the Go code to build this object using builders.

func ColorDimensionConfigConverter

func ColorDimensionConfigConverter(input ColorDimensionConfig) string

ColorDimensionConfigConverter accepts a `ColorDimensionConfig` object and generates the Go code to build this object using builders.

func DataQueryConverter

func DataQueryConverter(input DataQuery) string

DataQueryConverter accepts a `DataQuery` object and generates the Go code to build this object using builders.

func DataSourceJsonDataConverter

func DataSourceJsonDataConverter(input DataSourceJsonData) string

DataSourceJsonDataConverter accepts a `DataSourceJsonData` object and generates the Go code to build this object using builders.

func FillConfigConverter

func FillConfigConverter(input FillConfig) string

FillConfigConverter accepts a `FillConfig` object and generates the Go code to build this object using builders.

func FrameGeometrySourceConverter

func FrameGeometrySourceConverter(input FrameGeometrySource) string

FrameGeometrySourceConverter accepts a `FrameGeometrySource` object and generates the Go code to build this object using builders.

func GraphFieldConfigConverter

func GraphFieldConfigConverter(input GraphFieldConfig) string

GraphFieldConfigConverter accepts a `GraphFieldConfig` object and generates the Go code to build this object using builders.

func GraphThresholdsStyleConfigConverter

func GraphThresholdsStyleConfigConverter(input GraphThresholdsStyleConfig) string

GraphThresholdsStyleConfigConverter accepts a `GraphThresholdsStyleConfig` object and generates the Go code to build this object using builders.

func HeatmapCalculationBucketConfigConverter

func HeatmapCalculationBucketConfigConverter(input HeatmapCalculationBucketConfig) string

HeatmapCalculationBucketConfigConverter accepts a `HeatmapCalculationBucketConfig` object and generates the Go code to build this object using builders.

func HeatmapCalculationOptionsConverter

func HeatmapCalculationOptionsConverter(input HeatmapCalculationOptions) string

HeatmapCalculationOptionsConverter accepts a `HeatmapCalculationOptions` object and generates the Go code to build this object using builders.

func HideSeriesConfigConverter

func HideSeriesConfigConverter(input HideSeriesConfig) string

HideSeriesConfigConverter accepts a `HideSeriesConfig` object and generates the Go code to build this object using builders.

func HideableFieldConfigConverter

func HideableFieldConfigConverter(input HideableFieldConfig) string

HideableFieldConfigConverter accepts a `HideableFieldConfig` object and generates the Go code to build this object using builders.

func LineConfigConverter

func LineConfigConverter(input LineConfig) string

LineConfigConverter accepts a `LineConfig` object and generates the Go code to build this object using builders.

func LineStyleConverter

func LineStyleConverter(input LineStyle) string

LineStyleConverter accepts a `LineStyle` object and generates the Go code to build this object using builders.

func MapLayerOptionsConverter

func MapLayerOptionsConverter(input MapLayerOptions) string

MapLayerOptionsConverter accepts a `MapLayerOptions` object and generates the Go code to build this object using builders.

func OptionsWithLegendConverter

func OptionsWithLegendConverter(input OptionsWithLegend) string

OptionsWithLegendConverter accepts a `OptionsWithLegend` object and generates the Go code to build this object using builders.

func OptionsWithTextFormattingConverter

func OptionsWithTextFormattingConverter(input OptionsWithTextFormatting) string

OptionsWithTextFormattingConverter accepts a `OptionsWithTextFormatting` object and generates the Go code to build this object using builders.

func OptionsWithTimezonesConverter

func OptionsWithTimezonesConverter(input OptionsWithTimezones) string

OptionsWithTimezonesConverter accepts a `OptionsWithTimezones` object and generates the Go code to build this object using builders.

func OptionsWithTooltipConverter

func OptionsWithTooltipConverter(input OptionsWithTooltip) string

OptionsWithTooltipConverter accepts a `OptionsWithTooltip` object and generates the Go code to build this object using builders.

func PointsConfigConverter

func PointsConfigConverter(input PointsConfig) string

PointsConfigConverter accepts a `PointsConfig` object and generates the Go code to build this object using builders.

func ReduceDataOptionsConverter

func ReduceDataOptionsConverter(input ReduceDataOptions) string

ReduceDataOptionsConverter accepts a `ReduceDataOptions` object and generates the Go code to build this object using builders.

func ResourceDimensionConfigConverter

func ResourceDimensionConfigConverter(input ResourceDimensionConfig) string

ResourceDimensionConfigConverter accepts a `ResourceDimensionConfig` object and generates the Go code to build this object using builders.

func ScalarDimensionConfigConverter

func ScalarDimensionConfigConverter(input ScalarDimensionConfig) string

ScalarDimensionConfigConverter accepts a `ScalarDimensionConfig` object and generates the Go code to build this object using builders.

func ScaleDimensionConfigConverter

func ScaleDimensionConfigConverter(input ScaleDimensionConfig) string

ScaleDimensionConfigConverter accepts a `ScaleDimensionConfig` object and generates the Go code to build this object using builders.

func ScaleDistributionConfigConverter

func ScaleDistributionConfigConverter(input ScaleDistributionConfig) string

ScaleDistributionConfigConverter accepts a `ScaleDistributionConfig` object and generates the Go code to build this object using builders.

func SingleStatBaseOptionsConverter

func SingleStatBaseOptionsConverter(input SingleStatBaseOptions) string

SingleStatBaseOptionsConverter accepts a `SingleStatBaseOptions` object and generates the Go code to build this object using builders.

func StackableFieldConfigConverter

func StackableFieldConfigConverter(input StackableFieldConfig) string

StackableFieldConfigConverter accepts a `StackableFieldConfig` object and generates the Go code to build this object using builders.

func StackingConfigConverter

func StackingConfigConverter(input StackingConfig) string

StackingConfigConverter accepts a `StackingConfig` object and generates the Go code to build this object using builders.

func TableBarGaugeCellOptionsConverter

func TableBarGaugeCellOptionsConverter(input TableBarGaugeCellOptions) string

TableBarGaugeCellOptionsConverter accepts a `TableBarGaugeCellOptions` object and generates the Go code to build this object using builders.

func TableColoredBackgroundCellOptionsConverter

func TableColoredBackgroundCellOptionsConverter(input TableColoredBackgroundCellOptions) string

TableColoredBackgroundCellOptionsConverter accepts a `TableColoredBackgroundCellOptions` object and generates the Go code to build this object using builders.

func TableFieldOptionsConverter

func TableFieldOptionsConverter(input TableFieldOptions) string

TableFieldOptionsConverter accepts a `TableFieldOptions` object and generates the Go code to build this object using builders.

func TableFooterOptionsConverter

func TableFooterOptionsConverter(input TableFooterOptions) string

TableFooterOptionsConverter accepts a `TableFooterOptions` object and generates the Go code to build this object using builders.

func TableSortByFieldStateConverter

func TableSortByFieldStateConverter(input TableSortByFieldState) string

TableSortByFieldStateConverter accepts a `TableSortByFieldState` object and generates the Go code to build this object using builders.

func TableSparklineCellOptionsConverter

func TableSparklineCellOptionsConverter(input TableSparklineCellOptions) string

TableSparklineCellOptionsConverter accepts a `TableSparklineCellOptions` object and generates the Go code to build this object using builders.

func TextDimensionConfigConverter

func TextDimensionConfigConverter(input TextDimensionConfig) string

TextDimensionConfigConverter accepts a `TextDimensionConfig` object and generates the Go code to build this object using builders.

func VizLegendOptionsConverter

func VizLegendOptionsConverter(input VizLegendOptions) string

VizLegendOptionsConverter accepts a `VizLegendOptions` object and generates the Go code to build this object using builders.

func VizTextDisplayOptionsConverter

func VizTextDisplayOptionsConverter(input VizTextDisplayOptions) string

VizTextDisplayOptionsConverter accepts a `VizTextDisplayOptions` object and generates the Go code to build this object using builders.

func VizTooltipOptionsConverter

func VizTooltipOptionsConverter(input VizTooltipOptions) string

VizTooltipOptionsConverter accepts a `VizTooltipOptions` object and generates the Go code to build this object using builders.

Types

type AxisColorMode

type AxisColorMode string

TODO docs

const (
	AxisColorModeText   AxisColorMode = "text"
	AxisColorModeSeries AxisColorMode = "series"
)

type AxisConfig

type AxisConfig struct {
	AxisPlacement     *AxisPlacement           `json:"axisPlacement,omitempty"`
	AxisColorMode     *AxisColorMode           `json:"axisColorMode,omitempty"`
	AxisLabel         *string                  `json:"axisLabel,omitempty"`
	AxisWidth         *float64                 `json:"axisWidth,omitempty"`
	AxisSoftMin       *float64                 `json:"axisSoftMin,omitempty"`
	AxisSoftMax       *float64                 `json:"axisSoftMax,omitempty"`
	AxisGridShow      *bool                    `json:"axisGridShow,omitempty"`
	ScaleDistribution *ScaleDistributionConfig `json:"scaleDistribution,omitempty"`
	AxisCenteredZero  *bool                    `json:"axisCenteredZero,omitempty"`
	AxisBorderShow    *bool                    `json:"axisBorderShow,omitempty"`
}

TODO docs

func NewAxisConfig

func NewAxisConfig() *AxisConfig

NewAxisConfig creates a new AxisConfig object.

func (AxisConfig) Equals

func (resource AxisConfig) Equals(other AxisConfig) bool

Equals tests the equality of two `AxisConfig` objects.

func (*AxisConfig) UnmarshalJSONStrict

func (resource *AxisConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `AxisConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (AxisConfig) Validate

func (resource AxisConfig) Validate() error

Validate checks all the validation constraints that may be defined on `AxisConfig` fields for violations and returns them.

type AxisConfigBuilder

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

TODO docs

func NewAxisConfigBuilder

func NewAxisConfigBuilder() *AxisConfigBuilder

func (*AxisConfigBuilder) AxisBorderShow

func (builder *AxisConfigBuilder) AxisBorderShow(axisBorderShow bool) *AxisConfigBuilder

func (*AxisConfigBuilder) AxisCenteredZero

func (builder *AxisConfigBuilder) AxisCenteredZero(axisCenteredZero bool) *AxisConfigBuilder

func (*AxisConfigBuilder) AxisColorMode

func (builder *AxisConfigBuilder) AxisColorMode(axisColorMode AxisColorMode) *AxisConfigBuilder

func (*AxisConfigBuilder) AxisGridShow

func (builder *AxisConfigBuilder) AxisGridShow(axisGridShow bool) *AxisConfigBuilder

func (*AxisConfigBuilder) AxisLabel

func (builder *AxisConfigBuilder) AxisLabel(axisLabel string) *AxisConfigBuilder

func (*AxisConfigBuilder) AxisPlacement

func (builder *AxisConfigBuilder) AxisPlacement(axisPlacement AxisPlacement) *AxisConfigBuilder

func (*AxisConfigBuilder) AxisSoftMax

func (builder *AxisConfigBuilder) AxisSoftMax(axisSoftMax float64) *AxisConfigBuilder

func (*AxisConfigBuilder) AxisSoftMin

func (builder *AxisConfigBuilder) AxisSoftMin(axisSoftMin float64) *AxisConfigBuilder

func (*AxisConfigBuilder) AxisWidth

func (builder *AxisConfigBuilder) AxisWidth(axisWidth float64) *AxisConfigBuilder

func (*AxisConfigBuilder) Build

func (builder *AxisConfigBuilder) Build() (AxisConfig, error)

func (*AxisConfigBuilder) ScaleDistribution

func (builder *AxisConfigBuilder) ScaleDistribution(scaleDistribution cog.Builder[ScaleDistributionConfig]) *AxisConfigBuilder

type AxisPlacement

type AxisPlacement string

TODO docs

const (
	AxisPlacementAuto   AxisPlacement = "auto"
	AxisPlacementTop    AxisPlacement = "top"
	AxisPlacementRight  AxisPlacement = "right"
	AxisPlacementBottom AxisPlacement = "bottom"
	AxisPlacementLeft   AxisPlacement = "left"
	AxisPlacementHidden AxisPlacement = "hidden"
)

type BarAlignment

type BarAlignment int64

TODO docs

const (
	BarAlignmentBefore BarAlignment = -1
	BarAlignmentCenter BarAlignment = 0
	BarAlignmentAfter  BarAlignment = 1
)

type BarConfig

type BarConfig struct {
	BarAlignment   *BarAlignment `json:"barAlignment,omitempty"`
	BarWidthFactor *float64      `json:"barWidthFactor,omitempty"`
	BarMaxWidth    *float64      `json:"barMaxWidth,omitempty"`
}

TODO docs

func NewBarConfig

func NewBarConfig() *BarConfig

NewBarConfig creates a new BarConfig object.

func (BarConfig) Equals

func (resource BarConfig) Equals(other BarConfig) bool

Equals tests the equality of two `BarConfig` objects.

func (*BarConfig) UnmarshalJSONStrict

func (resource *BarConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `BarConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (BarConfig) Validate

func (resource BarConfig) Validate() error

Validate checks all the validation constraints that may be defined on `BarConfig` fields for violations and returns them.

type BarConfigBuilder

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

TODO docs

func NewBarConfigBuilder

func NewBarConfigBuilder() *BarConfigBuilder

func (*BarConfigBuilder) BarAlignment

func (builder *BarConfigBuilder) BarAlignment(barAlignment BarAlignment) *BarConfigBuilder

func (*BarConfigBuilder) BarMaxWidth

func (builder *BarConfigBuilder) BarMaxWidth(barMaxWidth float64) *BarConfigBuilder

func (*BarConfigBuilder) BarWidthFactor

func (builder *BarConfigBuilder) BarWidthFactor(barWidthFactor float64) *BarConfigBuilder

func (*BarConfigBuilder) Build

func (builder *BarConfigBuilder) Build() (BarConfig, error)

type BarGaugeDisplayMode

type BarGaugeDisplayMode string

Enum expressing the possible display modes for the bar gauge component of Grafana UI

const (
	BarGaugeDisplayModeBasic    BarGaugeDisplayMode = "basic"
	BarGaugeDisplayModeLcd      BarGaugeDisplayMode = "lcd"
	BarGaugeDisplayModeGradient BarGaugeDisplayMode = "gradient"
)

type BarGaugeNamePlacement

type BarGaugeNamePlacement string

Allows for the bar gauge name to be placed explicitly

const (
	BarGaugeNamePlacementAuto BarGaugeNamePlacement = "auto"
	BarGaugeNamePlacementTop  BarGaugeNamePlacement = "top"
	BarGaugeNamePlacementLeft BarGaugeNamePlacement = "left"
)

type BarGaugeSizing

type BarGaugeSizing string

Allows for the bar gauge size to be set explicitly

const (
	BarGaugeSizingAuto   BarGaugeSizing = "auto"
	BarGaugeSizingManual BarGaugeSizing = "manual"
)

type BarGaugeValueMode

type BarGaugeValueMode string

Allows for the table cell gauge display type to set the gauge mode.

const (
	BarGaugeValueModeColor  BarGaugeValueMode = "color"
	BarGaugeValueModeText   BarGaugeValueMode = "text"
	BarGaugeValueModeHidden BarGaugeValueMode = "hidden"
)

type BaseDimensionConfig

type BaseDimensionConfig struct {
	// fixed: T -- will be added by each element
	Field *string `json:"field,omitempty"`
}

func NewBaseDimensionConfig

func NewBaseDimensionConfig() *BaseDimensionConfig

NewBaseDimensionConfig creates a new BaseDimensionConfig object.

func (BaseDimensionConfig) Equals

func (resource BaseDimensionConfig) Equals(other BaseDimensionConfig) bool

Equals tests the equality of two `BaseDimensionConfig` objects.

func (*BaseDimensionConfig) UnmarshalJSONStrict

func (resource *BaseDimensionConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `BaseDimensionConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (BaseDimensionConfig) Validate

func (resource BaseDimensionConfig) Validate() error

Validate checks all the validation constraints that may be defined on `BaseDimensionConfig` fields for violations and returns them.

type BaseDimensionConfigBuilder

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

func NewBaseDimensionConfigBuilder

func NewBaseDimensionConfigBuilder() *BaseDimensionConfigBuilder

func (*BaseDimensionConfigBuilder) Build

func (*BaseDimensionConfigBuilder) Field

fixed: T -- will be added by each element

type BigValueColorMode

type BigValueColorMode string

TODO docs

const (
	BigValueColorModeValue           BigValueColorMode = "value"
	BigValueColorModeBackground      BigValueColorMode = "background"
	BigValueColorModeBackgroundSolid BigValueColorMode = "background_solid"
	BigValueColorModeNone            BigValueColorMode = "none"
)

type BigValueGraphMode

type BigValueGraphMode string

TODO docs

const (
	BigValueGraphModeNone BigValueGraphMode = "none"
	BigValueGraphModeLine BigValueGraphMode = "line"
	BigValueGraphModeArea BigValueGraphMode = "area"
)

type BigValueJustifyMode

type BigValueJustifyMode string

TODO docs

const (
	BigValueJustifyModeAuto   BigValueJustifyMode = "auto"
	BigValueJustifyModeCenter BigValueJustifyMode = "center"
)

type BigValueTextMode

type BigValueTextMode string

TODO docs

const (
	BigValueTextModeAuto         BigValueTextMode = "auto"
	BigValueTextModeValue        BigValueTextMode = "value"
	BigValueTextModeValueAndName BigValueTextMode = "value_and_name"
	BigValueTextModeName         BigValueTextMode = "name"
	BigValueTextModeNone         BigValueTextMode = "none"
)

type BoolOrFloat64

type BoolOrFloat64 struct {
	Bool    *bool    `json:"Bool,omitempty"`
	Float64 *float64 `json:"Float64,omitempty"`
}

func NewBoolOrFloat64

func NewBoolOrFloat64() *BoolOrFloat64

NewBoolOrFloat64 creates a new BoolOrFloat64 object.

func (BoolOrFloat64) Equals

func (resource BoolOrFloat64) Equals(other BoolOrFloat64) bool

Equals tests the equality of two `BoolOrFloat64` objects.

func (BoolOrFloat64) MarshalJSON

func (resource BoolOrFloat64) MarshalJSON() ([]byte, error)

MarshalJSON implements a custom JSON marshalling logic to encode `BoolOrFloat64` as JSON.

func (*BoolOrFloat64) UnmarshalJSON

func (resource *BoolOrFloat64) UnmarshalJSON(raw []byte) error

UnmarshalJSON implements a custom JSON unmarshalling logic to decode `BoolOrFloat64` from JSON.

func (*BoolOrFloat64) UnmarshalJSONStrict

func (resource *BoolOrFloat64) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `BoolOrFloat64` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (BoolOrFloat64) Validate

func (resource BoolOrFloat64) Validate() error

Validate checks all the validation constraints that may be defined on `BoolOrFloat64` fields for violations and returns them.

type BoolOrUint32

type BoolOrUint32 struct {
	Bool   *bool   `json:"Bool,omitempty"`
	Uint32 *uint32 `json:"Uint32,omitempty"`
}

func NewBoolOrUint32

func NewBoolOrUint32() *BoolOrUint32

NewBoolOrUint32 creates a new BoolOrUint32 object.

func (BoolOrUint32) Equals

func (resource BoolOrUint32) Equals(other BoolOrUint32) bool

Equals tests the equality of two `BoolOrUint32` objects.

func (BoolOrUint32) MarshalJSON

func (resource BoolOrUint32) MarshalJSON() ([]byte, error)

MarshalJSON implements a custom JSON marshalling logic to encode `BoolOrUint32` as JSON.

func (*BoolOrUint32) UnmarshalJSON

func (resource *BoolOrUint32) UnmarshalJSON(raw []byte) error

UnmarshalJSON implements a custom JSON unmarshalling logic to decode `BoolOrUint32` from JSON.

func (*BoolOrUint32) UnmarshalJSONStrict

func (resource *BoolOrUint32) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `BoolOrUint32` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (BoolOrUint32) Validate

func (resource BoolOrUint32) Validate() error

Validate checks all the validation constraints that may be defined on `BoolOrUint32` fields for violations and returns them.

type ColorDimensionConfig

type ColorDimensionConfig struct {
	// color value
	Fixed *string `json:"fixed,omitempty"`
	// fixed: T -- will be added by each element
	Field *string `json:"field,omitempty"`
}

func NewColorDimensionConfig

func NewColorDimensionConfig() *ColorDimensionConfig

NewColorDimensionConfig creates a new ColorDimensionConfig object.

func (ColorDimensionConfig) Equals

func (resource ColorDimensionConfig) Equals(other ColorDimensionConfig) bool

Equals tests the equality of two `ColorDimensionConfig` objects.

func (*ColorDimensionConfig) UnmarshalJSONStrict

func (resource *ColorDimensionConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `ColorDimensionConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (ColorDimensionConfig) Validate

func (resource ColorDimensionConfig) Validate() error

Validate checks all the validation constraints that may be defined on `ColorDimensionConfig` fields for violations and returns them.

type ColorDimensionConfigBuilder

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

func NewColorDimensionConfigBuilder

func NewColorDimensionConfigBuilder() *ColorDimensionConfigBuilder

func (*ColorDimensionConfigBuilder) Build

func (*ColorDimensionConfigBuilder) Field

fixed: T -- will be added by each element

func (*ColorDimensionConfigBuilder) Fixed

color value

type ComparisonOperation

type ComparisonOperation string

Compare two values

const (
	ComparisonOperationEQ  ComparisonOperation = "eq"
	ComparisonOperationNEQ ComparisonOperation = "neq"
	ComparisonOperationLT  ComparisonOperation = "lt"
	ComparisonOperationLTE ComparisonOperation = "lte"
	ComparisonOperationGT  ComparisonOperation = "gt"
	ComparisonOperationGTE ComparisonOperation = "gte"
)

type DataQuery

type DataQuery struct {
	// A unique identifier for the query within the list of targets.
	// In server side expressions, the refId is used as a variable name to identify results.
	// By default, the UI will assign A->Z; however setting meaningful names may be useful.
	RefId string `json:"refId"`
	// If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.
	Hide *bool `json:"hide,omitempty"`
	// Specify the query flavor
	// TODO make this required and give it a default
	QueryType *string `json:"queryType,omitempty"`
	// For mixed data sources the selected datasource is on the query level.
	// For non mixed scenarios this is undefined.
	// TODO find a better way to do this ^ that's friendly to schema
	// TODO this shouldn't be unknown but DataSourceRef | null
	Datasource any `json:"datasource,omitempty"`
}

These are the common properties available to all queries in all datasources. Specific implementations will *extend* this interface, adding the required properties for the given context.

func NewDataQuery

func NewDataQuery() *DataQuery

NewDataQuery creates a new DataQuery object.

func (DataQuery) Equals

func (resource DataQuery) Equals(other DataQuery) bool

Equals tests the equality of two `DataQuery` objects.

func (*DataQuery) UnmarshalJSONStrict

func (resource *DataQuery) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `DataQuery` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (DataQuery) Validate

func (resource DataQuery) Validate() error

Validate checks all the validation constraints that may be defined on `DataQuery` fields for violations and returns them.

type DataQueryBuilder

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

These are the common properties available to all queries in all datasources. Specific implementations will *extend* this interface, adding the required properties for the given context.

func NewDataQueryBuilder

func NewDataQueryBuilder() *DataQueryBuilder

func (*DataQueryBuilder) Build

func (builder *DataQueryBuilder) Build() (DataQuery, error)

func (*DataQueryBuilder) Datasource

func (builder *DataQueryBuilder) Datasource(datasource any) *DataQueryBuilder

For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. TODO find a better way to do this ^ that's friendly to schema TODO this shouldn't be unknown but DataSourceRef | null

func (*DataQueryBuilder) Hide

func (builder *DataQueryBuilder) Hide(hide bool) *DataQueryBuilder

If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.

func (*DataQueryBuilder) QueryType

func (builder *DataQueryBuilder) QueryType(queryType string) *DataQueryBuilder

Specify the query flavor TODO make this required and give it a default

func (*DataQueryBuilder) RefId

func (builder *DataQueryBuilder) RefId(refId string) *DataQueryBuilder

A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. By default, the UI will assign A->Z; however setting meaningful names may be useful.

type DataSourceJsonData

type DataSourceJsonData struct {
	AuthType        *string `json:"authType,omitempty"`
	DefaultRegion   *string `json:"defaultRegion,omitempty"`
	Profile         *string `json:"profile,omitempty"`
	ManageAlerts    *bool   `json:"manageAlerts,omitempty"`
	AlertmanagerUid *string `json:"alertmanagerUid,omitempty"`
}

TODO docs

func NewDataSourceJsonData

func NewDataSourceJsonData() *DataSourceJsonData

NewDataSourceJsonData creates a new DataSourceJsonData object.

func (DataSourceJsonData) Equals

func (resource DataSourceJsonData) Equals(other DataSourceJsonData) bool

Equals tests the equality of two `DataSourceJsonData` objects.

func (*DataSourceJsonData) UnmarshalJSONStrict

func (resource *DataSourceJsonData) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `DataSourceJsonData` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (DataSourceJsonData) Validate

func (resource DataSourceJsonData) Validate() error

Validate checks all the validation constraints that may be defined on `DataSourceJsonData` fields for violations and returns them.

type DataSourceJsonDataBuilder

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

TODO docs

func NewDataSourceJsonDataBuilder

func NewDataSourceJsonDataBuilder() *DataSourceJsonDataBuilder

func (*DataSourceJsonDataBuilder) AlertmanagerUid

func (builder *DataSourceJsonDataBuilder) AlertmanagerUid(alertmanagerUid string) *DataSourceJsonDataBuilder

func (*DataSourceJsonDataBuilder) AuthType

func (builder *DataSourceJsonDataBuilder) AuthType(authType string) *DataSourceJsonDataBuilder

func (*DataSourceJsonDataBuilder) Build

func (*DataSourceJsonDataBuilder) DefaultRegion

func (builder *DataSourceJsonDataBuilder) DefaultRegion(defaultRegion string) *DataSourceJsonDataBuilder

func (*DataSourceJsonDataBuilder) ManageAlerts

func (builder *DataSourceJsonDataBuilder) ManageAlerts(manageAlerts bool) *DataSourceJsonDataBuilder

func (*DataSourceJsonDataBuilder) Profile

func (builder *DataSourceJsonDataBuilder) Profile(profile string) *DataSourceJsonDataBuilder

type DataTopic

type DataTopic string

A topic is attached to DataFrame metadata in query results. This specifies where the data should be used.

const (
	DataTopicSeries      DataTopic = "series"
	DataTopicAnnotations DataTopic = "annotations"
	DataTopicAlertStates DataTopic = "alertStates"
)

type FieldTextAlignment

type FieldTextAlignment string

TODO -- should not be table specific! TODO docs

const (
	FieldTextAlignmentAuto   FieldTextAlignment = "auto"
	FieldTextAlignmentLeft   FieldTextAlignment = "left"
	FieldTextAlignmentRight  FieldTextAlignment = "right"
	FieldTextAlignmentCenter FieldTextAlignment = "center"
)

type FillConfig

type FillConfig struct {
	FillColor   *string  `json:"fillColor,omitempty"`
	FillOpacity *float64 `json:"fillOpacity,omitempty"`
	FillBelowTo *string  `json:"fillBelowTo,omitempty"`
}

TODO docs

func NewFillConfig

func NewFillConfig() *FillConfig

NewFillConfig creates a new FillConfig object.

func (FillConfig) Equals

func (resource FillConfig) Equals(other FillConfig) bool

Equals tests the equality of two `FillConfig` objects.

func (*FillConfig) UnmarshalJSONStrict

func (resource *FillConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `FillConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (FillConfig) Validate

func (resource FillConfig) Validate() error

Validate checks all the validation constraints that may be defined on `FillConfig` fields for violations and returns them.

type FillConfigBuilder

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

TODO docs

func NewFillConfigBuilder

func NewFillConfigBuilder() *FillConfigBuilder

func (*FillConfigBuilder) Build

func (builder *FillConfigBuilder) Build() (FillConfig, error)

func (*FillConfigBuilder) FillBelowTo

func (builder *FillConfigBuilder) FillBelowTo(fillBelowTo string) *FillConfigBuilder

func (*FillConfigBuilder) FillColor

func (builder *FillConfigBuilder) FillColor(fillColor string) *FillConfigBuilder

func (*FillConfigBuilder) FillOpacity

func (builder *FillConfigBuilder) FillOpacity(fillOpacity float64) *FillConfigBuilder

type FrameGeometrySource

type FrameGeometrySource struct {
	Mode FrameGeometrySourceMode `json:"mode"`
	// Field mappings
	Geohash   *string `json:"geohash,omitempty"`
	Latitude  *string `json:"latitude,omitempty"`
	Longitude *string `json:"longitude,omitempty"`
	Wkt       *string `json:"wkt,omitempty"`
	Lookup    *string `json:"lookup,omitempty"`
	// Path to Gazetteer
	Gazetteer *string `json:"gazetteer,omitempty"`
}

func NewFrameGeometrySource

func NewFrameGeometrySource() *FrameGeometrySource

NewFrameGeometrySource creates a new FrameGeometrySource object.

func (FrameGeometrySource) Equals

func (resource FrameGeometrySource) Equals(other FrameGeometrySource) bool

Equals tests the equality of two `FrameGeometrySource` objects.

func (*FrameGeometrySource) UnmarshalJSONStrict

func (resource *FrameGeometrySource) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `FrameGeometrySource` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (FrameGeometrySource) Validate

func (resource FrameGeometrySource) Validate() error

Validate checks all the validation constraints that may be defined on `FrameGeometrySource` fields for violations and returns them.

type FrameGeometrySourceBuilder

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

func NewFrameGeometrySourceBuilder

func NewFrameGeometrySourceBuilder() *FrameGeometrySourceBuilder

func (*FrameGeometrySourceBuilder) Build

func (*FrameGeometrySourceBuilder) Gazetteer

func (builder *FrameGeometrySourceBuilder) Gazetteer(gazetteer string) *FrameGeometrySourceBuilder

Path to Gazetteer

func (*FrameGeometrySourceBuilder) Geohash

Field mappings

func (*FrameGeometrySourceBuilder) Latitude

func (builder *FrameGeometrySourceBuilder) Latitude(latitude string) *FrameGeometrySourceBuilder

func (*FrameGeometrySourceBuilder) Longitude

func (builder *FrameGeometrySourceBuilder) Longitude(longitude string) *FrameGeometrySourceBuilder

func (*FrameGeometrySourceBuilder) Lookup

func (*FrameGeometrySourceBuilder) Mode

func (*FrameGeometrySourceBuilder) Wkt

type FrameGeometrySourceMode

type FrameGeometrySourceMode string
const (
	FrameGeometrySourceModeAuto    FrameGeometrySourceMode = "auto"
	FrameGeometrySourceModeGeohash FrameGeometrySourceMode = "geohash"
	FrameGeometrySourceModeCoords  FrameGeometrySourceMode = "coords"
	FrameGeometrySourceModeLookup  FrameGeometrySourceMode = "lookup"
)

type GraphDrawStyle

type GraphDrawStyle string

TODO docs

const (
	GraphDrawStyleLine   GraphDrawStyle = "line"
	GraphDrawStyleBars   GraphDrawStyle = "bars"
	GraphDrawStylePoints GraphDrawStyle = "points"
)

type GraphFieldConfig

type GraphFieldConfig struct {
	DrawStyle         *GraphDrawStyle             `json:"drawStyle,omitempty"`
	GradientMode      *GraphGradientMode          `json:"gradientMode,omitempty"`
	ThresholdsStyle   *GraphThresholdsStyleConfig `json:"thresholdsStyle,omitempty"`
	LineColor         *string                     `json:"lineColor,omitempty"`
	LineWidth         *float64                    `json:"lineWidth,omitempty"`
	LineInterpolation *LineInterpolation          `json:"lineInterpolation,omitempty"`
	LineStyle         *LineStyle                  `json:"lineStyle,omitempty"`
	FillColor         *string                     `json:"fillColor,omitempty"`
	FillOpacity       *float64                    `json:"fillOpacity,omitempty"`
	ShowPoints        *VisibilityMode             `json:"showPoints,omitempty"`
	PointSize         *float64                    `json:"pointSize,omitempty"`
	PointColor        *string                     `json:"pointColor,omitempty"`
	AxisPlacement     *AxisPlacement              `json:"axisPlacement,omitempty"`
	AxisColorMode     *AxisColorMode              `json:"axisColorMode,omitempty"`
	AxisLabel         *string                     `json:"axisLabel,omitempty"`
	AxisWidth         *float64                    `json:"axisWidth,omitempty"`
	AxisSoftMin       *float64                    `json:"axisSoftMin,omitempty"`
	AxisSoftMax       *float64                    `json:"axisSoftMax,omitempty"`
	AxisGridShow      *bool                       `json:"axisGridShow,omitempty"`
	ScaleDistribution *ScaleDistributionConfig    `json:"scaleDistribution,omitempty"`
	AxisCenteredZero  *bool                       `json:"axisCenteredZero,omitempty"`
	BarAlignment      *BarAlignment               `json:"barAlignment,omitempty"`
	BarWidthFactor    *float64                    `json:"barWidthFactor,omitempty"`
	Stacking          *StackingConfig             `json:"stacking,omitempty"`
	HideFrom          *HideSeriesConfig           `json:"hideFrom,omitempty"`
	Transform         *GraphTransform             `json:"transform,omitempty"`
	// Indicate if null values should be treated as gaps or connected.
	// When the value is a number, it represents the maximum delta in the
	// X axis that should be considered connected.  For timeseries, this is milliseconds
	SpanNulls      *BoolOrFloat64 `json:"spanNulls,omitempty"`
	FillBelowTo    *string        `json:"fillBelowTo,omitempty"`
	PointSymbol    *string        `json:"pointSymbol,omitempty"`
	AxisBorderShow *bool          `json:"axisBorderShow,omitempty"`
	BarMaxWidth    *float64       `json:"barMaxWidth,omitempty"`
	InsertNulls    *BoolOrUint32  `json:"insertNulls,omitempty"`
}

TODO docs

func NewGraphFieldConfig

func NewGraphFieldConfig() *GraphFieldConfig

NewGraphFieldConfig creates a new GraphFieldConfig object.

func (GraphFieldConfig) Equals

func (resource GraphFieldConfig) Equals(other GraphFieldConfig) bool

Equals tests the equality of two `GraphFieldConfig` objects.

func (*GraphFieldConfig) UnmarshalJSONStrict

func (resource *GraphFieldConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `GraphFieldConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (GraphFieldConfig) Validate

func (resource GraphFieldConfig) Validate() error

Validate checks all the validation constraints that may be defined on `GraphFieldConfig` fields for violations and returns them.

type GraphFieldConfigBuilder

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

TODO docs

func NewGraphFieldConfigBuilder

func NewGraphFieldConfigBuilder() *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) AxisBorderShow

func (builder *GraphFieldConfigBuilder) AxisBorderShow(axisBorderShow bool) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) AxisCenteredZero

func (builder *GraphFieldConfigBuilder) AxisCenteredZero(axisCenteredZero bool) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) AxisColorMode

func (builder *GraphFieldConfigBuilder) AxisColorMode(axisColorMode AxisColorMode) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) AxisGridShow

func (builder *GraphFieldConfigBuilder) AxisGridShow(axisGridShow bool) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) AxisLabel

func (builder *GraphFieldConfigBuilder) AxisLabel(axisLabel string) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) AxisPlacement

func (builder *GraphFieldConfigBuilder) AxisPlacement(axisPlacement AxisPlacement) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) AxisSoftMax

func (builder *GraphFieldConfigBuilder) AxisSoftMax(axisSoftMax float64) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) AxisSoftMin

func (builder *GraphFieldConfigBuilder) AxisSoftMin(axisSoftMin float64) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) AxisWidth

func (builder *GraphFieldConfigBuilder) AxisWidth(axisWidth float64) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) BarAlignment

func (builder *GraphFieldConfigBuilder) BarAlignment(barAlignment BarAlignment) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) BarMaxWidth

func (builder *GraphFieldConfigBuilder) BarMaxWidth(barMaxWidth float64) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) BarWidthFactor

func (builder *GraphFieldConfigBuilder) BarWidthFactor(barWidthFactor float64) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) Build

func (builder *GraphFieldConfigBuilder) Build() (GraphFieldConfig, error)

func (*GraphFieldConfigBuilder) DrawStyle

func (builder *GraphFieldConfigBuilder) DrawStyle(drawStyle GraphDrawStyle) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) FillBelowTo

func (builder *GraphFieldConfigBuilder) FillBelowTo(fillBelowTo string) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) FillColor

func (builder *GraphFieldConfigBuilder) FillColor(fillColor string) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) FillOpacity

func (builder *GraphFieldConfigBuilder) FillOpacity(fillOpacity float64) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) GradientMode

func (builder *GraphFieldConfigBuilder) GradientMode(gradientMode GraphGradientMode) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) HideFrom

func (*GraphFieldConfigBuilder) InsertNulls

func (builder *GraphFieldConfigBuilder) InsertNulls(insertNulls BoolOrUint32) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) LineColor

func (builder *GraphFieldConfigBuilder) LineColor(lineColor string) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) LineInterpolation

func (builder *GraphFieldConfigBuilder) LineInterpolation(lineInterpolation LineInterpolation) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) LineStyle

func (builder *GraphFieldConfigBuilder) LineStyle(lineStyle cog.Builder[LineStyle]) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) LineWidth

func (builder *GraphFieldConfigBuilder) LineWidth(lineWidth float64) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) PointColor

func (builder *GraphFieldConfigBuilder) PointColor(pointColor string) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) PointSize

func (builder *GraphFieldConfigBuilder) PointSize(pointSize float64) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) PointSymbol

func (builder *GraphFieldConfigBuilder) PointSymbol(pointSymbol string) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) ScaleDistribution

func (builder *GraphFieldConfigBuilder) ScaleDistribution(scaleDistribution cog.Builder[ScaleDistributionConfig]) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) ShowPoints

func (builder *GraphFieldConfigBuilder) ShowPoints(showPoints VisibilityMode) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) SpanNulls

func (builder *GraphFieldConfigBuilder) SpanNulls(spanNulls BoolOrFloat64) *GraphFieldConfigBuilder

Indicate if null values should be treated as gaps or connected. When the value is a number, it represents the maximum delta in the X axis that should be considered connected. For timeseries, this is milliseconds

func (*GraphFieldConfigBuilder) Stacking

func (*GraphFieldConfigBuilder) ThresholdsStyle

func (builder *GraphFieldConfigBuilder) ThresholdsStyle(thresholdsStyle cog.Builder[GraphThresholdsStyleConfig]) *GraphFieldConfigBuilder

func (*GraphFieldConfigBuilder) Transform

func (builder *GraphFieldConfigBuilder) Transform(transform GraphTransform) *GraphFieldConfigBuilder

type GraphGradientMode

type GraphGradientMode string

TODO docs

const (
	GraphGradientModeNone    GraphGradientMode = "none"
	GraphGradientModeOpacity GraphGradientMode = "opacity"
	GraphGradientModeHue     GraphGradientMode = "hue"
	GraphGradientModeScheme  GraphGradientMode = "scheme"
)

type GraphThresholdsStyleConfig

type GraphThresholdsStyleConfig struct {
	Mode GraphThresholdsStyleMode `json:"mode"`
}

TODO docs

func NewGraphThresholdsStyleConfig

func NewGraphThresholdsStyleConfig() *GraphThresholdsStyleConfig

NewGraphThresholdsStyleConfig creates a new GraphThresholdsStyleConfig object.

func (GraphThresholdsStyleConfig) Equals

Equals tests the equality of two `GraphThresholdsStyleConfig` objects.

func (*GraphThresholdsStyleConfig) UnmarshalJSONStrict

func (resource *GraphThresholdsStyleConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `GraphThresholdsStyleConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (GraphThresholdsStyleConfig) Validate

func (resource GraphThresholdsStyleConfig) Validate() error

Validate checks all the validation constraints that may be defined on `GraphThresholdsStyleConfig` fields for violations and returns them.

type GraphThresholdsStyleConfigBuilder

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

TODO docs

func NewGraphThresholdsStyleConfigBuilder

func NewGraphThresholdsStyleConfigBuilder() *GraphThresholdsStyleConfigBuilder

func (*GraphThresholdsStyleConfigBuilder) Build

func (*GraphThresholdsStyleConfigBuilder) Mode

type GraphThresholdsStyleMode

type GraphThresholdsStyleMode string

TODO docs

const (
	GraphThresholdsStyleModeOff           GraphThresholdsStyleMode = "off"
	GraphThresholdsStyleModeLine          GraphThresholdsStyleMode = "line"
	GraphThresholdsStyleModeDashed        GraphThresholdsStyleMode = "dashed"
	GraphThresholdsStyleModeArea          GraphThresholdsStyleMode = "area"
	GraphThresholdsStyleModeLineAndArea   GraphThresholdsStyleMode = "line+area"
	GraphThresholdsStyleModeDashedAndArea GraphThresholdsStyleMode = "dashed+area"
	GraphThresholdsStyleModeSeries        GraphThresholdsStyleMode = "series"
)

type GraphTransform

type GraphTransform string

TODO docs

const (
	GraphTransformConstant  GraphTransform = "constant"
	GraphTransformNegativeY GraphTransform = "negative-Y"
)

type HeatmapCalculationBucketConfig

type HeatmapCalculationBucketConfig struct {
	// Sets the bucket calculation mode
	Mode *HeatmapCalculationMode `json:"mode,omitempty"`
	// The number of buckets to use for the axis in the heatmap
	Value *string `json:"value,omitempty"`
	// Controls the scale of the buckets
	Scale *ScaleDistributionConfig `json:"scale,omitempty"`
}

func NewHeatmapCalculationBucketConfig

func NewHeatmapCalculationBucketConfig() *HeatmapCalculationBucketConfig

NewHeatmapCalculationBucketConfig creates a new HeatmapCalculationBucketConfig object.

func (HeatmapCalculationBucketConfig) Equals

Equals tests the equality of two `HeatmapCalculationBucketConfig` objects.

func (*HeatmapCalculationBucketConfig) UnmarshalJSONStrict

func (resource *HeatmapCalculationBucketConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `HeatmapCalculationBucketConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (HeatmapCalculationBucketConfig) Validate

func (resource HeatmapCalculationBucketConfig) Validate() error

Validate checks all the validation constraints that may be defined on `HeatmapCalculationBucketConfig` fields for violations and returns them.

type HeatmapCalculationBucketConfigBuilder

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

func NewHeatmapCalculationBucketConfigBuilder

func NewHeatmapCalculationBucketConfigBuilder() *HeatmapCalculationBucketConfigBuilder

func (*HeatmapCalculationBucketConfigBuilder) Build

func (*HeatmapCalculationBucketConfigBuilder) Mode

Sets the bucket calculation mode

func (*HeatmapCalculationBucketConfigBuilder) Scale

Controls the scale of the buckets

func (*HeatmapCalculationBucketConfigBuilder) Value

The number of buckets to use for the axis in the heatmap

type HeatmapCalculationMode

type HeatmapCalculationMode string
const (
	HeatmapCalculationModeSize  HeatmapCalculationMode = "size"
	HeatmapCalculationModeCount HeatmapCalculationMode = "count"
)

type HeatmapCalculationOptions

type HeatmapCalculationOptions struct {
	// The number of buckets to use for the xAxis in the heatmap
	XBuckets *HeatmapCalculationBucketConfig `json:"xBuckets,omitempty"`
	// The number of buckets to use for the yAxis in the heatmap
	YBuckets *HeatmapCalculationBucketConfig `json:"yBuckets,omitempty"`
}

func NewHeatmapCalculationOptions

func NewHeatmapCalculationOptions() *HeatmapCalculationOptions

NewHeatmapCalculationOptions creates a new HeatmapCalculationOptions object.

func (HeatmapCalculationOptions) Equals

Equals tests the equality of two `HeatmapCalculationOptions` objects.

func (*HeatmapCalculationOptions) UnmarshalJSONStrict

func (resource *HeatmapCalculationOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `HeatmapCalculationOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (HeatmapCalculationOptions) Validate

func (resource HeatmapCalculationOptions) Validate() error

Validate checks all the validation constraints that may be defined on `HeatmapCalculationOptions` fields for violations and returns them.

type HeatmapCalculationOptionsBuilder

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

func NewHeatmapCalculationOptionsBuilder

func NewHeatmapCalculationOptionsBuilder() *HeatmapCalculationOptionsBuilder

func (*HeatmapCalculationOptionsBuilder) Build

func (*HeatmapCalculationOptionsBuilder) XBuckets

The number of buckets to use for the xAxis in the heatmap

func (*HeatmapCalculationOptionsBuilder) YBuckets

The number of buckets to use for the yAxis in the heatmap

type HeatmapCellLayout

type HeatmapCellLayout string
const (
	HeatmapCellLayoutLe      HeatmapCellLayout = "le"
	HeatmapCellLayoutGe      HeatmapCellLayout = "ge"
	HeatmapCellLayoutUnknown HeatmapCellLayout = "unknown"
	HeatmapCellLayoutAuto    HeatmapCellLayout = "auto"
)

type HideSeriesConfig

type HideSeriesConfig struct {
	Tooltip bool `json:"tooltip"`
	Legend  bool `json:"legend"`
	Viz     bool `json:"viz"`
}

TODO docs

func NewHideSeriesConfig

func NewHideSeriesConfig() *HideSeriesConfig

NewHideSeriesConfig creates a new HideSeriesConfig object.

func (HideSeriesConfig) Equals

func (resource HideSeriesConfig) Equals(other HideSeriesConfig) bool

Equals tests the equality of two `HideSeriesConfig` objects.

func (*HideSeriesConfig) UnmarshalJSONStrict

func (resource *HideSeriesConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `HideSeriesConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (HideSeriesConfig) Validate

func (resource HideSeriesConfig) Validate() error

Validate checks all the validation constraints that may be defined on `HideSeriesConfig` fields for violations and returns them.

type HideSeriesConfigBuilder

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

TODO docs

func NewHideSeriesConfigBuilder

func NewHideSeriesConfigBuilder() *HideSeriesConfigBuilder

func (*HideSeriesConfigBuilder) Build

func (builder *HideSeriesConfigBuilder) Build() (HideSeriesConfig, error)

func (*HideSeriesConfigBuilder) Legend

func (builder *HideSeriesConfigBuilder) Legend(legend bool) *HideSeriesConfigBuilder

func (*HideSeriesConfigBuilder) Tooltip

func (builder *HideSeriesConfigBuilder) Tooltip(tooltip bool) *HideSeriesConfigBuilder

func (*HideSeriesConfigBuilder) Viz

type HideableFieldConfig

type HideableFieldConfig struct {
	HideFrom *HideSeriesConfig `json:"hideFrom,omitempty"`
}

TODO docs

func NewHideableFieldConfig

func NewHideableFieldConfig() *HideableFieldConfig

NewHideableFieldConfig creates a new HideableFieldConfig object.

func (HideableFieldConfig) Equals

func (resource HideableFieldConfig) Equals(other HideableFieldConfig) bool

Equals tests the equality of two `HideableFieldConfig` objects.

func (*HideableFieldConfig) UnmarshalJSONStrict

func (resource *HideableFieldConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `HideableFieldConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (HideableFieldConfig) Validate

func (resource HideableFieldConfig) Validate() error

Validate checks all the validation constraints that may be defined on `HideableFieldConfig` fields for violations and returns them.

type HideableFieldConfigBuilder

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

TODO docs

func NewHideableFieldConfigBuilder

func NewHideableFieldConfigBuilder() *HideableFieldConfigBuilder

func (*HideableFieldConfigBuilder) Build

func (*HideableFieldConfigBuilder) HideFrom

type Labels

type Labels map[string]string

type LegendDisplayMode

type LegendDisplayMode string

TODO docs Note: "hidden" needs to remain as an option for plugins compatibility

const (
	LegendDisplayModeList   LegendDisplayMode = "list"
	LegendDisplayModeTable  LegendDisplayMode = "table"
	LegendDisplayModeHidden LegendDisplayMode = "hidden"
)

type LegendPlacement

type LegendPlacement string

TODO docs

const (
	LegendPlacementBottom LegendPlacement = "bottom"
	LegendPlacementRight  LegendPlacement = "right"
)

type LineConfig

type LineConfig struct {
	LineColor         *string            `json:"lineColor,omitempty"`
	LineWidth         *float64           `json:"lineWidth,omitempty"`
	LineInterpolation *LineInterpolation `json:"lineInterpolation,omitempty"`
	LineStyle         *LineStyle         `json:"lineStyle,omitempty"`
	// Indicate if null values should be treated as gaps or connected.
	// When the value is a number, it represents the maximum delta in the
	// X axis that should be considered connected.  For timeseries, this is milliseconds
	SpanNulls *BoolOrFloat64 `json:"spanNulls,omitempty"`
}

TODO docs

func NewLineConfig

func NewLineConfig() *LineConfig

NewLineConfig creates a new LineConfig object.

func (LineConfig) Equals

func (resource LineConfig) Equals(other LineConfig) bool

Equals tests the equality of two `LineConfig` objects.

func (*LineConfig) UnmarshalJSONStrict

func (resource *LineConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `LineConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (LineConfig) Validate

func (resource LineConfig) Validate() error

Validate checks all the validation constraints that may be defined on `LineConfig` fields for violations and returns them.

type LineConfigBuilder

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

TODO docs

func NewLineConfigBuilder

func NewLineConfigBuilder() *LineConfigBuilder

func (*LineConfigBuilder) Build

func (builder *LineConfigBuilder) Build() (LineConfig, error)

func (*LineConfigBuilder) LineColor

func (builder *LineConfigBuilder) LineColor(lineColor string) *LineConfigBuilder

func (*LineConfigBuilder) LineInterpolation

func (builder *LineConfigBuilder) LineInterpolation(lineInterpolation LineInterpolation) *LineConfigBuilder

func (*LineConfigBuilder) LineStyle

func (builder *LineConfigBuilder) LineStyle(lineStyle cog.Builder[LineStyle]) *LineConfigBuilder

func (*LineConfigBuilder) LineWidth

func (builder *LineConfigBuilder) LineWidth(lineWidth float64) *LineConfigBuilder

func (*LineConfigBuilder) SpanNulls

func (builder *LineConfigBuilder) SpanNulls(spanNulls BoolOrFloat64) *LineConfigBuilder

Indicate if null values should be treated as gaps or connected. When the value is a number, it represents the maximum delta in the X axis that should be considered connected. For timeseries, this is milliseconds

type LineInterpolation

type LineInterpolation string

TODO docs

const (
	LineInterpolationLinear     LineInterpolation = "linear"
	LineInterpolationSmooth     LineInterpolation = "smooth"
	LineInterpolationStepBefore LineInterpolation = "stepBefore"
	LineInterpolationStepAfter  LineInterpolation = "stepAfter"
)

type LineStyle

type LineStyle struct {
	Fill *LineStyleFill `json:"fill,omitempty"`
	Dash []float64      `json:"dash,omitempty"`
}

TODO docs

func NewLineStyle

func NewLineStyle() *LineStyle

NewLineStyle creates a new LineStyle object.

func (LineStyle) Equals

func (resource LineStyle) Equals(other LineStyle) bool

Equals tests the equality of two `LineStyle` objects.

func (*LineStyle) UnmarshalJSONStrict

func (resource *LineStyle) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `LineStyle` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (LineStyle) Validate

func (resource LineStyle) Validate() error

Validate checks all the validation constraints that may be defined on `LineStyle` fields for violations and returns them.

type LineStyleBuilder

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

TODO docs

func NewLineStyleBuilder

func NewLineStyleBuilder() *LineStyleBuilder

func (*LineStyleBuilder) Build

func (builder *LineStyleBuilder) Build() (LineStyle, error)

func (*LineStyleBuilder) Dash

func (builder *LineStyleBuilder) Dash(dash []float64) *LineStyleBuilder

func (*LineStyleBuilder) Fill

func (builder *LineStyleBuilder) Fill(fill LineStyleFill) *LineStyleBuilder

type LineStyleFill

type LineStyleFill string
const (
	LineStyleFillSolid  LineStyleFill = "solid"
	LineStyleFillDash   LineStyleFill = "dash"
	LineStyleFillDot    LineStyleFill = "dot"
	LineStyleFillSquare LineStyleFill = "square"
)

type LogsDedupStrategy

type LogsDedupStrategy string
const (
	LogsDedupStrategyNone      LogsDedupStrategy = "none"
	LogsDedupStrategyExact     LogsDedupStrategy = "exact"
	LogsDedupStrategyNumbers   LogsDedupStrategy = "numbers"
	LogsDedupStrategySignature LogsDedupStrategy = "signature"
)

type LogsSortOrder

type LogsSortOrder string
const (
	LogsSortOrderDescending LogsSortOrder = "Descending"
	LogsSortOrderAscending  LogsSortOrder = "Ascending"
)

type MapLayerOptions

type MapLayerOptions struct {
	Type string `json:"type"`
	// configured unique display name
	Name string `json:"name"`
	// Custom options depending on the type
	Config any `json:"config,omitempty"`
	// Common method to define geometry fields
	Location *FrameGeometrySource `json:"location,omitempty"`
	// Defines a frame MatcherConfig that may filter data for the given layer
	FilterData any `json:"filterData,omitempty"`
	// Common properties:
	// https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html
	// Layer opacity (0-1)
	Opacity *int64 `json:"opacity,omitempty"`
	// Check tooltip (defaults to true)
	Tooltip *bool `json:"tooltip,omitempty"`
}

func NewMapLayerOptions

func NewMapLayerOptions() *MapLayerOptions

NewMapLayerOptions creates a new MapLayerOptions object.

func (MapLayerOptions) Equals

func (resource MapLayerOptions) Equals(other MapLayerOptions) bool

Equals tests the equality of two `MapLayerOptions` objects.

func (*MapLayerOptions) UnmarshalJSONStrict

func (resource *MapLayerOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `MapLayerOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (MapLayerOptions) Validate

func (resource MapLayerOptions) Validate() error

Validate checks all the validation constraints that may be defined on `MapLayerOptions` fields for violations and returns them.

type MapLayerOptionsBuilder

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

func NewMapLayerOptionsBuilder

func NewMapLayerOptionsBuilder() *MapLayerOptionsBuilder

func (*MapLayerOptionsBuilder) Build

func (builder *MapLayerOptionsBuilder) Build() (MapLayerOptions, error)

func (*MapLayerOptionsBuilder) Config

func (builder *MapLayerOptionsBuilder) Config(config any) *MapLayerOptionsBuilder

Custom options depending on the type

func (*MapLayerOptionsBuilder) FilterData

func (builder *MapLayerOptionsBuilder) FilterData(filterData any) *MapLayerOptionsBuilder

Defines a frame MatcherConfig that may filter data for the given layer

func (*MapLayerOptionsBuilder) Location

Common method to define geometry fields

func (*MapLayerOptionsBuilder) Name

configured unique display name

func (*MapLayerOptionsBuilder) Opacity

func (builder *MapLayerOptionsBuilder) Opacity(opacity int64) *MapLayerOptionsBuilder

Common properties: https://openlayers.org/en/latest/apidoc/module-ol_layer_Base-BaseLayer.html Layer opacity (0-1)

func (*MapLayerOptionsBuilder) Tooltip

func (builder *MapLayerOptionsBuilder) Tooltip(tooltip bool) *MapLayerOptionsBuilder

Check tooltip (defaults to true)

func (*MapLayerOptionsBuilder) Type

func (builder *MapLayerOptionsBuilder) Type(typeArg string) *MapLayerOptionsBuilder

type OptionsWithLegend

type OptionsWithLegend struct {
	Legend VizLegendOptions `json:"legend"`
}

TODO docs

func NewOptionsWithLegend

func NewOptionsWithLegend() *OptionsWithLegend

NewOptionsWithLegend creates a new OptionsWithLegend object.

func (OptionsWithLegend) Equals

func (resource OptionsWithLegend) Equals(other OptionsWithLegend) bool

Equals tests the equality of two `OptionsWithLegend` objects.

func (*OptionsWithLegend) UnmarshalJSONStrict

func (resource *OptionsWithLegend) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `OptionsWithLegend` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (OptionsWithLegend) Validate

func (resource OptionsWithLegend) Validate() error

Validate checks all the validation constraints that may be defined on `OptionsWithLegend` fields for violations and returns them.

type OptionsWithLegendBuilder

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

TODO docs

func NewOptionsWithLegendBuilder

func NewOptionsWithLegendBuilder() *OptionsWithLegendBuilder

func (*OptionsWithLegendBuilder) Build

func (builder *OptionsWithLegendBuilder) Build() (OptionsWithLegend, error)

func (*OptionsWithLegendBuilder) Legend

type OptionsWithTextFormatting

type OptionsWithTextFormatting struct {
	Text *VizTextDisplayOptions `json:"text,omitempty"`
}

TODO docs

func NewOptionsWithTextFormatting

func NewOptionsWithTextFormatting() *OptionsWithTextFormatting

NewOptionsWithTextFormatting creates a new OptionsWithTextFormatting object.

func (OptionsWithTextFormatting) Equals

Equals tests the equality of two `OptionsWithTextFormatting` objects.

func (*OptionsWithTextFormatting) UnmarshalJSONStrict

func (resource *OptionsWithTextFormatting) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `OptionsWithTextFormatting` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (OptionsWithTextFormatting) Validate

func (resource OptionsWithTextFormatting) Validate() error

Validate checks all the validation constraints that may be defined on `OptionsWithTextFormatting` fields for violations and returns them.

type OptionsWithTextFormattingBuilder

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

TODO docs

func NewOptionsWithTextFormattingBuilder

func NewOptionsWithTextFormattingBuilder() *OptionsWithTextFormattingBuilder

func (*OptionsWithTextFormattingBuilder) Build

func (*OptionsWithTextFormattingBuilder) Text

type OptionsWithTimezones

type OptionsWithTimezones struct {
	Timezone []TimeZone `json:"timezone,omitempty"`
}

TODO docs

func NewOptionsWithTimezones

func NewOptionsWithTimezones() *OptionsWithTimezones

NewOptionsWithTimezones creates a new OptionsWithTimezones object.

func (OptionsWithTimezones) Equals

func (resource OptionsWithTimezones) Equals(other OptionsWithTimezones) bool

Equals tests the equality of two `OptionsWithTimezones` objects.

func (*OptionsWithTimezones) UnmarshalJSONStrict

func (resource *OptionsWithTimezones) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `OptionsWithTimezones` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (OptionsWithTimezones) Validate

func (resource OptionsWithTimezones) Validate() error

Validate checks all the validation constraints that may be defined on `OptionsWithTimezones` fields for violations and returns them.

type OptionsWithTimezonesBuilder

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

TODO docs

func NewOptionsWithTimezonesBuilder

func NewOptionsWithTimezonesBuilder() *OptionsWithTimezonesBuilder

func (*OptionsWithTimezonesBuilder) Build

func (*OptionsWithTimezonesBuilder) Timezone

func (builder *OptionsWithTimezonesBuilder) Timezone(timezone []TimeZone) *OptionsWithTimezonesBuilder

type OptionsWithTooltip

type OptionsWithTooltip struct {
	Tooltip VizTooltipOptions `json:"tooltip"`
}

TODO docs

func NewOptionsWithTooltip

func NewOptionsWithTooltip() *OptionsWithTooltip

NewOptionsWithTooltip creates a new OptionsWithTooltip object.

func (OptionsWithTooltip) Equals

func (resource OptionsWithTooltip) Equals(other OptionsWithTooltip) bool

Equals tests the equality of two `OptionsWithTooltip` objects.

func (*OptionsWithTooltip) UnmarshalJSONStrict

func (resource *OptionsWithTooltip) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `OptionsWithTooltip` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (OptionsWithTooltip) Validate

func (resource OptionsWithTooltip) Validate() error

Validate checks all the validation constraints that may be defined on `OptionsWithTooltip` fields for violations and returns them.

type OptionsWithTooltipBuilder

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

TODO docs

func NewOptionsWithTooltipBuilder

func NewOptionsWithTooltipBuilder() *OptionsWithTooltipBuilder

func (*OptionsWithTooltipBuilder) Build

func (*OptionsWithTooltipBuilder) Tooltip

type PointsConfig

type PointsConfig struct {
	ShowPoints  *VisibilityMode `json:"showPoints,omitempty"`
	PointSize   *float64        `json:"pointSize,omitempty"`
	PointColor  *string         `json:"pointColor,omitempty"`
	PointSymbol *string         `json:"pointSymbol,omitempty"`
}

TODO docs

func NewPointsConfig

func NewPointsConfig() *PointsConfig

NewPointsConfig creates a new PointsConfig object.

func (PointsConfig) Equals

func (resource PointsConfig) Equals(other PointsConfig) bool

Equals tests the equality of two `PointsConfig` objects.

func (*PointsConfig) UnmarshalJSONStrict

func (resource *PointsConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `PointsConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (PointsConfig) Validate

func (resource PointsConfig) Validate() error

Validate checks all the validation constraints that may be defined on `PointsConfig` fields for violations and returns them.

type PointsConfigBuilder

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

TODO docs

func NewPointsConfigBuilder

func NewPointsConfigBuilder() *PointsConfigBuilder

func (*PointsConfigBuilder) Build

func (builder *PointsConfigBuilder) Build() (PointsConfig, error)

func (*PointsConfigBuilder) PointColor

func (builder *PointsConfigBuilder) PointColor(pointColor string) *PointsConfigBuilder

func (*PointsConfigBuilder) PointSize

func (builder *PointsConfigBuilder) PointSize(pointSize float64) *PointsConfigBuilder

func (*PointsConfigBuilder) PointSymbol

func (builder *PointsConfigBuilder) PointSymbol(pointSymbol string) *PointsConfigBuilder

func (*PointsConfigBuilder) ShowPoints

func (builder *PointsConfigBuilder) ShowPoints(showPoints VisibilityMode) *PointsConfigBuilder

type ReduceDataOptions

type ReduceDataOptions struct {
	// If true show each row value
	Values *bool `json:"values,omitempty"`
	// if showing all values limit
	Limit *float64 `json:"limit,omitempty"`
	// When !values, pick one value for the whole field
	Calcs []string `json:"calcs"`
	// Which fields to show.  By default this is only numeric fields
	Fields *string `json:"fields,omitempty"`
}

TODO docs

func NewReduceDataOptions

func NewReduceDataOptions() *ReduceDataOptions

NewReduceDataOptions creates a new ReduceDataOptions object.

func (ReduceDataOptions) Equals

func (resource ReduceDataOptions) Equals(other ReduceDataOptions) bool

Equals tests the equality of two `ReduceDataOptions` objects.

func (*ReduceDataOptions) UnmarshalJSONStrict

func (resource *ReduceDataOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `ReduceDataOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (ReduceDataOptions) Validate

func (resource ReduceDataOptions) Validate() error

Validate checks all the validation constraints that may be defined on `ReduceDataOptions` fields for violations and returns them.

type ReduceDataOptionsBuilder

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

TODO docs

func NewReduceDataOptionsBuilder

func NewReduceDataOptionsBuilder() *ReduceDataOptionsBuilder

func (*ReduceDataOptionsBuilder) Build

func (builder *ReduceDataOptionsBuilder) Build() (ReduceDataOptions, error)

func (*ReduceDataOptionsBuilder) Calcs

func (builder *ReduceDataOptionsBuilder) Calcs(calcs []string) *ReduceDataOptionsBuilder

When !values, pick one value for the whole field

func (*ReduceDataOptionsBuilder) Fields

func (builder *ReduceDataOptionsBuilder) Fields(fields string) *ReduceDataOptionsBuilder

Which fields to show. By default this is only numeric fields

func (*ReduceDataOptionsBuilder) Limit

if showing all values limit

func (*ReduceDataOptionsBuilder) Values

func (builder *ReduceDataOptionsBuilder) Values(values bool) *ReduceDataOptionsBuilder

If true show each row value

type ResourceDimensionConfig

type ResourceDimensionConfig struct {
	Mode ResourceDimensionMode `json:"mode"`
	// fixed: T -- will be added by each element
	Field *string `json:"field,omitempty"`
	Fixed *string `json:"fixed,omitempty"`
}

Links to a resource (image/svg path)

func NewResourceDimensionConfig

func NewResourceDimensionConfig() *ResourceDimensionConfig

NewResourceDimensionConfig creates a new ResourceDimensionConfig object.

func (ResourceDimensionConfig) Equals

func (resource ResourceDimensionConfig) Equals(other ResourceDimensionConfig) bool

Equals tests the equality of two `ResourceDimensionConfig` objects.

func (*ResourceDimensionConfig) UnmarshalJSONStrict

func (resource *ResourceDimensionConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `ResourceDimensionConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (ResourceDimensionConfig) Validate

func (resource ResourceDimensionConfig) Validate() error

Validate checks all the validation constraints that may be defined on `ResourceDimensionConfig` fields for violations and returns them.

type ResourceDimensionConfigBuilder

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

Links to a resource (image/svg path)

func NewResourceDimensionConfigBuilder

func NewResourceDimensionConfigBuilder() *ResourceDimensionConfigBuilder

func (*ResourceDimensionConfigBuilder) Build

func (*ResourceDimensionConfigBuilder) Field

fixed: T -- will be added by each element

func (*ResourceDimensionConfigBuilder) Fixed

func (*ResourceDimensionConfigBuilder) Mode

type ResourceDimensionMode

type ResourceDimensionMode string
const (
	ResourceDimensionModeFixed   ResourceDimensionMode = "fixed"
	ResourceDimensionModeField   ResourceDimensionMode = "field"
	ResourceDimensionModeMapping ResourceDimensionMode = "mapping"
)

type ScalarDimensionConfig

type ScalarDimensionConfig struct {
	Min   float64  `json:"min"`
	Max   float64  `json:"max"`
	Fixed *float64 `json:"fixed,omitempty"`
	// fixed: T -- will be added by each element
	Field *string              `json:"field,omitempty"`
	Mode  *ScalarDimensionMode `json:"mode,omitempty"`
}

func NewScalarDimensionConfig

func NewScalarDimensionConfig() *ScalarDimensionConfig

NewScalarDimensionConfig creates a new ScalarDimensionConfig object.

func (ScalarDimensionConfig) Equals

func (resource ScalarDimensionConfig) Equals(other ScalarDimensionConfig) bool

Equals tests the equality of two `ScalarDimensionConfig` objects.

func (*ScalarDimensionConfig) UnmarshalJSONStrict

func (resource *ScalarDimensionConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `ScalarDimensionConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (ScalarDimensionConfig) Validate

func (resource ScalarDimensionConfig) Validate() error

Validate checks all the validation constraints that may be defined on `ScalarDimensionConfig` fields for violations and returns them.

type ScalarDimensionConfigBuilder

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

func NewScalarDimensionConfigBuilder

func NewScalarDimensionConfigBuilder() *ScalarDimensionConfigBuilder

func (*ScalarDimensionConfigBuilder) Build

func (*ScalarDimensionConfigBuilder) Field

fixed: T -- will be added by each element

func (*ScalarDimensionConfigBuilder) Fixed

func (*ScalarDimensionConfigBuilder) Max

func (*ScalarDimensionConfigBuilder) Min

func (*ScalarDimensionConfigBuilder) Mode

type ScalarDimensionMode

type ScalarDimensionMode string
const (
	ScalarDimensionModeMod     ScalarDimensionMode = "mod"
	ScalarDimensionModeClamped ScalarDimensionMode = "clamped"
)

type ScaleDimensionConfig

type ScaleDimensionConfig struct {
	Min   float64  `json:"min"`
	Max   float64  `json:"max"`
	Fixed *float64 `json:"fixed,omitempty"`
	// fixed: T -- will be added by each element
	Field *string `json:"field,omitempty"`
	// | *"linear"
	Mode *ScaleDimensionMode `json:"mode,omitempty"`
}

func NewScaleDimensionConfig

func NewScaleDimensionConfig() *ScaleDimensionConfig

NewScaleDimensionConfig creates a new ScaleDimensionConfig object.

func (ScaleDimensionConfig) Equals

func (resource ScaleDimensionConfig) Equals(other ScaleDimensionConfig) bool

Equals tests the equality of two `ScaleDimensionConfig` objects.

func (*ScaleDimensionConfig) UnmarshalJSONStrict

func (resource *ScaleDimensionConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `ScaleDimensionConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (ScaleDimensionConfig) Validate

func (resource ScaleDimensionConfig) Validate() error

Validate checks all the validation constraints that may be defined on `ScaleDimensionConfig` fields for violations and returns them.

type ScaleDimensionConfigBuilder

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

func NewScaleDimensionConfigBuilder

func NewScaleDimensionConfigBuilder() *ScaleDimensionConfigBuilder

func (*ScaleDimensionConfigBuilder) Build

func (*ScaleDimensionConfigBuilder) Field

fixed: T -- will be added by each element

func (*ScaleDimensionConfigBuilder) Fixed

func (*ScaleDimensionConfigBuilder) Max

func (*ScaleDimensionConfigBuilder) Min

func (*ScaleDimensionConfigBuilder) Mode

| *"linear"

type ScaleDimensionMode

type ScaleDimensionMode string
const (
	ScaleDimensionModeLinear ScaleDimensionMode = "linear"
	ScaleDimensionModeQuad   ScaleDimensionMode = "quad"
)

type ScaleDirection

type ScaleDirection int64

TODO docs

const (
	ScaleDirectionUp    ScaleDirection = 1
	ScaleDirectionRight ScaleDirection = 1
	ScaleDirectionDown  ScaleDirection = -1
	ScaleDirectionLeft  ScaleDirection = -1
)

type ScaleDistribution

type ScaleDistribution string

TODO docs

const (
	ScaleDistributionLinear  ScaleDistribution = "linear"
	ScaleDistributionLog     ScaleDistribution = "log"
	ScaleDistributionOrdinal ScaleDistribution = "ordinal"
	ScaleDistributionSymlog  ScaleDistribution = "symlog"
)

type ScaleDistributionConfig

type ScaleDistributionConfig struct {
	Type            ScaleDistribution `json:"type"`
	Log             *float64          `json:"log,omitempty"`
	LinearThreshold *float64          `json:"linearThreshold,omitempty"`
}

TODO docs

func NewScaleDistributionConfig

func NewScaleDistributionConfig() *ScaleDistributionConfig

NewScaleDistributionConfig creates a new ScaleDistributionConfig object.

func (ScaleDistributionConfig) Equals

func (resource ScaleDistributionConfig) Equals(other ScaleDistributionConfig) bool

Equals tests the equality of two `ScaleDistributionConfig` objects.

func (*ScaleDistributionConfig) UnmarshalJSONStrict

func (resource *ScaleDistributionConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `ScaleDistributionConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (ScaleDistributionConfig) Validate

func (resource ScaleDistributionConfig) Validate() error

Validate checks all the validation constraints that may be defined on `ScaleDistributionConfig` fields for violations and returns them.

type ScaleDistributionConfigBuilder

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

TODO docs

func NewScaleDistributionConfigBuilder

func NewScaleDistributionConfigBuilder() *ScaleDistributionConfigBuilder

func (*ScaleDistributionConfigBuilder) Build

func (*ScaleDistributionConfigBuilder) LinearThreshold

func (builder *ScaleDistributionConfigBuilder) LinearThreshold(linearThreshold float64) *ScaleDistributionConfigBuilder

func (*ScaleDistributionConfigBuilder) Log

func (*ScaleDistributionConfigBuilder) Type

type ScaleOrientation

type ScaleOrientation int64

TODO docs

const (
	ScaleOrientationHorizontal ScaleOrientation = 0
	ScaleOrientationVertical   ScaleOrientation = 1
)

type SingleStatBaseOptions

type SingleStatBaseOptions struct {
	ReduceOptions ReduceDataOptions      `json:"reduceOptions"`
	Text          *VizTextDisplayOptions `json:"text,omitempty"`
	Orientation   VizOrientation         `json:"orientation"`
}

TODO docs

func NewSingleStatBaseOptions

func NewSingleStatBaseOptions() *SingleStatBaseOptions

NewSingleStatBaseOptions creates a new SingleStatBaseOptions object.

func (SingleStatBaseOptions) Equals

func (resource SingleStatBaseOptions) Equals(other SingleStatBaseOptions) bool

Equals tests the equality of two `SingleStatBaseOptions` objects.

func (*SingleStatBaseOptions) UnmarshalJSONStrict

func (resource *SingleStatBaseOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `SingleStatBaseOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (SingleStatBaseOptions) Validate

func (resource SingleStatBaseOptions) Validate() error

Validate checks all the validation constraints that may be defined on `SingleStatBaseOptions` fields for violations and returns them.

type SingleStatBaseOptionsBuilder

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

TODO docs

func NewSingleStatBaseOptionsBuilder

func NewSingleStatBaseOptionsBuilder() *SingleStatBaseOptionsBuilder

func (*SingleStatBaseOptionsBuilder) Build

func (*SingleStatBaseOptionsBuilder) Orientation

func (*SingleStatBaseOptionsBuilder) ReduceOptions

func (*SingleStatBaseOptionsBuilder) Text

type SortOrder

type SortOrder string

TODO docs

const (
	SortOrderAscending  SortOrder = "asc"
	SortOrderDescending SortOrder = "desc"
	SortOrderNone       SortOrder = "none"
)

type StackableFieldConfig

type StackableFieldConfig struct {
	Stacking *StackingConfig `json:"stacking,omitempty"`
}

TODO docs

func NewStackableFieldConfig

func NewStackableFieldConfig() *StackableFieldConfig

NewStackableFieldConfig creates a new StackableFieldConfig object.

func (StackableFieldConfig) Equals

func (resource StackableFieldConfig) Equals(other StackableFieldConfig) bool

Equals tests the equality of two `StackableFieldConfig` objects.

func (*StackableFieldConfig) UnmarshalJSONStrict

func (resource *StackableFieldConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `StackableFieldConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (StackableFieldConfig) Validate

func (resource StackableFieldConfig) Validate() error

Validate checks all the validation constraints that may be defined on `StackableFieldConfig` fields for violations and returns them.

type StackableFieldConfigBuilder

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

TODO docs

func NewStackableFieldConfigBuilder

func NewStackableFieldConfigBuilder() *StackableFieldConfigBuilder

func (*StackableFieldConfigBuilder) Build

func (*StackableFieldConfigBuilder) Stacking

type StackingConfig

type StackingConfig struct {
	Mode  *StackingMode `json:"mode,omitempty"`
	Group *string       `json:"group,omitempty"`
}

TODO docs

func NewStackingConfig

func NewStackingConfig() *StackingConfig

NewStackingConfig creates a new StackingConfig object.

func (StackingConfig) Equals

func (resource StackingConfig) Equals(other StackingConfig) bool

Equals tests the equality of two `StackingConfig` objects.

func (*StackingConfig) UnmarshalJSONStrict

func (resource *StackingConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `StackingConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (StackingConfig) Validate

func (resource StackingConfig) Validate() error

Validate checks all the validation constraints that may be defined on `StackingConfig` fields for violations and returns them.

type StackingConfigBuilder

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

TODO docs

func NewStackingConfigBuilder

func NewStackingConfigBuilder() *StackingConfigBuilder

func (*StackingConfigBuilder) Build

func (builder *StackingConfigBuilder) Build() (StackingConfig, error)

func (*StackingConfigBuilder) Group

func (builder *StackingConfigBuilder) Group(group string) *StackingConfigBuilder

func (*StackingConfigBuilder) Mode

type StackingMode

type StackingMode string

TODO docs

const (
	StackingModeNone    StackingMode = "none"
	StackingModeNormal  StackingMode = "normal"
	StackingModePercent StackingMode = "percent"
)

type TableAutoCellOptions

type TableAutoCellOptions struct {
	Type string `json:"type"`
}

Auto mode table cell options

func NewTableAutoCellOptions

func NewTableAutoCellOptions() *TableAutoCellOptions

NewTableAutoCellOptions creates a new TableAutoCellOptions object.

func (TableAutoCellOptions) Equals

func (resource TableAutoCellOptions) Equals(other TableAutoCellOptions) bool

Equals tests the equality of two `TableAutoCellOptions` objects.

func (*TableAutoCellOptions) UnmarshalJSONStrict

func (resource *TableAutoCellOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableAutoCellOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableAutoCellOptions) Validate

func (resource TableAutoCellOptions) Validate() error

Validate checks all the validation constraints that may be defined on `TableAutoCellOptions` fields for violations and returns them.

type TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions

type TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions struct {
	TableAutoCellOptions              *TableAutoCellOptions              `json:"TableAutoCellOptions,omitempty"`
	TableSparklineCellOptions         *TableSparklineCellOptions         `json:"TableSparklineCellOptions,omitempty"`
	TableBarGaugeCellOptions          *TableBarGaugeCellOptions          `json:"TableBarGaugeCellOptions,omitempty"`
	TableColoredBackgroundCellOptions *TableColoredBackgroundCellOptions `json:"TableColoredBackgroundCellOptions,omitempty"`
	TableColorTextCellOptions         *TableColorTextCellOptions         `json:"TableColorTextCellOptions,omitempty"`
	TableImageCellOptions             *TableImageCellOptions             `json:"TableImageCellOptions,omitempty"`
	TableDataLinksCellOptions         *TableDataLinksCellOptions         `json:"TableDataLinksCellOptions,omitempty"`
	TableJsonViewCellOptions          *TableJsonViewCellOptions          `json:"TableJsonViewCellOptions,omitempty"`
}

func NewTableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions

func NewTableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions() *TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions

NewTableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions creates a new TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions object.

func (TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions) Equals

Equals tests the equality of two `TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions` objects.

func (TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions) MarshalJSON

MarshalJSON implements a custom JSON marshalling logic to encode `TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions` as JSON.

func (*TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions) UnmarshalJSON

UnmarshalJSON implements a custom JSON unmarshalling logic to decode `TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions` from JSON.

func (*TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions) UnmarshalJSONStrict

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions) Validate

Validate checks all the validation constraints that may be defined on `TableAutoCellOptionsOrTableSparklineCellOptionsOrTableBarGaugeCellOptionsOrTableColoredBackgroundCellOptionsOrTableColorTextCellOptionsOrTableImageCellOptionsOrTableDataLinksCellOptionsOrTableJsonViewCellOptions` fields for violations and returns them.

type TableBarGaugeCellOptions

type TableBarGaugeCellOptions struct {
	Type             string               `json:"type"`
	Mode             *BarGaugeDisplayMode `json:"mode,omitempty"`
	ValueDisplayMode *BarGaugeValueMode   `json:"valueDisplayMode,omitempty"`
}

Gauge cell options

func NewTableBarGaugeCellOptions

func NewTableBarGaugeCellOptions() *TableBarGaugeCellOptions

NewTableBarGaugeCellOptions creates a new TableBarGaugeCellOptions object.

func (TableBarGaugeCellOptions) Equals

Equals tests the equality of two `TableBarGaugeCellOptions` objects.

func (*TableBarGaugeCellOptions) UnmarshalJSONStrict

func (resource *TableBarGaugeCellOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableBarGaugeCellOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableBarGaugeCellOptions) Validate

func (resource TableBarGaugeCellOptions) Validate() error

Validate checks all the validation constraints that may be defined on `TableBarGaugeCellOptions` fields for violations and returns them.

type TableBarGaugeCellOptionsBuilder

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

Gauge cell options

func NewTableBarGaugeCellOptionsBuilder

func NewTableBarGaugeCellOptionsBuilder() *TableBarGaugeCellOptionsBuilder

func (*TableBarGaugeCellOptionsBuilder) Build

func (*TableBarGaugeCellOptionsBuilder) Mode

func (*TableBarGaugeCellOptionsBuilder) ValueDisplayMode

func (builder *TableBarGaugeCellOptionsBuilder) ValueDisplayMode(valueDisplayMode BarGaugeValueMode) *TableBarGaugeCellOptionsBuilder

type TableCellBackgroundDisplayMode

type TableCellBackgroundDisplayMode string

Display mode to the "Colored Background" display mode for table cells. Either displays a solid color (basic mode) or a gradient.

const (
	TableCellBackgroundDisplayModeBasic    TableCellBackgroundDisplayMode = "basic"
	TableCellBackgroundDisplayModeGradient TableCellBackgroundDisplayMode = "gradient"
)

type TableCellDisplayMode

type TableCellDisplayMode string

Internally, this is the "type" of cell that's being displayed in the table such as colored text, JSON, gauge, etc. The color-background-solid, gradient-gauge, and lcd-gauge modes are deprecated in favor of new cell subOptions

const (
	TableCellDisplayModeAuto                 TableCellDisplayMode = "auto"
	TableCellDisplayModeColorText            TableCellDisplayMode = "color-text"
	TableCellDisplayModeColorBackground      TableCellDisplayMode = "color-background"
	TableCellDisplayModeColorBackgroundSolid TableCellDisplayMode = "color-background-solid"
	TableCellDisplayModeGradientGauge        TableCellDisplayMode = "gradient-gauge"
	TableCellDisplayModeLcdGauge             TableCellDisplayMode = "lcd-gauge"
	TableCellDisplayModeJSONView             TableCellDisplayMode = "json-view"
	TableCellDisplayModeBasicGauge           TableCellDisplayMode = "basic"
	TableCellDisplayModeImage                TableCellDisplayMode = "image"
	TableCellDisplayModeGauge                TableCellDisplayMode = "gauge"
	TableCellDisplayModeSparkline            TableCellDisplayMode = "sparkline"
	TableCellDisplayModeDataLinks            TableCellDisplayMode = "data-links"
	TableCellDisplayModeCustom               TableCellDisplayMode = "custom"
)

type TableCellHeight

type TableCellHeight string

Height of a table cell

const (
	TableCellHeightSm TableCellHeight = "sm"
	TableCellHeightMd TableCellHeight = "md"
	TableCellHeightLg TableCellHeight = "lg"
)

type TableCellOptions

Table cell options. Each cell has a display mode and other potential options for that display.

func NewTableCellOptions

func NewTableCellOptions() *TableCellOptions

NewTableCellOptions creates a new TableCellOptions object.

type TableColorTextCellOptions

type TableColorTextCellOptions struct {
	Type string `json:"type"`
}

Colored text cell options

func NewTableColorTextCellOptions

func NewTableColorTextCellOptions() *TableColorTextCellOptions

NewTableColorTextCellOptions creates a new TableColorTextCellOptions object.

func (TableColorTextCellOptions) Equals

Equals tests the equality of two `TableColorTextCellOptions` objects.

func (*TableColorTextCellOptions) UnmarshalJSONStrict

func (resource *TableColorTextCellOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableColorTextCellOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableColorTextCellOptions) Validate

func (resource TableColorTextCellOptions) Validate() error

Validate checks all the validation constraints that may be defined on `TableColorTextCellOptions` fields for violations and returns them.

type TableColoredBackgroundCellOptions

type TableColoredBackgroundCellOptions struct {
	Type       string                          `json:"type"`
	Mode       *TableCellBackgroundDisplayMode `json:"mode,omitempty"`
	ApplyToRow *bool                           `json:"applyToRow,omitempty"`
}

Colored background cell options

func NewTableColoredBackgroundCellOptions

func NewTableColoredBackgroundCellOptions() *TableColoredBackgroundCellOptions

NewTableColoredBackgroundCellOptions creates a new TableColoredBackgroundCellOptions object.

func (TableColoredBackgroundCellOptions) Equals

Equals tests the equality of two `TableColoredBackgroundCellOptions` objects.

func (*TableColoredBackgroundCellOptions) UnmarshalJSONStrict

func (resource *TableColoredBackgroundCellOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableColoredBackgroundCellOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableColoredBackgroundCellOptions) Validate

func (resource TableColoredBackgroundCellOptions) Validate() error

Validate checks all the validation constraints that may be defined on `TableColoredBackgroundCellOptions` fields for violations and returns them.

type TableColoredBackgroundCellOptionsBuilder

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

Colored background cell options

func NewTableColoredBackgroundCellOptionsBuilder

func NewTableColoredBackgroundCellOptionsBuilder() *TableColoredBackgroundCellOptionsBuilder

func (*TableColoredBackgroundCellOptionsBuilder) ApplyToRow

func (*TableColoredBackgroundCellOptionsBuilder) Build

func (*TableColoredBackgroundCellOptionsBuilder) Mode

type TableDataLinksCellOptions

type TableDataLinksCellOptions struct {
	Type string `json:"type"`
}

Show data links in the cell

func NewTableDataLinksCellOptions

func NewTableDataLinksCellOptions() *TableDataLinksCellOptions

NewTableDataLinksCellOptions creates a new TableDataLinksCellOptions object.

func (TableDataLinksCellOptions) Equals

Equals tests the equality of two `TableDataLinksCellOptions` objects.

func (*TableDataLinksCellOptions) UnmarshalJSONStrict

func (resource *TableDataLinksCellOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableDataLinksCellOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableDataLinksCellOptions) Validate

func (resource TableDataLinksCellOptions) Validate() error

Validate checks all the validation constraints that may be defined on `TableDataLinksCellOptions` fields for violations and returns them.

type TableFieldOptions

type TableFieldOptions struct {
	Width    *float64           `json:"width,omitempty"`
	MinWidth *float64           `json:"minWidth,omitempty"`
	Align    FieldTextAlignment `json:"align"`
	// This field is deprecated in favor of using cellOptions
	DisplayMode *TableCellDisplayMode `json:"displayMode,omitempty"`
	CellOptions *TableCellOptions     `json:"cellOptions,omitempty"`
	// ?? default is missing or false ??
	Hidden     *bool `json:"hidden,omitempty"`
	Inspect    bool  `json:"inspect"`
	Filterable *bool `json:"filterable,omitempty"`
	// Hides any header for a column, useful for columns that show some static content or buttons.
	HideHeader *bool `json:"hideHeader,omitempty"`
}

Field options for each field within a table (e.g 10, "The String", 64.20, etc.) Generally defines alignment, filtering capabilties, display options, etc.

func NewTableFieldOptions

func NewTableFieldOptions() *TableFieldOptions

NewTableFieldOptions creates a new TableFieldOptions object.

func (TableFieldOptions) Equals

func (resource TableFieldOptions) Equals(other TableFieldOptions) bool

Equals tests the equality of two `TableFieldOptions` objects.

func (*TableFieldOptions) UnmarshalJSONStrict

func (resource *TableFieldOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableFieldOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableFieldOptions) Validate

func (resource TableFieldOptions) Validate() error

Validate checks all the validation constraints that may be defined on `TableFieldOptions` fields for violations and returns them.

type TableFieldOptionsBuilder

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

Field options for each field within a table (e.g 10, "The String", 64.20, etc.) Generally defines alignment, filtering capabilties, display options, etc.

func NewTableFieldOptionsBuilder

func NewTableFieldOptionsBuilder() *TableFieldOptionsBuilder

func (*TableFieldOptionsBuilder) Align

func (*TableFieldOptionsBuilder) Build

func (builder *TableFieldOptionsBuilder) Build() (TableFieldOptions, error)

func (*TableFieldOptionsBuilder) CellOptions

func (builder *TableFieldOptionsBuilder) CellOptions(cellOptions TableCellOptions) *TableFieldOptionsBuilder

func (*TableFieldOptionsBuilder) DisplayMode

func (builder *TableFieldOptionsBuilder) DisplayMode(displayMode TableCellDisplayMode) *TableFieldOptionsBuilder

This field is deprecated in favor of using cellOptions

func (*TableFieldOptionsBuilder) Filterable

func (builder *TableFieldOptionsBuilder) Filterable(filterable bool) *TableFieldOptionsBuilder

func (*TableFieldOptionsBuilder) Hidden

func (builder *TableFieldOptionsBuilder) Hidden(hidden bool) *TableFieldOptionsBuilder

?? default is missing or false ??

func (*TableFieldOptionsBuilder) HideHeader

func (builder *TableFieldOptionsBuilder) HideHeader(hideHeader bool) *TableFieldOptionsBuilder

Hides any header for a column, useful for columns that show some static content or buttons.

func (*TableFieldOptionsBuilder) Inspect

func (builder *TableFieldOptionsBuilder) Inspect(inspect bool) *TableFieldOptionsBuilder

func (*TableFieldOptionsBuilder) MinWidth

func (builder *TableFieldOptionsBuilder) MinWidth(minWidth float64) *TableFieldOptionsBuilder

func (*TableFieldOptionsBuilder) Width

type TableFooterOptions

type TableFooterOptions struct {
	Show bool `json:"show"`
	// actually 1 value
	Reducer          []string `json:"reducer"`
	Fields           []string `json:"fields,omitempty"`
	EnablePagination *bool    `json:"enablePagination,omitempty"`
	CountRows        *bool    `json:"countRows,omitempty"`
}

Footer options

func NewTableFooterOptions

func NewTableFooterOptions() *TableFooterOptions

NewTableFooterOptions creates a new TableFooterOptions object.

func (TableFooterOptions) Equals

func (resource TableFooterOptions) Equals(other TableFooterOptions) bool

Equals tests the equality of two `TableFooterOptions` objects.

func (*TableFooterOptions) UnmarshalJSONStrict

func (resource *TableFooterOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableFooterOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableFooterOptions) Validate

func (resource TableFooterOptions) Validate() error

Validate checks all the validation constraints that may be defined on `TableFooterOptions` fields for violations and returns them.

type TableFooterOptionsBuilder

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

Footer options

func NewTableFooterOptionsBuilder

func NewTableFooterOptionsBuilder() *TableFooterOptionsBuilder

func (*TableFooterOptionsBuilder) Build

func (*TableFooterOptionsBuilder) CountRows

func (builder *TableFooterOptionsBuilder) CountRows(countRows bool) *TableFooterOptionsBuilder

func (*TableFooterOptionsBuilder) EnablePagination

func (builder *TableFooterOptionsBuilder) EnablePagination(enablePagination bool) *TableFooterOptionsBuilder

func (*TableFooterOptionsBuilder) Fields

func (builder *TableFooterOptionsBuilder) Fields(fields []string) *TableFooterOptionsBuilder

func (*TableFooterOptionsBuilder) Reducer

func (builder *TableFooterOptionsBuilder) Reducer(reducer []string) *TableFooterOptionsBuilder

actually 1 value

func (*TableFooterOptionsBuilder) Show

type TableImageCellOptions

type TableImageCellOptions struct {
	Type string `json:"type"`
}

Json view cell options

func NewTableImageCellOptions

func NewTableImageCellOptions() *TableImageCellOptions

NewTableImageCellOptions creates a new TableImageCellOptions object.

func (TableImageCellOptions) Equals

func (resource TableImageCellOptions) Equals(other TableImageCellOptions) bool

Equals tests the equality of two `TableImageCellOptions` objects.

func (*TableImageCellOptions) UnmarshalJSONStrict

func (resource *TableImageCellOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableImageCellOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableImageCellOptions) Validate

func (resource TableImageCellOptions) Validate() error

Validate checks all the validation constraints that may be defined on `TableImageCellOptions` fields for violations and returns them.

type TableJsonViewCellOptions

type TableJsonViewCellOptions struct {
	Type string `json:"type"`
}

Json view cell options

func NewTableJsonViewCellOptions

func NewTableJsonViewCellOptions() *TableJsonViewCellOptions

NewTableJsonViewCellOptions creates a new TableJsonViewCellOptions object.

func (TableJsonViewCellOptions) Equals

Equals tests the equality of two `TableJsonViewCellOptions` objects.

func (*TableJsonViewCellOptions) UnmarshalJSONStrict

func (resource *TableJsonViewCellOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableJsonViewCellOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableJsonViewCellOptions) Validate

func (resource TableJsonViewCellOptions) Validate() error

Validate checks all the validation constraints that may be defined on `TableJsonViewCellOptions` fields for violations and returns them.

type TableSortByFieldState

type TableSortByFieldState struct {
	// Sets the display name of the field to sort by
	DisplayName string `json:"displayName"`
	// Flag used to indicate descending sort order
	Desc *bool `json:"desc,omitempty"`
}

Sort by field state

func NewTableSortByFieldState

func NewTableSortByFieldState() *TableSortByFieldState

NewTableSortByFieldState creates a new TableSortByFieldState object.

func (TableSortByFieldState) Equals

func (resource TableSortByFieldState) Equals(other TableSortByFieldState) bool

Equals tests the equality of two `TableSortByFieldState` objects.

func (*TableSortByFieldState) UnmarshalJSONStrict

func (resource *TableSortByFieldState) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableSortByFieldState` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableSortByFieldState) Validate

func (resource TableSortByFieldState) Validate() error

Validate checks all the validation constraints that may be defined on `TableSortByFieldState` fields for violations and returns them.

type TableSortByFieldStateBuilder

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

Sort by field state

func NewTableSortByFieldStateBuilder

func NewTableSortByFieldStateBuilder() *TableSortByFieldStateBuilder

func (*TableSortByFieldStateBuilder) Build

func (*TableSortByFieldStateBuilder) Desc

Flag used to indicate descending sort order

func (*TableSortByFieldStateBuilder) DisplayName

func (builder *TableSortByFieldStateBuilder) DisplayName(displayName string) *TableSortByFieldStateBuilder

Sets the display name of the field to sort by

type TableSparklineCellOptions

type TableSparklineCellOptions struct {
	Type              string                      `json:"type"`
	DrawStyle         *GraphDrawStyle             `json:"drawStyle,omitempty"`
	GradientMode      *GraphGradientMode          `json:"gradientMode,omitempty"`
	ThresholdsStyle   *GraphThresholdsStyleConfig `json:"thresholdsStyle,omitempty"`
	LineColor         *string                     `json:"lineColor,omitempty"`
	LineWidth         *float64                    `json:"lineWidth,omitempty"`
	LineInterpolation *LineInterpolation          `json:"lineInterpolation,omitempty"`
	LineStyle         *LineStyle                  `json:"lineStyle,omitempty"`
	FillColor         *string                     `json:"fillColor,omitempty"`
	FillOpacity       *float64                    `json:"fillOpacity,omitempty"`
	ShowPoints        *VisibilityMode             `json:"showPoints,omitempty"`
	PointSize         *float64                    `json:"pointSize,omitempty"`
	PointColor        *string                     `json:"pointColor,omitempty"`
	AxisPlacement     *AxisPlacement              `json:"axisPlacement,omitempty"`
	AxisColorMode     *AxisColorMode              `json:"axisColorMode,omitempty"`
	AxisLabel         *string                     `json:"axisLabel,omitempty"`
	AxisWidth         *float64                    `json:"axisWidth,omitempty"`
	AxisSoftMin       *float64                    `json:"axisSoftMin,omitempty"`
	AxisSoftMax       *float64                    `json:"axisSoftMax,omitempty"`
	AxisGridShow      *bool                       `json:"axisGridShow,omitempty"`
	ScaleDistribution *ScaleDistributionConfig    `json:"scaleDistribution,omitempty"`
	AxisCenteredZero  *bool                       `json:"axisCenteredZero,omitempty"`
	BarAlignment      *BarAlignment               `json:"barAlignment,omitempty"`
	BarWidthFactor    *float64                    `json:"barWidthFactor,omitempty"`
	Stacking          *StackingConfig             `json:"stacking,omitempty"`
	HideFrom          *HideSeriesConfig           `json:"hideFrom,omitempty"`
	HideValue         *bool                       `json:"hideValue,omitempty"`
	Transform         *GraphTransform             `json:"transform,omitempty"`
	// Indicate if null values should be treated as gaps or connected.
	// When the value is a number, it represents the maximum delta in the
	// X axis that should be considered connected.  For timeseries, this is milliseconds
	SpanNulls      *BoolOrFloat64 `json:"spanNulls,omitempty"`
	FillBelowTo    *string        `json:"fillBelowTo,omitempty"`
	PointSymbol    *string        `json:"pointSymbol,omitempty"`
	AxisBorderShow *bool          `json:"axisBorderShow,omitempty"`
	BarMaxWidth    *float64       `json:"barMaxWidth,omitempty"`
}

Sparkline cell options

func NewTableSparklineCellOptions

func NewTableSparklineCellOptions() *TableSparklineCellOptions

NewTableSparklineCellOptions creates a new TableSparklineCellOptions object.

func (TableSparklineCellOptions) Equals

Equals tests the equality of two `TableSparklineCellOptions` objects.

func (*TableSparklineCellOptions) UnmarshalJSONStrict

func (resource *TableSparklineCellOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TableSparklineCellOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TableSparklineCellOptions) Validate

func (resource TableSparklineCellOptions) Validate() error

Validate checks all the validation constraints that may be defined on `TableSparklineCellOptions` fields for violations and returns them.

type TableSparklineCellOptionsBuilder

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

Sparkline cell options

func NewTableSparklineCellOptionsBuilder

func NewTableSparklineCellOptionsBuilder() *TableSparklineCellOptionsBuilder

func (*TableSparklineCellOptionsBuilder) AxisBorderShow

func (builder *TableSparklineCellOptionsBuilder) AxisBorderShow(axisBorderShow bool) *TableSparklineCellOptionsBuilder

func (*TableSparklineCellOptionsBuilder) AxisCenteredZero

func (builder *TableSparklineCellOptionsBuilder) AxisCenteredZero(axisCenteredZero bool) *TableSparklineCellOptionsBuilder

func (*TableSparklineCellOptionsBuilder) AxisColorMode

func (*TableSparklineCellOptionsBuilder) AxisGridShow

func (builder *TableSparklineCellOptionsBuilder) AxisGridShow(axisGridShow bool) *TableSparklineCellOptionsBuilder

func (*TableSparklineCellOptionsBuilder) AxisLabel

func (*TableSparklineCellOptionsBuilder) AxisPlacement

func (*TableSparklineCellOptionsBuilder) AxisSoftMax

func (*TableSparklineCellOptionsBuilder) AxisSoftMin

func (*TableSparklineCellOptionsBuilder) AxisWidth

func (*TableSparklineCellOptionsBuilder) BarAlignment

func (*TableSparklineCellOptionsBuilder) BarMaxWidth

func (*TableSparklineCellOptionsBuilder) BarWidthFactor

func (builder *TableSparklineCellOptionsBuilder) BarWidthFactor(barWidthFactor float64) *TableSparklineCellOptionsBuilder

func (*TableSparklineCellOptionsBuilder) Build

func (*TableSparklineCellOptionsBuilder) DrawStyle

func (*TableSparklineCellOptionsBuilder) FillBelowTo

func (*TableSparklineCellOptionsBuilder) FillColor

func (*TableSparklineCellOptionsBuilder) FillOpacity

func (*TableSparklineCellOptionsBuilder) GradientMode

func (*TableSparklineCellOptionsBuilder) HideFrom

func (*TableSparklineCellOptionsBuilder) HideValue

func (*TableSparklineCellOptionsBuilder) LineColor

func (*TableSparklineCellOptionsBuilder) LineInterpolation

func (builder *TableSparklineCellOptionsBuilder) LineInterpolation(lineInterpolation LineInterpolation) *TableSparklineCellOptionsBuilder

func (*TableSparklineCellOptionsBuilder) LineStyle

func (*TableSparklineCellOptionsBuilder) LineWidth

func (*TableSparklineCellOptionsBuilder) PointColor

func (*TableSparklineCellOptionsBuilder) PointSize

func (*TableSparklineCellOptionsBuilder) PointSymbol

func (*TableSparklineCellOptionsBuilder) ScaleDistribution

func (*TableSparklineCellOptionsBuilder) ShowPoints

func (*TableSparklineCellOptionsBuilder) SpanNulls

Indicate if null values should be treated as gaps or connected. When the value is a number, it represents the maximum delta in the X axis that should be considered connected. For timeseries, this is milliseconds

func (*TableSparklineCellOptionsBuilder) Stacking

func (*TableSparklineCellOptionsBuilder) ThresholdsStyle

func (*TableSparklineCellOptionsBuilder) Transform

type TextDimensionConfig

type TextDimensionConfig struct {
	Mode TextDimensionMode `json:"mode"`
	// fixed: T -- will be added by each element
	Field *string `json:"field,omitempty"`
	Fixed *string `json:"fixed,omitempty"`
}

func NewTextDimensionConfig

func NewTextDimensionConfig() *TextDimensionConfig

NewTextDimensionConfig creates a new TextDimensionConfig object.

func (TextDimensionConfig) Equals

func (resource TextDimensionConfig) Equals(other TextDimensionConfig) bool

Equals tests the equality of two `TextDimensionConfig` objects.

func (*TextDimensionConfig) UnmarshalJSONStrict

func (resource *TextDimensionConfig) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `TextDimensionConfig` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (TextDimensionConfig) Validate

func (resource TextDimensionConfig) Validate() error

Validate checks all the validation constraints that may be defined on `TextDimensionConfig` fields for violations and returns them.

type TextDimensionConfigBuilder

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

func NewTextDimensionConfigBuilder

func NewTextDimensionConfigBuilder() *TextDimensionConfigBuilder

func (*TextDimensionConfigBuilder) Build

func (*TextDimensionConfigBuilder) Field

fixed: T -- will be added by each element

func (*TextDimensionConfigBuilder) Fixed

func (*TextDimensionConfigBuilder) Mode

type TextDimensionMode

type TextDimensionMode string
const (
	TextDimensionModeFixed    TextDimensionMode = "fixed"
	TextDimensionModeField    TextDimensionMode = "field"
	TextDimensionModeTemplate TextDimensionMode = "template"
)

type TimeZone

type TimeZone string

A specific timezone from https://en.wikipedia.org/wiki/Tz_database

type TimelineValueAlignment

type TimelineValueAlignment string

Controls the value alignment in the TimelineChart component

const (
	TimelineValueAlignmentCenter TimelineValueAlignment = "center"
	TimelineValueAlignmentLeft   TimelineValueAlignment = "left"
	TimelineValueAlignmentRight  TimelineValueAlignment = "right"
)

type TooltipDisplayMode

type TooltipDisplayMode string

TODO docs

const (
	TooltipDisplayModeSingle TooltipDisplayMode = "single"
	TooltipDisplayModeMulti  TooltipDisplayMode = "multi"
	TooltipDisplayModeNone   TooltipDisplayMode = "none"
)

type VariableFormatID

type VariableFormatID string

Optional formats for the template variable replace functions See also https://grafana.com/docs/grafana/latest/dashboards/variables/variable-syntax/#advanced-variable-format-options

const (
	VariableFormatIDLucene        VariableFormatID = "lucene"
	VariableFormatIDRaw           VariableFormatID = "raw"
	VariableFormatIDRegex         VariableFormatID = "regex"
	VariableFormatIDPipe          VariableFormatID = "pipe"
	VariableFormatIDDistributed   VariableFormatID = "distributed"
	VariableFormatIDCSV           VariableFormatID = "csv"
	VariableFormatIDHTML          VariableFormatID = "html"
	VariableFormatIDJSON          VariableFormatID = "json"
	VariableFormatIDPercentEncode VariableFormatID = "percentencode"
	VariableFormatIDUriEncode     VariableFormatID = "uriencode"
	VariableFormatIDSingleQuote   VariableFormatID = "singlequote"
	VariableFormatIDDoubleQuote   VariableFormatID = "doublequote"
	VariableFormatIDSQLString     VariableFormatID = "sqlstring"
	VariableFormatIDDate          VariableFormatID = "date"
	VariableFormatIDGlob          VariableFormatID = "glob"
	VariableFormatIDText          VariableFormatID = "text"
	VariableFormatIDQueryParam    VariableFormatID = "queryparam"
)

type VisibilityMode

type VisibilityMode string

TODO docs

const (
	VisibilityModeAuto   VisibilityMode = "auto"
	VisibilityModeNever  VisibilityMode = "never"
	VisibilityModeAlways VisibilityMode = "always"
)

type VizLegendOptions

type VizLegendOptions struct {
	DisplayMode LegendDisplayMode `json:"displayMode"`
	Placement   LegendPlacement   `json:"placement"`
	ShowLegend  bool              `json:"showLegend"`
	AsTable     *bool             `json:"asTable,omitempty"`
	IsVisible   *bool             `json:"isVisible,omitempty"`
	SortBy      *string           `json:"sortBy,omitempty"`
	SortDesc    *bool             `json:"sortDesc,omitempty"`
	Width       *float64          `json:"width,omitempty"`
	Calcs       []string          `json:"calcs"`
}

TODO docs

func NewVizLegendOptions

func NewVizLegendOptions() *VizLegendOptions

NewVizLegendOptions creates a new VizLegendOptions object.

func (VizLegendOptions) Equals

func (resource VizLegendOptions) Equals(other VizLegendOptions) bool

Equals tests the equality of two `VizLegendOptions` objects.

func (*VizLegendOptions) UnmarshalJSONStrict

func (resource *VizLegendOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `VizLegendOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (VizLegendOptions) Validate

func (resource VizLegendOptions) Validate() error

Validate checks all the validation constraints that may be defined on `VizLegendOptions` fields for violations and returns them.

type VizLegendOptionsBuilder

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

TODO docs

func NewVizLegendOptionsBuilder

func NewVizLegendOptionsBuilder() *VizLegendOptionsBuilder

func (*VizLegendOptionsBuilder) AsTable

func (builder *VizLegendOptionsBuilder) AsTable(asTable bool) *VizLegendOptionsBuilder

func (*VizLegendOptionsBuilder) Build

func (builder *VizLegendOptionsBuilder) Build() (VizLegendOptions, error)

func (*VizLegendOptionsBuilder) Calcs

func (builder *VizLegendOptionsBuilder) Calcs(calcs []string) *VizLegendOptionsBuilder

func (*VizLegendOptionsBuilder) DisplayMode

func (builder *VizLegendOptionsBuilder) DisplayMode(displayMode LegendDisplayMode) *VizLegendOptionsBuilder

func (*VizLegendOptionsBuilder) IsVisible

func (builder *VizLegendOptionsBuilder) IsVisible(isVisible bool) *VizLegendOptionsBuilder

func (*VizLegendOptionsBuilder) Placement

func (builder *VizLegendOptionsBuilder) Placement(placement LegendPlacement) *VizLegendOptionsBuilder

func (*VizLegendOptionsBuilder) ShowLegend

func (builder *VizLegendOptionsBuilder) ShowLegend(showLegend bool) *VizLegendOptionsBuilder

func (*VizLegendOptionsBuilder) SortBy

func (builder *VizLegendOptionsBuilder) SortBy(sortBy string) *VizLegendOptionsBuilder

func (*VizLegendOptionsBuilder) SortDesc

func (builder *VizLegendOptionsBuilder) SortDesc(sortDesc bool) *VizLegendOptionsBuilder

func (*VizLegendOptionsBuilder) Width

type VizOrientation

type VizOrientation string

TODO docs

const (
	VizOrientationAuto       VizOrientation = "auto"
	VizOrientationVertical   VizOrientation = "vertical"
	VizOrientationHorizontal VizOrientation = "horizontal"
)

type VizTextDisplayOptions

type VizTextDisplayOptions struct {
	// Explicit title text size
	TitleSize *float64 `json:"titleSize,omitempty"`
	// Explicit value text size
	ValueSize *float64 `json:"valueSize,omitempty"`
}

TODO docs

func NewVizTextDisplayOptions

func NewVizTextDisplayOptions() *VizTextDisplayOptions

NewVizTextDisplayOptions creates a new VizTextDisplayOptions object.

func (VizTextDisplayOptions) Equals

func (resource VizTextDisplayOptions) Equals(other VizTextDisplayOptions) bool

Equals tests the equality of two `VizTextDisplayOptions` objects.

func (*VizTextDisplayOptions) UnmarshalJSONStrict

func (resource *VizTextDisplayOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `VizTextDisplayOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (VizTextDisplayOptions) Validate

func (resource VizTextDisplayOptions) Validate() error

Validate checks all the validation constraints that may be defined on `VizTextDisplayOptions` fields for violations and returns them.

type VizTextDisplayOptionsBuilder

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

TODO docs

func NewVizTextDisplayOptionsBuilder

func NewVizTextDisplayOptionsBuilder() *VizTextDisplayOptionsBuilder

func (*VizTextDisplayOptionsBuilder) Build

func (*VizTextDisplayOptionsBuilder) TitleSize

func (builder *VizTextDisplayOptionsBuilder) TitleSize(titleSize float64) *VizTextDisplayOptionsBuilder

Explicit title text size

func (*VizTextDisplayOptionsBuilder) ValueSize

func (builder *VizTextDisplayOptionsBuilder) ValueSize(valueSize float64) *VizTextDisplayOptionsBuilder

Explicit value text size

type VizTooltipOptions

type VizTooltipOptions struct {
	Mode      TooltipDisplayMode `json:"mode"`
	Sort      SortOrder          `json:"sort"`
	MaxWidth  *float64           `json:"maxWidth,omitempty"`
	MaxHeight *float64           `json:"maxHeight,omitempty"`
}

TODO docs

func NewVizTooltipOptions

func NewVizTooltipOptions() *VizTooltipOptions

NewVizTooltipOptions creates a new VizTooltipOptions object.

func (VizTooltipOptions) Equals

func (resource VizTooltipOptions) Equals(other VizTooltipOptions) bool

Equals tests the equality of two `VizTooltipOptions` objects.

func (*VizTooltipOptions) UnmarshalJSONStrict

func (resource *VizTooltipOptions) UnmarshalJSONStrict(raw []byte) error

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode `VizTooltipOptions` from JSON. Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (VizTooltipOptions) Validate

func (resource VizTooltipOptions) Validate() error

Validate checks all the validation constraints that may be defined on `VizTooltipOptions` fields for violations and returns them.

type VizTooltipOptionsBuilder

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

TODO docs

func NewVizTooltipOptionsBuilder

func NewVizTooltipOptionsBuilder() *VizTooltipOptionsBuilder

func (*VizTooltipOptionsBuilder) Build

func (builder *VizTooltipOptionsBuilder) Build() (VizTooltipOptions, error)

func (*VizTooltipOptionsBuilder) MaxHeight

func (builder *VizTooltipOptionsBuilder) MaxHeight(maxHeight float64) *VizTooltipOptionsBuilder

func (*VizTooltipOptionsBuilder) MaxWidth

func (builder *VizTooltipOptionsBuilder) MaxWidth(maxWidth float64) *VizTooltipOptionsBuilder

func (*VizTooltipOptionsBuilder) Mode

func (*VizTooltipOptionsBuilder) Sort

Source Files

Jump to

Keyboard shortcuts

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