mxCellState | mxGraph Typescript Declarations

Hierarchy

mxRectangle
- mxCellState

Index

Constructors

constructor

Properties

Constructors

constructor

new mxCellState(view: mxGraphView, cell: mxCell, style: {}): mxCellState

Overrides mxRectangle.constructor
- Defined in view/mxCellState.d.ts:2
Parameters
- view: mxGraphView
- cell: mxCell
- style: {}
  - [key: string]: any
Returns mxCellState

Properties

absoluteOffset

absoluteOffset: mxPoint

Variable: absoluteOffset

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: mxPoint[]

Variable: absolutePoints

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

cell

cell: mxCell

Variable: cell

Reference to the that is represented by this state.

control

control: mxShape

height

height: number

Variable: height

Holds the height of the rectangle. Default is 0.

invalid

invalid: boolean

Variable: invalid

Specifies if the state is invalid. Default is true.

length

length: number

Variable: length

Caches the length of an edge.

origin

origin: mxPoint

Variable: origin

that holds the origin for all child cells. Default is a new empty .

segments

segments: number[]

Variable: segments

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

shape

shape: mxShape

Variable: shape

Holds the that represents the cell graphically.

style

style: {}

Variable: style

Contains an array of key, value pairs that represent the style of the cell.

Type declaration

[key: string]: any

terminalDistance

terminalDistance: number

Variable: terminalDistance

Caches the distance between the end points for an edge.

text

text: mxText

Variable: text

Holds the that represents the label of the cell. Thi smay be null if the cell has no label.

unscaledWidth

unscaledWidth: number

Variable: unscaledWidth

Holds the unscaled width of the state.

view

view: mxGraphView

Variable: view

Reference to the enclosing .

visibleSourceState

visibleSourceState: mxCellState

Variable: visibleSourceState

Caches the visible source terminal state.

visibleTargetState

visibleTargetState: mxCellState

Variable: visibleTargetState

Caches the visible target terminal state.

width

width: number

Variable: width

Holds the width of the rectangle. Default is 0.

x

x: number

Variable: x

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

y

y: number

Variable: y

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

Methods

add

add(rect: mxRectangle): void

Inherited from mxRectangle.add
- Defined in util/mxRectangle.d.ts:45
Function: add

Adds the given rectangle to this rectangle.

Parameters
- rect: mxRectangle
Returns void

clone

clone(): mxCellState

Overrides mxRectangle.clone
- Defined in view/mxCellState.d.ts:223
Function: clone

Returns a clone of this .

Returns mxCellState

destroy

destroy(): void

- Defined in view/mxCellState.d.ts:230
Destructor: destroy

Destroys the state and all associated resources.

Returns void

equals

equals(obj: mxRectangle): boolean

Inherited from mxRectangle.equals
- Defined in util/mxRectangle.d.ts:82
Function: equals

Returns true if the given object equals this rectangle.

Parameters
- obj: mxRectangle
Returns boolean

fromRectangle

fromRectangle(rect: mxRectangle): mxRectangle

Inherited from mxRectangle.fromRectangle
- Defined in util/mxRectangle.d.ts:89
Function: fromRectangle

Returns a new which is a copy of the given rectangle.

Parameters
- rect: mxRectangle
Returns mxRectangle

getCellBounds

getCellBounds(): mxRectangle

- Defined in view/mxCellState.d.ts:193
Function: getCellBounds

Returns the unscaled, untranslated bounds.

Returns mxRectangle

getCenterX

getCenterX(): number

Inherited from mxRectangle.getCenterX
- Defined in util/mxRectangle.d.ts:31
Function: getCenterX

Returns the x-coordinate of the center point.

Returns number

getCenterY

getCenterY(): number

Inherited from mxRectangle.getCenterY
- Defined in util/mxRectangle.d.ts:38
Function: getCenterY

Returns the y-coordinate of the center point.

Returns number

getPaintBounds

getPaintBounds(): mxRectangle

- Defined in view/mxCellState.d.ts:202
Function: getPaintBounds

Returns the unscaled, untranslated paint bounds. This is the same as but with a 90 degree rotation if the shape's isPaintBoundsInverted returns true.

Returns mxRectangle

getPerimeterBounds

getPerimeterBounds(border?: number, bounds?: mxRectangle): mxRectangle

- Defined in view/mxCellState.d.ts:130
Function: getPerimeterBounds

Returns the that should be used as the perimeter of the cell.

Parameters:

border - Optional border to be added around the perimeter bounds. bounds - Optional to be used as the initial bounds.

Parameters
- Optional border: number
- Optional bounds: mxRectangle
Returns mxRectangle

getPoint

getPoint(): mxPoint

Inherited from mxRectangle.getPoint
- Defined in util/mxRectangle.d.ts:68
Function: getPoint

Returns the top, left corner as a new .

Returns mxPoint

getVisibleTerminal

getVisibleTerminal(source: boolean): mxCell

- Defined in view/mxCellState.d.ts:162
Function: getVisibleTerminal

Returns the visible source or target terminal cell.

Parameters:

source - Boolean that specifies if the source or target cell should be returned.

Parameters
- source: boolean
Returns mxCell

getVisibleTerminalState

getVisibleTerminalState(source?: boolean): mxCellState

- Defined in view/mxCellState.d.ts:174
Function: getVisibleTerminalState

Returns the visible source or target terminal state.

Parameters:

source - Boolean that specifies if the source or target state should be returned.

Parameters
- Optional source: boolean
Returns mxCellState

grow

grow(amount: number): void

Inherited from mxRectangle.grow
- Defined in util/mxRectangle.d.ts:61
Function: grow

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

intersect

intersect(rect: mxRectangle): void

Inherited from mxRectangle.intersect
- Defined in util/mxRectangle.d.ts:52
Function: intersect

Changes this rectangle to where it overlaps with the given rectangle.

Parameters
- rect: mxRectangle
Returns void

rotate90

rotate90(): void

Inherited from mxRectangle.rotate90
- Defined in util/mxRectangle.d.ts:75
Function: rotate90

Rotates this rectangle by 90 degree around its center point.

Returns void

setAbsoluteTerminalPoint

setAbsoluteTerminalPoint(point: mxPoint, isSource: boolean): void

- Defined in view/mxCellState.d.ts:143
Function: setAbsoluteTerminalPoint

Sets the first or last point in depending on isSource.

Parameters:

point - that represents the terminal point. isSource - Boolean that specifies if the first or last point should be assigned.

Parameters
- point: mxPoint
- isSource: boolean
Returns void

setCursor

setCursor(cursor: string): void

- Defined in view/mxCellState.d.ts:150
Function: setCursor

Sets the given cursor on the shape and text shape.

Parameters
- cursor: string
Returns void

setRect

setRect(x: number, y: number, w: number, h: number): void

Inherited from mxRectangle.setRect
- Defined in util/mxRectangle.d.ts:24
Function: setRect

Sets this rectangle to the specified values

Parameters
- x: number
- y: number
- w: number
- h: number
Returns void

setState

setState(state: mxCellState): void

- Defined in view/mxCellState.d.ts:216
Destructor: setState

Copies all fields from the given state to this state.

Parameters
- state: mxCellState
Returns void

setVisibleTerminalState

setVisibleTerminalState(terminalState: mxCellState, source: boolean): void

- Defined in view/mxCellState.d.ts:186
Function: setVisibleTerminalState

Sets the visible source or target terminal state.

Parameters:

terminalState - that represents the terminal. source - Boolean that specifies if the source or target state should be set.

Parameters
- terminalState: mxCellState
- source: boolean
Returns void

updateCachedBounds

updateCachedBounds(): void

- Defined in view/mxCellState.d.ts:209
Function: updateCachedBounds

Updates the cellBounds and paintBounds.

Returns void

Static fromRectangle

fromRectangle(rect: mxRectangle): mxRectangle

Inherited from mxRectangle.fromRectangle
- Defined in util/mxRectangle.d.ts:93
Parameters
- rect: mxRectangle
Returns mxRectangle

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

view: mxGraphView

cell: mxCell

style: {}

[key: string]: any

Returns mxCellState

Properties

absoluteOffset

absolutePoints

cell

control

height

invalid

length

origin

segments

shape

style

Type declaration

[key: string]: any

terminalDistance

text

unscaledWidth

view

visibleSourceState

visibleTargetState

width

x

y

Methods

add

Parameters

rect: mxRectangle

Returns void

clone

Returns mxCellState

destroy

Returns void

equals

Parameters

obj: mxRectangle

Returns boolean

fromRectangle

Parameters

rect: mxRectangle

Returns mxRectangle

getCellBounds

Returns mxRectangle

getCenterX

Returns number

getCenterY

Returns number

getPaintBounds

Returns mxRectangle

getPerimeterBounds

Parameters

Optional border: number

Optional bounds: mxRectangle

Returns mxRectangle

getPoint

Returns mxPoint

getVisibleTerminal

Parameters

source: boolean

Returns mxCell

getVisibleTerminalState

Parameters

Optional source: boolean

Returns mxCellState

grow

Parameters

amount: number

Returns void