api:dk11:delphi:vcl.gisviewerbmp.tgis_viewerbmp
Table of Contents
TGIS_ViewerBmp class
DK for Delphi | VCL.GisViewerBmp.TGIS_ViewerBmp | Classes | Constructors | Methods | Properties | Events
Bitmap-based GIS viewer component for rendering map content to a bitmap instead of a windowed control.
Available also on: Delphi FMX | .NET WinForms | Java | ActiveX | Python.
Syntax
// Delphi type TGIS_ViewerBmp = class( TComponent, IGIS_Viewer, IGIS_ViewerParent, IGIS_ViewerBmp ) end;
// C++ Builder class PASCALIMPLEMENTATION TGIS_ViewerBmp : public TComponent { };
Inheritance
→ TComponent
Implements
Constructors
Inherited
Overrides
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| Create | public | Creates a bitmap viewer with a default bitmap size of 320 by 240 pixels. | |
| Create(Integer; Integer) | public | Creates a bitmap viewer using the specified bitmap dimensions. | |
| Create(Integer; Integer; TGIS_RendererAbstract) | public | Creates a bitmap viewer using the specified bitmap dimensions and renderer. | |
| Create(TBitmap) | public | Creates a bitmap viewer that uses an existing VCL bitmap as the drawing target. | |
| Create(TBitmap; TGIS_RendererAbstract) | public | Creates a bitmap viewer that uses an existing VCL bitmap and renderer. | |
| Create(TGIS_Bitmap) | public | Creates a bitmap viewer that uses an existing GIS bitmap as the drawing target. | |
| Create(TGIS_Bitmap; TGIS_RendererAbstract) | public | Creates a bitmap viewer that uses an existing GIS bitmap and renderer. | |
| Destroy | public | Destroys the bitmap viewer and releases owned bitmap and renderer resources. | |
Methods
Inherited
Overrides
Protected
Private
| 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) |
|
| 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 the viewer that painting is starting. (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 used to verify whether the layer order, parameters, or related viewer state has been modified. (Implements IGIS_Viewer.ChangeHash) |
|
| Clear | public | Clear the bitmap and prepare the background color and picture. (Implements IGIS_ViewerBmp.Clear) |
|
| Close | public | Close the current project. (Implements IGIS_Viewer.Close) |
|
| ControlAutoCenterViewport | public | Move the screen origin of the map by delta values. (Implements IGIS_ViewerParent.ControlAutoCenterViewport) |
|
| ControlCanvasHeight | public | Gets the canvas height. (Implements IGIS_ViewerParent.ControlCanvasHeight) |
|
| ControlCanvasScale | public | Gets the canvas scale. (Implements IGIS_ViewerParent.ControlCanvasScale) |
|
| ControlCanvasWidth | public | Gets the canvas width. (Implements IGIS_ViewerParent.ControlCanvasWidth) |
|
| ControlClose | public | Notifies the control that the map is going to be closed. (Implements IGIS_ViewerParent.ControlClose) |
|
| ControlDrawTexture(TObject; TGIS_Extent; Integer) | public | Draws a texture. (Implements IGIS_ViewerParent.ControlDrawTexture) |
|
| ControlDrawTexture(TObject; TGIS_LayerAbstract; TGIS_Extent; Integer) | public | Draws a texture. (Implements IGIS_ViewerParent.ControlDrawTexture) |
|
| ControlExtentChanged | public | Notify the control that the map extent has changed. (Implements IGIS_ViewerParent.ControlExtentChanged) |
|
| ControlFlash | public | Flashes the control. (Implements IGIS_ViewerParent.ControlFlash) |
|
| ControlHourglassHide | public | Hides the hourglass cursor. (Implements IGIS_ViewerParent.ControlHourglassHide) |
|
| ControlHourglassShake | public | Shakes the hourglass cursor. (Implements IGIS_ViewerParent.ControlHourglassShake) |
|
| ControlHourglassShow | public | Shows the hourglass cursor. (Implements IGIS_ViewerParent.ControlHourglassShow) |
|
| ControlInvoke | public | Runs a procedure in the UI thread context. (Implements IGIS_ViewerParent.ControlInvoke) |
|
| ControlObject | public | Returns the active control as an object. (Implements IGIS_ViewerParent.ControlObject) |
|
| ControlPPI | public | Gets the current PPI. (Implements IGIS_ViewerParent.ControlPPI) |
|
| ControlProcessMessages | public | Processes pending 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 | Repaints the control. (Implements IGIS_ViewerParent.ControlRepaint) |
|
| ControlSet3DMode | public | Set the current 3D mode. (Implements IGIS_ViewerParent.ControlSet3DMode) |
|
| ControlSystemPPI | public | Gets the system PPI. (Implements IGIS_ViewerParent.ControlSystemPPI) |
|
| ControlUpdateBasemap | public | Updates the basemap. (Implements IGIS_ViewerParent.ControlUpdateBasemap) |
|
| ControlUpdateEditor | public | Updates the editor. (Implements IGIS_ViewerParent.ControlUpdateEditor) |
|
| ControlUpdateProgressive | public | Performs a progressive update. (Implements IGIS_ViewerParent.ControlUpdateProgressive) |
|
| ControlUpdateSelection | public | Updates the selection layer. (Implements IGIS_ViewerParent.ControlUpdateSelection) |
|
| ControlUpdateSynchronize | public | Wait for a pending paint operation to be finalized. (Implements IGIS_ViewerParent.ControlUpdateSynchronize) |
|
| ControlUpdateTopmost | public | Updates the topmost layer. (Implements IGIS_ViewerParent.ControlUpdateTopmost) |
|
| ControlUpdateWholeMap | public | Updates the whole map. (Implements IGIS_ViewerParent.ControlUpdateWholeMap) |
|
| Delete | public | Delete the layer identified by a name. (Implements IGIS_Viewer.Delete) |
|
| Draw | public | Draw the current extent on the bitmap. (Implements IGIS_ViewerBmp.Draw) |
|
| Draw(TObject; TGIS_DrawMode) | public | Draw all layers on the current renderer. (Implements IGIS_Viewer.Draw) |
|
| DrawAsync | public | ||
| EndPaintInternal | public | Notify the viewer that painting has finished. (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) |
|
| 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. (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 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(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 coordinates to screen coordinates. (Implements IGIS_Viewer.MapToScreenRect) |
|
| MarkModified | public | Mark viewer upon some modifications. (Implements IGIS_Viewer.MarkModified) |
|
| 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) |
|
| NotifyPaintException | public | Transform an exception into a TGIS_Viewer.OnPaintException event. (Implements IGIS_Viewer.NotifyPaintException) |
|
| NotifySubscribers | public | Send a notification to subscribed controls. (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 | Converts a size from device-dependent pixels to device-independent twips (1/1440 inch) to keep the map device independent. (Implements IGIS_Viewer.PixelsToTwips) |
|
| PrintBmp(VCL.Graphics.TBitmap) | public | Renders the current map view to a VCL bitmap. | |
| PrintBmp(VCL.Graphics.TBitmap; Boolean) | public | Renders the current map view to a VCL bitmap. | |
| PrintPdf(String) | public | Prints the current extent to PDF using the default page size and default ppi. (Implements IGIS_Viewer.PrintPdf) |
|
| PrintPdf(String; Single; Single) | public | Prints the current extent to PDF using the specified page size and default PPI. (Implements IGIS_Viewer.PrintPdf) |
|
| PrintPdf(String; Single; Single; Integer) | public | Prints the current extent to PDF using the specified page size and custom PPI. (Implements IGIS_Viewer.PrintPdf) |
|
| PrintPdf(TStream) | public | Prints the current extent to PDF using the default page size and default PPI. (Implements IGIS_Viewer.PrintPdf) |
|
| PrintPdf(TStream; Single; Single) | public | Prints the current extent to PDF using the specified page size and default PPI. (Implements IGIS_Viewer.PrintPdf) |
|
| PrintPdf(TStream; Single; Single; Integer) | public | Prints the current extent to PDF using the specified page size and custom PPI. (Implements IGIS_Viewer.PrintPdf) |
|
| PrintSvg(String) | public | Prints the current extent to SVG (Scalable Vector Graphics) using the parent view box size and parent PPI. (Implements IGIS_Viewer.PrintSvg) |
|
| PrintSvg(String; Single; Single; Integer) | public | Prints the current extent to SVG (Scalable Vector Graphics). (Implements IGIS_Viewer.PrintSvg) |
|
| PrintSvg(TStream) | public | Prints the current extent to SVG (Scalable Vector Graphics) using the parent view box size and parent PPI. (Implements IGIS_Viewer.PrintSvg) |
|
| PrintSvg(TStream; Single; Single; Integer) | public | Prints the current extent to SVG (Scalable Vector Graphics). (Implements IGIS_Viewer.PrintSvg) |
|
| 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) |
|
| 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 | 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) |
|
| 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 coordinates to map coordinates. (Implements IGIS_Viewer.ScreenToMapRect) |
|
| ScrollDn | public | Scroll down. (Implements IGIS_ViewerBmp.ScrollDn) |
|
| ScrollLeft | public | Scroll left. (Implements IGIS_ViewerBmp.ScrollLeft) |
|
| ScrollPgDn | public | Scroll one page down. (Implements IGIS_ViewerBmp.ScrollPgDn) |
|
| ScrollPgLeft | public | Scroll one page left. (Implements IGIS_ViewerBmp.ScrollPgLeft) |
|
| ScrollPgRight | public | Scroll one page right. (Implements IGIS_ViewerBmp.ScrollPgRight) |
|
| ScrollPgUp | public | Scroll one page up. (Implements IGIS_ViewerBmp.ScrollPgUp) |
|
| ScrollRight | public | Scroll right. (Implements IGIS_ViewerBmp.ScrollRight) |
|
| ScrollUp | public | Scroll up. (Implements IGIS_ViewerBmp.ScrollUp) |
|
| 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) |
|
| SetRenderer | public | Set the underlying renderer as a native, platform dependent object. (Implements IGIS_ViewerBmp.SetRenderer) |
|
| SetSize | public | Set a new bitmap size. (Implements IGIS_ViewerBmp.SetSize) |
|
| SetViewer | public | Set the internal viewer handle. (Implements IGIS_ViewerParent.SetViewer) |
|
| 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) |
|
| 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(Boolean) | public | Unlock the viewer and optionally redraw it. (Implements IGIS_Viewer.Unlock) |
|
| 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) |
|
| 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) |
|
| ZoomIn | public | Zoom in slightly. (Implements IGIS_ViewerBmp.ZoomIn) |
|
| ZoomOut | public | Zoom out slightly. (Implements IGIS_ViewerBmp.ZoomOut) |
|
Properties
Inherited
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| 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) |
|
| Bitmap | public | Underlying bitmap as a native, platform dependent object. (Implements IGIS_ViewerBmp.Bitmap) |
|
| 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. (Implements IGIS_Viewer.Color) |
|
| ContextInternal | public | Internal platform-specific paint context object used during bitmap rendering operations. | |
| Copyright | public | Legal notice and product version. (Implements IGIS_Viewer.Copyright) |
|
| CS | public | Coordinate system assigned to the viewer. (Implements IGIS_Viewer.CS) |
|
| 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. (Inherited from IGIS_Viewer) |
|
| DrawBasemapOnly | public | If True, draws only the base map without selection, labels, charts, editor overlays, or paint events. | |
| 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) |
|
| GIS_Bitmap | public | Underlying bitmap. (Implements IGIS_ViewerBmp.GIS_Bitmap) |
|
| Height | public | Underlying bitmap height. (Implements IGIS_ViewerBmp.Height) |
|
| 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) |
|
| KeepContextInternal | public | Internal flag controlling whether the paint context is preserved between rendering operations. | |
| KeepScale | public | True if a viewer should maintain scale upon resize. (Inherited from IGIS_Viewer) |
|
| 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) |
|
| 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. (Inherited from IGIS_Viewer) |
|
| 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 to draw map content to the bitmap. | |
| 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) |
|
| 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) |
|
| TilePicture | public | ||
| TileRect | public | Location of the bitmap over the entire rendered area (in pixels). (Implements IGIS_ViewerBmp.TileRect) |
|
| 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. (Inherited from IGIS_Viewer) |
|
| UseRTree | public | True if an RTree spatial index will be used by default when a layer is created. (Implements IGIS_Viewer.UseRTree) |
|
| 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) |
|
| Width | public | Underlying bitmap width. (Implements IGIS_ViewerBmp.Width) |
|
| 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) |
|
Events
Inherited
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| AfterPaintEvent | published | Fired after any Draw operation using the current paint context. | |
| AfterPaintRendererEvent | published | Fired after any Draw operation using the current renderer. | |
| BeforePaintEvent | published | Fired before any Draw operation using the current paint context. | |
| BeforePaintRendererEvent | published | Fired before any Draw operation using the current renderer. | |
| BusyEvent | published | Fired regularly during long-running operations to report progress. | |
| ExtentChangeEvent | published | Fired when the viewer Extent property changes. | |
| PaintExtraEvent | published | Fired after the renderer PaintExtra operation completes. | |
| VisibleExtentChangeEvent | published | Fired before BeforePaintEvent when VisibleExtent changes directly. | |
| ZoomChangeEvent | published | Fired before BeforePaintEvent when the viewer Zoom property changes. | |
Remarks
PURPOSE: Provides map presentation, navigation, coordinate conversion, and layer management for off-screen rendering scenarios such as printing, export, image generation, and server-side map production.
BEHAVIOR: Wraps core viewer functionality around a TGIS_Bitmap or VCL TBitmap and uses a renderer to draw the current VisibleExtent. This class is intended for bitmap output only; for window output use TGIS_ViewerWnd.
USAGE: Create an off-screen viewer, open data, and render the current map view to a bitmap.
viewer = TGIS_ViewerBmp(800, 600) viewer.Open(path) viewer.FullExtent() viewer.Draw() viewer.PrintBmp(bitmap, True)
CONSTRAINTS: KeepScale is always False, DelayedUpdate is always 0, ProgressiveUpdate is always 0, and UseAnimations is always False on TGIS_ViewerBmp. TiledPaint has no meaning on TGIS_ViewerBmp.
2026/09/20 23:49