Skip to content

Update pycmap_histogram.rst #68

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_histogram.rst #68

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9433d31
Update pycmap_histogram.rst
MSchatzUW May 20, 2020
0da5b14
Update pycmap_histogram.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
6 changes: 1 addition & 5 deletions user_guide/API_ref/pycmap_api/data_vizualization/pycmap_histogram.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Histogram Plot
Creates a histogram graph for each variable according to the specified space-time constraints (dt1, dt2, lat1, lat2, lon1, lon2, depth1, depth2). Change the `APIs vizEngine`_ parameter if you wish to use a different visualization library.
Returns the generated graph objects in form of a 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 Down Expand Up @@ -60,7 +59,6 @@ Histogram Plot
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 Down Expand Up @@ -95,7 +93,7 @@ Histogram Plot

|

**Example 1:**
**Example 1**


This example creates three histogram graphs comparing dissolved oxygen
Expand Down Expand Up @@ -146,8 +144,6 @@ visualization library (plotly) which may be changed by:

<iframe src="../../../../_static/pycmap_tutorial_viz/html/histogram_oxygen_WOA_clim.html" frameborder = 0 height="420px" width="100%">></iframe>



.. code-block:: python

# here is how to modify a graph:
Expand Down