api:dk11:delphi:vcl.gisviewerwnd.tgis_viewerwnd
Table of Contents
TGIS_ViewerWnd class
DK for Delphi | VCL.GisViewerWnd.TGIS_ViewerWnd | Classes | Constructors | Methods | Properties | Events
Main visual VCL control responsible for displaying and interacting with maps in a window.
Available also on: Delphi FMX | .NET WinForms | Java | ActiveX | Python.
Syntax
// Delphi type [ComponentPlatformsAttribute(pfidWindows)] TGIS_ViewerWnd = class( TCustomControl, IGIS_Viewer, IGIS_ViewerParent, IGIS_ViewerWnd ) end;
// C++ Builder class PASCALIMPLEMENTATION TGIS_ViewerWnd : public TCustomControl { };
Inheritance
→ TCustomControl
Implements
Constructors
Inherited
Overrides
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| Create | public | Standard constructor. | |
| Destroy | public | Standard destructor. | |
Methods
Inherited
Overrides
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| Add | public | Add a layer to the Viewer. (Implements IGIS_Viewer.Add) |
|
| AddHierarchy | public | Read hierarchy and build groups with layers. (Implements IGIS_Viewer.AddHierarchy) |
|
| AssignedBusyEvent | public | Reference to a busy event handler assigned to the Viewer. (Implements IGIS_Viewer.AssignedBusyEvent) |
|
| AssignedHelpEvent | public | Reference to a help event handler assigned to the Viewer. (Implements IGIS_Viewer.AssignedHelpEvent) |
|
| AttachLayer | public | Attach layer to the viewer by re-parenting. (Implements IGIS_Viewer.AttachLayer) |
|
| BeginPaintInternal | public | Notify viewer about entering of a paint mode. (Implements IGIS_Viewer.BeginPaintInternal) |
|
| 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. (Implements IGIS_Viewer.ChangeHash) |
|
| Close | public | Close a project. (Implements IGIS_Viewer.Close) |
|
| ControlAutoCenterViewport | public | Move the screen origin of the map by delta values. (Implements IGIS_ViewerParent.ControlAutoCenterViewport) |
|
| ControlCanvasHeight | public | Get canvas height. (Implements IGIS_ViewerParent.ControlCanvasHeight) |
|
| ControlCanvasScale | public | Get canvas scale. (Implements IGIS_ViewerParent.ControlCanvasScale) |
|
| ControlCanvasWidth | public | Get canvas width. (Implements IGIS_ViewerParent.ControlCanvasWidth) |
|
| ControlClose | public | Notify the control that the map is going to be closed. (Implements IGIS_ViewerParent.ControlClose) |
|
| ControlDrawTexture(TObject; TGIS_Extent; Integer) | public | Draw texture. (Implements IGIS_ViewerParent.ControlDrawTexture) |
|
| ControlDrawTexture(TObject; TGIS_LayerAbstract; TGIS_Extent; Integer) | public | Draw texture. (Implements IGIS_ViewerParent.ControlDrawTexture) |
|
| ControlExtentChanged | public | Notify the control that the map extent has changed. (Implements IGIS_ViewerParent.ControlExtentChanged) |
|
| ControlFlash | public | Do flash. (Implements IGIS_ViewerParent.ControlFlash) |
|
| ControlHourglassHide | public | Hide the hourglass cursor. (Implements IGIS_ViewerParent.ControlHourglassHide) |
|
| ControlHourglassShake | public | Shake the hourglass cursor. (Implements IGIS_ViewerParent.ControlHourglassShake) |
|
| ControlHourglassShow | public | Show the hourglass cursor. (Implements IGIS_ViewerParent.ControlHourglassShow) |
|
| ControlInvoke | public | Run procedure in a UI thread context. (Implements IGIS_ViewerParent.ControlInvoke) |
|
| ControlObject | public | Returns an active control as an object. (Implements IGIS_ViewerParent.ControlObject) |
|
| ControlPPI | public | Get current PPI. (Implements IGIS_ViewerParent.ControlPPI) |
|
| ControlProcessMessages | public | Do process messages. (Implements IGIS_ViewerParent.ControlProcessMessages) |
|
| ControlRaiseEditorChangeEvent | public | Raise the editor change event. (Implements IGIS_ViewerParent.ControlRaiseEditorChangeEvent) |
|
| ControlRenderer | public | Gets the renderer instance. (Implements IGIS_ViewerParent.ControlRenderer) |
|
| ControlRepaint | public | Repaint control. (Implements IGIS_ViewerParent.ControlRepaint) |
|
| ControlSet3DMode | public | Set the current 3D mode. (Implements IGIS_ViewerParent.ControlSet3DMode) |
|
| ControlSystemPPI | public | Get system PPI. (Implements IGIS_ViewerParent.ControlSystemPPI) |
|
| ControlUpdateBasemap | public | Update the basemap. (Implements IGIS_ViewerParent.ControlUpdateBasemap) |
|
| ControlUpdateEditor | public | Update the editor. (Implements IGIS_ViewerParent.ControlUpdateEditor) |
|
| ControlUpdateProgressive | public | Progressive update. (Implements IGIS_ViewerParent.ControlUpdateProgressive) |
|
| ControlUpdateSelection | public | Update the selection layer. (Implements IGIS_ViewerParent.ControlUpdateSelection) |
|
| ControlUpdateSynchronize | public | Wait for a pending paint operation to be finalized. (Implements IGIS_ViewerParent.ControlUpdateSynchronize) |
|
| ControlUpdateTopmost | public | Update the topmost layer. (Implements IGIS_ViewerParent.ControlUpdateTopmost) |
|
| ControlUpdateWholeMap | public | Update the whole map. (Implements IGIS_ViewerParent.ControlUpdateWholeMap) |
|
| Delete | public | Delete the layer identified by a name. (Implements IGIS_Viewer.Delete) |
|
| DoMouseDown | public | Executes the same operation as a mouse down event handler. | |
| DoMouseMove | public | Executes the same operation as a mouse move event handler. | |
| DoMouseUp | public | Executes the same operation as a mouse up event handler. | |
| Draw | public | Draw all layers on a current renderer. (Implements IGIS_Viewer.Draw) |
|
| EndPaintInternal | public | Notify viewer about leaving of a paint mode. (Implements IGIS_Viewer.EndPaintInternal) |
|
| 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 | Return current context object. (Implements IGIS_Viewer.GetRenderContext) |
|
| GetViewer | public | Get the internal viewer handle. (Implements IGIS_ViewerParent.GetViewer) |
|
| 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 Hourglass. (Implements IGIS_Viewer.HourglassRelease) |
|
| HourglassRestart | public | Restart hourglass timing used for progressive updates. (Implements IGIS_Viewer.HourglassRestart) |
|
| HourglassShake | public | Shake Hourglass. (Implements IGIS_Viewer.HourglassShake) |
|
| Interrupt | public | Will terminate timely 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(TGIS_Extent) | public | Invalidate an extent for a full map redraw. (Implements IGIS_Viewer.InvalidateExtent) |
|
| InvalidateExtent(TGIS_Extent; Boolean) | public | Invalidate an extent. (Implements IGIS_Viewer.InvalidateExtent) |
|
| 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) |
|
| Locate(TGIS_Point; Double) | public | Locates the shape nearest to _ptg that is within _prec. (Implements IGIS_Viewer.Locate) |
|
| Locate(TGIS_Point; Double; Boolean) | public | Locates the shape nearest to _ptg that is within _prec. (Implements IGIS_Viewer.Locate) |
|
| Locate(TPoint; Integer) | public | Locates the shape nearest to _pt 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) |
|
| 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 related to screen related. (Implements IGIS_Viewer.MapToScreenRect) |
|
| MarkModified | public | Mark viewer upon some modifications. (Implements IGIS_Viewer.MarkModified) |
|
| MoveViewport | public | Move the screen origin of the map by delta values. (Implements IGIS_Viewer.MoveViewport) |
|
| MoveViewportEx | public | Move the screen origin of the map by delta values. (Implements IGIS_Viewer.MoveViewportEx) |
|
| MustSave | public | Check if any layer or the project file was modified by editing. (Implements IGIS_Viewer.MustSave) |
|
| NotifyPaintException | public | Transform an exception into a TGIS_Viewer.OnPaintException event. (Implements IGIS_Viewer.NotifyPaintException) |
|
| NotifySubscribers | public | Send notification to subscribers. (Implements IGIS_Viewer.NotifySubscribers) |
|
| Open(String) | public | Open a project. (Implements IGIS_Viewer.Open) |
|
| Open(String; Boolean) | public | Open a project. (Implements IGIS_Viewer.Open) |
|
| OpenAsync(String; Boolean; TGIS_AsyncCallback) | public | Open a project asynchronously. (Implements IGIS_Viewer.OpenAsync) |
|
| OpenAsync(String; TGIS_AsyncCallback) | public | Open a project asynchronously. (Implements IGIS_Viewer.OpenAsync) |
|
| OpenEx(TGIS_ConfigAbstract; String) | public | Open a project file from memory. (Implements IGIS_Viewer.OpenEx) |
|
| OpenEx(TGIS_ConfigAbstract; String; Boolean) | public | Open a project file from memory. (Implements IGIS_Viewer.OpenEx) |
|
| OpenExAsync(TGIS_ConfigAbstract; String; Boolean; TGIS_AsyncCallback) | public | Open a project file from memory asynchronously. (Implements IGIS_Viewer.OpenExAsync) |
|
| OpenExAsync(TGIS_ConfigAbstract; String; TGIS_AsyncCallback) | public | Open a project file from memory asynchronously. (Implements IGIS_Viewer.OpenExAsync) |
|
| PixelsToTwips | public | Convert size from device dependent pixels to device independent Twips (1/1440 inch). (Implements IGIS_Viewer.PixelsToTwips) |
|
| public | Print the current viewer content using the default printer. (Implements IGIS_ViewerWnd.Print) |
||
| Print(IGIS_Printer) | public | Print the current viewer content using the specified printer. (Implements IGIS_ViewerWnd.Print) |
|
| PrintBmp(TGIS_Bitmap) | public | Print the current content on a bitmap. (Implements IGIS_ViewerWnd.PrintBmp) |
|
| PrintBmp(TGIS_Bitmap; Boolean) | public | Print the current content on a bitmap. (Implements IGIS_ViewerWnd.PrintBmp) |
|
| PrintBmp(VCL.Graphics.TBitmap) | public | Prints the current view to a bitmap. | |
| PrintBmp(Vcl.Graphics.TBitmap; Boolean) | public | Prints the current view to a bitmap. | |
| PrintClipboard | public | Print the current view to the clipboard. | |
| PrintClipboard(Boolean) | public | Prints the current view to the clipboard. | |
| PrintPdf(String) | public | Prints the current extent to PDF using the default page size. (Implements IGIS_Viewer.PrintPdf) |
|
| PrintPdf(String; Single; Single) | public | Prints the current extent to PDF. (Implements IGIS_Viewer.PrintPdf) |
|
| PrintPdf(TStream) | public | Prints the current extent to PDF using the default page size. (Implements IGIS_Viewer.PrintPdf) |
|
| PrintPdf(TStream; Single; Single) | public | Prints the current extent to PDF. (Implements IGIS_Viewer.PrintPdf) |
|
| RaiseBusyEvent | public | Fire Busy event of a viewer. (Implements IGIS_Viewer.RaiseBusyEvent) |
|
| RaiseHelpEvent | public | Fire the Help event of a viewer. (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) |
|
| ReParent | public | Set a new parent for the viewer. (Implements IGIS_Viewer.ReParent) |
|
| ReParentLock | public | Block reparenting. (Implements IGIS_Viewer.ReParentLock) |
|
| ReParentUnlock | public | Unblock reparenting. (Implements IGIS_Viewer.ReParentUnlock) |
|
| 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 | Compute extent (encompassing area of the extent) after the viewer rotation. (Implements IGIS_Viewer.RotatedExtent) |
|
| RotatedPoint | public | Computes the position of a point after viewer rotation. (Implements IGIS_Viewer.RotatedPoint) |
|
| RotatedPoint3D | public | Compute position of the 3D point after the 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) |
|
| SaveProject(Boolean) | public | Save the current project. (Implements IGIS_Viewer.SaveProject) |
|
| SaveProjectAs(String) | public | Save the current project under a new name. (Implements IGIS_Viewer.SaveProjectAs) |
|
| SaveProjectAs(String; Boolean) | public | Save the current project under a new name. (Implements IGIS_Viewer.SaveProjectAs) |
|
| SaveProjectAsEx(TGIS_ConfigAbstract; String) | public | Save the current project under a new name. (Implements IGIS_Viewer.SaveProjectAsEx) |
|
| SaveProjectAsEx(TGIS_ConfigAbstract; String; Boolean) | public | Save the current project under a new name. (Implements IGIS_Viewer.SaveProjectAsEx) |
|
| 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 related to map related. (Implements IGIS_Viewer.ScreenToMapRect) |
|
| SetCSByEPSG | public | Sets the coordinate system from an EPSG code. (Implements IGIS_Viewer.SetCSByEPSG) |
|
| SetCSByWKT | public | Sets the coordinate system from a WKT string (GEOGCS or PROJCS). (Implements IGIS_Viewer.SetCSByWKT) |
|
| SetCSByWKTFile | public | Sets the coordinate system from a file containing a WKT string (GEOGCS or PROJCS). (Implements IGIS_Viewer.SetCSByWKTFile) |
|
| SetViewer | public | Set the internal viewer handle. (Implements IGIS_ViewerParent.SetViewer) |
|
| SetViewport | public | Sets the viewport to a given position. (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) |
|
| TapDouble | protected | Executes the action associated with a double tap gesture. | |
| TapLong | protected | Executes the action associated with a long tap gesture. | |
| TapSingle | protected | Executes the action associated with a single tap gesture. | |
| 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 | Convert the size from to device independent Twips (1/1440 inch) to device points. (Implements IGIS_Viewer.TwipsToPoints) |
|
| Unlock | public | Unlock the viewer and redraw it. (Implements IGIS_Viewer.Unlock) |
|
| Unlock(Boolean) | public | Unlock the viewer and optionally redraw it. (Implements IGIS_Viewer.Unlock) |
|
| UnrotatedExtent | public | Compute original extent of the rotated extent. (Implements IGIS_Viewer.UnrotatedExtent) |
|
| UnrotatedPoint | public | Compute original position of the rotated point. (Implements IGIS_Viewer.UnrotatedPoint) |
|
| UnrotatedPoint3D | public | Compute original position of the rotated 3D point. (Implements IGIS_Viewer.UnrotatedPoint3D) |
|
| UnrotatedPoint3D_ref | public | Compute original position of the rotated 3D point. (Implements IGIS_Viewer.UnrotatedPoint3D_ref) |
|
| UnSubscribe | public | Remove provided control from the notification subscription list. (Implements IGIS_Viewer.UnSubscribe) |
|
| 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) |
|
Properties
Inherited
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| Align | published | Standard VCL property. | |
| Anchors | published | Standard VCL property. | |
| AutoCenter | published | If True, then the screen will be centered on click, edit, etc. | |
| AutoStyle | published | If True, layers added to the viewer will have a unique style applied; Default is False. (Implements IGIS_Viewer.AutoStyle) |
|
| BigExtent | public | Map extent. (Implements IGIS_Viewer.BigExtent) |
|
| BigExtentMargin | published | Map extent margin. (Implements IGIS_Viewer.BigExtentMargin) |
|
| BorderStyle | published | Border visibility. | |
| BusyLevel | public | Level of current busy state. (Implements IGIS_Viewer.BusyLevel) |
|
| BusyText | public | Text related to 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 Viewer will be centered during Zoom. (Implements IGIS_Viewer.CenterPtg) |
|
| Color | published | Background color. (Implements IGIS_Viewer.Color) |
|
| Copyright | public | Legal notice and product version. (Implements IGIS_Viewer.Copyright) |
|
| CS | public | Coordinate System assigned to the viewer. (Implements IGIS_Viewer.CS) |
|
| Ctl3D | published | Standard VCL property. | |
| CursorFor3DSelect | published | Cursor for TGIS_Viewer3DMode.Select. | |
| CursorForCameraPosition | published | Cursor for TGIS_Viewer3DMode.CameraPosition. | |
| CursorForCameraRotation | published | Cursor for TGIS_Viewer3DMode.CameraRotation. | |
| CursorForCameraXY | published | Cursor for TGIS_Viewer3DMode.CameraXY. | |
| CursorForCameraXYZ | published | Cursor for TGIS_Viewer3DMode.CameraXYZ. | |
| CursorForCameraZoom | published | Cursor for TGIS_Viewer3DMode.Zoom. | |
| CursorForDrag | published | Cursor for TGIS_ViewerMode.Drag mode (dragging a map within the component window). | |
| CursorForEdit | published | Cursor for TGIS_ViewerMode.Edit mode (editing a feature on a map). | |
| CursorForSelect | published | Cursor for TGIS_ViewerMode.Select mode (selecting items on a map). | |
| CursorForSunPosition | published | Cursor for TGIS_Viewer3DMode.SunPosition. | |
| CursorForUserDefined | published | Cursor for TGIS_ViewerMode.UserDefined mode. | |
| CursorForZoom | published | Cursor for TGIS_ViewerMode.Zoom mode (zooming a map using a rubber-band rectangle). | |
| CursorForZoomEx | published | Cursor for TGIS_ViewerMode.ZoomEx mode (zooming a map interactively). | |
| CustomData | public | List of custom user-defined data saved to and restored from config/project files. (Implements IGIS_Viewer.CustomData) |
|
| CustomPPI | published | Custom resolution in pixels-per-inch. (Implements IGIS_Viewer.CustomPPI) |
|
| DelayedUpdate | published | Delayed update threshold in milliseconds. (Implements IGIS_Viewer.DelayedUpdate) |
|
| DragCursor | published | Standard VCL property. | |
| DragKind | published | Standard VCL property. | |
| DragMode | published | Standard VCL property. | |
| Editor | public | Editor context. (Implements IGIS_Viewer.Editor) |
|
| Enabled | published | Standard VCL property. | |
| Extent | public | Map extent. (Implements IGIS_Viewer.Extent) |
|
| FileCopyrights | public | List of copyrights. (Implements IGIS_Viewer.FileCopyrights) |
|
| FontScale | published | 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) |
|
| Graticule | public | Graticule object. | |
| HelpContext | published | Standard VCL property. | |
| Hierarchy | public | Hierarchy list. (Implements IGIS_Viewer.Hierarchy) |
|
| Hint | published | Standard VCL property. | |
| IncrementalPaint | published | Is partial drawing to screen done in incremental mode? (Implements IGIS_Viewer.IncrementalPaint) |
|
| InPaint | public | True if Viewer is busy in Paint procedure. (Implements IGIS_Viewer.InPaint) |
|
| IsBusy | public | Indicates whether the viewer is currently painting. (Implements IGIS_Viewer.IsBusy) |
|
| IsEmpty | public | True if Viewer is empty (no layers). (Implements IGIS_Viewer.IsEmpty) |
|
| IsLocked | public | True if Viewer is in locked state Lock. (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 | published | 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 zoom level for a viewer. (Implements IGIS_Viewer.Level) |
|
| MasterViewer | public | Master Viewer reference. (Implements IGIS_Viewer.MasterViewer) |
|
| MinZoomSize | published | Minimal size of the zooming rectangle. | |
| Mode | published | Mode of reaction to mouse events. | |
| ModeMouseButton | published | Active mouse button for Mode operations such as dragging and selecting. | |
| MultiUserMode | published | Multiuser mode. (Implements IGIS_Viewer.MultiUserMode) |
|
| OverlappedExtentMargin | public | Overlapped extent margin (in pixels). (Implements IGIS_Viewer.OverlappedExtentMargin) |
|
| ParentColor | published | Standard VCL property. | |
| ParentCtl3D | published | Standard VCL property. | |
| ParentShowHint | published | Standard VCL property. | |
| PopupMenu | published | Standard VCL property. | |
| PPI | public | Rendering resolution in pixels per inch. (Implements IGIS_Viewer.PPI) |
|
| ProgressiveUpdate | published | 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 | published | 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 | Setting up and reading the scale factor. (Implements IGIS_Viewer.Scale) |
|
| ScaleAsFloat | public | Setting up and reading the scale factor. (Implements IGIS_Viewer.ScaleAsFloat) |
|
| ScaleAsText | public | Setting up and reading the scale factor as text in format '1:10000'. (Implements IGIS_Viewer.ScaleAsText) |
|
| SelectionColor | published | Color used for selecting object. | |
| SelectionGisColor | public | Color used for selecting object. (Implements IGIS_Viewer.SelectionGisColor) |
|
| SelectionOutlineOnly | published | If True, polygons are marked only with an outline and not filled. (Implements IGIS_Viewer.SelectionOutlineOnly) |
|
| SelectionTransparency | published | Transparency value for selection; if 100 SelectionGisColor will not be transparent. (Implements IGIS_Viewer.SelectionTransparency) |
|
| SelectionWidth | published | Outline width of selection area (>0 in twips, <0 in pixels). (Implements IGIS_Viewer.SelectionWidth) |
|
| StyleElements | published | See documentation for TCustomControl in Delphi help. | |
| SystemPPI | public | System resolution in pixels-per-inch. (Implements IGIS_Viewer.SystemPPI) |
|
| TabOrder | published | Standard VCL property. | |
| TabStop | published | Standard VCL property. | |
| TemporaryScaleInternal | public | Used to force rendering in a different scale then actual. (Implements IGIS_Viewer.TemporaryScaleInternal) |
|
| TemporaryVisibleExtent | public | Used to force rendering labels while drawing with tiles. (Implements IGIS_Viewer.TemporaryVisibleExtent) |
|
| TiledPaint | published | Is partial drawing to screen done in tiled mode? (Implements IGIS_Viewer.TiledPaint) |
|
| UponDestroy | public | True if viewer is upon destruction so some operations (like screen updates) should not be performed (Implements IGIS_Viewer.UponDestroy) |
|
| UseAnimations | published | True if zoom animations are allowed. (Implements IGIS_Viewer.UseAnimations) |
|
| UseRTree | published | True if RTree will be used by default upon creation of any layer. (Implements IGIS_Viewer.UseRTree) |
|
| View3D | public | Indicates whether the viewer is operating in 3D mode. | |
| Viewer3D | public | 3D viewer object, or nil when 3D mode is disabled. | |
| 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 | Setting an upper left corner position of the components window within the map. (Implements IGIS_Viewer.Viewport) |
|
| Visible | published | Standard VCL property. | |
| VisibleExtent | public | Extent of the map visible in the window. (Implements IGIS_Viewer.VisibleExtent) |
|
| Zoom | public | Setting up and reading the related zoom factor. (Implements IGIS_Viewer.Zoom) |
|
| ZoomEx | public | Setting up and reading the absolute zoom factor. (Implements IGIS_Viewer.ZoomEx) |
|
Events
Inherited
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| AfterPaintEvent | published | AfterPaint event. | |
| AfterPaintRendererEvent | published | AfterPaintRenderer event. | |
| AfterProjectOpenEvent | published | AfterProjectOpen event. | |
| AfterUpdateEvent | published | AfterUpdate event. | |
| BeforePaintEvent | published | BeforePaint event. | |
| BeforePaintRendererEvent | published | BeforePaintRenderer event. | |
| BeforeUpdateEvent | published | BeforeUpdate event. | |
| BusyEvent | published | Busy event fired regularly during long-running operations. | |
| EditorChangeEvent | published | Will be fired after any change made by the editor. | |
| EditorPointChangeEvent | published | EditorPointChange event. | |
| EditorPointMoveEvent | published | EditorPointMove event. | |
| EditorSnapPointEvent | published | EditorSnapPoint event. | |
| ExtentChangeEvent | published | ExtentChange event. | |
| HelpEvent | published | Help event. | |
| LayerAddEvent | published | LayerAdd event. | |
| LayerDeleteEvent | published | LayerDelete event. | |
| ModeChangeEvent | published | Will be fired when the viewer mode changes. | |
| OnClick | published | Standard VCL event. | |
| OnContextPopup | published | Standard VCL event. | |
| OnDblClick | published | Standard VCL event. | |
| OnDragDrop | published | Standard VCL event. | |
| OnDragOver | published | Standard VCL event. | |
| OnEndDrag | published | Standard VCL event. | |
| OnEnter | published | Standard VCL event. | |
| OnExit | published | Standard VCL event. | |
| OnGesture | published | Standard VCL event. | |
| OnKeyDown | published | Standard VCL event. | |
| OnKeyPress | published | Standard VCL event. | |
| OnKeyUp | published | Standard VCL event. | |
| OnMouseDown | published | Standard VCL event. | |
| OnMouseMove | published | Standard VCL event. | |
| OnMouseUp | published | Standard VCL event. | |
| OnMouseWheel | published | Standard VCL event. | |
| OnMouseWheelDown | published | Standard VCL event. | |
| OnMouseWheelUp | published | Standard VCL event. | |
| OnResize | published | Standard VCL event. | |
| OnStartDrag | published | Standard VCL event. | |
| PaintExceptionEvent | published | PaintException event. | |
| PaintExtraEvent | published | PaintExtra event. | |
| PasswordEvent | published | Password event. | |
| ProjectCloseEvent | published | ProjectClose event. | |
| ProjectOpenEvent | published | ProjectOpen event. | |
| TapDoubleEvent | published | TapDouble event. | |
| TapLongEvent | published | TapLong event. | |
| TapSimpleEvent | published | TapSimple event. | |
| UpdateEvent | published | Update event. | |
| VisibleExtentChangeEvent | published | VisibleExtentChange event. | |
| ZoomChangeEvent | published | ZoomChange event. | |
Remarks
PURPOSE: Provides the primary on-window 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 3D viewer 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. |
Available metadata keys:
| Metadata | Values | Default | Description |
|---|---|---|---|
| TGIS_ViewerWnd.Mode.Drag.AllGestures | TRUE FALSE | FALSE | If true then all gestures (pan and zoom) are enabled. If false then pan gesture simulates the mouse. |
| TGIS_ViewerWnd.Mode.Zoom.AllGestures | TRUE FALSE | FALSE | If true then all gestures (pan and zoom) are enabled. If false then pan gesture simulates the mouse. |
| TGIS_ViewerWnd.Mode.Select.AllGestures | TRUE FALSE | TRUE | If true then all gestures (pan and zoom) are enabled. If false then no gestures are enabled. |
| TGIS_ViewerWnd.Mode.Edit.AllGestures | TRUE FALSE | TRUE | If true then zoom gesture is enabled. If false then zoom gesture is disabled. |
| TGIS_ViewerWnd.Viewer3D.Mode.CameraPosition.AllGestures | TRUE FALSE | FALSE | If true then zoom gesture is enabled. If false then zoom gesture is disabled. |
| TGIS_ViewerWnd.Viewer3D.Mode.CameraXY.AllGestures | TRUE FALSE | FALSE | If true then zoom gesture is enabled. If false then zoom gesture is disabled. |
| TGIS_ViewerWnd.Viewer3D.Mode.CameraXYZ.AllGestures | TRUE FALSE | FALSE | If true then zoom gesture is enabled. If false then zoom gesture is disabled. |
| TGIS_ViewerWnd.Viewer3D.Mode.CameraRotation.AllGestures | TRUE FALSE | FALSE | If true then zoom gesture is enabled. If false then zoom gesture is disabled. |
| TGIS_ViewerWnd.Viewer3D.Mode.SunPosition.AllGestures | TRUE FALSE | FALSE | If true then zoom gesture is enabled. If false then zoom gesture is disabled. |
| TGIS_ViewerWnd.Viewer3D.Mode.Zoom.AllGestures | TRUE FALSE | FALSE | If true then all gestures (pan and zoom) are enabled. If false then pan gesture simulates the mouse. |
| TGIS_ViewerWnd.Viewer3D.Mode.Select.AllGestures | TRUE FALSE | TRUE | If true then all gestures (pan and zoom) are enabled. If false then no gestures are enabled. |
2026/07/11 00:51