The following tables list the members exposed by ImageViewer.
Name | Description | |
---|---|---|
ImageViewer | Initializes a new ImageViewer |
Name | Description | |
---|---|---|
beginAutoSizeChanged | Disable detecting if the viewer size has changed. | |
beginRender | Stops the viewer from rendering the content if any change is applied. This is useful to increase the control's speed efficiency. | |
beginTransform | Stops the viewer from updating the transformations matrices and updating the view layout. This is useful to increase the control's speed efficiency. | |
beginUpdate | Stops 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. | |
centerAtPoint | Centers the view display at the specified point. | |
combineFloater | Combines the floaters with the images for all items inside this ImageViewer. | |
convertBoundsToView | Converts a rectangle value from logical (excluding the current transformation) to physical (in control pixel coordinates). | |
convertPoint | Converts a LeadPointD from one coordinates to the other. | |
convertPoints | Converts an array of LeadPointD from one coordinates to the other. | |
convertRect | Converts a LeadRectD from one coordinates to the other. | |
convertTransform | Converts a transformation matrix relative to one item to another. | |
disableSync | Temporarily disable syncing for a group while keeping the group itself intact. | |
disableTransitions | Stops the viewer from updating the transformations matrices and view layout during CSS transitions. | |
dispose | Destroys this ImageViewer and removes it from the page. | |
enableSync | Re-enable syncing for a group. | |
enableTransitions | Enable updating the transformations matrices and view layout during CSS transitions. | |
endAutoSizeChanged | Enables detecting if the viewer size has changed. | |
endRender | Instruct the viewer that updates are completed and rendering of content can be resumed. | |
EndRenderItem | Instructs the viewer that updates are completed and rendering of content can be resumed on the specified item. | |
endTransform | Instruct the viewer that updates are completed and updating transformations and view layout can be resumed. | |
endUpdate | Instruct the viewer that updates are completed and updating the transformations matrices, view layout and rendering of content can be resumed. | |
ensureBoundsVisible | Ensures that the specified rectangle area is visible in the viewer. | |
ensureItemVisible | Ensures that an item is visible in the viewer. | |
ensureItemVisibleByIndex | Ensures that the item at the specified index is visible in the viewer. | |
findNearestItem | Gets the item nearest to the specified physical (in viewer pixel) coordinates. | |
getAllVisibleItems | Gets all the visible items in the viewer. | |
getDestinationRectangle | Utility method to adjust the given LeadRectD based on source size, size mode and alignment. | |
getFirstVisibleItem | First visible item or part of it in the viewer. | |
getFirstVisibleItemIndex | Index for the first visible item or part of it in the viewer. | |
getImageProcessingFile | Helper method to build the full name of an image processing JavaScript file. | |
getImageTransformWithDpi | Transformation matrix of the image with or without DPI scaling (single item mode). | |
getItemBounds | Current logical (excluding the current transformation) bounds of any part of an item. | |
getItemContentTransform | Transformation matrix of the content of an item. | |
getItemFloaterSize | Floater image size of an item. | |
getItemFloaterTransform | Transformation matrix of the floater of an item. | |
getItemImageFloatingPointTransform | Transformation matrix of the image of an item without rounded values. | |
getItemImageSize | Image size of an item. | |
getItemImageTransform | Transformation matrix of the image of an item. | |
getItemImageTransformScaleOnly | Transformation matrix of the image of an item without translation and rotation. | |
getItemImageTransformWithDpi | Transformation matrix of the image of an item with or without DPI scaling. | |
getItemTransform | Transformation matrix of the whole item. | |
getItemViewBounds | Current physical bounds (in control pixel coordinates) of any part of an item. | |
getLargestVisibleItem | Largest visible item or part of it in the viewer. | |
getLargestVisibleItemIndex | Index for the largest visible item or part of it in the viewer. | |
getLastVisibleItem | Last visible item or part of it in the viewer. | |
getLastVisibleItemIndex | Index for the last visible item or part of it in the viewer. | |
getScaleFactors | Utility method to calculate the scale factor needed to perform the specified size mode using a source and destination size. | |
getSynced | Returns a list of all ImageViewer instances that match the given sync. | |
getViewBounds | Current bounds of the view in physical (in control pixel) coordinates. | |
gotoItem | Scroll to the top-left of an item. | |
gotoItemByIndex | Scrolls to the top-left of an item given by its index. | |
hitTestFloater | First item that has its floater under a physical (in viewer pixel) coordinates. | |
hitTestItem | First item that is under a physical point (in viewer pixel) coordinates. | |
hitTestItemPart | Specific part of the item under a physical (in viewer pixel) coordinates. | |
hitTestItems | Items that intersect with a rectangle in physical (in viewer pixel) coordinates. | |
invalidate | Invalidates a portion of the entire surface of the control and causes the control to be redrawn. | |
invalidateItem | Invalidate an item. | |
invalidateItemByIndex | Invalidate the item at the specified index. | |
isItemVisible | Gets a value that indicates whether the specified item or part is currently visible in the viewer. | |
isSyncDisabled | Determines if syncing for a group has been disabled. | |
onActiveItemChanged | Raises the ActiveItemChanged event. | |
onAutoItemElementsAdded | Raises the AutoItemElementsAdded event. | |
onAutoItemElementsRemoved | Raises the AutoItemElementsRemoved event. | |
onElementsUpdated | Raises the ElementsUpdated event. | |
onEraseBackground | Raises the EraseBackground event. | |
onForeCanvasSizeChanged | Raises the ForeCanvasSizeChanged event. | |
onItemChanged | Raises the ItemChanged event. | |
onItemDragDrop | Raises the ItemDragDrop event. | |
onItemError | Raises the ItemError event. | |
onPostRender | Raises the PostRender event. | |
onPostRenderItem | Raises the PostRenderItem event. | |
onPreRender | Raises the PreRender event. | |
onPreRenderItem | Raises the PreRenderItem event. | |
onPropertyChanged | Raises the PropertyChanged event. | |
onRedirectRender | Raises the RedirectRender event. | |
onRender | Raises the Render event. | |
onRenderBackground | Raises the RenderBackground event. | |
onRenderBorder | Raises the RenderBorder event. | |
onRenderError | Raises the RenderError event. | |
onRenderImage | Raises the RenderImage event. | |
onRenderItem | Raises the RenderItem event. | |
onRenderItemFloater | Raises the RenderItemFloater event. | |
onRenderItemFloaterRegion | Raises the RenderItemFloaterRegion event. | |
onRenderItemRegion | Raises the RenderItemRegion event. | |
onRenderShadow | Raises the RenderShadow event. | |
onRenderText | Raises the RenderText event. | |
onScrollOffsetChanged | Raises the ScrollOffsetChanged event. | |
onSelectedItemsChanged | Raises the SelectedItemsChanged event. | |
onSizeChanged | Informs the control that the size of the container has changed. | |
onTransformChanged | Raises the OnTransformChanged event. | |
processDragDropUrl | Processes the image dropped on this ImageViewer during a drag/drop operation. | |
renderRedirect | Renders the content of the viewer to an external context. | |
reset | Resets the display properties to their default values (single item mode). | |
restrictScrollOffset | Ensures a scroll position is inside the minimum and maximum scroll value currently allowed. | |
scrollBy | Scrolls the viewer by the specified amount in pixels. | |
scrollByRestrict | Scrolls the viewer by the specified amount in pixels while always restricting the value to the current minimum and maximum allowed. | |
setItemFloater | Sets the floater for an item. | |
stopInertiaScroll | Stops any inertia scroll operations. | |
sync | Establishes sync groups. | |
translateItemScaleFactor | Translates an item horizontally or vertically a given amount of pixels, regardless of the current zoom value. | |
unsync | Removes a single viewer from the sync group. | |
unsyncGroup | Un-syncs all members of the sync group of the given sync ID. | |
updateStyles | Informs the viewer that the CSS classes used have been changed. | |
updateTransform | Re-calculates the transformation matrices and update the view layout. | |
zoom | Zooms or changes the size mode of the view. | |
zoomToRect | Zooms the view to the specified rectangle. |
Name | Description | |
---|---|---|
activeItem | Active item of this image viewer. | |
activeItemBackgroundColor | Active item background color. | |
activeItemBorderColor | Active item border color. | |
allowDrop | Indicates whether the viewer can accept data that the user drags onto it. | |
aspectRatioCorrection | Manual aspect ratio correction value. | |
autoCreateCanvas | Indicates whether to automatically create the HTML5 Canvas Element when the image is updated. | |
autoResetOptions | Determines which display properties to reset when a new image is set into the viewer (when in single item mode). | |
autoScrollDiv | Auto Scroll HTML Div Element. | |
backImage | Optional background element to be displayed in the viewer (single item mode). | |
backImageLoadImageUrlMode | Specifies how an image should be loaded when this item is provided a URL (single item mode). | |
backImageUrl | URL to the optional background image to displayed in the viewer (single item mode). | |
canRender | Gets a value that indicate if the ImageViewer will render the content when changes are made to the control's properties or to the items. | |
canTransform | Gets 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. | |
canvas | HTML5 Canvas Element to be displayed in the viewer (single item mode). | |
clipImageToContent | Indicates whether to clip the image outside the content area if ResizeOnTransform was set to false. | |
controlSize | Control size. | |
defaultInteractiveMode | Default interactive mode. | |
defaultZoomOrigin | Origin of the default zoom point for current horizontal and vertical alignment, in control pixel coordinates. | |
dropCopyKeyState | Modifier key used to initiate a copy drop operation. | |
dropLinkKeyState | Modifier key used to initiate a link drop operation. | |
dropMoveKeyState | Modifier key used to initiate a move drop operation. | |
element | The HTML or SVG Element to be displayed in the viewer (single item mode). | |
enableRequestAnimationFrame | Indicates whether the ImageViewer should use HTML5 requestAnimationFrame when renderingthe image. |
|
eraseBackgroundOnInvalidate | Indicates whether the ImageViewer will clear the foreground canvas prior to rendering. | |
eventCanvas | The Background HTML5 Canvas Element. | |
flip | Flip the view vertically. | |
flipImageElement | Flip the image vertically without the border. | |
floater | Floater image (single item mode). | |
floaterOpacity | Opacity used when rendering the floaters in this ImageViewer. | |
floaterRegionRenderMode | Indicates how floater regions are rendered. | |
floaterTransform | Transformation matrix used by the floater image (single item mode). | |
foreCanvas | The Foreground HTML5 Canvas Element. | |
hasImage | Gets a value that indicate if the viewer currently has an image (single item mode). | |
hasItems | Gets a value that indicate whether this viewer has any items. | |
hasSize | Whether or not the ControlSize has a valid size. | |
hitTestStateInteractiveMode | The ImageViewerInteractiveMode that is currently in a hit-test state. | |
hoveredItemBackgroundColor | Hovered items background color. | |
hoveredItemBorderColor | Hovered items border color. | |
idleInteractiveMode | The ImageViewerInteractiveMode that is currently acting as the first idle mode. | |
image | The HTML Image Element to be displayed in the viewer (single item mode). | |
imageBackgroundColor | Images background color. | |
imageBorderColor | Images border color. | |
imageBorderThickness | Images border thickness. | |
imageBounds | Physical position and size of the image in the viewer (single item mode). | |
imageDropShadow | The Image's drop shadow properties. | |
imageHorizontalAlignment | Specifies how to align the images inside their items horizontally. | |
imageProcessingLibrariesPath | Path to the image processing library script files. | |
imageRegionRenderMode | Indicates how image regions are rendered. | |
imageResolution | Resolution in dots/inch (or DPI) of the image (single item mode). | |
imageScale | Optional scale value to use when rendering the images (single item mode). | |
imagesDiv | Internally used for loading SVG documents with embedded images. | |
imageSize | Size of the image in the viewer (single item mode). | |
imageTransform | Current transformation matrix used for displaying the image (single item mode). | |
imageUrl | URL to the image to display in the viewer (single item mode). | |
imageVerticalAlignment | Specifies how to align the images inside their items vertically. | |
interactiveModes | The list of interactive modes in this ImageViewer. | |
interactiveService | The InteractiveService for this viewer control. | |
interpolationMode | Interpolation mode used by this ImageViewer. | |
interpolationRunMode | Interpolation run mode used by this ImageViewer. | |
invert | Indicates whether to invert the item images. | |
isRenderRedirected | Gets a value that indicate whether the current rendering operation is targeting an external device rather the control itself. | |
isSyncSource | Indicates that this image viewer can act as a sync source. | |
isSyncTarget | Indicates that this image viewer can act as a sync target. | |
isTransitionsEnabled | Detect if the image viewer is in a state where CSS transition detection is enabled. | |
itemBackgroundColor | Default items background color. | |
itemBorderColor | Default items border color. | |
itemBorderThickness | Items border thickness. | |
itemHorizontalAlignment | Specifies how to align the items inside the view horizontally. | |
itemMargin | Margins to use between the view and the items. | |
itemPadding | Padding to use between the items border and the content. | |
items | The collection of items in this ImageViewer. | |
itemSize | Default item size. | |
itemSizeMode | Indicates how the images are displayed inside their items. | |
itemSpacing | Spacing to use between neighboring items. | |
itemTextColor | Default items text color. | |
itemTextFont | Items text font. | |
itemTextTrimming | Items text trimming options. | |
itemTextWrap | Indicates whether the items text should automatically wrap to the next line if needed. | |
itemVerticalAlignment | Specifies how to align the items inside the view vertically. | |
loadImageUrlMode | Specifies how an image should be loaded when this item is provided a URL (single item mode). | |
mainDiv | Main HTML Div Element. | |
maximumScaleFactor | Maximum scale factor allowed. | |
maximumScrollSize | Current maximum scroll size allowed. | |
minimumScaleFactor | Minimum scale factor allowed. | |
name | User-defined name associated with the ImageViewer instance. | |
ownerDraw | Indicates whether the control automatically renders the view and items. | |
passthroughDiv | An HTML Div Element used for assistance with pointer events capture. | |
RenderInsideClippingRect | Indicates whether to render only the items inside the clipping rectangle, or the entire viewer area. | |
resizeElementForView | Indicates whether to resize the item element instead of scaling it for the view. | |
resizeOnTransform | Indicates whether the viewer should change the size of the scrolling area when an item is transformed. | |
restrictScroll | Indicates whether scrolling or panning the view outside the maximum range is allowed. | |
reverse | Reverse the view horizontally. | |
reverseImageElement | Reverse the image horizontally without the border. | |
rotateAngle | Value of the rotation angle to use when displaying the view. | |
scaleFactor | Value of the scale factor for the view display. | |
screenDpi | Current screen resolution in dots per inch (or DPI). | |
scrollMode | Determines how the control handles scrollbars when the current transformation results in the view area being larger than the control. | |
scrollOffset | Scroll offset value. | |
selectedItemBackgroundColor | Selected items background color. | |
selectedItemBorderColor | Selected items border color. | |
selectedItemTextColor | Selected items text color. | |
sizeMode | Gets a value that determines how the control displays the view and adjusts the display automatically. | |
syncId | Gets the sync ID of this image viewer. | |
tag | Object that contains data about the control. | |
textHorizontalAlignment | Specifies how to align the text inside their items horizontally. | |
textVerticalAlignment | Specifies how to align the text inside their items vertically. | |
updateShadowOnRotation | Deprecated. Indicates whether to update the CSS values for the box-shadow property of each item border element. | |
useDpi | Indicates whether the control must account for the physical resolution of the images when calculating the display properties. | |
useElements | Checks if the viewer is using the Elements Mode. | |
viewBorderColor | View border color. | |
viewBorderThickness | View border thickness. | |
viewBounds | Current view bounds. | |
viewDiv | Holds the item elements and shows the viewer's view margin, view padding, view border, and view box shadow. | |
viewDivHolder | Parent of the image viewer ImageViewer.ViewDiv. | |
viewDropShadow | View drop shadow properties. | |
viewHorizontalAlignment | Specifies how to align the view inside the control horizontally. | |
viewLayout | The view layout used by this ImageViewer. | |
viewMargin | Margins to use between the control boundary and the view. | |
viewPadding | Padding to use between the view border and the items. | |
viewSize | Current view size in pixels. | |
viewTransform | Current transformation matrix of the view. | |
viewVerticalAlignment | Specifies how to align the view inside the control vertically. | |
workingInteractiveMode | The ImageViewerInteractiveMode that is currently processing the input events (working). | |
xScaleFactor | Value of the horizontal scale factor for the view display. | |
yScaleFactor | Value of the vertical scale factor for the view display. |
Name | Description | |
---|---|---|
activeItemChanged | Occurs when the value of ActiveItem changes. | |
autoItemElementsAdded | Occurs after an item HTML elements are re-added to the DOM. | |
autoItemElementsRemoved | Occurs before an item HTML elements are re-deleted from the DOM. | |
elementsUpdated | Occurs anytime the viewer changes any DOM or CSS property on an element that is part of view or any item. | |
eraseBackground | Occurs when the control's background needs to be erased. | |
foreCanvasSizeChanged | Occurs when the size of the foreground canvas changes. | |
imageLoading | Occurs just before an image starts loading as the result of a URL update. | |
interpolation | Occurs when the interpolator state changes. | |
itemChanged | Occurs when any of the items inside this ImageViewer changes. | |
itemDragDrop | Occurs when data is being dragged or dropped from/to this ImageViewer. | |
itemError | Occurs when an error happens when the viewer tries to update the item image data. | |
postRender | Occurs after the view is rendered. | |
postRenderItem | Occurs after an item is rendered. | |
preRender | Occurs before the view is rendered. | |
preRenderItem | Occurs before an item is rendered. | |
propertyChanged | Occurs when a property value in this ImageViewer changes. | |
redirectRender | Occurs when the viewer content has changed and any external controls performing live capture need to be updated. | |
render | Render the view. | |
renderBackground | Renders view or item background. | |
renderBorder | Renders view or item border. | |
renderError | Occurs when an error happens during rendering. | |
renderImage | Renders the item image. | |
renderItem | Occurs when an item is rendered. | |
renderItemFloater | Renders the item floater. | |
renderItemFloaterRegion | Renders the item floater region. | |
renderItemRegion | Renders the item region. | |
renderShadow | Renders view or item or drop shadow. | |
renderText | Renders the item text. | |
scrollOffsetChanged | Occurs when the value of ScrollOffset changes. | |
selectedItemsChanged | Occurs when any of the items inside this viewer selection state changes. | |
transformChanged | Occurs when the transformation matrix of the view or any of the items change. |