Help us shape the future of Go! Take the 2026 Go Developer Survey

report

package
v0.68.0 Latest Latest
Warning

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

Go to latest
Published: Oct 21, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const NAME = "Report"

Variables

This section is empty.

Functions

This section is empty.

Types

type Report

type Report struct {
	metadata.MetadataInfo
	XMLName    xml.Name `xml:"Report"`
	Xmlns      string   `xml:"xmlns,attr"`
	Aggregates []struct {
		AcrossGroupingContext *struct {
			Text string `xml:",chardata"`
		} `xml:"acrossGroupingContext"`
		CalculatedFormula *TextLiteral `xml:"calculatedFormula"`
		Datatype          struct {
			Text string `xml:",chardata"`
		} `xml:"datatype"`
		DeveloperName struct {
			Text string `xml:",chardata"`
		} `xml:"developerName"`
		DownGroupingContext *struct {
			Text string `xml:",chardata"`
		} `xml:"downGroupingContext"`
		IsActive struct {
			Text string `xml:",chardata"`
		} `xml:"isActive"`
		IsCrossBlock struct {
			Text string `xml:",chardata"`
		} `xml:"isCrossBlock"`
		MasterLabel struct {
			Text string `xml:",chardata"`
		} `xml:"masterLabel"`
		Scale struct {
			Text string `xml:",chardata"`
		} `xml:"scale"`
	} `xml:"aggregates"`
	Buckets []ReportBucket `xml:"buckets"`
	Chart   *struct {
		BackgroundColor1 struct {
			Text string `xml:",chardata"`
		} `xml:"backgroundColor1"`
		BackgroundColor2 struct {
			Text string `xml:",chardata"`
		} `xml:"backgroundColor2"`
		BackgroundFadeDir struct {
			Text string `xml:",chardata"`
		} `xml:"backgroundFadeDir"`
		ChartSummaries struct {
			Aggregate *struct {
				Text string `xml:",chardata"`
			} `xml:"aggregate"`
			AxisBinding struct {
				Text string `xml:",chardata"`
			} `xml:"axisBinding"`
			Column struct {
				Text string `xml:",chardata"`
			} `xml:"column"`
		} `xml:"chartSummaries"`
		ChartType struct {
			Text string `xml:",chardata"`
		} `xml:"chartType"`
		EnableHoverLabels struct {
			Text string `xml:",chardata"`
		} `xml:"enableHoverLabels"`
		ExpandOthers struct {
			Text string `xml:",chardata"`
		} `xml:"expandOthers"`
		GroupingColumn struct {
			Text string `xml:",chardata"`
		} `xml:"groupingColumn"`
		LegendPosition *struct {
			Text string `xml:",chardata"`
		} `xml:"legendPosition"`
		Location struct {
			Text string `xml:",chardata"`
		} `xml:"location"`
		SecondaryGroupingColumn *struct {
			Text string `xml:",chardata"`
		} `xml:"secondaryGroupingColumn"`
		ShowAxisLabels struct {
			Text string `xml:",chardata"`
		} `xml:"showAxisLabels"`
		ShowPercentage struct {
			Text string `xml:",chardata"`
		} `xml:"showPercentage"`
		ShowTotal struct {
			Text string `xml:",chardata"`
		} `xml:"showTotal"`
		ShowValues struct {
			Text string `xml:",chardata"`
		} `xml:"showValues"`
		Size struct {
			Text string `xml:",chardata"`
		} `xml:"size"`
		SummaryAxisRange struct {
			Text string `xml:",chardata"`
		} `xml:"summaryAxisRange"`
		TextColor struct {
			Text string `xml:",chardata"`
		} `xml:"textColor"`
		TextSize struct {
			Text string `xml:",chardata"`
		} `xml:"textSize"`
		Title *struct {
			Text string `xml:",chardata"`
		} `xml:"title"`
		TitleColor struct {
			Text string `xml:",chardata"`
		} `xml:"titleColor"`
		TitleSize struct {
			Text string `xml:",chardata"`
		} `xml:"titleSize"`
	} `xml:"chart"`
	ColorRanges []struct {
		ColumnName struct {
			Text string `xml:",chardata"`
		} `xml:"columnName"`
		HighBreakpoint *struct {
			Text string `xml:",chardata"`
		} `xml:"highBreakpoint"`
		HighColor struct {
			Text string `xml:",chardata"`
		} `xml:"highColor"`
		LowBreakpoint struct {
			Text string `xml:",chardata"`
		} `xml:"lowBreakpoint"`
		LowColor struct {
			Text string `xml:",chardata"`
		} `xml:"lowColor"`
		MidColor struct {
			Text string `xml:",chardata"`
		} `xml:"midColor"`
	} `xml:"colorRanges"`
	Columns      []ReportColumn `xml:"columns"`
	CrossFilters []struct {
		Operation struct {
			Text string `xml:",chardata"`
		} `xml:"operation"`
		PrimaryTableColumn struct {
			Text string `xml:",chardata"`
		} `xml:"primaryTableColumn"`
		RelatedTable struct {
			Text string `xml:",chardata"`
		} `xml:"relatedTable"`
		RelatedTableJoinColumn struct {
			Text string `xml:",chardata"`
		} `xml:"relatedTableJoinColumn"`
	} `xml:"crossFilters"`
	CustomDetailFormulas []struct {
		CalculatedFormula struct {
			Text string `xml:",chardata"`
		} `xml:"calculatedFormula"`
		DataType struct {
			Text string `xml:",chardata"`
		} `xml:"dataType"`
		Description *struct {
			Text string `xml:",chardata"`
		} `xml:"description"`
		DeveloperName struct {
			Text string `xml:",chardata"`
		} `xml:"developerName"`
		Label struct {
			Text string `xml:",chardata"`
		} `xml:"label"`
		Scale struct {
			Text string `xml:",chardata"`
		} `xml:"scale"`
	} `xml:"customDetailFormulas"`
	Description     *TextLiteral  `xml:"description"`
	Filter          *ReportFilter `xml:"filter"`
	Format          TextLiteral   `xml:"format"`
	FormattingRules []struct {
		ColumnName struct {
			Text string `xml:",chardata"`
		} `xml:"columnName"`
		Values []struct {
			BackgroundColor *struct {
				Text string `xml:",chardata"`
			} `xml:"backgroundColor"`
			RangeUpperBound *struct {
				Text string `xml:",chardata"`
			} `xml:"rangeUpperBound"`
		} `xml:"values"`
	} `xml:"formattingRules"`
	GroupingsAcross []ReportGroupingAcross `xml:"groupingsAcross"`
	GroupingsDown   []ReportGroupingDown   `xml:"groupingsDown"`
	Name            TextLiteral            `xml:"name"`
	Params          []struct {
		Name struct {
			Text string `xml:",chardata"`
		} `xml:"name"`
		Value struct {
			Text string `xml:",chardata"`
		} `xml:"value"`
	} `xml:"params"`
	ReportType          TextLiteral `xml:"reportType"`
	RoleHierarchyFilter []struct {
		Text string `xml:",chardata"`
	} `xml:"roleHierarchyFilter"`
	Scope *struct {
		Text string `xml:",chardata"`
	} `xml:"scope"`
	ShowDetails *struct {
		Text string `xml:",chardata"`
	} `xml:"showDetails"`
	ShowGrandTotal *struct {
		Text string `xml:",chardata"`
	} `xml:"showGrandTotal"`
	ShowSubTotals *struct {
		Text string `xml:",chardata"`
	} `xml:"showSubTotals"`
	SortColumn *struct {
		Text string `xml:",chardata"`
	} `xml:"sortColumn"`
	SortOrder *struct {
		Text string `xml:",chardata"`
	} `xml:"sortOrder"`
	TimeFrameFilter *struct {
		DateColumn struct {
			Text string `xml:",chardata"`
		} `xml:"dateColumn"`
		Interval struct {
			Text string `xml:",chardata"`
		} `xml:"interval"`
		StartDate *struct {
			Text string `xml:",chardata"`
		} `xml:"startDate"`
	} `xml:"timeFrameFilter"`
}

func Open

func Open(path string) (*Report, error)

func (*Report) DeleteField

func (r *Report) DeleteField(fieldName string) error

func (*Report) Files

func (c *Report) Files(format metadata.Format) (map[string][]byte, error)

func (*Report) SetMetadata

func (c *Report) SetMetadata(m metadata.MetadataInfo)

func (*Report) Type

func (c *Report) Type() metadata.MetadataType

type ReportBucket

type ReportBucket struct {
	BucketType       TextLiteral         `xml:"bucketType"`
	DeveloperName    TextLiteral         `xml:"developerName"`
	MasterLabel      TextLiteral         `xml:"masterLabel"`
	NullTreatment    TextLiteral         `xml:"nullTreatment"`
	OtherBucketLabel *TextLiteral        `xml:"otherBucketLabel"`
	SourceColumnName TextLiteral         `xml:"sourceColumnName"`
	UseOther         TextLiteral         `xml:"useOther"`
	Values           []ReportBucketValue `xml:"values"`
}

ReportBucket represents a bucket in a report

type ReportBucketValue

type ReportBucketValue struct {
	SourceValues []struct {
		SourceValue TextLiteral `xml:"sourceValue"`
	} `xml:"sourceValues"`
	Value TextLiteral `xml:"value"`
}

ReportBucketValue represents a bucket value

type ReportColumn

type ReportColumn struct {
	AggregateTypes *TextLiteral `xml:"aggregateTypes"`
	Field          TextLiteral  `xml:"field"`
}

ReportColumn represents a column in a report

type ReportFilter

type ReportFilter struct {
	BooleanFilter *TextLiteral               `xml:"booleanFilter"`
	CriteriaItems []ReportFilterCriteriaItem `xml:"criteriaItems"`
}

ReportFilter represents a filter in a report

type ReportFilterCriteriaItem

type ReportFilterCriteriaItem struct {
	Column         TextLiteral  `xml:"column"`
	ColumnToColumn *TextLiteral `xml:"columnToColumn"`
	IsUnlocked     *TextLiteral `xml:"isUnlocked"`
	Operator       TextLiteral  `xml:"operator"`
	Value          TextLiteral  `xml:"value"`
}

ReportFilterCriteriaItem represents a filter criteria item in a report

type ReportGroupingAcross

type ReportGroupingAcross struct {
	DateGranularity *TextLiteral `xml:"dateGranularity"`
	Field           TextLiteral  `xml:"field"`
	SortOrder       TextLiteral  `xml:"sortOrder"`
}

ReportGroupingAcross represents a grouping across in a report

type ReportGroupingDown

type ReportGroupingDown struct {
	AggregateType   *TextLiteral `xml:"aggregateType"`
	DateGranularity *TextLiteral `xml:"dateGranularity"`
	Field           TextLiteral  `xml:"field"`
	SortByName      *TextLiteral `xml:"sortByName"`
	SortOrder       TextLiteral  `xml:"sortOrder"`
	SortType        *TextLiteral `xml:"sortType"`
}

ReportGroupingDown represents a grouping down in a report

Jump to

Keyboard shortcuts

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