LEADTOOLS JavaScript (Leadtools.Controls)

ImageViewer Object

Show in webframe
Fields  Properties  Methods  Events


The following tables list the members exposed by ImageViewer.

Public Constructors
 NameDescription
ImageViewer ConstructorInitializes a new ImageViewer  
Top
Public Fields
 NameDescription
MaximumScaleFactorThe maximum value for the ScaleFactor property (1000).  
MinimumScaleFactorThe minimum value for the ScaleFactor property (0.001).  
Top
Public Properties
 NameDescription
AspectRatioCorrectionGets or sets the manual aspect ratio correction value  
AutoScaleBackCanvasGets or sets a value that indicates whether to automatically resize the background canvas if needed.  
AutoScrollDivIdGets the auto scroll DIV element ID.  
BackCanvasGets the background canvas element.  
BackCanvasScaleGets the optional value used to scale the current background canvas.  
BackImageGets the background image element.  
CanvasIdGets the foreground canvas element ID  
ControlIdGets the control ID  
ControlSizeGets the control size.  
CurrentScaleFactorGets or sets the current scale factor for the image display.  
CurrentXScaleFactorGets the actual value of the horizontal scale factor for the image display.  
CurrentYScaleFactorGets the actual value of the vertical scale factor for the image display.  
DefaultInteractiveModeGets or sets the ImageViewerInteractiveMode that the viewer control should use to process default input events.  
DefaultZoomOriginGets the origin of the default zoom point for current horizontal and vertical alignment, in control coordinates.  
DivIdGets the main DIV element ID.  
EnableDpiCorrectionGets or sets a value that indicates whether the viewer should view images with non-uniform DPI with the correct aspect ratio.  
EnableRequestAnimationFrameGets or sets a value that indicates whether the ImageViewer should use HTML 5 requestAnimationFrame when rendering the image.  
EraseBackgroundOnInvalidateGets or sets a value that indicates whether the ImageViewer will clear the foreground canvas prior to rendering.  
FlipGets or sets a value which determines if the ImageViewer will display the image flipped vertically.  
HasImageGets a value that indicate if the viewer currently has an image.  
HorizontalScrollHeightGets the height of the vertical scrollbar.  
ImageControlCenterGets the location of the center of the image, in control coordinates.  
ImageDpiXGets or sets the horizontal resolution in dots/inch (or DPI) of the image.  
ImageDpiYGets or sets the vertical resolution in dots/inch (or DPI) of the image.  
ImageHorizontalAlignmentGets or sets a value that indicates the horizontal alignment for the image in this control.  
ImageSizeGets or sets the size of the image in the viewer.  
ImageUrlGets or sets the URL to the image to be displayed in the viewer.  
ImageVerticalAlignmentGets or sets a value that indicates the vertical alignment for the image in this control.  
InteractiveServiceGets or sets the InteractiveService for this viewer control.  
InvertGets or sets a value that indicates whether to invert the image.  
MouseWheelInteractiveModeGets or sets the ImageViewerInteractiveMode that the viewer control should use to process mouse wheel events.  
NewImageResetOptionsGets or sets a value that determines which properties to reset when a new image is set into the viewer.  
OwnerDrawGets or sets the value that indicate whether the viewer should draw the content of the background image or canvas into the foreground canvas or not.  
PinchInteractiveModeGets or sets the ImageViewerInteractiveMode that the viewer control should use to process pinch events.  
RealImageSizeGets the real width and height of the image.  
ResizeOnRotateGets or sets a value that indicates whether the viewer should change the size of the scrolling area when the image is rotated.  
RestrictHiddenScrollModeGets or sets a value that indicates whether scrolling or panning the image outside the maximum range is allowed.  
ReverseGets or sets a value which determines if the ImageViewer will display the image reversed horizontally.  
RotateAngleGets or sets the value of the rotation angle to use when displaying the image.  
ScaleFactorGets or sets the scale factor used to display the image.  
ScreenDpiXGets or sets the current screen horizontal resolution in dots per inch (or DPI).  
ScreenDpiYGets or sets the current screen vertical resolution in dots/inch (or DPI).  
ScrollModeGets or sets a value that determines how the control handles scrollbars when the current transformation results in the image being larger than the container.  
ScrollOffsetGets or sets the scroll offset value.  
ScrollRangeGets the size of the current maximum scroll area.  
SizeModeGets or sets a value that determines how the control displays the image and adjusts the display automatically.  
TouchInteractiveModeGets or sets the ImageViewerInteractiveMode that the viewer control should use to process touch input events.  
TransformGets the current transformation matrix used for displaying the image.  
UseBackCanvasGets or sets a value that indicates whether to use the backrgound canvas to store the image data.  
UseDpiGets or sets a value that indicates whether the control must account for the physical resolution of the image when calculating the display properties.  
VerticalScrollWidthGets the width of the vertical scrollbar.  
WorkingInteractiveModeGets the ImageViewerInteractiveMode that the viewer control is currently using to process input events.  
Top
Protected Properties
 NameDescription
CanScrollGets a value that determines if the ImageViewer can obtain the value of the auto scrollbar location.  
CanUpdateGets 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
BeginUpdateStops the viewer from being updated if any change is applied. This is useful to increase the control's speed efficiency.  
CenterAtPointCenters the image display at the specified point.  
ConvertPointConverts the specified point from one CoordinateType to another.  
ConvertRectConverts the specified rectangle from one CoordinateType to another.  
DisposeDestroys this ImageViewer and removes it from the page.  
EndUpdateUse this method to indicate that updates to the ImageViewer are complete.  
GetMouseInteractiveModeGets the current ImageViewerInteractiveMode assigned to the specified MouseButton.  
GetTransformGets the current transformation matrix used for displaying the image with or without DPI scaling.  
ImageControlRectangleGets the location and size of the image in the viewer in control coordinates.  
InvalidateInvalidates the entire surface of the control and causes the control to be redrawn.  
OnImageChangedRaises the ImageChanged event.  
OnSizeChangedInform the control that the size of the container has changed.  
OnTransformChangedRaises the TransformChanged event.  
ScaleToGrayInterpolates the current image to improve viewability when the image is scaled down.  
ScrollByScrolls the image by the specified amount.  
SetMouseInteractiveModeSets the current ImageViewerInteractiveMode for the specified MouseButton.  
ZoomZooms or changes the size mode of the image inside the viewer.  
ZoomToRectZooms the image to the specified rectangle.  
Top
Protected Methods
 NameDescription
BeginScrollThe ImageViewer should stop obtaining the value of the auto scrollbar location.  
EndScrollThe ImageViewer should start obtaining the value of the auto scrollbar location again.  
OnCanvasSizeChangedRaises the CanvasSizeChanged event.  
OnEraseBackgroundRaises the EraseBackground event.  
OnImageErrorRaises the ImageError event.  
OnImageReadyStateChangeRaises the ImageReadyStateChange event.  
OnPostRenderImageRaises the PostRenderImage event.  
OnPreRenderImageRaises the PreRenderImage event.  
OnPropertyChangedRaises the PropertyChanged event.  
OnScrollChangedRaises the ScrollChanged event.  
OnWorkingInteractiveModeChangedRaises the WorkingInteractiveModeChanged event.  
Top
Public Events
 NameDescription
CanvasSizeChangedOccurs when the size of the control's foreground canvas changes.  
EraseBackgroundOccurs when the control's background needs to be erased.  
ImageChangedOccurs when the image in the viewer changes.  
ImageErrorOccurs when the URL set into ImageUrl does not contain a valid image.  
ImageReadyStateChangeOccurs while the image is being loaded.  
PostRenderImageOccurs after the control has rendered the image.  
PreRenderImageOccurs before the control renders the image.  
PropertyChangedOccurs when a property value in this ImageViewerchanges.  
ScrollChangedOccurs when the value of ScrollOffset changes.  
TransformChangedOccurs when the Transform property changes.  
WorkingInteractiveModeChangedOccurs when the WorkingInteractiveMode property changes.  
Top
See Also

Reference

ImageViewer Object
Leadtools.Controls Namespace

 

 


Products | Support | Contact Us | Copyright Notices
© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.