Skip to contents

Set Up a Three-Dimensional Scatter Configuration

Usage

setup_Scatter3DConfig(
  x = NULL,
  y = NULL,
  z = NULL,
  group = NULL,
  alpha = 20,
  beta = 40,
  view_size = 190,
  point_size = 8,
  opacity = 0.8,
  xlab = NULL,
  ylab = NULL,
  zlab = NULL,
  palette = NULL,
  title = NULL,
  dat_path = NULL,
  origin = NULL,
  writer = NULL,
  mode = "points",
  order = "input",
  line_width = 2
)

Arguments

x, y, z

Optional Character: Numeric coordinate column bindings.

group

Optional Character: Group column binding.

alpha

Numeric [-80, 80]: Camera elevation in degrees.

beta

Numeric [-180, 180]: Camera azimuth in degrees.

view_size

Numeric [175, 400]: Orthographic viewing extent for a 100-unit cube.

point_size

Numeric (0, 100]: Marker diameter in pixels.

opacity

Numeric [0, 1]: Point and line opacity.

xlab, ylab, zlab

Optional Character: Axis names.

palette

Optional Character: Group colors.

title

Optional Character: Chart title. Declared here because it is the one property every chart type has; palette is not (four take a colormap instead), and axis labels and margins are cartesian-only.

dat_path

Optional Character: Path to the data, read at draw time. The serializable alternative to passing data to draw().

origin

Optional Named character {"user", "default", "derived"}: Where each value came from, one entry per settable property. Absent on an authored config; written by the interface that resolved it.

writer

Optional Named character: Which interface wrote the config, as name and version. Absent on an authored config.

mode

Character c("points", "lines", "both"): Geometry to draw.

order

Character c("input", "x"): Order within complete path runs. Missing coordinates break paths; sorting never joins across those breaks.

line_width

Numeric (0, 100]: Path width in pixels.

Value

Scatter3DConfig: Validated settings.

Examples

draw(setup_Scatter3DConfig(x = "Sepal.Length", y = "Sepal.Width",
  z = "Petal.Length", group = "Species"), data = iris)