summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSamuel Mannehed <samuel@cendio.se>2019-07-23 16:07:17 +0200
committerSamuel Mannehed <samuel@cendio.se>2019-07-23 16:07:17 +0200
commite14aa4d0fe43a939378a3dd7666806fa7018dfe7 (patch)
tree30d014745e699117d5fa48b93b5aa5a455b32c0b /docs
parentc912230309806aacbae4295faf7ad6406da97617 (diff)
downloadnovnc-e14aa4d0fe43a939378a3dd7666806fa7018dfe7.tar.gz
Add documentation for the option showDotCursor
This is not only a property, it's also a parameter to the constructor.
Diffstat (limited to 'docs')
-rw-r--r--docs/API.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/API.md b/docs/API.md
index aa6337f..05c6122 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -187,6 +187,11 @@ connection to a specified VNC server.
- A `DOMString` specifying the ID to provide to any VNC repeater
encountered.
+ `showDotCursor`
+ - A `boolean` indicating whether a dot cursor should be shown
+ instead of a zero-sized or fully-transparent cursor if the
+ server sets such invisible cursor. Disabled by default.
+
`wsProtocols`
- An `Array` of `DOMString`s specifying the sub-protocols to use
in the WebSocket connection. Empty by default.