Child pages
  • Format Rules
Skip to end of metadata
Go to start of metadata

Syntax

Each line can be one of the following. Comments can be made with either '#' or '//'; all trailing characters would be ignored.

Syntax

Description
GC
A General Command (GC) that affects the entire hive plot.
[AM; ...]
Set the default Appearance Modifiers (AM). Any format rules following this line will have these appearance modifiers unless overwritten otherwise.
QNS [AM; ...]
Apply appearance modifiers to the node(s) selected with a Quick Node Selector (QNS).
QES [AM; ...]
Apply appearance modifiers to the edge(s) selected with a Quick Edge Selector (QES).
CNS [AM; ...]
Apply appearance modifiers to the node(s) selected with a Complex Node Selector (CNS).
CES [AM; ...]
Apply appearance modifiers to the edge(s) selected with a Complex Edge Selector (CES).

General Command

SyntaxDescription
clear

Hide all nodes and edges from the hive plot.

This is shorthand for:

n() [show=no]
e() [show=no]

or

.* [show=no]
.* .* [show=no]

Appearance Modifier

SyntaxDescription
thickness=int
width=int

Set the thickness of the edge(s) selected.

int must be an integer ≥ 0.

size=int
radius=int

Set the radius of the node(s) selected.

int must be an integer ≥ 0.

rgb=(int,int,int)
color=(int,int,int)
colour=(int,int,int)

Set the color of the item(s) selected with an RGB triplet (r, g, b).

int must be an integer in range [0, 255].

rgb=str
color=str
colour=str

Set the color of the item(s) selected with a name.

str must be one of:

  • optblue, optgreen, optyellow, optorange, optred, optviolet, optpurple
  • white
  • vvvvlgrey, vvvlgrey, vvlgrey, vlgrey, lgrey, grey, dgrey, vdgrey, vvdgrey, vvvdgrey, vvvvdgrey
  • black
  • vlred, lred, red, dred
  • vlgreen, lgreen, green, dgreen
  • vlblue, lblue, blue, dblue
  • vlpurple, lpurple, purple, dpurple
  • vlyellow, lyellow, yellow, dyellow
  • lime
  • vlorange, lorange, orange, dorange
rgb=int
color=int
colour=int

Set the color of the item(s) selected with an index of the color palette.

int must be an integer ≥ 0.

rgb=relation
color=relation
colour=relation

Set the color of the item(s) selected as a darker or brighter variant of the default color.

relation must be one of:

  • brighter
  • darker
depth=int
level=int
z=int
layer=int

Set the layer of the item(s) selected.

All objects in the hive plot are in the default layer 0.

All objects selected by a format rule are in the default layer 1.

int must be an integer in range [-231-1, 231-1].

opacity=int

Set the opacity of the item(s) selected.

int must be in an integer in range [0, 100].

show=boolean
visible=boolean
appear=boolean

Show (or hide) the item(s) selected.

boolean must be one of:

  • yes, y, true, t
  • no, n, false, f
show
visible
appear
Show the items selected.
autonode=boolean
Set the visibility of nodes (not) to depend on the visibility of incident edges.

boolean must be one of:

  • yes, y, true, t
  • no, n, false, f
autonode
Set the visibility of nodes to depend on the visibility of incident edges.
label=boolean

Show (or hide) the label of the node(s) selected.

boolean must be one of:

  • yes, y, true, t
  • no, n, false, f
label
Show the label of the node(s) selected.

Quick Node Selector

SyntaxDescription
str

Select a node with its name.

str must be a valid node name.

.*
Select all nodes in the network.

Quick Edge Selector

SyntaxDescription
QNS QNS
Select the edges from the first QNS to the second QNS.
QNS QNS QNS
Select the edges from the first QNS to the second QNS and the edges from the second QNS to the third QNS.

Complex Node Selector

SyntaxDescription
n()
Select all nodes in the network.
n(...)

Select nodes that satisfy the conditions in ...

... must be one of, or a comma-separated list of AS or ICES.

AS specifies the criteria of the nodes' attributes.

ICES specifies the criteria of incident edges' attributes.

!n(...)
Complement of the set of nodes returned by n(...)

Complex Edge Selector

SyntaxDescription
e()
Select all edges in the network.
e(...)

Select edges that satisfy the conditions in ...

... must be one of, or a comma-separated list of AS or ICNS.

AS specifies the criteria of the edges' attributes.

ICNS specifies the criteria of incident nodes' attributes.

!e(...)
Complement of the set of nodes returned by e(...)

Attribute Selector

SyntaxDescription
attr=val

The item(s) has attribute attr with only one value and that value is val.

attr~val

The item(s) has attribute attr with one or more values and one of the values is val.

attr~!val

The item(s) has attribute attr with one or more values and one of the values is not val.

attr>val

The item(s) has numerical attribute attr greater than the value val.

attr>=val
The item(s) has numerical attribute attr greater than or equal to the value val.
attr==val
The item(s) has numerical attribute attr equal to the value val.
attr<=val
The item(s) has numerical attribute attr less than or equal to the value val.
attr<val
The item(s) has numerical attribute attr less than the value val.

Internal Complex Node Selector

SyntaxDescription
n(...)

Specify the incident node(s).

... as defined in CNS.

n1(...)

Specify the source node(s).

n2(...)
Specify the sink node(s).
!n(...)
Complement of set of nodes returned by n(...)
!n1(...)
Complement of set of nodes returned by n1(...)
!n2(...)
Complement of set of nodes returned by n2(...)
In an undirected graph, n1(...) and n2(...) are treated the same way as n(...)

Internal Complex Edge Selector

SyntaxDescription
e(...)

Specify the incident edge(s).

... as defined in CES.

e1(...)
Specify the incoming edge(s).
e2(...)
Specify the outgoing edge(s).
!e(...)
Complement of set of edges returned by e(...)
!e1(...)
Complement of set of edges returned by e1(...)
!e2(...)
Complement of set of edges returned by e2(...)
In an undirected graph, e1(...) and e2(...) are treated the same way as e(...)
  • No labels