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;
    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 get getHandlerKind getName isOrthogonal

Methods

add

add(
    name: string,
    edgeStyle: EdgeStyleFunction,
    metaData?: EdgeStyleMetaData,
): void
Parameters
- name: string
- edgeStyle: EdgeStyleFunction
- OptionalmetaData: EdgeStyleMetaData
Returns void
Overrides Registry.add
- Defined in types.ts:1575

get

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

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:1589

getName

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

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:1582