35 lines
1.1 KiB
R
35 lines
1.1 KiB
R
% Generated by roxygen2: do not edit by hand
|
|
% Please edit documentation in R/apex-utils.R
|
|
\name{ax_title}
|
|
\alias{ax_title}
|
|
\title{Chart's title}
|
|
\usage{
|
|
ax_title(ax, text = NULL, align = NULL, margin = NULL, offsetX = NULL,
|
|
offsetY = NULL, floating = NULL, style = NULL, ...)
|
|
}
|
|
\arguments{
|
|
\item{ax}{A \code{apexcharts} \code{htmlwidget} object.}
|
|
|
|
\item{text}{Text to display as a title of chart.}
|
|
|
|
\item{align}{Alignment of subtitle relative to chart area. Possible Options: \code{"left"}, \code{"center"} and \code{"right"}.}
|
|
|
|
\item{margin}{Numeric. Vertical spacing around the title text.}
|
|
|
|
\item{offsetX}{Numeric. Sets the left offset for subtitle text.}
|
|
|
|
\item{offsetY}{Numeric. Sets the top offset for subtitle text}
|
|
|
|
\item{floating}{Logical. The floating option will take out the subtitle text from the chart area and make it float on top of the chart.}
|
|
|
|
\item{style}{List with two items: \code{fontSize} (Font Size of the title text) and \code{color} (Fore color of the title text).}
|
|
|
|
\item{...}{Additional parameters.}
|
|
}
|
|
\value{
|
|
A \code{apexcharts} \code{htmlwidget} object.
|
|
}
|
|
\description{
|
|
Chart's title
|
|
}
|