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,
    ): MarkerFunction | null;
    get(name: string | null | undefined): MarkerFactoryFunction | null;
    getName(value: MarkerFactoryFunction | null): string | null;
}

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

createMarker

createMarker(
    canvas: AbstractCanvas2D,
    shape: Shape,
    type: StyleArrowValue,
    pe: Point,
    unitX: number,
    unitY: number,
    size: number,
    source: boolean,
    sw: number,
    filled: boolean,
): MarkerFunction | null
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 MarkerFunction | null
- Defined in types.ts:1723

get

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

getName

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

Interface EdgeMarkerRegistryInterface

Since

Hierarchy (View Summary)

Index

Methods

Methods

add

Parameters

Returns void

createMarker

Parameters

Returns MarkerFunction | null

get

Parameters

Returns MarkerFactoryFunction | null

getName

Parameters

Returns string | null

Settings

On This Page