Appearance

@graphty/graph-io / styles / ShapeAnnotation

Interface: ShapeAnnotation ​

Defined in: styles/annotations.ts:49

A filled, outlined shape.

Extends ​

Properties ​

borderColor ​

readonly borderColor: `#${string}`

Defined in: styles/annotations.ts:65

The outline's color.

borderOpacity ​

readonly borderOpacity: number

Defined in: styles/annotations.ts:67

The outline's opacity, 0..1.

borderWidth ​

readonly borderWidth: number

Defined in: styles/annotations.ts:69

The outline's width.

center ​

readonly center: AnnotationPoint

Defined in: styles/annotations.ts:53

The box's center.

fill ​

readonly fill: `#${string}` | null

Defined in: styles/annotations.ts:61

The fill color, or null for none.

fillOpacity ​

readonly fillOpacity: number

Defined in: styles/annotations.ts:63

The fill's opacity, 0..1.

height ​

readonly height: number

Defined in: styles/annotations.ts:57

The box's height.

id ​

readonly id: string

Defined in: styles/annotations.ts:29

The file's id for the annotation, or its index when the file gives none.

Inherited from ​

AnnotationBase.id

kind ​

readonly kind: "shape"

Defined in: styles/annotations.ts:51

What the annotation is: always "shape" for a shape.

layer ​

readonly layer: "background" | "foreground"

Defined in: styles/annotations.ts:31

Whether it is drawn behind the graph or in front of it.

Inherited from ​

AnnotationBase.layer

rotation ​

readonly rotation: number

Defined in: styles/annotations.ts:42

The turn in degrees, clockwise on screen.

Inherited from ​

RotatedAnnotation.rotation

shape ​

readonly shape: StyleNodeShape

Defined in: styles/annotations.ts:59

The outline's shape.

width ​

readonly width: number

Defined in: styles/annotations.ts:55

The box's width.

z ​

readonly z: number

Defined in: styles/annotations.ts:33

Its drawing order within its layer, lowest first.

Inherited from ​

AnnotationBase.z