pygmt.Figure.shift_origin

Figure.shift_origin(xshift=None, yshift=None)[source]

Shift plot origin in x and/or y directions.

This method shifts plot origin relative to the current origin by (xshift, yshift) and optionally append the length unit (c, i, or p).

Prepend a to shift the origin back to the original position after plotting, prepend c to center the plot on the center of the paper (optionally add shift), prepend f to shift the origin relative to the fixed lower left corner of the page, or prepend r [Default] to move the origin relative to its current location.

Detailed usage at https://docs.generic-mapping-tools.org/latest/cookbook/options.html#plot-positioning-and-layout-the-x-y-options

Parameters

  • xshift (str) – Shift plot origin in x direction.

  • yshift (str) – Shift plot origin in y direction.

Notes

For GMT 6.1.0, this function can’t be used as the first plotting function of pygmt.Figure, since it relies the region and projection settings from previous commands.