Graphty

Appearance

@graphty/graph-io / @graphty/graph-io/json / JsonShapeMeta

Interface: JsonShapeMeta ​

Defined in: formats/json/dialect.ts:72

The shape information the importer records under meta.extra.json so the exporter can write the same file back; jsonShapeOf(snapshot) reads it. Every field is optional because a graph may come from another format.

Properties ​

allowSelfLoops? ​

readonly optional allowSelfLoops?: boolean

Defined in: formats/json/dialect.ts:90

graphology: options.allowSelfLoops as declared.

cytoscape? ​

readonly optional cytoscape?: Readonly<Record<string, unknown>>

Defined in: formats/json/dialect.ts:92

cytoscape: every top-level key besides elements and data (style, zoom, pan, ...), verbatim.

dialect? ​

readonly optional dialect?: JsonDialect

Defined in: formats/json/dialect.ts:74

The dialect the file was read as.

edgesKey? ​

readonly optional edgesKey?: string

Defined in: formats/json/dialect.ts:76

node-link / d3: the key the edge array was under ("links" or "edges").

id? ​

readonly optional id?: string

Defined in: formats/json/dialect.ts:86

jgf: the graph id.

readonly optional indexLinks?: boolean

Defined in: formats/json/dialect.ts:80

node-link / d3: whether edge endpoints were array positions rather than ids.

nodeIdKey? ​

readonly optional nodeIdKey?: string | null

Defined in: formats/json/dialect.ts:78

node-link / d3: the key holding the node id ("id", "name", ...); null when nodes were positional.

sourceKey? ​

readonly optional sourceKey?: string

Defined in: formats/json/dialect.ts:82

node-link / d3 / vis: the endpoint keys the file used.

targetKey? ​

readonly optional targetKey?: string

Defined in: formats/json/dialect.ts:84

node-link / d3 / vis: the endpoint keys the file used.

type? ​

readonly optional type?: string

Defined in: formats/json/dialect.ts:88

jgf: the graph type.