Skip to content
sigma.js sigma.js
v4.0.6 Docs Examples GitHub 12.2K

EdgeLabelDisplayData

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

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

color: string

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

Label color (CSS color string)

LabelDisplayData.color


edgeAttributes: Record<string, unknown>

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

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


edgeIndex: number

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

Edge index in edge data texture


edgeSize: number

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

Edge thickness/size in pixels


fontKey: string

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

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

LabelDisplayData.fontKey


forceLabel: boolean

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

Force display even if culled by LabelGrid

LabelDisplayData.forceLabel


hidden: boolean

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

Whether the label is hidden

LabelDisplayData.hidden


labelAngle: number

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

Label rotation angle in radians

LabelDisplayData.labelAngle


margin: number

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

Gap between node boundary and label (pixels)

LabelDisplayData.margin


nodeIndex: number

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

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

LabelDisplayData.nodeIndex


nodeSize: number

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

Node size (for offset calculation)

LabelDisplayData.nodeSize


offset: number

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

Perpendicular offset from path centerline (pixels)


parentKey: string

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

Reference to parent node/edge key

LabelDisplayData.parentKey


parentType: "node" | "edge"

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

Parent type: ‘node’ or ‘edge’

LabelDisplayData.parentType


position: EdgeLabelPosition

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

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


size: number

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

Font size in pixels

LabelDisplayData.size


sourceNodeIndex: number

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

Source node index in node data texture


sourceShape: string

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

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


sourceSize: number

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

Source node size in graph coordinates


sourceX: number

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

Source node X position in graph coordinates


sourceY: number

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

Source node Y position in graph coordinates


targetNodeIndex: number

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

Target node index in node data texture


targetShape: string

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

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


targetSize: number

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

Target node size in graph coordinates


targetX: number

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

Target node X position in graph coordinates


targetY: number

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

Target node Y position in graph coordinates


text: string

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

The label text content

LabelDisplayData.text


type: string

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

Label type (for program selection)

LabelDisplayData.type


x: number

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

X position in graph coordinates (node center)

LabelDisplayData.x


y: number

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

Y position in graph coordinates (node center)

LabelDisplayData.y


zIndex: number

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

Z-index for depth ordering

LabelDisplayData.zIndex