api:dk11:activex:tatukgis_xdk11.igis_viewer
Table of Contents
IGIS_Viewer interface
DK11 for ActiveX | TatukGIS_XDK11.IGIS_Viewer | Interfaces | Methods | Properties
Common API for viewer operations. To be shared across platforms.
Syntax
// C# public interface IGIS_Viewer: ITBaseObject { }
' VisualBasic Public Interface IGIS_Viewer Implements ITBaseObject End Class
// Oxygene type IGIS_Viewer = public interface( ITBaseObject ) end;
Implements
Methods
Inherited
Overrides
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| Add | public | Add a layer to the Viewer. | |
| AddHierarchy | public | Read hierarchy and build groups with layers. | |
| AttachDelphiObj | public | Only for internal use of TatukGIS. (Inherited from ITBaseObject) |
|
| AttachLayer | public | Attach layer to the viewer by re-parenting. | |
| BeginPaintInternal | public | Notify viewer about entering of a paint mode. | |
| BusyPrepare | public | Prepare BusyEvent for long-term operation. | |
| BusyRelease | public | Release Busy state. | |
| BusyShake | public | Shake Busy state. | |
| CenterViewport | public | Set viewport to the vale when _ptg will be visible on the center of the screen. | |
| ChangeHash | public | Change hash. | |
| Close | public | Close a project. | |
| Delete | public | Delete the layer identified by a name. | |
| DelphiObj | public | Only for internal use of TatukGIS. (Inherited from ITBaseObject) |
|
| Draw | public | Draw all layers on a current renderer. | |
| EndPaintInternal | public | Notify viewer about leaving of a paint mode. | |
| FullExtent | public | Calculate the screen origin, zoom, and viewport to place the whole map in the window. | |
| FullExtentZoom | public | Calculates a zoom which places the whole map inside the window | |
| Get | public | Retrieve the layer identified by a name. | |
| GetGrid | public | Fills provided _grid array with values defined by _extent. | |
| GetRenderContext | public | Return current context object. | |
| HourglassActive | public | Test is hourglass is active. | |
| HourglassPrepare | public | Prepare Hourglass cursor for timely operation. | |
| HourglassRelease | public | Release Hourglass. | |
| HourglassRestart | public | Restart hourglass timing used for progressive updates. | |
| HourglassShake | public | Shake Hourglass. | |
| Interrupt | public | Will terminate timely operation as soon as possible. | |
| Interrupted | public | Test if any pending operation must be aborted. | |
| InvalidateBasemap | public | Invalidate only basemap layers. | |
| InvalidateEditor | public | Invalidate editor. | |
| InvalidateExtent | public | Invalidate an extent for full map redraw | |
| InvalidateExtent_2 | public | Invalidate an extent. | |
| InvalidateSelection | public | Invalidate selection. | |
| InvalidateTopmost | public | Invalidate only topmost layers. | |
| InvalidateWholeMap | public | Invalidate whole map. | |
| Locate | public | Locate a shape that is near _ptg, but is closer than _prec distance. | |
| LocateEx | public | Locate shapes on layers that are near _ptg, but closer than _prec distance. | |
| Locate_2 | public | Locate a shape that is near _ptg, but is closer than _prec distance. | |
| Locate_3 | public | Locate a shape that is near _pt, but is closer than _prec distance. | |
| Lock | public | Lock viewer. | |
| MapToScreen | public | Converts point coordinates from map related to screen related. | |
| MapToScreen3D | public | Converts 3D point coordinates from map related to screen related. | |
| MapToScreenEx | public | Converts point coordinates from map related to screen related, but result will be in TGIS_Point. | |
| MapToScreenRect | public | Converts rectangle coordinates from map related to screen related. | |
| MarkModified | public | Mark viewer upon some modifications. | |
| MoveViewport | public | Move the screen origin of the map by delta values. | |
| MoveViewportEx | public | Move the screen origin of the map by delta values. | |
| MustSave | public | Check if any layer or the project file was modified by editing. | |
| NotifySubscribers | public | Send notification to subscribers. | |
| Open | public | Open project. | |
| OpenEx | public | Open project file from the memory. | |
| OpenEx_2 | public | Open project file from the memory. | |
| Open_2 | public | Open project. | |
| PixelsToTwips | public | Convert size from device dependent pixels to device independent Twips (1/1440 inch). | |
| RaiseBusyEvent | public | Fire Busy event of a viewer. | |
| RaiseHelpEvent | public | Fire Busy event of a viewer. | |
| ReadConfig | public | Read all configuration data from project. | |
| RecalcExtent | public | Calculates a common extent. | |
| Reposition | public | Reposition the map within the component window. | |
| RereadConfig | public | Reread all configuration data from 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 | Compute extent (encompassing area of the extent) after the viewer rotation. | |
| RotatedPoint | public | Compute position of the point after the viewer rotation. | |
| RotatedPoint3D | public | Compute position of the 3D point after the viewer rotation. | |
| RotatedPoint3D_ref | public | Compute position of the 3D point after the viewer rotation. | |
| SaveAll | public | Save all layers (parameters and data) | |
| SaveData | public | Save all changes to the data. | |
| SaveProject | public | Save current project. | |
| SaveProjectAs | public | Save current project under new name. | |
| SaveProjectAsEx | public | Save current project under new name. | |
| SaveProjectAsEx_2 | public | Save current project under new name. | |
| SaveProjectAs_2 | public | Save current project under new name. | |
| SaveProject_2 | public | Save current project. | |
| ScreenToMap | public | Converts point coordinates from screen related to map related. | |
| ScreenToMap3D | public | Converts point coordinates from screen related to map related. | |
| ScreenToMapEx | public | Converts point coordinates from screen related to map related, but source will be in TGIS_Point. | |
| ScreenToMapRect | public | Converts rectangle coordinates from screen related to map related. | |
| SetCSByEPSG | public | Setup Coordinate System to a coordinate system provided by EPSG code. | |
| SetCSByWKT | public | Setup Coordinate System to a coordinate system provided by WKT string (GEOGCS or PROJCS). | |
| SetCSByWKTFile | public | Setup Coordinate System to a coordinate system provided by file which contains WKT string (GEOGCS or PROJCS). | |
| SetViewport | public | Set viewport to a given position. | |
| StorePaintState | public | Store the current paint state. | |
| Subscribe | public | Add provided control to the notification subscription list. | |
| SynchronizePaint | public | Wait for pending paint operation to be finalized. | |
| TwipsToPixels | public | Convert the size from to device independent Twips (1/1440 inch) to device dependent pixels. | |
| TwipsToPoints | public | Convert the size from to device independent Twips (1/1440 inch) to device points. | |
| Unlock | public | Unlock viewer. | |
| Unlock_2 | public | Unlock the viewer but do not redraw | |
| UnrotatedExtent | public | Compute original extent of the rotated extent. | |
| UnrotatedPoint | public | Compute original position of the rotated point. | |
| UnrotatedPoint3D | public | Compute original position of the rotated 3D point. | |
| UnrotatedPoint3D_ref | public | Compute original position of the rotated 3D point. | |
| UnSubscribe | public | Remove provided control from the notification subscription list. | |
| WaitForBackgroundProcesses | public | Wait for any pending background processes that must be finalized before app can continue. | |
| WaitForNotBusy | public | Call _proc when viewer will fully end painting procees. | |
| 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. | |
| BigExtentMargin | public | Map extent margin. | |
| BusyLevel | public | Level of current busy state. | |
| BusyText | public | Text related to current busy state. | |
| Center | public | Center the screen based on given point. | |
| CenterPtg | public | Point on which 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. | |
| CustomPPI | public | Custom resolution in pixels-per-inch. | |
| DelayedUpdate | public | Delayed update threshold in milliseconds. | |
| Editor | public | Editor context. | |
| Extent | public | Map extent. | |
| FileCopyrights | public | List Copyrights | |
| FontScale | public | Font magnifying factor in percents. | |
| FullDrawExtent | public | Extent of full current/last drawing area including margin and w/o tiling. | |
| Hierarchy | public | Hierarchy list. | |
| IncrementalPaint | public | Is partial drawing to screen done in incremental mode? | |
| InPaint | public | True if Viewer is busy in Paint procedure. | |
| IsBusy | public | True if Viewer is busy. | |
| IsEmpty | public | True if Viewer is empty (no layers). | |
| IsLocked | public | True if Viewer is in locked state Lock. | |
| 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 zoom level for a viewer. | |
| MasterViewer | public | Master Viewer reference. | |
| MultiUserMode | public | Multiuser 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, then you can not drag outside the map Extent. | |
| RestrictedExtent | public | Restricted Map extent. | |
| RotationAngle | public | Angle of viewer rotation in radians. | |
| RotationPoint | public | Point of viewer rotation in map units. | |
| Scale | public | Setting up and reading the scale factor. | |
| ScaleAsFloat | public | Setting up and reading the scale factor. | |
| ScaleAsText | public | Setting up and reading the scale factor as text in format '1:10000'. | |
| SelectionGisColor | public | Color used for selecting object. | |
| SelectionOutlineOnly | public | If true then polygons will be marked only with outline not a full fill. | |
| SelectionTransparency | public | Transparency value for selection; if 100 SelectionGisColor will not be transparent. | |
| 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 in a different scale then actual. | |
| TemporaryVisibleExtent | public | Used to force rendering labels while drawing with tiles. | |
| TiledPaint | public | Is partial drawing to screen done in tiled mode? | |
| UponDestroy | public | True if viewer is upon destruction so some operations (like screen updates) should not be performed | |
| UseAnimations | public | True if animation upon zooming are allowed. | |
| UseRTree | public | True if RTree will be used by default upon creation of any layer. | |
| ViewerParent | public | Parent for the current IGIS_Viewer object. | |
| Viewport | public | Setting an upper left corner position of the components window within the map. | |
| VisibleExtent | public | Extent of the map that is visible in the window. | |
| Zoom | public | Setting up and reading the related zoom factor. | |
| ZoomEx | public | Setting up and reading the absolute zoom factor. | |
2024/08/02 22:22