Documentation
¶
Index ¶
- Constants
- type Dashboard
- func (d *Dashboard) DeleteReport(report string) error
- func (c *Dashboard) Files(format metadata.Format) (map[string][]byte, error)
- func (d *Dashboard) GetReports() []string
- func (c *Dashboard) SetMetadata(m metadata.MetadataInfo)
- func (c *Dashboard) Type() metadata.MetadataType
- func (o *Dashboard) UpdateDashboardType(dashboardType string)
- func (o *Dashboard) UpdateRunningUser(user string)
- type DashboardComponent
- type DashboardSection
Constants ¶
View Source
const NAME = "Dashboard"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Dashboard ¶
type Dashboard struct {
metadata.MetadataInfo
XMLName xml.Name `xml:"Dashboard"`
Xmlns string `xml:"xmlns,attr"`
Xsi string `xml:"xmlns:xsi,attr,omitempty"`
BackgroundEndColor TextLiteral `xml:"backgroundEndColor"`
BackgroundFadeDirection TextLiteral `xml:"backgroundFadeDirection"`
BackgroundStartColor TextLiteral `xml:"backgroundStartColor"`
ChartTheme *TextLiteral `xml:"chartTheme"`
ColorPalette *TextLiteral `xml:"colorPalette"`
DashboardChartTheme *TextLiteral `xml:"dashboardChartTheme"`
DashboardColorPalette *TextLiteral `xml:"dashboardColorPalette"`
DashboardFilters []struct {
DashboardFilterOptions []struct {
Operator TextLiteral `xml:"operator"`
Values []TextLiteral `xml:"values"`
} `xml:"dashboardFilterOptions"`
Name TextLiteral `xml:"name"`
} `xml:"dashboardFilters"`
DashboardGridLayout *struct {
DashboardGridComponents []struct {
ColSpan TextLiteral `xml:"colSpan"`
ColumnIndex TextLiteral `xml:"columnIndex"`
DashboardComponent DashboardComponent `xml:"dashboardComponent"`
RowIndex TextLiteral `xml:"rowIndex"`
RowSpan TextLiteral `xml:"rowSpan"`
} `xml:"dashboardGridComponents"`
NumberOfColumns TextLiteral `xml:"numberOfColumns"`
RowHeight TextLiteral `xml:"rowHeight"`
} `xml:"dashboardGridLayout"`
DashboardType *TextLiteral `xml:"dashboardType"`
Description *TextLiteral `xml:"description"`
IsGridLayout *TextLiteral `xml:"isGridLayout"`
LeftSection *DashboardSection `xml:"leftSection"`
MiddleSection *DashboardSection `xml:"middleSection"`
Owner *TextLiteral `xml:"owner"`
RightSection *DashboardSection `xml:"rightSection"`
RunningUser *TextLiteral `xml:"runningUser"`
TextColor TextLiteral `xml:"textColor"`
Title TextLiteral `xml:"title"`
TitleColor TextLiteral `xml:"titleColor"`
TitleSize TextLiteral `xml:"titleSize"`
}
func (*Dashboard) DeleteReport ¶
func (*Dashboard) GetReports ¶
func (*Dashboard) SetMetadata ¶
func (c *Dashboard) SetMetadata(m metadata.MetadataInfo)
func (*Dashboard) Type ¶
func (c *Dashboard) Type() metadata.MetadataType
func (*Dashboard) UpdateDashboardType ¶
func (*Dashboard) UpdateRunningUser ¶
type DashboardComponent ¶ added in v0.69.0
type DashboardComponent struct {
AutoselectColumnsFromReport *TextLiteral `xml:"autoselectColumnsFromReport"`
ChartAxisRange *TextLiteral `xml:"chartAxisRange"`
ChartAxisRangeMax *TextLiteral `xml:"chartAxisRangeMax"`
ChartAxisRangeMin *TextLiteral `xml:"chartAxisRangeMin"`
ChartSummary []struct {
Aggregate *TextLiteral `xml:"aggregate"`
AxisBinding *TextLiteral `xml:"axisBinding"`
Column TextLiteral `xml:"column"`
} `xml:"chartSummary"`
ComponentChartTheme *TextLiteral `xml:"componentChartTheme"`
ComponentType TextLiteral `xml:"componentType"`
DashboardComponentContents *struct {
RichTextContent TextLiteral `xml:"richTextContent"`
} `xml:"dashboardComponentContents"`
DashboardFilterColumns []struct {
Column TextLiteral `xml:"column"`
} `xml:"dashboardFilterColumns"`
DashboardTableColumn []struct {
AggregateType *TextLiteral `xml:"aggregateType"`
CalculatePercent *TextLiteral `xml:"calculatePercent"`
Column TextLiteral `xml:"column"`
ShowSubTotal *TextLiteral `xml:"showSubTotal"`
ShowTotal *TextLiteral `xml:"showTotal"`
SortBy *TextLiteral `xml:"sortBy"`
} `xml:"dashboardTableColumn"`
DecimalPrecision *TextLiteral `xml:"decimalPrecision"`
DisplayUnits *TextLiteral `xml:"displayUnits"`
DrillDownUrl *TextLiteral `xml:"drillDownUrl"`
DrillEnabled *TextLiteral `xml:"drillEnabled"`
DrillToDetailEnabled *TextLiteral `xml:"drillToDetailEnabled"`
EnableHover *TextLiteral `xml:"enableHover"`
ExpandOthers *TextLiteral `xml:"expandOthers"`
FlexComponentProperties *struct {
DecimalPrecision *TextLiteral `xml:"decimalPrecision"`
FlexTableColumn []struct {
BreakPoint1 *TextLiteral `xml:"breakPoint1"`
BreakPoint2 *TextLiteral `xml:"breakPoint2"`
BreakPointOrder *TextLiteral `xml:"breakPointOrder"`
HighRangeColor *TextLiteral `xml:"highRangeColor"`
LowRangeColor *TextLiteral `xml:"lowRangeColor"`
MidRangeColor *TextLiteral `xml:"midRangeColor"`
ReportColumn NillableText `xml:"reportColumn"`
ShowSubTotal TextLiteral `xml:"showSubTotal"`
ShowTotal TextLiteral `xml:"showTotal"`
Type TextLiteral `xml:"type"`
} `xml:"flexTableColumn"`
FlexTableSortInfo *struct {
SortColumn *TextLiteral `xml:"sortColumn"`
SortOrder TextLiteral `xml:"sortOrder"`
} `xml:"flexTableSortInfo"`
HideChatterPhotos *TextLiteral `xml:"hideChatterPhotos"`
UseReportTableSetting *TextLiteral `xml:"useReportTableSetting"`
} `xml:"flexComponentProperties"`
GaugeMax *TextLiteral `xml:"gaugeMax"`
GaugeMin *TextLiteral `xml:"gaugeMin"`
GroupingColumn []NillableText `xml:"groupingColumn"`
GroupingSortProperties *struct {
GroupingSorts []struct {
GroupingLevel TextLiteral `xml:"groupingLevel"`
InheritedReportGroupingSort *TextLiteral `xml:"inheritedReportGroupingSort"`
SortColumn *TextLiteral `xml:"sortColumn"`
SortOrder *TextLiteral `xml:"sortOrder"`
} `xml:"groupingSorts"`
} `xml:"groupingSortProperties"`
Header *TextLiteral `xml:"header"`
IndicatorBreakpoint1 *TextLiteral `xml:"indicatorBreakpoint1"`
IndicatorBreakpoint2 *TextLiteral `xml:"indicatorBreakpoint2"`
IndicatorHighColor *TextLiteral `xml:"indicatorHighColor"`
IndicatorLowColor *TextLiteral `xml:"indicatorLowColor"`
IndicatorMiddleColor *TextLiteral `xml:"indicatorMiddleColor"`
LegendPosition *TextLiteral `xml:"legendPosition"`
MaxValuesDisplayed *TextLiteral `xml:"maxValuesDisplayed"`
MetricLabel *TextLiteral `xml:"metricLabel"`
Report *string `xml:"report"`
ShowPercentage *TextLiteral `xml:"showPercentage"`
ShowPicturesOnCharts *TextLiteral `xml:"showPicturesOnCharts"`
ShowPicturesOnTables *TextLiteral `xml:"showPicturesOnTables"`
ShowRange *TextLiteral `xml:"showRange"`
ShowTotal *TextLiteral `xml:"showTotal"`
ShowValues *TextLiteral `xml:"showValues"`
SortBy *TextLiteral `xml:"sortBy"`
SortLegendValues *TextLiteral `xml:"sortLegendValues"`
Title *TextLiteral `xml:"title"`
UseReportChart *TextLiteral `xml:"useReportChart"`
}
DashboardComponent is a component of a dashboard, in either a grid layout or a section
type DashboardSection ¶ added in v0.69.0
type DashboardSection struct {
ColumnSize TextLiteral `xml:"columnSize"`
Components []DashboardComponent `xml:"components"`
}
DashboardSection is a column of components in a dashboard that does not use a grid layout
Click to show internal directories.
Click to hide internal directories.