User Tools

Site Tools


api:dk11:activex:tatukgis_xdk11.tgis_layervector

TGIS_LayerVector class

DK11 for ActiveX | TatukGIS_XDK11.TGIS_LayerVector | Classes | Methods | Properties

General layer class for vector layers. Must be derived to provide file access.

Available also on: Delphi | .NET | Java | ActiveX.

Syntax

// C#
public class TGIS_LayerVector : ITGIS_LayerVector, IConnectionPointContainer, ITGIS_LayerVectorEvents 
{
}
' VisualBasic
Public Class TGIS_LayerVector
  Implements ITGIS_LayerVector
  Implements IConnectionPointContainer
  Implements ITGIS_LayerVectorEvents
End Class
// Oxygene
type
  TGIS_LayerVector = public class
  end;

Implements

ITGIS_LayerVector IConnectionPointContainer ITGIS_LayerVectorEvents

Methods

Inherited Overrides Protected
Name Visibility Description
AddField public Add a new field.
AddFieldInternal public Add new field.
AddFieldInternal_2 public Add new field.
AddShape public Add a new shape (a copy) and make it editable.
AddShape_2 public Add a new shape (a copy) and make it editable.
Alive public Makes a layer non-dormant.
(Inherited from ITGIS_Layer)
ApplyCuttingPolygon public Set cutting polygon for a layer.
(Inherited from ITGIS_Layer)
AttachDelphiObj public Only for internal use of TatukGIS.
(Inherited from ITBaseObject)
Build public Build new layer - prepare storage.
Build_2 public Build new layer - prepare storage.
CentroidScope public Calculate a centroid for a scope.
ChangeHash public Change hash.
(Inherited from ITGIS_Layer)
ClearModified public Set IsModified flag to false for a layer and sublayers.
(Inherited from ITGIS_Layer)
CreateShape public Create a new shape and make it editable.
CreateShape_2 public Create a new shape and make it editable
CursorAfterFetchEvent public CursorAfterFetch event.
(Inherited from ITGIS_LayerVectorEvents)
CursorBeforeFetchEvent public CursorBeforeFetch event.
(Inherited from ITGIS_LayerVectorEvents)
CursorCloseEvent public CursorClose event.
(Inherited from ITGIS_LayerVectorEvents)
CursorOpenEvent public CursorOpen event.
(Inherited from ITGIS_LayerVectorEvents)
Delete public Delete a shape.
DeleteField public Delete field.
DelphiObj public Only for internal use of TatukGIS.
(Inherited from ITBaseObject)
Deselect public Clear selection of shape.
DeselectAll public Clear selection of all shapes.
Dormant public Makes a layer dormant.
(Inherited from ITGIS_Layer)
DormantGain public Calculate approximate gain (in Megabytes) which can be achieved releasing memory by calling Dormant()
(Inherited from ITGIS_Layer)
Draw public Draws a layer.
(Inherited from ITGIS_Layer)
DrawChart public Draw layer charts.
DrawEx public Draws a layer with given extent.
(Inherited from ITGIS_Layer)
DrawFlash public Draw flashed
(Inherited from ITGIS_Layer)
DrawScope public Draw only shapes that meet a scope criteria.
DrawSelected public Draws a layer.
(Inherited from ITGIS_Layer)
DrawSelectedEx public Draws a layer with given extent.
(Inherited from ITGIS_Layer)
ExportLayer public Export layer.
ExportLayerEx public Export layer.
ExportLayer_2 public Export layer.
ExportStructureToFLD public Export fields structure to fld file.
FieldInfo public Return pointer to GIS_FieldInfo structure.
FinalizeDirectWrite public Finalize direct writing into a layer storage.
FindField public Find field in a field list.
FindFieldInternal public Find field in a field list.
FindFirst public Find first occurrence of an item which meets extent and query.
FindFirst_2 public Find first occurrence of an item which meets extent and query.
FindFirst_3 public Find first occurrence of an item which meets extent and query.
FindFirst_4 public Find first occurrence of an item which meets extent and query.
FindFirst_5 public Find first occurrence of an item which meets extent and query.
FindNext public Find next occurrence of item defined in FindFirst.
FlashShape public Flash shape several times
ForEach public Fetch all shapes form the layer using callback function.
ForEachSubLayer public Return in callback event a layer and all sublayers that belong it.
(Inherited from ITGIS_Layer)
GetAvailableLayers public Get a list of layers available in storage.
(Inherited from ITGIS_Layer)
GetField public Get field value for a shape given by unique identity.
GetFieldEx public Get field value for a shape given by unique identity.
GetLastUid public Peek a Uid of last shape.
GetNewUid public Finds a Uid for a new shape.
GetSelectedCount public Return the number of selected shapes.
GetShape public Get shape by unique identifier on default cursor (0).
GetShape_2 public Get shape by unique identifier.
GetUniqueFieldName public Suggests unique field name.
HourglassShake public Notify on hourglass on busy state.
(Inherited from ITGIS_Layer)
ImportLayer public Import layer from an existing layer.
ImportLayerEx public Import layer from an existing layer.
ImportLayer_2 public Import layer from an existing layer.
ImportStructure public Import the field structure from another layer
InitializeDirectWrite public Build new layer - prepare storage for direct writing.
InvalidateScope public Invalidate shapes in the scope.
InvalidateSelection public Invalidate all selected shape (but only to redraw selection not shapes itself.
IsGrid public Is layer a grid type.
(Inherited from ITGIS_Layer)
IsPixel public Is layer a pixel type.
(Inherited from ITGIS_Layer)
IsSupported public Is operation supported by a layer.
(Inherited from ITGIS_Layer)
IsVector public Is layer a vector type.
(Inherited from ITGIS_Layer)
IsVector3D public Is layer a vector type.
(Inherited from ITGIS_Layer)
IsVisible public Check if a layer is visible in given extent and current params.
(Inherited from ITGIS_Layer)
LabelPosEvent public LabelPos event.
(Inherited from ITGIS_LayerVectorEvents)
LegendInfo public Return parameters filled with the renderer styling.
Locate public Locate a shape.
LocateEx public Locate a shape (more precise).
LocateEx_2 public Locate a shape (more precise).
LocateEx_3 public Locate a shape (more precise).
Locate_2 public Locate a shape.
Lock public Lock a layer burst-mode operation.
(Inherited from ITGIS_Layer)
Loop public Prepare enumerator (also known as iterator or cursor) to iterate layer.
Loop_2 public Prepare enumerator (also known as iterator or cursor) to iterate layer.
Loop_3 public Prepare enumerator (also known as iterator or cursor) to iterate layer.
Loop_4 public Prepare enumerator (also known as iterator or cursor) to iterate layer.
Loop_5 public Prepare enumerator (also known as iterator or cursor) to iterate layer.
MergeLayer public Merge layer from an existing layer.
MergeLayerEx public Merge layer from an existing layer.
MergeLayer_2 public Merge layer from an existing layer.
MergeStructure public Merge the field structure from another layer
MergeStructure_2 public Merge the field structure from another layer
Move public Move a layer up or down in a viewer zorder list.
(Inherited from ITGIS_Layer)
MoveEx public Move a layer up or down in a viewer zorder list.
(Inherited from ITGIS_Layer)
MustCalculateStatistics public Verify if all statistics required to properly render layer are available.
(Inherited from ITGIS_Layer)
MustReproject public Do layer must reproject.
(Inherited from ITGIS_Layer)
MustSave public Check if the layer was modified by editing.
(Inherited from ITGIS_Layer)
Open public Open the layer.
(Inherited from ITGIS_Layer)
Paint public Draws a layer or fires PaintLayer event ( if defined ).
(Inherited from ITGIS_Layer)
PaintShapeChartEvent public PaintShapeChart event.
(Inherited from ITGIS_LayerVectorEvents)
PaintShapeEvent public PaintShape event.
(Inherited from ITGIS_LayerVectorEvents)
PaintShapeLabelEvent public PaintShapeLabel event.
(Inherited from ITGIS_LayerVectorEvents)
ParamsAsDrawn public Get a shape styling parameters used during drawing on a viewer and fill _params parameter with them.
Prepare public Open the layer.
(Inherited from ITGIS_Layer)
PrepareExportFieldNames public Prepare export field names.
PrepareExportFieldNames_2 public Prepare export field names.
PrepareExportFieldNames_3 public Prepare export field names.
PreRecognize public Check if layer can read a file.
(Inherited from ITGIS_Layer)
Project public Apply a projection on the single point.
(Inherited from ITGIS_Layer)
Project3D public Apply a projection on the single point in 3D.
(Inherited from ITGIS_Layer)
Project3D_Ref public Apply a projection on the single point in 3D.
(Inherited from ITGIS_Layer)
Project_Ref public Apply a projection on the single point.
(Inherited from ITGIS_Layer)
RaiseBusyEvent public Fire Busy event of a layer.
(Inherited from ITGIS_Layer)
RaiseBusyPrepare public Fire BusyPrepare method of a viewer.
(Inherited from ITGIS_Layer)
RaiseBusyRelease public Fire BusyRelease method of a viewer.
(Inherited from ITGIS_Layer)
RaiseBusyShake public Fire BusyShake method of a viewer.
(Inherited from ITGIS_Layer)
ReadConfig public Read layer configuration files.
(Inherited from ITGIS_Layer)
ReadConfigParam public Read layer configuration parameter.
(Inherited from ITGIS_Layer)
ReadFieldDefinition public Parse field definition file.
ReadFieldRules public Parse field rules file.
RecalcExtent public Recalculate extent based on real shapes.
(Inherited from ITGIS_Layer)
RecalcProjectedExtent public Recalculate a projected extent.
(Inherited from ITGIS_Layer)
RenameField public Rename a field.
ReOpen public Reopen the layer.
(Inherited from ITGIS_Layer)
RereadConfig public Reread layer configuration files.
(Inherited from ITGIS_Layer)
Revert public Revert a shape to the original state.
RevertAll public Revert a layer to a original content.
(Inherited from ITGIS_Layer)
RevertShapes public Revert all shapes to the original state.
RootLayer public Return absolute parent layer.
(Inherited from ITGIS_Layer)
SaveAll public Save layer and destroy mirrored items.
(Inherited from ITGIS_Layer)
SaveData public Save layer and destroy mirrored items.
(Inherited from ITGIS_Layer)
SetCSByEPSG public Setup Coordinate System to a coordinate system provided by EPSG code.
(Inherited from ITGIS_Layer)
SetCSByWKT public Setup Coordinate System to a coordinate system provided by WKT string (GEOGCS or PROJCS).
(Inherited from ITGIS_Layer)
SetCSByWKTFile public Setup Coordinate System to a coordinate system provided by file which contains WKT string (GEOGCS or PROJCS).
(Inherited from ITGIS_Layer)
ShapeFieldChangeEvent public ShapeFieldChange event.
(Inherited from ITGIS_LayerVectorEvents)
ShapeGeometryChangeEvent public ShapeGeometryChange event.
(Inherited from ITGIS_LayerVectorEvents)
Unlock public Unlock a layer from burst-mode operation.
(Inherited from ITGIS_Layer)
Unproject public Apply reverse projection (recover from projection) on the single point.
(Inherited from ITGIS_Layer)
Unproject3D public Apply reverse projection (recover from projection) on the single point in 3D.
(Inherited from ITGIS_Layer)
Unproject3D_Ref public Apply reverse projection (recover from projection) on the single point in 3D.
(Inherited from ITGIS_Layer)
Unproject_Ref public Apply reverse projection (recover from projection) on the single point.
(Inherited from ITGIS_Layer)
WriteConfig public Write layer configuration files.
(Inherited from ITGIS_Layer)
WriteShapeDirect public Write a shape directly into the layer storage.

Properties

Inherited Protected
Name Visibility Description
Active public Is the Layer active? Active means that it can be visible, and that an object can be localized on such layers.
(Inherited from ITGIS_Layer)
Addition public Addition value.
(Inherited from ITGIS_Layer)
Age public Age of the layer.
(Inherited from ITGIS_Layer)
Basemap public True, if layer must be interpreted as basemap (for background painting).
(Inherited from ITGIS_Layer)
BlockRTree public If true, then UseRtree Rtree for the layer can not be enabled.
CachedPaint public False, if layer must be painted directly (bypassing cache).
(Inherited from ITGIS_Layer)
Caption public Caption of layer, if not filed directly then will be filed with Name while adding to the Viewer.
(Inherited from ITGIS_Layer)
CodePage public Code Page in which text has been stored.
(Inherited from ITGIS_Layer)
Collapsed public Is the Layer collapsed? Collapsed means that inside legend only title will be visible.
(Inherited from ITGIS_Layer)
Comments public Additional user comments.
(Inherited from ITGIS_Layer)
ConfigFile public Configuration file handle.
(Inherited from ITGIS_Layer)
ConfigName public Configuration file name.
(Inherited from ITGIS_Layer)
CS public Coordinate System assigned to the layer.
(Inherited from ITGIS_Layer)
CustomData public List of custom, user-defined data.
(Inherited from ITGIS_Layer)
DefaultDimension public Default shape dimension for layer.
DefaultShapeType public Default shape type for layer.
DirectMode public Return True, if the layer is direct-mode (bypassing cache).
(Inherited from ITGIS_Layer)
DormantMode public Dormant mode for the layer.
(Inherited from ITGIS_Layer)
Driver public Layer driver name.
(Inherited from ITGIS_Layer)
Extent public Extent of the layer.
(Inherited from ITGIS_Layer)
Extent3D public Extent 3D of the layer.
(Inherited from ITGIS_Layer)
Fields public List of database fields definitions.
FieldsVirtual public List of virtual fields.
FileCopyrights public Copyright information about the layer.
(Inherited from ITGIS_Layer)
FileInfo public Additional textual information about the layer such compression, number of pixels, copyright etc.
(Inherited from ITGIS_Layer)
HideFromLegend public False, if layer should not be visible in a legend.
(Inherited from ITGIS_Layer)
IgnoreShapeParams public If True then only layer level params will be used.
InMemoryRTree public True, if rtree file will be created in-memory.
IsExportable public True if layer is exportable.
(Inherited from ITGIS_Layer)
IsLocked public True, if layer is in locked state Lock.
(Inherited from ITGIS_Layer)
IsOpened public True, if layer was opened and is ready for operations.
(Inherited from ITGIS_Layer)
IsPersistent public True if layer is persistent.
(Inherited from ITGIS_Layer)
IsReadOnly public Is layer read only.
(Inherited from ITGIS_Layer)
IsTopmost public True, if layer can be interpreted as topmost (trackable).
(Inherited from ITGIS_Layer)
Items public List of all ghost items.
JoinADO public ADO Query to be joined.
JoinCodePage public Code page for JoinADO/JoindDB.
JoinForeign public Field from Query to be joined.
JoinPrimary public Field from feature table to be joined.
LabelingMode public Labeling mode metadata.
MaxTileSize public Maximum allowed tile size for the layer.
(Inherited from ITGIS_Layer)
MultipassRendering public Force multipass rendering.
MultiUserMode public Multiuser mode.
(Inherited from ITGIS_Layer)
Name public Name of layer, if not field directly then will be field with Path while adding to the Viewer.
(Inherited from ITGIS_Layer)
Params public Returns parameters (colors, fills, etc.) object.
ParamsList public List of all parameters sections attached to the current layer.
(Inherited from ITGIS_Layer)
Params_ public Parameters (colors, fills etc) object.
(Inherited from ITGIS_Layer)
ParentLayer public Sub layer parent layer.
(Inherited from ITGIS_Layer)
Path public Path to file with layer data.
(Inherited from ITGIS_Layer)
PathFLD public Path to fields definition ini file.
PathFLDX public Path to field rules file.
PathRTree public Path to RTree index.
PathWithDriver public Path to file with layer data extended with driver name.
(Inherited from ITGIS_Layer)
ProjectedExtent public Extent of the layer in projected units.
(Inherited from ITGIS_Layer)
Renderer public Handle to a renderer used for drawing shapes.
(Inherited from ITGIS_Layer)
Scope public Scope zone.
ScopeExtent public Scope extent.
SelectedList public List of uids of selected shapes.
Statistics public Layer statistics engine
(Inherited from ITGIS_Layer)
Stream public Reference to a potential layer underlying stream.
(Inherited from ITGIS_Layer)
SubLayers public Sub layers list.
(Inherited from ITGIS_Layer)
SubType public Layer type.
(Inherited from ITGIS_Layer)
SupportedDimensions public Set of dimensions supported by a layer.
SupportedShapes public Set of shapes supported by a layer.
SymbolingMode public Symboling mode metadata.
Tag public Tag has no predefined meaning.
(Inherited from ITGIS_Layer)
TagInternal public TagInternal has no predefined meaning.
(Inherited from ITGIS_Layer)
TagPointer public TagPointer has no predefined meaning.
(Inherited from ITGIS_Layer)
Transform public Custom transformation.
(Inherited from ITGIS_Layer)
Transparency public Transparency value.
(Inherited from ITGIS_Layer)
UnSupportedOperations public Set of operations not supported by a layer.
(Inherited from ITGIS_Layer)
UseConfig public Is config file active?
(Inherited from ITGIS_Layer)
UserObject public UserObject can be used to associate with the layer a user defined objects.
(Inherited from ITGIS_Layer)
UseRTree public Set the use of an index based on RTree structure.
Viewer public Reference to viewer object.
(Inherited from ITGIS_Layer)
ZOrder public Layer position relative to other layers.
(Inherited from ITGIS_Layer)
ZOrderEx public Layer position relative to other layers.
(Inherited from ITGIS_Layer)

Remarks

Available metadata keys

Metadata Values Default Description
TGIS_Viewer.RotationMode.Labels NO BYFIELD WITHANGLE ALL BYFIELD Labels rotation modes.
TGIS_LayerVector.WriteOriginalUid TRUE FALSE FALSE Field with original uid (ORIG_ID) will be added during layer import.

Virtual fields

Each vector layer supports virtual fields:

(to be accessed by ITGIS_Shape.GetField method)

Field name Description
GIS_FIELD_AREA Same as ITGIS_Shape.AreaCS method or ITGIS_Shape.Area method if layer has no coordinate system assigned.
GIS_FIELD_CENTER_X Center X coordinate of a shape.
GIS_FIELD_CENTER_Y Center Y coordinate of a shape.
GIS_FIELD_CENTER_M Center M coordinate of a 3d shape.
GIS_FIELD_CENTER_Z Center Z coordinate of a 3d shape.
GIS_FIELD_CENTROID_X X coordinate of a shape's centroid (ITGIS_Shape.Centroid method).
GIS_FIELD_CENTROID_Y Y coordinate of a shape's centroid (ITGIS_Shape.Centroid method).
GIS_FIELD_COORD_M M coordinate of the first vertex of a 3D shape.
GIS_FIELD_COORD_Z Z coordinate of the first vertex of a 3D shape.
GIS_FIELD_HIDDEN Same as ITGIS_Shape.IsHidden property
GIS_FIELD_LENGTH Same as ITGIS_Shape.LengthCS method or ITGIS_Shape.Length method if layer has no coordinate system assigned.
GIS_FIELD_MAX_X Maximum X coordinate of a shape. Same as XMax from ITGIS_Shape.Extent property.
GIS_FIELD_MAX_Y Maximum Y coordinate of a shape. Same as YMax from ITGIS_Shape.Extent property.
GIS_FIELD_MAX_M Maximum M coordinate of a 3D shape. Same as MMax from ITGIS_Shape.Extent3D property.
GIS_FIELD_MAX_Z Maximum Z coordinate of a 3D shape. Same as ZMax from ITGIS_Shape.Extent3D property.
GIS_FIELD_MIN_X Minimum X coordinate of a shape. Same as XMin from ITGIS_Shape.Extent property.
GIS_FIELD_MIN_Y Minimum Y coordinate of a shape. Same as YMin from ITGIS_Shape.Extent3D property.
GIS_FIELD_MIN_M Minimum M coordinate of a 3D shape. Same as MMin from ITGIS_Shape.Extent3D property.
GIS_FIELD_MIN_Z Minimum Z coordinate of a 3D shape. Same as ZMin from ITGIS_Shape.Extent3D property.
GIS_FIELD_NOW Current date & time.
GIS_FIELD_NUM_PARTS Same as ITGIS_Shape.GetNumParts method
GIS_FIELD_NUM_POINTS Same as ITGIS_Shape.GetNumPoints method
GIS_FIELD_SELECTED Same as ITGIS_Shape.IsSelected property
GIS_FIELD_UID Same as ITGIS_Shape.Uid property

2019/09/18 01:02