- data
a dataframe
- data2
NULL or a dataframe used to update the data with the
button; its column names must include the column names of data
given in yValues, it must have the same number of rows as
data and its rows must be in the same order as those of data
- xValue
name of the column of data to be used on the x-axis
- yValues
a character matrix with two columns; each row corresponds to
a range area and provides the names of two columns of data to be
used as the limits of the range area
- areas
an unnamed list of list of settings for the range areas; the
n-th inner list of settings corresponds to the n-th row of the
yValues matrix; each list of settings has three possible fields:
name for the legend label, color for the color of the range
area, and opacity for the opacity of the range area, a number
between 0 and 1
- hline
an optional horizontal line to add to the chart; it must be a
named list of the form list(value = h, line = settings) where
h is the "intercept" and settings is a list of settings
created with amLine
- vline
an optional vertical line to add to the chart; it must be a
named list of the form list(value = v, line = settings) where
v is the "intercept" and settings is a list of settings
created with amLine
- xLimits
range of the x-axis, a vector of two values specifying
the left and right limits of the x-axis; NULL for default values
- yLimits
range of the y-axis, a vector of two values specifying
the lower and upper limits of the y-axis; NULL for default values
- expandX
if xLimits = NULL, a percentage of the range of the
x-axis used to expand this range
- expandY
if yLimits = NULL, a percentage of the range of the
y-axis used to expand this range
- Xformatter
a
number formatting string
if xValue is set to a numeric column of data;
it is used to format the values displayed in the cursor tooltips if
cursor = TRUE, the labels of the x-axis unless you specify
your own formatter in the labels field of the list passed on to
the xAxis option, and the values displayed in the tooltips unless
you specify your own tooltip text;
if xValue is set to a date column of data, this option should
be set to a
date formatting string,
and it has an effect only on the values displayed in the tooltips (unless
you specify your own tooltip text); formatting the dates on the x-axis is
done via the labels field of the list passed on to the xAxis
option
- Yformatter
a
number formatting string;
it is used to format the values displayed in the cursor tooltips if
cursor = TRUE, the labels of the y-axis unless you specify
your own formatter in the labels field of the list passed on to
the yAxis option, and the values displayed in the tooltips unless
you specify your own tooltip text (see the first example of
amBarChart for the way to set
a number formatter in the tooltip text)
- chartTitle
chart title, it can be NULL or FALSE for no
title, a character string,
a list of settings created with amText, or a list with two
fields: text, a list of settings created with amText,
and align, can be "left", "right" or "center"
- theme
theme, NULL or one of "dataviz",
"material", "kelly", "dark", "moonrisekingdom",
"frozen", "spiritedaway", "patterns",
"microchart"
- animated
Boolean, whether to animate the rendering of the graphic
- draggable
TRUE/FALSE to enable/disable dragging of
all lines, otherwise a named list of the form
list(yvalue1 = TRUE, yvalue2 = FALSE, ...) to enable/disable the
dragging for each series corresponding to a column given in yValues
- tooltip
settings of the tooltips; NULL for default,
FALSE for no tooltip, otherwise a named list of the form
list(yvalue1 = settings1, yvalue2 = settings2, ...) where
settings1, settings2, ... are lists created with
amTooltip; this can also be a
single list of settings that will be applied to each series,
or a just a string for the text to display in the tooltip
- bullets
settings of the bullets; NULL for default,
otherwise a named list of the form
list(yvalue1 = settings1, yvalue2 = settings2, ...) where
settings1, settings2, ... are lists created with
amCircle, amTriangle or
amRectangle; this can also be a
single list of settings that will be applied to each series
- alwaysShowBullets
logical, whether the bullets should always be
visible, or visible on hover only
- lineStyle
settings of the lines; NULL for default,
otherwise a named list of the form
list(yvalue1 = settings1, yvalue2 = settings2, ...) where
settings1, settings2, ... are lists created with
amLine; this can also be a
single list of settings that will be applied to each line
- backgroundColor
a color for the chart background
- xAxis
settings of the x-axis given as a list, or just a string
for the axis title; the list of settings has five possible fields:
a field title, a list of settings for the axis title created
with amText,
a field labels, a list of settings for the axis labels created
with amAxisLabels,
a field adjust, a number defining the vertical adjustment of
the axis (in pixels),
a field gridLines, a list of settings for the grid lines created
with amLine,
and a field breaks to control the axis breaks, an R object created
with amAxisBreaks
- yAxis
settings of the y-axis given as a list, or just a string
for the axis title; the list of settings has five possible fields:
a field title, a list of settings for the axis title created
with amText,
a field labels, a list of settings for the axis labels created
with amAxisLabels,
a field adjust, a number defining the horizontal adjustment of
the axis (in pixels),
a field gridLines, a list of settings for the grid lines created
with amLine,
and a field breaks to control the axis breaks, an R object created
with amAxisBreaks
- scrollbarX
logical, whether to add a scrollbar for the x-axis
- scrollbarY
logical, whether to add a scrollbar for the y-axis
- legend
FALSE for no legend, TRUE for a legend with
default settings, or a list of settings created with
amLegend
- caption
NULL or FALSE for no caption, a formatted
text created with amText, or a list with two fields:
text, a list created with amText, and align,
can be "left", "right" or "center"
- image
option to include an image at a corner of the chart;
NULL or FALSE for no image, otherwise a named list with four
possible fields: the field image (required) is a list created with
amImage,
the field position can be "topleft", "topright",
"bottomleft" or "bottomright", the field hjust
defines the horizontal adjustment, and the field vjust defines
the vertical adjustment
- button
NULL for the default, FALSE for no button,
or a list of settings created with amButton; this button is
used to replace the current data with data2
- cursor
option to add a cursor on the chart; FALSE for no
cursor, TRUE for a cursor for both axes with default settings
for the axes tooltips,
otherwise a named list with four possible fields: a field
axes to specify the axes for which the cursor is requested, can be
"x", "y", or "xy",
a field tooltip to set the style of the axes tooltips, this
must be a list of settings created with amTooltip,
a field extraTooltipPrecision, a named list of the form
list(x = i, y = j) where i and j are the desired
numbers of additional decimals for the tooltips on the x-axis and
on the y-axis respectively, and a field modifier, a list with two
possible fields, x and y, which defines modifiers for the
values displayed in the tooltips; a modifier is some JavaScript code
given as a string, which performs a modification of a string named
text, e.g. "text = '[font-style:italic]' + text + '[/]';";
see the example for an example of modifier
- width
the width of the chart, e.g. "600px" or "80%";
ignored if the chart is displayed in Shiny, in which case the width is
given in amChart4Output
- height
the height of the chart, e.g. "400px";
ignored if the chart is displayed in Shiny, in which case the height is
given in amChart4Output
- export
logical, whether to enable the export menu
- chartId
a HTML id for the chart
- elementId
a HTML id for the container of the chart; ignored if the
chart is displayed in Shiny, in which case the id is given by the Shiny id