@graphty/graphty-element / catalog / GeneratorParamDescriptor

Interface: GeneratorParamDescriptor

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

One parameter of a generator in the catalogue.

Properties

choices?

readonly optional choices?: readonly string[]

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

The values allowed, for a choice.

---

default

readonly default: string | number | boolean

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

The value used when the parameter is not given.

---

max?

readonly optional max?: number

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

The largest value allowed, for a number.

---

min?

readonly optional min?: number

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

The smallest value allowed, for a number.

---

name

readonly name: string

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

The key generateGraph takes it under.

---

plainName

readonly plainName: string

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

A default name for it.

---

type

readonly type: "number" | "boolean" | "integer" | "choice"

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

"integer" and "number" take a number, "boolean" true or false, "choice" one of choices.