rickshaw
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
- Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
README¶
Rickshaw Example
This example creates a Rickshaw report using static, monthly data.
Documentation¶
Index¶
- func RickshawExtensionsReport(data TemplateData) string
- func StreamRickshawExtensionsReport(qw422016 *qt422016.Writer, data TemplateData)
- func WriteRickshawExtensionsReport(qq422016 qtio422016.Writer, data TemplateData)
- type DataInfoJs
- type Item
- type MonthData
- type RickshawData
- type RickshawDataFormatted
- type Series
- type TemplateData
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
funcRickshawExtensionsReport¶
func RickshawExtensionsReport(dataTemplateData)string
funcStreamRickshawExtensionsReport¶
func StreamRickshawExtensionsReport(qw422016 *qt422016.Writer, dataTemplateData)
funcWriteRickshawExtensionsReport¶
func WriteRickshawExtensionsReport(qq422016qtio422016.Writer, dataTemplateData)
Types¶
typeDataInfoJs¶
type DataInfoJs struct {Colorstring `json:"color,omitempty"`Data []Item `json:"data"`Namestring `json:"name"`}DataInfoJS is the series item to be sent to the Rickshaw extensions JS code.
typeMonthData¶
MonthData is the input value to be converted into Rickshaw items
func (*MonthData)RickshawItem¶
typeRickshawData¶
funcNewMonthlyRickshawDataFromSlotSeriesSet¶
func NewMonthlyRickshawDataFromSlotSeriesSet(setslot.SlotDataSeriesSet)RickshawData
funcNewRickshawData¶
func NewRickshawData()RickshawData
func (*RickshawData)AddItem¶
func (rd *RickshawData) AddItem(itemItem)
AddItem adds an item to the report
func (*RickshawData)Formatted¶
func (rd *RickshawData) Formatted() (RickshawDataFormatted,error)
Formatted returns formatted information ready for Rickshaw
func (*RickshawData)Inflate¶
func (rd *RickshawData) Inflate()
typeRickshawDataFormatted¶
type RickshawDataFormatted struct {SeriesNames []stringSeriesData [][]ItemFormattedData []DataInfoJs}funcNewRickshawDataFormattedFromDateHistogram¶
func NewRickshawDataFormattedFromDateHistogram(timesetinterval.TimeSeriesSet)RickshawDataFormatted
typeTemplateData¶
type TemplateData struct {HeaderHTMLstringReportNamestringReportLinkstringRickshawURLstringRickshawDataFormattedRickshawDataFormattedItemTypestringIncludeDataTableboolIncludeDataTableTotalsbool}func (*TemplateData)FormattedDataJSON¶
func (td *TemplateData) FormattedDataJSON() []byte
func (*TemplateData)TableData¶
func (td *TemplateData) TableData() ([]string, [][]string)
Source Files
Directories