Libraries.Interface.Controls.Charts.BoxPlotWriter Documentation

The BoxPlotChartWriter 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.BoxPlot

DataFrame frame
frame:Load("Data.csv")
frame:SetSelectedColumnRange(0,1)

BoxPlot chart = frame:BoxPlot()
chart:SetTitle("My Awesome Title")
chart:Display()
chart:Save("myBoxPlot.svg")

Inherits from: Libraries.Interface.Controls.Charts.ChartWriter, Libraries.Language.Object

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

AddLegend(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)

This action adds the labels on the y axis

Parameters

AddOrderingList(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)

These are the outlier dots

Parameters

AddPatternDefinitions(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)

This action adds the patterns to be used on chart elements

Parameters

AddRegressionLines(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)

Region Wrapper

Parameters

AddXLabels(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)

This action adds the labels on the x axis

Parameters

AddYLabels(Libraries.Data.Formats.ScalableVectorGraphics.ScalableVectorGraphics canvas, Libraries.Interface.Controls.Charts.Chart chart)

This action adds the labels on the y axis

Parameters

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.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

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.

Return

Libraries.Data.Formats.ScalableVectorGraphics.Group:

Example


    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)

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

Libraries.Containers.Array:

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

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.

Return

text:

Example


    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)

GetSubChartAreas()

This action gets the subchart area list.

Return

Libraries.Containers.Array:

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

Libraries.Containers.Array:

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

Libraries.Containers.Array:

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

  • boolean hasAccessibility

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

  • number height

SetChartAreaPosition(number x, number y)

This action sets the position (percentage) of the chart area.

Parameters

  • number x
  • number y

SetChartAreaPositionX(number x)

This action sets the position (percentage) of the chart area.

Parameters

  • number x

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.

Parameters

  • number y

Example


    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)

SetChartAreaWidth(number width)

This action sets the width (percentage) of the chart area.

Parameters

  • number width

SetChartHeight(integer svgHeight)

This action sets the height (pixel) of the chart.

Parameters

  • integer svgHeight

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.

Parameters

Example


    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)

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

  • integer svgWidth

SetScriptFilepath(text scriptFilepath)

This action sets the group panels.

Parameters

  • text scriptFilepath

SetStyleFilepath(text styleFilepath)

chartCanvas:SetSize(svgWidth,svgHeight)

Parameters

  • text styleFilepath

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.BoxPlot chart, Libraries.System.File file, integer svgWidth, integer svgHeight)

Parameters

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.

Parameters

Example


    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)

WriteOutChart(Libraries.Interface.Controls.Charts.BoxPlot chart, Libraries.System.File file)

Parameters

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.

Parameters

Return

text:

Example


    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)

WriteOutChart(Libraries.Interface.Controls.Charts.BoxPlot chart)

Parameters

Return

text

WriteOutChart(Libraries.Interface.Controls.Charts.BoxPlot chart, integer svgWidth, integer svgHeight)

Parameters

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.

Parameters

Return

text:

Example


    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)

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.

Parameters

Example


    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)

WriteOutHTML(Libraries.Interface.Controls.Charts.BoxPlot chart, Libraries.System.File file)

Parameters

WriteOutHTML(Libraries.Interface.Controls.Charts.Chart chart, Libraries.System.File file)

Generate SVG elements for each piece of the chart

Parameters