Class ConnectorBaseEditor

ConnectorBaseEditor covers basic connector creating and editing features. It is used to edit most of the common connector types that don't require some special editor treatment.

Hierarchy

  • ConnectorBaseEditor

Constructors

constructor

Properties

_container _isSelected _language _state activeGrip? connector controlBox grip1 grip2 manipulationStartX manipulationStartY movingPort? overlayContainer prevX prevY

Accessors

container isSelected propertyPanels settings state

Methods

addControlGrips createGrip dblClick deselect dispose hideControlBox manipulate ownsTarget pointerDown pointerUp positionGrip positionGrips resize restoreState scale select setupControlBox showControlBox

Events

onConnectorCreated? onConnectorUpdated?

Constructors

constructor

Properties

Protected _container

_container: SVGGElement

SVG group container encapsulating all the connector's elements.

Protected _isSelected

_isSelected: boolean = false

Is connector selected?

Protected _language

_language: Language

Language (localization) subsystem instance.

Protected _state

_state: ConnectorState = 'new'

Current state of the connector editor.

Protected Optional activeGrip

activeGrip?: ResizeGrip

Active manipulation grip.

connector

connector: ConnectorBase

Connector being edited by this connector editor.

Protected controlBox

controlBox: SVGGElement

Container for control elements.

Protected grip1

grip1: ResizeGrip

First manipulation grip

Protected grip2

grip2: ResizeGrip

Second manipulation grip.

Protected manipulationStartX

manipulationStartX: number = 0

Initial X coordinate where pointer manipulation has started.

Protected manipulationStartY

manipulationStartY: number = 0

Initial Y coordinate where pointer manipulation has started.

Optional movingPort

movingPort?: Port

Reference to the port being moved.

Protected overlayContainer

overlayContainer: HTMLDivElement

HTML overlay container for editor elements like text editor, etc.

Protected prevX

prevX: number = 0

Pointer's X coordinate after the previous pointer event.

Protected prevY

prevY: number = 0

Pointer's Y coordinate after the previous pointer event.

Accessors

container

  • get container(): SVGGElement

  • Returns the SVG group container for the connector's elements.

    Returns SVGGElement

isSelected

  • get isSelected(): boolean

  • Returns true if the connector is currently selected.

    Returns boolean

propertyPanels

Protected settings

state

Methods

Protected addControlGrips

  • Adds control grips to the editor.

    Returns void

Protected createGrip

dblClick

  • Handles double-click event on the connector - opens the text editor for the label.

    Parameters

    • point: IPoint

      pointer location.

    • Optional target: EventTarget

      immediate event target.

    Returns void

deselect

  • Deselects the connector.

    Returns void

dispose

  • Disposes of the editor.

    Returns void

Protected hideControlBox

  • Hides the connector editor controls.

    Returns void

manipulate

  • Handles pointer manipulation depending on the editor's state (movement, resizing, etc.)

    Parameters

    • point: IPoint

      pointer location.

    Returns void

ownsTarget

  • Returns true if the supplied element (event target) belongs to this connector or connector editor.

    Parameters

    • el: null | EventTarget

      target element.

    Returns boolean

    true if the element belongs to the connector or editor.

pointerDown

  • Handles pointerdown event on the connector editor.

    Parameters

    • point: IPoint

      pointer location.

    • Optional target: EventTarget

      immediate pointer event target.

    Returns void

pointerUp

  • Handles the pointerup event.

    Parameters

    • point: IPoint

      pointer location.

    Returns void

Protected positionGrip

  • Positions a control grip at specified location.

    Parameters

    • grip: SVGGraphicsElement

      grip to position.

    • x: number

      horizontal coordinate.

    • y: number

      vertical coordinate.

    Returns void

Protected positionGrips

  • Positions control grips according to the connector's position.

    Returns void

Protected resize

  • Resizes the connector.

    Parameters

    • point: IPoint

      pointer location.

    Returns void

restoreState

  • Restores the connector's state and adjusts the editor accordingly.

    Parameters

    Returns void

scale

  • Scales the connector and editor.

    Parameters

    • scaleX: number

      horizontal scale factor.

    • scaleY: number

      vertical scale factor.

    Returns void

select

  • Selects the connector.

    Returns void

Protected setupControlBox

  • Creates the control box for the editor.

    Returns void

Protected showControlBox

  • Shows the connector editor controls.

    Returns void

Events

Optional onConnectorCreated

onConnectorCreated?: ((connector) => void)

Type declaration

    • (connector): void

    • Fired when the connector creation is completed.

      Parameters

      Returns void

Optional onConnectorUpdated

onConnectorUpdated?: ((connector) => void)

Type declaration

    • (connector): void

    • Fired when the connector is changed (moved, edited, etc.).

      Parameters

      Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc