@graphty/graphty-element / extend / CommonExportOptions

Interface: CommonExportOptions

Defined in: graph-io/dist/src/types.d.ts:357

The options every exporter accepts next to its format-specific ones.

Properties

onMixedDirection?

optional onMixedDirection?: "error" | "directed" | "undirected"

Defined in: graph-io/dist/src/types.d.ts:375

What a format with one direction per file does with a graph that has both directed and undirected edges: "error" throws (E_DIRECTED), "directed" writes every edge as directed (an undirected edge once, as one directed edge), "undirected" writes the whole graph undirected. A format that keeps each edge's own direction (GraphML, GEXF, CSV, Pajek, XGMML, Cytoscape sessions, and the JGF and graphology JSON dialects) ignores it and writes both kinds; to make such a graph all one direction, read it with the import option onMixedDirection.

Default Value

"error"

---

sanitizeIds?

optional sanitizeIds?: "error" | "mangle"

Defined in: graph-io/dist/src/types.d.ts:365

What to do with node ids the format cannot hold. "error": the export throws (E_INVALID_ID) and no node is renamed. "mangle": such ids are rewritten and the originals are written to the file too, so an import with restoreMangledIds (on by default) reads the original ids back. Pajek is the exception: it always numbers nodes 1 to N and keeps the old ids as labels.

Default Value

"error"