pygmt.Figure.sca

Figure.sca(ax=None, **kwargs)

Set the current Axes instance to ax.

Before you start plotting you must first select the active subplot. Note: If any projection option is passed with ? as scale or width when plotting subplots, then the dimensions of the map are automatically determined by the subplot size and your region. For Cartesian plots: If you want the scale to apply equally to both dimensions then you must specify projection="x" [The default projection="X" will fill the subplot by using unequal scales].

Aliases:

  • A = fixedlabel

  • C = clearance

  • V = verbose

Parameters

  • ax (str) – row,col|index. Sets the current subplot until further notice. Note: First row or col is 0, not 1. If not given we go to the next subplot by order specified via autolabel in pygmt.Figure.subplot. As an alternative, you may bypass the sca mode and instead supply the common option ax**=[*row,col*] to the first plot command you issue in that subplot. GMT maintains information about the current figure and subplot. Also, you may give the one-dimensional *index* instead which starts at 0 and follows the row or column order set via **autolabel in pygmt.Figure.subplot.

  • fixedlabel (str) – Overrides the automatic labeling with the given string. No modifiers are allowed. Placement, justification, etc. are all inherited from how autolabel was specified by the initial pygmt.Figure.subplot command.

  • clearance (str) – [side]clearance. Reserve a space of dimension clearance between the margin and the subplot on the specified side, using side values from w, e, s, or n. The option is repeatable to set aside space on more than one side. Such space will be left untouched by the main map plotting but can be accessed by modules that plot scales, bars, text, etc. This setting overrides the common clearances set by clearance in the initial pygmt.Figure.subplot call.

  • verbose (str) –

    Select verbosity level [Default is w], which modulates the messages written to stderr. Choose among 7 levels of verbosity:

    • q - Quiet, not even fatal error messages are produced

    • e - Error messages only

    • w - Warnings [Default]

    • t - Timings (report runtimes for time-intensive algorthms);

    • i - Informational messages (same as “verbose=True”)

    • c - Compatibility warnings

    • d - Debugging messages

Examples using pygmt.Figure.sca