Skip to main content

Interface: BrowserImageDataReadyEvent

Base interface for all m2c2kit events.

Remarks​

I would have named it Event, but that would collide with the existing DOM Event

Extends​

Properties​

dataUrl?​

optional dataUrl: string

The image data URL.

Defined in​

m2c2kit/packages/core/src/M2Event.ts:119

handled?​

optional handled: boolean

Has the event been taken care of by the listener and not be dispatched to other targets?

Inherited from​

M2Event.handled

Defined in​

m2c2kit/packages/core/src/M2Event.ts:26

height​

height: number

Height to scale image to

Defined in​

m2c2kit/packages/core/src/M2Event.ts:117

imageName​

imageName: string

The image name.

Defined in​

m2c2kit/packages/core/src/M2Event.ts:113

iso8601Timestamp​

iso8601Timestamp: string

Timestamp of th event, from new Date().toISOString()

Inherited from​

M2Event.iso8601Timestamp

Defined in​

m2c2kit/packages/core/src/M2Event.ts:30

sequence?​

optional sequence: number

Sequence number of event.

Remarks​

Sequence number is guaranteed to reflect order of events, but not necessarily contiguous, e.g., could be 1, 2, 5, 10, 11, 24.

Inherited from​

M2Event.sequence

Defined in​

m2c2kit/packages/core/src/M2Event.ts:35

svgString?​

optional svgString: string

SVG string

Defined in​

m2c2kit/packages/core/src/M2Event.ts:121

target​

target: ImageManager

The object on which the event occurred. If the event has gone through serialization, the string will be the object's UUID (if an M2Node) or class name.

Overrides​

M2Event.target

Defined in​

m2c2kit/packages/core/src/M2Event.ts:111

timestamp​

timestamp: number

Timestamp of the event, from performance.now()

Inherited from​

M2Event.timestamp

Defined in​

m2c2kit/packages/core/src/M2Event.ts:28

type​

type: "BrowserImageDataReady"

Type of event.

Overrides​

M2Event.type

Defined in​

m2c2kit/packages/core/src/M2Event.ts:110

width​

width: number

Width to scale image to

Defined in​

m2c2kit/packages/core/src/M2Event.ts:115