updateAnnotationShape | R Documentation |
Updates a shape annotation to a Cytoscape network view. The object will also be added to the Annotation Panel in the GUI.
updateAnnotationShape(
type = NULL,
customShape = NULL,
annotationName = NULL,
x.pos = NULL,
y.pos = NULL,
angle = NULL,
fillColor = NULL,
opacity = NULL,
borderThickness = NULL,
borderColor = NULL,
borderOpacity = NULL,
height = NULL,
width = NULL,
name = NULL,
canvas = NULL,
z.order = NULL,
network = NULL,
base.url = .defaultBaseUrl
)
type |
(optional) The type of the shape, default is RECTANGLE. See getNodeShapes() for valid options. |
customShape |
(optional) If a custom shape, this is the text of the shape |
annotationName |
Name of annotation by UUID or Name |
x.pos |
(optional) X position in pixels from left; default is center of current view |
y.pos |
(optional) Y position in pixels from top; default is center of current view |
angle |
(optional) Angle of text orientation; default is 0.0 (horizontal) |
fillColor |
(optional) Hexidecimal color; default is #000000 (black) |
opacity |
(optional) Opacity of fill color. Must be an integer between 0 and 100; default is 100. |
borderThickness |
(optional) Integer |
borderColor |
(optional) Hexidecimal color; default is #000000 (black) |
borderOpacity |
(optional) Integer between 0 and 100; default is 100. |
height |
(optional) Height of shape; default is based on text height. |
width |
(optional) Width of shape; default is based on text length. |
name |
(optional) Name of annotation object; default is "Shape" |
canvas |
(optional) Canvas to display annotation, i.e., foreground (default) or background |
z.order |
(optional) Arrangement order specified by number (larger values are in front of smaller values); default is 0 |
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. |
A named list of annotation properties, including UUID
updateAnnotationShape("rectangle", "annotationName")
updateAnnotationShape("rectangle", "annotationName", 1000, 1000, name="S2")
updateAnnotationShape("rectangle", "annotationName", 1200, 1000, 30, "#990000",
40,name="S3", canvas="background",z=4)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.