Interface EdgeStyleRegistryInterface

The definition of a registry that stores the EdgeStyleFunctions and their configuration.

Since

0.20.0

interface EdgeStyleRegistryInterface {
    add(
        name: string,
        edgeStyle: EdgeStyleFunction,
        metaData?: EdgeStyleMetaData,
    ): void;
    allowsIntermediateHandles(edgeStyle?: null | EdgeStyleFunction): boolean;
    get(name: undefined | null | string): null | EdgeStyleFunction;
    getHandlerKind(edgeStyle?: null | EdgeStyleFunction): EdgeStyleHandlerKind;
    getName(value: null | EdgeStyleFunction): null | string;
    isOrthogonal(edgeStyle?: null | EdgeStyleFunction): boolean;
}

Hierarchy (View Summary)

Registry<EdgeStyleFunction>
- EdgeStyleRegistryInterface

Index

Methods

add allowsIntermediateHandles get getHandlerKind getName isOrthogonal

Methods

add

add(
    name: string,
    edgeStyle: EdgeStyleFunction,
    metaData?: EdgeStyleMetaData,
): void
Register an EdgeStyleFunction under the given name along with its EdgeStyleMetaData.

The metadata is used by maxGraph to drive edge handling behaviors (handler kind, orthogonal projection on perimeter, intermediate bend handles). Make sure to pass the correct values, as omitting or mis-setting them may lead to unexpected behaviors when editing or rendering the edge.

To register edge styles provided by maxGraph, prefer the dedicated helpers which already provide the correct metadata:
Or registerDefaultEdgeStyles to register all of them at once.
Parameters
- name: string
  the key under which the edgeStyle is registered.
- edgeStyle: EdgeStyleFunction
  the EdgeStyleFunction to register.
- OptionalmetaData: EdgeStyleMetaData
  the optional EdgeStyleMetaData associated with edgeStyle.
Returns void
Overrides Registry.add
- Defined in types.ts:1691

allowsIntermediateHandles

allowsIntermediateHandles(edgeStyle?: null | EdgeStyleFunction): boolean
Retrieves whether the specified edgeStyle allows intermediate bend handles.

If the edgeStyle is not registered or the allowIntermediateHandles was not set during registration, this method returns true.
Parameters
- OptionaledgeStyle: null | EdgeStyleFunction
Returns boolean
Since
0.24.0
- Defined in types.ts:1713

get

get(name: undefined | null | string): null | EdgeStyleFunction
Parameters
- name: undefined | null | string
Returns null | EdgeStyleFunction
Inherited from Registry.get
- Defined in types.ts:1607

getHandlerKind

getHandlerKind(edgeStyle?: null | EdgeStyleFunction): EdgeStyleHandlerKind
Retrieves the handler kind of the specified edgeStyle as it was registered.

If the edgeStyle is not registered or the handlerKind was not set during registration, this method returns 'default'.
Parameters
- OptionaledgeStyle: null | EdgeStyleFunction
Returns EdgeStyleHandlerKind
- Defined in types.ts:1705

getName

getName(value: null | EdgeStyleFunction): null | string
Parameters
- value: null | EdgeStyleFunction
Returns null | string
Inherited from Registry.getName
- Defined in types.ts:1609

isOrthogonal

isOrthogonal(edgeStyle?: null | EdgeStyleFunction): boolean
Retrieves the orthogonal state of the specified edgeStyle as it was registered.

If the edgeStyle is not registered or the orthogonal state was not set during registration, this method returns false.
Parameters
- OptionaledgeStyle: null | EdgeStyleFunction
Returns boolean
- Defined in types.ts:1698