Skip to contents

Properties of layout.image.

Usage

add_layout_image(
  fig,
  arg = NULL,
  ...,
  layer = NULL,
  name = NULL,
  opacity = NULL,
  sizex = NULL,
  sizey = NULL,
  sizing = NULL,
  source = NULL,
  templateitemname = NULL,
  visible = NULL,
  x = NULL,
  xanchor = NULL,
  xref = NULL,
  y = NULL,
  yanchor = NULL,
  yref = NULL,
  row = NULL,
  col = NULL,
  secondary_y = NULL,
  exclude_empty_subplots = FALSE,
  skip_invalid = FALSE
)

go_layout_image(
  arg = NULL,
  ...,
  layer = NULL,
  name = NULL,
  opacity = NULL,
  sizex = NULL,
  sizey = NULL,
  sizing = NULL,
  source = NULL,
  templateitemname = NULL,
  visible = NULL,
  x = NULL,
  xanchor = NULL,
  xref = NULL,
  y = NULL,
  yanchor = NULL,
  yref = NULL,
  skip_invalid = FALSE
)

Arguments

fig

A go_figure object.

arg

Optional named list, or graph object of the same type, to initialise properties from (constructors). Named arguments take precedence.

...

Further properties, including nested properties in "magic underscore" form, e.g. marker_size = 10 for marker = list(size = 10). Property values may be one-sided formulas, evaluated in data for add_*() functions.

layer

Specifies whether images are drawn below or above traces. When `xref` and `yref` are both set to `paper`, image is drawn below the entire plot area. One of "below", "above".

name

When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template. String.

opacity

Sets the opacity of the image. Number in the interval [0, 1].

sizex

Sets the image container size horizontally. The image will be sized based on the `position` value. When `xref` is set to `paper`, units are sized relative to the plot width. When `xref` ends with ` domain`, units are sized relative to the axis width. Number.

sizey

Sets the image container size vertically. The image will be sized based on the `position` value. When `yref` is set to `paper`, units are sized relative to the plot height. When `yref` ends with ` domain`, units are sized relative to the axis height. Number.

sizing

Specifies which dimension of the image to constrain. One of "fill", "contain", "stretch".

source

Specifies the URL of the image to be used. The URL must be accessible from the domain where the plot code is run, and can be either relative or absolute. String.

templateitemname

Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`. String.

visible

Determines whether or not this image is visible. Logical.

x

Sets the image's x position. When `xref` is set to `paper`, units are sized relative to the plot height. See `xref` for more info Any value.

xanchor

Sets the anchor for the x position One of "left", "center", "right".

xref

Sets the images's x coordinate axis. If set to a x axis id (e.g. "x" or "x2"), the `x` position refers to a x coordinate. If set to "paper", the `x` position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by "domain" (separated by a space), the position behaves like for "paper", but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., "x2 domain" refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis. One of "paper", or a string matching "^x([2-9]|[1-9][0-9]+)?( domain)?$".

y

Sets the image's y position. When `yref` is set to `paper`, units are sized relative to the plot height. See `yref` for more info Any value.

yanchor

Sets the anchor for the y position. One of "top", "middle", "bottom".

yref

Sets the images's y coordinate axis. If set to a y axis id (e.g. "y" or "y2"), the `y` position refers to a y coordinate. If set to "paper", the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by "domain" (separated by a space), the position behaves like for "paper", but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., "y2 domain" refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis. One of "paper", or a string matching "^y([2-9]|[1-9][0-9]+)?( domain)?$".

row

Subplot grid row (figures created with make_subplots() only). May be "all" or a vector to address several cells.

col

Subplot grid column (figures created with make_subplots() only). May be "all" or a vector to address several cells.

secondary_y

If TRUE, use the secondary y axis of the subplot.

exclude_empty_subplots

If TRUE, skip subplots that have no traces or layout objects.

skip_invalid

If TRUE, silently drop invalid properties instead of raising an error.

Value

Each go_*() function returns a graph object of the same class as its name; add_*() functions return the modified figure.

Details

go_layout_image() create validated graph objects (named lists). Every property is checked against the plotly.js schema when an object is created or modified (see plotly_obj-modify()). add_layout_image() creates an object and adds it to a figure.

See also