Class LayoutManager

Implements a layout manager that runs a given layout after any changes to the graph:

Example

const layoutManager = new LayoutManager(graph);
layoutManager.getLayout = (cell, eventName) => {
  return layout;
};

See getLayout for a description of the possible eventNames.

Event: mxEvent.LAYOUT_CELLS

Fires between begin- and endUpdate after all cells have been layouted in layoutCells. The cells property contains all cells that have been passed to layoutCells.

Hierarchy (view full)

EventSource
- LayoutManager

Constructors

constructor

new LayoutManager(graph): LayoutManager
Parameters
- graph: Graph
Returns LayoutManager
Overrides EventSource.constructor
- Defined in view/layout/LayoutManager.ts:92

Properties

bubbling

bubbling: boolean = true

Specifies if the layout should bubble along the cell hierarchy.

Default

true

enabled

enabled: boolean = true

Specifies if event handling is enabled.

Default

true

eventListeners

eventListeners: EventListenerObject[] = []

Holds the event names and associated listeners in an array. The array contains the event name followed by the respective listener for each registered listener.

eventsEnabled

eventsEnabled: boolean = true

Specifies if events can be fired. Default is true.

eventSource

eventSource: null | EventTarget = null

Optional source for events. Default is null.

graph

graph: Graph

Reference to the enclosing graph.

moveHandler

moveHandler: ((...args: any[]) => any)

Holds the function that handles the move event.

resizeHandler

resizeHandler: ((...args: any[]) => any)

Holds the function that handles the resize event.

undoHandler

undoHandler: ((...args: any[]) => any)

Holds the function that handles the endUpdate event.

Methods

addAncestorsWithLayout

addAncestorsWithLayout(cell, result?): Cell[]
Adds all ancestors of the given cell that have a layout.
Parameters
- cell: null | Cell
- result: Cell[] = []
Returns Cell[]
- Defined in view/layout/LayoutManager.ts:312

addCellsWithLayout

addCellsWithLayout(cell, result?): Cell[]
Adds all ancestors of the given cell that have a layout.
Parameters
- cell: null | Cell
- result: Cell[] = []
Returns Cell[]
- Defined in view/layout/LayoutManager.ts:305

addDescendantsWithLayout

addDescendantsWithLayout(cell, result?): Cell[]
Adds all descendants of the given cell that have a layout.
Parameters
- cell: null | Cell
- result: Cell[] = []
Returns Cell[]
- Defined in view/layout/LayoutManager.ts:330

addListener

addListener(name, funct): void
Binds the specified function to the given event name. If no event name is given, then the listener is registered for all events.

The parameters of the listener are the sender and an EventObject.
Parameters
- name: string
- funct: Function
Returns void
Inherited from EventSource.addListener
- Defined in view/event/EventSource.ts:102

beforeUndo

beforeUndo(undoableEdit): void
Called from undoHandler.
Parameters
- undoableEdit: UndoableEdit
Returns void
- Defined in view/layout/LayoutManager.ts:215

cellsMoved

cellsMoved(cells, evt): void
Called from moveHandler.
Parameters
- cells: Cell[]
- evt: MouseEvent
  Mouse event that represents the mousedown.
Returns void
- Defined in view/layout/LayoutManager.ts:225

cellsResized

cellsResized(cells?, bounds?, prev?): void
Called from resizeHandler.
Parameters
- cells: null | Cell[] = null
- bounds: null | Rectangle[] = null
  mxRectangle taht represents the new bounds.
- prev: null | Cell[] = null
Returns void
- Defined in view/layout/LayoutManager.ts:249

destroy

destroy(): void
Removes all handlers from the graph and deletes the reference to it.

Returns void
- Defined in view/layout/LayoutManager.ts:393

executeLayout

executeLayout(cell, bubble?): void
Executes the given layout on the given parent.
Parameters
- cell: Cell
- bubble: boolean = false
Returns void
- Defined in view/layout/LayoutManager.ts:380

executeLayoutForCells

executeLayoutForCells(cells): void
Executes the given layout on the given parent.
Parameters
- cells: Cell[]
Returns void
- Defined in view/layout/LayoutManager.ts:348

fireEvent

fireEvent(evt, sender?): void
Dispatches the given event to the listeners which are registered for the event. The sender argument is optional. The current execution scope ("this") is used for the listener invocation (see Utils#bind).

Example:
```
fireEvent(new mxEventObject("eventName", key1, val1, .., keyN, valN))
```
Parameters
- evt: EventObject
  EventObject that represents the event.
- sender: null | EventTarget = null
  Optional sender to be passed to the listener. Default value is the return value of .
Returns void
Inherited from EventSource.fireEvent
- Defined in view/event/EventSource.ts:136

getCellsForChange

getCellsForChange(change): Cell[]
Executes all layouts which have been scheduled during the changes.
Parameters
- change: any
  mxChildChange|mxTerminalChange|mxVisibleChange|...
Returns Cell[]
- Defined in view/layout/LayoutManager.ts:283

getCellsForChanges

getCellsForChanges(changes): Cell[]
Returns the cells for which a layout should be executed.
Parameters
- changes: any[]
Returns Cell[]
- Defined in view/layout/LayoutManager.ts:267

getEventSource

getEventSource(): null | EventTarget
Returns .

Returns null | EventTarget
Inherited from EventSource.getEventSource
- Defined in view/event/EventSource.ts:85

getGraph

getGraph(): Graph
Returns the graph that this layout operates on.

Returns Graph
- Defined in view/layout/LayoutManager.ts:160

getLayout

getLayout(cell, eventName): null | GraphLayout
Returns the layout for the given cell and eventName. Possible event names are InternalEvent.MOVE_CELLS and InternalEvent.RESIZE_CELLS for callbacks on when cells are moved or resized and InternalEvent.BEGIN_UPDATE and InternalEvent.END_UPDATE for the capture and bubble phase of the layout after any changes of the model.
Parameters
- cell: null | Cell
- eventName: string
Returns null | GraphLayout
- Defined in view/layout/LayoutManager.ts:203

hasLayout

hasLayout(cell): boolean
Returns true if the given cell has a layout. This implementation invokes with Event#LAYOUT_CELLS as the eventName. Override this if creating layouts in is expensive and return true if will return a layout for the given cell for Event#BEGIN_UPDATE or Event#END_UPDATE.
Parameters
- cell: null | Cell
Returns boolean
- Defined in view/layout/LayoutManager.ts:192

isBubbling

isBubbling(): boolean
Returns true if a layout should bubble, that is, if the parent layout should be executed whenever a cell layout (layout of the children of a cell) has been executed. This implementation returns bubbling.

Returns boolean
- Defined in view/layout/LayoutManager.ts:146

isEnabled

isEnabled(): boolean
Returns true if events are handled. This implementation returns enabled.

Returns boolean
- Defined in view/layout/LayoutManager.ts:127

isEventsEnabled

isEventsEnabled(): boolean
Returns .

Returns boolean
Inherited from EventSource.isEventsEnabled
- Defined in view/event/EventSource.ts:71

layoutCells

layoutCells(cells, bubble?): void
Executes all layouts which have been scheduled during the changes.
Parameters
- cells: Cell[]
- bubble: boolean = false
Returns void
- Defined in view/layout/LayoutManager.ts:357

removeListener

removeListener(funct): void
Removes all occurrences of the given listener from .
Parameters
- funct: Function
Returns void
Inherited from EventSource.removeListener
- Defined in view/event/EventSource.ts:109

setBubbling

setBubbling(value): void
Sets bubbling.
Parameters
- value: boolean
Returns void
- Defined in view/layout/LayoutManager.ts:153

setEnabled

setEnabled(enabled): void
Enables or disables event handling. This implementation updates enabled.
Parameters
- enabled: boolean
  Boolean that specifies the new enabled state.
Returns void
- Defined in view/layout/LayoutManager.ts:137

setEventsEnabled

setEventsEnabled(value): void
Sets .
Parameters
- value: boolean
Returns void
Inherited from EventSource.setEventsEnabled
- Defined in view/event/EventSource.ts:78

setEventSource

setEventSource(value): void
Sets .
Parameters
- value: null | EventTarget
Returns void
Inherited from EventSource.setEventSource
- Defined in view/event/EventSource.ts:92

setGraph

setGraph(graph): void
Sets the graph that the layouts operate on.
Parameters
- graph: null | Graph
Returns void
- Defined in view/layout/LayoutManager.ts:167

Class LayoutManager

Example

Event: mxEvent.LAYOUT_CELLS

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LayoutManager

Properties

bubbling

Default

enabled

Default

eventListeners

eventsEnabled

eventSource

graph

moveHandler

resizeHandler

undoHandler

Methods

addAncestorsWithLayout

Parameters

Returns Cell[]

addCellsWithLayout

Parameters

Returns Cell[]

addDescendantsWithLayout

Parameters

Returns Cell[]

addListener

Parameters

Returns void

beforeUndo

Parameters

Returns void

cellsMoved

Parameters

Returns void

cellsResized

Parameters

Returns void

destroy

Returns void

executeLayout

Parameters

Returns void

executeLayoutForCells

Parameters

Returns void

fireEvent

Parameters

Returns void

getCellsForChange

Parameters

Returns Cell[]

getCellsForChanges

Parameters

Returns Cell[]

getEventSource

Returns null | EventTarget

getGraph

Returns Graph

getLayout

Parameters

Returns null | GraphLayout

hasLayout

Parameters

Returns boolean

isBubbling

Returns boolean

isEnabled

Returns boolean

isEventsEnabled

Returns boolean

layoutCells