Skip to content

@graphty/graphty-element / catalog / FormatDescriptor

Interface: FormatDescriptor ​

Defined in: graphty-element/src/catalog/types.ts:772

One file format the element can read, write, or both.

Properties ​

canExport ​

canExport: boolean

Defined in: graphty-element/src/catalog/types.ts:778


canImport ​

canImport: boolean

Defined in: graphty-element/src/catalog/types.ts:777


extensions ​

extensions: readonly string[]

Defined in: graphty-element/src/catalog/types.ts:775


id ​

id: FormatId

Defined in: graphty-element/src/catalog/types.ts:773


mimeTypes ​

mimeTypes: readonly string[]

Defined in: graphty-element/src/catalog/types.ts:776


options ​

options: readonly OptionDescriptor[]

Defined in: graphty-element/src/catalog/types.ts:780

The options its reader accepts.


plainName ​

plainName: string

Defined in: graphty-element/src/catalog/types.ts:774


writerOptions? ​

optional writerOptions?: readonly OptionDescriptor[]

Defined in: graphty-element/src/catalog/types.ts:786

The options exportGraph accepts for it, graph-io's common sanitizeIds and onMixedDirection included. Absent when nothing writes the format; an option not listed here is refused with E_UNKNOWN_OPTION.