Skip to content
This is the alpha v4 version website. Looking for the v3 documentation?

EdgeLabelDisplayData

Defined in: packages/sigma/src/types.ts:408

Display data for an edge label, computed during processing. Extends LabelDisplayData with edge-specific positioning info.

Extends

Properties

color

color: string

Defined in: packages/sigma/src/types.ts:377

Label color (CSS color string)

Inherited from

LabelDisplayData.color


edgeAttributes

edgeAttributes: Record<string, unknown>

Defined in: packages/sigma/src/types.ts:432

Resolved edge display data — source for the path attributes (curvature, loop geometry, …) packed into the label attribute texture.


edgeIndex

edgeIndex: number

Defined in: packages/sigma/src/types.ts:438

Edge index in edge data texture


edgeSize

edgeSize: number

Defined in: packages/sigma/src/types.ts:428

Edge thickness/size in pixels


fontKey

fontKey: string

Defined in: packages/sigma/src/types.ts:397

Font key for multi-font support (references registered font in atlas)

Inherited from

LabelDisplayData.fontKey


forceLabel

forceLabel: boolean

Defined in: packages/sigma/src/types.ts:381

Force display even if culled by LabelGrid

Inherited from

LabelDisplayData.forceLabel


hidden

hidden: boolean

Defined in: packages/sigma/src/types.ts:379

Whether the label is hidden

Inherited from

LabelDisplayData.hidden


labelAngle

labelAngle: number

Defined in: packages/sigma/src/types.ts:399

Label rotation angle in radians

Inherited from

LabelDisplayData.labelAngle


margin

margin: number

Defined in: packages/sigma/src/types.ts:395

Gap between node boundary and label (pixels)

Inherited from

LabelDisplayData.margin


nodeIndex

nodeIndex: number

Defined in: packages/sigma/src/types.ts:401

Node index in node data texture (for GPU-side lookup)

Inherited from

LabelDisplayData.nodeIndex


nodeSize

nodeSize: number

Defined in: packages/sigma/src/types.ts:393

Node size (for offset calculation)

Inherited from

LabelDisplayData.nodeSize


offset

offset: number

Defined in: packages/sigma/src/types.ts:430

Perpendicular offset from path centerline (pixels)


parentKey

parentKey: string

Defined in: packages/sigma/src/types.ts:387

Reference to parent node/edge key

Inherited from

LabelDisplayData.parentKey


parentType

parentType: "node" | "edge"

Defined in: packages/sigma/src/types.ts:389

Parent type: ‘node’ or ‘edge’

Inherited from

LabelDisplayData.parentType


position

position: EdgeLabelPosition

Defined in: packages/sigma/src/types.ts:410

Position of edge label relative to path (overrides LabelDisplayData.position)


size

size: number

Defined in: packages/sigma/src/types.ts:375

Font size in pixels

Inherited from

LabelDisplayData.size


sourceNodeIndex

sourceNodeIndex: number

Defined in: packages/sigma/src/types.ts:434

Source node index in node data texture


sourceShape

sourceShape: string

Defined in: packages/sigma/src/types.ts:424

Source node shape slug (e.g., “circle”, “square”)


sourceSize

sourceSize: number

Defined in: packages/sigma/src/types.ts:420

Source node size in graph coordinates


sourceX

sourceX: number

Defined in: packages/sigma/src/types.ts:412

Source node X position in graph coordinates


sourceY

sourceY: number

Defined in: packages/sigma/src/types.ts:414

Source node Y position in graph coordinates


targetNodeIndex

targetNodeIndex: number

Defined in: packages/sigma/src/types.ts:436

Target node index in node data texture


targetShape

targetShape: string

Defined in: packages/sigma/src/types.ts:426

Target node shape slug (e.g., “circle”, “square”)


targetSize

targetSize: number

Defined in: packages/sigma/src/types.ts:422

Target node size in graph coordinates


targetX

targetX: number

Defined in: packages/sigma/src/types.ts:416

Target node X position in graph coordinates


targetY

targetY: number

Defined in: packages/sigma/src/types.ts:418

Target node Y position in graph coordinates


text

text: string

Defined in: packages/sigma/src/types.ts:369

The label text content

Inherited from

LabelDisplayData.text


type

type: string

Defined in: packages/sigma/src/types.ts:383

Label type (for program selection)

Inherited from

LabelDisplayData.type


x

x: number

Defined in: packages/sigma/src/types.ts:371

X position in graph coordinates (node center)

Inherited from

LabelDisplayData.x


y

y: number

Defined in: packages/sigma/src/types.ts:373

Y position in graph coordinates (node center)

Inherited from

LabelDisplayData.y


zIndex

zIndex: number

Defined in: packages/sigma/src/types.ts:385

Z-index for depth ordering

Inherited from

LabelDisplayData.zIndex