Figure.colorbar: Add position/length/width and more parameters to specify colorbar position and properties

[seisman]

Modifiers	PyGMT	GMT	GMT.jl
[g|j|J|n|x]<refpoint>[+j<justify>][+o<dx>[/<dy>]]	position	-	-
+w<length>[/<width>]]	length/width	size	size
[+e[b|f][<length>]]	fg_triangle/bg_triangle/triangle_height	triangles	triangles
[+h|v]	oriention="horizontal" or "vertical"	horizontal,vertical	horizontal
[+n|N[<txt>]]	nan/nan_position	nan	nan
[+r]	reverse	reverse	Give a negative length to reverse the scale bar

References

• GMT long-form names: https://github.com/GenericMappingTools/gmt/blob/0b754730b7b062d12e8142e9ea032d556f3bf58f/src/longopt/psscale_inc.h#L29-L31
• GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/colorbar.html

Preview: https://pygmt-dev--4048.org.readthedocs.build/en/4048/api/generated/pygmt.Figure.colorbar.html#pygmt.Figure.colorbar

[yvonnefroehlich]

I feel it would be good to add an alias for -S,

-S[+aangle][+c|n][+r][+s][+xlabel][+yunit]

as I realized that this flags allows to set x and y labels in case frame (-B) cannot be used, e.g., if equalsize (-L) is used.
I am wondering if adding an alias, e.g., appearance, using the old alias system still makes sense or if we should do this directly using the new alias system to introduce aliases for the single modifieres.

[yvonnefroehlich]

Just one small typo for now, will look at this PR in detail today or tomorrow.

[seisman]

Perhaps shorter names nan and nan_position are better?

[yvonnefroehlich]

I think nan_position (or nan_side) is fine.

[seisman]

I've renamed them to nan/nan_position in 57f8c39.

[seisman]

The names are also a little too long. It's also unclear what sidebar means. What about fg_triangle/bg_triangle and triangle_height?

[yvonnefroehlich]

Agree that these names are a bit long. fg_trinagle and bg_triangle would mean we have two parameters, correct? Maybe cb_triangles; "cb" for "colorbar", which is clearer as "sidebar"?

[seisman]

I feel cb_triangles is a bad name for two reasons:

• It's unclear what cb stands for
• This is a parameter for Figure.colorbar, so the prefix cb (short for colorbar) is a little duplicate

[seisman]

What about fgcolor/bgcolor, which fgcolor=True/bgcolor=True means draw a triangle for foreground/background color.

fgcolor/bgcolor are also used in the Pattern class, but it takes a color, not a boolean value.

Edit: fgcolor/bgcolor may be good names, but it would be unclear what triangle_height means.

So, I still prefer fg_triangle/bg_triangle/triangle_height.

[seisman]

I've renamed them to fg_triangle/bg_triangle/triangle_height in 405383c.