Skip to content

Commit 783610f

Browse files
Copilotseisman
andauthored
Figure.grdview: Migrate cmap alias to the new alias system (#4443)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
1 parent a885d75 commit 783610f

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

pygmt/src/grdview.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,11 @@ def _alias_option_Q( # noqa: N802
114114
@deprecate_parameter("facadepen", "facade_pen", "v0.18.0", remove_version="v0.20.0")
115115
@deprecate_parameter("meshpen", "mesh_pen", "v0.18.0", remove_version="v0.20.0")
116116
@deprecate_parameter("drapegrid", "drape_grid", "v0.18.0", remove_version="v0.20.0")
117-
@use_alias(C="cmap", I="shading", f="coltypes", n="interpolation")
117+
@use_alias(I="shading", f="coltypes", n="interpolation")
118118
def grdview( # noqa: PLR0913
119119
self,
120120
grid: PathLike | xr.DataArray,
121+
cmap: str | None = None,
121122
drape_grid: PathLike | xr.DataArray | None = None,
122123
surftype: Literal[
123124
"mesh", "surface", "surface+mesh", "image", "waterfall_x", "waterfall_y"
@@ -157,6 +158,7 @@ def grdview( # noqa: PLR0913
157158
158159
$aliases
159160
- B = frame
161+
- C = cmap
160162
- G = drape_grid
161163
- J = projection
162164
- Jz = zscale
@@ -175,7 +177,7 @@ def grdview( # noqa: PLR0913
175177
Parameters
176178
----------
177179
$grid
178-
cmap : str
180+
cmap
179181
The name of the color palette table to use.
180182
drapegrid
181183
The grid (a file name or a :class:`xarray.DataArray`) or image to be draped on
@@ -296,6 +298,7 @@ def grdview( # noqa: PLR0913
296298
plane = grdinfo(grid, per_column=True).split()[4]
297299

298300
aliasdict = AliasSystem(
301+
C=Alias(cmap, name="cmap"),
299302
Jz=Alias(zscale, name="zscale"),
300303
JZ=Alias(zsize, name="zsize"),
301304
Q=_alias_option_Q(

0 commit comments

Comments
 (0)