Appearance

@graphty/graph-io / styles / ArrowAnnotation

Interface: ArrowAnnotation ​

Defined in: styles/annotations.ts:103

A line between two points, with an arrowhead at either end.

Extends ​

Properties ​

color ​

readonly color: `#${string}`

Defined in: styles/annotations.ts:111

The line color.

from ​

readonly from: AnnotationPoint

Defined in: styles/annotations.ts:107

Where the line starts.

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: "arrow"

Defined in: styles/annotations.ts:105

What the annotation is: always "arrow" for an arrow.

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

opacity ​

readonly opacity: number

Defined in: styles/annotations.ts:113

The line's opacity, 0..1.

sourceArrow ​

readonly sourceArrow: StyleArrowShape

Defined in: styles/annotations.ts:117

The arrowhead at the start.

sourceColor ​

readonly sourceColor: `#${string}`

Defined in: styles/annotations.ts:125

The arrowhead color at the start.

sourceHeadLength? ​

readonly optional sourceHeadLength?: number

Defined in: styles/annotations.ts:132

How long the start's arrowhead is along the line, in the units of the points, size included; absent, the drawing program's own length for the line's width.

sourceHeadWidth? ​

readonly optional sourceHeadWidth?: number

Defined in: styles/annotations.ts:134

How wide the start's arrowhead is across the line, as sourceHeadLength says.

sourceSize ​

readonly sourceSize: number

Defined in: styles/annotations.ts:121

The start's arrowhead size as a factor of the normal size.

targetArrow ​

readonly targetArrow: StyleArrowShape

Defined in: styles/annotations.ts:119

The arrowhead at the end.

targetColor ​

readonly targetColor: `#${string}`

Defined in: styles/annotations.ts:127

The arrowhead color at the end.

targetHeadLength? ​

readonly optional targetHeadLength?: number

Defined in: styles/annotations.ts:136

How long the end's arrowhead is along the line, as sourceHeadLength says.

targetHeadWidth? ​

readonly optional targetHeadWidth?: number

Defined in: styles/annotations.ts:138

How wide the end's arrowhead is across the line, as sourceHeadLength says.

targetSize ​

readonly targetSize: number

Defined in: styles/annotations.ts:123

The end's arrowhead size as a factor of the normal size.

to ​

readonly to: AnnotationPoint

Defined in: styles/annotations.ts:109

Where it ends.

width ​

readonly width: number

Defined in: styles/annotations.ts:115

The line width.

z ​

readonly z: number

Defined in: styles/annotations.ts:33

Its drawing order within its layer, lowest first.

Inherited from ​

AnnotationBase.z