api:dk11:delphi:gisinterfaces.igis_viewer
Table of Contents
IGIS_Viewer interface
DK for Delphi | GisInterfaces.IGIS_Viewer | Interfaces | Methods | Properties
Common API for viewer operations. To be shared across platforms.
Syntax
// Delphi type IGIS_Viewer = interface( IInterface ) ['{1EE91EC2-77AA-4131-8B76-8EE254CC74D7}'] end;
// C++ Builder __interface INTERFACE_UUID("{1EE91EC2-77AA-4131-8B76-8EE254CC74D7}") IGIS_Viewer : public IInterface { };
Implements
IInterface
Methods
Inherited
Overrides
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| Add | public | Add a layer to the Viewer. | |
| AddHierarchy | public | Read hierarchy information and build hierarchy groups with layers. | |
| AssignedBusyEvent | public | Reference to a busy event handler assigned to the Viewer. | |
| AssignedHelpEvent | public | Reference to a help event handler assigned to the Viewer. | |
| AttachLayer | public | Attach layer to the viewer by re-parenting. | |
| BeginPaintInternal | public | Notify the viewer that painting is starting. | |
| BusyPrepare | public | Prepare BusyEvent for a long-running operation. | |
| BusyRelease | public | Release the busy state. | |
| BusyShake | public | Update the busy state. | |
| CenterViewport | public | Sets the viewport so that _ptg becomes visible at the center of the screen. | |
| ChangeHash | public | Change hash used to verify whether the layer order, parameters, or related viewer state has been modified. | |
| Close | public | Close the current project. | |
| Delete | public | Delete the layer identified by a name. | |
| Draw | public | Draw all layers on the current renderer. | |
| EndPaintInternal | public | Notify the viewer that painting has finished. | |
| FullExtent | public | Calculate the screen origin, zoom, and viewport to place the whole map in the window. | |
| FullExtentZoom | public | Calculates the zoom that fits the whole map inside the window. | |
| Get | public | Retrieve the layer identified by name. | |
| GetGrid | public | Fill the provided _grid array with values for _extent. | |
| GetRenderContext | public | Returns the current rendering context object. | |
| HourglassActive | public | Test whether the hourglass is active. | |
| HourglassPrepare | public | Prepare the hourglass cursor for a long operation. | |
| HourglassRelease | public | Release the hourglass state. | |
| HourglassRestart | public | Restart hourglass timing used for progressive updates. | |
| HourglassShake | public | Refresh the hourglass state. | |
| Interrupt | public | Request interruption of a long-running operation as soon as possible. | |
| Interrupted | public | Test whether a pending operation must be aborted. | |
| InvalidateBasemap | public | Invalidate only basemap layers. | |
| InvalidateEditor | public | Invalidate the editor to mark the viewer for redraw after an editor change. | |
| InvalidateExtent(TGIS_Extent) | public | Invalidate an extent for a full map redraw. | |
| InvalidateExtent(TGIS_Extent; Boolean) | public | Invalidate an extent. | |
| InvalidateSelection | public | Invalidate the selection to mark the viewer for redraw after a selection change. | |
| InvalidateTopmost | public | Invalidate only topmost layers. | |
| InvalidateWholeMap | public | Invalidate whole map. | |
| Locate(TGIS_Point; Double) | public | Locates the shape nearest to _ptg that is within _prec. | |
| Locate(TGIS_Point; Double; Boolean) | public | Locates the shape nearest to _ptg that is within _prec. | |
| Locate(TPoint; Integer) | public | Locates the shape nearest to _pt that is within _prec. | |
| LocateEx | public | Locates shapes on layers near _ptg and returns the best candidate from each layer that is within _prec. | |
| Lock | public | Lock the viewer. | |
| MapToScreen | public | Converts point coordinates from map coordinates to screen coordinates. | |
| MapToScreen3D | public | Converts 3D point coordinates from map coordinates to screen coordinates. | |
| MapToScreenEx | public | Converts point coordinates from map coordinates to screen coordinates, returning the result as TGIS_Point. | |
| MapToScreenRect | public | Converts rectangle coordinates from map coordinates to screen coordinates. | |
| MarkModified | public | Mark viewer upon some modifications. | |
| MoveViewport | public | Moves the map viewport by delta values in screen coordinates. | |
| MoveViewportEx | public | Moves the map viewport by delta values in map coordinates. | |
| MustSave | public | Check if any layer or the project file was modified by editing. | |
| NotifyPaintException | public | Transform an exception into a TGIS_Viewer.OnPaintException event. | |
| NotifySubscribers | public | Send a notification to subscribed controls. | |
| Open(String) | public | Open a project. | |
| Open(String; Boolean) | public | Open a project. | |
| OpenAsync(String; Boolean; TGIS_AsyncCallback) | public | Open a project asynchronously. | |
| OpenAsync(String; TGIS_AsyncCallback) | public | Open a project asynchronously. | |
| OpenEx(TGIS_ConfigAbstract; String) | public | Open a project file from memory. | |
| OpenEx(TGIS_ConfigAbstract; String; Boolean) | public | Open a project file from memory. | |
| OpenExAsync(TGIS_ConfigAbstract; String; Boolean; TGIS_AsyncCallback) | public | Open a project file from memory asynchronously. | |
| OpenExAsync(TGIS_ConfigAbstract; String; TGIS_AsyncCallback) | public | Open a project file from memory asynchronously. | |
| PixelsToTwips | public | Converts a size from device-dependent pixels to device-independent twips (1/1440 inch) to keep the map device independent. | |
| PrintPdf(String) | public | Prints the current extent to PDF using the default page size. | |
| PrintPdf(String; Single; Single) | public | Prints the current extent to PDF. | |
| PrintPdf(TStream) | public | Prints the current extent to PDF using the default page size. | |
| PrintPdf(TStream; Single; Single) | public | Prints the current extent to PDF. | |
| PrintSvg(String) | public | Prints the current extent to SVG (Scalable Vector Graphics) using the parent view box size and parent PPI. | |
| PrintSvg(String; Single; Single; Integer) | public | Prints the current extent to SVG (Scalable Vector Graphics). | |
| PrintSvg(TStream) | public | Prints the current extent to SVG (Scalable Vector Graphics) using the parent view box size and parent PPI. | |
| PrintSvg(TStream; Single; Single; Integer) | public | Prints the current extent to SVG (Scalable Vector Graphics). | |
| RaiseBusyEvent | public | Fire the viewer busy event. | |
| RaiseHelpEvent | public | Fire the viewer help event. | |
| ReadConfig | public | Read all configuration data from the project. | |
| RecalcExtent | public | Calculates a common extent. | |
| ReParent | public | Set a new parent for the viewer. | |
| ReParentLock | public | Block reparenting. | |
| ReParentUnlock | public | Unblock reparenting. | |
| Reposition | public | Reposition the map within the component window. | |
| RereadConfig | public | Reread all configuration data from the project and layer configuration files. | |
| RestorePaintState | public | Restore and free the current paint state. | |
| RevertAll | public | Revert all layers to a file-based original. | |
| RotatedExtent | public | Computes the extent that encompasses an extent after viewer rotation. | |
| RotatedPoint | public | Computes the position of a point after viewer rotation. | |
| RotatedPoint3D | public | Computes the position of a 3D point after viewer rotation. | |
| RotatedPoint3D_ref | public | Computes the position of the 3D point after viewer rotation. | |
| SaveAll | public | Save all layers (parameters and data) | |
| SaveData | public | Save all changes to the data. | |
| SaveProject | public | Save the current project. | |
| SaveProject(Boolean) | public | Save the current project. | |
| SaveProjectAs(String) | public | Save the current project under a new name. | |
| SaveProjectAs(String; Boolean) | public | Save the current project under a new name. | |
| SaveProjectAsEx(TGIS_ConfigAbstract; String) | public | Save the current project under a new name. | |
| SaveProjectAsEx(TGIS_ConfigAbstract; String; Boolean) | public | Save the current project under a new name. | |
| ScreenToMap | public | Converts point coordinates from screen coordinates to map coordinates. | |
| ScreenToMap3D | public | Converts point coordinates from screen coordinates to map coordinates. | |
| ScreenToMapEx | public | Converts point coordinates from screen coordinates to map coordinates, using TGIS_Point as the source type. | |
| ScreenToMapRect | public | Converts rectangle coordinates from screen coordinates to map coordinates. | |
| SetCSByEPSG | public | Sets the coordinate system from an EPSG (European Petroleum Survey Group) code. | |
| SetCSByWKT | public | Sets the coordinate system from a WKT (Well-Known Text) string containing a GEOGCS or PROJCS definition. | |
| SetCSByWKTFile | public | Sets the coordinate system from a file containing a WKT (Well-Known Text) string with a GEOGCS or PROJCS definition. | |
| SetViewport | public | Sets the viewport origin to a given position in map coordinates. | |
| StorePaintState | public | Store the current paint state. | |
| Subscribe | public | Add provided control to the notification subscription list. | |
| SynchronizePaint | public | Wait for a pending paint operation to finish. | |
| TwipsToPixels | public | Converts a size from device-independent twips (1/1440 inch) to device-dependent pixels to keep the map device independent. | |
| TwipsToPoints | public | Converts a size from device-independent twips (1/1440 inch) to device points for advanced font sizing. | |
| Unlock | public | Unlock the viewer and redraw it. | |
| Unlock(Boolean) | public | Unlock the viewer and optionally redraw it. | |
| UnrotatedExtent | public | Computes the original extent of a rotated extent. | |
| UnrotatedPoint | public | Computes the original position of a rotated point. | |
| UnrotatedPoint3D | public | Computes the original position of a rotated 3D point. | |
| UnrotatedPoint3D_ref | public | Computes the original position of a rotated 3D point. | |
| UnSubscribe | public | Remove provided control from the notification subscription list. | |
| WaitForBackgroundProcesses | public | Waits for any pending background processes that must finish before the application can continue. | |
| WaitForNotBusy | public | Calls _proc when the viewer fully finishes the painting process. | |
| WriteConfig | public | Write all configuration data to the project or layer INI file. | |
Properties
Inherited
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| AutoStyle | public | If True, layers added to the viewer will have a unique style applied. | |
| BigExtent | public | Map extent encompassing the collective extents of all layers and a border defined by BigExtentMargin. | |
| BigExtentMargin | public | Map extent margin. | |
| BusyLevel | public | Level of current busy state. | |
| BusyText | public | Text related to the current busy state. | |
| Center | public | Center the screen based on given point. | |
| CenterPtg | public | Point on which the viewer will be centered during zoom. | |
| Color | public | Background color. | |
| Copyright | public | Legal notice and product version. | |
| CS | public | Coordinate system assigned to the viewer. | |
| CustomData | public | List of custom user-defined data saved to and restored from config/project files. | |
| CustomPPI | public | Custom resolution in pixels-per-inch. | |
| DelayedUpdate | public | Delayed update threshold in milliseconds. | |
| Editor | public | Editor context. | |
| Extent | public | Map extent encompassing the collective extents of all layers. | |
| FileCopyrights | public | List of copyrights. | |
| FontScale | public | Font magnifying factor in percents. | |
| FullDrawExtent | public | Extent of the full current or last drawing area, including margin and without tiling. | |
| Hierarchy | public | Hierarchy list. | |
| IncrementalPaint | public | Is partial drawing to screen done in incremental mode? | |
| InPaint | public | True if the viewer is busy in the Paint procedure. | |
| IsBusy | public | Indicates whether the viewer is currently painting. | |
| IsEmpty | public | True if the viewer is empty and contains no layers. | |
| IsLocked | public | True if the viewer is in the locked state. | |
| IsTopmost | public | True if Viewer has a topmost layer. | |
| Items | public | All layers. | |
| KeepScale | public | True if a viewer should maintain scale upon resize. | |
| LabelsReg | public | Labels position allocator object. | |
| Level | public | Sets and gets the zoom level for the viewer. | |
| MasterViewer | public | Reference to the master viewer used by tiled painting. | |
| MultiUserMode | public | Multi-user mode. | |
| OverlappedExtentMargin | public | Overlapped extent margin in pixels. | |
| PPI | public | Rendering resolution in pixels per inch. | |
| ProgressiveUpdate | public | Progressive update threshold in milliseconds. | |
| ProjectFile | public | Project file itself as opened in Open procedure. | |
| ProjectName | public | Project file name as opened in Open procedure. | |
| RestrictedDrag | public | If True, dragging outside the map extent is not allowed. | |
| RestrictedExtent | public | Restricted map extent. | |
| RotationAngle | public | Angle of viewer rotation in radians. | |
| RotationPoint | public | Point of viewer rotation in map units. | |
| Scale | public | Sets and gets the scale factor. | |
| ScaleAsFloat | public | Sets and gets the scale factor. | |
| ScaleAsText | public | Sets and gets the scale factor as text in the format '1:10000'. | |
| SelectionGisColor | public | Color used to highlight selected objects. | |
| SelectionOutlineOnly | public | If True, polygons are marked only with an outline and not filled. | |
| SelectionTransparency | public | Transparency value for selection. | |
| SelectionWidth | public | Outline width of selection area (>0 in twips, <0 in pixels). | |
| SystemPPI | public | System resolution in pixels per inch. | |
| TemporaryScaleInternal | public | Used to force rendering at a scale different from the actual scale. | |
| TemporaryVisibleExtent | public | Used to force label rendering while drawing with tiles. | |
| TiledPaint | public | True if partial drawing to the screen is done in tiled mode. | |
| UponDestroy | public | True if the viewer is being destroyed, so some operations such as screen updates should not be performed. | |
| UseAnimations | public | True if zoom animations are allowed. | |
| UseRTree | public | True if an RTree spatial index will be used by default when a layer is created. | |
| ViewerParent | public | Parent for the current IGIS_Viewer object. | |
| ViewerParentRoot | public | Root parent for the current IGIS_Viewer object. | |
| Viewport | public | Sets and gets the upper-left corner position of the component window within the map. | |
| VisibleExtent | public | Extent of the map visible in the window. | |
| Zoom | public | Sets and gets the relative zoom factor. | |
| ZoomEx | public | Sets and gets the absolute zoom factor. | |
2026/08/30 01:55