Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CaptionFrameMarker

Hierarchy

Index

Constructors

constructor

Properties

Protected _container

_container: SVGGElement

Protected _outerContainer

_outerContainer: SVGGElement

Protected captionBg

captionBg: SVGRectElement

Caption background element.

Protected captionElement

captionElement: SVGTextElement

Caption text element.

Protected captionText

captionText: string = ""

Caption text.

Protected fillColor

fillColor: string = "transparent"

Caption background (fill) color.

Protected fontFamily

fontFamily: string

Caption font family.

Protected fontSize

fontSize: string = "1rem"

Caption font size.

Protected frame

frame: SVGRectElement

Frame rectangle.

Protected height

height: number = 0

Marker height.

Protected left

left: number = 0

x coordinate of the top-left corner.

Protected manipulationStartHeight

manipulationStartHeight: number

Height at the start of manipulation.

Protected manipulationStartLeft

manipulationStartLeft: number

x coordinate of the top-left corner at the start of manipulation.

Protected manipulationStartTop

manipulationStartTop: number

y coordinate of the top-left corner at the start of manipulation.

Protected manipulationStartWidth

manipulationStartWidth: number

Width at the start of manipulation.

Protected manipulationStartX

manipulationStartX: number

x coordinate of the pointer at the start of manipulation.

Protected manipulationStartY

manipulationStartY: number

y coordinate of the pointer at the start of manipulation.

Optional notes

notes: string

Additional information about the marker

Protected offsetX

offsetX: number = 0

Pointer's horizontal distance from the top left corner.

Protected offsetY

offsetY: number = 0

Pointer's vertical distance from the top left corner.

onMarkerCreated

onMarkerCreated: (marker: MarkerBase) => void

Method called when marker creation is finished.

Type declaration

Protected rotationAngle

rotationAngle: number = 0

Marker's rotation angle.

Protected strokeColor

strokeColor: string = "transparent"

Frame border color.

Protected strokeDasharray

strokeDasharray: string = ""

Frame border dash array.

Protected strokeWidth

strokeWidth: number = 0

Frame border line width.

Protected textColor

textColor: string = "transparent"

Caption text color.

Protected top

top: number = 0

y coordinate of the top-left corner.

Protected width

width: number = 0

Marker width.

Static title

title: string = "Caption frame marker"

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

Static typeName

typeName: string = "CaptionFrameMarker"

String type name of the marker type.

Used when adding {@link MarkerArea.availableMarkerTypes} via a string and to save and restore state.

Accessors

Protected centerX

  • get centerX(): number

Protected centerY

  • get centerY(): number

container

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

    Returns SVGGElement

outerContainer

  • get outerContainer(): SVGGElement
  • Outer SVG group container not manipulated or transformed by the marker itself in any way

    Returns SVGGElement

Protected visual

  • get visual(): SVGGraphicsElement
  • set visual(value: SVGGraphicsElement): void

Methods

Protected addMarkerVisualToContainer

  • addMarkerVisualToContainer(element: SVGElement): void
  • Adds marker's root visual element to the container group.

    Parameters

    • element: SVGElement

      marker's visual element.

    Returns void

Protected createVisual

  • createVisual(): void
  • Creates marker visual.

    Returns void

dblClick

  • dblClick(point: IPoint, target?: EventTarget): void
  • Handles pointer (mouse, touch, stylus, etc.) double click event.

    Parameters

    • point: IPoint

      event coordinates.

    • Optional target: EventTarget

      direct event target element.

    Returns void

deselect

  • deselect(): void

dispose

  • dispose(): void

Protected moveVisual

  • moveVisual(point: IPoint): void

ownsTarget

  • ownsTarget(el: EventTarget): boolean
  • Returns true if passed SVG element belongs to the marker. False otherwise.

    Parameters

    • el: EventTarget

      target element.

    Returns boolean

pointerDown

  • pointerDown(point: IPoint, target?: EventTarget): void

pointerUp

  • pointerUp(point: IPoint): void

Protected resize

restoreState

Protected rotatePoint

scale

  • scale(scaleX: number, scaleY: number): void
  • Scales marker. Used after the image resize.

    Parameters

    • scaleX: number

      horizontal scale

    • scaleY: number

      vertical scale

    Returns void

select

  • select(): void

setCaptionText

  • setCaptionText(text: string): void
  • Sets caption text.

    Parameters

    • text: string

      new caption text.

    Returns void

Protected setSize

  • setSize(): void

Protected sizeCaption

  • sizeCaption(): void
  • Returns void

Protected unrotatePoint

Object literals

Protected defaultSize

defaultSize: object

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

x

x: number = 50

y

y: number = 20

Generated using TypeDoc