Libraries.Compute.Statistics.Charts.ViolinChartCreator Documentation
This class is used to create a Violin Chart from columns(at most 3) of data in a DataFrame. It combines a box and whisker graph and a normal distribution graph. The max value on y-axis is based on the max value of all columns. X-axis is devided equally to holds at most 3 violin chart with labels of each column.
Example Code
use Libraries.Compute.Statistics.DataFrame
use Libraries.Compute.Statistics.Charts.ViolinChartCreator
//Create a ViolinChart and set some properties
DataFrame frame
frame:Load("Data/Data.csv")
ViolinChartCreator creator
creator:AddColumn(1)
SigmoidAction act
creator:SetWindowingAction(act)
ViolinChart chart = frame:CreateChart(creator)
chart:SetTitle("Violin Chart")
chart:SetYAxisTitle("Y-values")
chart:SetXAxisTitle("X-Values")
chart:SetBandWidth(1
Inherits from: Libraries.Compute.Statistics.DataFrameChartCreator, Libraries.Compute.Statistics.Inputs.ColumnInput, Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
AddColumn(integer column) | This action adds a value to the end of the input. |
Calculations(Libraries.Compute.Vector dataset) | This action calculates the median, lower quartile, upper quartile, largest and smallest values to form a box and whisker graph. |
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
Create(Libraries.Compute.Statistics.DataFrame frame) | |
EmptyColumns() | This action empty's the list, clearing out all of the items contained within i |
Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |
GetColumn(integer index) | This action gets the item at a given location in an array. |
GetColumnIterator() | This action gets an iterator for the object and returns that iterator. |
GetColumnSize() | This action gets the size of the array. |
GetHashCode() | This action gets the hash code for an object. |
GetMedian(integer upperIndex, integer lowerIndex, integer span, Libraries.Compute.Vector dataset) | Find outliers and exclude th |
GetWindowingAction() | Get median from the upper ha |
GetYTickCount() | This action returns how many scale ticks should be used along the Y axis of the LineChart. |
IsEmptyColumns() | This action returns a boolean value, true if the container is empty and false if it contains any items. |
RemoveColumn(integer column) | This action removes the first occurrence of an item that is found in the Addable object. |
RemoveColumnAt(integer index) | This action removes an item from an indexed object and returns that item. |
SetBandWidth(integer num) | interval numb |
SetWindowingAction(Libraries.Compute.Statistics.Analysis.UnivariateAction window) | Get median from the lower ha |
SetYTickCount(integer yTicks) | This action sets how many scale ticks should be used along the Y axis of the LineChart. |
Actions Documentation
AddColumn(integer column)
This action adds a value to the end of the input.
Parameters
Calculations(Libraries.Compute.Vector dataset)
This action calculates the median, lower quartile, upper quartile, largest and smallest values to form a box and whisker graph. It then returns an Array that stores all the informations listed abo
Parameters
Return
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.
Create(Libraries.Compute.Statistics.DataFrame frame)
Parameters
Return
Libraries.Interface.Controls.Charts.Chart
EmptyColumns()
This action empty's the list, clearing out all of the items contained within i
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.
GetColumn(integer index)
This action gets the item at a given location in an array.
Parameters
Return
integer: The item at the given locatio
GetColumnIterator()
This action gets an iterator for the object and returns that iterator.
Return
Libraries.Containers.Iterator: Returns the iterator for an objec
GetColumnSize()
This action gets the size of the array.
Return
integer:
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.
GetMedian(integer upperIndex, integer lowerIndex, integer span, Libraries.Compute.Vector dataset)
Find outliers and exclude th
Parameters
Return
GetWindowingAction()
Get median from the upper ha
Return
Libraries.Compute.Statistics.Analysis.UnivariateAction:
GetYTickCount()
This action returns how many scale ticks should be used along the Y axis of the LineChart. By default, this value is 5.
Return
integer: The number of ticks along the Y axis of the LineChar
IsEmptyColumns()
This action returns a boolean value, true if the container is empty and false if it contains any items.
Return
boolean: Returns true when the container is empty and false when it is no
RemoveColumn(integer column)
This action removes the first occurrence of an item that is found in the Addable object.
Parameters
Return
boolean: Returns true if the item was removed and false if it was not remove
RemoveColumnAt(integer index)
This action removes an item from an indexed object and returns that item.
Parameters
SetBandWidth(integer num)
interval numb
Parameters
SetWindowingAction(Libraries.Compute.Statistics.Analysis.UnivariateAction window)
Get median from the lower ha
Parameters
SetYTickCount(integer yTicks)
This action sets how many scale ticks should be used along the Y axis of the LineChart. By default, this value is 5.
Parameters
- integer yTicks: How many ticks should be used along the Y axis of the LineChar