Graphty

Appearance

@graphty/graphty-element / extend / DefinitionBase

Interface: DefinitionBase<O> ​

Defined in: graphty-element/src/simple/types.ts:81

Members every definition has. Only id is required.

Extended by ​

Type Parameters ​

O ​

O extends OptionsShorthand

Properties ​

description? ​

readonly optional description?: string

Defined in: graphty-element/src/simple/types.ts:87

One sentence for pickers and the catalogue. Default: "".

id ​

readonly id: string

Defined in: graphty-element/src/simple/types.ts:83

Permanent id: lower case, hyphenated, vendor-prefixed ("acme-hop-reach"). Kept unchanged when the extension graduates.

name? ​

readonly optional name?: string

Defined in: graphty-element/src/simple/types.ts:85

What pickers show. Default: the id in sentence case ("acme-hop-reach" reads "Acme hop reach").

options? ​

readonly optional options?: O

Defined in: graphty-element/src/simple/types.ts:89

The options a reader may set, in short form: { spacing: 2, weight: { type: "attribute", on: "edge" } }.

version? ​

readonly optional version?: string

Defined in: graphty-element/src/simple/types.ts:91

The extension's own semver version, recorded as provenance.