Class CellState

Represents the current state of a cell in a given GraphView.

For edges, the edge label position is stored in absoluteOffset.

The size for oversize labels can be retrieved using the boundingBox property of the text field as shown below.

const bbox = state.text?.boundingBox ?? null;

Hierarchy (View Summary)

Rectangle
- CellState

Constructors

constructor

new CellState(
    view?: null | GraphView,
    cell?: null | Cell,
    style?: null | CellStateStyle,
): CellState
Constructs a new object that represents the current state of the given Cell in the specified view.
Parameters
- view: null | GraphView = null
  GraphView that contains the state.
- cell: null | Cell = null
  Cell that this state represents.
- style: null | CellStateStyle = null
  the style of the Cell.
Returns CellState
Overrides Rectangle.constructor
- Defined in view/cell/CellState.ts:163

Properties

_height

_height: number = 0

Holds the height of the rectangle.

Default

_width

_width: number = 0

Holds the width of the rectangle.

Default

_x

_x: number = 0

Holds the x-coordinate of the point. Default is 0.

_y

_y: number = 0

Holds the y-coordinate of the point. Default is 0.

absoluteOffset

absoluteOffset: Point

Point that holds the absolute offset.

For edges, this is the absolute coordinates of the label position.
For vertices, this is the offset of the label relative to the top, left corner of the vertex.

absolutePoints

absolutePoints: (null | Point)[] = []

Holds an array of that represent the absolute points of an edge.

boundingBox

boundingBox: null | Rectangle = null

cell

cell: Cell

Reference to the Cell that is represented by this state.

cellBounds

cellBounds: null | Rectangle = null

control

control: null | Shape = null

invalid

invalid: boolean = true

Specifies if the state is invalid.

Default

true

invalidStyle

invalidStyle: boolean = false

Specifies if the style is invalid.

Default

false

length

length: number = 0

Caches the length of an edge.

node

node: null | HTMLElement = null

origin

origin: Point

Point that holds the origin for all child cells.

Default

a new empty Point.

overlays

overlays: Dictionary<CellOverlay, Shape> = ...

paintBounds

paintBounds: null | Rectangle = null

parentHighlight

parentHighlight: null | RectangleShape = null

point

point: null | Point = null

segments

segments: number[] = []

Array of numbers that represent the cached length of each segment of the edge.

shape

shape: null | Shape = null

Holds the Shape that represents the cell graphically.

style

style: CellStateStyle

The style of the Cell.

terminalDistance

terminalDistance: number = 0

Caches the distance between the end points for an edge.

text

text: null | TextShape = null

Holds the Text that represents the label of the cell. This may be null if the cell has no label.

unscaledHeight

unscaledHeight: number = 0

Holds the unscaled height of the state.

unscaledWidth

unscaledWidth: number = 0

Holds the unscaled width of the state.

view

view: GraphView

Reference to the enclosing GraphView.

visibleSourceState

visibleSourceState: null | CellState = null

Caches the visible source terminal state.

visibleTargetState

visibleTargetState: null | CellState = null

Caches the visible target terminal state.

Accessors

height

get height(): number
Returns number
Inherited from Rectangle.height
- Defined in view/geometry/Rectangle.ts:60
set height(height: number): void
Parameters
- height: number
Returns void
Inherited from Rectangle.height
- Defined in view/geometry/Rectangle.ts:64

width

get width(): number
Returns number
Inherited from Rectangle.width
- Defined in view/geometry/Rectangle.ts:50
set width(width: number): void
Parameters
- width: number
Returns void
Inherited from Rectangle.width
- Defined in view/geometry/Rectangle.ts:54

x

get x(): number
Returns number
Inherited from Rectangle.x
- Defined in view/geometry/Point.ts:43
set x(x: number): void
Parameters
- x: number
Returns void
Inherited from Rectangle.x
- Defined in view/geometry/Point.ts:47

y

get y(): number
Returns number
Inherited from Rectangle.y
- Defined in view/geometry/Point.ts:53
set y(y: number): void
Parameters
- y: number
Returns void
Inherited from Rectangle.y
- Defined in view/geometry/Point.ts:57

Methods

add

add(rect: Rectangle): void
Adds the given rectangle to this rectangle.
Parameters
- rect: Rectangle
Returns void
Inherited from Rectangle.add
- Defined in view/geometry/Rectangle.ts:104

clone

clone(): CellState
Returns a clone of this Point.

Returns CellState
Overrides Rectangle.clone
- Defined in view/cell/CellState.ts:343

destroy

destroy(): void
Destroys the state and all associated resources.

Returns void
- Defined in view/cell/CellState.ts:380

equals

equals(rect: null | Rectangle): boolean
Returns true if the given object equals this rectangle.
Parameters
- rect: null | Rectangle
Returns boolean
Inherited from Rectangle.equals
- Defined in view/geometry/Rectangle.ts:167

getCellBounds

getCellBounds(): null | Rectangle
Returns the unscaled, untranslated bounds.

Returns null | Rectangle
- Defined in view/cell/CellState.ts:284

getCenterX

getCenterX(): number
Returns the x-coordinate of the center point.

Returns number
Inherited from Rectangle.getCenterX
- Defined in view/geometry/Rectangle.ts:90

getCenterY

getCenterY(): number
Returns the y-coordinate of the center point.

Returns number
Inherited from Rectangle.getCenterY
- Defined in view/geometry/Rectangle.ts:97

getImageSrc

getImageSrc(): null | string
Returns the image URL for the given cell state. This implementation returns the value stored in the CellStateStyle.image property of style.

Returns null | string
- Defined in view/cell/CellState.ts:423

getIndicatorColor

getIndicatorColor(): null | string
Returns the indicator color for the given cell state. This implementation returns the value stored in the CellStateStyle.indicatorColor property of style.

Returns null | string
- Defined in view/cell/CellState.ts:432

getIndicatorGradientColor

getIndicatorGradientColor(): null | SpecialStyleColorValue
Returns the indicator gradient color for the given cell state. This implementation returns the value stored in the CellStateStyle.gradientColor property of style.

Returns null | SpecialStyleColorValue
- Defined in view/cell/CellState.ts:441

getIndicatorImageSrc

getIndicatorImageSrc(): null | string
Returns the indicator image for the given cell state. This implementation returns the value stored in the CellStateStyle.indicatorImage property of style.

Returns null | string
- Defined in view/cell/CellState.ts:459

getIndicatorShape

getIndicatorShape(): null | StyleShapeValue
Returns the indicator shape for the given cell state. This implementation returns the value stored in the CellStateStyle.indicatorShape property of style.

Returns null | StyleShapeValue
- Defined in view/cell/CellState.ts:450

getPaintBounds

getPaintBounds(): null | Rectangle
Returns the unscaled, untranslated paint bounds.

This is the same as getCellBounds but with a 90-degrees rotation if the Shape.isPaintBoundsInverted returns true.

Returns null | Rectangle
- Defined in view/cell/CellState.ts:293

getPerimeterBounds

getPerimeterBounds(border?: number, bounds?: Rectangle): Rectangle
Returns the Rectangle that should be used as the perimeter of the cell.
Parameters
- border: number = 0
  Optional border to be added around the perimeter bounds.
- bounds: Rectangle = ...
  Optional Rectangle to be used as the initial bounds.
Returns Rectangle
- Defined in view/cell/CellState.ts:188

getPoint

getPoint(): Point
Returns the top, left corner as a new Point.

Returns Point
Inherited from Rectangle.getPoint
- Defined in view/geometry/Rectangle.ts:147

getVerticalAlign

getVerticalAlign(): VAlignValue | MIDDLE
Returns the vertical alignment for the given cell state. This implementation returns the value stored in the CellStateStyle.verticalAlign property of style.

Returns VAlignValue | MIDDLE
- Defined in view/cell/CellState.ts:403

getVisibleTerminal

getVisibleTerminal(source?: boolean): null | Cell
Returns the visible source or target terminal cell.
Parameters
- source: boolean = false
  Boolean that specifies if the source or target cell should be returned.
Returns null | Cell
- Defined in view/cell/CellState.ts:254

getVisibleTerminalState

getVisibleTerminalState(source?: boolean): null | CellState
Returns the visible source or target terminal state.
Parameters
- source: boolean = false
  Boolean that specifies if the source or target state should be returned.
Returns null | CellState
- Defined in view/cell/CellState.ts:263

grow

grow(amount: number): void
Grows the rectangle by the given amount, that is, this method subtracts the given amount from the x- and y-coordinates and adds twice the amount to the width and height.
Parameters
- amount: number
Returns void
Inherited from Rectangle.grow
- Defined in view/geometry/Rectangle.ts:137

intersect

intersect(rect: Rectangle): void
Changes this rectangle to where it overlaps with the given rectangle.
Parameters
- rect: Rectangle
Returns void
Inherited from Rectangle.intersect
- Defined in view/geometry/Rectangle.ts:119

isLoop

isLoop(state: CellState): null | boolean
Returns true if the given cell state is a loop.
Parameters
- state: CellState
  CellState that represents a potential loop.
Returns null | boolean
- Defined in view/cell/CellState.ts:389

isTransparentState

isTransparentState(): boolean
Returns true if the given state has no stroke, no fill color and no image.

Returns boolean
- Defined in view/cell/CellState.ts:410

rotate90

rotate90(): void
Rotates this rectangle by 90 degree around its center point.

Returns void
Inherited from Rectangle.rotate90
- Defined in view/geometry/Rectangle.ts:154

setAbsoluteTerminalPoint

setAbsoluteTerminalPoint(point: null | Point, isSource?: boolean): void
Sets the first or last point in depending on isSource.
Parameters
- point: null | Point
  Point that represents the terminal point.
- isSource: boolean = false
  Boolean that specifies if the first or last point should be assigned.
Returns void
- Defined in view/cell/CellState.ts:220

setCursor

setCursor(cursor: string): void
Sets the given cursor on the shape and text shape.
Parameters
- cursor: string
Returns void
- Defined in view/cell/CellState.ts:240

setRect

setRect(x: number, y: number, width: number, height: number): void
Sets this rectangle to the specified values
Parameters
- x: number
- y: number
- width: number
- height: number
Returns void
Inherited from Rectangle.setRect
- Defined in view/geometry/Rectangle.ts:80

setState

setState(state: CellState): void
Copies all fields from the given state to this state.
Parameters
- state: CellState
Returns void
- Defined in view/cell/CellState.ts:321

setVisibleTerminalState

setVisibleTerminalState(terminalState: null | CellState, source?: boolean): void
Sets the visible source or target terminal state.
Parameters
- terminalState: null | CellState
  CellState that represents the terminal.
- source: boolean = false
  Boolean that specifies if the source or target state should be set.
Returns void
- Defined in view/cell/CellState.ts:273

updateCachedBounds

updateCachedBounds(): void
Updates the cellBounds and paintBounds.

Returns void
- Defined in view/cell/CellState.ts:300

`Static`fromRectangle

fromRectangle(rect: Rectangle): Rectangle
Returns a new Rectangle which is a copy of the given rectangle.
Parameters
- rect: Rectangle
Returns Rectangle
Inherited from Rectangle.fromRectangle
- Defined in view/geometry/Rectangle.ts:73

Class CellState

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CellState

Properties

_height

Default

_width

Default

_x

_y

absoluteOffset

absolutePoints

boundingBox

cell

cellBounds

control

invalid

Default

invalidStyle

Default

length

node

origin

Default

overlays

paintBounds

parentHighlight

point

segments

shape

style

terminalDistance

text

unscaledHeight

unscaledWidth

view

visibleSourceState

visibleTargetState

Accessors

height

Returns number

Parameters

Returns void

width

Returns number

Parameters

Returns void

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

Methods

add

Parameters

Returns void

clone

Returns CellState

destroy

Returns void

equals

Parameters

Returns boolean

getCellBounds

Returns null | Rectangle

getCenterX

Returns number

getCenterY

Returns number

`Static`fromRectangle