Seadragon - DevExpress/AjaxControlToolkit GitHub Wiki
The SeaDragon control can be used for viewing images in an interactive manner. Use the mouse to pan and zoom around an image.
Properties
| Name | Description |
|---|---|
| AlwaysBlend | Determines whether or not tiles should always blend in and out, not just when they're first loaded. Default is false |
| AnimationTime | The amount of time in seconds during which animations should last. Default is 1.5 |
| AutoHideControls | Determines whether or not controls should be automatically hidden when the user mover the mouse away from the viewer and the image has stopped animating. Default is true |
| BlendTime | The amount of time in seconds when new tiles' blend changes from transparent to opaque. Default is 0.5 |
| clickDistThreshold | The maximum number of pixels the mouse can move between a mousedown and mouseup for an action to be considered as a quick click. Default is 5 |
| ClickTimeThreshold | The maximum number of milliseconds that can pass between a mousedown and mouseup for an action to be considered as a quick click. Default is 200 |
| Controls | A collection of controls |
| ControlsCollection | A collection of SeaDragon controls |
| ImageLoaderLimit | The maximum number of concurrent image downloads that can be performed by each viewer. Default is 2 |
| ImmediateRender | Determines whether or not the most appropriate tiles should always be rendered before any low-resolution tiles are rendered. The sharpening effect is lost, and instead a visible tiling effect occurs. Default is false |
| MaxImageCacheCount | Maximum number of cached images |
| MaxZoomPixelRatio | Maximum pixel ratio (screen pixel to content pixel) that can be obtained by zooming in. Default is 4 |
| MinPixelRatio | Minimum pixel ratio |
| MinZoomDimension | Minimum size (in screen pixels) of any dimension that can be obtained by zooming out. Default is 16 |
| MouseNavEnabled | Determines whether or not mouse navigation is enabled |
| OnClientAnimation | The name of a JavaScript function executed on animation on the client side |
| OnClientAnimationEnd | The name of a JavaScript function executed on the client side when animation ends |
| OnClientAnimationStart | The name of a JavaScript function executed on the client side when animation starts |
| OnClientError | The name of a JavaScript function executed on the client side when the error event occurs |
| OnClientIgnore | The name of a JavaScript function executed on the client side when the ignore event occurs |
| OnClientOpen | The name of a JavaScript function executed on the client side after an image is opened |
| OnClientResize | The name of a JavaScript function executed on the client side when an image is resized |
| OverlaysCollection | A collection of overlays |
| ShowNavigationControl | Determines whether or not navigation buttons should be shown |
| SourceUrl | A path for all UI images. It can be absolute or relative. If it is relative, it must be relative to an HTML page. This value change will affect only new viewers. Default is img |
| SpringStiffness | Determines how sharply springs used for animation move. Default is 5.0 |
| VisibilityRatio | The minimum portion of the viewport that must show visible content in both dimensions. Default is 0.1 |
| WrapHorizontal | Determines whether or not the control uses horizontal wrapping |
| WrapVertical | Determines whether or not the control uses vertical wrapping |
| ZoomPerClick | The factor by which images should zoom in on being clicked. Default is 2 |
| ZoomPerSecond | The factor by which images should zoom in each second the zoom buttons are held down. Default is 2 |
Viewer
Client properties
| Name | Description |
|---|---|
| alwaysBlend | Determines whether or not tiles should always blend in and out, not just when they're first loaded. Default is false |
| animationTime | The amount of time in seconds that animations should last. Default is 1.5 |
| autoHideControls | Determines whether or not controls should be automatically hidden when a user moves the mouse away from the viewer and the image has stopped animating. Default is true |
| blendTime | The amount of time in seconds that new tiles take to blend from transparent to opaque. Default is 0.5 |
| clickDistThreshold | Maximum number of pixels the mouse can move between a mousedown and mouseup fo an action to be considered as a quick click. Default is 5 |
| clickTimeThreshold | Maximum number of milliseconds that can pass between a mousedown and mouseup for an action to be considered as a quick click. Default is 200 |
| controls | A list of controls |
| debugMode | Determines whether or not the debug mode is enabled |
| imageLoaderLimit | Maximum number of concurrent image downloads that can be performed by each viewer. Default is 2 |
| immediateRender | Determines whether or not the most appropriate tiles should always be rendered before any low-resolution tiles are rendered. The sharpening effect is lost, and instead a visible tiling effect occurs. Default is false |
| maxImageCacheCount | Maximum number of cached images |
| maxZoomPixelRatio | Maximum pixel ratio (screen pixel to content pixel) that can be obtained from zooming in. Default is 4 |
| minPixelRatio | Minimum pixel ratio |
| minZoomDimension | Minimum size (in screen pixels) of a dimension that can be obtained from zooming out. Default is 16 |
| mouseNavEnabled | Determines whether or not mouse navigation is enabled |
| overlays | A list of overlay controls |
| prefixUrl | Prefix URL |
| showNavigationControl | Determines whether or not navigation buttons should be shown |
| springStiffness | Determines how sharply springs used for animations move. Default is 5.0 |
| visibilityRatio | Minimum portion of the viewport that must show visible content in both dimensions. Default is 0.1 |
| wrapHorizontal | Determines whether or not the control uses horizontal wrapping |
| wrapVertical | Determines whether or not the control uses vertical wrapping |
| xmlPath | An XML path |
| zoomPerClick | The factor by which images should zoom in on being clicked. Default is 2 |
| zoomPerSecond | The factor by which images should zoom in each second the zoom buttons are held down. Default is 2 |
Client methods
| Name | Description |
|---|---|
| getNavControl() | Returns a navigation control of the viewer |
Client events
| Name | Description |
|---|---|
| animationend | Fires when animation ends |
| animationstart | Fires when animation starts |
| error | Fires when the error occurs |
| ignore | Fires when the ignore event occurs |
| open | Fires when the viewer opens |
| resize | Fires on viewer resizing |
Client properties
alwaysBlend
Determines whether or not tiles should always blend in and out, not just when they're first loaded. Default is false
Getter name: get_alwaysBlend()Setter name: set_alwaysBlend(value)
animationTime
The amount of time in seconds that animations should last. Default is 1.5
Getter name: get_animationTime()Setter name: set_animationTime(value)
autoHideControls
Determines whether or not controls should be automatically hidden when a user moves the mouse away from the viewer and the image has stopped animating. Default is true
Getter name: get_autoHideControl()Setter name: set_autoHideControl(value)
blendTime
The amount of time in seconds that new tiles take to blend from transparent to opaque. Default is 0.5
Getter name: get_blendTime()Setter name: set_blendTime(value)
clickDistThreshold
Maximum number of pixels the mouse can move between a mousedown and mouseup fo an action to be considered as a quick click. Default is 5
Getter name: get_clickDistThreshold()Setter name: set_clickDistThreshold(value)
clickTimeThreshold
Maximum number of milliseconds that can pass between a mousedown and mouseup for an action to be considered as a quick click. Default is 200
Getter name: get_clickTimeThreshold()Setter name: set_clickTimeThreshold(value)
controls
A list of controls
Getter name: get_controls()Setter name: set_controls(value)
debugMode
Determines whether or not the debug mode is enabled
Getter name: get_debugMode()Setter name: set_debugMode(value)
imageLoaderLimit
Maximum number of concurrent image downloads that can be performed by each viewer. Default is 2
Getter name: get_imageLoaderLimit()Setter name: set_imageLoaderLimit(value)
immediateRender
Determines whether or not the most appropriate tiles should always be rendered before any low-resolution tiles are rendered. The sharpening effect is lost, and instead a visible tiling effect occurs. Default is false
Getter name: get_immediateRender()Setter name: set_immediateRender(value)
maxImageCacheCount
Maximum number of cached images
Getter name: get_maxImageCacheCount()Setter name: set_maxImageCacheCount(value)
maxZoomPixelRatio
Maximum pixel ratio (screen pixel to content pixel) that can be obtained from zooming in. Default is 4
Getter name: get_maxZoomPixelRation()Setter name: set_maxZoomPixelRation(value)
minPixelRatio
Minimum pixel ratio
Getter name: get_minPixelRatio()Setter name: set_minPixelRatio(value)
minZoomDimension
Minimum size (in screen pixels) of a dimension that can be obtained from zooming out. Default is 16
Getter name: get_minZoomDimension()Setter name: set_minZoomDimension(value)
mouseNavEnabled
Determines whether or not mouse navigation is enabled
Getter name: get_mouseNavEnabled()Setter name: set_mouseNavEnabled(value)
overlays
A list of overlay controls
Getter name: get_overlays()Setter name: set_overlays(value)
prefixUrl
Prefix URL
Getter name: get_prefixUrl()Setter name: set_prefixUrl(value)
showNavigationControl
Determines whether or not navigation buttons should be shown
Getter name: get_showNavigationControl()Setter name: set_showNavigationControl(value)
springStiffness
Determines how sharply springs used for animations move. Default is 5.0
Getter name: get_springStiffness()Setter name: set_springStiffness(value)
visibilityRatio
Minimum portion of the viewport that must show visible content in both dimensions. Default is 0.1
Getter name: get_visibilityRatio()Setter name: set_visibilityRatio(value)
wrapHorizontal
Determines whether or not the control uses horizontal wrapping
Getter name: get_wrapHorizontal()Setter name: set_wrapHorizontal(value)
wrapVertical
Determines whether or not the control uses vertical wrapping
Getter name: get_wrapVertical()Setter name: set_wrapVertical(value)
xmlPath
An XML path
Getter name: get_xmlPath()Setter name: set_xmlPath(value)
zoomPerClick
The factor by which images should zoom in on being clicked. Default is 2
Getter name: get_zoomPerClick()Setter name: set_zoomPerClick(value)
zoomPerSecond
The factor by which images should zoom in each second the zoom buttons are held down. Default is 2
Getter name: get_zoomPerSecond()Setter name: set_zoomPerSecond(value)
Client methods
getNavControl()
Returns a navigation control of the viewer
Client events
animationend
Fires when animation ends
Add event handler method: add_animationend(handler)Remove event handler method: remove_animationend(handler)
animationstart
Fires when animation starts
Add event handler method: add_animationstart(handler)Remove event handler method: remove_animationstart(handler)
error
Fires when the error occurs
Add event handler method: add_error(handler)Remove event handler method: remove_error(handler)
ignore
Fires when the ignore event occurs
Add event handler method: add_ignore(handler)Remove event handler method: remove_ignore(handler)
open
Fires when the viewer opens
Add event handler method: add_open(handler)Remove event handler method: remove_open(handler)
resize
Fires on viewer resizing
Add event handler method: add_resize(handler)Remove event handler method: remove_resize(handler)
Viewport
Client methods
| Name | Description |
|---|---|
| getAspectRatio() | Returns viewport aspect ratio |
| getBounds() | Returns viewport bounds |
| getCenter() | Returns viewport center point |
| getContainerSize() | Returns viewport container size |
| getZoom() | Returns viewport current zoom level |
Client methods
getAspectRatio()
Returns viewport aspect ratio
getBounds()
Returns viewport bounds
getCenter()
Returns viewport center point
getContainerSize()
Returns viewport container size
getZoom()
Returns viewport current zoom level