state | diagram-maker

Index

Namespaces

<internal>

Enumerations

Interfaces

Type aliases

Variables

Type aliases

ActionInterceptor

ActionInterceptor<NodeType, EdgeType>: (action: Action, dispatch: Dispatch<Action>, getState: () => DiagramMakerData<NodeType, EdgeType>) => void

Type parameters

NodeType
EdgeType

Type declaration

- (action: Action, dispatch: Dispatch<Action>, getState: () => DiagramMakerData<NodeType, EdgeType>): void
- Parameters
  - action: Action
  - dispatch: Dispatch<Action>
  - getState: () => DiagramMakerData<NodeType, EdgeType>
    - - (): DiagramMakerData<NodeType, EdgeType>
      - Returns DiagramMakerData<NodeType, EdgeType>
  Returns void

NodeAction

Type parameters

NodeType

PanelAction

PanelAction: ResizePanelAction | DragPanelAction | DragStartPanelAction

WorkspaceAction

Variables

Const NodeActions

NodeActions: { NODE_CREATE: NODE_CREATE; NODE_DELETE: NODE_DELETE; NODE_DRAG: NODE_DRAG; NODE_DRAG_END: NODE_DRAG_END; NODE_DRAG_START: NODE_DRAG_START; NODE_LAYOUT: NODE_LAYOUT; NODE_SELECT: NODE_SELECT; POTENTIAL_NODE_DRAG: POTENTIAL_NODE_DRAG; POTENTIAL_NODE_DRAG_END: POTENTIAL_NODE_DRAG_END; POTENTIAL_NODE_DRAG_START: POTENTIAL_NODE_DRAG_START } = ...

Type declaration

NODE_CREATE: NODE_CREATE
NODE_DELETE: NODE_DELETE
NODE_DRAG: NODE_DRAG
NODE_DRAG_END: NODE_DRAG_END
NODE_DRAG_START: NODE_DRAG_START
NODE_LAYOUT: NODE_LAYOUT
NODE_SELECT: NODE_SELECT
POTENTIAL_NODE_DRAG: POTENTIAL_NODE_DRAG
POTENTIAL_NODE_DRAG_END: POTENTIAL_NODE_DRAG_END
POTENTIAL_NODE_DRAG_START: POTENTIAL_NODE_DRAG_START

Const PanelActions

PanelActions: { PANEL_DRAG: PANEL_DRAG; PANEL_DRAG_START: PANEL_DRAG_START; PANEL_RESIZE: PANEL_RESIZE } = ...

Type declaration

PANEL_DRAG: PANEL_DRAG
PANEL_DRAG_START: PANEL_DRAG_START
PANEL_RESIZE: PANEL_RESIZE

Const WorkspaceActions

WorkspaceActions: { WORKSPACE_CANVAS_RESIZE: WORKSPACE_CANVAS_RESIZE; WORKSPACE_DESELECT: WORKSPACE_DESELECT; WORKSPACE_DRAG: WORKSPACE_DRAG; WORKSPACE_RESET_ZOOM: WORKSPACE_RESET_ZOOM; WORKSPACE_RESIZE: WORKSPACE_RESIZE; WORKSPACE_SELECT_ALL: WORKSPACE_SELECT_ALL; WORKSPACE_ZOOM: WORKSPACE_ZOOM } = ...

Type declaration

WORKSPACE_CANVAS_RESIZE: WORKSPACE_CANVAS_RESIZE
WORKSPACE_DESELECT: WORKSPACE_DESELECT
WORKSPACE_DRAG: WORKSPACE_DRAG
WORKSPACE_RESET_ZOOM: WORKSPACE_RESET_ZOOM
WORKSPACE_RESIZE: WORKSPACE_RESIZE
WORKSPACE_SELECT_ALL: WORKSPACE_SELECT_ALL
WORKSPACE_ZOOM: WORKSPACE_ZOOM

Functions

adjustWorkspace

adjustWorkspace<NodeType, EdgeType>(state: DiagramMakerData<NodeType, EdgeType>): DiagramMakerData<NodeType, EdgeType>

- Defined in src/state/layout/layoutReducer.ts:10
Type parameters
- NodeType
- EdgeType
Parameters
- state: DiagramMakerData<NodeType, EdgeType>
Returns DiagramMakerData<NodeType, EdgeType>

createDeleteItemsAction

createDeleteItemsAction(nodeIds: string[], edgeIds: string[]): DeleteItemsAction

- Defined in src/state/global/globalActionDispatcher.ts:7
Parameters
- nodeIds: string[]
- edgeIds: string[]
Returns DeleteItemsAction

createFitAction

createFitAction(nodeRects: Rectangle[], leftPanelWidth?: number, rightPanelWidth?: number): FitAction

- Defined in src/state/editor/editorActionDispatcher.ts:90
Parameters
- nodeRects: Rectangle[]
- Optional leftPanelWidth: number
- Optional rightPanelWidth: number
Returns FitAction

createFocusNodeAction

createFocusNodeAction(id: string, position: Position, size: Size, leftPanelWidth?: number, rightPanelWidth?: number): FocusNodeAction

- Defined in src/state/editor/editorActionDispatcher.ts:75
Parameters
- id: string
- position: Position
- size: Size
- Optional leftPanelWidth: number
- Optional rightPanelWidth: number
Returns FocusNodeAction

createInterceptorMiddleware

createInterceptorMiddleware<NodeType, EdgeType>(actionInterceptor?: ActionInterceptor<NodeType, EdgeType>): (store: MiddlewareAPI<Dispatch<AnyAction>, any>) => (next: Dispatch<Action<any>>) => (action: Action<any>) => void

- Defined in src/state/middleware/createInterceptorMiddleware.ts:7
Type parameters
- NodeType
- EdgeType
Parameters
- Optional actionInterceptor: ActionInterceptor<NodeType, EdgeType>
Returns (store: MiddlewareAPI<Dispatch<AnyAction>, any>) => (next: Dispatch<Action<any>>) => (action: Action<any>) => void
- - (store: MiddlewareAPI<Dispatch<AnyAction>, any>): (next: Dispatch<Action<any>>) => (action: Action<any>) => void
  - Parameters
    - store: MiddlewareAPI<Dispatch<AnyAction>, any>
    Returns (next: Dispatch<Action<any>>) => (action: Action<any>) => void
    - - (next: Dispatch<Action<any>>): (action: Action<any>) => void
      - Parameters
        next: Dispatch<Action<any>>
        Returns (action: Action<any>) => void
        (action: Action<any>): void
        Parameters
        action: Action<any>
        Returns void

createLayoutAction

createLayoutAction(layoutConfig: LayoutConfig): LayoutAction

- Defined in src/state/layout/layoutActionDispatcher.ts:3
Parameters
- layoutConfig: LayoutConfig
Returns LayoutAction

createNewItemsAction

createNewItemsAction<NodeType, EdgeType>(nodes: DiagramMakerNode<NodeType>[], edges: DiagramMakerEdge<EdgeType>[]): CreateItemsAction<NodeType, EdgeType>

- Defined in src/state/global/globalActionDispatcher.ts:20
Type parameters
- NodeType
- EdgeType
Parameters
- nodes: DiagramMakerNode<NodeType>[]
- edges: DiagramMakerEdge<EdgeType>[]
Returns CreateItemsAction<NodeType, EdgeType>

createSetEditorModeAction

createSetEditorModeAction(mode: EditorModeType): SetEditorModeAction

- Defined in src/state/editor/editorActionDispatcher.ts:68
Parameters
- mode: EditorModeType
Returns SetEditorModeAction

createStore

createStore<NodeType, EdgeType>(initialData?: DiagramMakerData<NodeType, EdgeType>, consumerRootReducer?: Reducer<DiagramMakerData<NodeType, EdgeType>, DiagramMakerAction<NodeType, EdgeType>>, consumerEnhancer?: StoreEnhancer<{}, {}>, actionInterceptor?: ActionInterceptor<NodeType, EdgeType>): Store<DiagramMakerData<NodeType, EdgeType>>

- Defined in src/state/createStore.ts:17
Type parameters
- NodeType
- EdgeType
Parameters
- Optional initialData: DiagramMakerData<NodeType, EdgeType>
- Optional consumerRootReducer: Reducer<DiagramMakerData<NodeType, EdgeType>, DiagramMakerAction<NodeType, EdgeType>>
- Optional consumerEnhancer: StoreEnhancer<{}, {}>
- Optional actionInterceptor: ActionInterceptor<NodeType, EdgeType>
Returns Store<DiagramMakerData<NodeType, EdgeType>>

edgeReducer

edgeReducer<NodeType, EdgeType>(state: undefined | DiagramMakerEdges<EdgeType>, action: DiagramMakerAction<NodeType, EdgeType>): DiagramMakerEdges<EdgeType>

- Defined in src/state/edge/edgeReducer.ts:11
Type parameters
- NodeType
- EdgeType
Parameters
- state: undefined | DiagramMakerEdges<EdgeType>
- action: DiagramMakerAction<NodeType, EdgeType>
Returns DiagramMakerEdges<EdgeType>

editorReducer

editorReducer<NodeType, EdgeType>(state: undefined | DiagramMakerEditor, action: DiagramMakerAction<NodeType, EdgeType>): DiagramMakerEditor

- Defined in src/state/editor/editorReducer.ts:8
Type parameters
- NodeType
- EdgeType
Parameters
- state: undefined | DiagramMakerEditor
- action: DiagramMakerAction<NodeType, EdgeType>
Returns DiagramMakerEditor

getDefaultWorkspaceState

getDefaultWorkspaceState(): DiagramMakerWorkspace

- Defined in src/state/workspace/workspaceReducer.ts:24
Returns DiagramMakerWorkspace

getRootReducer

getRootReducer<NodeType, EdgeType>(): RootReducer<NodeType, EdgeType>

- Defined in src/state/common/rootReducer.ts:18
Type parameters
- NodeType
- EdgeType
Returns RootReducer<NodeType, EdgeType>

getUndoMiddleware

getUndoMiddleware<NodeType, EdgeType>(): Middleware<{}, any, Dispatch<AnyAction>>

- Defined in src/state/middleware/undoMiddleware.ts:10
Type parameters
- NodeType
- EdgeType
Returns Middleware<{}, any, Dispatch<AnyAction>>

handleDeleteSelectedItems

handleDeleteSelectedItems<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>): void

- Defined in src/state/global/globalActionDispatcher.ts:33
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
Returns void

handleEdgeClick

handleEdgeClick<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>, id: undefined | string): void

- Defined in src/state/edge/edgeActionDispatcher.ts:107
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
- id: undefined | string
Returns void

handleEdgeCreate

handleEdgeCreate<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>, src: undefined | string, dest: undefined | string): void

- Defined in src/state/edge/edgeActionDispatcher.ts:91
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
- src: undefined | string
- dest: undefined | string
Returns void

handleEdgeDrag

handleEdgeDrag<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>, position: Position): void

- Defined in src/state/edge/edgeActionDispatcher.ts:84
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
- position: Position
Returns void

handleEdgeDragEnd

handleEdgeDragEnd<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>, id: undefined | string): void

- Defined in src/state/edge/edgeActionDispatcher.ts:75
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
- id: undefined | string
Returns void

handleEdgeDragStart

handleEdgeDragStart<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>, id: undefined | string, position: Position): void

- Defined in src/state/edge/edgeActionDispatcher.ts:65
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
- id: undefined | string
- position: Position
Returns void

handleEdgeMouseOut

handleEdgeMouseOut<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>, id: undefined | string): void

- Defined in src/state/edge/edgeActionDispatcher.ts:125
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
- id: undefined | string
Returns void

handleEdgeMouseOver

handleEdgeMouseOver<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>, id: undefined | string): void

- Defined in src/state/edge/edgeActionDispatcher.ts:116
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
- id: undefined | string
Returns void

handleHideContextMenu

handleHideContextMenu<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>): void

- Defined in src/state/editor/editorActionDispatcher.ts:115
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
Returns void

handleHideSelectionMarquee

handleHideSelectionMarquee<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>): void

- Defined in src/state/editor/editorActionDispatcher.ts:148
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
Returns void

handleShowContextMenu

handleShowContextMenu<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>, config: ConfigService<NodeType, EdgeType>, event: NormalizedMouseClickEvent): void

- Defined in src/state/editor/editorActionDispatcher.ts:97
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
- config: ConfigService<NodeType, EdgeType>
- event: NormalizedMouseClickEvent
Returns void

handleShowSelectionMarquee

handleShowSelectionMarquee<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>, anchor: Position): void

- Defined in src/state/editor/editorActionDispatcher.ts:126
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
- anchor: Position
Returns void

handleUpdateSelectionMarquee

handleUpdateSelectionMarquee<NodeType, EdgeType>(store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>, position: Position): void

- Defined in src/state/editor/editorActionDispatcher.ts:135
Type parameters
- NodeType
- EdgeType
Parameters
- store: Store<DiagramMakerData<NodeType, EdgeType>, AnyAction>
- position: Position
Returns void

hierarchicalLayout

hierarchicalLayout<NodeType, EdgeType>(state: DiagramMakerData<NodeType, EdgeType>, layoutConfig: HierarchicalLayoutConfig): DiagramMakerData<NodeType, EdgeType>

- Defined in src/state/layout/hierarchicalLayout.ts:372
Type parameters
- NodeType
- EdgeType
Parameters
- state: DiagramMakerData<NodeType, EdgeType>
- layoutConfig: HierarchicalLayoutConfig
Returns DiagramMakerData<NodeType, EdgeType>

layoutReducer

layoutReducer<NodeType, EdgeType>(state: undefined | DiagramMakerData<NodeType, EdgeType>, action: DiagramMakerAction<NodeType, EdgeType>): DiagramMakerData<NodeType, EdgeType>

- Defined in src/state/layout/layoutReducer.ts:52
Type parameters
- NodeType
- EdgeType
Parameters
- state: undefined | DiagramMakerData<NodeType, EdgeType>
- action: DiagramMakerAction<NodeType, EdgeType>
Returns DiagramMakerData<NodeType, EdgeType>

nodeReducer

nodeReducer<NodeType, EdgeType>(state: undefined | DiagramMakerNodes<NodeType>, action: DiagramMakerAction<NodeType, EdgeType>): DiagramMakerNodes<NodeType>

- Defined in src/state/node/nodeReducer.ts:36
Type parameters
- NodeType
- EdgeType
Parameters
- state: undefined | DiagramMakerNodes<NodeType>
- action: DiagramMakerAction<NodeType, EdgeType>
Returns DiagramMakerNodes<NodeType>

panelReducer

panelReducer<NodeType, EdgeType>(state: undefined | DiagramMakerPanels, action: DiagramMakerAction<NodeType, EdgeType>): DiagramMakerPanels

- Defined in src/state/panel/panelReducer.ts:96
Type parameters
- NodeType
- EdgeType
Parameters
- state: undefined | DiagramMakerPanels
- action: DiagramMakerAction<NodeType, EdgeType>
Returns DiagramMakerPanels

pluginReducer

pluginReducer<NodeType, EdgeType>(state: undefined | DiagramMakerPlugins, _action: DiagramMakerAction<NodeType, EdgeType>): DiagramMakerPlugins

- Defined in src/state/plugin/pluginReducer.ts:4
Type parameters
- NodeType
- EdgeType
Parameters
- state: undefined | DiagramMakerPlugins
- _action: DiagramMakerAction<NodeType, EdgeType>
Returns DiagramMakerPlugins

potentialEdgeReducer

potentialEdgeReducer<NodeType, EdgeType>(state: undefined | null | DiagramMakerPotentialEdge, action: DiagramMakerAction<NodeType, EdgeType>): DiagramMakerPotentialEdge | null

- Defined in src/state/edge/potentialEdgeReducer.ts:8
Type parameters
- NodeType
- EdgeType
Parameters
- state: undefined | null | DiagramMakerPotentialEdge
- action: DiagramMakerAction<NodeType, EdgeType>
Returns DiagramMakerPotentialEdge | null

potentialNodeReducer

potentialNodeReducer<NodeType, EdgeType>(state: undefined | null | DiagramMakerPotentialNode, action: DiagramMakerAction<NodeType, EdgeType>): DiagramMakerPotentialNode | null

- Defined in src/state/node/potentialNodeReducer.ts:10
Type parameters
- NodeType
- EdgeType
Parameters
- state: undefined | null | DiagramMakerPotentialNode
- action: DiagramMakerAction<NodeType, EdgeType>
Returns DiagramMakerPotentialNode | null

readOnlyEventFilter

readOnlyEventFilter(event: NormalizedEvent): boolean

- Defined in src/state/mode/readOnly/readOnlyEventFilter.ts:7
Parameters
- event: NormalizedEvent
Returns boolean

rootEventFilter

rootEventFilter(e: NormalizedEvent, editorMode: EditorModeType): boolean

- Defined in src/state/mode/rootEventFilter.ts:8
Parameters
- e: NormalizedEvent
- editorMode: EditorModeType
Returns boolean

workflowLayout

workflowLayout<NodeType, EdgeType>(state: DiagramMakerData<NodeType, EdgeType>, workflowConfig: WorkflowLayoutConfig): DiagramMakerData<NodeType, EdgeType>

- Defined in src/state/layout/workflowLayout.ts:24
Type parameters
- NodeType
- EdgeType
Parameters
- state: DiagramMakerData<NodeType, EdgeType>
- workflowConfig: WorkflowLayoutConfig
Returns DiagramMakerData<NodeType, EdgeType>

workspaceReducer

workspaceReducer<NodeType, EdgeType>(state: undefined | DiagramMakerWorkspace, action: DiagramMakerAction<NodeType, EdgeType>): DiagramMakerWorkspace

- Defined in src/state/workspace/workspaceReducer.ts:210
Type parameters
- NodeType
- EdgeType
Parameters
- state: undefined | DiagramMakerWorkspace
- action: DiagramMakerAction<NodeType, EdgeType>
Returns DiagramMakerWorkspace

Index

Namespaces

Enumerations

Interfaces

Type aliases

Variables

Functions

Type aliases

ActionInterceptor

Type parameters

NodeType

EdgeType

Type declaration

Parameters

action: Action

dispatch: Dispatch<Action>

getState: () => DiagramMakerData<NodeType, EdgeType>

Returns DiagramMakerData<NodeType, EdgeType>

Returns void

NodeAction

Type parameters

NodeType

PanelAction

WorkspaceAction

Variables

Const NodeActions

Type declaration

NODE_CREATE: NODE_CREATE

NODE_DELETE: NODE_DELETE

NODE_DRAG: NODE_DRAG

NODE_DRAG_END: NODE_DRAG_END

NODE_DRAG_START: NODE_DRAG_START

NODE_LAYOUT: NODE_LAYOUT

NODE_SELECT: NODE_SELECT

POTENTIAL_NODE_DRAG: POTENTIAL_NODE_DRAG

POTENTIAL_NODE_DRAG_END: POTENTIAL_NODE_DRAG_END

POTENTIAL_NODE_DRAG_START: POTENTIAL_NODE_DRAG_START

Const PanelActions

Type declaration

PANEL_DRAG: PANEL_DRAG

PANEL_DRAG_START: PANEL_DRAG_START

PANEL_RESIZE: PANEL_RESIZE

Const WorkspaceActions

Type declaration

WORKSPACE_CANVAS_RESIZE: WORKSPACE_CANVAS_RESIZE

WORKSPACE_DESELECT: WORKSPACE_DESELECT

WORKSPACE_DRAG: WORKSPACE_DRAG

WORKSPACE_RESET_ZOOM: WORKSPACE_RESET_ZOOM

WORKSPACE_RESIZE: WORKSPACE_RESIZE

WORKSPACE_SELECT_ALL: WORKSPACE_SELECT_ALL

WORKSPACE_ZOOM: WORKSPACE_ZOOM

Functions

adjustWorkspace

Type parameters

NodeType

EdgeType

Parameters

state: DiagramMakerData<NodeType, EdgeType>

Returns DiagramMakerData<NodeType, EdgeType>

createDeleteItemsAction

Parameters

nodeIds: string[]

edgeIds: string[]

Returns DeleteItemsAction

createFitAction

Parameters

nodeRects: Rectangle[]

Optional leftPanelWidth: number

Optional rightPanelWidth: number

Returns FitAction

createFocusNodeAction

Parameters

id: string

position: Position

size: Size

Optional leftPanelWidth: number

Optional rightPanelWidth: number

Returns FocusNodeAction

createInterceptorMiddleware

Type parameters