The unique identifier for this control.
This is true if the control can respond to UI events else false.
Use enable() and disable() to enable and disable it.
This is true if the control background is opaque else false.
Use opaque() and transparent() display / hide the background.
This is true if the control is visible else false.
Use hide() and show() to set visibility.
The type name for this control.
(type name = class name without the Cvs prefix)
Add a child to this control using its relative position [rx, ry]. If rx and ry are not provided then it uses the values set in the child.
this control
is the actual control or its id
Optional rx: numberOptional ry: numberAdds additional images the image(s) to those already displayed in this viewer. They will be inserted at the position by the first parameter.
All additional images will be resized to match the first (bottom) layer.
this control
an image or an array of images
Appends additional image(s) to those already in this viewer. These images will appear above any pre-existing layers.
The additional images will be resized to match the first (bottom) layer.
this control
an image or an array of images
Disables this control.
this control
Optional cascade: booleanif true disable child controls
Enables this control.
this control
Optional cascade: booleanif true enable child controls
Make this control invisible
this control
Remove this control from its parent
this control
Makes the controls background opaque. The actual color depends on the controls color scheme.
The second parameter, alpha, is optional and controls the level of opaqueness from 0 - transparent to 255 - fully opaque (efault value).
this control
alpha value for controls background color.
Adds this control to another control which becomes its parent.
this control
is the parental control or its id
Optional rx: numberx position relative to parent
Optional ry: numbery position relative to parent
Remove a child control from this one so that it stays in same screen position.
this control
the control to remove or its id
Sets or gets the scale and or scale limits
If no parameters are passed the the current scale is returned. A single parameter sets the current scale and three parameter sets the current scale and the limits for the zoom slider.
this control or the current scale
the scale to use
Sets the existing scaler value (if there is no scaler it will be created) and limits. The initial value will be constrained to the limits.
this control
the scale to use
the lowest scale allowed
the highest scale allowed
If the name of a valid color scheme is provided then it will use it to display the control, non-existant scheme names will be ignored. In both cases this control is returned.
If there is no parameter it returns the name of the current color scheme used by this control.
this control or the control's color scheme
Optional name: stringthe color scheme name e.g. 'blue'
Optional cascade: booleanif true propogate scheme to all child controls.
This sets the event handler to be used when this control fires an event. The parameter can take one of three forms:
this control
the function to handle this control's events.
Make this control visible
this control
The current status is an object with 3 fields { cX, cY, scale }
where -
cX, cY is the position in the image that correseponds to the view center andscale is the current scale used to display the image.the current status
Makes the controls background fully transparent.
this control
Sets the view of the image to be displayed. If you enter values outside the image or ar scale value outside scaler limts they will be constrained to legal action on the viewer to report back changes to the view centre and/or scale attributes.
Optional wscale: numberGenerated using TypeDoc
This control is used to scroll and zoom on an image.
When the mouse moves over the control scrollbars will appear (if needed) inside the bottom and right-hand-side edges of the view. When the mouse is near the centre a slider will appear which can be used to change the scale.
This control also supports layers where multiple images can be layered to make the final visual.