exportImage: Export Image

In RCy3: Functions to Access and Control Cytoscape

Description

Saves the current network view as an image file.

Usage

exportImage(
  filename = NULL,
  type = "PNG",
  resolution = NULL,
  units = NULL,
  height = NULL,
  width = NULL,
  zoom = NULL,
  network = NULL,
  base.url = .defaultBaseUrl
)

Arguments

filename	(character) Full path or path relavtive to current working directory, in addition to the name of the file. Extension is automatically added based on the type argument. If blank, the current network name will be used.
type	(character) Type of image to export, e.g., PNG (default), JPEG, PDF, SVG, PS (PostScript).
resolution	(numeric) The resolution of the exported image, in DPI. Valid only for bitmap formats, when the selected width and height 'units' is inches. The possible values are: 72 (default), 100, 150, 300, 600.
units	(character) The units for the 'width' and 'height' values. Valid only for bitmap formats, such as PNG and JPEG. The possible values are: pixels (default), inches.
height	(numeric) The height of the exported image. Valid only for bitmap formats, such as PNG and JPEG.
width	(numeric) The width of the exported image. Valid only for bitmap formats, such as PNG and JPEG.
zoom	(numeric) The zoom value to proportionally scale the image. The default value is 100.0. Valid only for bitmap formats, such as PNG and JPEG
network	(optional) Name or SUID of a network or view. Default is the "current" network active in Cytoscape. The first (presummably only) view associated a network is used if a specific view SUID is not provided.
base.url	(optional) Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://localhost:1234 and the latest version of the CyREST API supported by this version of RCy3.

Details

The image is cropped per the current view in Cytoscape. Consider applying fitContent prior to export.

Value

server response

Examples

exportImage('/fullpath/myNetwork','PDF')

RCy3 documentation built on Nov. 21, 2020, 2 a.m.