ApiNATOMY model

#/definitions/Graph

Definitions

#/definitions/Border

Properties (6.18)
borders
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Default and Examples (7.3, 7.4)
host
Must match any of (6.27)
Type (6.25)
string
Must match all of (6.26)

#/definitions/Chain

Properties (6.18)
conveyingLyphs
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Default and Examples (7.3, 7.4)
start
Must match any of (6.27)
Type (6.25)
string
end
Must match any of (6.27)
Type (6.25)
string
Must match all of (6.26)

#/definitions/Channel

Properties (6.18)
materials
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Default and Examples (7.3, 7.4)
housingLyphs
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Default and Examples (7.3, 7.4)
instances
Type (6.25)
array<*>
Items (6.9)
Must match all of (6.26)

#/definitions/Coalescence

Properties (6.18)
topology
Type (6.25)
string
Enum (allowed values) (6.23)
"CONNECTING"
"EMBEDDING"
Default and Examples (7.3, 7.4)
Default
"CONNECTING"
generatedFrom
Must match any of (6.27)
lyphs
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Default and Examples (7.3, 7.4)
Must match all of (6.26)

#/definitions/ColorScheme

Type (6.25)
string
Enum (allowed values) (6.23)
"interpolateBrBG"
"interpolatePRGn"
"interpolatePiYG"
"interpolatePuOr"
"interpolateRdBu"
"interpolateRdGy"
"interpolateRdYlBu"
"interpolateRdYlGn"
"interpolateSpectral"
"interpolateBuGn"
"interpolateBuPu"
"interpolateGnBu"
"interpolateOrRd"
"interpolatePuBuGn"
"interpolatePuBu"
"interpolatePuRd"
"interpolateRdPu"
"interpolateYlGnBu"
"interpolateYlGn"
"interpolateYlOrBr"
"interpolateYlOrRd"
"interpolateBlues"
"interpolateGreens"
"interpolateGreys"
"interpolatePurples"
"interpolateReds"
"interpolateOranges"
"interpolateCubehelixDefault"
"interpolateRainbow"
"interpolateViridis"

#/definitions/External

Properties (6.18)
uri
Type (6.25)
string
type
Type (6.25)
string
externalTo
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Must match all of (6.26)

#/definitions/Graph

Properties (6.18)
config
Type (6.25)
object
Properties (6.18)
filter
Type (6.25)
array<string>
Items (6.9)
Type (6.25)
string
Must match all of (6.26)

#/definitions/Group

Properties (6.18)
nodes
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Default and Examples (7.3, 7.4)
links
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Default and Examples (7.3, 7.4)
lyphs
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Default and Examples (7.3, 7.4)
materials
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
regions
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
references
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
coalescences
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Default and Examples (7.3, 7.4)
channels
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
chains
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
trees
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
groups
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Default and Examples (7.3, 7.4)
Must match all of (6.26)

#/definitions/GroupColorScheme

Type (6.25)
object
Properties (6.18)
scheme
#/definitions/ColorScheme
length
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
x ≥ 1
reversed
Type (6.25)
boolean
offset
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 1

#/definitions/GroupTemplate

Properties (6.18)
group
Must match any of (6.27)
Type (6.25)
string
length
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 100
Must match all of (6.26)

#/definitions/JSONPathScheme

Type (6.25)
string

#/definitions/Lyph

Properties (6.18)
topology
Type (6.25)
string
Enum (allowed values) (6.23)
"TUBE"
"BAG"
"BAG2"
"CYST"
thickness
Type (6.25)
object
Properties (6.18)
min
Type (6.25)
number
max
Type (6.25)
number
Default and Examples (7.3, 7.4)
Default
{
}
length
Type (6.25)
object
Properties (6.18)
min
Type (6.25)
number
max
Type (6.25)
number
Default and Examples (7.3, 7.4)
Default
{
}
isTemplate
Type (6.25)
boolean
subtypes
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
supertype
Must match any of (6.27)
Type (6.25)
string
conveyedBy
Must match any of (6.27)
Type (6.25)
string
layers
Type (6.25)
array<*>
Unique Items (6.13)
Array items must be unique
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
layerIn
Must match any of (6.27)
Type (6.25)
string
internalIn
Must match any of (6.27)
Type (6.25)
string
hostedBy
Must match any of (6.27)
Type (6.25)
string
inCoalescences
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Default and Examples (7.3, 7.4)
channels
Type (6.25)
array<*>
Unique Items (6.13)
Array items must be unique
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
bundles
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Default and Examples (7.3, 7.4)
generatedFrom
Must match any of (6.27)
angle
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 360
infoFields
Type (6.25)
array<string>
Items (6.9)
Type (6.25)
string
Default and Examples (7.3, 7.4)
Default
[
"id",
"name",
"class",
"topology",
"conveyedBy",
"external",
"comment",
"supertype",
"cloneOf",
"generated"
]
width
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 100
height
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 100
scale
Type (6.25)
object
Properties (6.18)
width
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 100
height
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 100
Default and Examples (7.3, 7.4)
Default
{
"height": 80,
"width": 40
}
create3d
Type (6.25)
boolean
layerWidth
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 100
Must match all of (6.26)

#/definitions/Material

Properties (6.18)
materials
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
inMaterials
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
transportedBy
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Must match all of (6.26)

#/definitions/Node

Properties (6.18)
infoFields
Type (6.25)
array<string>
Items (6.9)
Type (6.25)
string
Default and Examples (7.3, 7.4)
Default
[
"id",
"name",
"class",
"hostedBy",
"generated"
]
hostedBy
Must match any of (6.27)
Type (6.25)
string
internalIn
Must match any of (6.27)
Type (6.25)
string
controlNodes
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
layout
#/definitions/Point3Scheme
fixed
Type (6.25)
boolean
val
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
x ≥ 0
Default and Examples (7.3, 7.4)
Default
1
offset
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 1
charge
Type (6.25)
number
Default and Examples (7.3, 7.4)
collide
Type (6.25)
number
Default and Examples (7.3, 7.4)
Default
5
sourceOf
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
targetOf
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Must match all of (6.26)

#/definitions/OffsetScheme

Type (6.25)
object
Properties (6.18)
start
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 1
Default and Examples (7.3, 7.4)
end
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 1
Default and Examples (7.3, 7.4)
Default
1
step
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
0 ≤ x ≤ 1

#/definitions/Point2Scheme

Type (6.25)
object
Properties (6.18)
x
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
-100 ≤ x ≤ 100
y
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
-100 ≤ x ≤ 100

#/definitions/Point3Scheme

Properties (6.18)
z
Type (6.25)
number
Numeric range (6.4, 6.2, 6.5, 6.3)
-100 ≤ x ≤ 100
Must match all of (6.26)

#/definitions/Region

Properties (6.18)
Must match all of (6.26)

#/definitions/Resource

Type (6.25)
object
Properties (6.18)
id
Type (6.25)
string
name
Type (6.25)
string
class
Type (6.25)
string
comment
Type (6.25)
string
external
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
assign
Type (6.25)
array<object>
Items (6.9)
Type (6.25)
object
Properties (6.18)
path
#/definitions/JSONPathScheme
value
Type (6.25)
object
interpolate
Type (6.25)
array<object>
Items (6.9)
Type (6.25)
object
Properties (6.18)
path
#/definitions/JSONPathScheme
color
#/definitions/GroupColorScheme
offset
#/definitions/OffsetScheme
inactive
Type (6.25)
boolean
generated
Type (6.25)
boolean
infoFields
Type (6.25)
array<string>
Items (6.9)
Type (6.25)
string
Default and Examples (7.3, 7.4)
Default
[
"id",
"name",
"class",
"generated"
]

#/definitions/RGBColorScheme

Type (6.25)
string
String Pattern (6.8)
x must match /#([a-fA-F0-9]{6}|[a-fA-F0-9]{3}){1,2}|(rgb|hsl)a\((\d{1,3}%?,\s?){3}(1|0?\.\d+)\)|(rgb|hsl)\(\d{1,3}%?(,\s?\d{1,3}%?){2}\)/

#/definitions/Shape

Properties (6.18)
border
Must match any of (6.27)
Type (6.25)
string
Default and Examples (7.3, 7.4)
Default
{
}
points
Type (6.25)
array<*>
Items (6.9)
internalLyphColumns
Type (6.25)
number
Default and Examples (7.3, 7.4)
Default
1
internalLyphs
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
internalNodes
Type (6.25)
array<*>
Unique Items (6.13)
Array items must be unique
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
hostedLyphs
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Must match all of (6.26)

#/definitions/Tree

Properties (6.18)
root
Must match any of (6.27)
Type (6.25)
string
numLevels
Type (6.25)
number
Default and Examples (7.3, 7.4)
Default
1
levels
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
lyphTemplate
Must match any of (6.27)
Type (6.25)
string
branchingFactors
Type (6.25)
array<number>
Items (6.9)
Type (6.25)
number
Default and Examples (7.3, 7.4)
Default
1
numInstances
Type (6.25)
number
Default and Examples (7.3, 7.4)
instances
Type (6.25)
array<*>
Items (6.9)
housingLyphs
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Type (6.25)
string
Default and Examples (7.3, 7.4)
Must match all of (6.26)

#/definitions/VisualResource

Properties (6.18)
color
Must match all of (6.26)
viewObjects
Type (6.25)
object
Default and Examples (7.3, 7.4)
Default
{
}
labels
Type (6.25)
object
Default and Examples (7.3, 7.4)
Default
{
}
hidden
Type (6.25)
boolean
skipLabel
Type (6.25)
boolean
cloneOf
Must match any of (6.27)
clones
Type (6.25)
array<*>
Items (6.9)
Must match any of (6.27)
Must match all of (6.26)