Robot
/
apexcharter
mirror of https://github.com/dreamRs/apexcharter.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

roxygen 7

This commit is contained in:
pvictor 2019-11-26 10:17:42 +01:00
parent 500619df5a
commit f7e551db05
22 changed files with 262 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
man/apex.Rd
View File

@ -4,8 +4,16 @@
\alias{apex}
\title{Quick ApexChart}
\usage{
apex(data, mapping, type = "column", ..., auto_update = TRUE,
width = NULL, height = NULL, elementId = NULL)
apex(
data,
mapping,
type = "column",
...,
auto_update = TRUE,
width = NULL,
height = NULL,
elementId = NULL
)
}
\arguments{
\item{data}{Default dataset to use for chart. If not already a \code{data.frame}, it will be coerced to with \code{as.data.frame}.}

9
man/apexchart.Rd
View File

@ -4,8 +4,13 @@
\alias{apexchart}
\title{Create a apexcharts.js widget}
\usage{
apexchart(ax_opts = list(), auto_update = TRUE, width = NULL,
height = NULL, elementId = NULL)
apexchart(
ax_opts = list(),
auto_update = TRUE,
width = NULL,
height = NULL,
elementId = NULL
)
}
\arguments{
\item{ax_opts}{A \code{list} in JSON format with chart parameters.}

10
man/ax_annotations.Rd
View File

@ -4,8 +4,14 @@
\alias{ax_annotations}
\title{Annotations properties}
\usage{
ax_annotations(ax, position = NULL, yaxis = NULL, xaxis = NULL,
points = NULL, ...)
ax_annotations(
ax,
position = NULL,
yaxis = NULL,
xaxis = NULL,
points = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

25
man/ax_chart.Rd
View File

@ -4,11 +4,26 @@
\alias{ax_chart}
\title{Chart parameters}
\usage{
ax_chart(ax, type = NULL, stacked = NULL, stackType = NULL,
animations = NULL, background = NULL, foreColor = NULL,
dropShadow = NULL, events = NULL, offsetX = NULL, offsetY = NULL,
selection = NULL, sparkline = NULL, toolbar = NULL, zoom = NULL,
width = NULL, height = NULL, ...)
ax_chart(
ax,
type = NULL,
stacked = NULL,
stackType = NULL,
animations = NULL,
background = NULL,
foreColor = NULL,
dropShadow = NULL,
events = NULL,
offsetX = NULL,
offsetY = NULL,
selection = NULL,
sparkline = NULL,
toolbar = NULL,
zoom = NULL,
width = NULL,
height = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

14
man/ax_dataLabels.Rd
View File

@ -4,9 +4,17 @@
\alias{ax_dataLabels}
\title{Labels on data}
\usage{
ax_dataLabels(ax, enabled = NULL, textAnchor = NULL, offsetX = NULL,
offsetY = NULL, style = NULL, dropShadow = NULL,
formatter = NULL, ...)
ax_dataLabels(
ax,
enabled = NULL,
textAnchor = NULL,
offsetX = NULL,
offsetY = NULL,
style = NULL,
dropShadow = NULL,
formatter = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

12
man/ax_fill.Rd
View File

@ -4,8 +4,16 @@
\alias{ax_fill}
\title{Fill property}
\usage{
ax_fill(ax, type = NULL, colors = NULL, opacity = NULL,
gradient = NULL, image = NULL, pattern = NULL, ...)
ax_fill(
ax,
type = NULL,
colors = NULL,
opacity = NULL,
gradient = NULL,
image = NULL,
pattern = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

16
man/ax_grid.Rd
View File

@ -4,9 +4,19 @@
\alias{ax_grid}
\title{Add grids on chart}
\usage{
ax_grid(ax, show = NULL, borderColor = NULL, strokeDashArray = NULL,
position = NULL, xaxis = NULL, yaxis = NULL, row = NULL,
column = NULL, padding = NULL, ...)
ax_grid(
ax,
show = NULL,
borderColor = NULL,
strokeDashArray = NULL,
position = NULL,
xaxis = NULL,
yaxis = NULL,
row = NULL,
column = NULL,
padding = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

29
man/ax_legend.Rd
View File

@ -4,13 +4,28 @@
\alias{ax_legend}
\title{Legend properties}
\usage{
ax_legend(ax, show = NULL, position = NULL,
showForSingleSeries = NULL, showForNullSeries = NULL,
showForZeroSeries = NULL, horizontalAlign = NULL, fontSize = NULL,
textAnchor = NULL, offsetY = NULL, offsetX = NULL,
formatter = NULL, labels = NULL, markers = NULL,
itemMargin = NULL, containerMargin = NULL, onItemClick = NULL,
onItemHover = NULL, floating = NULL, ...)
ax_legend(
ax,
show = NULL,
position = NULL,
showForSingleSeries = NULL,
showForNullSeries = NULL,
showForZeroSeries = NULL,
horizontalAlign = NULL,
fontSize = NULL,
textAnchor = NULL,
offsetY = NULL,
offsetX = NULL,
formatter = NULL,
labels = NULL,
markers = NULL,
itemMargin = NULL,
containerMargin = NULL,
onItemClick = NULL,
onItemHover = NULL,
floating = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

19
man/ax_markers.Rd
View File

@ -4,10 +4,21 @@
\alias{ax_markers}
\title{Markers properties}
\usage{
ax_markers(ax, size = NULL, colors = NULL, strokeColor = NULL,
strokeWidth = NULL, strokeOpacity = NULL, fillOpacity = NULL,
shape = NULL, radius = NULL, offsetX = NULL, offsetY = NULL,
hover = NULL, ...)
ax_markers(
ax,
size = NULL,
colors = NULL,
strokeColor = NULL,
strokeWidth = NULL,
strokeOpacity = NULL,
fillOpacity = NULL,
shape = NULL,
radius = NULL,
offsetX = NULL,
offsetY = NULL,
hover = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

10
man/ax_plotOptions.Rd
View File

@ -4,8 +4,14 @@
\alias{ax_plotOptions}
\title{Specific options for chart}
\usage{
ax_plotOptions(ax, bar = NULL, heatmap = NULL, radialBar = NULL,
pie = NULL, ...)
ax_plotOptions(
ax,
bar = NULL,
heatmap = NULL,
radialBar = NULL,
pie = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

12
man/ax_stroke.Rd
View File

@ -4,8 +4,16 @@
\alias{ax_stroke}
\title{Stroke properties}
\usage{
ax_stroke(ax, show = NULL, curve = NULL, lineCap = NULL,
width = NULL, colors = NULL, dashArray = NULL, ...)
ax_stroke(
ax,
show = NULL,
curve = NULL,
lineCap = NULL,
width = NULL,
colors = NULL,
dashArray = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

14
man/ax_subtitle.Rd
View File

@ -4,9 +4,17 @@
\alias{ax_subtitle}
\title{Chart's subtitle}
\usage{
ax_subtitle(ax, text = NULL, align = NULL, margin = NULL,
offsetX = NULL, offsetY = NULL, floating = NULL, style = NULL,
...)
ax_subtitle(
ax,
text = NULL,
align = NULL,
margin = NULL,
offsetX = NULL,
offsetY = NULL,
floating = NULL,
style = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

3
man/ax_theme.Rd
View File

@ -4,8 +4,7 @@
\alias{ax_theme}
\title{Theme for charts}
\usage{
ax_theme(ax, mode = c("light", "dark"), palette = NULL,
monochrome = NULL, ...)
ax_theme(ax, mode = c("light", "dark"), palette = NULL, monochrome = NULL, ...)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

14
man/ax_title.Rd
View File

@ -4,9 +4,17 @@
\alias{ax_title}
\title{Chart's title}
\usage{
ax_title(ax, text = NULL, align = NULL, margin = NULL,
offsetX = NULL, offsetY = NULL, floating = NULL, style = NULL,
...)
ax_title(
ax,
text = NULL,
align = NULL,
margin = NULL,
offsetX = NULL,
offsetY = NULL,
floating = NULL,
style = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

24
man/ax_tooltip.Rd
View File

@ -4,11 +4,25 @@
\alias{ax_tooltip}
\title{Tooltip options}
\usage{
ax_tooltip(ax, enabled = NULL, shared = NULL, followCursor = NULL,
intersect = NULL, inverseOrder = NULL, custom = NULL,
fillSeriesColor = NULL, onDatasetHover = NULL, theme = NULL,
x = NULL, y = NULL, z = NULL, marker = NULL, items = NULL,
fixed = NULL, ...)
ax_tooltip(
ax,
enabled = NULL,
shared = NULL,
followCursor = NULL,
intersect = NULL,
inverseOrder = NULL,
custom = NULL,
fillSeriesColor = NULL,
onDatasetHover = NULL,
theme = NULL,
x = NULL,
y = NULL,
z = NULL,
marker = NULL,
items = NULL,
fixed = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

23
man/ax_xaxis.Rd
View File

@ -4,11 +4,24 @@
\alias{ax_xaxis}
\title{X-axis options}
\usage{
ax_xaxis(ax, type = NULL, categories = NULL, labels = NULL,
axisBorder = NULL, axisTicks = NULL, tickAmount = NULL,
min = NULL, max = NULL, range = NULL, floating = NULL,
position = NULL, title = NULL, crosshairs = NULL, tooltip = NULL,
...)
ax_xaxis(
ax,
type = NULL,
categories = NULL,
labels = NULL,
axisBorder = NULL,
axisTicks = NULL,
tickAmount = NULL,
min = NULL,
max = NULL,
range = NULL,
floating = NULL,
position = NULL,
title = NULL,
crosshairs = NULL,
tooltip = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

19
man/ax_yaxis.Rd
View File

@ -4,10 +4,21 @@
\alias{ax_yaxis}
\title{Y-axis options}
\usage{
ax_yaxis(ax, opposite = NULL, tickAmount = NULL, max = NULL,
min = NULL, floating = NULL, labels = NULL, axisBorder = NULL,
axisTicks = NULL, title = NULL, tooltip = NULL,
crosshairs = NULL, ...)
ax_yaxis(
ax,
opposite = NULL,
tickAmount = NULL,
max = NULL,
min = NULL,
floating = NULL,
labels = NULL,
axisBorder = NULL,
axisTicks = NULL,
title = NULL,
tooltip = NULL,
crosshairs = NULL,
...
)
}
\arguments{
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}

13
man/bar_opts.Rd
View File

@ -4,9 +4,16 @@
\alias{bar_opts}
\title{Bar options}
\usage{
bar_opts(horizontal = NULL, endingShape = NULL, columnWidth = NULL,
barHeight = NULL, distributed = NULL, colors = NULL,
dataLabels = NULL, ...)
bar_opts(
horizontal = NULL,
endingShape = NULL,
columnWidth = NULL,
barHeight = NULL,
distributed = NULL,
colors = NULL,
dataLabels = NULL,
...
)
}
\arguments{
\item{horizontal}{Logical. This option will turn a column chart into a horizontal bar chart.}

20
man/events_opts.Rd
View File

@ -4,11 +4,21 @@
\alias{events_opts}
\title{Events options}
\usage{
events_opts(click = NULL, beforeMount = NULL, mounted = NULL,
updated = NULL, legendClick = NULL, selection = NULL,
dataPointSelection = NULL, dataPointMouseEnter = NULL,
dataPointMouseLeave = NULL, beforeZoom = NULL, zoomed = NULL,
scrolled = NULL, ...)
events_opts(
click = NULL,
beforeMount = NULL,
mounted = NULL,
updated = NULL,
legendClick = NULL,
selection = NULL,
dataPointSelection = NULL,
dataPointMouseEnter = NULL,
dataPointMouseLeave = NULL,
beforeZoom = NULL,
zoomed = NULL,
scrolled = NULL,
...
)
}
\arguments{
\item{click}{Fires when user clicks on any area of the chart.}

9
man/heatmap_opts.Rd
View File

@ -4,8 +4,13 @@
\alias{heatmap_opts}
\title{Heatmap options}
\usage{
heatmap_opts(radius = NULL, enableShades = NULL,
shadeIntensity = NULL, colorScale = NULL, ...)
heatmap_opts(
radius = NULL,
enableShades = NULL,
shadeIntensity = NULL,
colorScale = NULL,
...
)
}
\arguments{
\item{radius}{Numeric. Radius of the rectangle inside heatmap.}

11
man/pie_opts.Rd
View File

@ -4,8 +4,15 @@
\alias{pie_opts}
\title{Pie options}
\usage{
pie_opts(size = NULL, donut = NULL, customScale = NULL,
offsetX = NULL, offsetY = NULL, dataLabels = NULL, ...)
pie_opts(
size = NULL,
donut = NULL,
customScale = NULL,
offsetX = NULL,
offsetY = NULL,
dataLabels = NULL,
...
)
}
\arguments{
\item{size}{Numeric. Custom size of the pie which will override the default size calculations.}

15
man/radialBar_opts.Rd
View File

@ -4,9 +4,18 @@
\alias{radialBar_opts}
\title{Radial bar options}
\usage{
radialBar_opts(size = NULL, inverseOrder = NULL, startAngle = NULL,
endAngle = NULL, offsetX = NULL, offsetY = NULL, hollow = NULL,
track = NULL, dataLabels = NULL, ...)
radialBar_opts(
size = NULL,
inverseOrder = NULL,
startAngle = NULL,
endAngle = NULL,
offsetX = NULL,
offsetY = NULL,
hollow = NULL,
track = NULL,
dataLabels = NULL,
...
)
}
\arguments{
\item{size}{Numeric. Manual size of the radialBars instead of calculating automatically from default height / width.}