R/utils_sharedGenerics.R

#' @name Generics functions
#' @title General shared generic methods
#' @description These methods are shared by at least two different classes
#' @param .Object \linkS4class{AmObject}.
#' @details Be cautious when using one of these functions since they have several signatures (S4).
#' @return An updated 'AmObject'.
#' 
#' @rdname shared-generics
NULL


#' @param amBalloon \linkS4class{AmBalloon}.
#' @details setBalloon is shared by AmChart and AmStockChart.
#' 
#' @rdname shared-generics
#' @export
#' 
setGeneric(name = "setBalloon", def = function(.Object, amBalloon = NULL, ...) {standardGeneric("setBalloon")})

#' @param dataProvider \code{data.frame}.
#' @param keepNA \code{logical}, default set to \code{TRUE}.
#' Indicates if \code{NULL} values have to be kept or ignored.
#' @details setDataProvider(..) is shared by AmGraph and DataSet.
#' 
#' @rdname shared-generics
#' @export
#' 
setGeneric(name = "setDataProvider", def = function(.Object, dataProvider, keepNA = TRUE) {standardGeneric("setDataProvider")})

#' @details setTitle(...) is Shared by AmGraph and ValueAxis.
#' @param title \code{character}.
#' 
#' @rdname shared-generics
#' @export
#' 
setGeneric(name = "setTitle", def = function(.Object, title) {standardGeneric("setTitle")})

#' @details setType(...) is shared by AmGraph and AmChart.
#' @param type \code{character}.
#' 
#' @rdname shared-generics
#' @export
#' 
setGeneric( name = "setType", def = function(.Object, type) {standardGeneric("setType")})

#' @details setGraph(...) is shared by AmChart and ChartScrollbar.
#' @param graph \linkS4class{AmGraph}.
#' @param ... Other properties.
#' 
#' @rdname shared-generics
#' @export
#' 
setGeneric(name = "setGraph", def = function(.Object, graph = NULL, ...) {standardGeneric("setGraph")})

#' @details addGuide(...) is shared by AxisBase and AmChart.
#' @param guide \linkS4class{Guide}.
#' 
#' @rdname shared-generics
#' @export
#' 
setGeneric(name = "addGuide", def = function(.Object, guide = NULL, ...) {standardGeneric("addGuide")})

#' @details setText(...) is shared by Title and Label.
#' @param text \code{character}.
#' 
#' @rdname shared-generics
#' @export
#' 
setGeneric(name = "setText", def = function(.Object, text) {standardGeneric("setText")})

#' @details setValueAxis(...) is shared by AmChart(type = "gantt"), TrendLine and Guide.
#' @param valueAxis \linkS4class{ValueAxis}.
#' 
#' @rdname shared-generics
#' @export
#' 
setGeneric(name = "setValueAxis", def = function(.Object, valueAxis = NULL, ...) {standardGeneric("setValueAxis")})

Try the rAmCharts package in your browser

Any scripts or data that you put into this service are public.

rAmCharts documentation built on Dec. 6, 2019, 5:11 p.m.