Libraries.Interface.Controls.Charts.BarChartWriter Documentation
The BarChartWriter class is part of the set of writers that allow for Charts to save their representation in the form ScalableVectorGraphics. This class will write out all of the necessary text needed to write out an SVG file that will contain the chart.
Example Code
use Libraries.Compute.Statistics.DataFrame
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Interface.Controls.Charts.BarChartWriter
DataFrame frame
frame:Load("Data.csv")
frame:SetSelectedColumnRange(0,1)
BarChart chart = frame:BarChart()
chart:SetTitle("My Awesome Title")
chart:SetXAxisTitle("Time")
chart:Display()
BarChartWriter writer
output writer:WriteOutChart(char
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |
GetHashCode() | This action gets the hash code for an object. |
WriteOutChart(Libraries.Interface.Controls.Charts.BarChart chart) | This action writes out the BarChart by grabbing necessary information from the chart and it will then return all of the necessary text needed to write out an SVG file that will contain the chart. |
Actions Documentation
Compare(Libraries.Language.Object object)
This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smalle
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Example Code
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
GetHashCode()
This action gets the hash code for an object.
Example Code
Object o
integer hash = o:GetHashCode
Return
integer: The integer hash code of the object.
WriteOutChart(Libraries.Interface.Controls.Charts.BarChart chart)
This action writes out the BarChart by grabbing necessary information from the chart and it will then return all of the necessary text needed to write out an SVG file that will contain the chart.
Example Code
use Libraries.Compute.Statistics.DataFrame
use Libraries.Interface.Controls.Charts.BarChart
use Libraries.Interface.Controls.Charts.BarChartWriter
DataFrame frame
frame:Load("Data.csv")
frame:SetSelectedColumnRange(0,1)
BarChart chart = frame:BarChart()
chart:Display()
BarChartWriter writer
output writer:WriteOutChart(char
Parameters
- Libraries.Interface.Controls.Charts.BarChart: The chart that will be used to create an SVG
Return
text: