R/axis.R

In JohnCoene/echarts: EChart htmlwidget

#' Customise Y axis
#'
#' @param p an echart object.
#' @param show whether to show the axis.
#' @param z,zlevel first and second grade cascading control, the higher z the closer to the top.
#' @param type type of axis takes, \code{value}, \code{category}, \code{time}, \code{log}.
#' @param append whether to append options to current axis or override.
#' @param boundaryGap whether to plot on axis line or between.
#' @param position position of axis, takes \code{bottom}, \code{top}, \code{left} or \code{right}.
#' @param name name of the axis.
#' @param nameLocation location of \code{name}, takes \code{start} or \code{end}.
#' @param nameTextStyle style \code{name} text.
#' @param min,max min and max values.
#' @param scale If \code{FALSE}, the value axis must start with 0. If \code{TRUE}, you can set the minimum and maximum value
#' of value axis as the starting and ending value of your value axis.
#' @param ... any other parameter to pass to the axis.
#' @param splitNumber number of segments, defaults to auto split along with the min/max.
#' @param logLabelBase base log.
#' @param logPositive if \code{FALSE} negative values are not supported.
#'
#' @examples
#' df <- data.frame(x = c("Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"),
#'   y = runif(7, 1, 5))
#'
#' df %>%
#'   echart(x) %>%
#'   eline(y) %>%
#'   exAxis_category(boundaryGap = FALSE)
#'
#' df %>%
#'   echart(x) %>%
#'   ebar(y) %>%
#'   eyAxis_log()
#'
#' @name yAxis
#' @rdname yAxis
NULL

#' @rdname yAxis
#' @export
eyAxis <- function(p, show = TRUE, type = "value", append = FALSE, ...){

  opts <- list(...)
  opts$type <- type
  opts$show <- show

  p <- add_axis(p, opts, append, axis = "yAxis")

  p
}

#' @rdname yAxis
#' @export
eyAxis_category <- function(p, show = TRUE, zlevel = 0, z = 0, boundaryGap = FALSE, append = FALSE, ...){

  opts <- axis_category(show, zlevel, z, boundaryGap, ...)

  p <- add_axis(p, opts, append, axis = "yAxis")

  p
}

#' @rdname yAxis
#' @export
eyAxis_value <- function(p, show = TRUE, zlevel = 0, z = 0, position = "left", name = NULL,
                         nameLocation = "end", nameTextStyle = list(), boundaryGap = list(0, 0),
                         min = NULL, max = NULL, scale = FALSE, splitNumber = NULL, append = FALSE, ...){

  opts <- axis_value(show, zlevel, z, position, name, nameLocation, nameTextStyle, boundaryGap,
                     min, max, scale, splitNumber, ...)

  p <- add_axis(p, opts, append, axis = "yAxis")

  p
}

#' @rdname yAxis
#' @export
eyAxis_time <- function(p, show = TRUE, zlevel = 0, z = 0, position = "left", name = NULL,
                        nameLocation = "end", nameTextStyle = list(), boundaryGap = list(0, 0),
                        min = NULL, max = NULL, scale = FALSE, splitNumber = NULL, append = FALSE, ...){

  opts <- axis_time(show, zlevel, z, position, name, nameLocation, nameTextStyle, boundaryGap,
                    min, max, scale, splitNumber, ...)

  p <- add_axis(p, opts, append, axis = "yAxis")

  p
}

#' @rdname yAxis
#' @export
eyAxis_log <- function(p, show = TRUE, zlevel = 0, z = 0, position = "left", logLabelBase = NULL,
                       logPositive = NULL, append = FALSE, ...){

  opts <- opts <- axis_log(show, zlevel, z, position, logLabelBase, logPositive, ...)

  p <- add_axis(p, opts, append, axis = "yAxis")

  p
}

#' Customise x axis.
#'
#' @param p an echart object.
#' @param show whether to show the axis.
#' @param z,zlevel first and second grade cascading control, the higher z the closer to the top.
#' @param type type of axis takes, \code{value}, \code{category}, \code{time}, \code{log}.
#' @param append whether to append options to current axis or override.
#' @param boundaryGap whether to plot on axis line or between.
#' @param position position of axis, takes \code{bottom}, \code{top}, \code{left} or \code{right}.
#' @param name name of the axis.
#' @param nameLocation location of \code{name}, takes \code{start} or \code{end}.
#' @param min,max min and max values.
#' @param scale If \code{FALSE}, the value axis must start with 0. If \code{TRUE}, you can set the minimum and maximum value
#' of value axis as the starting and ending value of your value axis.
#' @param ... any other parameter to pass to the axis.
#' @param splitNumber number of segments, defaults to auto split along with the min/max.
#' @param logLabelBase base log.
#' @param logPositive if \code{FALSE} negative values are not supported.
#'
#' @examples
#' mtcars$models <- row.names(mtcars)
#'
#' mtcars[1:10,] %>%
#'   echart(models) %>%
#'   eline(mpg) %>%
#'   exAxis_category() %>%
#'   eyAxis_value(min = 10, append = FALSE, scale = TRUE)
#'
#' @name xAxis
#' @rdname xAxis
NULL

#' Customize X axis
#'
#' @rdname xAxis
#' @export
exAxis <- function(p, show = TRUE, type = "value", append = FALSE, ...){

  opts <- list(...)
  opts$show <- show
  opts$data <- axis_data(type)
  opts$type <- type

  p <- axis_it(p, append, opts, "xAxis")

  p
}

#' @rdname xAxis
#' @export
exAxis_category <- function(p, show = TRUE, zlevel = 0, z = 0, boundaryGap = FALSE, append = FALSE, ...){

  type <- "category"

  opts <- list(...)
  opts$data <- axis_data(type)
  opts$type <- type
  opts$show <- show
  opts$zlevel <- zlevel
  opts$z <- z
  opts$boundaryGap <- boundaryGap

  p <- axis_it(p, append, opts, "xAxis")

  p
}


#' @rdname xAxis
#' @export
exAxis_value <- function(p, show = TRUE, min = NULL, max = NULL, zlevel = 0, z = 0, position = "bottom", name = NULL,
                         nameLocation = "end", boundaryGap = list(0, 0), scale = FALSE, splitNumber = NULL,
                         append = FALSE, ...){

  type <- "value"

  opts <- list(...)
  opts$data <- axis_data(type)
  opts$type <- type
  opts$show <- show
  opts$zlevel <- zlevel
  opts$z <- z
  opts$name <- if(!is.null(name)) name
  opts$position <- position
  opts$boundaryGap <- boundaryGap
  opts$min <- if(!is.null(min)) min
  opts$max <- if(!is.null(max)) max
  opts$nameLocation <- nameLocation
  opts$scale <- scale
  opts$splitNumber <- if(!is.null(splitNumber)) splitNumber

  p <- axis_it(p, append, opts, "xAxis")

  p

}

#' @rdname xAxis
#' @export
exAxis_time <- function(p, show = TRUE, zlevel = 0, z = 0, position = "bottom", name = NULL,
                        nameLocation = "end", boundaryGap = list(0, 0), min = NULL, max = NULL, scale = FALSE,
                        splitNumber = NULL, append = FALSE, ...){

  type <- "time"

  opts <- list(...)
  opts$data <- axis_data(type)
  opts$type <- type
  opts$show <- show
  opts$zlevel <- zlevel
  opts$z <- z
  opts$name <- if(!is.null(name)) name
  opts$position <- position
  opts$boundaryGap <- boundaryGap
  opts$min <- if(!is.null(min)) min
  opts$max <- if(!is.null(max)) max
  opts$nameLocation <- nameLocation
  opts$scale <- scale
  opts$splitNumber <- if(!is.null(splitNumber)) splitNumber

  p <- axis_it(p, append, opts, "xAxis")

  p

}

#' @rdname xAxis
#' @export
exAxis_log <- function(p, show = TRUE, zlevel = 0, z = 0, position = "bottom", logLabelBase = NULL,
                       logPositive = NULL, append = FALSE, ...){

  type <- "log"

  opts <- list(...)
  opts$data <- axis_data(type)
  opts$type <- type
  opts$show <- show
  opts$zlevel <- zlevel
  opts$z <- z
  opts$position <- position
  opts$logLabelBase <- if(!is.null(logLabelBase)) logLabelBase
  opts$logPositive <- if(!is.null(logPositive)) logPositive


  p <- axis_it(p, append, opts, "xAxis")

  p
}