Interface EdgeMarkerRegistryInterface

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

Since

0.20.0

interface EdgeMarkerRegistryInterface {
    add(name: string, value: MarkerFactoryFunction): void;
    createMarker(
        canvas: AbstractCanvas2D,
        shape: Shape,
        type: StyleArrowValue,
        pe: Point,
        unitX: number,
        unitY: number,
        size: number,
        source: boolean,
        sw: number,
        filled: boolean,
    ): null | MarkerFunction;
    get(name: undefined | null | string): null | MarkerFactoryFunction;
    getName(value: null | MarkerFactoryFunction): null | string;
}

Hierarchy (View Summary)

Registry<MarkerFactoryFunction>
- EdgeMarkerRegistryInterface

Index

Methods

add createMarker get getName

Methods

add

add(name: string, value: MarkerFactoryFunction): void
Parameters
- name: string
- value: MarkerFactoryFunction
Returns void
Inherited from Registry.add
- Defined in types.ts:1520

createMarker

createMarker(
    canvas: AbstractCanvas2D,
    shape: Shape,
    type: StyleArrowValue,
    pe: Point,
    unitX: number,
    unitY: number,
    size: number,
    source: boolean,
    sw: number,
    filled: boolean,
): null | MarkerFunction
Returns a MarkerFunction to paint the given marker.

The type parameter is used to retrieve the correct MarkerFactoryFunction from the registry which is then used to create the MarkerFunction.

If none is found, null is returned.
Parameters
- canvas: AbstractCanvas2D
- shape: Shape
- type: StyleArrowValue
- pe: Point
- unitX: number
- unitY: number
- size: number
- source: boolean
- sw: number
- filled: boolean
Returns null | MarkerFunction
- Defined in types.ts:1606

get

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

getName

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

Interface EdgeMarkerRegistryInterface

Since

Hierarchy (View Summary)

Index

Methods

Methods

add

Parameters

Returns void

createMarker

Parameters

Returns null | MarkerFunction

get

Parameters

Returns null | MarkerFactoryFunction

getName

Parameters

Returns null | string

Settings

On This Page