Class: FieldOfViewOverlay

FieldOfViewOverlay(viewer, optsopt)

new FieldOfViewOverlay(viewer, optsopt)

Parameters:
Name Type Attributes Description
viewer OpenSeadragon.Viewer
opts Object <optional>
Properties
Name Type Attributes Default Description
registerWithConfig boolean <optional>
 true Set false to suppress auto-registration with ConfigurationWidget
Source:

Members

_fovContextMenuEl :HTMLElement|null

Type:
  • HTMLElement | null
Source:

Methods

_commitFovDialogInputsFromDom()

Read diameter / area inputs and commit into `this.settings` (used before Place if user did not blur).
Source:

_findFovDroppedRingGroup(item) → {paper.Item|null}

Parameters:
Name Type Description
item paper.Item | null
Source:
Returns:
Root group for a dropped FOV ring, if any.
Type
paper.Item | null

_formatAreaMm2ForInput(a)

Parameters:
Name Type Description
a number
Source:

_fovHitTolerance(view, layer)

Same tolerance convention as ToolBase#getTolerance (screen px → project units).
Parameters:
Name Type Description
view paper.View
layer paper.Layer
Source:

_isFocused(el)

Parameters:
Name Type Description
el Element | null
Source:

_onFovCanvasContextMenu(ev)

Parameters:
Name Type Description
ev MouseEvent
Source:

_openFovContextMenu(clientX, clientY, ringGroup)

Parameters:
Name Type Description
clientX number
clientY number
ringGroup paper.Item
Source:

_parsePositiveFloatDraft(text) → {Object|Object}

Same draft parsing pattern as screenshot overlay: trim, require finite number > 0.
Parameters:
Name Type Description
text string
Source:
Returns:
Type
Object | Object

_resolveActiveTiledImageOrThrow() → {OpenSeadragon.TiledImage}

Source:
Returns:
Type
OpenSeadragon.TiledImage

_setIfNotFocused(input, valueString)

Avoid clobbering in-progress typing when mirroring the paired numeric field (screenshot overlay pattern).
Parameters:
Name Type Description
input HTMLInputElement | null
valueString string
Source:

buildDropItemData(centerImg, diameterPx)

Parameters:
Name Type Description
centerImg OpenSeadragon.Point
diameterPx number
Source:

clearAllDroppedFieldOfViews()

Remove all committed field-of-view rings from the active tile Paper layer.
Source:

countDroppedFovRings() → {number}

Source:
Returns:
Type
number

getDropTargetLayer() → {paper.Layer|null}

Paper layer for this overlay’s scope on the active tile (image-local coordinates).
Source:
Returns:
Type
paper.Layer | null

hitTestFovRingAtProjectPoint(projectPoint) → {paper.Item|null}

Parameters:
Name Type Description
projectPoint paper.Point | null
Source:
Returns:
Type
paper.Item | null

notifyFovRingGeometryChanged()

Keeps full-dialog action buttons in sync after a ring is dropped without leaving compact mode.
Source: