setNodeLabelBypass: Set Node Label Bypass

Description Usage Arguments Details Value See Also Examples

View source: R/StyleBypasses.R

Description

Override the label for particular nodes.

Usage

1
2
3
4
5
6
setNodeLabelBypass(
  node.names,
  new.labels,
  network = NULL,
  base.url = .defaultBaseUrl
)

Arguments

node.names

List of node names

new.labels

List of labels, or single value

network

(optional) Name or SUID of the network. Default is the "current" network active in Cytoscape.

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

This method permanently overrides any default values or mappings defined for this visual property of the node or nodes specified. This method ultimately calls the generic function, setNodePropertyBypass, which can be used to set any visual property. To restore defaults and mappings, use clearNodePropertyBypass, see examples.

Value

None

See Also

setNodePropertyBypass, clearNodePropertyBypass

Examples

1
2
3
setNodeLabelBypass('Node 1', 'Custom Label')
setNodeLabelBypass(c('Node 1','Node 2'), 'Custom Label')
clearNodePropertyBypass(c('Node 1','Node 2'), 'NODE_LABEL')

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