name of HTML5 element
Initial width of this viewport
Initial height of this viewport
turn off the right-click popup menu
Display the FPS text in the viewport
@ param showFPS Set to true to display frames per seoond in the viewport, false to hide it
By default, JavaScript windows only see mosue events within its Canvas element, which means when the mouse moves outside the element, they are no longer tracked. By enabling this option, mouse events outside the HTML element are passed to this adaptor. By default, this is off (to adhere to standard javaScript behavior). In all cases, when a mouseUp occurs outside the active viewport, that event will be passed to the adaptor.
HTML element associated with this viewport
Get the orientation for this viewport
return the renderEngine associated with this viewport.
return the renderEngineID associated with this viewport
Get the slice information from scroll adaptor for 2D views
paint() write the bytes to the HTML element (either CANVAS or IMG); In this method, the bytes are written to the actual CANVAS or IMG, however the sublcass HTMLDoubleBufferViewport overwrites this method and does rendering on a hidden CANVAS or IMG, which is then rendered onto the real CANVAS or IMG.
Invokes the native intermediate render() method.
This is a synchronous method and returns ReturnCode.ok on success.
Invokes the native renderFinal() method. It is important that a render() be done before a renderFinal() after the rendeirng state has changed, such as from a setRenderParamters().
This is a synchronous method and returns ReturnCode.ok on success.
Resizes this component and triggers a render() / renderFinal() sequence
Updated width of this viewport
Updated height of this viewport
This is a synchronous method and returns ReturnCode.ok on success.
Applies the specified XML preset to this viewport
path and filename of the XML file to load. This will be relative to the FoviaWebSDK.EXE directory, or can be an absolute path
This is an asynchronous method that returns a Promise as follows:
Promise .then(void) .catch (err: ReturnCode )
callbackFunc(err: ReturnCode , void)
While this does not provide a return value, the application will be notified once the preset has been applied and rendered
Associate a custom mouse adaptor with a given mouse button and keyboard modifier
Associate a custom mouse adaptor with a given mouse button and keyboard modifier
Create a mapping between a mouse event and the specified adaptor
Set the orientation for this viewport (typically called when creating MPR viewports)
Install a mouse adaptor that is invokved unconditionally for all mouse events. This allow the application to peek at the event, process it, and stop the propagate.
This is useful when the application is detecting a mouse over event of an annotation or cross-reference lines, and handle that opposed to the current mouse adaptor that would otherwise be triggered.
Install a touch adaptor that is invokved unconditionally for all touch events. This allow the application to peek at the event, process it, and stop the propagate.
This is useful when the application is detecting a touch over event of an annotation or cross-reference lines, and handle that opposed to the current mouse adaptor that would otherwise be triggered.
map between a touch event and specified adaptor
retrieve the current "this" or "self" pointer (HTMLViewport) from the HTML element
store the current this pointer (HTMLViewport) into the HTML element (this reference is visible from the browsser)
Generated using TypeDoc
HTMLRepaintableViewport extends base HTMLViewport with a repaint option. This allows the caller to render ontop of a previous created image from the server when the updating is limited to changes on the client side rendering state.