exportPDF: Export PDF

In cytoscape/RCy3: Functions to Access and Control Cytoscape

Export PDF

Description

Saves the current network view as an pdf file.

Usage

exportPDF(
  filename = NULL,
  exportTextAsFont = TRUE,
  hideLabels = FALSE,
  pageSize = "Letter",
  orientation = "Portrait",
  network = NULL,
  base.url = .defaultBaseUrl,
  overwriteFile = TRUE
)

Arguments

filename	(character) Full path or path relative 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.
exportTextAsFont	(optional): If TRUE (the default value), texts will be exported as fonts.
hideLabels	(optional): TRUE makes node and edge labels invisible in image. False allows them to be drawn. The default is False.
pageSize	(optional): (Auto|Letter|Legal|Tabloid|A0|A1|A2|A3|A4|A5) Predefined standard page size, or choose custom. Default is 'Letter'.
orientation	(optional): Page orientation, portrait or landscape.
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.
overwriteFile	(optional) FALSE allows Cytoscape show a message box before overwriting the file if the file already exists; TRUE allows Cytoscape to overwrite it without asking. Default value is TRUE.

Details

Exports the current view to a graphics file and returns the path to the saved file. To speed up image export for large networks use the option 'allGraphicsDetails=FALSE'. Available for Cytoscape v3.10 or later.

Value

server response

Examples

exportPDF('/fullpath/myNetwork')

cytoscape/RCy3 documentation built on Nov. 1, 2024, 2:49 a.m.