@graphty/graphty-element / session / ProjectConfigPatch

Interface: ProjectConfigPatch

Defined in: graphty-element/src/session/types.ts:1317

A partial ProjectConfig, nested: { data: { knownFields: { nodeIdPath: "key" } } }. Plain objects are merged key by key; data.algorithms, background and selectionStyle are replaced whole. Setting a key to undefined returns it to its default.

Properties

author?

readonly optional author?: string | null

Defined in: graphty-element/src/session/types.ts:1328

At most 256 characters; empty or only white space counts as no name, and null clears it.

---

background?

readonly optional background?: { backgroundType: "color"; color: string | undefined; } | { backgroundType: "skybox"; data: string; }

Defined in: graphty-element/src/session/types.ts:1324

---

data?

readonly optional data?: object

Defined in: graphty-element/src/session/types.ts:1318

algorithms?

readonly optional algorithms?: (string | { algorithm: string; as?: string; params?: Record<string, unknown>; seed?: number; style?: boolean | { size?: boolean | readonly [number, number]; }; })[]

directed?

readonly optional directed?: boolean | "auto"

knownFields?

readonly optional knownFields?: Partial<{ edgeDstIdPath: string | null; edgeIdPath: string | null; edgeSrcIdPath: string | null; edgeTimePath: string | null; edgeWeightPath: string | null; idCoercion: "keep" | "canonical"; nodeIdPath: string; nodeLabelPath: string | null; nodeTimePath: string | null; nodeWeightPath: string | null; positionScale: number; repeatedEdges: "error" | "min" | "max" | "keep" | "first" | "last" | "sum"; }>

---

layoutBehavior?

readonly optional layoutBehavior?: Partial<{ minDelta: number; preSteps: number; stepMultiplier: number; }>

Defined in: graphty-element/src/session/types.ts:1326

---

name?

readonly optional name?: string | null

Defined in: graphty-element/src/session/types.ts:1330

At most 256 characters; empty or only white space counts as no name, and null clears it.

---

runAlgorithmsOnLoad?

readonly optional runAlgorithmsOnLoad?: boolean

Defined in: graphty-element/src/session/types.ts:1323

---

selectionStyle?

readonly optional selectionStyle?: object

Defined in: graphty-element/src/session/types.ts:1325

color?

optional color?: string

The halo's colour. Any colour the element understands; normalised to hex on parse.

opacity?

optional opacity?: number

How solid the halo is, in [0, 1]. Low enough to read as a highlight rather than a node.

scale?

optional scale?: number

How much of the node's own size the halo is drawn at.

Greater than 1 puts a ring around the node, which is what a highlight reads as. Below 1 the halo disappears inside the node it is meant to mark, so the schema takes any positive number and the default stands a little clear of the node.