Skip to content

Update pycmap_section_map_contour.rst #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MSchatzUW wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update pycmap_section_map_contour.rst #71

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4340ea
Update pycmap_section_map_contour.rst
MSchatzUW May 20, 2020
4ed9820
Update pycmap_section_map_contour.rst
MSchatzUW May 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions user_guide/API_ref/pycmap_api/data_vizualization/pycmap_section_map_contour.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ Section Map, Section Contour
python list. One may use the returned objects to modify the graph
properties.


.. note::
This method requires a valid `API key`_. It is not necessary to set the
API key every time because the API properties are stored locally after
Expand All @@ -60,9 +59,7 @@ Section Map, Section Contour
**variable: list of string**
Variable short name which directly corresponds to a field name in the table. A full list of variable short names can be found in :ref:`Catalog`.
**dt1: string**
Start date or datetime. This parameter sets the lower bound of the temporal cut.

Example values: '2016-05-25' or '2017-12-10 17:25:00'.
Start date or datetime. This parameter sets the lower bound of the temporal cut. Example values: '2016-05-25' or '2017-12-10 17:25:00'.
**dt2: string**
End date or datetime. This parameter sets the upper bound of the temporal cut. Example values: '2016-05-25' or '2017-12-10 17:25:00'.
**lat1: float**
Expand All @@ -79,8 +76,6 @@ Section Map, Section Contour
End depth [m]. This parameter sets the upper bound of the vertical cut. Note depth is a positive number (it is 0 at the surface and increases towards the ocean floor).
**exportDataFlag: boolean, default: False**
If True, the graph data points are stored on the local machine. The export path and file format are set by the `APIs parameters`_.


**show: boolean, default: True**
If True, the graph object is returned and is displayed. The graph file is saved on the local machine at the figureDir directory.
If False, the graph object is returned but not displayed.
Expand All @@ -90,9 +85,9 @@ Section Map, Section Contour



:returns: list of graph objects
:returns: A list of graph objects.

A list of graph objects. Below are the graph's properties and methods.
Below are the graph's properties and methods.

:Properties:
**data: dataframe**
Expand All @@ -101,6 +96,7 @@ Section Map, Section Contour
Number of contour levels. Only applicable to plotly.
**cmap: str or cmocean colormap**
Colormap name. Any matplotlib (e.g. 'viridis', ..) or cmocean (e.g. cmocean.cm.thermal, ..) colormaps can be passed to this property. A full list of matplotlib and cmocean color palettes can be found at the following links:

https://matplotlib.org/3.1.0/tutorials/colors/colormaps.html

https://matplotlib.org/cmocean/
Expand Down