@graphty/graphty-element / catalog / GeneratorDescriptor

Interface: GeneratorDescriptor

Defined in: graph-samples/dist/src/generators/catalog.d.ts:26

One generator in the catalogue.

Properties

description

readonly description: string

Defined in: graph-samples/dist/src/generators/catalog.d.ts:32

One sentence saying what it builds.

---

name

readonly name: string

Defined in: graph-samples/dist/src/generators/catalog.d.ts:28

The name generateGraph takes: the generator function's name in kebab case, without "Graph".

---

params

readonly params: readonly GeneratorParamDescriptor[]

Defined in: graph-samples/dist/src/generators/catalog.d.ts:34

Its main parameters; a random generator's last one is seed.

---

plainName

readonly plainName: string

Defined in: graph-samples/dist/src/generators/catalog.d.ts:30

A default name for it.

---

thumbnail?

readonly optional thumbnail?: string

Defined in: graph-samples/dist/src/generators/catalog.d.ts:41

A small picture of what it builds with its default parameters (a 480 x 300 WebP with a transparent background, drawn by graphty-element): its file name beside the datasets' files, so its address is the dataset base URL (DEFAULT_DATASET_BASE_URL) plus this name. Absent when it has none.