Error processing SSI file
LEADTOOLS JavaScript (Leadtools.Controls)

ImageViewer Object

Show in webframe
Properties  Methods  Events


The following tables list the members exposed by ImageViewer.

Public Constructors
 NameDescription
ImageViewer ConstructorInitializes a new ImageViewer  
Top
Public Properties
 NameDescription
ActiveItemActive item of this image viewer.  
ActiveItemBackgroundColorActive item background color.  
ActiveItemBorderColorActive item border color.  
AllowDropIndicates whether the viewer can accept data that the user drags onto it.  
AspectRatioCorrectionManual aspect ratio correction value  
AutoCreateCanvasIndicates whether to automatically create the HTML5 Canvas Element when the image is updated.  
AutoResetOptionsDetermines which display properties to reset when a new image is set into the viewer (single item mode).  
AutoScrollDivAuto Scroll HTML Div Element.  
BackImageOptional background element to be displayed in the viewer (single item mode).  
BackImageLoadImageUrlModeSpecifies how an image should be loaded when this item is provided a URL (single item mode)  
BackImageUrlURL to the optional background image to displayed in the viewer (single item mode).  
CanvasHTML5 Canvas Element to be displayed in the viewer (single item mode).  
ClipImageToContentIndicates whether to clip the image outside the content area if ResizeOnTransform was set to false.  
ControlSizeControl size.  
DefaultInteractiveModeDefault interactive mode.  
DefaultZoomOriginOrigin of the default zoom point for current horizontal and vertical alignment, in control pixel coordinates.  
DropCopyKeyStateModifier key used to initiate a copy drop operation  
DropLinkKeyStateModifier key used to initiate a link drop operation  
DropMoveKeyStateModifier key used to initiate a move drop operation  
ElementThe HTML or SVG Element to be displayed in the viewer (single item mode).  
EnableRequestAnimationFrameIndicates whether the ImageViewer should use HTML5 requestAnimationFrame when rendering the image.  
EraseBackgroundOnInvalidateIndicates whether the ImageViewer will clear the foreground canvas prior to rendering.  
EventCanvasThe Background HTML5 Canvas Element.  
FlipFlip the view vertically.  
FlipImageElementFlip the image vertically without the border.  
FloaterFloater image (single item mode).  
FloaterOpacityOpacity used when rendering the floaters in this ImageViewer  
FloaterRegionRenderModeIndicates how floater regions are rendered.  
FloaterTransformTransformation matrix used by the floater image (single item mode).  
ForeCanvasThe Foreground HTML5 Canvas Element.  
HasImageGets a value that indicate if the viewer currently has an image (single item mode).  
HasItemsGets a value that indicate whether this viewer has any items.  
HasSizeWhether or not the ControlSize has a valid size.  
HitTestStateInteractiveModeThe ImageViewerInteractiveMode that is currently in a hit-test state.  
HoveredItemBackgroundColorHovered items background color.  
HoveredItemBorderColorHovered items border color.  
IdleInteractiveModeThe ImageViewerInteractiveMode that is currently acting as the first idle mode.  
ImageThe HTML Image Element to be displayed in the viewer (single item mode).  
ImageBackgroundColorImages background color.  
ImageBorderColorImages border color.  
ImageBorderThicknessImages border thickness.  
ImageBoundsPhysical position and size of the image in the viewer (single item mode).  
ImageDropShadowImages drop shadow properties  
ImageHorizontalAlignmentSpecifies how to align the images inside their items horizontally.  
ImageProcessingLibrariesPathPath to the image processing library script files.  
ImageRegionRenderModeIndicates how image regions are rendered.  
ImageResolutionResolution in dots/inch (or DPI) of the image (single item mode).  
ImageScaleOptional scale value to use when rendering the images (single item mode).  
ImagesDivInternally used for loading SVG documents with embedded images.  
ImageSizeSize of the image in the viewer (single item mode).  
ImageTransformCurrent transformation matrix used for displaying the image (single item mode).  
ImageUrlURL to the image to displayed in the viewer (single item mode).  
ImageVerticalAlignmentSpecifies how to align the images inside their items vertically.  
InteractiveModesThe list of interactive modes in this ImageViewer.  
InteractiveServiceThe InteractiveService for this viewer control.  
InterpolationModeInterpolation mode used by this ImageViewer.  
InterpolationRunModeInterpolation run mode used by this ImageViewer.  
InvertIndicates whether to invert the items images.  
IsRenderRedirectedGets a value that indicate whether the current rendering operation is targetting an external device rather the control itself.  
IsTransitionsEnabledDetect if the image viewer is in a state where CSS transition detection is enabled.  
ItemBackgroundColorDefault items background color.  
ItemBorderColorDefault items border color.  
ItemBorderThicknessItems border thickness.  
ItemHorizontalAlignmentSpecifies how to align the items inside the view horizontally.  
ItemMarginMargins to use between the view and the items.  
ItemPaddingPadding to use between the items border and the content.  
ItemsThe colletion of items in this ImageViewer  
ItemSizeDefault item size.  
ItemSizeModeIndicates how the images are displayed inside their items.  
ItemSpacingSpacing to use between neighboring items.  
ItemTextColorDefault items text color.  
ItemTextFontItems text font.  
ItemTextTrimmingItems text trimming options.  
ItemTextWrapIndicates whether the items text should automatically wrap to the next line if needed.  
ItemVerticalAlignmentSpecifies how to align the items inside the view vertically.  
LoadImageUrlModeSpecifies how an image should be loaded when this item is provided a URL (single item mode)  
MainDivMain HTML Div Element.  
MaximumScaleFactorMaximum scale factor allowed.  
MaximumScrollSizeCurrent maximum scroll size allowed.  
MinimumScaleFactorMinimum scale factor allowed.  
OwnerDrawIndicates whether the control automatically renders the view and items.  
PassthroughDivAn HTML Div Element used for assistance with pointer events capture.  
ResizeOnTransformIndicates whether the viewer should change the size of the scrolling area when an item is transformed.  
RestrictScrollIndicates whether scrolling or panning the view outside the maximum range is allowed.  
ReverseReverse the view horizontally.  
ReverseImageElementReverse the image horizontally without the border.  
RotateAngleValue of the rotation angle to use when displaying the view.  
ScaleFactorValue of the scale factor for the view display.  
ScreenDpiCurrent screen resolution in dots per inch (or DPI).  
ScrollModeDetermines how the control handles scrollbars when the current transformation results in the view area being larger than the control.  
ScrollOffsetScroll offset value.  
SelectedItemBackgroundColorSelected items background color.  
SelectedItemBorderColorSelected items border color.  
SelectedItemTextColorSelected items text color.  
SizeModeGets a value that determines how the control displays the view and adjusts the display automatically.  
TagObject that contains data about the control.  
TextHorizontalAlignmentSpecifies how to align the text inside their items horizontally.  
TextVerticalAlignmentSpecifies how to align the text inside their items vertically.  
UpdateShadowOnRotationIndicate whether to update the CSS values for the box-shadow property of each item border element.  
UseDpiIndicates whether the control must account for the physical resolution of the images when calculating the display properties.  
UseElementsChecks if the viewer is using the Elements Mode.  
ViewBorderColorView border color.  
ViewBorderThicknessView border thickness.  
ViewBoundsCurrent view bounds.  
ViewDivHolds the item elements and shows the viewer's view margin, view padding, view border, and view box shadow.  
ViewDivHolderParent of the image viewer ImageViewer.ViewDiv.  
ViewDropShadowView drop shadow properties  
ViewHorizontalAlignmentSpecifies how to align the view inside the control horizontally.  
ViewLayoutView layout used by this ImageViewer.  
ViewMarginMargins to use between the control boundary and the view.  
ViewPaddingPadding to use between the view border and the items.  
ViewSizeCurrent view size in pixels.  
ViewTransformCurrent transformation matrix of the view.  
ViewVerticalAlignmentSpecifies how to align the view inside the control vertically.  
WorkingInteractiveModeThe ImageViewerInteractiveMode that is currently processing the input events (working).  
XScaleFactorValue of the horizontal scale factor for the view display.  
YScaleFactorValue of the vertical scale factor for the view display.  
Top
Protected Properties
 NameDescription
CanRenderGets a value that indicate if the ImageViewer will render the content when changes are made to the control's properties or to the items.  
CanTransformGets a value that indicate if the ImageViewer will update the transformation matrices and view layout when changes are made to the control's properties or to the items.  
Top
Public Methods
 NameDescription
BeginAutoSizeChangedDisable detecting if the viewer size has changed.  
BeginRenderStops the viewer from rendering the content if any change is applied. This is useful to increase the control's speed efficiency.  
BeginTransformStops the viewer from updating the transformations matrices and updating the view layout. This is useful to increase the control's speed efficiency.  
BeginUpdateStops the viewer from updating the transformations matrices, view layout and rendering the content if any change is applied. This is useful to increase the control's speed efficiency.  
CenterAtPointCenters the view display at the specified point.  
CombineFloaterCombines the floaters with the images for all items inside this ImageViewer  
ConvertBoundsToViewConverts a rectangle value from logical (excluding the current transformation) to physical (in control pixel coordinates).  
ConvertPointConverts a LeadPointD from one coordinates to the other.  
ConvertPointsConverts an array of LeadPointD from one coordinates to the other.  
ConvertRectConverts a LeadRectD from one coordinates to the other.  
ConvertTransformConverts a transformation matrix relative to one item to another.  
DisableTransitionsStops the viewer from updating the transformations matrices and view layout during CSS transitions.  
DisposeDestroys this ImageViewer and removes it from the page.  
EnableTransitionsEnable updating the transformations matrices and view layout during CSS transitions.  
EndAutoSizeChangedEnables detecting if the viewer size has changed.  
EndRenderInstruct the viewer that updates are completed and rendering of content can be resumed.  
EndTransformInstruct the viewer that updates are completed and updating transformations and view layout can be resumed.  
EndUpdateInstruct the viewer that updates are completed and updating the transformations matrices, view layout and rendering of content can be resumed.  
EnsureBoundsVisibleEnsures that the specified rectangle area is visible in the viewer.  
EnsureItemVisibleEnsures that an item is visible in the viewer.  
EnsureItemVisibleByIndexEnsures that the item at the specified index is visible in the viewer.  
GetDestinationRectangleUtility method to adjust the given LeadRectD based on source size, size mode and alignment  
GetFirstVisibleItemFirst visible item or part of it in the viewer.  
GetFirstVisibleItemIndexIndex for the first visible item or part of it in the viewer.  
GetImageTransformWithDpiTransformation matrix of the image with or without DPI scaling (single item mode).  
GetItemBoundsCurrent logical (excluding the current transformation) bounds of any part of an item.  
GetItemContentTransformTransformation matrix of the content of an item.  
GetItemFloaterSizeFloater image size of an item.  
GetItemFloaterTransformTransformation matrix of the floater of an item.  
GetItemImageFloatingPointTransformTransformation matrix of the image of an item without rounded values.  
GetItemImageSizeImage size of an item.  
GetItemImageTransformTransformation matrix of the image of an item.  
GetItemImageTransformWithDpiTransformation matrix of the image of an item with or without DPI scaling.  
GetItemTransformTransformation matrix of the whole item.  
GetItemViewBoundsCurrent physical (in control pixel coordinates) bounds of any part of an item.  
GetLargestVisibleItemLargest visible item or part of it in the viewer.  
GetLargestVisibleItemIndexIndex for the largest visible item or part of it in the viewer.  
GetLastVisibleItemLast visible item or part of it in the viewer.  
GetLastVisibleItemIndexIndex for the last visible item or part of it in the viewer.  
GetScaleFactorsUtility method to calculate the scale factor needed to perform the specified size mode using a source and destination size.  
GetViewBoundsCurrent bounds of the view in physical (in control pixel) coordinates  
GotoItemScroll to the top-left of an item.  
GotoItemByIndexScroll to the top-left of an item giving its index.  
HitTestFloaterFirst item that has its floater under a physical (in viewer pixel) coordinates.  
HitTestItemFirst item that is under a physical (in viewer pixel) coordinates.  
HitTestItemPartSpecific part of the item under a physical (in viewer pixel) coordinates.  
HitTestItemsItems that intersect with a rectangle in physical (in viewer pixel) coordinates.  
InvalidateInvalidates a portion of the entire surface of the control and causes the control to be redrawn.  
InvalidateItemInvalidate an item.  
InvalidateItemByIndexInvalidate the item at the specified index.  
IsItemVisibleGets a value that indicate whether the specified item or part is currently visible in the viewer.  
OnSizeChangedInform the control that the size of the container has changed.  
OnTransformChangedRaises the OnTransformChanged event.  
RenderRedirectRender the content of the viewer to an external context.  
ResetResets the display properties to their default values (single item mode).  
RestrictScrollOffsetEnsures a scroll position is inside the minimum and maximum scroll value currently allowed.  
ScrollByScrolls the viewer by the specified amount in pixels.  
ScrollByRestrictScrolls the viewer by the specified amount in pixels while always restricting the value to the current minimum and maximum allowed.  
TranslateItemScaleFactorTranslates an item horizontally or vertically a given amount of pixels regardless of the current zoom value.  
UpdateStylesInform the viewer that the CSS classes used has been changed.  
UpdateTransformRe-calculates the transformation matrices and update the view layout.  
ZoomZooms or changes the size mode of the view.  
ZoomToRectZooms the view to the specified rectangle.  
Top
Protected Methods
 NameDescription
GetItemImageTransformScaleOnlyTransformation matrix of the image of an item without translation and rotation.  
OnActiveItemChangedRaises the ActiveItemChanged event.  
OnAutoItemElementsAddedRaises the AutoItemElementsAdded event.  
OnAutoItemElementsRemovedRaises the AutoItemElementsRemoved event.  
OnElementsUpdatedRaises the ElementsUpdated event.  
OnEraseBackgroundRaises the EraseBackground event.  
OnForeCanvasSizeChangedRaises the ForeCanvasSizeChanged event.  
OnItemChangedRaises the ItemChanged event.  
OnItemDragDropRaises the ItemDragDrop event.  
OnItemErrorRaises the ItemError event.  
OnPostRenderRaises the PostRender event.  
OnPostRenderItemRaises the PostRenderItem event.  
OnPreRenderRaises the PreRender event.  
OnPreRenderItemRaises the PreRenderItem event.  
OnPropertyChangedRaises the PropertyChanged event.  
OnRedirectRenderRaises the RedirectRender event.  
OnRenderRaises the Render event.  
OnRenderBackgroundRaises the RenderBackground event.  
OnRenderBorderRaises the RenderBorder event.  
OnRenderErrorRaises the RenderError event.  
OnRenderImageRaises the RenderImage event.  
OnRenderItemRaises the RenderItem event.  
OnRenderItemFloaterRaises the RenderItemFloater event.  
OnRenderItemFloaterRegionRaises the RenderItemFloaterRegion event.  
OnRenderItemRegionRaises the RenderItemRegion event.  
OnRenderShadowRaises the RenderShadow event.  
OnRenderTextRaises the RenderText event.  
OnScrollOffsetChangedRaises the ScrollOffsetChanged event.  
OnSelectedItemsChangedRaises the SelectedItemsChanged event.  
ProcessDragDropUrlProcesses the image dropped on this ImageViewer during a drag/drop operation.  
Top
Public Events
 NameDescription
ActiveItemChangedOccurs when the value of ActiveItem changes.  
AutoItemElementsAddedOccurs after an item HTML elements are re-added to the DOM.  
AutoItemElementsRemovedOccurs before an item HTML elements are re-deleted from the DOM.  
ElementsUpdatedOccurs anytime the viewer changes any DOM or CSS property on an element that is part of view or any item  
EraseBackgroundOccurs when the control's background needs to be erased.  
ForeCanvasSizeChangedOccurs when the size of the foreground canvas changes.  
ImageLoadingOccurs just before an image starts loading as the result of a URL update.  
InterpolationOccurs when the interpolator state changes.  
ItemChangedOccurs when any of the items inside this ImageViewer changes  
ItemDragDropOccurs when data is being dragged or dropped from/to this ImageViewer.  
ItemErrorOccurs when an error happens when the viewer tries to update the item image data.  
PostRenderOccurs after the view is rendered.  
PostRenderItemOccurs after an item is rendered.  
PreRenderOccurs before the view is rendered.  
PreRenderItemOccurs before an item is rendered.  
PropertyChangedOccurs when a property value in this ImageViewerchanges.  
RedirectRenderOccurs when the viewer content has changed and any external controls performing live capture need to be updated.  
RenderRender the view.  
RenderBackgroundRenders view or item background.  
RenderBorderRenders view or item border.  
RenderErrorOccurs when an error happens during rendering.  
RenderImageRenders the item image.  
RenderItemOccurs when an item is rendered.  
RenderItemFloaterRenders the item floater.  
RenderItemFloaterRegionRenders the item floater region.  
RenderItemRegionRenders the item region.  
RenderShadowRenders view or item or drop shadow.  
RenderTextRenders the item text.  
ScrollOffsetChangedOccurs when the value of ScrollOffset changes.  
SelectedItemsChangedOccurs when any of the items inside this viewer selection state changes.  
TransformChangedOccurs when the transformation matrix of the view or any of the item changes.  
Top
See Also

Reference

ImageViewer Object
Leadtools.Controls Namespace

Error processing SSI file