Appearance

@graphty/graph-io / positions / PositionColumnExtra

Interface: PositionColumnExtra ​

Defined in: positions/types.ts:35

How a role-position column's values are spelled, as optional fields of the column's meta.extra. A missing field means y up, center, "file" units: what the Cytoscape-family, GEXF and DOT columns already hold.

Extended by ​

Properties ​

anchor? ​

readonly optional anchor?: PositionAnchor

Defined in: positions/types.ts:62

What the coordinate points at; "top-left" is moved to the center using width and height.

containersFollowChildren? ​

readonly optional containersFollowChildren?: boolean

Defined in: positions/types.ts:85

The program that draws the file draws a container node (one other nodes name as their parent) around its children, wherever the container's own stored coordinate says: Cytoscape.js computes a compound node's position and size from its children's. A container's stored coordinate is then not read, and it has no position here unless the file stores its box.

height? ​

readonly optional height?: string

Defined in: positions/types.ts:66

The name of the node column holding each node's height, for a top-left anchor.

originUnplaced? ​

readonly optional originUnplaced?: boolean

Defined in: positions/types.ts:78

The program that draws the file puts a node the file gives no position at the origin, (0, 0, 0) as written, when other nodes are placed (Gephi), rather than leaving it for a layout to place.

pxPerUnit? ​

readonly optional pxPerUnit?: number

Defined in: positions/types.ts:43

How many px (points) one unit of the coordinates is, when units is "file" but the file's unit is a known length: 72 for Graphviz input inches. Lets a reader draw the coordinates in the same unit as the file's px style lengths; the coordinates themselves stay as written.

pxPerUnitY? ​

readonly optional pxPerUnitY?: number

Defined in: positions/types.ts:49

How many px one unit of y is, when the program that draws the file stretches its axes apart (Pajek fits the file's 0..1 square to its Draw window, x across the width and y down the height); absent when y is pxPerUnit like x. extractPositions() returns y in x's unit.

sourceDims? ​

readonly optional sourceDims?: 2 | 3

Defined in: positions/types.ts:58

How many coordinates the file wrote per node: 2, or 3 when it stored a z.

units? ​

readonly optional units?: LengthUnit

Defined in: positions/types.ts:37

The unit of the coordinates.

viewerFit? ​

readonly optional viewerFit?: ViewerFit

Defined in: positions/types.ts:56

Set when the coordinates have no fixed length: the program that draws the file fits their bounding box into its canvas, padding px in from each side, and draws label sizes in the canvas's px rather than in the coordinates' unit (sigma.js). Absent when the coordinates keep their own length.

width? ​

readonly optional width?: string

Defined in: positions/types.ts:64

The name of the node column holding each node's width, for a top-left anchor.

yAxis? ​

readonly optional yAxis?: YAxis

Defined in: positions/types.ts:60

Which way y grows; "down" is flipped to y up.

zeroUnplaced? ​

readonly optional zeroUnplaced?: boolean

Defined in: positions/types.ts:73

The file writes (0, 0) for a node it has no position for (NetworkX's Pajek writer): when other rows are placed, a (0, 0) shared by two or more rows counts as unplaced.

zOrigin? ​

readonly optional zOrigin?: number

Defined in: positions/types.ts:68

A z the file centers its depth on (Pajek's 0.5): subtracted from a real z before any flip.