R/class_DataSetSelector.R

In rAmCharts: JavaScript Charts Tool

#' @include class_AmObject.R
NULL

#' @title DataSetSelector class
#' 
#' @description DataSetSelector is a tool used to select data sets
#' as main and to compare to main data set.
#' 
#' @slot position \code{character}.
#' Possible values: "right", "left", "top", "bottom".
#' "top" and "bottom" positions has a limitation -
#' only one data set can be selected for comparing.
#' @slot listeners \code{list} containining the listeners to add to the object.
#' The list must be named as in the official API. Each element must be a character string.
#' @slot otherProperties \code{list}
#' containing other avalaible properties not yet implemented in the package.
#' @slot value \code{numeric}.
#' 
#' @details Run \code{api("DataSetSelector")} for more information and all avalaible properties.
#' @author datastorm-open
#' 
#' @export
#' 
setClass(Class = "DataSetSelector", contains = "AmObject",
         representation = representation(position = "character"))

#' @title Creates or updates a DataSetSelector
#' @description Use the constructors to create the object with its properties
#' or update an existing one with the setters.
#' 
#' @param .Object \linkS4class{DataSetSelector}.
#' @param position \code{character}.
#' Possible values: "right", "left", "top", "bottom".
#' "top" and "bottom" positions has a limitation -
#' only one data set can be selected for comparison.
#' @param ... other properties of DataSetSelector.
#' @return (updated) \linkS4class{DataSetSelector}.
#' @examples
#' new("DataSetSelector", size = 10)
#' 
#' @rdname DataSetSelector
#' @export
#' 
setMethod(f = "initialize", signature = "DataSetSelector",
          definition = function(.Object, position, ...)
          {  
            if (!missing(position)) {
              .Object <- setPosition(.Object, position)
            } else {}
            
            .Object <- setProperties(.Object, ...)
            validObject(.Object)
            return(.Object)
          })

#' @rdname DataSetSelector
#' @examples
#' dataSetSelector(position = "left")
#' @export
#' 
dataSetSelector <- function(position, ...) {
  .Object <- new("DataSetSelector")
  
  if (!missing(position)) {
    .Object <- setPosition(.Object, position)
  } else {}
  
  .Object <- setProperties(.Object, ...)
  validObject(.Object)
  return(.Object)
}

#' @rdname DataSetSelector
#' @export
#' 
setGeneric(name = "setPosition", def = function(.Object, position) {standardGeneric("setPosition")})
#' @rdname DataSetSelector
#' @examples
#' setPosition(.Object = dataSetSelector(), position = "left")
#' 
setMethod(f = "setPosition", signature = c("DataSetSelector", "character"),
          definition = function(.Object, position)
          {
            .Object@position <- position
            validObject(.Object)
            return(.Object)
          })