Example
new ac.ACLineChartBuilder()
.setData(myData)
.setTitle("Unit Sales and Production")
.build()
.addToDom('chart');
Summary
Constructors |
ac.ACLineChartBuilder()
|
Methods |
ac.ACLineChartBuilder
|
addLegendText(legendText [, legendTextPosition] ) |
ac.ACLineChartBuilder
|
addThemePartial(themePartial) |
ac.ACLineChartBuilder
|
addToSecondaryAxisByTitle(valueSetTitle) |
ac.ACLineChartBuilder
|
addValueSet(valueSet) |
ac.ACLineChartBuilder
|
addValueSetToPrimaryAxis(valueSet) |
ac.ACLineChartBuilder
|
addValueSetToSecondaryAxis(valueSet) |
ac.ACLineChart
|
build() |
ac.ACLineChartBuilder
|
clearLegendText() |
String
|
getAxisCaption(axisIdentity) |
Integer
|
getAxisDesiredTickmarks(axisIdentity) |
String
|
getAxisMarkerFormattingPattern(axisIdentity) |
Float
|
getAxisMaximum(axisIdentity) |
Float
|
getAxisMinimum(axisIdentity) |
Integer
|
getAxisNumberOfSubTicks(axisIdentity) |
ac.AxisPosition
|
getAxisPosition(axisIdentity) |
Float
|
getAxisSpacingEnd(axisIdentity) |
Float
|
getAxisSpacingStart(axisIdentity) |
String
|
getAxisTickmarkFormattingPattern(axisIdentity) |
ac.AxisType
|
getAxisType(axisIdentity) |
String
|
getColorScheme() |
String
|
getDefaultPopupText() |
String
|
getFooterText() |
ac.HorizontalAlignment
|
getFooterTextAlignment() |
ac.LegendPosition
|
getLegendPosition() |
String
|
getPalette() |
String
|
getTheme() |
String[]
|
getThemePartials() |
String
|
getTitle() |
String
|
getTitleImageUrl() |
ac.TitlePosition
|
getTitlePosition() |
ac.HorizontalAlignment
|
getTitleTextAlignment() |
Boolean
|
isAxisCheckForCollisions(axisIdentity) |
Boolean
|
isAxisDisplayFirstTick(axisIdentity) |
Boolean
|
isAxisDisplayLastTick(axisIdentity) |
Boolean
|
isDebugMode() |
Boolean
|
isDrawValuePoints() |
Boolean
|
isHighlightPlotArea() |
Boolean
|
isHighlightZeroLine() |
Boolean
|
isScrollingEnabled() |
Boolean
|
isShowLegend() |
Boolean
|
isShowMarker() |
Boolean
|
isShowPopup() |
Boolean
|
isZoomingEnabled() |
ac.ACLineChartBuilder
|
setAxisCaption(axisIdentity, labelText) |
ac.ACLineChartBuilder
|
setAxisCheckForCollisions(axisIdentity, checkForCollisions) |
ac.ACLineChartBuilder
|
setAxisDesiredTickmarks(axisIdentity, desiredTickmarks) |
ac.ACLineChartBuilder
|
setAxisDisplayFirstTick(axisIdentity, displayFirstTick) |
ac.ACLineChartBuilder
|
setAxisDisplayLastTick(axisIdentity, displayLastTick) |
ac.ACLineChartBuilder
|
setAxisMarkerFormattingPattern(axisIdentity, markerFormattingPattern) |
ac.ACLineChartBuilder
|
setAxisMaximumAsDate(axisIdentity, maximum) |
ac.ACLineChartBuilder
|
setAxisMaximumAsNumber(axisIdentity, maximum) |
ac.ACLineChartBuilder
|
setAxisMaximumAsString(axisIdentity, maximum,dateFormattingPattern) |
ac.ACLineChartBuilder
|
setAxisMinimumAsDate(axisIdentity, minimum) |
ac.ACLineChartBuilder
|
setAxisMinimumAsNumber(axisIdentity, minimum) |
ac.ACLineChartBuilder
|
setAxisMinimumAsString(axisIdentity, minimum,dateFormattingPattern) |
ac.ACLineChartBuilder
|
setAxisNumberOfSubTicks(axisIdentity, numSubTicks) |
ac.ACLineChartBuilder
|
setAxisPosition(axisIdentity, axisPosition) |
ac.ACLineChartBuilder
|
setAxisSpacingEnd(axisIdentity, spacingEnd) |
ac.ACLineChartBuilder
|
setAxisSpacingStart(axisIdentity, spacingStart) |
ac.ACLineChartBuilder
|
setAxisTickmarkFormattingPattern(axisIdentity, labelFormattingPattern) |
ac.ACLineChartBuilder
|
setAxisType(axisIdentity, axisType) |
ac.ACLineChartBuilder
|
setBackgroundImageUrl(value) |
ACLineChartBuilder
|
setBooleanVariable(variableName, value) |
ac.ACLineChartBuilder
|
setCSVDataOrder(dataOrder) |
ac.ACLineChartBuilder
|
setCSVDataSeriesConfig(rowTitle, dataModel [,pattern] ) |
ac.ACLineChartBuilder
|
setCSVSeparator(separator) |
ac.ACLineChartBuilder
|
setCSVTitleIndex(index) |
ac.ACLineChartBuilder
|
setCSVXValuesIndex(index) |
ac.ACLineChartBuilder
|
setColorScheme(colorScheme [, origin] ) |
|
setColorVariable(variableName, colorString) |
ac.ACLineChartBuilder
|
setData(data) |
ac.ACLineChartBuilder
|
setDataImportType(dataImportType) |
ac.ACLineChartBuilder
|
setDataUrl(dataUrl) |
ac.ACLineChartBuilder
|
setDebugMode(debugMode) |
ac.ACLineChartBuilder
|
setDecimalSeparator(decimalSeparator) |
ac.ACLineChartBuilder
|
setDefaultPopupText(defaultPopupText [, valueXFormattingPattern,valueYFormattingPattern] ) |
ac.ACLineChartBuilder
|
setDrawValuePoints(drawValuePoints) |
ac.ACLineChartBuilder
|
setFooterText(footerText) |
ac.ACLineChartBuilder
|
setFooterTextAlignment(footerAlignment) |
ac.ACLineChartBuilder
|
setHeight(height) |
ac.ACLineChartBuilder
|
setHighlightPlotArea(highlightPlotArea) |
ac.ACLineChartBuilder
|
setHighlightZeroLine(highlightZeroLine) |
ac.ACLineChartBuilder
|
setImageVariable(variableName, value) |
ac.ACLineChartBuilder
|
setJsonXId(xidentifier) |
ac.ACLineChartBuilder
|
setJsonYId(yidentifier) |
ac.ACLineChartBuilder
|
setLegendPosition(legendPosition) |
ACLineChartBuilder
|
setNumberVariable(variableName, value) |
ac.ACLineChartBuilder
|
setPalette(palette, colorScheme [,paletteOrigin, colorSchemeOrigin] ) |
ac.ACLineChartBuilder
|
setPopupText(valueSetIdentifier, popupText,valueXFormattingPattern, valueYFormattingPattern) |
ac.ACLineChartBuilder
|
setScrollingEnabled(scrollingEnabled) |
ac.ACLineChartBuilder
|
setShowLegend(showLegend) |
ac.ACLineChartBuilder
|
setShowMarker(showMarker) |
ac.ACLineChartBuilder
|
setShowPopup(showPopup) |
ac.ACLineChartBuilder
|
setSizeVariable(variableName, variableValue) |
ac.ACLineChartBuilder
|
setStringVariable(variableName, value) |
ac.ACLineChartBuilder
|
setStyleVariable(variableName, styleOptions) |
ac.ACLineChartBuilder
|
setTheme(theme [, origin] ) |
ac.ACLineChartBuilder
|
setTitle(title [, titlePosition,titleImageUrl] ) |
ac.ACLineChartBuilder
|
setTitleImageUrl(titleImageUrl) |
ac.ACLineChartBuilder
|
setTitlePosition(titlePosition) |
ac.ACLineChartBuilder
|
setTitleTextAlignment(titleAlignment) |
ac.ACLineChartBuilder
|
setWidth(width) |
ac.ACLineChartBuilder
|
setZoomingEnabled(zoomingEnabled) |
ac.ACLineChartBuilder
|
swapAxes() |
Constructor detail
ac.ACLineChartBuilder()
Constructs a new ACLineChartBuilder.
Example
new ac.ACLineChartBuilder()
Method detail
addLegendText(legendText [, legendTextPosition] )
Adds text to the legend specifying the position where it is to be printed.
You can use this method more than once to add text both to the top and the bottom.
Parameters
Returns
Example
.addLegendText("top text", ac.LegendTextPosition.TOP)
.addLegendText("bottom text", ac.LegendTextPosition.BOTTOM)
Here we use two calls to add text to the top and to the bottom of the legend.
addThemePartial(themePartial)
Insert additional code into the Theme which controls the display of the chart.
Parameters
String -- additional code which should be part of the theme
Returns
addToSecondaryAxisByTitle(valueSetTitle)
This method is used to add a ValueSet to a secondary (mostly Y) Axis.
Parameters
String -- title of the value set
Returns
Example
addToSecondaryAxisByTitle("Precipitation")
Adds the ValueSet "Precipitation" to the secondary axis.
addValueSet(valueSet)
addValueSetToPrimaryAxis(valueSet)
addValueSetToSecondaryAxis(valueSet)
build()
Returns
ac.ACLineChart -- constructed line chart which can be added to
the DOM.
Errors
An exception will be thrown when an error occurs during the build
process.
clearLegendText()
getAxisCaption(axisIdentity)
Returns the current label of the specified axis.
There are no default labels. You have to specify the axis label by yourself.
A "label" is a descriptive text which is displayed below (X-axis)
or at the side of the axis (Y-axis).
Parameters
Returns
String -- the current label
getAxisDesiredTickmarks(axisIdentity)
Parameters
ac.AxisIdentity -- this parameter identifies the axis for which the
desired tickmarks should be returned
Returns
Integer -- the amount of desired tickmarks
getAxisMarkerFormattingPattern(axisIdentity)
Parameters
ac.AxisIdentity -- this parameter identifies the axis for which the
marker formatting pattern should be returned
Returns
String -- the marker formatting pattern
getAxisMaximum(axisIdentity)
Retrieves the axis maximum for passed axis identity.
Parameters
Returns
Float -- the axis maximum
getAxisMinimum(axisIdentity)
Returns the current axis minimum (the bottom value of an axis) for a given axis identity.
Parameters
Returns
Float -- A floating point number which represents the axis minimum.
getAxisNumberOfSubTicks(axisIdentity)
Returns the number of sub tickmarks between two ticks.
Parameters
ac.AxisIdentity -- this parameter identifies the axis for which
you wish to retrieve the number of sub ticks
Returns
Integer -- the number of sub ticks
getAxisPosition(axisIdentity)
Returns the axis position of the specified axis.
Parameters
Returns
getAxisSpacingEnd(axisIdentity)
Gets the axis spacing for the end of the axis.
"Axis spacing" is the distance (in Tickmarks) between the last value point and
the end of the axis. A spacing of 1.0 means that the space of one
tickmark will be added to the end of the axis.
0.5 is half a tickmark etc.
Per default no spacing is used.
Deprecated!
Parameters
ac.AxisIdentity -- this parameter identifies the axis for which the
end spacing should be returned
Returns
Float -- end spacing
getAxisSpacingStart(axisIdentity)
Parameters
ac.AxisIdentity -- this parameter identifies the axis for which the
start spacing should be returned
Returns
Float -- axis spacing start
getAxisTickmarkFormattingPattern(axisIdentity)
Retrieves the axis label formatter pattern for passed axis identity.
Parameters
ac.AxisIdentity -- this parameter identifies the axis for which the
tickmark formatting pattern should be returned
Returns
String -- the formatting pattern
getAxisType(axisIdentity)
Retrieves the axis type for the axis specified.
Parameters
Returns
getColorScheme()
Returns
String -- color scheme url
getDefaultPopupText()
Returns
String -- the default popup text
getFooterText()
Retrieve the footer text
Returns
String -- the footer text
getFooterTextAlignment()
Returns the footer text alignment
Returns
getLegendPosition()
Retrieves the legend position.
Returns
getPalette()
getTheme()
getThemePartials()
getTitle()
Retrieves the title
Returns
String -- title
getTitleImageUrl()
Retrieves the URL of the title image
Returns
String -- url to the title image
getTitlePosition()
Retrieves the current title position.
Returns
getTitleTextAlignment()
Returns the title text alignment.
Returns
isAxisCheckForCollisions(axisIdentity)
Indicates if the "collision check" is enabled or disabled for the given axis identity.
A "collision check" automatically turns off the display of value point symbols on a line chart
if too many value points are present and the symbols start to overlap.
This feature is enabled by default.
Parameters
Returns
Boolean -- true when activated
isAxisDisplayFirstTick(axisIdentity)
Checks whenever the first tick is displayed for the specified axis.
Default is "true".
Parameters
Returns
Boolean -- true when the first tick is displayed
isAxisDisplayLastTick(axisIdentity)
Indicates if the last tickmark (=value label) on the given axis will be displayed.
Parameters
Returns
Boolean -- true when the last tick is displayed
isDebugMode()
Checks whether the chart is in debug mode or not.
Returns
Boolean -- whether it is in debug mode or not.
isDrawValuePoints()
Returns
Boolean -- true when value points are shown
isHighlightPlotArea()
Returns
Boolean -- true indicates that the plot area is highlighted.
isHighlightZeroLine()
Indicates if the zero gridline is highlighted.
Returns
Boolean -- true when the zero gridline is highlighted
isScrollingEnabled()
Returns whether the scrolling feature is enabled or disabled.
Returns
Boolean -- true when scrolling is enabled
isShowLegend()
Checks whether the legend is shown or not.
Returns
Boolean -- whether or not the legend is shown.
isShowMarker()
Returns
Boolean -- true when is the marker is turned on.
isShowPopup()
Indicates whether popups are active or not.
A popup is a little note that "pops up" when the mouse is
moved over a value point in the chart.
See
ac.ACLineChartBuilder.setShowPopup(showPopup) for information on how to activate popups.
Returns
Boolean -- true when popups are active, false otherwise
isZoomingEnabled()
Indicates whether the zooming feature is enabled or disabled.
Returns
Boolean -- true when zooming is enabled
setAxisCaption(axisIdentity, labelText)
Sets the label text for the specified axis.
A "label" is a descriptive text which is displayed below (X-axis)
or at the side of the axis (Y-axis).
If the text is larger than the available length it will be continued in the next line.
Parameters
ac.AxisIdentity -- used to identify the axis for which this is done
String -- the new axis label
Returns
setAxisCheckForCollisions(axisIdentity, checkForCollisions)
Activates or deactivates the collision check for the given axis. ( X_Axis, Y_Axis, Y2_Axis )
A "collision check" automatically turns off the display of value point symbols on a line chart
if too many value points are present and the symbols start to overlap.
This feature is turned on by default.
If set to "false" all ValuePoints will be drawn even if they overlap.
Parameters
ac.AxisIdentity -- used to identify the axis for which this is done
Boolean -- true to activate collision detection
Returns
setAxisDesiredTickmarks(axisIdentity, desiredTickmarks)
Determines a number of tickmarks to be displayed on the specified axis.
The axis-renderer tries to use a number of tickmarks _as_close_as_possible_ to
the number of tickmarks specified by the user.
Parameters
ac.AxisIdentity -- this parameter identifies the axis for which the
desired tickmarks should be set
Integer -- the amount of desired tickmarks
Returns
setAxisDisplayFirstTick(axisIdentity, displayFirstTick)
Turns the display of the first tickmark on an axis on or off.
Sometimes you don't want to start the axis labeling with the first value but the second.
This method suppresses the display of the first label on the given axis.
Parameters
ac.AxisIdentity -- used to identify the axis for which this is done
Boolean -- true to show the first tick
Returns
setAxisDisplayLastTick(axisIdentity, displayLastTick)
Turns the display of the last tickmark (=value label) on an axis on or off.
Sometimes you don't want to display the last tickmark (=value label) on an axis.
This method suppresses the display of the last label on the given axis.
Parameters
ac.AxisIdentity -- used to identify the axis for which this is done
Boolean -- true to show the last tick
Returns
Example
In this example the display of the last axis-tick is turned off.
setAxisDisplayLastTick( ac.AxisIdentity.X_AXIS, false )
setAxisMarkerFormattingPattern(axisIdentity, markerFormattingPattern)
Parameters
ac.AxisIdentity -- this parameter identifies the axis for which the
marker formatting pattern should be set
String -- the new formatting pattern
Returns
Example
setAxisTickmarkFormattingPattern( ac.AxisIdentity.Y2_AXIS, "#,##0.0#" )
Sets the formatting pattern of the second Y-axis to "#,##0.0#".
The syntax follows the Java-Classes "DecimalFormat" and "SimpleDateFormat". Please see the original
Java documentation for further details.
Number formatting reference:
http://download.oracle.com/javase/1.4.2/docs/api/java/text/DecimalFormat.html
Date formatting reference:
http://download.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html
setAxisMaximumAsDate(axisIdentity, maximum)
Sets the date axis maximum for the specified axis. You need to pass a Date object
as the second parameter, better use setAxisMaximumString which does this for you.
Parameters
ac.AxisIdentity -- this parameter identifies the axis
String -- axis maximum
Returns
setAxisMaximumAsNumber(axisIdentity, maximum)
Sets the numeric axis maximum for passed axis identity.
Parameters
ac.AxisIdentity -- this parameter identifies the axis
Float -- axis maximum
Returns
setAxisMaximumAsString(axisIdentity, maximum,dateFormattingPattern)
Sets the date axis maximum for the specified axis.
Parameters
ac.AxisIdentity -- this parameter identifies the axis
String -- axis maximum
String -- a date formatting pattern which will be used to convert the
second argument to a Date object
Returns
setAxisMinimumAsDate(axisIdentity, minimum)
Parameters
ac.AxisIdentity -- this parameter identifies the axis
String -- a string which acts as a Date object
Returns
setAxisMinimumAsNumber(axisIdentity, minimum)
Sets the value at which the axis starts for passed axis identity.
Parameters
ac.AxisIdentity this parameter identifies the axis
Float -- a floating point number which defines the new axis minimum
Returns
Example
.setAxisMinimumAsNumber(ac.AxisIdentity.Y_AXIS, 20)
.setAxisMaximumAsNumber(ac.AxisIdentity.Y_AXIS, 100)
Sets the range of values for the Y-Axis manually from 20 up to 100.
The Y-Axis will start at 20 and end at 100. If you have values that are outside of the
defined range an error will occur
setAxisMinimumAsString(axisIdentity, minimum,dateFormattingPattern)
Sets the date axis minimum for passed axis identity.
Parameters
ac.AxisIdentity -- this parameter identifies the axis
String -- the new axis minimum
String -- a date formatting pattern
Returns
setAxisNumberOfSubTicks(axisIdentity, numSubTicks)
Sets the number of sub tickmarks between two ticks.
Parameters
ac.AxisIdentity -- this parameter identifies the axis
Integer -- the number of sub ticks
Returns
setAxisPosition(axisIdentity, axisPosition)
Sets the axis position of the specified axis.
The X-Axis can be attached to the TOP or the BOTTOM,
the Y-Axis can be attached to the LEFT or the RIGHT.
If you would like to display the X-Axis on the left or right side
or if you would like to display the Y-Axis on the top or the bottom
you have to use the
ac.ACLineChartBuilder.swapAxes() method.
Parameters
Returns
Example
.setAxisPosition( ac.AxisIdentity.X_AXIS, ac.AxisPosition.TOP )
This command places the X-Axis on the top of the chart.
.setAxisPosition( ac.AxisIdentity.Y_AXIS, ac.AxisPosition.RIGHT )
Attaches the Y-Axis to the right side of the chart.
setAxisSpacingEnd(axisIdentity, spacingEnd)
Sets the axis spacing at the end of the axis.
"Axis spacing" is the distance (in Tickmarks) between the last value point and
the end of the axis. A spacing of 1.0 means that the space of one
tickmark will be added to the end of the axis.
0.5 is half a tickmark etc.
Per default no spacing is used.
Deprecated!
Parameters
ac.AxisIdentity -- this parameter identifies the axis for which the
end spacing should be set
Float -- the new value
Returns
setAxisSpacingStart(axisIdentity, spacingStart)
Sets the axis spacing at the beginning of the axis.
"Axis spacing" is the distance (in Tickmarks) between the beginning
of the axis and the first value point. A spacing of 1.0 means that the space of one
tickmark will be added to the beginning of the axis.
0.5 is half a tickmark etc.
Per default no spacing is used.
Deprecated!
Parameters
ac.AxisIdentity -- this parameter identifies the axis for which the
start spacing should be set
Float -- the new value
Returns
Example
setAxisSpacingStart(ac.AxisIdentity.X_AXIS, 1.0)
specifies the chart to be 640 pixels wide.
setAxisTickmarkFormattingPattern(axisIdentity, labelFormattingPattern)
Defines a display-format for the labels of the specified axis.
Parameters
ac.AxisIdentity -- this parameter identifies the axis for which the
tickmark formatting pattern should be set
String -- the new formatting pattern
Returns
Example
.setAxisTickmarkFormattingPattern( ac.AxisIdentity.Y2_AXIS, "#,##0.0#" )
Sets the formatting pattern of the second Y-axis to "#,##0.0#".
The syntax follows the Java-Classes "DecimalFormat" and "SimpleDateFormat". Please see the original
Java documentation for further details.
Number formatting reference:
http://download.oracle.com/javase/1.4.2/docs/api/java/text/DecimalFormat.html
Date formatting reference:
http://download.oracle.com/javase/1.4.2/docs/api/java/text/SimpleDateFormat.html
setAxisType(axisIdentity, axisType)
Sets the axis type of the specified axis.
The axis-type determines the general "behaviour" of an axis.
Per default the vertical axes (Y_AXIS, Y2_AXIS) are of type LINEAR
the horizontal axis (X_AXIS) is of type CATEGORY.
Parameters
Returns
setBackgroundImageUrl(value)
Sets the URL for a background image.
Parameters
String -- the URL to a background image
Returns
setBooleanVariable(variableName, value)
Sets a boolean variable. This is definitive and will overwrite
any settings in a theme or color scheme.
Parameters
String -- the variable name
Boolean -- boolean variable value.
Returns
ACLineChartBuilder -- the builder instance on which this method
was called. It's a fluent interface.
setCSVDataOrder(dataOrder)
Sets the data order. Data order identifies the data structure.
Parameters
Returns
setCSVDataSeriesConfig(rowTitle, dataModel [,pattern] )
This method configures the way the data will be parsed during CSV parsing.
Parameters
String -- the row title
ac.DataModel -- how the data is organized
String --
optional formatting pattern used for the data sets
Returns
setCSVSeparator(separator)
Sets the separator for the CSV data.
By default the semicolon ";" is used as separator for CSV values.
If you wish to use a different separator you can define it here.
Parameters
String -- the CSV separator
Returns
Example
.setCSVSeparator(",")
Defines the comma to be the separator for CSV values.
setCSVTitleIndex(index)
Sets the column index which should be used as title. The index numbering starts at 0.
Parameters
Integer -- column index which should be used as title
Returns
Example
.setCSVIndex( 0 )
Specify the first column to be used as title column. Default is 0.
setCSVXValuesIndex(index)
Sets the row index of data which should be shared between value sets.
Parameters
Integer -- the row index
Returns
setColorScheme(colorScheme [, origin] )
Defines a color scheme and explicitly tells ArcadiaCharts where to look for the
color scheme file by ignoring the built-in search order.
The design of a chart is determined by three xml-files:
- Theme
- ColorScheme
- ColorPalette
The Color-Scheme defines the colors that will be used in the chart.
ArcadiaCharts comes with a set of predefined colorSchemes that should serve most needs.
But you can also define your own color scheme in an xml file and use that instead.
Specifying which file to use is necessary if you wanted to use an external color-scheme-file
with a similar name as a built-in file.
Parameters
String -- colorScheme url or name
ac.Origin --
origin of the color scheme, i.e. built in or external
Returns
setColorVariable(variableName, colorString)
Sets a color theme variable. This is definitive and will overwrite
any settings in a theme or color scheme.
Refer to the handbook for a list of color theme variables.
Parameters
String -- color scheme variable name
String -- color string in RGB(A) or hex notation. R, G and B values may be any integer between 0 and 255, A is a floating point number between 0 and 1.
Example
setColorVariable( "BACKGROUND_SHADOW_COLOR", "rgba( 12, 34, 56, 1.0 )" )
Sets the color of the background shadow to a color value of (12, 34, 56) with 100% opacity.
setColorVariable( "BACKGROUND_SHADOW_COLOR", "#abcdef" )
Sets the color of the background shadow to a color value of #abcdef (hexadecimal), which equals rgb(171, 205, 239) with 100% opacity.
ac.ACLineChartBuilder -- the builder instance on which this method
was called. It's a fluent interface.
setData(data)
Attach data in CSV format to the chart.
The function expects the CSV data to be in one long string variable.
Parameters
String -- data in CSV format
Returns
Example
var myData = "Title;Jan;Feb;Mar;Apr;May;Jun\n"+
"Temperature;4;4;7;10;13;16\n"+
"Precipitation;79;56;70;46;59;59";
// ...
.setData( myData )
Fills a string with data in CSV format and attaches it to the chart.
setDataImportType(dataImportType)
Sets the type of content that should be bound to the chart.
Possible values are CSV, JSON, and XML (not yet implemented)
If no import-Type is set, the default value CSV will be assumed.
Please note that only ac.DataImportType.CSV is working currently.
Parameters
Returns
Example
setDataImportType( ac.DataImportType.CSV )
specifies the import type to be CSV
setDataUrl(dataUrl)
Specifies a file to load data in CSV-format from.
The location of the file can be specified either as URL or as path.
Please note that due to browser restrictions (same origin policy)
only data from the same url as the chart itself can be retrieved.
Parameters
* dataUrl (text)
Returns
Example
.setDataUrl("mydata/weather.csv")
.setDataUrl('http://127.0.0.1:8888/data.csv')
These two examples show how to specify the file location as path and as URL.
setDebugMode(debugMode)
Turns the debug mode on or off.
In debug-mode the chart will display additional information that might be useful when
designing the chart. It should be turned off in all other cases.
Parameters
Boolean -- true to activate the debug mode
Returns
Example
.setDebugMode(true)
Activates the debug mode.
setDecimalSeparator(decimalSeparator)
Sets decimal separator for floating point number.
Parameters
String -- the decimal separator
Returns
Example
For example in Germany decimal numbers are separated by "," (comma)
whereas the "." (period) is widely used in English speaking countries.
If you some data like
1.000,00 then the decimal separator
would be ",".
.setDecimalSeparator(",")
setDefaultPopupText(defaultPopupText [, valueXFormattingPattern,valueYFormattingPattern] )
Sets the default popup text for ALL value sets.
A popup will appear when the mouse is right over a value point.
Popups usually display the current value of X and Y and in some cases the Name of the
current ValueSet.
Popups are formatted using formatting patterns. The level of possible formatting depends
on the type of axis you have in your chart (linear, logarithmic, category, date).
If you want to use different popup texts for each value set you can use
ac.ACLineChartBuilder.setPopupText(valueSetIdentifier, popupText,valueXFormattingPattern, valueYFormattingPattern).
Parameters
String -- the popup text for popups
String -- optional A formatting pattern for the X-axis value.
String -- optional A formatting pattern for the Y-axis value.
Returns
Example
.setDefaultPopupText("Category: $ValueSetTitle Price: $valueY Year: $valueX", "yyyy", "USD #0.0#")
Defines the popup to display a text like "Category: Revenues Q1 Price: USD 1.2 Year: 1959".
$ValueSetTitle is a placeholder for the current ValueSet Title.
$valueX and $valueY are placeholder for the current values of X and Y.
Please note that the order of the variables $valueX and $valueY does not change the order that
the formatting patterns are used. The second parameter always applies a formatting pattern to $valueX
and the third parameter always applies a formatting pattern to $valueY.
"yyyy" defines the year to be displayed as "1959".
"USD #0.0#" sets the format of the Y-Value to have at least one decimal after the decimal point.
setDrawValuePoints(drawValuePoints)
Turns ValuePoint display on and off. A ValuePoint is a little symbol
(circle, square, etc.) will be drawn for each value point on a value line.
Parameters
Boolean -- true to draw value points
Returns
setFooterText(footerText)
Parameters
String -- a footer text
Returns
setFooterTextAlignment(footerAlignment)
setHeight(height)
Sets the height of the chart in pixels
Parameters
Integer -- height of the chart in pixel
Returns
Example
.setHeight(400)
This will set the height of the chart to 400 pixels
setHighlightPlotArea(highlightPlotArea)
Highlight the plot area or deactivate it.
Parameters
Boolean -- pass true to activate highlighting, false to deactivate it.
Returns
setHighlightZeroLine(highlightZeroLine)
If a chart displays negative and positive values the zero-line can be highlighted
to increase visibility.
This function works like an on/off switch for the zero-line highlighting.
Parameters
Boolean -- true to highlight the zero line
Returns
setImageVariable(variableName, value)
Sets an image variable. This is definitive and will overwrite
any settings in a theme or color scheme.
Parameters
String -- the variable name
String -- textual variable value.
Returns
setJsonXId(xidentifier)
This function is used to attach Data in JSON-Objects to the X axis.
JSON is a universal, language-independent format for data. In this way,
it's similar to XML. Whereas XML uses tags, JSON is a subset of YAML
and actually looks like JavaScript's object-literal notation.
Have a look at this example, containing the current stock price and
price change for the stock-symbols "ABC" "DEF" and "GHI".
[
{
"symbol": "ABC",
"price": 87.86,
"change": -0.41
},
{
"symbol": "DEF",
"price": 62.79,
"change": 0.49
},
{
"symbol": "GHI",
"price": 67.64,
"change": 0.05
}
]
In order to process this data ArcadiaCharts needs to know which value to
put on the X and Y axis.
Parameters
String -- key / property of each object
Returns
Example
.setJsonXId( "symbol" )
.setJsonYId( "price" )
.setJsonYId( "change" )
setJsonYId(yidentifier)
This function is used to attach Data in JSON-Objects to the X axis.
JSON is a universal, language-independent format for data. In this way,
it's similar to XML. Whereas XML uses tags, JSON is a subset of YAML
and actually looks like JavaScript's object-literal notation.
Have a look at this example, containing the current stock price and
price change for the stock-symbols "ABC" "DEF" and "GHI".
[
{
"symbol": "ABC",
"price": 87.86,
"change": -0.41
},
{
"symbol": "DEF",
"price": 62.79,
"change": 0.49
},
{
"symbol": "GHI",
"price": 67.64,
"change": 0.05
}
]
In order to process this data ArcadiaCharts needs to know which value to
put on the X and Y axis.
Parameters
String -- key / property of each object
Returns
Example
.setJsonXId( "symbol" )
.setJsonYId( "price" )
.setJsonYId( "change" )
setLegendPosition(legendPosition)
Parameters
Returns
Example
.setLegendPosition( ac.LegendPosition.LEFT )
displays the legend at the left side of the chart.
setNumberVariable(variableName, value)
Sets a number variable. This is definitive and will overwrite
any settings in a theme or color scheme.
Parameters
String -- the variable name
Number -- numeric variable value.
Returns
ACLineChartBuilder -- the builder instance on which this method
was called. It's a fluent interface.
setPalette(palette, colorScheme [,paletteOrigin, colorSchemeOrigin] )
Sets the color-palette with origin. An origin describes if a builtin palette should be used or an external palette.
This is useful if you want to use an external palette-file with a similar name as a builtin file.
The color scheme as a second parameter is necessary, because it highly depends on the
palette and if colors are not defined by the palette that are used by the color scheme,
the chart will not look as intended.
ArcadiaCharts can use custom color palettes in XML-format. The format is self-explanatory.
Check out one of the color-palette files that come with ArcadiaCharts to find out more.
By default ArcadiaCharts first tries to find the palette-file in the list of builtin palettes.
If no builtin palette of this name is found, the document-root will be searched.
The consequence is that if you change "palette_css.xml" on your server the changes will not be
"seen" by ArcadiaCharts since "palette_css.xml" is a builtin palette. ArcadiaCharts finds "palette_css.xml"
in the list of the builtin palettes and uses this without looking any further.
You can either use your own palette name or you tell ArcadiaCharts that you explicitly want to use the palette
file from the server by setting the "palette-origin" parameter.
The same applies to the color scheme origin parameter.
Parameters
String -- palette
String -- Url to the color scheme
ac.Origin --
optional whether the palette is internal or external. This parameter is optional. See the description for the resource location strategy.
ac.Origin --
optional whether the color scheme is internal or external. This parameter is optional. See the description for the resource location strategy.
Returns
setPopupText(valueSetIdentifier, popupText,valueXFormattingPattern, valueYFormattingPattern)
Parameters
String -- an identifier which identifies the value for which you want to set the popup text
String -- popup text
String -- formatting pattern for the x-axis value
String -- formatting pattern for the y-axis value
Returns
Example
String data = "Demo;A;B;C\n"+
"Value Set 1;1;2;3\n";
new ac.ACLineChartBuilder()
.setData( data )
.setPopupText( "Value Set 1", "The value is $valueY for $valueX", "#0.0#", "#0" )
This will set the popup text for the value set "Value Set 1".
The variables $valueX and $valueY will be replaced by the actual values of X and Y.
The formatting patterns for X and Y values are #0.0# and #0, respectively.
Please note that the order of the variables $valueX and $valueY does not change the order that
the formatting patterns are used. The third parameter always applies a formatting pattern to $valueX
and the fourth parameter always applies a formatting pattern to $valueY.
setScrollingEnabled(scrollingEnabled)
Activates or deactivates the scrolling.
Parameters
Boolean -- pass true to activate scrolling
Returns
setShowLegend(showLegend)
Turn legend on or off.
A legend shows the names of the value-sets in the chart
aside the colors and symbols that are used for the presentation of the data.
Parameters
Boolean -- whether or the legend shall be shown
Returns
setShowMarker(showMarker)
Enables or disables the marker.
A marker is line that "follows" the mouse when the mouse is moved over the chart area.
It displays in a little note the value of the valuePoint right under the marker-line.
Parameters
Boolean -- true to turn the marker on.
Returns
setShowPopup(showPopup)
Turns the display of popups on or off for the whole chart.
A popup is a little note that "pops up" when the mouse is
moved over a value point in the chart.
In the standard-configuration a popup shows the exact value of
the value point under the mouse.
Popups are highly customizable using formatting patterns.
Parameters
Boolean -- true to activate popups. You can deactivate them by passing
false to this method.
Returns
setSizeVariable(variableName, variableValue)
Sets a size theme variable. This is definitive and will overwrite
any settings in a theme or color scheme.
Refer to the handbook for a list of size theme variables.
Parameters
String -- the variable name
String -- textual variable value. You can use the syntax "min: 0; default: 1; max: 2" here.
Returns
Example
setSizeVariable( "AXIS_SIZE", "min: 10; default: 0.2 * $chartWidth; max: 20" )
Sets the size of the axis to be between 10 and 20 pixels with a default of 20% chart width.
setStringVariable(variableName, value)
Sets a string variable. This is definitive and will overwrite
any settings in a theme or color scheme.
Parameters
String -- the variable name
String -- textual variable value.
Returns
setStyleVariable(variableName, styleOptions)
Sets a style theme variable. This is definitive and will overwrite
any settings in a theme or color scheme. You can define any style you like
and use it in any RichTextElement.
Parameters
String -- variable name
Object -- styling options
Returns
Example
var myTitleStyle = ac.Util.createHashMap( [
[ "fontWeight", "bold" ]},
[ "fontSize", "22px" ]
} ] );
// ...
.setStyleVariable( "TitleElement", myTitleStyle );
Sets the Title to bold and its font size to 22px.
setTheme(theme [, origin] )
The layout of a chart is determined by the "theme" which is assigned to it.
ArcadiaCharts is shipped with many predefined themes in the form of xml-files.
The standard-Themes have been hardwired into the library for better performance.
The standard-themes are also included as xml files in order to enable you to make changes to them.
If you set a theme with "setTheme()" the library first checks if the theme-file is available as
built-in theme and, if yes, uses the internal theme.
This means that your changes to one of the standard-theme xml
files will not be seen unless
a) you specify a pathname with the file, for example setTheme("myThemes/theme_standard.xml") or
b) you determine which file to use by specifying the theme-origin ( BUILT_IN, EXTERNAL ).
Please note that the colors of a chart are not defined in the theme but in a colorScheme-XML-File
which works in a similar fashion. Please refer to the setColorScheme-Method for further details.
Parameters
String -- theme URL
ac.Origin --
optional whether it is an internal or external theme
Returns
Example
.setTheme("theme_standard_plain.xml", ac.Origin.EXTERNAL)
specifies the external "theme_standard_plain" to be used instead of the built-in version.
setTitle(title [, titlePosition,titleImageUrl] )
Sets the chart title and specifies title position and an image.
The function expects a URL to the image.
Most browsers will only let you load images from your current server (same origin policy).
The title can include the following tags:
- <strong>
- <em>
- <b>
- <i>
- <h1>, <h2>, <h3>
- <small>
- <pre>
- <br>
-
Parameters
String -- title which may include the above mentioned tags.
ac.TitlePosition --
optional positioning of the title
String --
optional URL of an image that should be part of the title.
Returns
Example
setTitle( " This is my Chart", ac.TitlePosition.TOP , "images/myimage.png")
Sets the string "This is my Chart" to be the title.
The word "my" will be formatted in italic typesetting.
The title will be displayed at the top of the chart.
The title includes the image "myimage.png" in the subdirectory "/images" on your server.
setTitleImageUrl(titleImageUrl)
Add an image to the chart title by specifying an URL.
Most browsers will only let you load images from your current
server (same origin policy);
Parameters
String -- title image url
Returns
setTitlePosition(titlePosition)
Sets the title position.
A chart title can be placed at the top or bottom of the chart.
For supported values see
ac.TitlePosition.
Parameters
Returns
setTitleTextAlignment(titleAlignment)
setWidth(width)
Sets the width of the chart in pixels
Parameters
Integer -- width of the chart in pixel
Returns
Example
.setWidth(400)
This will set the width of the chart to 400 pixels
setZoomingEnabled(zoomingEnabled)
Activates or deactivates the zooming feature.
Useful for ValueSets with a lot of values that need drill-down.
Parameters
Boolean -- true when zooming is enabled.
Returns
Example
.setZoomingEnabled( true )
Enables the zooming feature. Hold down the left mouse button
over the chart area and drag the mouse to select the zoom area.
swapAxes()