DisplayEventCoords

Message

DisplayEventCoords on|off

Originator

Client

Response

Info: Event coordinates on

Info: Event coordinates off

SyntaxError: insufficient parameters to DisplayEventCoords

SyntaxError: invalid parameters to DisplayEventCoords

Response (immediate socket)

Success

Failure

Details

When event coordinates are switched on, mouse/touchscreen events are accompanied by their x/y coordinates, to give you full ability to localize your every message coming from the server. Here's what one hypothetical message looks like with and without event coordinates:

Event: PictureTouched

Event: PictureTouched 572 827

                      x   y

If event coordinates and timestamps are both switched on (see TimeStamps), the event coordinates precede the timestamp, e.g.

Event: PictureTouched 572 827 [18376]

                      x   y  timestamp

Event coordinates are off by default.

Note. If you want to be informed about touchscreen or mouse events on the document background, simply create an appropriately-colour rectangle as an object and send it to the back. The true background will not respond to events.  The coordinates reported are the document's coordinates, so are unaffected by display scaling (see DisplayScaleDocuments and DisplaySetDocumentSize).        

Revision history

Implemented by WhiskerServer version 2.3.

See also