chart_ax_x: x axis settings

View source: R/axis_setting.R

chart_ax_xR Documentation

x axis settings

Description

Define settings for an x axis.

Usage

chart_ax_x(
  x,
  orientation,
  crosses,
  cross_between,
  major_tick_mark,
  minor_tick_mark,
  tick_label_pos,
  display,
  num_fmt,
  rotation,
  limit_min,
  limit_max,
  position,
  second_axis = FALSE
)

Arguments

x

an ms_chart object.

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 section for more details.

rotation

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

limit_min

minimum value on the axis.

limit_max

maximum value on the axis.

position

position value that cross the other axis.

second_axis

unused

num_fmt

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

From my actual knowledge, depending on some 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 digits

  • #,##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

  • @

Illustrations

See Also

chart_ax_y(), ms_areachart(), ms_barchart(), ms_scatterchart(), ms_linechart()

Examples

library(mschart)

chart_01 <- ms_linechart(
  data = us_indus_prod,
  x = "date", y = "value",
  group = "type"
)

chart_01 <- chart_ax_y(x = chart_01, limit_min = 20, limit_max = 120)
chart_01

mschart documentation built on Dec. 1, 2022, 1:32 a.m.