Skip to content

Commit

Permalink
view.export: cytoscape 3.7.1
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeboucas committed Feb 5, 2019
1 parent 38ae386 commit 6b12af5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
5 changes: 4 additions & 1 deletion docs/cyrest/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ___

## ***cyclient.view.export***

**`cyclient.view.export(self, Height=None, options=None, OutputFile=None, Resolution=None, Units=None, Width=None, Zoom=None, verbose=False)`**
**`cyclient.view.export(self, Height=None, options=None, OutputFile=None, Resolution=None, Units=None, Width=None, Zoom=None, view="current", verbose=False)`**

Exports the current view to a graphics file and returns the path to the
saved file. PNG and JPEG formats have options for scaling, while other
Expand Down Expand Up @@ -105,6 +105,9 @@ only for bitmap formats, such as PNG and JPEG.
* **`Zoom (string, optional)`** The zoom value to proportionally scale
the image. The default value is 100.0. Valid only for bitmap formats,
such as PNG and JPEG
* **`view (string, optional)`** Specifies a network view by name, or by
SUID if the prefix SUID: is used. The keyword CURRENT, or a blank value
can also be used to specify the current network view.
* **`verbose`** print more

* **`returns`** path to the saved file
Expand Down
8 changes: 4 additions & 4 deletions py2cytoscape/cyrest/view.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ def destroy(self, verbose=False):
response=api(url=self.__url+"/destroy", PARAMS=PARAMS, method="POST", verbose=verbose)
return response

def export(self, Height=None, options=None, OutputFile=None, Resolution=None,\
Units=None, Width=None, Zoom=None, verbose=False):
def export(self, options=None, OutputFile=None, Resolution=None,\
Units=None, Width=None, Zoom=None, view="current", verbose=False):
"""
Exports the current view to a graphics file and returns the path to the
saved file. PNG and JPEG formats have options for scaling, while other
Expand Down Expand Up @@ -79,8 +79,8 @@ def export(self, Height=None, options=None, OutputFile=None, Resolution=None,\
:returns: path to the saved file
"""
PARAMS=set_param(["Height","options","OutputFile","Resolution",\
"Units","Width","Zoom"],\
[Height,options,OutputFile,Resolution,Units,Width,Zoom ])
"Units","Width","Zoom","view"],\
[Height,options,OutputFile,Resolution,Units,Width,Zoom,view ])
response=api(url=self.__url+"/export", PARAMS=PARAMS, method="POST", verbose=verbose)
return response

Expand Down

0 comments on commit 6b12af5

Please sign in to comment.