Class: FlatMapView

Defined in: FlatMapView.ts:125

Extends

• EventEmitter<FlatMapEventMap>

Constructors

Constructor

new FlatMapView(
   container, 
   geometry, 
   options?
): FlatMapView;

Defined in: FlatMapView.ts:149

Parameters

container

HTMLElement

geometry

FlatMapGeometryInput

options?

FlatMapViewOptions = {}

Returns

FlatMapView

Overrides

EventEmitter.constructor

Properties

canvas

readonly canvas: HTMLCanvasElement;

Defined in: FlatMapView.ts:126

---

surfaceId

readonly surfaceId: string | null;

Defined in: FlatMapView.ts:127

---

vertices

vertices: Float32Array;

Defined in: FlatMapView.ts:128

---

faces

faces: Uint32Array;

Defined in: FlatMapView.ts:129

---

hoverVertexIndex

hoverVertexIndex: number | null = null;

Defined in: FlatMapView.ts:130

---

selectedVertexIndex

selectedVertexIndex: number | null = null;

Defined in: FlatMapView.ts:131

---

layerState

layerState: Map<string, Record<string, unknown>>;

Defined in: FlatMapView.ts:132

---

currentTime

currentTime: number | null = null;

Defined in: FlatMapView.ts:133

---

rois

readonly rois: ROIManager;

Defined in: FlatMapView.ts:134

Methods

on()

on<K>(event, listener): UnsubscribeFn;

Defined in: EventEmitter.ts:18

Type Parameters

K

K extends keyof FlatMapEventMap

Parameters

event

K

listener

TypedEventListener<FlatMapEventMap[K]>

Returns

UnsubscribeFn

Inherited from

EventEmitter.on

---

once()

once<K>(event, listener): UnsubscribeFn;

Defined in: EventEmitter.ts:30

Type Parameters

K

K extends keyof FlatMapEventMap

Parameters

event

K

listener

TypedEventListener<FlatMapEventMap[K]>

Returns

UnsubscribeFn

Inherited from

EventEmitter.once

---

emit()

emit<K>(event, ...args): void;

Defined in: EventEmitter.ts:41

Type Parameters

K

K extends keyof FlatMapEventMap

Parameters

event

K

args

...EventPayloadArgs<FlatMapEventMap[K]>

Returns

void

Inherited from

EventEmitter.emit

---

removeListener()

removeListener<K>(event, listenerToRemove): void;

Defined in: EventEmitter.ts:60

Type Parameters

K

K extends keyof FlatMapEventMap

Parameters

event

K

listenerToRemove

TypedEventListener<FlatMapEventMap[K]>

Returns

void

Inherited from

EventEmitter.removeListener

---

removeAllListeners()

removeAllListeners(event?): void;

Defined in: EventEmitter.ts:75

Parameters

event?

keyof FlatMapEventMap

Returns

void

Inherited from

EventEmitter.removeAllListeners

---

off()

off<K>(event, listener): void;

Defined in: EventEmitter.ts:84

Type Parameters

K

K extends keyof FlatMapEventMap

Parameters

event

K

listener

TypedEventListener<FlatMapEventMap[K]>

Returns

void

Inherited from

EventEmitter.off

---

resize()

resize(width, height): void;

Defined in: FlatMapView.ts:263

Parameters

width

number

height

number

Returns

void

---

setGeometry()

setGeometry(geometry): void;

Defined in: FlatMapView.ts:276

Parameters

geometry

FlatMapGeometryInput

Returns

void

---

setHover()

setHover(vertexIndex, options?): void;

Defined in: FlatMapView.ts:284

Parameters

vertexIndex

number | null

options?

emit?

boolean

screenX?

number

screenY?

number

Returns

void

---

setSelection()

setSelection(vertexIndex, options?): void;

Defined in: FlatMapView.ts:307

Parameters

vertexIndex

number | null

options?

emit?

boolean

Returns

void

---

setLayerState()

setLayerState(layerId, state): void;

Defined in: FlatMapView.ts:319

Parameters

layerId

string

state

Record<string, unknown>

Returns

void

---

setTime()

setTime(time): void;

Defined in: FlatMapView.ts:325

Parameters

time

number

Returns

void

---

startROIDrawing()

startROIDrawing(options): void;

Defined in: FlatMapView.ts:332

Parameters

options

FlatMapROIDrawingOptions

Returns

void

---

cancelROIDrawing()

cancelROIDrawing(): void;

Defined in: FlatMapView.ts:343

Returns

void

---

finishROIDrawing()

finishROIDrawing(): VertexROI | null;

Defined in: FlatMapView.ts:351

Returns

VertexROI | null

---

selectVerticesInPolygon()

selectVerticesInPolygon(polygon): number[];

Defined in: FlatMapView.ts:374

Parameters

polygon

RoiPoint[]

Returns

number[]

---

createROIFromPolygon()

createROIFromPolygon(polygon, options): VertexROI | null;

Defined in: FlatMapView.ts:382

Parameters

polygon

RoiPoint[]

options

name

string

color?

string

provenance?

RoiProvenance

minVertices?

number

Returns

VertexROI | null

---

updateROI()

updateROI(roiId, updates): VertexROI | null;

Defined in: FlatMapView.ts:411

Parameters

roiId

string

updates

name?

string

polygon?

RoiPoint[]

color?

string

provenance?

RoiProvenance

Returns

VertexROI | null

---

removeROI()

removeROI(roiId): boolean;

Defined in: FlatMapView.ts:436

Parameters

roiId

string

Returns

boolean

---

clearROIs()

clearROIs(): void;

Defined in: FlatMapView.ts:446

Returns

void

---

pickVertex()

pickVertex(clientX, clientY): number | null;

Defined in: FlatMapView.ts:454

Parameters

clientX

number

clientY

number

Returns

number | null

---

pickVertexAt()

pickVertexAt(
   x, 
   y, 
   maxDistance?
): number | null;

Defined in: FlatMapView.ts:462

Parameters

x

number

y

number

maxDistance?

number = 10

Returns

number | null

---

projectVertex()

projectVertex(vertexIndex): object;

Defined in: FlatMapView.ts:481

Parameters

vertexIndex

number

Returns

object

x

x: number;

y

y: number;

---

render()

render(): void;

Defined in: FlatMapView.ts:504

Returns

void

---

dispose()

dispose(): void;

Defined in: FlatMapView.ts:535

Returns

void