Create an Encharter Chart

Factory function that initialises an R6 chart object. Returns a Chart object for standard OOXML chart types (bar, line, scatter, …) or a ChartEx object for modern extended chart types (waterfall, treemap, …).

The `Chart` class provides a flexible interface to build Office OpenXML (OOXML) chart objects. It allows for granular control over gridlines, secondary axes, and combined chart types (e.g., Bar and Line) within a single plot area.

An R6 class to create and manipulate Office OpenXML (OOXML) Extended Charts (ChartEx), including Waterfall, Sunburst, Treemap, and Region Maps, which are not supported by standard Office Open XML chart types.

encharter(type = "lineChart")

ec(type = "lineChart")

Arguments

type

A character string specifying the chart type. Common R-style aliases are accepted (see Details).

Value

An R6 object of class Chart or ChartEx.

Details

Supported Chart Types:

• Bar/Column: "barChart", "barplot", "hist", "histogram"

• Line/Area: "lineChart", "line", "areaChart", "area"

• Scatter: "scatterChart", "scatter", "point"

• Pie/Doughnut: "pieChart", "pie", "doughnutChart", "doughnut"

• Extended (ChartEx): "waterfall", "treemap", "sunburst", "regionMap", "boxWhisker" / "boxplot", "funnel"

Bar vs Column direction: For bar/column charts, orientation is set via the dir argument in $add_series(): "col" (vertical, default) or "bar" (horizontal).

This class is designed to work with the `openxlsx2` package by generating the underlying XML required for the add_chart_xml method.

This class uses XML to manipulate the underlying XML structure and integrates with `openxlsx2` for workbook generation.

Super class

EncharterBase -> Chart

Public fields

x2_title

List containing text and style for the secondary X-axis.

y2_title

List containing text and style for the secondary Y-axis.

first_slice_ang

Integer. Rotation of the first slice (0-360).

expansion

Integer. Size of the expansion for pie charts.

hole_size

Integer. Size of the hole for doughnut charts (0-90).

show_data_table

Logical if a data table should be added.

drop_lines

Logical; show lines from points to the axis.

high_low_lines

Logical; show lines between max/min points.

up_down_bars

Logical; show bars between first and last series.

bubble_scale

Numeric; the scale factor for bubbles (default 100).

show_neg_bubbles

Logical; whether to show bubbles with negative values.

disp_blanks_as

Character; "gap", "span", or "zero".

Methods

Public methods

• Chart$new()

• Chart$set_x2_title()

• Chart$set_y2_title()

• Chart$set_y2_axis()

• Chart$set_x2_axis()

• Chart$set_data_table()

• Chart$set_pie_options()

• Chart$set_bubble_options()

• Chart$set_disp_blanks()

• Chart$add_series()

• Chart$render()

• Chart$clone()

Inherited methods

• EncharterBase$print()
• EncharterBase$set_chart_style()
• EncharterBase$set_chart_title()
• EncharterBase$set_data_label_style()
• EncharterBase$set_legend_style()
• EncharterBase$set_plot_style()
• EncharterBase$set_x_axis()
• EncharterBase$set_x_title()
• EncharterBase$set_y_axis()
• EncharterBase$set_y_title()

---

Chart$new()

Initialize a new Chart object.

Usage

Chart$new(type = NULL)

Arguments

type

Initial chart type (e.g., "lineChart", "barChart", "pieChart").

---

Chart$set_x2_title()

Set the secondary X-axis title.

Only takes effect if at least one series has been assigned to the secondary X-axis via add_series(secondary = "x"). Issues a warning and returns self silently otherwise.

Usage

Chart$set_x2_title(
  text,
  font_size = NULL,
  font_name = NULL,
  font_color = NULL,
  bold = NULL,
  italic = NULL,
  fill = NULL,
  line = NULL,
  line_width = NULL
)

Arguments

text

Title string.

font_size

Numeric font size in points.

font_name

Font typeface name.

font_color

Six-digit hex color for the title text.

bold, italic

Logical font style.

fill

Six-digit hex color for the title background box.

line

Six-digit hex color for the title border.

line_width

Numeric border width in points.

Examples

ec("scatter") |>
  add_series(data = "Sheet1!A1:A10", secondary = "x") |>
  set_x2_title("Secondary X", font_color = "888888")

---

Chart$set_y2_title()

Set the secondary Y-axis title.

Only takes effect if at least one series has been assigned to the secondary Y-axis via add_series(secondary = TRUE) or secondary = "y". Issues a warning otherwise.

Usage

Chart$set_y2_title(
  text,
  font_size = NULL,
  font_name = NULL,
  font_color = NULL,
  bold = NULL,
  italic = NULL,
  fill = NULL,
  line = NULL,
  line_width = NULL
)

Arguments

text

Title string.

font_size

Numeric font size in points.

font_name

Font typeface name.

font_color

Six-digit hex color for the title text.

bold, italic

Logical font style.

fill

Six-digit hex color for the title background box.

line

Six-digit hex color for the title border.

line_width

Numeric border width in points.

Examples

ec("line") |>
  add_series(data = "Sheet1!A1:A10") |>
  add_series(data = "Sheet1!B1:B10", secondary = TRUE) |>
  set_y2_title("Growth Rate (%)")

---

Chart$set_y2_axis()

Set Secondary Y-axis scaling, units, and format.

Usage

Chart$set_y2_axis(
  min = NULL,
  max = NULL,
  major = NULL,
  minor = NULL,
  major_time = NULL,
  minor_time = NULL,
  base_time = NULL,
  major_tick = NULL,
  minor_tick = NULL,
  format = NULL,
  log_base = NULL,
  color = NULL,
  font_name = NULL,
  font_size = NULL,
  bold = NULL,
  italic = NULL,
  font_color = NULL,
  rot = NULL,
  grid_color = NULL,
  gridlines = NULL,
  minor_grid_color = NULL,
  minor_gridlines = NULL,
  cross_between = NULL,
  line_width = NULL,
  grid_width = NULL,
  minor_grid_width = NULL,
  crosses = "max",
  crosses_at = NULL,
  label_pos = NULL
)

Arguments

min

Minimum value for the axis.

max

Maximum value for the axis.

major

Numeric value for major unit interval.

minor

Numeric value for minor unit interval.

major_time

Time unit for major steps ("days", "months", "years"). Used for date axes.

minor_time

Time unit for minor steps ("days", "months", "years"). Used for date axes.

base_time

Base time unit for date axes ("days", "months", "years").

major_tick, minor_tick

Tick marks for major and minor ("cross", "in", "none", "out").

format

A number format string (e.g., "#,##0" or "yyyy-mm-dd").

log_base

Base for logarithmic scaling (e.g., 10).

color, font_color

Hex color for the axis lines and label (or independent label color).

font_name

Font typeface name (e.g., "Arial", "Calibri").

font_size

Font size for the axis labels.

bold

Logical; if `TRUE`, axis labels will be bold.

italic

Logical; if `TRUE`, axis labels will be italicized.

rot

Rotation in degrees.

grid_color, minor_grid_color

Hex color for the gridlines.

gridlines, minor_gridlines

Logical. Show or hide gridlines.

cross_between

Specifies how the value axis crosses the category axis ('between' or 'midCat').

line_width, grid_width, minor_grid_width

Numeric. Change the width of the axis and gridlines.

crosses

Intersection: "autoZero" (default), "min" (start), or "max" (end).

crosses_at

Numeric axis value for intersection. Overrides 'crosses'.

label_pos

Label position: "nextTo" (default), "low" (edge of chart), "high" (opposite edge), or "none".

---

Chart$set_x2_axis()

Set Secondary X-axis scaling, units, and format.

Usage

Chart$set_x2_axis(
  min = NULL,
  max = NULL,
  major = NULL,
  minor = NULL,
  major_time = NULL,
  minor_time = NULL,
  base_time = NULL,
  major_tick = NULL,
  minor_tick = NULL,
  format = NULL,
  log_base = NULL,
  color = NULL,
  font_name = NULL,
  font_size = NULL,
  bold = NULL,
  italic = NULL,
  font_color = NULL,
  rot = NULL,
  grid_color = NULL,
  gridlines = NULL,
  minor_grid_color = NULL,
  minor_gridlines = NULL,
  cross_between = NULL,
  line_width = NULL,
  grid_width = NULL,
  minor_grid_width = NULL,
  crosses = "max",
  crosses_at = NULL,
  label_pos = NULL
)

Arguments

min

Minimum value for the axis.

max

Maximum value for the axis.

major

Numeric value for major unit interval.

minor

Numeric value for minor unit interval.

major_time

Time unit for major steps ("days", "months", "years"). Used for date axes.

minor_time

Time unit for minor steps ("days", "months", "years"). Used for date axes.

base_time

Base time unit for date axes ("days", "months", "years").

major_tick, minor_tick

Tick marks for major and minor ("cross", "in", "none", "out").

format

A number format string (e.g., "#,##0" or "yyyy-mm-dd").

log_base

Base for logarithmic scaling (e.g., 10).

color, font_color

Hex color for the axis lines and label (or independent label color).

font_name

Font typeface name (e.g., "Arial", "Calibri").

font_size

Font size for the axis labels.

bold

Logical; if `TRUE`, axis labels will be bold.

italic

Logical; if `TRUE`, axis labels will be italicized.

rot

Rotation in degrees.

grid_color, minor_grid_color

Hex color for the gridlines.

gridlines, minor_gridlines

Logical. Show or hide gridlines.

cross_between

Specifies how the value axis crosses the category axis ('between' or 'midCat').

line_width, grid_width, minor_grid_width

Numeric. Change the width of the axis and gridlines.

crosses

Intersection: "autoZero" (default), "min" (start), or "max" (end).

crosses_at

Numeric axis value for intersection. Overrides 'crosses'.

label_pos

Label position: "nextTo" (default), "low" (edge of chart), "high" (opposite edge), or "none".

---

Chart$set_data_table()

Set the data table.

Usage

Chart$set_data_table(show = TRUE)

Arguments

show

Logical TRUE or FALSE.

---

Chart$set_pie_options()

Usage

Chart$set_pie_options(rotation = NULL, expansion = NULL, hole_size = NULL)

Arguments

rotation

The angle of the first slice in degrees, from 0 to 360. This rotates the chart clockwise.

expansion

Sets the expansion, from 0 to 400.

hole_size

Set the hole size of (only doughnut charts), from 0 to 90.

---

Chart$set_bubble_options()

Usage

Chart$set_bubble_options(scale = 100, show_neg = FALSE)

Arguments

scale

The scale factor for bubbles, from 0 to 300 (expressed as a percentage).

show_neg

Logical; if `TRUE`, bubbles with negative values will be displayed on the chart.

---

Chart$set_disp_blanks()

Set missing value behavior ("gap", "span", "zero").

Usage

Chart$set_disp_blanks(val = "gap")

Arguments

val

Character. One of "gap" (break), "span" (continue), or "zero" (drop).

---

Chart$add_series()

Add a data series to the chart with independent styling.

Usage

Chart$add_series(
  header = NULL,
  data,
  cat = NULL,
  z_data = NULL,
  color = "4472C4",
  type = NULL,
  secondary = FALSE,
  dir = "col",
  grouping = "standard",
  overlap = NULL,
  gap_width = NULL,
  smooth = FALSE,
  show_line = TRUE,
  marker = "none",
  marker_size = 5,
  marker_fill = NULL,
  marker_line = NULL,
  marker_line_width = 0.75,
  show_val = NULL,
  show_cat = NULL,
  line_type = NULL,
  line_width = 1,
  line_color = NULL,
  filled = FALSE,
  error_bars = FALSE,
  trendline = FALSE
)

Arguments

header

Cell range or string for series name.

data

Cell range for series values.

cat

Cell range for category labels.

z_data

Cell range for bubble sizes (bubbleChart only).

color

Primary Hex color for the series (used as default for line and markers).

type

Chart type for this specific series (for combo charts).

secondary

Logical. Set to TRUE to move series to secondary axis.

dir

Bar direction ("col" or "bar").

grouping

Chart grouping ("standard", "stacked", "percentStacked").

overlap

Integer between -100 and 100 for bar charts.

gap_width

Integer between 0 and 500 for bar charts.

smooth

Logical. Enable line smoothing for line/scatter charts.

show_line

Logical. Show the line connecting points.

marker

Marker type ("none", "circle", "square", "diamond", "triangle").

marker_size

Integer size of marker.

marker_fill

Hex color for the interior of the marker. Defaults to `color`.

marker_line

Hex color for the marker border. Defaults to `color`.

marker_line_width

Numeric width of the marker border.

show_val

Logical. Override global label settings for this series (show value).

show_cat

Logical. Override global label settings for this series (show category).

line_type

Line style: "dashed", "dotted", "dashDot", or "solid".

line_width

Numeric width of the connecting line.

line_color

Hex color for the connecting line. Defaults to `color`.

filled

Logical; for radar charts, fills the interior area. Default FALSE.

error_bars

A list of error bar properties:

• type: The error value type (ST_ErrValType). Must be one of: "fixedVal" (Fixed Value), "percentage" (Percentage), "stdDev" (Standard Deviation), "stdErr" (Standard Error), or "cust" (Custom).

• value: The numeric value for the error bars (e.g., 10 for 10

• direction: Direction of bars. One of "both", "plus", or "minus".

• color: Hex color code for the bars (e.g., "FF0000").

trendline

A list of regression line properties:

• type: The regression type (ST_TrendlineType). Must be one of: "linear" (Linear), "exp" (Exponential), "log" (Logarithmic), "movingAvg" (Moving Average), "poly" (Polynomial), or "power" (Power).

• order: Required for "poly"; an integer between 2 and 6.

• period: Required for "movingAvg"; an integer representing the window size.

• color: Hex color code for the line.

• show_r2: Logical; if TRUE, displays the R-squared value on the chart.

---

Chart$render()

Generate the final XML string for the chart.

Usage

Chart$render(
  u_ids = c("53178645", "60812428", "64752656", "81893617", "90007639")
)

Arguments

u_ids

five unique ids

Returns

A character string containing the OOXML chart definition.

---

Chart$clone()

The objects of this class are cloneable with this method.

Usage

Chart$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Super class

EncharterBase -> ChartEx

Public fields

color_xml

color

style_xml

style

Methods

Public methods

• ChartEx$new()

• ChartEx$add_series()

• ChartEx$render()

• ChartEx$clone()

Inherited methods

• EncharterBase$print()
• EncharterBase$set_chart_style()
• EncharterBase$set_chart_title()
• EncharterBase$set_data_label_style()
• EncharterBase$set_legend_style()
• EncharterBase$set_plot_style()
• EncharterBase$set_x_axis()
• EncharterBase$set_x_title()
• EncharterBase$set_y_axis()
• EncharterBase$set_y_title()

---

ChartEx$new()

Create a new ChartEx object.

Usage

ChartEx$new(type = NULL)

Arguments

type

Initial chart type (e.g., "waterfall", "treemap").

Returns

A new `ChartEx` object.

---

ChartEx$add_series()

Add a data series to the chart.

Usage

ChartEx$add_series(
  header = NULL,
  data,
  cat = NULL,
  type = NULL,
  color = "auto",
  line_color = NULL,
  line_width = 1,
  gap_width = NULL,
  subtotals = NULL,
  statistics = NULL,
  binning = NULL,
  visibility = NULL,
  parent_label = "overlapping"
)

Arguments

header

Cell range for the series name.

data

Cell range for the numeric values.

cat

Cell range for the category labels.

type

Type of chart (waterfall, sunburst, treemap, regionMap).

color

Hex color or "auto".

line_color

Border color.

line_width

Border width.

gap_width

Integer between 0 and 500.

subtotals

Numeric vector of indices to treat as subtotals (Waterfall only).

statistics

Quartile method: "inclusive" or "exclusive".

binning

A list for Histogram/BoxWhisker: `binSize` (numeric), `binCount` (integer), `intervalClosed` ("left", "right"), `underflow` (numeric or "auto"), `overflow` (numeric or "auto").

visibility

A named list of logicals for BoxWhisker/Waterfall: `connectorLines`, `meanLine`, `meanMarker`, `nonoutliers`, `outliers`.

parent_label

Treemap label style: "overlapping", "banner", or "none".

---

ChartEx$render()

Render the internal XML for writing to a file.

Usage

ChartEx$render(id_start = 1, guid = "{C59B1284-E301-0D0F-1B20-FD96A66D6E43}")

Arguments

id_start

Numeric starting ID for XML data references.

guid

a guid

Returns

A list containing the XML and attribute mappings.

---

ChartEx$clone()

The objects of this class are cloneable with this method.

Usage

ChartEx$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# Standard line chart
ec("lineChart")
#> An encharter object
#> Number of Series: 0 

# Extended waterfall chart
ec("waterfall")
#> An encharter object
#> Number of Series: 0 

# R-style alias
ec("barplot")
#> An encharter object
#> Number of Series: 0 


## ------------------------------------------------
## Method `Chart$set_x2_title()`
## ------------------------------------------------

if (FALSE) { # \dontrun{
ec("scatter") |>
  add_series(data = "Sheet1!A1:A10", secondary = "x") |>
  set_x2_title("Secondary X", font_color = "888888")
} # }

## ------------------------------------------------
## Method `Chart$set_y2_title()`
## ------------------------------------------------

if (FALSE) { # \dontrun{
ec("line") |>
  add_series(data = "Sheet1!A1:A10") |>
  add_series(data = "Sheet1!B1:B10", secondary = TRUE) |>
  set_y2_title("Growth Rate (%)")
} # }