R/class_Label.R

In DataKnowledge/rAmCharts: JavaScript Charts Tool

#' @include class_AmObject.R utils_sharedGenerics.R
NULL

#' @title Label class
#' @author datastorm-open
#' 
#' @description Creates a label on the chart which can be placed anywhere, multiple can be assigned.
#' @details Run \code{api("Label")} for more information and all avalaible properties.
#' 
#' @slot bold \code{character}. Specifies if label is bold or not.
#' @slot text \code{character}. Text of a title.
#' @slot x \code{numeric}. X position of a label.
#' @slot y \code{numeric}. Y position of a label.
#' @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}.
#' 
#' @export
setClass(Class = "Label", contains = "AmObject",
         representation = representation(
           text = "character",
           bold = "logical",
           x = "numericOrCharacter",
           y = "numericOrCharacter"))

#' @title Initializes Label
#' @description Uses the constructor to create the object
#' or update an existing one with the setters.
#' 
#' @param .Object \linkS4class{Label}.
#' @param bold \code{character}, specifies if label is bold or not.
#' @param text \code{character}, text of a title.
#' @param x \code{numeric}, label's x position.
#' @param y \code{numeric}, label's y position.
#' @param ... other properties of Label.
#' 
#' @return (updated) .Object of class \linkS4class{Label}.
#' 
#' @examples
#' # --- method initialize
#' new("Label", x = 10)
#' 
#' @export
#' @rdname Label
#' 
setMethod(f = "initialize", signature = "Label",
          definition = function(.Object, text, bold, x, y, ...)
          {  
            if (!missing(text)) {
              .Object@text <- text
            } else {}
            if (!missing(bold)) {
              .Object@bold <- bold
            } else {}
            if (!missing(x)) {
              .Object@x <- x
            } else {}
            if (!missing(y)) {
              .Object@y <- y
            } else {}
            .Object <- setProperties(.Object, ...)
            validObject(.Object)
            return(.Object)
          })

#' @rdname  Label
#' 
#' @examples
#' # --- constructor
#' label(text = "bonjour")
#' label(text = "Male", x = "28%", y = "97%")
#' 
#' @export
#' 
label <- function(text, bold, x, y, ...){
  .Object <- new("Label")
  if (!missing(text)) {
    .Object@text <- text
  } else {}
  if (!missing(bold)) {
    .Object@bold <- bold
  } else {}
  if (!missing(x)) {
    .Object@x <- x
  } else {}
  if (!missing(y)) {
    .Object@y <- y
  } else {}
  .Object <- setProperties(.Object, ...)
  validObject(.Object)
  return( .Object )
}

# > @bold : setters ####

#' @rdname Label
#' @export
setGeneric(name = "setBold", def = function(.Object, bold){ standardGeneric("setBold") } )
#' @examples
#' # --- update property 'bold'
#' setBold(.Object = label(), bold = TRUE)
#' 
#' @rdname Label
setMethod(f = "setBold", signature = c("Label", "logical"),
          definition = function(.Object, bold)
          {
            .Object@bold <- bold
            validObject(.Object)
            return(.Object)
          })

# > @text : setters ####

#' @examples
#' # --- update 'text'
#' setText(.Object = label(), text = "Bonjour")
#' 
#' @rdname Label
setMethod(f = "setText", signature = c("Label", "character"),
          definition = function(.Object, text)
          {
            .Object@text <- text
            validObject(.Object)
            return(.Object)
          })

# > @x : setters ####

#' @rdname Label
#' @export
setGeneric(name = "setX", def = function(.Object, x){ standardGeneric("setX") } )
#' @examples
#' # --- update 'x'
#' setX(.Object = label(), x = 16)
#' 
#' @rdname Label
#' 
setMethod(f = "setX", signature = c("Label", "numericOrCharacter"),
          definition = function(.Object, x)
          {
            .Object@x <- x
            validObject(.Object)
            return(.Object)
          })

# > @y : setters ####

#' @rdname Label
#' @export
setGeneric(name = "setY", def = function(.Object, y){ standardGeneric("setY") } )
#' @examples
#' # --- update 'y'
#' setY(.Object = label(), y = 16)
#' 
#' @rdname Label
#' 
setMethod(f = "setY", signature = c("Label", "numericOrCharacter"),
          definition = function(.Object, y)
          {
            .Object@y <- y
            validObject(.Object)
            return(.Object)
          })