mschart (version 0.5.1)

chart_ax_y: Y axis settings

Description

Define settings for a y axis. S3 generic; the default method is documented below. ChartEx charts have a leaner set of supported options - see the package documentation.

Usage

chart_ax_y(x, ...)
# S3 method for default
chart_ax_y(
  x,
  orientation,
  crosses,
  cross_between,
  major_tick_mark,
  minor_tick_mark,
  tick_label_pos,
  display,
  num_fmt,
  rotation,
  limit_min,
  limit_max,
  position,
  major_unit,
  minor_unit,
  major_time_unit,
  minor_time_unit,
  ...
)

Value

An ms_chart object.

Arguments

x

an ms_chart object.

...

arguments passed to S3 methods.

orientation

axis orientation, one of 'maxMin', 'minMax'.

crosses

specifies how the axis crosses the perpendicular axis, one of 'autoZero', 'max', 'min'.

cross_between

specifies how the value axis crosses the category axis between categories, one of 'between', 'midCat'.

major_tick_mark, minor_tick_mark

tick marks position, one of 'cross', 'in', 'none', 'out'.

tick_label_pos

ticks labels position, one of 'high', 'low', 'nextTo', 'none'.

display

should the axis be displayed (a logical of length 1).

num_fmt

number formatting. See the num_fmt section for more details.

rotation

rotation angle. Value should be between -360 and 360.

limit_min

minimum value on the axis. Date objects are also accepted and will be converted automatically.

limit_max

maximum value on the axis. Date objects are also accepted and will be converted automatically.

position

the value at which this axis crosses the perpendicular axis.

major_unit

numeric, interval between major ticks and gridlines.

minor_unit

numeric, interval between minor ticks and gridlines.

major_time_unit

time unit for major ticks on date axes, one of "days", "months", "years".

minor_time_unit

time unit for minor ticks on date axes, one of "days", "months", "years".

Illustrations

num_fmt

All % need to be doubled, 0%% means "a number and percent symbol".

To my current knowledge, depending on the chart type and options, the following values are not systematically used by office chart engine; i.e. when chart pre-compute percentages, it seems using 0%% will have no effect.

• General: default value

• 0: display the number with no decimal

• 0.00: display the number with two decimals

• 0%%: display as percentages

• 0.00%%: display as percentages with two decimal places

• #,##0

• #,##0.00

• 0.00E+00

• # ?/?

• # ??/??

• mm-dd-yy

• d-mmm-yy

• d-mmm

• mmm-yy

• h:mm AM/PM

• h:mm:ss AM/PM

• h:mm

• h:mm:ss

• m/d/yy h:mm

• #,##0 ;(#,##0)

• #,##0 ;[Red](#,##0)

• #,##0.00;(#,##0.00)

• #,##0.00;[Red](#,##0.00)

• mm:ss

• [h]:mm:ss

• mmss.0

• ##0.0E+0

• @

See Also

chart_ax_x(), ms_areachart(), ms_barchart(), ms_scatterchart(), ms_linechart()

Examples

library(officer)
library(mschart)

chart_01 <- ms_linechart(
  data = us_indus_prod,
  x = "date", y = "value",
  group = "type"
)
chart_01 <- chart_settings(chart_01, style = "marker")
chart_01 <- chart_ax_x(
  x = chart_01, num_fmt = "[$-fr-FR]mmm yyyy",
  limit_min = min(us_indus_prod$date),
  limit_max = as.Date("1992-01-01")
)
chart_01