Constructor
new DocumentTextRenderer(wicaElementConnectionAttributesnon-null, wicaElementTextRenderingAttributesnon-null)
Constructs a new instance.
Parameters:
| Name | Type | Description |
|---|---|---|
wicaElementConnectionAttributes |
module:shared-definitions.WicaElementConnectionAttributes | The names of the HTML element attributes that are to be used in the wica communication process. See WicaElementConnectionAttributes. |
wicaElementTextRenderingAttributes |
module:shared-definitions.WicaElementTextRenderingAttributes | The names of the HTML element attributes that are to be used in the wica text rendering process. See WicaElementRenderingAttributes. |
Methods
activate(refreshRateInMillisecondsopt)
Starts periodically scanning the current document and updating the text content of all wica channel
elements to match the information obtained from the wica server.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
refreshRateInMilliseconds |
number |
<optional> |
100 | The period to wait after each update scan before starting the next one. See also: shutdown. |
shutdown()
Shuts down the service offered by this class.
See also: activate.