Class CoverMarker

Cover marker is a filled rectangle marker.

A typical use case is to cover some area of the image with a colored rectangle as a "redaction".

Hierarchy (View Summary)

ShapeMarkerBase
- CoverMarker

Accessors

centerX

get centerX(): number
x coordinate of the marker's center.

Returns number
Inherited from ShapeMarkerBase.centerX
- Defined in markerjs3/src/core/RectangularBoxMarkerBase.ts:41

centerY

get centerY(): number
y coordinate of the marker's center.

Returns number
Inherited from ShapeMarkerBase.centerY
- Defined in markerjs3/src/core/RectangularBoxMarkerBase.ts:47

container

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

Returns SVGGElement
Inherited from ShapeMarkerBase.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 ShapeMarkerBase.fillColor
- Defined in markerjs3/src/core/MarkerBase.ts:118
set fillColor(color: string): void
Parameters
- color: string
Returns void
Inherited from ShapeMarkerBase.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 ShapeMarkerBase.opacity
- Defined in markerjs3/src/core/MarkerBase.ts:187
set opacity(value: number): void
Parameters
- value: number
Returns void
Inherited from ShapeMarkerBase.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 ShapeMarkerBase.strokeColor
- Defined in markerjs3/src/core/MarkerBase.ts:95
set strokeColor(color: string): void
Parameters
- color: string
Returns void
Inherited from ShapeMarkerBase.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 ShapeMarkerBase.strokeDasharray
- Defined in markerjs3/src/core/MarkerBase.ts:164
set strokeDasharray(value: string): void
Parameters
- value: string
Returns void
Inherited from ShapeMarkerBase.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 ShapeMarkerBase.strokeWidth
- Defined in markerjs3/src/core/MarkerBase.ts:141
set strokeWidth(value: number): void
Parameters
- value: number
Returns void
Inherited from ShapeMarkerBase.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 ShapeMarkerBase.typeName
- Defined in markerjs3/src/core/MarkerBase.ts:33

`Protected`visual

get visual(): undefined | SVGGraphicsElement
Container for the marker's visual.

Returns undefined | SVGGraphicsElement
Inherited from ShapeMarkerBase.visual
- Defined in markerjs3/src/core/RectangularBoxMarkerBase.ts:55
set visual(value: SVGGraphicsElement): void
Parameters
- value: SVGGraphicsElement
Returns void
Inherited from ShapeMarkerBase.visual
- Defined in markerjs3/src/core/RectangularBoxMarkerBase.ts:58

Constructors

constructor

new CoverMarker(container: SVGGElement): CoverMarker
Parameters
- container: SVGGElement
Returns CoverMarker
Overrides ShapeMarkerBase.constructor
- Defined in markerjs3/src/core/CoverMarker.ts:16

Methods

`Protected`addMarkerVisualToContainer

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

adjustVisual

adjustVisual(): void
Adjusts marker's visual according to the current state (color, width, etc.).

Returns void
Inherited from ShapeMarkerBase.adjustVisual
- Defined in markerjs3/src/core/ShapeOutlineMarkerBase.ts:89

`Protected`applyFillColor

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

If needed, override this method in a derived class to apply the color to the marker's visual.

Returns void
Inherited from ShapeMarkerBase.applyFillColor
- Defined in markerjs3/src/core/ShapeMarkerBase.ts:24

`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
Inherited from ShapeMarkerBase.applyOpacity
- Defined in markerjs3/src/core/ShapeOutlineMarkerBase.ts:36

`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
Inherited from ShapeMarkerBase.applyStrokeColor
- Defined in markerjs3/src/core/ShapeOutlineMarkerBase.ts:14

`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
Inherited from ShapeMarkerBase.applyStrokeDasharray
- Defined in markerjs3/src/core/ShapeOutlineMarkerBase.ts:28

`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
Inherited from ShapeMarkerBase.applyStrokeWidth
- Defined in markerjs3/src/core/ShapeOutlineMarkerBase.ts:20

createVisual

createVisual(): void
Creates marker's visual.

Returns void
Inherited from ShapeMarkerBase.createVisual
- Defined in markerjs3/src/core/ShapeMarkerBase.ts:36

dispose

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

Returns void
Inherited from ShapeMarkerBase.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 ShapeMarkerBase.getBBox
- Defined in markerjs3/src/core/RectangularBoxMarkerBase.ts:233

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 ShapeMarkerBase.getOutline
- Defined in markerjs3/src/core/ShapeOutlineMarkerBase.ts:67

`Protected`getPath

getPath(width?: number, height?: number): string
Parameters
- width: number = ...
- height: number = ...
Returns string
Overrides ShapeMarkerBase.getPath
- Defined in markerjs3/src/core/CoverMarker.ts:24

getState

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

Returns ShapeMarkerBaseState
Inherited from ShapeMarkerBase.getState
- Defined in markerjs3/src/core/ShapeMarkerBase.ts:43

moveVisual

moveVisual(point: IPoint): void
Moves visual to the specified coordinates.
Parameters
- point: IPoint
  coordinates of the new top-left corner of the visual.
Returns void
Inherited from ShapeMarkerBase.moveVisual
- Defined in markerjs3/src/core/RectangularBoxMarkerBase.ts:78

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.
Inherited from ShapeMarkerBase.ownsTarget
- Defined in markerjs3/src/core/ShapeOutlineMarkerBase.ts:50

restoreState

restoreState(state: MarkerBaseState): void
Restores previously saved marker state.
Parameters
- state: MarkerBaseState
  previously saved state.
Returns void
Inherited from ShapeMarkerBase.restoreState
- Defined in markerjs3/src/core/ShapeMarkerBase.ts:54

rotate

rotate(point: IPoint): void
Rotates marker around the center.
Parameters
- point: IPoint
  coordinates of the rotation point.
Returns void
Inherited from ShapeMarkerBase.rotate
- Defined in markerjs3/src/core/RectangularBoxMarkerBase.ts:95

rotatePoint

rotatePoint(point: IPoint): IPoint
Returns point coordinates based on the actual screen coordinates and marker's rotation.
Parameters
- point: IPoint
  original pointer coordinates
Returns IPoint
Inherited from ShapeMarkerBase.rotatePoint
- Defined in markerjs3/src/core/RectangularBoxMarkerBase.ts:117

scale

scale(scaleX: number, scaleY: number): void
Scales marker. Used after resize.
Parameters
- scaleX: number
  horizontal scale
- scaleY: number
  vertical scale
Returns void
Inherited from ShapeMarkerBase.scale
- Defined in markerjs3/src/core/ShapeOutlineMarkerBase.ts:115

setSize

setSize(): void
Adjusts marker's size.

Returns void
Inherited from ShapeMarkerBase.setSize
- Defined in markerjs3/src/core/ShapeOutlineMarkerBase.ts:102

unrotatePoint

unrotatePoint(point: IPoint): IPoint
Returns original point coordinates based on coordinates with rotation applied.
Parameters
- point: IPoint
  rotated point coordinates.
Returns IPoint
Inherited from ShapeMarkerBase.unrotatePoint
- Defined in markerjs3/src/core/RectangularBoxMarkerBase.ts:138

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'

Marker's fill color.

`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 = false

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).

height

height: number = 0

Marker height.

left

left: number = 0

x coordinate of the top-left corner.

`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.

rotationAngle

rotationAngle: number = 0

Marker's rotation angle.

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).

`Static`title

title: string = 'Cover marker'

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

top

top: number = 0

y coordinate of the top-left corner.

`Static`typeName

typeName: string = 'CoverMarker'

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.

width

width: number = 0

Marker width.

Class CoverMarker

Hierarchy (View Summary)

Index

Accessors

Constructors

Methods

Properties

Accessors

centerX

Returns number

centerY

Returns number

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

Protectedvisual

Returns undefined | SVGGraphicsElement

Parameters

Returns void

Constructors

constructor

Parameters

Returns CoverMarker

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

getOutline

Returns string

ProtectedgetPath

Parameters

Returns string

getState

Returns ShapeMarkerBaseState

moveVisual

Parameters

Returns void

ownsTarget

Parameters

Returns boolean

restoreState

`Protected`visual

`Protected`addMarkerVisualToContainer

`Protected`applyFillColor

`Protected`applyOpacity

`Protected`applyStrokeColor

`Protected`applyStrokeDasharray

`Protected`applyStrokeWidth

`Protected`getPath

`Protected`_container

`Protected`_fillColor

`Protected`_opacity

`Protected`_strokeColor

`Protected`_strokeDasharray

`Protected`_strokeWidth

`Static`applyDefaultFilter

`Optional`notes

`Static`title

`Static`typeName