Class graphomate.ui.charts.Chart

extends sap.ui.core.Control

Constructor Details

new graphomate.ui.charts.Chart(id?:string, settings?:object)

Accepts an id and a settings object or one or none of them. The settings object defines initial property values as well as aggregated and associated objects. Every setting can also be set using the related setter method. The supported settings are:

Properties:

General

chartType : graphomate.ui.charts.enums.ChartType (default: "bar")
rotated : boolean (default: false)

Data

series1 : float[] (default: [])
series2 : float[] (default: [])
series3 : float[] (default: [])
series4 : float[] (default: [])
series5 : float[] (default: [])
series6 : float[] (default: [])
series7 : float[] (default: [])
series8 : float[] (default: [])
series9 : float[] (default: [])
series10 : float[] (default: [])
datatypes1 : string[] (default: [])
datatypes2 : string[] (default: [])
datatypes3 : string[] (default: []),
datatypes4 : string[] (default: [])
datatypes5 : string[] (default: [])
datatypes6 : string[] (default: [])
datatypes7 : string[] (default: [])
datatypes8 : string[] (default: [])
datatypes9 : string[] (default: [])
datatypes10 : string[] (default: [])
seriesLabels : string[] (default: ["Series1","Series2","Series3","Series4","Series5","Series6","Series7","Series8","Series9","Series10"])
categoryLabels : string[][] (default: [])
axisLabels : string[] (default: [])
visibleSeries : int[] (default: [])

Labels

showCategoryLabels : boolean (default: true)
fontSize : graphomate.ui.types.UnsignedInteger (default: 12)
fontFamily : string (default: "Arial")
fontColor : graphomate.ui.types.HexColor (default: "#000000")
labelPositioningMode : graphomate.ui.charts.enums.LabelPositioningMode (default: Auto)
collisionAdjustment : graphomate.ui.types.UnsignedInteger (default: 2)
basicNumberFormat : string (default: "0.0a")
basicNumberFormatPercent : string (default: "0.0%")
showSeriesLabelsLeft : boolean (default: false)
showSeriesLabelsRight : boolean (default: false)
labelFormatMode : graphomate.ui.enums.LabelFormatMode (default: Basic)
suppressZeroLabels : boolean (default: false)
suppressRepeatingCategoryLabels : boolean[] (default: [false,true,false,false])
showAxisLabelsLeft : boolean (default: false)
showAxisLabelsRight : boolean (default: false)
splitSignForCategoryLabels : string (default: "")
splitSignForAxisLabels : string (default: "")
locale : graphomate.ui.enums.Locale (default: EN)
categoryLabelRotation : graphomate.ui.types.RotationAngle (default: 0)

Axes

showCategoryAxis : boolean (default: true)
axisThickness : int, (default: 3)
fixedCategoryWidth : boolean (default: false)
categoryWidth : int (default: 50)
showValueAxis : boolean (default: false)
flipValueAxis : boolean (default: false)
valueAxisTickDistance : float (default: 50.0)
categoryCount : graphomate.ui.types.UnsignedInteger (default: 0)

Synchronization

comparisonGroup : string (default: null)

Deviations

negativeDeviationIsGood : boolean (default: false)
deviationGoodColor : graphomate.ui.types.HexColor (default: "#8CB400")
deviationBadColor : graphomate.ui.types.HexColor (default: "#FF0000")
spaceFactorDeviationChart : float (default: 0.25)
spaceFactorBaseChart : float (default: 0.5)
deviationPinLineBlack : boolean (default: false)

Highlight

highlightMode : graphomate.ui.charts.enums.HighlightMode (default: None)
showHighlightLabelPercentage : boolean (default: true)
showHighlightLabelAbsolute : boolean (default: true)

Scaling

scaleMode : graphomate.ui.enums.ScaleMode (default: Auto)
manualScaleMax : graphomate.ui.types.PositiveFloat (default: 150.0)
manualScaleMin : graphomate.ui.types.NegativeFloat (default: -150.0)
manualScalePercentMin : graphomate.ui.types.NegativeFloat (default: -20.0)
manualScalePercentMax : graphomate.ui.types.PositiveFloat (default: 20.0)

Outliers

outlierSize : graphomate.ui.types.UnsignedInteger (default: 7)
useOutlierThreshold : boolean (default: false)
positiveOutlierThreshold : graphomate.ui.types.PositiveFloat (default: 100.0)
negativeOutlierThreshold : graphomate.ui.types.NegativeFloat (default: -100.0)
outlierMode : graphomate.ui.enums.OutlierMode (default: Short)

Separators

separatorMode : graphomate.ui.charts.enums.SeparatorMode (default: None)
separatorSourceRowIndex : graphomate.ui.types.UnsignedInteger (default: 0)
separatorPositions : graphomate.ui.types.UnsignedInteger[] (default: [])
separatorLength : graphomate.ui.types.UnsignedInteger (default: 10)
separatorColor : graphomate.ui.types.HexColor (default: "#000000")
separatorThickness : graphomate.ui.types.UnsignedInteger (default: 1)
separatorsInFront : boolean (default: false)

Scaling Helper

scalingHelperMode : graphomate.ui.charts.enums.ScalingHelperMode (default: None)
scalingHelperValue : float (default: 100.0)
scalingHelperAreaColor: graphomate.ui.types.HexColor (default: "#FAEDB8")
scalingHelperLineColor : graphomate.ui.types.HexColor (default: "#333333")
scalingHelperLineWidth : graphomate.ui.types.UnsignedInteger (default: "#000000")

Offset Bar Chart

showOffsetsOnLeft : boolean (default: false)
offsetBarDeviationLabelsOnTop : boolean (default: false)

Stacked Bar Chart

stackedBarSumsVisible : boolean (default: true)
stackedBarNegativeValues : boolean (default: false)
stackedBarLabelPosition : graphomate.ui.charts.enums.StackedBarLabelPosition (default: Middle)

Waterfall Chart

calcPath : string[] (default: [])
waterfallPlusColor : graphomate.ui.types.HexColor (default: "#D8D8D8")
waterfallMinusColor : graphomate.ui.types.HexColor (default: "#6E6E6E")
waterfallSumColor : graphomate.ui.types.HexColor (default: "#2E2E2E")
waterfallSpanPlusColor : graphomate.ui.types.HexColor (default: "#2E2E2E")
waterfallSpanMinusColor : graphomate.ui.types.HexColor (default: "#2E2E2E")
waterfallNeutralColor : graphomate.ui.types.HexColor (default: "#2E2E2E")

Appearance

width : sap.ui.core.CSSSize (default: "350px")
height : sap.ui.core.CSSSize (default: "250px")
padding : int (default: 0)
spacing : int (default: 0)
drawBoundaries : boolean (default: false)
barWidth : graphomate.ui.types.PositiveFloat (default: 0.5)
pinWidth : graphomate.ui.types.PositiveFloat (default: 3.0)
elementsOffset : float (default: 0.3)
pinHeadRadiusX : graphomate.ui.types.PositiveFloat (default: 4.0)
pinHeadRadiusY : graphomate.ui.types.PositiveFloat (default: 4.0)
lineDotRadiusX : graphomate.ui.types.PositiveFloat (default: 0.1)
lineDotRadiusY : graphomate.ui.types.PositiveFloat (default: 0.1)

Aggregations:

deviations : graphomate.ui.charts.Deviation[] (default: [])
highlights : graphomate.ui.charts.Highlight[] (default: [])
seriesStyles : graphomate.ui.Datatype[] (default: 10 graphomate.ui.Datatype objects defining default styles)
extendedNumberFormat : graphomate.ui.ExtendedNumberFormat (default: null)
extendedNumberFormatPercent : graphomate.ui.ExtendedNumberFormat (default: null)

Events:

elementClick : fnListenerFunction(oEvent)

Property Details

Each property "sampleProperty" can be set using the related setter "setSampleProperty". Each setter expects a valid value for the related property as input parameter and throws an exception for invalid values. It returns the "this context" for method chaining. Each property "sampleProperty" can also be gotten using the related getter method "getSampleProperty". It expects no input parameters and returns the current value of the related property. Each property that represents or partially contains indices excepts a 0 based index. Even to specify a data series that is named with "series1" for example the index 0 is expected.

setSampleProperty(value) - Sets the property to the passed value if valid and returns this for method chaining.
getSampleProperty() - Returns the current value of the property.

The Following Properties are available:

Property Name	Type	Description
chartType	graphomate.ui.charts.enums.ChartType	Sets the Chart Type of the chart.
rotated	boolean	Sets the orientation of the chart. With the value false the chart will be horizontally oriented (default orientation for temporal data) while the value true will make the chart vertically oriented (rotated orientation for structural data).
series1	float[]	Sets the data for the first data series as an array of floating point numbers.
series2	float[]	Sets the data for the second data series as an array of floating point numbers.
series3	float[]	Sets the data for the third data series as an array of floating point numbers.
series4	float[]	Sets the data for the fourth data series as an array of floating point numbers.
series5	float[]	Sets the data for the fifth data series as an array of floating point numbers.
series6	float[]	Sets the data for the sixth data series as an array of floating point numbers.
series7	float[]	Sets the data for the seventh data series as an array of floating point numbers.
series8	float[]	Sets the data for the eighth data series as an array of floating point numbers.
series9	float[]	Sets the data for the ninth data series as an array of floating point numbers.
series10	float[]	Sets the data for the tenth data series as an array of floating point numbers.
datatypes1	string[]	Array of strings with the same length as the first data series. Each string represents the name of the datatype matched to the related value of data series one. A datatype describes the appearance of a value in the chart and has to be defined using the global DatatypeDictionary.
datatypes2	string[]	Array of strings with the same length as the second data series. Each string represents the name of the datatype matched to the related value of data series one.
datatypes3	string[]	Array of strings with the same length as the third data series. Each string represents the name of the datatype matched to the related value of data series two.
datatypes4	string[]	Array of strings with the same length as the fourth data series. Each string represents the name of the datatype matched to the related value of data series three.
datatypes5	string[]	Array of strings with the same length as the fifth data series. Each string represents the name of the datatype matched to the related value of data series four.
datatypes6	string[]	Array of strings with the same length as the sixth data series. Each string represents the name of the datatype matched to the related value of data series five.
datatypes7	string[]	Array of strings with the same length as the seventh data series. Each string represents the name of the datatype matched to the related value of data series six.
datatypes8	string[]	Array of strings with the same length as the eighth data series. Each string represents the name of the datatype matched to the related value of data series seven.
datatypes9	string[]	Array of strings with the same length as the ninth data series. Each string represents the name of the datatype matched to the related value of data series eight.
datatypes10	string[]	Array of strings with the same length as the tenth data series. Each string represents the name of the datatype matched to the related value of data series nine.
seriesLabels	string[]	Array of strings, where the index refers to a data series (first string relates to data series 1, second to series 2...) and the string describes the related series. Use empty string to skip a series that should not be labeled with a description. The visibility of series labels can be adjusted using the properties "showSeriesLabelsLeft" and "showSeriesLabelsRight".
categoryLabels	string[][]	Two dimensional array of strings, where the sub arrays are different levels of category labels to realize a hierarchy. The length of the sub arrays corresponds to the number of values per data series and the length of the main array defines the number of hierarchy levels. So a value of [["A","B","A","B"],["2009","2009","2010","2010"]] defines a hierarchy with two levels, where the first level labels the data series' values wth "A" or "B" and the second level labels them with a year.
axisLabels	string[]	Array of strings, where the first string will be displayed at the left and the second one at the right side of the axis (top / bottom of the axis in vertical orientation). The visibility of axis labels can be adjusted using the properties "showAxisLabelsLeft" and "showAxisLabelsRight"
visibleSeries	int[]	Array of indices refering to the data series. An empty array will result in all series being displayed. An array with the elements 0 and 2 will hide all series but the first and the third. Useful for hiding series which are only used to calculate deviations from.
showCategoryLabels	boolean	Sets the visibility of all category labels.
fontSize	int	Sets the font size in px.
fontFamily	string	Sets the font family by its name (e.g.: "Arial").
fontColor	graphomate.ui.types.HexColor	Sets the font color of the chart's text.
labelPositioningMode	graphomate.ui.charts.enums.LabelPositioningMode	Adjusts the behavior of the element labels.
collisionAdjustment	graphomate.ui.types.UnsignedInteger	Specifies the number of pixels two element labels are allowed to overlap until one of them gets hidden when property "labelPositioningMode" is set to automatic.
basicNumberFormat	string	Sets the number format string of absolute numbers according to numeral.js. For example a basic number format string of "0.00a" will format the number labels to have two decimal places and to be shortened using an abbreviation.
basicNumberFormatPercent	string	Sets the number format string of relative numbers according to numeral.js. For example a basic number format string of "0.00%" will format the number labels to have two decimal places and to end with the percent sign as a suffix.
showSeriesLabelsLeft	boolean	Sets the visibility of the series labels on the left side (top for a vertical oriented chart).
showSeriesLabelsRight	boolean	Sets the visibility of the series labels on the right side (bottom for a vertical oriented chart).
labelFormatMode	graphomate.ui.enums.LabelFormatMode	Sets whether the basic or the extended label format will be used for formatting the number labels.
suppressZeroLabels	boolean	Sets whether the element labels of 0 values should be hidden.
suppressRepeatingCategoryLabels	boolean[]	Defines in which level of the category label hierarchy repeating labels should be suppressed. Expects the following format [true,false,true] and alike, where the first boolean value relates to the first level of category labels.
showAxisLabelsLeft	boolean	Sets the visibility of the left axis label (top axis label in a vertical oriented chart).
showAxisLabelsRight	boolean	Sets the visibility of the right axis label (bottom axis label in a vertical oriented chart).
splitSignForCategoryLabels	string	Sets the string that will be replaced with a new line when found in any category label.
splitSignForAxisLabels	string	Sets the string that will be replaced with a new line when found in any axis label.
locale	graphomate.ui.enums.Locale	Sets the locale used for the formatting of number values when property "labelFormatMode" is set to basic.
categoryLabelRotation	graphomate.ui.types.RotationAngle	Rotates the category labels by an angle between 0 and 90 degree.
showCategoryAxis	boolean	Sets the visibility of the category axis.
axisThickness	int	Sets the thickness of the category axis in px.
fixedCategoryWidth	boolean	Sets whether the fixed category width set by property "categoryWidth" will be used. If set to false, the width will be calculated automatically to use the available space.
categoryWidth	int	Sets the manual category width in px. It will only be applied, if property "fixedCategoryWidth" is enabled.
showValueAxis	boolean	Sets the visibility of the value axis.
flipValueAxis	boolean	When set to true, the value axis will be displayed at the right side (at the bottom in a vertical oriented chart) instead of the default left position.
valueAxisTickDistance	float	Sets the interval size of the value axis. This is an approximate value. The actual value used by the rendering logic may differ.
categoryCount	graphomate.ui.types.UnsignedInteger	Sets the number of displayed categories. If a data series has more values than the specified number of categories, the remaining categories won't be displayed.
comparisonGroup	string	Sets a string for the global comparison group. All charts in the same Document Object Model Tree which have been assigned the same comparison group string will be scaled the same.
negativeDeviationIsGood	boolean	Switches the usage of the colors "deviationGoodColor" and "deviationBadColor".
deviationGoodColor	graphomate.ui.types.HexColor	Color used for displaying positive deviations.
deviationBadColor	graphomate.ui.types.HexColor	Color used for displaying negative deviations.
spaceFactorDeviationChart	float	Sets the space factor for each deviation chart. It affects the share of the available height a deviation chart will use to render (share of available width for vertical orientation). The formular for calculating the used space of a deviation chart is the following, where n is the number of deviation charts in the chart: spaceFactorDeviationChart / (nspaceFactorDeviationChart + spaceFactorBaseChart)*
spaceFactorBaseChart	float	Sets the space factor for the base chart. It affects the share of the available height the base chart will use to render (share of available width for vertical orientation). The formular for calculating the used space of the base chart is the following, where n is the number of deviation charts in the chart: spaceFactorDeviationChart / (nspaceFactorDeviationChart + spaceFactorBaseChart)*
deviationPinLineBlack	boolean	If set to true, the pin line of percentage deviation charts will be displayed black according to the IBCS standard.
highlightMode	graphomate.ui.charts.enums.HighlightMode	Sets the chart's highlight mode. Highlights are emphasized deviations between two values of special interest.
showHighlightLabelPercentage	boolean	Sets the visibility of percentage deviations in a highlight. If set to true, the highlight labels will include information about percentage deviation.
showHighlightLabelAbsolute	boolean	Sets the visibility of absolute deviations in a highlight. If set to true, the highlight labels will include information about absolute deviation.
scaleMode	graphomate.ui.enums.ScaleMode	Sets the scale mode. In case of manual scaling the values of the properties "manualScaleMax", "manualScaleMin", "manualScalePercentMin" and "manualScalePercentMax" will apply.
manualScaleMax	graphomate.ui.types.PositiveFloat	Sets the maximum value of the chart's absolute scale. Will be applied to absolute values when the property "scaleMode" causes a manual scaling.
manualScaleMin	graphomate.ui.types.NegativeFloat	Sets the minimum value of the chart's absolute scale. Will be applied to absolute values when the property "scaleMode" causes a manual scaling.
manualScalePercentMin	graphomate.ui.types.NegativeFloat	Sets the minimum value of the chart's percentage scale. Will be applied to percentage values when the property "scaleMode" causes a manual scaling.
manualScalePercentMax	graphomate.ui.types.PositiveFloat	Sets the maximum value of the chart's percentage scale. Will be applied to percentage values when the property "scaleMode" causes a manual scaling.
outlierSize	graphomate.ui.types.UnsignedInteger	Sets the outlier triangle's size in px. Outliers are chart elements representing values which exceed the chart's scale (e.g. because the chart's scale gets manipulated by the comparison group) or are forced to be displayed by specific thresholds.
useOutlierThreshold	boolean	Sets whether the properties "positiveOutlierThreshold" and "negativeOutlierThreshold" get applied. If set to true each value that exceeds the thresholds will be displayed as an outlier.
positiveOutlierThreshold	graphomate.ui.types.PositiveFloat	Positive floating point number. Each value that exceeds the threshold will be displayed as an outlier, if the property "useOutlierThreshold" is set to true.
negativeOutlierThreshold	graphomate.ui.types.NegativeFloat	Negative floating point number. Each value that exceeds the threshold will be displayed as an outlier, if the property "useOutlierThreshold" is set to true.
outlierMode	graphomate.ui.enums.OutlierMode	Sets the outliers' style.
separatorMode	graphomate.ui.charts.enums.SeparatorMode	Sets the mode that affects the position of separators. Separators are small vertical divider lines (horizontal divider lines in vertical chart orientation) which are displayed at the category axis to separate semantic groups of values.
separatorSourceRowIndex	graphomate.ui.types.UnsignedInteger	Specifies the datatype series that will be used to display separators, when property "separatorMode" is set to datatypes. If it's set to categories the sourceRowIndex describes the level of category labels used for the separator positioning.
separatorPositions	graphomate.ui.types.UnsignedInteger[]	Array of indices on the category axis. An index of 0 refers to the left side of the first category, 1 refers to left side of the second category (between first and second bar in a bar chart) and so on. The indices are used to display separators, when property "separatorMode" is set to manual.
separatorLength	graphomate.ui.types.UnsignedInteger	Sets the length of separator lines in px.
separatorColor	graphomate.ui.types.HexColor	Sets the color of the separator lines.
separatorThickness	graphomate.ui.types.UnsignedInteger	Sets the thicknes of separator lines in px.
separatorsInFront	boolean	If set to true, separators will have a higher z-index than the category axis.
scalingHelperMode	graphomate.ui.charts.enums.ScalingHelperMode	Specifies the appearance of the scaling helper. The scaling Helper displays a value range from zero to the value defined by property "scalingHelperValue". It may help to get a feeling for the scale of two differently scaled charts when displayed in both ones or could be used to mark a threshold.
scalingHelperValue	float	The value that will be displayed by the scaling helper.
scalingHelperAreaColor	graphomate.ui.types.HexColor	Sets the color of the scaling helper area (between the category axis and the scaling helper value) in scaling helper mode graphomate.ui.charts.enums.ScalingHelperMode.Area.
scalingHelperLineColor	graphomate.ui.types.HexColor	Sets the color of the scaling helper line, when the property "ScalingHelperMode" is set to line.
scalingHelperLineWidth	graphomate.ui.types.UnsignedInteger	Sets the width of the scaling helper line in px, when the property "ScalingHelperMode" is set to line.
showOffsetsOnLeft	boolean	If set to true, the offsets in a offset bar chart will be displayed at the left side of the bars (at the top in vertical oriented charts).
offsetBarDeviationLabelsOnTop	boolean	If set to true, labels of the offsets in a offset bar chart will be placed on top of the bars (at right side in vertical oriented charts).
stackedBarSumsVisible	boolean	Sets the visibility of calculated sums in a stackedbar chart.
stackedBarNegativeValues	boolean	Configures the interpretation of negative values in a stackedbar chart. If set to true, negative values will be displayed as a negative stack under the category axis. If set to false, they will be interpreted as positive values.
stackedBarLabelPosition	graphomate.ui.charts.enums.StackedBarLabelPosition	Sets the position of labels in a stackedbar chart.
calcPath	string[]	By defining the waterfall calculation path the appearance and the sign of each waterfall element can be controlled independently. The calcPath is an array of strings. Possible values are "+", "-", "0", "=", "s+" and "s-". Further information on the waterfall calculation path can be found in the documentation of our graphomate charts for other platforms.
waterfallPlusColor	graphomate.ui.types.HexColor	Sets the color of inflow values in a waterfall chart.
waterfallMinusColor	graphomate.ui.types.HexColor	Sets the color of outflow values in a waterfall chart.
waterfallSumColor	graphomate.ui.types.HexColor	Sets the color of sum values in a waterfall chart.
waterfallSpanPlusColor	graphomate.ui.types.HexColor	Sets the color of span inflow values in a waterfall chart.
waterfallSpanMinusColor	graphomate.ui.types.HexColor	Sets the color of span outflow values in a waterfall chart.
waterfallNeutralColor	graphomate.ui.types.HexColor	Sets the color of neutral values in a waterfall chart.
width	sap.ui.core.CSSSize	Sets the width of the chart. Allowed values are CSS sizes like "250px", "10em", "50%" or "auto".
height	sap.ui.core.CSSSize	Sets the height of the chart. Allowed values are CSS sizes like "250px", "10em", "50%" or "auto". Note that when a percentage value is given, the height of any of the surrounding containers must be defined. This is due to the characteristic of the html elements' height attribute which differs from the behavior of the width attribute for percentage values.
padding	int	Sets an inner padding for the chart in px.
spacing	int	Sets the spacing between the base chart and the deviation chart in px.
drawBoundaries	boolean	Debugging property to display internal layout borders of the chart.
barWidth	graphomate.ui.types.PositiveFloat	Sets the width of a chart's bars. If the value is greater than 1, it will be interpreted as px. Floating point numbers between 0 and 1 will be interpreted as relative values. The resulting width will then be a share of the category width.
pinWidth	graphomate.ui.types.PositiveFloat	Sets the width of pins in a pin chart. If the value is greater than 1, it will be interpreted as px. Floating point numbers between 0 and 1 will be interpreted as relative values. The resulting width will then be a share of the category width.
elementsOffset	float	Sets the offset of the data series' elements (e.g. bars) to the elements of other data series. If the value is greater than 1, it will be interpreted as px. Floating point numbers between 0 and 1 will be interpreted as percentage values relative to the category width.
pinHeadRadiusX	graphomate.ui.types.PositiveFloat	Sets the pixel based radius of all pin heads in x-direction.
pinHeadRadiusY	graphomate.ui.types.PositiveFloat	Sets the pixel based radius of all pin heads in y-direction.
lineDotRadiusX	graphomate.ui.types.PositiveFloat	Sets the pixel based radius of all dots of a line chart in x-direction.
lineDotRadiusY	graphomate.ui.types.PositiveFloat	Sets the pixel based radius of all dots of a line chart in y-direction.

Aggregation Details

We decided to use aggregation over association for all managed items of the graphomate chart because they can be bound to a model and associations can't. The disadvantage of using an aggregation is that a managed item can only be part of one aggregation. So the instance of an extendedNumberFormat for example can be part of an aggregation of chart 1 but can't be part of an aggregation of chart 2 while it is still part of chart 1.

Items of an aggregation named "sampleThings" that has a cardinality of 0...n (and a multiplicity of 1:n) can be accessed by using one of the following methods:

indexOfSampeThing(object) - Searches for the provided object in the aggregation and returns its 0-based index if found, or -1 otherwise.
getSampleThings() - Returns an array with the objects contained in the aggregation or an empty array.
addSampleThing(object) - Adds the provided object as last element in the aggregation. Returns this for method chaining.
insertSampleThing(object, index) - Inserts the provided object into the aggregation at position i. Returns this for method chaining.
removeSampleThing(object) - Removes the provided object from the aggregation. Returns the removed object.
removeAllSampleThings() - Removes all objects from the aggregation. Returns an array of all removed objects.
destroySampleThings() - Destroys all currently aggregated objects and clears the aggregation. Returns this for method chaining.

The Item of an aggregation named "sampleThing" that has a cardinality of 0...1 (and a multiplicity of 1:1) can be accessed by using one of the following methods:

getSampleThing() - Returns the current aggregated object or null.
setSampleThing(object) - Sets the provided object as the new aggregated object. Returns this for method chaining.
destroySampleThing() - Destroys the current aggregated object and clears the aggregation. Returns this for method chaining.

The following aggregations are available:

Aggregation Name	Aggregated Object Type	Cardinality	Description
deviations	graphomate.ui.charts.Deviation	0...n	The graphomate charts enables you to set additional axes above the base chart of all chart types (next to the base chart in vertical orientation), which display the percentage or absolute deviations between two data series. Of course you can set the data series which should be used to calculate the deviation values.
highlights	graphomate.ui.charts.Highlight	0...n	The highlight feature enables you to highlight the absolute or percentage difference between two elements (specific values of a defined data series). A highlight instance refers to the elements where the highlighting should start and end. Choose between a single highlighting on the side and the highlighting of multiple elements above the graph by using the property "highlightMode" of a chart. If you select single highlighting, the first element of this aggregation is displayed and all other elements are ignored.
seriesStyles	graphomate.ui.Datatype	0...n	This aggregation determines the appearance of data series, as long as you do not use datatypes as they have a higher priority than series styles. The handling is similar to the definition of datatypes for the DatatypeDictionary. The name property of an datatype in this aggregation will be ignored due to internal naming.
extendedNumberFormat	graphomate.ui.ExtendedNumberFormat	0...1	The item of this aggregation allows you to configure the formatting of absolute number labels.
extendedNumberFormatPercent	graphomate.ui.ExtendedNumberFormat	0...1	The item of this aggregation allows you to configure the formatting of percentage number labels.

Event Details

The following methods exist for each event "sampleEvent":

attachSampleEvent(function) - Registers a listener function for the event at the Chart.
detachSampleEvent(function) - Deregisters the passed listener function for the event from the Chart.

elementClick(oEvent)

This event is fired when the user clicks an element of the chart - for example a bar. By using oEvent.getParameter(parameterName) you can access the event's parameters. oEvent.getParameters() returns an object containing all available event parameters.

The following parameter names are available for this event:

{int} 'elementIdx' - The index of the clicked element within the series
{int} 'seriesIdx' - The index of the series the clicked element belongs to
{string} 'id' - The id of the chart which fired the event

Browser not supported