Libraries.Interface.Controls.Charts.ChartWriter Documentation
Inherits from: Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
AddChartArea(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart) | This action adds a white background to the canvas |
AddChartContent(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart) | This action adds the elements used within the chart area (bars, lines, datapoints, etc). |
AddLegend(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart) | This action adds the labels on the y axis |
AddOrderingList(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart) | Wrapper for SVG to help with scaling size |
AddRegressionLines(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart) | Region Wrapper |
AddXLabels(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart) | This action adds the labels on the x axis |
AddYLabels(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart) | This action adds the labels on the y axis |
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. |
GetBackground() | This action sets the background. |
GetChartArea() | This action sets the chart area. |
GetChartAreaHeight() | This action sets the height (percentage) of the chart area. |
GetChartAreaPositionX() | add the meta-data character set |
GetChartAreaPositionY() | Generate SVG elements for each piece of the chart |
GetChartAreaWidth() | This action sets the width (percentage) of the chart area. |
GetChartHeight() | This action sets the height (pixel) of the chart. |
GetChartInformation() | This action writes out the Chart 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. |
GetChartTitle() | This action sets the chart title. |
GetChartWidth() | This action sets the width (pixel) of the chart. |
GetGroupPanels() | This action sets the group panels. |
GetHashCode() | This action gets the hash code for an object. |
GetScriptFilepath() | This action gets the subchart area list. |
GetStyleFilepath() | This action writes out the Chart 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. |
GetSubChartAreas() | This action gets the subchart area list. |
GetXAxis() | This action sets the x axis line. |
GetXAxisLabel() | This action sets the x axis label. |
GetXLabels() | This action sets the y labels. |
GetYAxis() | This action sets the y axis line. |
GetYAxisLabel() | This action sets the y axis label. |
GetYLabels() | This action sets the y labels. |
HasAccessibility() | This action sets a flag to know if all of the accessibility information should be included. |
SetAccessibilityFlag(boolean hasAccessibility) | This action sets a flag to know if all of the accessibility information should be included. |
SetBackground(Libraries.Data.Formats.ScalableVectorGraphics.Rectangle background) | This action sets the background. |
SetChartArea(Libraries.Data.Formats.ScalableVectorGraphics.Rectangle chartArea) | This action sets the chart area. |
SetChartAreaHeight(number height) | This action sets the height (percentage) of the chart area. |
SetChartAreaPosition(number x, number y) | This action sets the position (percentage) of the chart area. |
SetChartAreaPositionX(number x) | This action sets the position (percentage) of the chart area. |
SetChartAreaPositionY(number y) | This action writes out the Chart 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. |
SetChartAreaWidth(number width) | This action sets the width (percentage) of the chart area. |
SetChartHeight(integer svgHeight) | This action sets the height (pixel) of the chart. |
SetChartInformation(Libraries.Data.Formats.ScalableVectorGraphics.Group chartInformation) | This action writes out the Chart 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. |
SetChartTitle(Libraries.Data.Formats.ScalableVectorGraphics.Label chartTitle) | This action sets the chart title. |
SetChartWidth(integer svgWidth) | This action sets the width (pixel) of the chart. |
SetScriptFilepath(text scriptFilepath) | This action sets the group panels. |
SetStyleFilepath(text styleFilepath) | chartCanvas:SetSize(svgWidth,svgHeight) |
SetXAxis(Libraries.Data.Formats.ScalableVectorGraphics.Rectangle xAxis) | This action sets the x axis line. |
SetXAxisLabel(Libraries.Data.Formats.ScalableVectorGraphics.Label xAxisLabel) | This action sets the x axis label. |
SetXLabels(Libraries.Containers.Array<Libraries.Data.Formats.ScalableVectorGraphics.Label> xLabels) | This action sets the y labels. |
SetYAxis(Libraries.Data.Formats.ScalableVectorGraphics.Rectangle yAxis) | This action sets the y axis line. |
SetYAxisLabel(Libraries.Data.Formats.ScalableVectorGraphics.Label yAxisLabel) | This action sets the y axis label. |
SetYLabels(Libraries.Containers.Array<Libraries.Data.Formats.ScalableVectorGraphics.Label> yLabels) | This action sets the y labels. |
TranslatePositionY(Libraries.Interface.Item2D item) | R^2 equation |
UniversalUniqueIdentifier() | Regression equation |
WriteOutChart(Libraries.Interface.Controls.Charts.Chart chart, Libraries.System.File file) | This action writes out the Chart 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. |
WriteOutChart(Libraries.Interface.Controls.Charts.Chart chart, integer svgWidth, integer svgHeight) | This action writes out the Chart 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. |
WriteOutChart(Libraries.Interface.Controls.Charts.Chart chart) | This action writes out the Chart 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. |
WriteOutChart(Libraries.Interface.Controls.Charts.Chart chart, Libraries.System.File file, integer svgWidth, integer svgHeight) | This action writes out the Chart 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. |
WriteOutHTML(Libraries.Interface.Controls.Charts.Chart chart, Libraries.System.File file) | Generate SVG elements for each piece of the chart |
Actions Documentation
AddChartArea(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)
This action adds a white background to the canvas
Parameters
- Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics
- Libraries.Interface.Controls.Charts.Chart
AddChartContent(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)
This action adds the elements used within the chart area (bars, lines, datapoints, etc).
Parameters
- Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics
- Libraries.Interface.Controls.Charts.Chart
AddLegend(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)
This action adds the labels on the y axis
Parameters
- Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics
- Libraries.Interface.Controls.Charts.Chart
AddOrderingList(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)
Wrapper for SVG to help with scaling size
Parameters
- Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics
- Libraries.Interface.Controls.Charts.Chart
AddRegressionLines(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)
Region Wrapper
Parameters
- Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics
- Libraries.Interface.Controls.Charts.Chart
AddXLabels(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)
This action adds the labels on the x axis
Parameters
- Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics
- Libraries.Interface.Controls.Charts.Chart
AddYLabels(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)
This action adds the labels on the y axis
Parameters
- Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics
- Libraries.Interface.Controls.Charts.Chart
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 (smaller)
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(t)
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
GetBackground()
This action sets the background.
Return
Libraries.Data.Formats.ScalableVectorGraphics.Rectangle:
GetChartArea()
This action sets the chart area.
Return
Libraries.Data.Formats.ScalableVectorGraphics.Rectangle:
GetChartAreaHeight()
This action sets the height (percentage) of the chart area.
Return
number:
GetChartAreaPositionX()
add the meta-data character set
Return
number:
GetChartAreaPositionY()
Generate SVG elements for each piece of the chart
Return
number:
GetChartAreaWidth()
This action sets the width (percentage) of the chart area.
Return
number:
GetChartHeight()
This action sets the height (pixel) of the chart.
Return
integer:
GetChartInformation()
This action writes out the Chart 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(chart, 1400, 1200)
Return
Libraries.Data.Formats.ScalableVectorGraphics.Group:
GetChartTitle()
This action sets the chart title.
Return
Libraries.Data.Formats.ScalableVectorGraphics.Label:
GetChartWidth()
This action sets the width (pixel) of the chart.
Return
integer:
GetGroupPanels()
This action sets the group panels.
Return
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.
GetScriptFilepath()
This action gets the subchart area list.
Return
text:
GetStyleFilepath()
This action writes out the Chart 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(chart)
Return
text:
GetSubChartAreas()
This action gets the subchart area list.
Return
GetXAxis()
This action sets the x axis line.
Return
Libraries.Data.Formats.ScalableVectorGraphics.Rectangle:
GetXAxisLabel()
This action sets the x axis label.
Return
Libraries.Data.Formats.ScalableVectorGraphics.Label:
GetXLabels()
This action sets the y labels.
Return
GetYAxis()
This action sets the y axis line.
Return
Libraries.Data.Formats.ScalableVectorGraphics.Rectangle:
GetYAxisLabel()
This action sets the y axis label.
Return
Libraries.Data.Formats.ScalableVectorGraphics.Label:
GetYLabels()
This action sets the y labels.
Return
HasAccessibility()
This action sets a flag to know if all of the accessibility information should be included. This may be used to reduce the size of the image in cases where it will be used as a flat image such as in a PDF.
Return
boolean:
SetAccessibilityFlag(boolean hasAccessibility)
This action sets a flag to know if all of the accessibility information should be included. This may be used to reduce the size of the image in cases where it will be used as a flat image such as in a PDF.
Parameters
SetBackground(Libraries.Data.Formats.ScalableVectorGraphics.Rectangle background)
This action sets the background.
Parameters
SetChartArea(Libraries.Data.Formats.ScalableVectorGraphics.Rectangle chartArea)
This action sets the chart area.
Parameters
SetChartAreaHeight(number height)
This action sets the height (percentage) of the chart area.
Parameters
SetChartAreaPosition(number x, number y)
This action sets the position (percentage) of the chart area.
Parameters
SetChartAreaPositionX(number x)
This action sets the position (percentage) of the chart area.
Parameters
SetChartAreaPositionY(number y)
This action writes out the Chart 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
File f
f:SetPath("aFile.svg")
chartWriter:WriteOutChart(chart, f)
Parameters
SetChartAreaWidth(number width)
This action sets the width (percentage) of the chart area.
Parameters
SetChartHeight(integer svgHeight)
This action sets the height (pixel) of the chart.
Parameters
SetChartInformation(Libraries.Data.Formats.ScalableVectorGraphics.Group chartInformation)
This action writes out the Chart 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
File f
f:SetPath("aFile.svg")
chartWriter:WriteOutChart(chart, f, 1400, 1200)
Parameters
SetChartTitle(Libraries.Data.Formats.ScalableVectorGraphics.Label chartTitle)
This action sets the chart title.
Parameters
SetChartWidth(integer svgWidth)
This action sets the width (pixel) of the chart.
Parameters
SetScriptFilepath(text scriptFilepath)
This action sets the group panels.
Parameters
SetStyleFilepath(text styleFilepath)
chartCanvas:SetSize(svgWidth,svgHeight)
Parameters
SetXAxis(Libraries.Data.Formats.ScalableVectorGraphics.Rectangle xAxis)
This action sets the x axis line.
Parameters
SetXAxisLabel(Libraries.Data.Formats.ScalableVectorGraphics.Label xAxisLabel)
This action sets the x axis label.
Parameters
SetXLabels(Libraries.Containers.Array<Libraries.Data.Formats.ScalableVectorGraphics.Label> xLabels)
This action sets the y labels.
Parameters
SetYAxis(Libraries.Data.Formats.ScalableVectorGraphics.Rectangle yAxis)
This action sets the y axis line.
Parameters
SetYAxisLabel(Libraries.Data.Formats.ScalableVectorGraphics.Label yAxisLabel)
This action sets the y axis label.
Parameters
SetYLabels(Libraries.Containers.Array<Libraries.Data.Formats.ScalableVectorGraphics.Label> yLabels)
This action sets the y labels.
Parameters
TranslatePositionY(Libraries.Interface.Item2D item)
R^2 equation
Parameters
Return
integer:
UniversalUniqueIdentifier()
Regression equation
Return
text:
WriteOutChart(Libraries.Interface.Controls.Charts.Chart chart, Libraries.System.File file)
This action writes out the Chart 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
File f
f:SetPath("aFile.svg")
chartWriter:WriteOutChart(chart, f)
Parameters
- Libraries.Interface.Controls.Charts.Chart: The chart that will be used to create an SVG
- Libraries.System.File: The file object that will be written to
WriteOutChart(Libraries.Interface.Controls.Charts.Chart chart, integer svgWidth, integer svgHeight)
This action writes out the Chart 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(chart, 1400, 1200)
Parameters
- Libraries.Interface.Controls.Charts.Chart: The chart that will be used to create an SVG
- integer svgWidth: The width in pixels of the SVG
- integer svgHeight: The height in pixels of the SVG
Return
text:
WriteOutChart(Libraries.Interface.Controls.Charts.Chart chart)
This action writes out the Chart 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(chart)
Parameters
- Libraries.Interface.Controls.Charts.Chart: The chart that will be used to create an SVG
Return
text:
WriteOutChart(Libraries.Interface.Controls.Charts.Chart chart, Libraries.System.File file, integer svgWidth, integer svgHeight)
This action writes out the Chart 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
File f
f:SetPath("aFile.svg")
chartWriter:WriteOutChart(chart, f, 1400, 1200)
Parameters
- Libraries.Interface.Controls.Charts.Chart: The chart that will be used to create an SVG
- Libraries.System.File: The file object that will be written to
- integer svgWidth: The width in pixels of the SVG
- integer svgHeight: The height in pixels of the SVG
WriteOutHTML(Libraries.Interface.Controls.Charts.Chart chart, Libraries.System.File file)
Generate SVG elements for each piece of the chart