TatukGIS Developer Kernel

User Tools

Site Tools

api:dk11:activex:tatukgis_xdk11.tgis_viewerwnd

Table of Contents



TGIS_ViewerWnd class

DK for ActiveX | TatukGIS_XDK11.TGIS_ViewerWnd | Classes | Methods | Properties

Main visual VCL control responsible for displaying and interacting with maps in a window.

Available also on: Delphi FMX | .NET WinForms | Java | Python.

Syntax

// C#
public class TGIS_ViewerWnd : ITGIS_ViewerWnd, ITGIS_ViewerWnd_OCX, IGIS_Viewer, IGIS_ViewerWnd, ITGIS_ViewerWndEvents 
{
}
' VisualBasic
Public Class TGIS_ViewerWnd
  Implements ITGIS_ViewerWnd
  Implements ITGIS_ViewerWnd_OCX
  Implements IGIS_Viewer
  Implements IGIS_ViewerWnd
  Implements ITGIS_ViewerWndEvents
End Class
// Oxygene
type
  TGIS_ViewerWnd = public class
  end;

Implements

ITGIS_ViewerWnd ITGIS_ViewerWnd_OCX IGIS_Viewer IGIS_ViewerWnd ITGIS_ViewerWndEvents

Methods

Inherited Overrides Protected
Name Visibility Description
Add public Add a layer to the Viewer.
(Implements IGIS_Viewer.Add)
AddHierarchy public Read hierarchy information and build hierarchy groups with layers.
(Implements IGIS_Viewer.AddHierarchy)
AfterPaintEvent public AfterPaint event.
(Inherited from ITGIS_ViewerWndEvents)
AfterPaintRendererEvent public AfterPaintRenderer event.
(Inherited from ITGIS_ViewerWndEvents)
AfterProjectOpenEvent public Fired after TGIS_Viewer.Open completes.
(Inherited from ITGIS_ViewerWndEvents)
AfterUpdateEvent public AfterUpdate event.
(Inherited from ITGIS_ViewerWndEvents)
AttachDelphiObj public Only for internal use of TatukGIS.
(Inherited from ITBaseObject)
(Implements ITBaseObject.AttachDelphiObj)
AttachLayer public Attach layer to the viewer by re-parenting.
(Implements IGIS_Viewer.AttachLayer)
BeforePaintEvent public BeforePaint event.
(Inherited from ITGIS_ViewerWndEvents)
BeforePaintRendererEvent public BeforePaintRenderer event.
(Inherited from ITGIS_ViewerWndEvents)
BeforeUpdateEvent public BeforeUpdate event.
(Inherited from ITGIS_ViewerWndEvents)
BeginPaintInternal public Notify the viewer that painting is starting.
(Implements IGIS_Viewer.BeginPaintInternal)
BusyEvent public Fired regularly during long-running operations to report progress.
(Inherited from ITGIS_ViewerWndEvents)
BusyPrepare public Prepare BusyEvent for a long-running operation.
(Implements IGIS_Viewer.BusyPrepare)
BusyRelease public Release the busy state.
(Implements IGIS_Viewer.BusyRelease)
BusyShake public Update the busy state.
(Implements IGIS_Viewer.BusyShake)
CenterViewport public Sets the viewport so that _ptg becomes visible at the center of the screen.
(Implements IGIS_Viewer.CenterViewport)
ChangeHash public Change hash used to verify whether the layer order, parameters, or related viewer state has been modified.
(Implements IGIS_Viewer.ChangeHash)
Close public Close the current project.
(Implements IGIS_Viewer.Close)
ControlAutoCenterViewport public Move the screen origin of the map by delta values.
ControlCanvasHeight public Gets the canvas height.
ControlCanvasScale public Gets the canvas scale.
ControlCanvasWidth public Gets the canvas width.
ControlClose public Notifies the control that the map is going to be closed.
ControlDrawTexture public Draws a texture.
ControlDrawTexture_2 public Draws a texture.
ControlExtentChanged public Notify the control that the map extent has changed.
ControlFlash public Flashes the control.
ControlHourglassHide public Hides the hourglass cursor.
ControlHourglassShake public Shakes the hourglass cursor.
ControlHourglassShow public Shows the hourglass cursor.
ControlObject public
ControlPPI public Gets the current PPI.
ControlProcessMessages public Processes pending messages.
ControlRaiseEditorChangeEvent public Raise the editor change event.
ControlRenderer public Gets the renderer instance.
ControlRepaint public Repaints the control.
ControlSet3DMode public Set the current 3D mode.
ControlSystemPPI public Gets the system PPI.
ControlUpdateBasemap public Updates the basemap.
ControlUpdateEditor public Updates the editor.
ControlUpdateProgressive public Performs a progressive update.
ControlUpdateSelection public Updates the selection layer.
ControlUpdateSynchronize public Wait for a pending paint operation to be finalized.
ControlUpdateTopmost public Updates the topmost layer.
ControlUpdateWholeMap public Updates the whole map.
Delete public Delete the layer identified by a name.
(Implements IGIS_Viewer.Delete)
DelphiObj public Only for internal use of TatukGIS.
(Inherited from ITBaseObject)
(Implements ITBaseObject.DelphiObj)
DoMouseDown public Invokes the viewer's mouse-down handling logic.
DoMouseMove public Invokes the viewer's mouse-move handling logic.
DoMouseUp public Invokes the viewer's mouse-up handling logic.
Draw public Draw all layers on the current renderer.
(Implements IGIS_Viewer.Draw)
EditorChangeEvent public EditorChange event.
(Inherited from ITGIS_ViewerWndEvents)
EditorPointChangeEvent public Fired when a point is changed in the editor.
(Inherited from ITGIS_ViewerWndEvents)
EditorPointMoveEvent public Fired while moving an edited point with the mouse in the editor.
(Inherited from ITGIS_ViewerWndEvents)
EditorSnapPointEvent public Fired when the editor snaps a point in custom snapping mode.
(Inherited from ITGIS_ViewerWndEvents)
EndPaintInternal public Notify the viewer that painting has finished.
(Implements IGIS_Viewer.EndPaintInternal)
ExtentChangeEvent public Fired when TGIS_Viewer.Extent changes.
(Inherited from ITGIS_ViewerWndEvents)
FullExtent public Calculate the screen origin, zoom, and viewport to place the whole map in the window.
(Implements IGIS_Viewer.FullExtent)
FullExtentZoom public Calculates the zoom that fits the whole map inside the window.
(Implements IGIS_Viewer.FullExtentZoom)
Get public Retrieve the layer identified by name.
(Implements IGIS_Viewer.Get)
GetCacheBitmap public Returns a copy of the last cache bitmap.
GetGrid public Fill the provided _grid array with values for _extent.
(Implements IGIS_Viewer.GetGrid)
GetRenderContext public Returns the current rendering context object.
(Implements IGIS_Viewer.GetRenderContext)
GetViewer public Get the internal viewer handle.
HelpEvent public Fired when context-sensitive help is requested.
(Inherited from ITGIS_ViewerWndEvents)
HourglassActive public Test whether the hourglass is active.
(Implements IGIS_Viewer.HourglassActive)
HourglassPrepare public Prepare the hourglass cursor for a long operation.
(Implements IGIS_Viewer.HourglassPrepare)
HourglassRelease public Release the hourglass state.
(Implements IGIS_Viewer.HourglassRelease)
HourglassRestart public Restart hourglass timing used for progressive updates.
(Implements IGIS_Viewer.HourglassRestart)
HourglassShake public Refresh the hourglass state.
(Implements IGIS_Viewer.HourglassShake)
Interrupt public Request interruption of a long-running operation as soon as possible.
(Implements IGIS_Viewer.Interrupt)
Interrupted public Test whether a pending operation must be aborted.
(Implements IGIS_Viewer.Interrupted)
InvalidateBasemap public Invalidate only basemap layers.
(Implements IGIS_Viewer.InvalidateBasemap)
InvalidateEditor public Invalidate the editor to mark the viewer for redraw after an editor change.
(Implements IGIS_Viewer.InvalidateEditor)
InvalidateExtent public Invalidate an extent for a full map redraw.
(Implements IGIS_Viewer.InvalidateExtent)
InvalidateExtent_2 public Invalidate an extent.
(Implements IGIS_Viewer.InvalidateExtent_2)
InvalidateSelection public Invalidate the selection to mark the viewer for redraw after a selection change.
(Implements IGIS_Viewer.InvalidateSelection)
InvalidateTopmost public Invalidate only topmost layers.
(Implements IGIS_Viewer.InvalidateTopmost)
InvalidateWholeMap public Invalidate whole map.
(Implements IGIS_Viewer.InvalidateWholeMap)
LayerAddEvent public Fired when a layer is added to the viewer, after creation and before opening.
(Inherited from ITGIS_ViewerWndEvents)
LayerDeleteEvent public Fired when a layer is deleted from the viewer, just before the layer is destroyed.
(Inherited from ITGIS_ViewerWndEvents)
Locate public Locates the shape nearest to _ptg that is within _prec.
(Implements IGIS_Viewer.Locate)
LocateEx public Locates shapes on layers near _ptg and returns the best candidate from each layer that is within _prec.
(Implements IGIS_Viewer.LocateEx)
Locate_2 public Locates the shape nearest to _ptg that is within _prec.
(Implements IGIS_Viewer.Locate_2)
Locate_3 public Locates the shape nearest to _pt that is within _prec.
(Implements IGIS_Viewer.Locate_3)
Lock public Lock the viewer.
(Implements IGIS_Viewer.Lock)
MapToScreen public Converts point coordinates from map coordinates to screen coordinates.
(Implements IGIS_Viewer.MapToScreen)
MapToScreen3D public Converts 3D point coordinates from map coordinates to screen coordinates.
(Implements IGIS_Viewer.MapToScreen3D)
MapToScreenEx public Converts point coordinates from map coordinates to screen coordinates, returning the result as TGIS_Point.
(Implements IGIS_Viewer.MapToScreenEx)
MapToScreenRect public Converts rectangle coordinates from map coordinates to screen coordinates.
(Implements IGIS_Viewer.MapToScreenRect)
MarkModified public Mark viewer upon some modifications.
(Implements IGIS_Viewer.MarkModified)
ModeChangeEvent public ModeChange event.
(Inherited from ITGIS_ViewerWndEvents)
MoveViewport public Moves the map viewport by delta values in screen coordinates.
(Implements IGIS_Viewer.MoveViewport)
MoveViewportEx public Moves the map viewport by delta values in map coordinates.
(Implements IGIS_Viewer.MoveViewportEx)
MustSave public Check if any layer or the project file was modified by editing.
(Implements IGIS_Viewer.MustSave)
NotifySubscribers public Send a notification to subscribed controls.
(Implements IGIS_Viewer.NotifySubscribers)
OnClick public Standard VCL event.
(Inherited from ITGIS_ViewerWndEvents)
OnDblClick public Standard VCL event.
(Inherited from ITGIS_ViewerWndEvents)
OnKeyDown public Standard VCL event.
(Inherited from ITGIS_ViewerWndEvents)
OnKeyPress public Standard VCL event.
(Inherited from ITGIS_ViewerWndEvents)
OnKeyUp public Standard VCL event.
(Inherited from ITGIS_ViewerWndEvents)
OnMouseDown public Standard VCL event.
(Inherited from ITGIS_ViewerWndEvents)
OnMouseMove public Standard VCL event.
(Inherited from ITGIS_ViewerWndEvents)
OnMouseUp public Standard VCL event.
(Inherited from ITGIS_ViewerWndEvents)
OnMouseWheel public Standard VCL event.
(Inherited from ITGIS_ViewerWndEvents)
OnMouseWheelDown public Standard VCL event.
(Inherited from ITGIS_ViewerWndEvents)
OnMouseWheelUp public Standard VCL event.
(Inherited from ITGIS_ViewerWndEvents)
Open public Open a project.
(Implements IGIS_Viewer.Open)
OpenEx public Open a project file from memory.
(Implements IGIS_Viewer.OpenEx)
OpenEx_2 public Open a project file from memory.
(Implements IGIS_Viewer.OpenEx_2)
Open_2 public Open a project.
(Implements IGIS_Viewer.Open_2)
PaintExceptionEvent public Fired when painting raises an exception.
(Inherited from ITGIS_ViewerWndEvents)
PaintExtraEvent public PaintExtra event.
(Inherited from ITGIS_ViewerWndEvents)
PasswordEvent public Fired when opening a layer requires credentials such as a username/password key-value pair.
(Inherited from ITGIS_ViewerWndEvents)
PixelsToTwips public Converts a size from device-dependent pixels to device-independent twips (1/1440 inch) to keep the map device independent.
(Implements IGIS_Viewer.PixelsToTwips)
Print public Print the current viewer content using the default printer.
(Implements IGIS_ViewerWnd.Print)
PrintBmp public Prints the current view to a bitmap.
PrintBmp_2 public Prints the current view to a bitmap.
PrintBmp_3 public Print the current viewer content to a bitmap.
(Implements IGIS_ViewerWnd.PrintBmp_3)
PrintBmp_4 public Print the current viewer content to a bitmap.
(Implements IGIS_ViewerWnd.PrintBmp_4)
PrintClipboard public Prints the current view to the clipboard.
PrintClipboard_2 public Prints the current view to the clipboard.
PrintPdf public Prints the current extent to PDF.
(Implements IGIS_Viewer.PrintPdf)
PrintPdf_2 public Prints the current extent to PDF.
(Implements IGIS_Viewer.PrintPdf_2)
PrintPdf_3 public Prints the current extent to PDF using the default page size.
(Implements IGIS_Viewer.PrintPdf_3)
PrintPdf_4 public Prints the current extent to PDF using the default page size.
(Implements IGIS_Viewer.PrintPdf_4)
PrintSvg public Prints the current extent to SVG (Scalable Vector Graphics) using the parent view box size and parent PPI.
(Implements IGIS_Viewer.PrintSvg)
PrintSvg_2 public Prints the current extent to SVG (Scalable Vector Graphics).
(Implements IGIS_Viewer.PrintSvg_2)
PrintSvg_3 public Prints the current extent to SVG (Scalable Vector Graphics) using the parent view box size and parent PPI.
(Implements IGIS_Viewer.PrintSvg_3)
PrintSvg_4 public Prints the current extent to SVG (Scalable Vector Graphics).
(Implements IGIS_Viewer.PrintSvg_4)
Print_2 public Print the current viewer content using the specified printer.
(Implements IGIS_ViewerWnd.Print_2)
ProjectCloseEvent public Fired when TGIS_Viewer.Close is called.
(Inherited from ITGIS_ViewerWndEvents)
ProjectOpenEvent public Fired when TGIS_Viewer.Open is called.
(Inherited from ITGIS_ViewerWndEvents)
RaiseBusyEvent public Fire the viewer busy event.
(Implements IGIS_Viewer.RaiseBusyEvent)
RaiseHelpEvent public Fire the viewer help event.
(Implements IGIS_Viewer.RaiseHelpEvent)
ReadConfig public Read all configuration data from the project.
(Implements IGIS_Viewer.ReadConfig)
RecalcExtent public Calculates a common extent.
(Implements IGIS_Viewer.RecalcExtent)
Reposition public Reposition the map within the component window.
(Implements IGIS_Viewer.Reposition)
RereadConfig public Reread all configuration data from the project and layer configuration files.
(Implements IGIS_Viewer.RereadConfig)
RestorePaintState public Restore and free the current paint state.
(Implements IGIS_Viewer.RestorePaintState)
RevertAll public Revert all layers to a file-based original.
(Implements IGIS_Viewer.RevertAll)
RotatedExtent public Computes the extent that encompasses an extent after viewer rotation.
(Implements IGIS_Viewer.RotatedExtent)
RotatedPoint public Computes the position of a point after viewer rotation.
(Implements IGIS_Viewer.RotatedPoint)
RotatedPoint3D public Computes the position of a 3D point after viewer rotation.
(Implements IGIS_Viewer.RotatedPoint3D)
RotatedPoint3D_ref public Computes the position of the 3D point after viewer rotation.
(Implements IGIS_Viewer.RotatedPoint3D_ref)
SaveAll public Save all layers (parameters and data)
(Implements IGIS_Viewer.SaveAll)
SaveData public Save all changes to the data.
(Implements IGIS_Viewer.SaveData)
SaveProject public Save the current project.
(Implements IGIS_Viewer.SaveProject)
SaveProjectAs public Save the current project under a new name.
(Implements IGIS_Viewer.SaveProjectAs)
SaveProjectAsEx public Save the current project under a new name.
(Implements IGIS_Viewer.SaveProjectAsEx)
SaveProjectAsEx_2 public Save the current project under a new name.
(Implements IGIS_Viewer.SaveProjectAsEx_2)
SaveProjectAs_2 public Save the current project under a new name.
(Implements IGIS_Viewer.SaveProjectAs_2)
SaveProject_2 public Save the current project.
(Implements IGIS_Viewer.SaveProject_2)
ScreenToMap public Converts point coordinates from screen coordinates to map coordinates.
(Implements IGIS_Viewer.ScreenToMap)
ScreenToMap3D public Converts point coordinates from screen coordinates to map coordinates.
(Implements IGIS_Viewer.ScreenToMap3D)
ScreenToMapEx public Converts point coordinates from screen coordinates to map coordinates, using TGIS_Point as the source type.
(Implements IGIS_Viewer.ScreenToMapEx)
ScreenToMapRect public Converts rectangle coordinates from screen coordinates to map coordinates.
(Implements IGIS_Viewer.ScreenToMapRect)
SetCSByEPSG public Sets the coordinate system from an EPSG (European Petroleum Survey Group) code.
(Implements IGIS_Viewer.SetCSByEPSG)
SetCSByWKT public Sets the coordinate system from a WKT (Well-Known Text) string containing a GEOGCS or PROJCS definition.
(Implements IGIS_Viewer.SetCSByWKT)
SetCSByWKTFile public Sets the coordinate system from a file containing a WKT (Well-Known Text) string with a GEOGCS or PROJCS definition.
(Implements IGIS_Viewer.SetCSByWKTFile)
SetViewer public Set the internal viewer handle.
SetViewport public Sets the viewport origin to a given position in map coordinates.
(Implements IGIS_Viewer.SetViewport)
StorePaintState public Store the current paint state.
(Implements IGIS_Viewer.StorePaintState)
Subscribe public Add provided control to the notification subscription list.
(Implements IGIS_Viewer.Subscribe)
SynchronizePaint public Wait for a pending paint operation to finish.
(Implements IGIS_Viewer.SynchronizePaint)
TapDoubleEvent public TapDouble event.
(Inherited from ITGIS_ViewerWndEvents)
TapLongEvent public TapLong event.
(Inherited from ITGIS_ViewerWndEvents)
TapSimpleEvent public TapSimple event.
(Inherited from ITGIS_ViewerWndEvents)
TwipsToPixels public Converts a size from device-independent twips (1/1440 inch) to device-dependent pixels to keep the map device independent.
(Implements IGIS_Viewer.TwipsToPixels)
TwipsToPoints public Converts a size from device-independent twips (1/1440 inch) to device points for advanced font sizing.
(Implements IGIS_Viewer.TwipsToPoints)
Unlock public Unlock the viewer and redraw it.
(Implements IGIS_Viewer.Unlock)
Unlock_2 public Unlock the viewer and optionally redraw it.
(Implements IGIS_Viewer.Unlock_2)
UnrotatedExtent public Computes the original extent of a rotated extent.
(Implements IGIS_Viewer.UnrotatedExtent)
UnrotatedPoint public Computes the original position of a rotated point.
(Implements IGIS_Viewer.UnrotatedPoint)
UnrotatedPoint3D public Computes the original position of a rotated 3D point.
(Implements IGIS_Viewer.UnrotatedPoint3D)
UnrotatedPoint3D_ref public Computes the original position of a rotated 3D point.
(Implements IGIS_Viewer.UnrotatedPoint3D_ref)
UnSubscribe public Remove provided control from the notification subscription list.
(Implements IGIS_Viewer.UnSubscribe)
UpdateEvent public Update event.
(Inherited from ITGIS_ViewerWndEvents)
VisibleExtentChangeEvent public Fired before BeforePaint when TGIS_Viewer.VisibleExtent changes.
(Inherited from ITGIS_ViewerWndEvents)
WaitForBackgroundProcesses public Waits for any pending background processes that must finish before the application can continue.
(Implements IGIS_Viewer.WaitForBackgroundProcesses)
WaitForNotBusy public Calls _proc when the viewer fully finishes the painting process.
(Implements IGIS_Viewer.WaitForNotBusy)
WriteConfig public Write all configuration data to the project or layer INI file.
(Implements IGIS_Viewer.WriteConfig)
ZoomBy public Zoom the viewer.
(Implements IGIS_ViewerWnd.ZoomBy)
ZoomChangeEvent public Fired before OnBeforePaint when Viewer.Zoom changes.
(Inherited from ITGIS_ViewerWndEvents)

Properties

Inherited Protected
Name Visibility Description
AutoCenter public If True, centers the map in response to click, edit, and similar viewer operations.
AutoStyle public If True, layers added to the viewer will have a unique style applied.
(Implements IGIS_Viewer.AutoStyle)
BigExtent public Map extent encompassing the collective extents of all layers and a border defined by BigExtentMargin.
(Implements IGIS_Viewer.BigExtent)
BigExtentMargin public Map extent margin.
(Implements IGIS_Viewer.BigExtentMargin)
BorderStyle public Border style of the viewer control.
BusyLevel public Level of current busy state.
(Implements IGIS_Viewer.BusyLevel)
BusyText public Text related to the current busy state.
(Implements IGIS_Viewer.BusyText)
Center public Center the screen based on given point.
(Implements IGIS_Viewer.Center)
CenterPtg public Point on which the viewer will be centered during zoom.
(Implements IGIS_Viewer.CenterPtg)
Color public Background color.
(Inherited from IGIS_Viewer)
Copyright public Legal notice and product version.
(Implements IGIS_Viewer.Copyright)
CS public Coordinate system assigned to the viewer.
(Implements IGIS_Viewer.CS)
CursorFor3DSelect public Cursor for TGIS_Viewer3DMode.Select.
CursorForCameraPosition public Cursor for TGIS_Viewer3DMode.CameraPosition.
CursorForCameraRotation public Cursor for TGIS_Viewer3DMode.CameraRotation.
CursorForCameraXY public Cursor for TGIS_Viewer3DMode.CameraXY.
CursorForCameraXYZ public Cursor for TGIS_Viewer3DMode.CameraXYZ.
CursorForCameraZoom public Cursor for TGIS_Viewer3DMode.Zoom.
CursorForDrag public Cursor for TGIS_ViewerMode.Drag mode when dragging the map within the viewer window.
CursorForEdit public Cursor for TGIS_ViewerMode.Edit mode when editing a feature on the map.
CursorForSelect public Cursor for TGIS_ViewerMode.Select mode when selecting items on the map.
CursorForSunPosition public Cursor for TGIS_Viewer3DMode.SunPosition.
CursorForUserDefined public Cursor for TGIS_ViewerMode.UserDefined mode.
CursorForZoom public Cursor for TGIS_ViewerMode.Zoom mode when zooming the map using a rubber-band rectangle.
CursorForZoomEx public Cursor for TGIS_ViewerMode.ZoomEx mode when zooming the map interactively.
CustomData public List of custom user-defined data saved to and restored from config/project files.
(Implements IGIS_Viewer.CustomData)
CustomPPI public Custom resolution in pixels-per-inch.
(Implements IGIS_Viewer.CustomPPI)
DelayedUpdate public Delayed update threshold in milliseconds.
(Implements IGIS_Viewer.DelayedUpdate)
Editor public Editor context.
(Implements IGIS_Viewer.Editor)
Extent public Map extent encompassing the collective extents of all layers.
(Implements IGIS_Viewer.Extent)
FileCopyrights public List of copyrights.
(Implements IGIS_Viewer.FileCopyrights)
FontScale public Font magnifying factor in percents.
(Implements IGIS_Viewer.FontScale)
FullDrawExtent public Extent of the full current or last drawing area, including margin and without tiling.
(Implements IGIS_Viewer.FullDrawExtent)
Hierarchy public Hierarchy list.
(Implements IGIS_Viewer.Hierarchy)
IncrementalPaint public Is partial drawing to screen done in incremental mode?
(Implements IGIS_Viewer.IncrementalPaint)
InPaint public True if the viewer is busy in the Paint procedure.
(Implements IGIS_Viewer.InPaint)
IsBusy public Indicates whether the viewer is currently painting.
(Implements IGIS_Viewer.IsBusy)
IsEmpty public True if the viewer is empty and contains no layers.
(Implements IGIS_Viewer.IsEmpty)
IsLocked public True if the viewer is in the locked state.
(Implements IGIS_Viewer.IsLocked)
IsTopmost public True if Viewer has a topmost layer.
(Implements IGIS_Viewer.IsTopmost)
Items public All layers.
(Implements IGIS_Viewer.Items)
KeepScale public True if a viewer should maintain scale upon resize.
(Implements IGIS_Viewer.KeepScale)
LabelsReg public Labels position allocator object.
(Implements IGIS_Viewer.LabelsReg)
Level public Sets and gets the zoom level for the viewer.
(Implements IGIS_Viewer.Level)
MasterViewer public Reference to the master viewer used by tiled painting.
(Implements IGIS_Viewer.MasterViewer)
MinZoomSize public Minimum size of the interactive zoom rectangle.
Mode public Mouse interaction mode for the viewer, such as selection, map dragging, editing, or zooming.
ModeMouseButton public Active mouse button for Mode operations such as dragging and selecting.
MultiUserMode public Multi-user mode.
(Implements IGIS_Viewer.MultiUserMode)
OverlappedExtentMargin public Overlapped extent margin in pixels.
(Implements IGIS_Viewer.OverlappedExtentMargin)
PPI public Rendering resolution in pixels per inch.
(Implements IGIS_Viewer.PPI)
ProgressiveUpdate public Progressive update threshold in milliseconds.
(Implements IGIS_Viewer.ProgressiveUpdate)
ProjectFile public Project file itself as opened in Open procedure.
(Implements IGIS_Viewer.ProjectFile)
ProjectName public Project file name as opened in Open procedure.
(Implements IGIS_Viewer.ProjectName)
Renderer public Currently active renderer used by the viewer for map drawing.
RestrictedDrag public If True, dragging outside the map extent is not allowed.
(Implements IGIS_Viewer.RestrictedDrag)
RestrictedExtent public Restricted map extent.
(Implements IGIS_Viewer.RestrictedExtent)
RotationAngle public Angle of viewer rotation in radians.
(Implements IGIS_Viewer.RotationAngle)
RotationPoint public Point of viewer rotation in map units.
(Implements IGIS_Viewer.RotationPoint)
Scale public Sets and gets the scale factor.
(Implements IGIS_Viewer.Scale)
ScaleAsFloat public Sets and gets the scale factor.
(Implements IGIS_Viewer.ScaleAsFloat)
ScaleAsText public Sets and gets the scale factor as text in the format '1:10000'.
(Implements IGIS_Viewer.ScaleAsText)
SelectionColor public Color used to highlight selected objects.
SelectionGisColor public Color used to highlight selected objects.
(Implements IGIS_Viewer.SelectionGisColor)
SelectionOutlineOnly public If True, polygons are marked only with an outline and not filled.
(Implements IGIS_Viewer.SelectionOutlineOnly)
SelectionTransparency public Transparency value for selection.
(Implements IGIS_Viewer.SelectionTransparency)
SelectionWidth public Outline width of selection area (>0 in twips, <0 in pixels).
(Implements IGIS_Viewer.SelectionWidth)
SystemPPI public System resolution in pixels per inch.
(Implements IGIS_Viewer.SystemPPI)
TemporaryScaleInternal public Used to force rendering at a scale different from the actual scale.
(Implements IGIS_Viewer.TemporaryScaleInternal)
TemporaryVisibleExtent public Used to force label rendering while drawing with tiles.
(Implements IGIS_Viewer.TemporaryVisibleExtent)
TiledPaint public True if partial drawing to the screen is done in tiled mode.
(Implements IGIS_Viewer.TiledPaint)
UponDestroy public True if the viewer is being destroyed, so some operations such as screen updates should not be performed.
(Implements IGIS_Viewer.UponDestroy)
UseAnimations public True if zoom animations are allowed.
(Implements IGIS_Viewer.UseAnimations)
UseHelp public True if HelpEvent should be used.
UseRTree public True if an RTree spatial index will be used by default when a layer is created.
(Implements IGIS_Viewer.UseRTree)
View3D public Indicates whether the viewer is operating in 3D mode.
(Implements IGIS_ViewerWnd.View3D)
Viewer3D public Assigned IGIS_Viewer3D backend used for 3D map display, or nil when 3D mode is unavailable.
(Implements IGIS_ViewerWnd.Viewer3D)
ViewerParent public Parent for the current IGIS_Viewer object.
(Implements IGIS_Viewer.ViewerParent)
ViewerParentRoot public Root parent for the current IGIS_Viewer object.
(Implements IGIS_Viewer.ViewerParentRoot)
Viewport public Sets and gets the upper-left corner position of the component window within the map.
(Implements IGIS_Viewer.Viewport)
VisibleExtent public Extent of the map visible in the window.
(Implements IGIS_Viewer.VisibleExtent)
Zoom public Sets and gets the relative zoom factor.
(Implements IGIS_Viewer.Zoom)
ZoomEx public Sets and gets the absolute zoom factor.
(Implements IGIS_Viewer.ZoomEx)

Remarks

PURPOSE: Provides the primary windowed Geographic Information System (GIS) viewer implementation for rendering map layers, handling user interaction, and integrating with a viewer parent.

BEHAVIOR: Supports 2D and optional 3D viewing modes, paint and update cycles, screen-to-map coordinate conversion, zoom and pan operations, selection, and event-based customization during rendering and interaction.

USAGE: Use this control as the main embedded map viewer in a Windows VCL application. 

viewer = TGIS_ViewerWnd()       viewer.Open(project_path)       viewer.Zoom = zoom_value

CONSTRAINTS: This unit is Windows/VCL-specific. Optional 3D behavior depends on an assigned IGIS_Viewer3D backend. For bitmap output, use TGIS_ViewerBmp.

Available metadata keys:

Metadata Values Default Description
TGIS_ViewerWnd.Paint.NavigateFeedback.FullCache TRUE FALSE TRUE If true then all labels, selections, and topmost layers will be visible upon scaling, dragging etc.
TGIS_ViewerWnd.Paint.Progressive.Transparency 0..100 60 Long-term operations will be drawn as semitransparent.
TGIS_ViewerWnd.Paint.Progressive.FullCache TRUE FALSE TRUE If true then long-term operations will be drawn behind last cached view.
TGIS_ViewerWnd.Paint.Direct2D.Full TRUE FALSE TRUE If true then drawing does not use Vcl bitmaps for caching.
TGIS_ViewerWnd.Paint.LabelsOnTop TRUE FALSE FALSE If true then labels are drawn on top.
TGIS_ViewerWnd.Paint.Topmost.LabelsOnTop TRUE FALSE FALSE If true then for topmost layers labels are drawn on top.

References

2026/09/06 01:09

Page Tools

©2026 TatukGIS. All Rights Reserved.
Send feedback