@graphty/graphty-element / index / GraphBackground

Variable: GraphBackground

const GraphBackground: ZodDiscriminatedUnion<[ZodObject<{ backgroundType: ZodLiteral<"color">; color: ZodPipe<ZodString, ZodTransform<string | undefined, string>>; }, $strict>, ZodObject<{ backgroundType: ZodLiteral<"skybox">; data: ZodUnion<[ZodURL, ZodString]>; }, $strict>]>

Defined in: graphty-element/src/config/GraphStyle.ts:23

What the graph is drawn against: a flat colour, or a photo-dome skybox built from an image.

The colour accepts any CSS colour the element understands and is normalised to hex on parse; the skybox's data is an image URL or a base64 PNG. It is the shape element.background and graph.setBackground() take.