mxLayoutManager | mxGraph Typescript Declarations

example

var layoutMgr = new mxLayoutManager(graph);
layoutMgr.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

mxEventSource
- mxLayoutManager

Index

Constructors

constructor

Properties

Constructors

constructor

new mxLayoutManager(graph: mxGraph): mxLayoutManager

Overrides mxEventSource.constructor
- Defined in view/mxLayoutManager.d.ts:27
Constructor: mxLayoutManager

Constructs a new automatic layout for the given graph.

Arguments:

Parameters
- graph: mxGraph
  
  Reference to the enclosing graph.
Returns mxLayoutManager

Properties

bubbling

bubbling: boolean

Specifies if the layout should bubble along the cell hierarchy.

default: true

enabled

enabled: boolean

Specifies if event handling is enabled.

default: true

eventListeners

eventListeners: any[]

Variable: eventListeners

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.

eventSource

eventSource: any

Variable: eventSource

Optional source for events. Default is null.

eventsEnabled

eventsEnabled: boolean

Variable: eventsEnabled

Specifies if events can be fired. Default is true.

graph

graph: mxGraph

Reference to the enclosing mxGraph.

moveHandler

moveHandler: Function

Holds the function that handles the move event.

resizeHandler

resizeHandler: Function

Holds the function that handles the resize event.

undoHandler

undoHandler: Function

Holds the function that handles the endUpdate event.

Methods

addAncestorsWithLayout

addAncestorsWithLayout(cell: mxCell, result: mxCell[]): mxCell[]

- Defined in view/mxLayoutManager.d.ts:168
Adds all ancestors of the given cell that have a layout.

Parameters
- cell: mxCell
- result: mxCell[]
Returns mxCell[]

addCellsWithLayout

addCellsWithLayout(cell: mxCell, result: mxCell[]): mxCell[]

- Defined in view/mxLayoutManager.d.ts:163
Adds all ancestors of the given cell that have a layout.

Parameters
- cell: mxCell
- result: mxCell[]
Returns mxCell[]

addDescendantsWithLayout

addDescendantsWithLayout(cell: mxCell, result: mxCell[]): mxCell[]

- Defined in view/mxLayoutManager.d.ts:173
Adds all descendants of the given cell that have a layout.

Parameters
- cell: mxCell
- result: mxCell[]
Returns mxCell[]

addListener

addListener(name: string, funct: (...args: any[]) => any): void

Inherited from mxEventSource.addListener
- Defined in util/mxEventSource.d.ts:64
Function: addListener

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 .

Parameters
- name: string
- funct: (...args: any[]) => any
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns void

beforeUndo

beforeUndo(undoableEdit: any): void

- Defined in view/mxLayoutManager.d.ts:125
Called from undoHandler.

Parameters
- undoableEdit: any
Returns void

cellsMoved

cellsMoved(cells: mxCell[], evt: MouseEvent): void

- Defined in view/mxLayoutManager.d.ts:133
Called from moveHandler.

Parameters
- cells: mxCell[]
- evt: MouseEvent
  
  Mouse event that represents the mousedown.
Returns void

cellsResized

cellsResized(cells: mxCell[], bounds: mxRectangle[], prev: any[]): void

- Defined in view/mxLayoutManager.d.ts:141
Called from resizeHandler.

Parameters
- cells: mxCell[]
- bounds: mxRectangle[]
  
  mxRectangle taht represents the new bounds.
- prev: any[]
Returns void

destroy

destroy(): void

- Defined in view/mxLayoutManager.d.ts:193
Removes all handlers from the graph and deletes the reference to it.

Returns void

executeLayout

executeLayout(cell: mxCell, bubble: string): void

- Defined in view/mxLayoutManager.d.ts:188
Executes the given layout on the given parent.

Parameters
- cell: mxCell
- bubble: string
Returns void

executeLayoutForCells

executeLayoutForCells(cells: mxCell[]): void

- Defined in view/mxLayoutManager.d.ts:178
Executes the given layout on the given parent.

Parameters
- cells: mxCell[]
Returns void

fireEvent

fireEvent(evt: mxEventObject, sender: any): void

Inherited from mxEventSource.fireEvent
- Defined in util/mxEventSource.d.ts:92
Function: fireEvent

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 <mxUtils.bind>).

Example:

(code) fireEvent(new mxEventObject("eventName", key1, val1, .., keyN, valN)) (end)

Parameters:

evt - that represents the event. sender - Optional sender to be passed to the listener. Default value is the return value of .

Parameters
- evt: mxEventObject
- sender: any
Returns void

getAncestorLayout

getAncestorLayout(cell: mxCell, eventName: string): mxGraphLayout

- Defined in view/mxLayoutManager.d.ts:146
Returns the cells to be layouted for the given sequence of changes.

Parameters
- cell: mxCell
- eventName: string
Returns mxGraphLayout

getCellsForChange

getCellsForChange(change: any): mxCell[]

- Defined in view/mxLayoutManager.d.ts:158
Executes all layouts which have been scheduled during the changes.

Parameters
- change: any
  
  mxChildChange|mxTerminalChange|mxVisibleChange|...
Returns mxCell[]

getCellsForChanges

getCellsForChanges(changes: any[]): mxCell[]

- Defined in view/mxLayoutManager.d.ts:151
Returns the cells for which a layout should be executed.

Parameters
- changes: any[]
Returns mxCell[]

getEventSource

getEventSource(): any

Inherited from mxEventSource.getEventSource
- Defined in util/mxEventSource.d.ts:47
Function: getEventSource

Returns .

Returns any

getGraph

getGraph(): mxGraph

- Defined in view/mxLayoutManager.d.ts:101
Returns the graph that this layout operates on.

Returns mxGraph

getLayout

getLayout(cell: mxCell, eventName?: string): null | mxGraphLayout

- Defined in view/mxLayoutManager.d.ts:115
Returns the layout for the given cell and eventName. Possible event names are mxEvent.MOVE_CELLS and mxEvent.RESIZE_CELLS for callbacks on when cells are moved or resized and mxEvent.BEGIN_UPDATE and mxEvent.END_UPDATE for the capture and bubble phase of the layout after any changes of the model.

Parameters
- cell: mxCell
- Optional eventName: string
Returns null | mxGraphLayout

isBubbling

isBubbling(): boolean

- Defined in view/mxLayoutManager.d.ts:91
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

isEnabled

isEnabled(): boolean

- Defined in view/mxLayoutManager.d.ts:76
Returns true if events are handled. This implementation returns enabled.

Returns boolean

isEventsEnabled

isEventsEnabled(): boolean

Inherited from mxEventSource.isEventsEnabled
- Defined in util/mxEventSource.d.ts:33
Function: isEventsEnabled

Returns .

Returns boolean

layoutCells

layoutCells(cells: mxCell[], bubble: string): void

- Defined in view/mxLayoutManager.d.ts:183
Executes all layouts which have been scheduled during the changes.

Parameters
- cells: mxCell[]
- bubble: string
Returns void

removeListener

removeListener(funct: (...args: any[]) => any): void

Inherited from mxEventSource.removeListener
- Defined in util/mxEventSource.d.ts:71
Function: removeListener

Removes all occurrences of the given listener from .

Parameters
- funct: (...args: any[]) => any
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns void

setBubbling

setBubbling(value: boolean): void

- Defined in view/mxLayoutManager.d.ts:96
Sets bubbling.

Parameters
- value: boolean
Returns void

setEnabled

setEnabled(enabled: boolean): void

- Defined in view/mxLayoutManager.d.ts:84
Enables or disables event handling. This implementation updates enabled.

Parameters
- enabled: boolean
  
  Boolean that specifies the new enabled state.
Returns void

setEventSource

setEventSource(value: any): void

Inherited from mxEventSource.setEventSource
- Defined in util/mxEventSource.d.ts:54
Function: setEventSource

Sets .

Parameters
- value: any
Returns void

setEventsEnabled

setEventsEnabled(value: boolean): void

Inherited from mxEventSource.setEventsEnabled
- Defined in util/mxEventSource.d.ts:40
Function: setEventsEnabled

Sets .

Parameters
- value: boolean
Returns void

setGraph

setGraph(graph: mxGraph): void

- Defined in view/mxLayoutManager.d.ts:106
Sets the graph that the layouts operate on.

Parameters
- graph: mxGraph
Returns void

Event: mxEvent.LAYOUT_CELLS

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

graph: mxGraph

Returns mxLayoutManager

Properties

bubbling

enabled

eventListeners

eventSource

eventsEnabled

graph

moveHandler

resizeHandler

undoHandler

Methods

addAncestorsWithLayout

Parameters

cell: mxCell

result: mxCell[]

Returns mxCell[]

addCellsWithLayout

Parameters

cell: mxCell

result: mxCell[]

Returns mxCell[]

addDescendantsWithLayout

Parameters

cell: mxCell

result: mxCell[]

Returns mxCell[]

addListener

Parameters

name: string

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

Parameters

Rest ...args: any[]

Returns any

Returns void

beforeUndo

Parameters

undoableEdit: any

Returns void

cellsMoved

Parameters

cells: mxCell[]

evt: MouseEvent

Returns void

cellsResized

Parameters

cells: mxCell[]

bounds: mxRectangle[]

prev: any[]

Returns void

destroy

Returns void

executeLayout

Parameters

cell: mxCell

bubble: string

Returns void

executeLayoutForCells

Parameters

cells: mxCell[]

Returns void

fireEvent

Parameters

evt: mxEventObject

sender: any

Returns void

getAncestorLayout

Parameters

cell: mxCell

eventName: string