added roxygen template for common documentation (ax)
This commit is contained in:
parent
647f4ab9c8
commit
fe45564f6a
|
@ -9,6 +9,7 @@
|
|||
^cran-comments\.md$
|
||||
^CRAN-RELEASE$
|
||||
^examples$
|
||||
^man-roxygen$
|
||||
^\.github$
|
||||
^LICENSE\.md$
|
||||
^codecov\.yml$
|
||||
|
|
|
@ -182,7 +182,7 @@ marker <- function(size = NULL,
|
|||
#' @description \code{add_shade()} allow to add a shaded area on specified range,
|
||||
#' \code{add_shade_weekend()} add a shadow on every week-end.
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param from Vector of position to start shadow.
|
||||
#' @param to Vector of position to end shadow.
|
||||
#' @param color Color of the shadow.
|
||||
|
@ -195,7 +195,7 @@ marker <- function(size = NULL,
|
|||
#' @note \code{add_shade_weekend} only works if variable
|
||||
#' used for x-axis is of class \code{Date} or \code{POSIXt}.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @name add-shade
|
||||
|
@ -259,7 +259,7 @@ add_shade_weekend <- function(ax, color = "#848484", opacity = 0.2, label = NULL
|
|||
#'
|
||||
#' @description Add a vertical line to mark a special event on a chart.
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param when Vector of position to place the event.
|
||||
#' @param color Color of the line.
|
||||
#' @param dash Creates dashes in borders of SVG path.
|
||||
|
@ -270,7 +270,7 @@ add_shade_weekend <- function(ax, color = "#848484", opacity = 0.2, label = NULL
|
|||
#' @param ... Additional arguments, see
|
||||
#' \url{https://apexcharts.com/docs/options/annotations/} for possible options.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @seealso \code{\link{add_event_marker}} to add a point.
|
||||
|
@ -297,7 +297,7 @@ add_event <- function(ax, when, color = "#E41A1C", dash = 4, label = NULL, ...)
|
|||
#' @param when Vector of position to place the event.
|
||||
#' @inheritParams add_point
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @return An [apexchart()] `htmlwidget` object.
|
||||
#' @export
|
||||
#'
|
||||
#' @seealso \code{\link{add_event}} to add a vertical line.
|
||||
|
@ -338,7 +338,7 @@ add_event_marker <- function(ax, when, y,
|
|||
|
||||
#' Add horizontal or vertical line
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param value Vector of position for the line(s).
|
||||
#' @param color Color(s) of the line(s).
|
||||
#' @param dash Creates dashes in borders of SVG path.
|
||||
|
@ -349,7 +349,7 @@ add_event_marker <- function(ax, when, y,
|
|||
#' @param ... Additional arguments, see
|
||||
#' \url{https://apexcharts.com/docs/options/annotations/} for possible options.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @name add-vh-lines
|
||||
|
@ -388,7 +388,7 @@ add_vline <- function(ax, value, color = "#000", dash = 0, label = NULL, ...) {
|
|||
|
||||
#' Add an annotation point
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param x Coordinate(s) on the x-axis.
|
||||
#' @param y Coordinate(s) on the y-axis.
|
||||
#' @param size Size of the marker.
|
||||
|
@ -402,7 +402,7 @@ add_vline <- function(ax, value, color = "#000", dash = 0, label = NULL, ...) {
|
|||
#' @param ... Additional arguments, see
|
||||
#' \url{https://apexcharts.com/docs/options/annotations/} for possible options.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @seealso \code{\link{add_event_marker}} to add a point when x-axis is a datetime.
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
#' Annotations properties
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param position Whether to put the annotations behind the charts or in front of it. Available Options: \code{"front"} or \code{"back"}.
|
||||
#' @param yaxis List of lists.
|
||||
#' @param xaxis List of lists.
|
||||
|
@ -13,7 +13,6 @@
|
|||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/annotations/}.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @export
|
||||
#'
|
||||
#' @examples
|
||||
|
@ -126,7 +125,7 @@ ax_annotations <- function(ax,
|
|||
|
||||
#' Chart parameters
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param type Specify the chart type. Available Options: \code{"bar"}, \code{"column"}, \code{"line"},
|
||||
#' \code{"pie"}, \code{"donut"}, \code{"radialBar"}, \code{"scatter"}, \code{"bubble"}, \code{"heatmap"}.
|
||||
#' @param stacked Logical. Enables stacked option for axis charts.
|
||||
|
@ -154,7 +153,6 @@ ax_annotations <- function(ax,
|
|||
#' @param height Height of the chart.
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @export
|
||||
#'
|
||||
#' @example examples/ax_chart.R
|
||||
|
@ -186,7 +184,7 @@ ax_chart <- function(ax,
|
|||
|
||||
#' Specific options for chart
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param bar See \code{\link{bar_opts}}.
|
||||
#' @param heatmap See \code{\link{heatmap_opts}}.
|
||||
#' @param radialBar See \code{\link{radialBar_opts}}.
|
||||
|
@ -194,7 +192,7 @@ ax_chart <- function(ax,
|
|||
#' @param bubble See \code{\link{bubble_opts}}.
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @examples
|
||||
|
@ -244,10 +242,10 @@ ax_plotOptions <- function(ax,
|
|||
|
||||
#' Colors
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param ... Colors for the chart's series. When all colors are used, it starts from the beginning.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/colors/}
|
||||
|
@ -280,7 +278,7 @@ ax_colors <- function(ax, ...) {
|
|||
|
||||
#' Labels on data
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param enabled To determine whether to show dataLabels or not.
|
||||
#' @param textAnchor The alignment of text relative to dataLabel's drawing position.
|
||||
#' Accepted values \code{"start"}, \code{"middle"} or \code{"end"}.
|
||||
|
@ -291,7 +289,7 @@ ax_colors <- function(ax, ...) {
|
|||
#' @param formatter The formatter function takes in a single value and allows you to format the value before displaying
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/datalabels/}
|
||||
|
@ -321,7 +319,7 @@ ax_dataLabels <- function(ax,
|
|||
|
||||
#' Fill property
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param type Whether to fill the paths with solid colors or gradient.
|
||||
#' Available options: \code{"solid"}, \code{"gradient"}, \code{"pattern"} or \code{"image"}.
|
||||
#' @param colors Colors to fill the svg paths..
|
||||
|
@ -331,7 +329,7 @@ ax_dataLabels <- function(ax,
|
|||
#' @param pattern A list of parameters.
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/fill/}
|
||||
|
@ -384,7 +382,7 @@ ax_fill <- function(ax,
|
|||
|
||||
#' Add grids on chart
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param show Logical. To show or hide grid area (including xaxis / yaxis)
|
||||
#' @param borderColor Colors of grid borders / lines.
|
||||
#' @param strokeDashArray Creates dashes in borders of svg path. Higher number creates more space between dashes in the border.
|
||||
|
@ -396,7 +394,7 @@ ax_fill <- function(ax,
|
|||
#' @param padding A list of parameters.
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/grid/}
|
||||
|
@ -448,12 +446,12 @@ ax_grid <- function(ax,
|
|||
|
||||
#' Alternative axis labels
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param labels A vector to use as labels.
|
||||
#' @param ... Vector. In Axis Charts (line / column), labels can be set instead of setting xaxis categories
|
||||
#' option. While, in pie/donut charts, each label corresponds to value in series array.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @name ax_labels
|
||||
|
@ -484,7 +482,7 @@ ax_labels2 <- function(ax, labels) {
|
|||
|
||||
#' Legend properties
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param show Logical. Whether to show or hide the legend container.
|
||||
#' @param position Available position options for legend: \code{"top"}, \code{"right"}, \code{"bottom"}, \code{"left"}.
|
||||
#' @param showForSingleSeries Show legend even if there is just 1 series.
|
||||
|
@ -510,7 +508,7 @@ ax_labels2 <- function(ax, labels) {
|
|||
#' @param floating Logical. The floating option will take out the legend from the chart area and make it float above the chart.
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/legend/}
|
||||
|
@ -558,7 +556,7 @@ ax_legend <- function(ax,
|
|||
|
||||
#' Markers properties
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param size Numeric. Size of the marker point.
|
||||
#' @param colors Sets the fill color(s) of the marker point.
|
||||
#' @param strokeColor Stroke Color of the marker.
|
||||
|
@ -572,7 +570,7 @@ ax_legend <- function(ax,
|
|||
#' @param hover List with item \code{size} (Size of the marker when it is active).
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/markers/}
|
||||
|
@ -607,7 +605,7 @@ ax_markers <- function(ax,
|
|||
|
||||
#' No data specification
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param text
|
||||
#' @param align
|
||||
#' @param verticalAlign
|
||||
|
@ -616,7 +614,7 @@ ax_markers <- function(ax,
|
|||
#' @param style
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @noRd
|
||||
#'
|
||||
ax_noData <- function(ax,
|
||||
|
@ -634,10 +632,10 @@ ax_noData <- function(ax,
|
|||
|
||||
#' Responsive options
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/responsive/}
|
||||
|
@ -674,10 +672,10 @@ ax_responsive <- function(ax, ...) {
|
|||
|
||||
#' Add data to a chart
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param ... Lists containing data to plot, typically list with two items: \code{name} and \code{data}.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @name ax-series
|
||||
|
@ -717,13 +715,13 @@ ax_series2 <- function(ax, l) {
|
|||
|
||||
#' Charts' states
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param normal A list of parameters.
|
||||
#' @param hover A list of parameters.
|
||||
#' @param active A list of parameters.
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/states/}
|
||||
|
@ -756,7 +754,7 @@ ax_states <- function(ax,
|
|||
|
||||
#' Chart's title
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param text Text to display as a title of chart.
|
||||
#' @param align Alignment of subtitle relative to chart area. Possible Options: \code{"left"}, \code{"center"} and \code{"right"}.
|
||||
#' @param margin Numeric. Vertical spacing around the title text.
|
||||
|
@ -766,7 +764,7 @@ ax_states <- function(ax,
|
|||
#' @param style List with two items: \code{fontSize} (Font Size of the title text) and \code{color} (Fore color of the title text).
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/title/}
|
||||
|
@ -797,7 +795,7 @@ ax_title <- function(ax,
|
|||
|
||||
#' Chart's subtitle
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param text Text to display as a subtitle of chart.
|
||||
#' @param align Alignment of subtitle relative to chart area. Possible Options: \code{"left"}, \code{"center"} and \code{"right"}.
|
||||
#' @param margin Numeric. Vertical spacing around the subtitle text.
|
||||
|
@ -807,7 +805,7 @@ ax_title <- function(ax,
|
|||
#' @param style List with two items: \code{fontSize} (Font Size of the subtitle text) and \code{color} (Fore color of the subtitle text).
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/subtitle/}
|
||||
|
@ -841,7 +839,7 @@ ax_subtitle <- function(ax,
|
|||
|
||||
#' Stroke properties
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param show Logical. To show or hide path-stroke / line
|
||||
#' @param curve In line / area charts, whether to draw smooth lines or straight lines.
|
||||
#' Available Options: \code{"smooth"} (connects the points in a curve fashion. Also known as spline)
|
||||
|
@ -855,7 +853,7 @@ ax_subtitle <- function(ax,
|
|||
#' @param dashArray Creates dashes in borders of svg path. Higher number creates more space between dashes in the border.
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/stroke/}
|
||||
|
@ -897,7 +895,7 @@ ax_stroke <- function(ax,
|
|||
|
||||
#' Tooltip options
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param enabled Logical. Show tooltip when user hovers over chart area.
|
||||
#' @param shared Logical. When having multiple series, show a shared tooltip.
|
||||
#' @param followCursor Logical. Follow user's cursor position instead of putting tooltip on actual data points.
|
||||
|
@ -915,7 +913,7 @@ ax_stroke <- function(ax,
|
|||
#' @param fixed A list of parameters.
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/tooltip/}
|
||||
|
@ -971,7 +969,7 @@ ax_tooltip <- function(ax,
|
|||
|
||||
#' X-axis options
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param type Character. Available Options : \code{"categories"} and \code{"datetime"}.
|
||||
#' @param categories Categories are labels which are displayed on the x-axis.
|
||||
#' @param labels A list of parameters.
|
||||
|
@ -990,7 +988,7 @@ ax_tooltip <- function(ax,
|
|||
#' @param tooltip A list of parameters.
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/xaxis/}
|
||||
|
@ -1076,7 +1074,7 @@ ax_xaxis <- function(ax,
|
|||
|
||||
#' Y-axis options
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param opposite Logical. When enabled, will draw the yaxis on the right side of the chart.
|
||||
#' @param tickAmount Number of Tick Intervals to show.
|
||||
#' @param max Lowest number to be set for the y-axis. The graph drawing beyond this number will be clipped off.
|
||||
|
@ -1091,7 +1089,7 @@ ax_xaxis <- function(ax,
|
|||
#' @param crosshairs A list of parameters.
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/yaxis/}
|
||||
|
@ -1145,10 +1143,10 @@ ax_yaxis <- function(ax,
|
|||
|
||||
#' Secondary Y-axis options
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param ... See arguments from \code{\link{ax_yaxis}}.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @export
|
||||
#'
|
||||
#' @example examples/ax_yaxis2.R
|
||||
|
@ -1170,13 +1168,12 @@ ax_yaxis2 <- function(ax, ...) {
|
|||
|
||||
#' Theme for charts
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param mode use light or dark theme.
|
||||
#' @param palette Character. Available palettes: \code{"palette1"} to \code{"palette10"}.
|
||||
#' @param monochrome A list of parameters.
|
||||
#' @param ... Additional parameters.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @export
|
||||
#'
|
||||
#' @note See \url{https://apexcharts.com/docs/options/theme/}
|
||||
|
@ -1226,7 +1223,7 @@ ax_theme <- function(ax,
|
|||
|
||||
#' Configuration for charts with no data
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param text The text to display when no-data is available.
|
||||
#' @param align Horizontal alignment: \code{"left"}, \code{"center"} or \code{"right"}.
|
||||
#' @param verticalAlign Vertical alignment: \code{"top"}, \code{"middle"} or \code{"bottom"}.
|
||||
|
@ -1235,7 +1232,6 @@ ax_theme <- function(ax,
|
|||
#' @param fontFamily FontFamily of the text.
|
||||
#' @param offsetX,offsetY Text offset.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @export
|
||||
#'
|
||||
#' @examples
|
||||
|
|
|
@ -1,10 +1,9 @@
|
|||
|
||||
#' Set specific color's series
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param values Named list, names represent data series, values colors to use.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @export
|
||||
#'
|
||||
#' @example examples/colors.R
|
||||
|
|
|
@ -208,7 +208,7 @@ get_last_row <- function(mat) {
|
|||
|
||||
#' Facet wrap for ApexCharts
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @param ax An [apexchart()] `htmlwidget` object.
|
||||
#' @param facets Variable(s) to use for facetting, wrapped in \code{vars(...)}.
|
||||
#' @param nrow,ncol Number of row and column in output matrix.
|
||||
#' @param scales Should scales be fixed (\code{"fixed"}, the default),
|
||||
|
@ -216,7 +216,7 @@ get_last_row <- function(mat) {
|
|||
#' @param labeller A function with one argument containing for each facet the value of the faceting variable.
|
||||
#' @param chart_height Individual chart height.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @return An [apexchart()] `htmlwidget` object with an additionnal class `"apex_facet"`.
|
||||
#' @export
|
||||
#'
|
||||
#' @name apex-facets
|
||||
|
|
2
R/labs.R
2
R/labs.R
|
@ -1,7 +1,7 @@
|
|||
|
||||
#' Modify axis, legend, and chart labels
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param title Text for the title.
|
||||
#' @param subtitle Text for the subtitle.
|
||||
#' @param x Text for the x-axis label.
|
||||
|
|
|
@ -4,14 +4,13 @@
|
|||
#' @description Add a line to an existing chart (bar, scatter and line types supported).
|
||||
#' On scatter charts you can also add a smooth line.
|
||||
#'
|
||||
#' @param ax An \code{\link{apex}} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param mapping Default list of aesthetic mappings to use for chart.
|
||||
#' @param data A \code{data.frame} to use to add a line, if \code{NULL} (default),
|
||||
#' the \code{data.frame} provided in \code{apex()} will be used.
|
||||
#' @param type Type of line.
|
||||
#' @param serie_name Name for the serie displayed in tooltip and legend.
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @export
|
||||
#'
|
||||
#' @name add-line
|
||||
|
|
|
@ -8,7 +8,7 @@
|
|||
#' with size > 0 and set tooltip's options `intersect = TRUE` and `shared = FALSE`.
|
||||
#' * **scatter:** retrieve XY coordinates.
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param inputId The id that will be used server-side for retrieving click.
|
||||
#' @param multiple Allow multiple selection: \code{TRUE} or \code{FALSE} (default).
|
||||
#' @param effect_type Type of effect for selected element, default is to use lightly darken color.
|
||||
|
@ -17,7 +17,6 @@
|
|||
#'
|
||||
#' @note If x-axis is of type datetime, value retrieved is of class \code{POSIXct}.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @export
|
||||
#'
|
||||
#' @importFrom shiny getDefaultReactiveDomain
|
||||
|
@ -67,13 +66,12 @@ set_input_click <- function(ax, inputId, multiple = FALSE,
|
|||
|
||||
#' Retrieve zoom information in Shiny
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param inputId The id that will be used server-side for retrieving zoom.
|
||||
#' @param session The Shiny session.
|
||||
#'
|
||||
#' @note If x-axis is of type datetime, value retrieved is of class \code{POSIXct}.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @export
|
||||
#'
|
||||
#' @importFrom shiny getDefaultReactiveDomain
|
||||
|
@ -97,7 +95,7 @@ set_input_zoom <- function(ax, inputId,
|
|||
|
||||
#' Retrieve selection information in Shiny
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param inputId The id that will be used server-side for retrieving selection.
|
||||
#' @param type Allow selection either on x-axis, y-axis or on both axis.
|
||||
#' @param fill_color Background color of the selection rect which is drawn when user drags on the chart.
|
||||
|
@ -111,7 +109,6 @@ set_input_zoom <- function(ax, inputId,
|
|||
#' @param ymin,ymax Start value of y-axis. Both \code{min} and \code{max} must be provided.
|
||||
#' @param session The Shiny session.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @export
|
||||
#'
|
||||
#' @examples
|
||||
|
@ -131,11 +128,19 @@ set_input_zoom <- function(ax, inputId,
|
|||
#' xmin = format_date("1980-01-01"),
|
||||
#' xmax = format_date("1985-01-01")
|
||||
#' )
|
||||
set_input_selection <- function(ax, inputId, type = c("x", "xy", "y"),
|
||||
fill_color = "#24292e", fill_opacity = 0.1,
|
||||
stroke_width = 1, stroke_dasharray = 3,
|
||||
stroke_color = "#24292e", stroke_opacity = 0.4,
|
||||
xmin = NULL, xmax = NULL, ymin = NULL, ymax = NULL,
|
||||
set_input_selection <- function(ax,
|
||||
inputId,
|
||||
type = c("x", "xy", "y"),
|
||||
fill_color = "#24292e",
|
||||
fill_opacity = 0.1,
|
||||
stroke_width = 1,
|
||||
stroke_dasharray = 3,
|
||||
stroke_color = "#24292e",
|
||||
stroke_opacity = 0.4,
|
||||
xmin = NULL,
|
||||
xmax = NULL,
|
||||
ymin = NULL,
|
||||
ymax = NULL,
|
||||
session = shiny::getDefaultReactiveDomain()) {
|
||||
type <- match.arg(type)
|
||||
if (is.null(session))
|
||||
|
@ -171,11 +176,10 @@ set_input_selection <- function(ax, inputId, type = c("x", "xy", "y"),
|
|||
|
||||
#' Retrieve chart's base64 dataURI.
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param inputId The id that will be used server-side for retrieving data.
|
||||
#' @param session The Shiny session.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @export
|
||||
#'
|
||||
#' @example examples/export-2.R
|
||||
|
|
|
@ -1,13 +1,12 @@
|
|||
|
||||
#' Fix tooltip
|
||||
#' Fixed tooltip
|
||||
#'
|
||||
#' @param ax An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param position Predefined position: \code{"topLeft"}, \code{"topRight"},
|
||||
#' \code{"bottomLeft"} or \code{"bottomRight"}.
|
||||
#' @param offsetX Sets the left offset for the tooltip container in fixed position.
|
||||
#' @param offsetY Sets the top offset for the tooltip container in fixed position.
|
||||
#'
|
||||
#' @return An \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @export
|
||||
#'
|
||||
#' @example examples/set_tooltip_fixed.R
|
||||
|
|
|
@ -58,12 +58,10 @@ make_styles <- function(styles) {
|
|||
|
||||
#' Utility function to create ApexChart parameters JSON
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param name Slot's name to edit
|
||||
#' @param ... Arguments for the slot
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @importFrom utils modifyList
|
||||
#'
|
||||
#' @noRd
|
||||
|
@ -84,12 +82,10 @@ make_styles <- function(styles) {
|
|||
|
||||
#' Utility function to create ApexChart parameters JSON
|
||||
#'
|
||||
#' @param ax A \code{apexcharts} \code{htmlwidget} object.
|
||||
#' @template ax-default
|
||||
#' @param name Slot's name to edit
|
||||
#' @param l List of arguments for the slot
|
||||
#'
|
||||
#' @return A \code{apexcharts} \code{htmlwidget} object.
|
||||
#'
|
||||
#' @importFrom utils modifyList
|
||||
#'
|
||||
#' @noRd
|
||||
|
|
|
@ -0,0 +1,3 @@
|
|||
#' @param ax An [apexchart()] `htmlwidget` object.
|
||||
#'
|
||||
#' @return An [apexchart()] `htmlwidget` object.
|
|
@ -25,7 +25,7 @@ add_smooth_line(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{\link{apex}} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{mapping}{Default list of aesthetic mappings to use for chart.}
|
||||
|
||||
|
@ -45,7 +45,7 @@ the \code{data.frame} provided in \code{apex()} will be used.}
|
|||
\item{...}{Arguments passed to \code{model}.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Add a line to an existing chart (bar, scatter and line types supported).
|
||||
|
|
|
@ -11,7 +11,7 @@ add_shade(ax, from, to, color = "#848484", opacity = 0.2, label = NULL, ...)
|
|||
add_shade_weekend(ax, color = "#848484", opacity = 0.2, label = NULL, ...)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{from}{Vector of position to start shadow.}
|
||||
|
||||
|
@ -28,7 +28,7 @@ or see \code{\link{label}} for more controls.}
|
|||
\url{https://apexcharts.com/docs/options/annotations/} for possible options.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
\code{add_shade()} allow to add a shaded area on specified range,
|
||||
|
|
|
@ -11,7 +11,7 @@ add_hline(ax, value, color = "#000", dash = 0, label = NULL, ...)
|
|||
add_vline(ax, value, color = "#000", dash = 0, label = NULL, ...)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{value}{Vector of position for the line(s).}
|
||||
|
||||
|
@ -28,7 +28,7 @@ or see \code{\link{label}} for more controls.}
|
|||
\url{https://apexcharts.com/docs/options/annotations/} for possible options.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Add horizontal or vertical line
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
add_event(ax, when, color = "#E41A1C", dash = 4, label = NULL, ...)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{when}{Vector of position to place the event.}
|
||||
|
||||
|
@ -24,7 +24,7 @@ or see \code{\link{label}} for more controls.}
|
|||
\url{https://apexcharts.com/docs/options/annotations/} for possible options.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Add a vertical line to mark a special event on a chart.
|
||||
|
|
|
@ -19,7 +19,7 @@ add_event_marker(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{when}{Vector of position to place the event.}
|
||||
|
||||
|
@ -44,7 +44,7 @@ or see \code{\link{label}} for more controls.}
|
|||
\url{https://apexcharts.com/docs/options/annotations/} for possible options.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Add a point with a label based on a datetime.
|
||||
|
|
|
@ -19,7 +19,7 @@ add_point(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{x}{Coordinate(s) on the x-axis.}
|
||||
|
||||
|
@ -44,7 +44,7 @@ or see \code{\link{label}} for more controls.}
|
|||
\url{https://apexcharts.com/docs/options/annotations/} for possible options.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Add an annotation point
|
||||
|
|
|
@ -26,7 +26,7 @@ ax_facet_grid(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{facets}{Variable(s) to use for facetting, wrapped in \code{vars(...)}.}
|
||||
|
||||
|
@ -42,7 +42,7 @@ free (\code{"free"}), or free in one dimension (\code{"free_x"}, \code{"free_y"}
|
|||
\item{rows, cols}{A set of variables or expressions quoted by vars() and defining faceting groups on the rows or columns dimension.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object with an additionnal class \code{"apex_facet"}.
|
||||
}
|
||||
\description{
|
||||
Facet wrap for ApexCharts
|
||||
|
|
|
@ -11,14 +11,14 @@ ax_series(ax, ...)
|
|||
ax_series2(ax, l)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{...}{Lists containing data to plot, typically list with two items: \code{name} and \code{data}.}
|
||||
|
||||
\item{l}{A list.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Add data to a chart
|
||||
|
|
|
@ -14,7 +14,7 @@ ax_annotations(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{position}{Whether to put the annotations behind the charts or in front of it. Available Options: \code{"front"} or \code{"back"}.}
|
||||
|
||||
|
@ -27,7 +27,7 @@ ax_annotations(
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Annotations properties
|
||||
|
|
|
@ -28,7 +28,7 @@ ax_chart(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{type}{Specify the chart type. Available Options: \code{"bar"}, \code{"column"}, \code{"line"},
|
||||
\code{"pie"}, \code{"donut"}, \code{"radialBar"}, \code{"scatter"}, \code{"bubble"}, \code{"heatmap"}.}
|
||||
|
@ -76,7 +76,7 @@ Available options: \code{"normal"} or \code{"100\%"}.}
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Chart parameters
|
||||
|
|
|
@ -7,12 +7,12 @@
|
|||
ax_colors(ax, ...)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{...}{Colors for the chart's series. When all colors are used, it starts from the beginning.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Colors
|
||||
|
|
|
@ -7,12 +7,12 @@
|
|||
ax_colors_manual(ax, values)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{values}{Named list, names represent data series, values colors to use.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Set specific color's series
|
||||
|
|
|
@ -17,7 +17,7 @@ ax_dataLabels(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{enabled}{To determine whether to show dataLabels or not.}
|
||||
|
||||
|
@ -37,7 +37,7 @@ Accepted values \code{"start"}, \code{"middle"} or \code{"end"}.}
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Labels on data
|
||||
|
|
|
@ -16,7 +16,7 @@ ax_fill(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{type}{Whether to fill the paths with solid colors or gradient.
|
||||
Available options: \code{"solid"}, \code{"gradient"}, \code{"pattern"} or \code{"image"}.}
|
||||
|
@ -34,7 +34,7 @@ Available options: \code{"solid"}, \code{"gradient"}, \code{"pattern"} or \code{
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Fill property
|
||||
|
|
|
@ -19,7 +19,7 @@ ax_grid(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{show}{Logical. To show or hide grid area (including xaxis / yaxis)}
|
||||
|
||||
|
@ -42,7 +42,7 @@ ax_grid(
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Add grids on chart
|
||||
|
|
|
@ -10,7 +10,7 @@ ax_labels(ax, ...)
|
|||
ax_labels2(ax, labels)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{...}{Vector. In Axis Charts (line / column), labels can be set instead of setting xaxis categories
|
||||
option. While, in pie/donut charts, each label corresponds to value in series array.}
|
||||
|
@ -18,7 +18,7 @@ option. While, in pie/donut charts, each label corresponds to value in series ar
|
|||
\item{labels}{A vector to use as labels.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Alternative axis labels
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
ax_labs(ax, title = NULL, subtitle = NULL, x = NULL, y = NULL)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{title}{Text for the title.}
|
||||
|
||||
|
@ -17,6 +17,9 @@ ax_labs(ax, title = NULL, subtitle = NULL, x = NULL, y = NULL)
|
|||
|
||||
\item{y}{Text for the y-axis label.}
|
||||
}
|
||||
\value{
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Modify axis, legend, and chart labels
|
||||
}
|
||||
|
|
|
@ -28,7 +28,7 @@ ax_legend(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{show}{Logical. Whether to show or hide the legend container.}
|
||||
|
||||
|
@ -74,7 +74,7 @@ when hovered on legend item, it will highlight the paths of the hovered series i
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Legend properties
|
||||
|
|
|
@ -21,7 +21,7 @@ ax_markers(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{size}{Numeric. Size of the marker point.}
|
||||
|
||||
|
@ -48,7 +48,7 @@ ax_markers(
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Markers properties
|
||||
|
|
|
@ -17,7 +17,7 @@ ax_nodata(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{text}{The text to display when no-data is available.}
|
||||
|
||||
|
@ -34,7 +34,7 @@ ax_nodata(
|
|||
\item{offsetX, offsetY}{Text offset.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Configuration for charts with no data
|
||||
|
|
|
@ -15,7 +15,7 @@ ax_plotOptions(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{bar}{See \code{\link{bar_opts}}.}
|
||||
|
||||
|
@ -30,7 +30,7 @@ ax_plotOptions(
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Specific options for chart
|
||||
|
|
|
@ -7,12 +7,12 @@
|
|||
ax_responsive(ax, ...)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Responsive options
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
ax_states(ax, normal = NULL, hover = NULL, active = NULL, ...)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{normal}{A list of parameters.}
|
||||
|
||||
|
@ -18,7 +18,7 @@ ax_states(ax, normal = NULL, hover = NULL, active = NULL, ...)
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Charts' states
|
||||
|
|
|
@ -16,7 +16,7 @@ ax_stroke(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{show}{Logical. To show or hide path-stroke / line}
|
||||
|
||||
|
@ -38,7 +38,7 @@ and \code{"round"} (ends the path-stroke with a radius that smooths out the star
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Stroke properties
|
||||
|
|
|
@ -17,7 +17,7 @@ ax_subtitle(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{text}{Text to display as a subtitle of chart.}
|
||||
|
||||
|
@ -36,7 +36,7 @@ ax_subtitle(
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Chart's subtitle
|
||||
|
|
|
@ -7,7 +7,7 @@
|
|||
ax_theme(ax, mode = c("light", "dark"), palette = NULL, monochrome = NULL, ...)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{mode}{use light or dark theme.}
|
||||
|
||||
|
@ -18,7 +18,7 @@ ax_theme(ax, mode = c("light", "dark"), palette = NULL, monochrome = NULL, ...)
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Theme for charts
|
||||
|
|
|
@ -17,7 +17,7 @@ ax_title(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{text}{Text to display as a title of chart.}
|
||||
|
||||
|
@ -36,7 +36,7 @@ ax_title(
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Chart's title
|
||||
|
|
|
@ -25,7 +25,7 @@ ax_tooltip(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{enabled}{Logical. Show tooltip when user hovers over chart area.}
|
||||
|
||||
|
@ -60,7 +60,7 @@ ax_tooltip(
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Tooltip options
|
||||
|
|
|
@ -24,7 +24,7 @@ ax_xaxis(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{type}{Character. Available Options : \code{"categories"} and \code{"datetime"}.}
|
||||
|
||||
|
@ -59,7 +59,7 @@ similar to an absolutely positioned element. Set the offsetX and offsetY then to
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
X-axis options
|
||||
|
|
|
@ -21,7 +21,7 @@ ax_yaxis(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{opposite}{Logical. When enabled, will draw the yaxis on the right side of the chart.}
|
||||
|
||||
|
@ -49,7 +49,7 @@ similar to an absolutely positioned element. Set the offsetX and offsetY then to
|
|||
\item{...}{Additional parameters.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Y-axis options
|
||||
|
|
|
@ -7,12 +7,12 @@
|
|||
ax_yaxis2(ax, ...)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{...}{See arguments from \code{\link{ax_yaxis}}.}
|
||||
}
|
||||
\value{
|
||||
A \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Secondary Y-axis options
|
||||
|
|
|
@ -14,7 +14,7 @@ set_input_click(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{inputId}{The id that will be used server-side for retrieving click.}
|
||||
|
||||
|
@ -27,7 +27,7 @@ set_input_click(
|
|||
\item{session}{The Shiny session.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
According to type of chart, different values are retrieved:
|
||||
|
|
|
@ -7,14 +7,14 @@
|
|||
set_input_export(ax, inputId, session = shiny::getDefaultReactiveDomain())
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{inputId}{The id that will be used server-side for retrieving data.}
|
||||
|
||||
\item{session}{The Shiny session.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Retrieve chart's base64 dataURI.
|
||||
|
|
|
@ -22,7 +22,7 @@ set_input_selection(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{inputId}{The id that will be used server-side for retrieving selection.}
|
||||
|
||||
|
@ -48,7 +48,7 @@ Higher number creates more space between dashes in the border.}
|
|||
\item{session}{The Shiny session.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Retrieve selection information in Shiny
|
||||
|
|
|
@ -7,14 +7,14 @@
|
|||
set_input_zoom(ax, inputId, session = shiny::getDefaultReactiveDomain())
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{inputId}{The id that will be used server-side for retrieving zoom.}
|
||||
|
||||
\item{session}{The Shiny session.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Retrieve zoom information in Shiny
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
% Please edit documentation in R/tooltip.R
|
||||
\name{set_tooltip_fixed}
|
||||
\alias{set_tooltip_fixed}
|
||||
\title{Fix tooltip}
|
||||
\title{Fixed tooltip}
|
||||
\usage{
|
||||
set_tooltip_fixed(
|
||||
ax,
|
||||
|
@ -12,7 +12,7 @@ set_tooltip_fixed(
|
|||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{ax}{An \code{apexcharts} \code{htmlwidget} object.}
|
||||
\item{ax}{An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.}
|
||||
|
||||
\item{position}{Predefined position: \code{"topLeft"}, \code{"topRight"},
|
||||
\code{"bottomLeft"} or \code{"bottomRight"}.}
|
||||
|
@ -22,10 +22,10 @@ set_tooltip_fixed(
|
|||
\item{offsetY}{Sets the top offset for the tooltip container in fixed position.}
|
||||
}
|
||||
\value{
|
||||
An \code{apexcharts} \code{htmlwidget} object.
|
||||
An \code{\link[=apexchart]{apexchart()}} \code{htmlwidget} object.
|
||||
}
|
||||
\description{
|
||||
Fix tooltip
|
||||
Fixed tooltip
|
||||
}
|
||||
\examples{
|
||||
|
||||
|
|
Loading…
Reference in New Issue