Class LinearMarkerBase

Base class for line-like markers.

Use one of the derived classes.

Hierarchy (View Summary)

MarkerBase
- LinearMarkerBase
  - LineMarker

Accessors

container

get container(): SVGGElement
SVG container object holding the marker's visual.

Returns SVGGElement
Inherited from MarkerBase.container
- Defined in markerjs3/src/core/MarkerBase.ts:61

fillColor

get fillColor(): string
Fill color of the marker.

In a derived class override applyFillColor to apply the color to the marker's visual.

Returns string
Inherited from MarkerBase.fillColor
- Defined in markerjs3/src/core/MarkerBase.ts:118
set fillColor(color: string): void
Parameters
- color: string
Returns void
Inherited from MarkerBase.fillColor
- Defined in markerjs3/src/core/MarkerBase.ts:121

opacity

get opacity(): number
Opacity of the marker.

In a derived class override applyOpacity to apply the opacity to the marker's visual.

Returns number
Inherited from MarkerBase.opacity
- Defined in markerjs3/src/core/MarkerBase.ts:187
set opacity(value: number): void
Parameters
- value: number
Returns void
Inherited from MarkerBase.opacity
- Defined in markerjs3/src/core/MarkerBase.ts:190

strokeColor

get strokeColor(): string
Stroke (outline) color of the marker.

In a derived class override applyStrokeColor to apply the color to the marker's visual.

Returns string
Inherited from MarkerBase.strokeColor
- Defined in markerjs3/src/core/MarkerBase.ts:95
set strokeColor(color: string): void
Parameters
- color: string
Returns void
Inherited from MarkerBase.strokeColor
- Defined in markerjs3/src/core/MarkerBase.ts:98

strokeDasharray

get strokeDasharray(): string
Stroke (outline) dash array of the marker.

In a derived class override applyStrokeDasharray to apply the dash array to the marker's visual.

Returns string
Inherited from MarkerBase.strokeDasharray
- Defined in markerjs3/src/core/MarkerBase.ts:164
set strokeDasharray(value: string): void
Parameters
- value: string
Returns void
Inherited from MarkerBase.strokeDasharray
- Defined in markerjs3/src/core/MarkerBase.ts:167

strokeWidth

get strokeWidth(): number
Stroke (outline) width of the marker.

In a derived class override applyStrokeWidth to apply the width to the marker's visual.

Returns number
Inherited from MarkerBase.strokeWidth
- Defined in markerjs3/src/core/MarkerBase.ts:141
set strokeWidth(value: number): void
Parameters
- value: number
Returns void
Inherited from MarkerBase.strokeWidth
- Defined in markerjs3/src/core/MarkerBase.ts:144

typeName

get typeName(): string
Returns marker type name for the object instance.

Returns string
Inherited from MarkerBase.typeName
- Defined in markerjs3/src/core/MarkerBase.ts:33

Constructors

constructor

new LinearMarkerBase(container: SVGGElement): LinearMarkerBase
Parameters
- container: SVGGElement
Returns LinearMarkerBase
Overrides MarkerBase.constructor
- Defined in markerjs3/src/core/LinearMarkerBase.ts:103

Methods

`Protected`addMarkerVisualToContainer

addMarkerVisualToContainer(element: SVGElement): void
Parameters
- element: SVGElement
Returns void
Inherited from MarkerBase.addMarkerVisualToContainer
- Defined in markerjs3/src/core/MarkerBase.ts:234

adjustVisual

adjustVisual(): void
Adjusts marker visual after manipulation when needed.

Returns void
- Defined in markerjs3/src/core/LinearMarkerBase.ts:209

`Protected`applyFillColor

applyFillColor(): void
Applies the fill color to the marker's visual.

Override this method in a derived class to apply the color to the marker's visual.

Returns void
Inherited from MarkerBase.applyFillColor
- Defined in markerjs3/src/core/MarkerBase.ts:130

`Protected`applyOpacity

applyOpacity(): void
Applies the opacity to the marker's visual.

Override this method in a derived class to apply the opacity to the marker's visual

Returns void
Overrides MarkerBase.applyOpacity
- Defined in markerjs3/src/core/LinearMarkerBase.ts:95

`Protected`applyStrokeColor

applyStrokeColor(): void
Applies the stroke color to the marker's visual.

Override this method in a derived class to apply the color to the marker's visual.

Returns void
Overrides MarkerBase.applyStrokeColor
- Defined in markerjs3/src/core/LinearMarkerBase.ts:58

`Protected`applyStrokeDasharray

applyStrokeDasharray(): void
Applies the stroke dash array to the marker's visual.

Override this method in a derived class to apply the dash array to the marker's visual.

Returns void
Overrides MarkerBase.applyStrokeDasharray
- Defined in markerjs3/src/core/LinearMarkerBase.ts:87

`Protected`applyStrokeWidth

applyStrokeWidth(): void
Applies the stroke width to the marker's visual.

Override this method in a derived class to apply the width to the marker's visual.

Returns void
Overrides MarkerBase.applyStrokeWidth
- Defined in markerjs3/src/core/LinearMarkerBase.ts:74

createVisual

createVisual(): void
Creates marker's visual.

Returns void
- Defined in markerjs3/src/core/LinearMarkerBase.ts:158

dispose

dispose(): void
Disposes the marker and cleans up.

Returns void
Inherited from MarkerBase.dispose
- Defined in markerjs3/src/core/MarkerBase.ts:232

getBBox

getBBox(): DOMRect
Returns markers bounding box.

Override to return a custom bounding box.

Returns DOMRect
rectangle fitting the marker.
Inherited from MarkerBase.getBBox
- Defined in markerjs3/src/core/MarkerBase.ts:293

`Protected`getEndTerminatorPath

getEndTerminatorPath(): string
The path representing the end terminator (ending) part of the marker visual.

Returns string
SVG path
- Defined in markerjs3/src/core/LinearMarkerBase.ts:151

getOutline

getOutline(): string
When overridden in a derived class, represents a preliminary outline for markers that can be displayed before the marker is actually created.

Returns string
SVG path string.
Inherited from MarkerBase.getOutline
- Defined in markerjs3/src/core/MarkerBase.ts:246

`Protected`getPath

getPath(): string
The path representing the line part of the marker visual.

When implemented in derived class should return SVG path for the marker.

Returns string
SVG path for the marker.
- Defined in markerjs3/src/core/LinearMarkerBase.ts:135

`Protected`getStartTerminatorPath

getStartTerminatorPath(): string
The path representing the start terminator (ending) part of the marker visual.

Returns string
SVG path
- Defined in markerjs3/src/core/LinearMarkerBase.ts:143

getState

getState(): LinearMarkerBaseState
Returns current marker state that can be restored in the future.

Returns LinearMarkerBaseState
Overrides MarkerBase.getState
- Defined in markerjs3/src/core/LinearMarkerBase.ts:242

ownsTarget

ownsTarget(el: EventTarget): boolean
Returns true if passed SVG element belongs to the marker. False otherwise.
Parameters
- el: EventTarget
  target element.
Returns boolean
true if the element belongs to the marker.
Overrides MarkerBase.ownsTarget
- Defined in markerjs3/src/core/LinearMarkerBase.ts:112

restoreState

restoreState(state: MarkerBaseState): void
Restores previously saved marker state.
Parameters
- state: MarkerBaseState
  previously saved state.
Returns void
Overrides MarkerBase.restoreState
- Defined in markerjs3/src/core/LinearMarkerBase.ts:256

scale

scale(scaleX: number, scaleY: number): void
Scales marker. Used after resize.
Parameters
- scaleX: number
  horizontal scale
- scaleY: number
  vertical scale
Returns void
Overrides MarkerBase.scale
- Defined in markerjs3/src/core/LinearMarkerBase.ts:269

Properties

`Protected`_container

_container: SVGGElement

SVG container object holding the marker's visual.

It is created and passed to the constructor by marker editor or viewer when creating the marker.

`Protected`_fillColor

_fillColor: string = 'transparent'

Fill color of the marker.

`Protected`_opacity

_opacity: number = 1

Opacity of the marker.

`Protected`_strokeColor

_strokeColor: string = 'transparent'

Stroke (outline) color of the marker.

`Protected`_strokeDasharray

_strokeDasharray: string = ''

Stroke (outline) dash array of the marker.

`Protected`_strokeWidth

_strokeWidth: number = 0

Stroke (outline) width of the marker.

`Static`applyDefaultFilter

applyDefaultFilter: boolean = true

When true, the default filter is applied to the marker's visual.

Since

3.2.0

defaultSize

defaultSize: ISize = ...

The default marker size when the marker is created with a click (without dragging).

`Protected`endTerminatorVisual

endTerminatorVisual: undefined | SVGGraphicsElement

End terminator (ending) visual of the marker.

`Protected`lineVisual

lineVisual: undefined | SVGGraphicsElement

Line visual of the marker.

`Optional`notes

notes?: string

Additional information about the marker.

Generally, this isn't used for anything functional. However, in a derived type it could be used for storing arbitrary data with no need to create extra properties and state types.

`Protected`selectorVisual

selectorVisual: undefined | SVGGraphicsElement

Wider invisible visual to make it easier to select and manipulate the marker.

stage

stage: MarkerStage = 'normal'

Marker lifecycle stage.

Most markers are created immediately after the user clicks on the canvas (normal). However, some markers are only finished creating after additional interactions (creating).

`Protected`startTerminatorVisual

startTerminatorVisual: undefined | SVGGraphicsElement

Start terminator (ending) visual of the marker.

`Static`title

title: string

Marker type title (display name) used for accessibility and other attributes.

`Static`typeName

typeName: string = 'MarkerBase'

Marker type name.

It's important to set this in each derived class. This value is used to identify marker types when restoring marker state and other scenarios.

`Protected`visibleVisual

visibleVisual: undefined | SVGGraphicsElement

Visible visual of the marker.

`Protected`visual

visual: undefined | SVGGraphicsElement

Marker's main visual.

x1

x1: number = 0

x coordinate of the first end-point

x2

x2: number = 0

x coordinate of the second end-point

y1

y1: number = 0

y coordinate of the first end-point

y2

y2: number = 0

y coordinate of the second end-point

Class LinearMarkerBase

Hierarchy (View Summary)

Index

Accessors

Constructors

Methods

Properties

Accessors

container

Returns SVGGElement

fillColor

Returns string

Parameters

Returns void

opacity

Returns number

Parameters

Returns void

strokeColor

Returns string

Parameters

Returns void

strokeDasharray

Returns string

Parameters

Returns void

strokeWidth

Returns number

Parameters

Returns void

typeName

Returns string

Constructors

constructor

Parameters

Returns LinearMarkerBase

Methods

ProtectedaddMarkerVisualToContainer

Parameters

Returns void

adjustVisual

Returns void

ProtectedapplyFillColor

Returns void

ProtectedapplyOpacity

Returns void

ProtectedapplyStrokeColor

Returns void

ProtectedapplyStrokeDasharray

Returns void

ProtectedapplyStrokeWidth

Returns void

createVisual

Returns void

dispose

Returns void

getBBox

Returns DOMRect

ProtectedgetEndTerminatorPath

Returns string

getOutline

Returns string

ProtectedgetPath

Returns string

ProtectedgetStartTerminatorPath

Returns string

getState

Returns LinearMarkerBaseState

ownsTarget

Parameters

Returns boolean

restoreState

Parameters

Returns void

scale

Parameters

Returns void

Properties

Protected_container

Protected_fillColor

`Protected`addMarkerVisualToContainer

`Protected`applyFillColor

`Protected`applyOpacity

`Protected`applyStrokeColor

`Protected`applyStrokeDasharray

`Protected`applyStrokeWidth

`Protected`getEndTerminatorPath

`Protected`getPath

`Protected`getStartTerminatorPath

`Protected`_container

`Protected`_fillColor

`Protected`_opacity

`Protected`_strokeColor

`Protected`_strokeDasharray

`Protected`_strokeWidth

`Static`applyDefaultFilter

`Protected`endTerminatorVisual

`Protected`lineVisual

`Optional`notes

`Protected`selectorVisual

`Protected`startTerminatorVisual

`Static`title

`Static`typeName

`Protected`visibleVisual

`Protected`visual