uiv1

package
v0.83.2 Latest Latest
Warning

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

Go to latest
Published: Mar 11, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	DashboardState_LeaderboardContextColumn_name = map[int32]string{
		0: "LEADERBOARD_CONTEXT_COLUMN_UNSPECIFIED",
		1: "LEADERBOARD_CONTEXT_COLUMN_PERCENT",
		2: "LEADERBOARD_CONTEXT_COLUMN_DELTA_PERCENT",
		3: "LEADERBOARD_CONTEXT_COLUMN_DELTA_ABSOLUTE",
		4: "LEADERBOARD_CONTEXT_COLUMN_HIDDEN",
	}
	DashboardState_LeaderboardContextColumn_value = map[string]int32{
		"LEADERBOARD_CONTEXT_COLUMN_UNSPECIFIED":    0,
		"LEADERBOARD_CONTEXT_COLUMN_PERCENT":        1,
		"LEADERBOARD_CONTEXT_COLUMN_DELTA_PERCENT":  2,
		"LEADERBOARD_CONTEXT_COLUMN_DELTA_ABSOLUTE": 3,
		"LEADERBOARD_CONTEXT_COLUMN_HIDDEN":         4,
	}
)

Enum value maps for DashboardState_LeaderboardContextColumn.

View Source
var (
	DashboardState_LeaderboardSortDirection_name = map[int32]string{
		0: "LEADERBOARD_SORT_DIRECTION_UNSPECIFIED",
		1: "LEADERBOARD_SORT_DIRECTION_ASCENDING",
		2: "LEADERBOARD_SORT_DIRECTION_DESCENDING",
	}
	DashboardState_LeaderboardSortDirection_value = map[string]int32{
		"LEADERBOARD_SORT_DIRECTION_UNSPECIFIED": 0,
		"LEADERBOARD_SORT_DIRECTION_ASCENDING":   1,
		"LEADERBOARD_SORT_DIRECTION_DESCENDING":  2,
	}
)

Enum value maps for DashboardState_LeaderboardSortDirection.

View Source
var (
	DashboardState_LeaderboardSortType_name = map[int32]string{
		0: "LEADERBOARD_SORT_TYPE_UNSPECIFIED",
		1: "LEADERBOARD_SORT_TYPE_VALUE",
		2: "LEADERBOARD_SORT_TYPE_DIMENSION",
		3: "LEADERBOARD_SORT_TYPE_PERCENT",
		4: "LEADERBOARD_SORT_TYPE_DELTA_PERCENT",
		5: "LEADERBOARD_SORT_TYPE_DELTA_ABSOLUTE",
	}
	DashboardState_LeaderboardSortType_value = map[string]int32{
		"LEADERBOARD_SORT_TYPE_UNSPECIFIED":    0,
		"LEADERBOARD_SORT_TYPE_VALUE":          1,
		"LEADERBOARD_SORT_TYPE_DIMENSION":      2,
		"LEADERBOARD_SORT_TYPE_PERCENT":        3,
		"LEADERBOARD_SORT_TYPE_DELTA_PERCENT":  4,
		"LEADERBOARD_SORT_TYPE_DELTA_ABSOLUTE": 5,
	}
)

Enum value maps for DashboardState_LeaderboardSortType.

View Source
var (
	DashboardState_PivotTableMode_name = map[int32]string{
		0: "PIVOT_TABLE_MODE_UNSPECIFIED",
		1: "PIVOT_TABLE_MODE_FLAT",
		2: "PIVOT_TABLE_MODE_NEST",
	}
	DashboardState_PivotTableMode_value = map[string]int32{
		"PIVOT_TABLE_MODE_UNSPECIFIED": 0,
		"PIVOT_TABLE_MODE_FLAT":        1,
		"PIVOT_TABLE_MODE_NEST":        2,
	}
)

Enum value maps for DashboardState_PivotTableMode.

View Source
var (
	DashboardState_ActivePage_name = map[int32]string{
		0: "ACTIVE_PAGE_UNSPECIFIED",
		1: "ACTIVE_PAGE_DEFAULT",
		2: "ACTIVE_PAGE_DIMENSION_TABLE",
		3: "ACTIVE_PAGE_TIME_DIMENSIONAL_DETAIL",
		4: "ACTIVE_PAGE_PIVOT",
	}
	DashboardState_ActivePage_value = map[string]int32{
		"ACTIVE_PAGE_UNSPECIFIED":             0,
		"ACTIVE_PAGE_DEFAULT":                 1,
		"ACTIVE_PAGE_DIMENSION_TABLE":         2,
		"ACTIVE_PAGE_TIME_DIMENSIONAL_DETAIL": 3,
		"ACTIVE_PAGE_PIVOT":                   4,
	}
)

Enum value maps for DashboardState_ActivePage.

View Source
var File_rill_ui_v1_dashboard_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type DashboardDimensionFilter

type DashboardDimensionFilter struct {
	Name   string         `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Filter *v1.Expression `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

func (*DashboardDimensionFilter) Descriptor deprecated

func (*DashboardDimensionFilter) Descriptor() ([]byte, []int)

Deprecated: Use DashboardDimensionFilter.ProtoReflect.Descriptor instead.

func (*DashboardDimensionFilter) GetFilter

func (x *DashboardDimensionFilter) GetFilter() *v1.Expression

func (*DashboardDimensionFilter) GetName

func (x *DashboardDimensionFilter) GetName() string

func (*DashboardDimensionFilter) ProtoMessage

func (*DashboardDimensionFilter) ProtoMessage()

func (*DashboardDimensionFilter) ProtoReflect

func (x *DashboardDimensionFilter) ProtoReflect() protoreflect.Message

func (*DashboardDimensionFilter) Reset

func (x *DashboardDimensionFilter) Reset()

func (*DashboardDimensionFilter) String

func (x *DashboardDimensionFilter) String() string

func (*DashboardDimensionFilter) Validate

func (m *DashboardDimensionFilter) Validate() error

Validate checks the field values on DashboardDimensionFilter with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*DashboardDimensionFilter) ValidateAll

func (m *DashboardDimensionFilter) ValidateAll() error

ValidateAll checks the field values on DashboardDimensionFilter with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DashboardDimensionFilterMultiError, or nil if none found.

type DashboardDimensionFilterMultiError

type DashboardDimensionFilterMultiError []error

DashboardDimensionFilterMultiError is an error wrapping multiple validation errors returned by DashboardDimensionFilter.ValidateAll() if the designated constraints aren't met.

func (DashboardDimensionFilterMultiError) AllErrors

func (m DashboardDimensionFilterMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DashboardDimensionFilterMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type DashboardDimensionFilterValidationError

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

DashboardDimensionFilterValidationError is the validation error returned by DashboardDimensionFilter.Validate if the designated constraints aren't met.

func (DashboardDimensionFilterValidationError) Cause

Cause function returns cause value.

func (DashboardDimensionFilterValidationError) Error

Error satisfies the builtin error interface

func (DashboardDimensionFilterValidationError) ErrorName

ErrorName returns error name.

func (DashboardDimensionFilterValidationError) Field

Field function returns field value.

func (DashboardDimensionFilterValidationError) Key

Key function returns key value.

func (DashboardDimensionFilterValidationError) Reason

Reason function returns reason value.

type DashboardState

type DashboardState struct {

	// Selected time range
	TimeRange *DashboardTimeRange `protobuf:"bytes,1,opt,name=time_range,json=timeRange,proto3" json:"time_range,omitempty"`
	// Dimension filters applied
	Filters *v1.MetricsViewFilter `protobuf:"bytes,2,opt,name=filters,proto3" json:"filters,omitempty"`
	// Expression format for dimension filters
	Where *v1.Expression `protobuf:"bytes,20,opt,name=where,proto3" json:"where,omitempty"`
	// Temporary to differentiate between "select" and "in list" modes. Expression will be replaced with UI specific state in the future.
	DimensionsWithInlistFilter []string `` /* 144-byte string literal not displayed */
	// Expression format for measure filters
	Having []*DashboardDimensionFilter `protobuf:"bytes,21,rep,name=having,proto3" json:"having,omitempty"`
	// Selected time granularity
	TimeGrain        v1.TimeGrain        `protobuf:"varint,3,opt,name=time_grain,json=timeGrain,proto3,enum=rill.runtime.v1.TimeGrain" json:"time_grain,omitempty"`
	CompareTimeRange *DashboardTimeRange `protobuf:"bytes,4,opt,name=compare_time_range,json=compareTimeRange,proto3" json:"compare_time_range,omitempty"`
	// Determines the active page. This is cleaner than using setting `selected_dimension` or `expanded_measure`
	ActivePage DashboardState_ActivePage `` /* 135-byte string literal not displayed */
	// Selected measure for the leaderboard
	LeaderboardMeasure *string `protobuf:"bytes,5,opt,name=leaderboard_measure,json=leaderboardMeasure,proto3,oneof" json:"leaderboard_measure,omitempty"`
	// Focused dimension
	SelectedDimension  *string `protobuf:"bytes,6,opt,name=selected_dimension,json=selectedDimension,proto3,oneof" json:"selected_dimension,omitempty"`
	ShowTimeComparison *bool   `protobuf:"varint,7,opt,name=show_time_comparison,json=showTimeComparison,proto3,oneof" json:"show_time_comparison,omitempty"`
	// Selected measures and dimensions to be shown
	VisibleMeasures          []string                                 `protobuf:"bytes,8,rep,name=visible_measures,json=visibleMeasures,proto3" json:"visible_measures,omitempty"`
	AllMeasuresVisible       *bool                                    `protobuf:"varint,9,opt,name=all_measures_visible,json=allMeasuresVisible,proto3,oneof" json:"all_measures_visible,omitempty"`
	VisibleDimensions        []string                                 `protobuf:"bytes,10,rep,name=visible_dimensions,json=visibleDimensions,proto3" json:"visible_dimensions,omitempty"`
	AllDimensionsVisible     *bool                                    `` /* 131-byte string literal not displayed */
	LeaderboardContextColumn *DashboardState_LeaderboardContextColumn `` /* 199-byte string literal not displayed */
	// Selected timezone for the dashboard
	SelectedTimezone *string `protobuf:"bytes,13,opt,name=selected_timezone,json=selectedTimezone,proto3,oneof" json:"selected_timezone,omitempty"`
	// Scrub time range
	ScrubRange               *DashboardTimeRange                      `protobuf:"bytes,14,opt,name=scrub_range,json=scrubRange,proto3,oneof" json:"scrub_range,omitempty"`
	LeaderboardSortDirection *DashboardState_LeaderboardSortDirection `` /* 199-byte string literal not displayed */
	LeaderboardSortType      *DashboardState_LeaderboardSortType      `` /* 179-byte string literal not displayed */
	// Deprecated
	LeaderboardMeasureCount              *uint32  `` /* 140-byte string literal not displayed */
	LeaderboardMeasures                  []string `protobuf:"bytes,39,rep,name=leaderboard_measures,json=leaderboardMeasures,proto3" json:"leaderboard_measures,omitempty"`
	LeaderboardShowContextForAllMeasures *bool    `` /* 185-byte string literal not displayed */
	ComparisonDimension                  *string  `protobuf:"bytes,17,opt,name=comparison_dimension,json=comparisonDimension,proto3,oneof" json:"comparison_dimension,omitempty"`
	// Expanded measure for TDD view
	ExpandedMeasure *string `protobuf:"bytes,18,opt,name=expanded_measure,json=expandedMeasure,proto3,oneof" json:"expanded_measure,omitempty"`
	// Pin index for TDD table selected values
	PinIndex *int32 `protobuf:"varint,19,opt,name=pin_index,json=pinIndex,proto3,oneof" json:"pin_index,omitempty"`
	// Type of visualization for TDD view
	ChartType *string `protobuf:"bytes,33,opt,name=chart_type,json=chartType,proto3,oneof" json:"chart_type,omitempty"`
	// These pivot fields are preserved to support backward
	// compatibility with existing URLs
	PivotRowTimeDimensions    []v1.TimeGrain `` /* 171-byte string literal not displayed */
	PivotRowDimensions        []string       `protobuf:"bytes,24,rep,name=pivot_row_dimensions,json=pivotRowDimensions,proto3" json:"pivot_row_dimensions,omitempty"`
	PivotColumnTimeDimensions []v1.TimeGrain `` /* 180-byte string literal not displayed */
	PivotColumnDimensions     []string       `` /* 127-byte string literal not displayed */
	// List of time measures selected for columns
	PivotColumnMeasures []string `protobuf:"bytes,27,rep,name=pivot_column_measures,json=pivotColumnMeasures,proto3" json:"pivot_column_measures,omitempty"`
	// Map of dimensions that are expanded
	PivotExpanded map[string]bool `` /* 190-byte string literal not displayed */
	// Sort settings
	PivotSort []*PivotColumnSort `protobuf:"bytes,29,rep,name=pivot_sort,json=pivotSort,proto3" json:"pivot_sort,omitempty"`
	// Pagination data
	PivotColumnPage *int32                         `protobuf:"varint,30,opt,name=pivot_column_page,json=pivotColumnPage,proto3,oneof" json:"pivot_column_page,omitempty"`
	PivotTableMode  *DashboardState_PivotTableMode `` /* 159-byte string literal not displayed */
	// Enable comparison for pivot
	PivotEnableComparison *bool `` /* 134-byte string literal not displayed */
	// List of all dimensions selected for rows
	PivotRowAllDimensions []*PivotElement `` /* 129-byte string literal not displayed */
	// List of all dimensions selected for columns
	PivotColumnAllDimensions []*PivotElement `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

DashboardState represents the dashboard as seen by the user

func (*DashboardState) Descriptor deprecated

func (*DashboardState) Descriptor() ([]byte, []int)

Deprecated: Use DashboardState.ProtoReflect.Descriptor instead.

func (*DashboardState) GetActivePage

func (x *DashboardState) GetActivePage() DashboardState_ActivePage

func (*DashboardState) GetAllDimensionsVisible

func (x *DashboardState) GetAllDimensionsVisible() bool

func (*DashboardState) GetAllMeasuresVisible

func (x *DashboardState) GetAllMeasuresVisible() bool

func (*DashboardState) GetChartType

func (x *DashboardState) GetChartType() string

func (*DashboardState) GetCompareTimeRange

func (x *DashboardState) GetCompareTimeRange() *DashboardTimeRange

func (*DashboardState) GetComparisonDimension

func (x *DashboardState) GetComparisonDimension() string

func (*DashboardState) GetDimensionsWithInlistFilter

func (x *DashboardState) GetDimensionsWithInlistFilter() []string

func (*DashboardState) GetExpandedMeasure

func (x *DashboardState) GetExpandedMeasure() string

func (*DashboardState) GetFilters

func (x *DashboardState) GetFilters() *v1.MetricsViewFilter

func (*DashboardState) GetHaving

func (x *DashboardState) GetHaving() []*DashboardDimensionFilter

func (*DashboardState) GetLeaderboardContextColumn

func (x *DashboardState) GetLeaderboardContextColumn() DashboardState_LeaderboardContextColumn

func (*DashboardState) GetLeaderboardMeasure

func (x *DashboardState) GetLeaderboardMeasure() string

func (*DashboardState) GetLeaderboardMeasureCount

func (x *DashboardState) GetLeaderboardMeasureCount() uint32

func (*DashboardState) GetLeaderboardMeasures

func (x *DashboardState) GetLeaderboardMeasures() []string

func (*DashboardState) GetLeaderboardShowContextForAllMeasures

func (x *DashboardState) GetLeaderboardShowContextForAllMeasures() bool

func (*DashboardState) GetLeaderboardSortDirection

func (x *DashboardState) GetLeaderboardSortDirection() DashboardState_LeaderboardSortDirection

func (*DashboardState) GetLeaderboardSortType

func (x *DashboardState) GetLeaderboardSortType() DashboardState_LeaderboardSortType

func (*DashboardState) GetPinIndex

func (x *DashboardState) GetPinIndex() int32

func (*DashboardState) GetPivotColumnAllDimensions

func (x *DashboardState) GetPivotColumnAllDimensions() []*PivotElement

func (*DashboardState) GetPivotColumnDimensions

func (x *DashboardState) GetPivotColumnDimensions() []string

func (*DashboardState) GetPivotColumnMeasures

func (x *DashboardState) GetPivotColumnMeasures() []string

func (*DashboardState) GetPivotColumnPage

func (x *DashboardState) GetPivotColumnPage() int32

func (*DashboardState) GetPivotColumnTimeDimensions

func (x *DashboardState) GetPivotColumnTimeDimensions() []v1.TimeGrain

func (*DashboardState) GetPivotEnableComparison

func (x *DashboardState) GetPivotEnableComparison() bool

func (*DashboardState) GetPivotExpanded

func (x *DashboardState) GetPivotExpanded() map[string]bool

func (*DashboardState) GetPivotRowAllDimensions

func (x *DashboardState) GetPivotRowAllDimensions() []*PivotElement

func (*DashboardState) GetPivotRowDimensions

func (x *DashboardState) GetPivotRowDimensions() []string

func (*DashboardState) GetPivotRowTimeDimensions

func (x *DashboardState) GetPivotRowTimeDimensions() []v1.TimeGrain

func (*DashboardState) GetPivotSort

func (x *DashboardState) GetPivotSort() []*PivotColumnSort

func (*DashboardState) GetPivotTableMode

func (x *DashboardState) GetPivotTableMode() DashboardState_PivotTableMode

func (*DashboardState) GetScrubRange

func (x *DashboardState) GetScrubRange() *DashboardTimeRange

func (*DashboardState) GetSelectedDimension

func (x *DashboardState) GetSelectedDimension() string

func (*DashboardState) GetSelectedTimezone

func (x *DashboardState) GetSelectedTimezone() string

func (*DashboardState) GetShowTimeComparison

func (x *DashboardState) GetShowTimeComparison() bool

func (*DashboardState) GetTimeGrain

func (x *DashboardState) GetTimeGrain() v1.TimeGrain

func (*DashboardState) GetTimeRange

func (x *DashboardState) GetTimeRange() *DashboardTimeRange

func (*DashboardState) GetVisibleDimensions

func (x *DashboardState) GetVisibleDimensions() []string

func (*DashboardState) GetVisibleMeasures

func (x *DashboardState) GetVisibleMeasures() []string

func (*DashboardState) GetWhere

func (x *DashboardState) GetWhere() *v1.Expression

func (*DashboardState) ProtoMessage

func (*DashboardState) ProtoMessage()

func (*DashboardState) ProtoReflect

func (x *DashboardState) ProtoReflect() protoreflect.Message

func (*DashboardState) Reset

func (x *DashboardState) Reset()

func (*DashboardState) String

func (x *DashboardState) String() string

func (*DashboardState) Validate

func (m *DashboardState) Validate() error

Validate checks the field values on DashboardState with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*DashboardState) ValidateAll

func (m *DashboardState) ValidateAll() error

ValidateAll checks the field values on DashboardState with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DashboardStateMultiError, or nil if none found.

type DashboardStateMultiError

type DashboardStateMultiError []error

DashboardStateMultiError is an error wrapping multiple validation errors returned by DashboardState.ValidateAll() if the designated constraints aren't met.

func (DashboardStateMultiError) AllErrors

func (m DashboardStateMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DashboardStateMultiError) Error

func (m DashboardStateMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type DashboardStateValidationError

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

DashboardStateValidationError is the validation error returned by DashboardState.Validate if the designated constraints aren't met.

func (DashboardStateValidationError) Cause

Cause function returns cause value.

func (DashboardStateValidationError) Error

Error satisfies the builtin error interface

func (DashboardStateValidationError) ErrorName

func (e DashboardStateValidationError) ErrorName() string

ErrorName returns error name.

func (DashboardStateValidationError) Field

Field function returns field value.

func (DashboardStateValidationError) Key

Key function returns key value.

func (DashboardStateValidationError) Reason

Reason function returns reason value.

type DashboardState_ActivePage

type DashboardState_ActivePage int32
const (
	DashboardState_ACTIVE_PAGE_UNSPECIFIED             DashboardState_ActivePage = 0
	DashboardState_ACTIVE_PAGE_DEFAULT                 DashboardState_ActivePage = 1
	DashboardState_ACTIVE_PAGE_DIMENSION_TABLE         DashboardState_ActivePage = 2
	DashboardState_ACTIVE_PAGE_TIME_DIMENSIONAL_DETAIL DashboardState_ActivePage = 3
	DashboardState_ACTIVE_PAGE_PIVOT                   DashboardState_ActivePage = 4
)

func (DashboardState_ActivePage) Descriptor

func (DashboardState_ActivePage) Enum

func (DashboardState_ActivePage) EnumDescriptor deprecated

func (DashboardState_ActivePage) EnumDescriptor() ([]byte, []int)

Deprecated: Use DashboardState_ActivePage.Descriptor instead.

func (DashboardState_ActivePage) Number

func (DashboardState_ActivePage) String

func (x DashboardState_ActivePage) String() string

func (DashboardState_ActivePage) Type

type DashboardState_LeaderboardContextColumn

type DashboardState_LeaderboardContextColumn int32
const (
	DashboardState_LEADERBOARD_CONTEXT_COLUMN_UNSPECIFIED    DashboardState_LeaderboardContextColumn = 0
	DashboardState_LEADERBOARD_CONTEXT_COLUMN_PERCENT        DashboardState_LeaderboardContextColumn = 1
	DashboardState_LEADERBOARD_CONTEXT_COLUMN_DELTA_PERCENT  DashboardState_LeaderboardContextColumn = 2
	DashboardState_LEADERBOARD_CONTEXT_COLUMN_DELTA_ABSOLUTE DashboardState_LeaderboardContextColumn = 3
	DashboardState_LEADERBOARD_CONTEXT_COLUMN_HIDDEN         DashboardState_LeaderboardContextColumn = 4
)

func (DashboardState_LeaderboardContextColumn) Descriptor

func (DashboardState_LeaderboardContextColumn) Enum

func (DashboardState_LeaderboardContextColumn) EnumDescriptor deprecated

func (DashboardState_LeaderboardContextColumn) EnumDescriptor() ([]byte, []int)

Deprecated: Use DashboardState_LeaderboardContextColumn.Descriptor instead.

func (DashboardState_LeaderboardContextColumn) Number

func (DashboardState_LeaderboardContextColumn) String

func (DashboardState_LeaderboardContextColumn) Type

type DashboardState_LeaderboardSortDirection

type DashboardState_LeaderboardSortDirection int32
const (
	DashboardState_LEADERBOARD_SORT_DIRECTION_UNSPECIFIED DashboardState_LeaderboardSortDirection = 0
	DashboardState_LEADERBOARD_SORT_DIRECTION_ASCENDING   DashboardState_LeaderboardSortDirection = 1
	DashboardState_LEADERBOARD_SORT_DIRECTION_DESCENDING  DashboardState_LeaderboardSortDirection = 2
)

func (DashboardState_LeaderboardSortDirection) Descriptor

func (DashboardState_LeaderboardSortDirection) Enum

func (DashboardState_LeaderboardSortDirection) EnumDescriptor deprecated

func (DashboardState_LeaderboardSortDirection) EnumDescriptor() ([]byte, []int)

Deprecated: Use DashboardState_LeaderboardSortDirection.Descriptor instead.

func (DashboardState_LeaderboardSortDirection) Number

func (DashboardState_LeaderboardSortDirection) String

func (DashboardState_LeaderboardSortDirection) Type

type DashboardState_LeaderboardSortType

type DashboardState_LeaderboardSortType int32

* SortType is used to determine how to sort the leaderboard and dimension detail table, as well as where to place the sort arrow.

By default, the leaderboards+table will be sorted by VALUE, using the value of the currently selected dashboard measure.

If DELTA_ABSOLUTE or DELTA_PERCENT is selected, the leaderboards+table will be sorted by the absolute or percentage delta change of the currently selected dashboard measure.

If PERCENT is selected, the table will be sorted by the value of the currently selected dashboard measure, which will return the same ordering as the percent-of-total sort for measures with valid percent-of-total. However, the sort arrow will be placed next to the percent-of-total icon.

As of 2023-08, DIMENSION is not implemented, but at that time the plan was to only apply DIMENSTION sort to the dimension detail table, and not the leaderboards.

const (
	DashboardState_LEADERBOARD_SORT_TYPE_UNSPECIFIED    DashboardState_LeaderboardSortType = 0
	DashboardState_LEADERBOARD_SORT_TYPE_VALUE          DashboardState_LeaderboardSortType = 1
	DashboardState_LEADERBOARD_SORT_TYPE_DIMENSION      DashboardState_LeaderboardSortType = 2
	DashboardState_LEADERBOARD_SORT_TYPE_PERCENT        DashboardState_LeaderboardSortType = 3
	DashboardState_LEADERBOARD_SORT_TYPE_DELTA_PERCENT  DashboardState_LeaderboardSortType = 4
	DashboardState_LEADERBOARD_SORT_TYPE_DELTA_ABSOLUTE DashboardState_LeaderboardSortType = 5
)

func (DashboardState_LeaderboardSortType) Descriptor

func (DashboardState_LeaderboardSortType) Enum

func (DashboardState_LeaderboardSortType) EnumDescriptor deprecated

func (DashboardState_LeaderboardSortType) EnumDescriptor() ([]byte, []int)

Deprecated: Use DashboardState_LeaderboardSortType.Descriptor instead.

func (DashboardState_LeaderboardSortType) Number

func (DashboardState_LeaderboardSortType) String

func (DashboardState_LeaderboardSortType) Type

type DashboardState_PivotTableMode

type DashboardState_PivotTableMode int32
const (
	DashboardState_PIVOT_TABLE_MODE_UNSPECIFIED DashboardState_PivotTableMode = 0
	DashboardState_PIVOT_TABLE_MODE_FLAT        DashboardState_PivotTableMode = 1
	DashboardState_PIVOT_TABLE_MODE_NEST        DashboardState_PivotTableMode = 2
)

func (DashboardState_PivotTableMode) Descriptor

func (DashboardState_PivotTableMode) Enum

func (DashboardState_PivotTableMode) EnumDescriptor deprecated

func (DashboardState_PivotTableMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use DashboardState_PivotTableMode.Descriptor instead.

func (DashboardState_PivotTableMode) Number

func (DashboardState_PivotTableMode) String

func (DashboardState_PivotTableMode) Type

type DashboardTimeRange

type DashboardTimeRange struct {
	Name      *string                `protobuf:"bytes,1,opt,name=name,proto3,oneof" json:"name,omitempty"`
	TimeStart *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time_start,json=timeStart,proto3,oneof" json:"time_start,omitempty"`
	TimeEnd   *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=time_end,json=timeEnd,proto3,oneof" json:"time_end,omitempty"`
	// contains filtered or unexported fields
}

func (*DashboardTimeRange) Descriptor deprecated

func (*DashboardTimeRange) Descriptor() ([]byte, []int)

Deprecated: Use DashboardTimeRange.ProtoReflect.Descriptor instead.

func (*DashboardTimeRange) GetName

func (x *DashboardTimeRange) GetName() string

func (*DashboardTimeRange) GetTimeEnd

func (x *DashboardTimeRange) GetTimeEnd() *timestamppb.Timestamp

func (*DashboardTimeRange) GetTimeStart

func (x *DashboardTimeRange) GetTimeStart() *timestamppb.Timestamp

func (*DashboardTimeRange) ProtoMessage

func (*DashboardTimeRange) ProtoMessage()

func (*DashboardTimeRange) ProtoReflect

func (x *DashboardTimeRange) ProtoReflect() protoreflect.Message

func (*DashboardTimeRange) Reset

func (x *DashboardTimeRange) Reset()

func (*DashboardTimeRange) String

func (x *DashboardTimeRange) String() string

func (*DashboardTimeRange) Validate

func (m *DashboardTimeRange) Validate() error

Validate checks the field values on DashboardTimeRange with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*DashboardTimeRange) ValidateAll

func (m *DashboardTimeRange) ValidateAll() error

ValidateAll checks the field values on DashboardTimeRange with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in DashboardTimeRangeMultiError, or nil if none found.

type DashboardTimeRangeMultiError

type DashboardTimeRangeMultiError []error

DashboardTimeRangeMultiError is an error wrapping multiple validation errors returned by DashboardTimeRange.ValidateAll() if the designated constraints aren't met.

func (DashboardTimeRangeMultiError) AllErrors

func (m DashboardTimeRangeMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DashboardTimeRangeMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type DashboardTimeRangeValidationError

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

DashboardTimeRangeValidationError is the validation error returned by DashboardTimeRange.Validate if the designated constraints aren't met.

func (DashboardTimeRangeValidationError) Cause

Cause function returns cause value.

func (DashboardTimeRangeValidationError) Error

Error satisfies the builtin error interface

func (DashboardTimeRangeValidationError) ErrorName

ErrorName returns error name.

func (DashboardTimeRangeValidationError) Field

Field function returns field value.

func (DashboardTimeRangeValidationError) Key

Key function returns key value.

func (DashboardTimeRangeValidationError) Reason

Reason function returns reason value.

type PivotColumnSort

type PivotColumnSort struct {
	Desc bool   `protobuf:"varint,1,opt,name=desc,proto3" json:"desc,omitempty"`
	Id   string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*PivotColumnSort) Descriptor deprecated

func (*PivotColumnSort) Descriptor() ([]byte, []int)

Deprecated: Use PivotColumnSort.ProtoReflect.Descriptor instead.

func (*PivotColumnSort) GetDesc

func (x *PivotColumnSort) GetDesc() bool

func (*PivotColumnSort) GetId

func (x *PivotColumnSort) GetId() string

func (*PivotColumnSort) ProtoMessage

func (*PivotColumnSort) ProtoMessage()

func (*PivotColumnSort) ProtoReflect

func (x *PivotColumnSort) ProtoReflect() protoreflect.Message

func (*PivotColumnSort) Reset

func (x *PivotColumnSort) Reset()

func (*PivotColumnSort) String

func (x *PivotColumnSort) String() string

func (*PivotColumnSort) Validate

func (m *PivotColumnSort) Validate() error

Validate checks the field values on PivotColumnSort with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*PivotColumnSort) ValidateAll

func (m *PivotColumnSort) ValidateAll() error

ValidateAll checks the field values on PivotColumnSort with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PivotColumnSortMultiError, or nil if none found.

type PivotColumnSortMultiError

type PivotColumnSortMultiError []error

PivotColumnSortMultiError is an error wrapping multiple validation errors returned by PivotColumnSort.ValidateAll() if the designated constraints aren't met.

func (PivotColumnSortMultiError) AllErrors

func (m PivotColumnSortMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PivotColumnSortMultiError) Error

Error returns a concatenation of all the error messages it wraps.

type PivotColumnSortValidationError

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

PivotColumnSortValidationError is the validation error returned by PivotColumnSort.Validate if the designated constraints aren't met.

func (PivotColumnSortValidationError) Cause

Cause function returns cause value.

func (PivotColumnSortValidationError) Error

Error satisfies the builtin error interface

func (PivotColumnSortValidationError) ErrorName

func (e PivotColumnSortValidationError) ErrorName() string

ErrorName returns error name.

func (PivotColumnSortValidationError) Field

Field function returns field value.

func (PivotColumnSortValidationError) Key

Key function returns key value.

func (PivotColumnSortValidationError) Reason

Reason function returns reason value.

type PivotElement

type PivotElement struct {

	// Types that are assignable to Element:
	//
	//	*PivotElement_PivotTimeDimension
	//	*PivotElement_PivotDimension
	Element isPivotElement_Element `protobuf_oneof:"element"`
	// contains filtered or unexported fields
}

func (*PivotElement) Descriptor deprecated

func (*PivotElement) Descriptor() ([]byte, []int)

Deprecated: Use PivotElement.ProtoReflect.Descriptor instead.

func (*PivotElement) GetElement

func (m *PivotElement) GetElement() isPivotElement_Element

func (*PivotElement) GetPivotDimension

func (x *PivotElement) GetPivotDimension() string

func (*PivotElement) GetPivotTimeDimension

func (x *PivotElement) GetPivotTimeDimension() v1.TimeGrain

func (*PivotElement) ProtoMessage

func (*PivotElement) ProtoMessage()

func (*PivotElement) ProtoReflect

func (x *PivotElement) ProtoReflect() protoreflect.Message

func (*PivotElement) Reset

func (x *PivotElement) Reset()

func (*PivotElement) String

func (x *PivotElement) String() string

func (*PivotElement) Validate

func (m *PivotElement) Validate() error

Validate checks the field values on PivotElement with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*PivotElement) ValidateAll

func (m *PivotElement) ValidateAll() error

ValidateAll checks the field values on PivotElement with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PivotElementMultiError, or nil if none found.

type PivotElementMultiError

type PivotElementMultiError []error

PivotElementMultiError is an error wrapping multiple validation errors returned by PivotElement.ValidateAll() if the designated constraints aren't met.

func (PivotElementMultiError) AllErrors

func (m PivotElementMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PivotElementMultiError) Error

func (m PivotElementMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PivotElementValidationError

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

PivotElementValidationError is the validation error returned by PivotElement.Validate if the designated constraints aren't met.

func (PivotElementValidationError) Cause

Cause function returns cause value.

func (PivotElementValidationError) Error

Error satisfies the builtin error interface

func (PivotElementValidationError) ErrorName

func (e PivotElementValidationError) ErrorName() string

ErrorName returns error name.

func (PivotElementValidationError) Field

Field function returns field value.

func (PivotElementValidationError) Key

Key function returns key value.

func (PivotElementValidationError) Reason

Reason function returns reason value.

type PivotElement_PivotDimension

type PivotElement_PivotDimension struct {
	PivotDimension string `protobuf:"bytes,2,opt,name=pivot_dimension,json=pivotDimension,proto3,oneof"`
}

type PivotElement_PivotTimeDimension

type PivotElement_PivotTimeDimension struct {
	PivotTimeDimension v1.TimeGrain `protobuf:"varint,1,opt,name=pivot_time_dimension,json=pivotTimeDimension,proto3,enum=rill.runtime.v1.TimeGrain,oneof"`
}

Jump to

Keyboard shortcuts

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