LEADTOOLS JavaScript (Leadtools.Controls)
LEAD Technologies, Inc

ImageViewer Object

Fields  Properties  Methods  Events


The following tables list the members exposed by ImageViewer.

Public Constructors
 NameDescription
Public ConstructorImageViewer ConstructorInitializes a new ImageViewer  
Top
Public Fields
 NameDescription
Public FieldMaximumScaleFactorThe maximum value for the ScaleFactor property (1000).  
Public FieldMinimumScaleFactorThe minimum value for the ScaleFactor property (0.001).  
Top
Public Properties
 NameDescription
Public PropertyAspectRatioCorrectionGets or sets the manual aspect ratio correction value  
Public PropertyAutoScrollDivIdGets the auto scroll DIV element ID.  
Public PropertyBackCanvasGets the background canvas element.  
Public PropertyCanvasIdGets the foreground canvas element ID  
Public PropertyControlIdGets the control ID  
Public PropertyControlSizeGets the control size.  
Public PropertyCurrentScaleFactorGets or sets the current scale factor for the image display.  
Public PropertyCurrentXScaleFactorGets the actual value of the horizontal scale factor for the image display.  
Public PropertyCurrentYScaleFactorGets the actual value of the vertical scale factor for the image display.  
Public PropertyDefaultInteractiveModeGets or sets the ImageViewerInteractiveMode that the viewer control should use to process default input events.  
Public PropertyDefaultZoomOriginGets the origin of the default zoom point for current horizontal and vertical alignment, in control coordinates.  
Public PropertyDivIdGets the main DIV element ID.  
Public PropertyEnableDpiCorrectionGets or sets a value that indicates whether the viewer should view images with non-uniform DPI with the correct aspect ratio.  
Public PropertyEnableRequestAnimationFrameGets or sets a value that indicates whether the ImageViewer should use HTML 5 requestAnimationFrame when rendering the image.  
Public PropertyEraseBackgroundOnInvalidateGets or sets a value that indicates whether the ImageViewer will clear the foreground canvas prior to rendering.  
Public PropertyFlipGets or sets a value which determines if the ImageViewer will display the image flipped vertically.  
Public PropertyHasImageGets a value that indicate if the viewer currently has an image.  
Public PropertyHorizontalScrollHeightGets the height of the vertical scrollbar.  
Public PropertyImageControlCenterGets the location of the center of the image, in control coordinates.  
Public PropertyImageDpiXGets or sets the horizontal resolution in dots/inch (or DPI) of the image.  
Public PropertyImageDpiYGets or sets the vertical resolution in dots/inch (or DPI) of the image.  
Public PropertyImageHorizontalAlignmentGets or sets a value that indicates the horizontal alignment for the image in this control.  
Public PropertyImageSizeGets or sets the size of the image in the viewer.  
Public PropertyImageUrlGets or sets the URL to the image to be displayed in the viewer.  
Public PropertyImageVerticalAlignmentGets or sets a value that indicates the vertical alignment for the image in this control.  
Public PropertyInteractiveServiceGets or sets the InteractiveService for this viewer control.  
Public PropertyInvertGets or sets a value that indicates whether to invert the image.  
Public PropertyMouseWheelInteractiveModeGets or sets the ImageViewerInteractiveMode that the viewer control should use to process mouse wheel events.  
Public PropertyNewImageResetOptionsGets or sets a value that determines which properties to reset when a new image is set into the viewer.  
Public PropertyOwnerDrawGets or sets the value that indicate whether the viewer should draw the content of the background canvas into the foreground canvas or not.  
Public PropertyRealImageSizeGets the real width and height of the image.  
Public PropertyResizeOnRotateGets or sets a value that indicates whether the viewer should change the size of the scrolling area when the image is rotated.  
Public PropertyRestrictHiddenScrollModeGets or sets a value that indicates whether scrolling or panning the image outside the maximum range is allowed.  
Public PropertyReverseGets or sets a value which determines if the ImageViewer will display the image reversed horizontally.  
Public PropertyRotateAngleGets or sets the value of the rotation angle to use when displaying the image.  
Public PropertyScaleFactorGets or sets the scale factor used to display the image.  
Public PropertyScreenDpiXGets or sets the current screen horizontal resolution in dots per inch (or DPI).  
Public PropertyScreenDpiYGets or sets the current screen vertical resolution in dots/inch (or DPI).  
Public PropertyScrollModeGets or sets a value that determines how the control handles scrollbars when the current transformation results in the image being larger than the container.  
Public PropertyScrollOffsetGets or sets the scroll offset value.  
Public PropertyScrollRangeGets the size of the current maximum scroll area.  
Public PropertySizeModeGets or sets a value that determines how the control displays the image and the adjusts the display automatically.  
Public PropertyTouchInteractiveModeGets or sets the ImageViewerInteractiveMode that the viewer control should use to process touch input events.  
Public PropertyTransformGets the current transformation matrix used for displaying the image.  
Public PropertyUseDpiGets or sets a value that indicates whether the control must account for the physical resolution of the image when calculating the display properties.  
Public PropertyVerticalScrollWidthGets the width of the vertical scrollbar.  
Public PropertyWorkingInteractiveModeGets the ImageViewerInteractiveMode that the viewer control is currently using to process input events.  
Top
Protected Properties
 NameDescription
Protected PropertyCanScrollGets a value that determines if the ImageViewer can obtain the value of the auto scrollbar location.  
Protected PropertyCanUpdateGets a value that determines if the ImageViewer currently will update the image viewing transform and invalidate the display when changes are made to the control's properties or to the image.  
Top
Public Methods
 NameDescription
Public MethodBeginUpdateStops the viewer from being updated if any change is applied. This is useful to increase the control's speed efficiency.  
Public MethodCenterAtPointCenters the image display at the specified point.  
Public MethodConvertPointConverts the specified point from one CoordinateType to another.  
Public MethodConvertRectConverts the specified rectangle from one CoordinateType to another.  
Public MethodDisposeDestroys this ImageViewer and removes it from the page.  
Public MethodEndUpdateUse this method to indicate that updates to the ImageViewer are complete.  
Public MethodGetMouseInteractiveModeGets the current ImageViewerInteractiveMode assigned to the specified MouseButton.  
Public MethodGetTransformGets the current transformation matrix used for displaying the image with or without DPI scaling.  
Public MethodImageControlRectangleGets the location and size of the image in the viewer in control coordinates.  
Public MethodInvalidateInvalidates the entire surface of the control and causes the control to be redrawn.  
Public MethodOnImageChangedRaises the ImageChanged event.  
Public MethodOnSizeChangedInform the control that the size of the container has changed.  
Public MethodOnTransformChangedRaises the TransformChanged event.  
Public MethodScaleToGrayInterpolates the current image to improve viewability when the image is scaled down.  
Public MethodScrollByScrolls the image by the specified amount.  
Public MethodSetMouseInteractiveModeSets the current ImageViewerInteractiveMode for the specified MouseButton.  
Public MethodZoomZooms or changes the size mode of the image inside the viewer.  
Public MethodZoomToRectZooms the image to the specified rectangle.  
Top
Protected Methods
 NameDescription
Protected MethodBeginScrollThe ImageViewer should stop obtaining the value of the auto scrollbar location.  
Protected MethodEndScrollThe ImageViewer should start obtaining the value of the auto scrollbar location again.  
Protected MethodOnCanvasSizeChangedRaises the CanvasSizeChanged event.  
Protected MethodOnEraseBackgroundRaises the EraseBackground event.  
Protected MethodOnImageErrorRaises the ImageError event.  
Protected MethodOnImageReadyStateChangeRaises the ImageReadyStateChange event.  
Protected MethodOnPostRenderImageRaises the PostRenderImage event.  
Protected MethodOnPreRenderImageRaises the PreRenderImage event.  
Protected MethodOnPropertyChangedRaises the PropertyChanged event.  
Protected MethodOnScrollChangedRaises the ScrollChanged event.  
Protected MethodOnWorkingInteractiveModeChangedRaises the WorkingInteractiveModeChanged event.  
Top
Public Events
 NameDescription
Public EventCanvasSizeChangedOccurs when the size of the control's foreground canvas changes.  
Public EventEraseBackgroundOccurs when the control's background needs to be erased.  
Public EventImageChangedOccurs when the image in the viewer changes.  
Public EventImageErrorOccurs when the URL set into ImageUrl does not contain a valid image.  
Public EventImageReadyStateChangeOccurs while the image is being loaded.  
Public EventPostRenderImageOccurs after the control has rendered the image.  
Public EventPreRenderImageOccurs before the control renders the image.  
Public EventPropertyChangedOccurs when a property value in this ImageViewerchanges.  
Public EventScrollChangedOccurs when the value of ScrollOffset changes.  
Public EventTransformChangedOccurs when the Transform property changes.  
Public EventWorkingInteractiveModeChangedOccurs when the WorkingInteractiveMode property changes.  
Top
See Also

Reference

ImageViewer Object
Leadtools.Controls Namespace

 

 

Products | Support | Contact Us | Copyright Notices

© 2006-2012 All Rights Reserved. LEAD Technologies, Inc.