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.

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 Adds a new field.
AddFieldInternal public Adds new field; for internal use.
AddFieldInternal_2 public Adds new field; for internal use.
AddShape public Adds a copy of shape and makes it editable.
AddShape_2 public Adds a copy of shape and makes it editable.
Alive public Makes a layer non-dormant.
(Inherited from ITGIS_Layer)
ApplyCuttingPolygon public Sets a cutting polygon for a layer.
(Inherited from ITGIS_Layer)
AttachDelphiObj public Only for internal use of TatukGIS.
(Inherited from ITBaseObject)
Build public Builds a new layer - prepares storage.
Build_2 public Builds s new layer - prepare storage.
CentroidScope public Calculates a centroid for a scope.
ChangeHash public Changes the hash for the purpose of verifying layer's modifications.
(Inherited from ITGIS_Layer)
ClearModified public Sets IsModified flag to false for a layer and its sublayers.
(Inherited from ITGIS_Layer)
CreateShape public Creates a new shape and makes it editable.
CreateShape_2 public Creates a new shape and makes 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 Deletes a shape.
DeleteField public Deletes a field.
DelphiObj public Only for internal use of TatukGIS.
(Inherited from ITBaseObject)
Deselect public Clears selection of shape.
DeselectAll public Clears selection of all shapes.
Dormant public Makes a layer dormant.
(Inherited from ITGIS_Layer)
DormantGain public Calculates the approximate gain (in Megabytes) which can be achieved by releasing memory by calling Dormant method.
(Inherited from ITGIS_Layer)
Draw public Draws a layer.
(Inherited from ITGIS_Layer)
DrawChart public Draws layer charts.
DrawEx public Draws a layer within a defined extent.
(Inherited from ITGIS_Layer)
DrawFlash public Draws a flash.
(Inherited from ITGIS_Layer)
DrawScope public Draws only shapes that meet a scope criterion.
DrawSelected public Draws only the selected item(s) on layer.
(Inherited from ITGIS_Layer)
DrawSelectedEx public Draws only the selected item(s) on layer that are within a defined extent.
(Inherited from ITGIS_Layer)
ExportLayer public Exports the layer.
ExportLayerEx public Exports layer.
ExportLayer_2 public Exports layer.
ExportStructureToFLD public Exports fields structure to a fld file.
FieldInfo public Returns pointer to GIS_FieldInfo structure.
FinalizeDirectWrite public Finalizes direct writing into layer storage.
FindField public Finds a field in the fields list.
FindFieldInternal public Finds a field in the fields list (for internal use).
FindFirst public Finds the first shape in layer.
FindFirst_2 public Finds the first occurrence of an item which meets an extent.
FindFirst_3 public Finds the first occurrence of an item which meets an extent and query.
FindFirst_4 public Finds the first occurrence of an item which meets an extent, query, and additional parameters.
FindFirst_5 public Finds the first occurrence of an item which meets an extent, query, and additional parameters.
FindNext public Finds the next occurrence of an item defined in FindFirst.
FlashShape public Flashes shape several times
ForEach public Fetches all shapes from the layer using callback function.
ForEachSubLayer public Returns in callback event the layer and all sublayers belonging to it.
(Inherited from ITGIS_Layer)
GetAvailableLayers public Gets a list of layers available in storage.
(Inherited from ITGIS_Layer)
GetField public Gets a field value for a shape determined by its unique identity.
GetFieldEx public Gets a field value for a shape determined by its unique identity.
GetLastUid public Gets the Uid of the last shape.
GetNewUid public Gets the Uid for a new shape.
GetSelectedCount public Returns the quantity of selected shapes.
GetShape public Gets a shape by its unique identifier on default cursor (0).
GetShape_2 public Gets a shape by unique identifier.
GetUniqueFieldName public Suggests a unique field name.
HourglassShake public Notifies of busy state using an hourglass.
(Inherited from ITGIS_Layer)
ImportLayer public Imports a layer from an existing layer.
ImportLayerEx public Imports a layer from an existing layer.
ImportLayer_2 public Imports a layer from an existing layer.
ImportStructure public Imports the field structure from another layer
InitializeDirectWrite public Builds a new layer - prepares storage for direct writing.
InvalidateScope public Invalidates shapes in the scope.
InvalidateSelection public Invalidates all selected shapes (but only to redraw the selection, not the shapes themselves).
IsGrid public Checks if the layer type is grid.
(Inherited from ITGIS_Layer)
IsPixel public Checks if the layer type is pixel.
(Inherited from ITGIS_Layer)
IsSupported public Checks if the operation is supported by the layer.
(Inherited from ITGIS_Layer)
IsVector public Checks if the layer type is vector.
(Inherited from ITGIS_Layer)
IsVector3D public Checks if the layer type is vector 3D.
(Inherited from ITGIS_Layer)
IsVisible public Checks if the layer is visible in a defined extent and current params.
(Inherited from ITGIS_Layer)
LabelPosEvent public LabelPos event.
(Inherited from ITGIS_LayerVectorEvents)
LegendInfo public Returns parameters filled with the renderer styling.
Locate public Locates a shape.
LocateEx public Locates a shape (more precise).
LocateEx_2 public Locates a shape (more precise).
LocateEx_3 public Locates a shape (more precise).
Locate_2 public Locates a shape.
Lock public Locks layer in burst-mode operation.
(Inherited from ITGIS_Layer)
Loop public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop_2 public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop_3 public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop_4 public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop_5 public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
MergeLayer public Merges layer from an existing layer.
MergeLayerEx public Merges layer with an existing layer.
MergeLayer_2 public Merges layer with an existing layer.
MergeStructure public Merges the field structure from another layer.
MergeStructure_2 public Merges the field structure from another layer.
Move public Moves a layer up or down in the viewer zorder list.
(Inherited from ITGIS_Layer)
MoveEx public Moves a layer up or down in the viewer zorder list (only visible layers).
(Inherited from ITGIS_Layer)
MustCalculateStatistics public Verifies if all statistics required to properly render the layer are available.
(Inherited from ITGIS_Layer)
MustReproject public Checks if the layer must be reprojected.
(Inherited from ITGIS_Layer)
MustSave public Checks if the layer was modified by editing.
(Inherited from ITGIS_Layer)
Open public Opens the layer.
(Inherited from ITGIS_Layer)
Paint public Draws the 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 Gets a shape's styling parameters that are used during drawing in the viewer, and fills the _params parameter.
Prepare public Opens the layer.
(Inherited from ITGIS_Layer)
PrepareExportFieldNames public Prepares field names to export.
PrepareExportFieldNames_2 public Prepares field names to export.
PrepareExportFieldNames_3 public Prepares field names to export.
PreRecognize public Checks if the layer can read the file.
(Inherited from ITGIS_Layer)
Project public Applies a projection on the single point.
(Inherited from ITGIS_Layer)
Project3D public Applies a projection on the single point in 3D.
(Inherited from ITGIS_Layer)
Project3D_Ref public Applies a projection on the single point in 3D.
(Inherited from ITGIS_Layer)
ProjectExtent public Applies a projection on the extent.
(Inherited from ITGIS_Layer)
Project_Ref public Applies a projection on the single point.
(Inherited from ITGIS_Layer)
RaiseBusyEvent public Fires Busy event of the layer.
(Inherited from ITGIS_Layer)
RaiseBusyPrepare public Fires BusyPrepare method of the assigned viewer.
(Inherited from ITGIS_Layer)
RaiseBusyRelease public Fires BusyRelease method of the assigned viewer.
(Inherited from ITGIS_Layer)
RaiseBusyShake public Fires BusyShake method of the assigned viewer.
(Inherited from ITGIS_Layer)
ReadConfig public Reads the layer configuration files.
(Inherited from ITGIS_Layer)
ReadConfigParam public Reads the layer configuration parameters.
(Inherited from ITGIS_Layer)
ReadFieldDefinition public Parses the field definition file.
ReadFieldRules public Parses the field rules file.
RecalcExtent public Recalculates extent based on real shapes.
(Inherited from ITGIS_Layer)
RecalcProjectedExtent public Recalculates a projected extent.
(Inherited from ITGIS_Layer)
RenameField public Renames a field.
ReOpen public Reopens the layer.
(Inherited from ITGIS_Layer)
RereadConfig public Rereads the layer configuration files.
(Inherited from ITGIS_Layer)
Revert public Reverts a shape to its original state.
RevertAll public Reverts layer to its original content.
(Inherited from ITGIS_Layer)
RevertShapes public Reverts all shapes to their original state.
RootLayer public Returns the absolute parent layer.
(Inherited from ITGIS_Layer)
SaveAll public Saves layer and destroys mirrored items.
(Inherited from ITGIS_Layer)
SaveData public Saves layer and destroys mirrored items.
(Inherited from ITGIS_Layer)
SetCSByEPSG public Sets up Coordinate System to a coordinate system provided by a EPSG code.
(Inherited from ITGIS_Layer)
SetCSByWKT public Sets up Coordinate System to a coordinate system provided by a WKT string (GEOGCS or PROJCS).
(Inherited from ITGIS_Layer)
SetCSByWKTFile public Sets up Coordinate System to a coordinate system provided by a file which contains a 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 Unlocks layer from burst-mode operation.
(Inherited from ITGIS_Layer)
Unproject public Applies reverse projection (recovers from the projection) on the single point.
(Inherited from ITGIS_Layer)
Unproject3D public Applies reverse projection (recovers from the projection) on the singlepoint in 3D.
(Inherited from ITGIS_Layer)
Unproject3D_Ref public Applies reverse projection (recovers from the projection) on the single point in 3D.
(Inherited from ITGIS_Layer)
UnprojectExtent public Applies reverse projection (recovers from the projection) on the extent.
(Inherited from ITGIS_Layer)
Unproject_Ref public Applies reverse projection (recover from projection) on the single point.
(Inherited from ITGIS_Layer)
WriteConfig public Writes layer configuration files.
(Inherited from ITGIS_Layer)
WriteShapeDirect public Writes a shape directly into storage.

Properties

Inherited Protected
Name Visibility Description
Active public Checks if the layer is active? Active means layer is visible and an object can be localized on the layer.
(Inherited from ITGIS_Layer)
Addition public Additional value.
(Inherited from ITGIS_Layer)
Age public Age of the layer (since its creation).
(Inherited from ITGIS_Layer)
Basemap public True if the layer must be interpreted as basemap (for background painting).
(Inherited from ITGIS_Layer)
BlockRTree public If true, then Rtree for the layer cannot be enabled and UseRtree is ignored.
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 when adding to the Viewer.
(Inherited from ITGIS_Layer)
CodePage public Code Page in which text has been stored.
(Inherited from ITGIS_Layer)
Collapsed public Checks if the layer is collapsed? Collapsed means only the layer's title will be visible inside the legend.
(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 that is 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 the layer.
DefaultShapeType public Default shape type for the layer.
DirectMode public 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 The layer's driver name.
(Inherited from ITGIS_Layer)
DynamicAggregator public Aggregation processor is executed upon the drawing process.
Extent public Extent of the layer.
(Inherited from ITGIS_Layer)
Extent3D public Three-dimensional extent of the layer.
(Inherited from ITGIS_Layer)
Fields public List of database field 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 as compression, number of pixels, copyright, etc.
(Inherited from ITGIS_Layer)
HideFromLegend public False if the layer should not be visible in 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 the layer is exportable.
(Inherited from ITGIS_Layer)
IsLocked public True if the layer is in locked state.
(Inherited from ITGIS_Layer)
IsOpened public True if the layer is opened and is ready for operations.
(Inherited from ITGIS_Layer)
IsPersistent public True if the layer is persistent.
(Inherited from ITGIS_Layer)
IsReadOnly public True if the layer is read-only.
(Inherited from ITGIS_Layer)
IsTopmost public True if the layer can be interpreted as the topmost (trackable) layer.
(Inherited from ITGIS_Layer)
Items public A list of all ghost items.
JoinADO public ADO Query to be joined.
JoinCodePage public Code page for JoinADO/JoinDB.
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 Forces multipass rendering.
MultiUserMode public Type of multiuser mode.
(Inherited from ITGIS_Layer)
Name public Name of layer; if not filled directly, then will be filled with Path when added to the viewer.
(Inherited from ITGIS_Layer)
Params public Returns parameters (colors, fills, etc.) object.
ParamsList public List of all parameter sections attached to the current layer.
(Inherited from ITGIS_Layer)
Params_ public Parameters (colors, fills, etc.) object.
(Inherited from ITGIS_Layer)
ParentLayer public Parent layer of a sub layer.
(Inherited from ITGIS_Layer)
Path public Path to file holding the layer's data.
(Inherited from ITGIS_Layer)
PathFLD public Path to field definitions ini file.
PathFLDX public Path to field rules file.
PathRTree public Path to RTree index.
PathWithDriver public Path to file with the layer's 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 the selected shapes.
Statistics public Layer statistics engine
(Inherited from ITGIS_Layer)
Stream public Reference to a potential layer underlying the stream.
(Inherited from ITGIS_Layer)
SubLayers public List of sublayers belonging to the layer.
(Inherited from ITGIS_Layer)
SubType public Type of sublayer.
(Inherited from ITGIS_Layer)
SupportedDimensions public Set of dimensions supported by a layer.
SupportedShapes public Set of shapes supported by a layer.
SupportedShapesAll public Similar to SupportedShapesSet, but this lists also includes shape types added temporarily by the aggregator.
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 for the layer (0..100).
(Inherited from ITGIS_Layer)
UnSupportedOperations public Set of operations not supported by the layer.
(Inherited from ITGIS_Layer)
UseConfig public True if config file is active.
(Inherited from ITGIS_Layer)
UserObject public UserObject can be used to associate with the layer a user-defined object.
(Inherited from ITGIS_Layer)
UseRTree public Sets the use of an index based on RTree structure.
Viewer public Reference to a viewer object.
(Inherited from ITGIS_Layer)
ZOrder public Layer's position relative to other layers.
(Inherited from ITGIS_Layer)
ZOrderEx public Layer position relative to other visible 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 TGIS_Shape.GetField)

Field name Description
GIS_FIELD_AREA Same as TGIS_Shape.AreaCS or TGIS_Shape.Area 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 TGIS_Shape.Centroid).
GIS_FIELD_CENTROID_Y Y coordinate of a shape's centroid TGIS_Shape.Centroid).
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 TGIS_Shape.IsHidden
GIS_FIELD_LENGTH Same as TGIS_Shape.LengthCS or TGIS_Shape.Length if layer has no coordinate system assigned.
GIS_FIELD_MAX_X Maximum X coordinate of a shape. Same as XMax from TGIS_Shape.Extent.
GIS_FIELD_MAX_Y Maximum Y coordinate of a shape. Same as YMax from TGIS_Shape.Extent.
GIS_FIELD_MAX_M Maximum M coordinate of a 3D shape. Same as MMax from TGIS_Shape.Extent3D.
GIS_FIELD_MAX_Z Maximum Z coordinate of a 3D shape. Same as ZMax from TGIS_Shape.Extent3D.
GIS_FIELD_MIN_X Minimum X coordinate of a shape. Same as XMin from TGIS_Shape.Extent.
GIS_FIELD_MIN_Y Minimum Y coordinate of a shape. Same as YMin from TGIS_Shape.Extent.
GIS_FIELD_MIN_M Minimum M coordinate of a 3D shape. Same as MMin from TGIS_Shape.Extent3D.
GIS_FIELD_MIN_Z Minimum Z coordinate of a 3D shape. Same as ZMin from TGIS_Shape.Extent3D.
GIS_FIELD_NOW Current date & time.
GIS_FIELD_NUM_PARTS Same as TGIS_Shape.GetNumParts.
GIS_FIELD_NUM_POINTS Same as TGIS_Shape.GetNumPoints.
GIS_FIELD_SELECTED Same as TGIS_Shape.IsSelected.
GIS_FIELD_UID Same as TGIS_Shape.Uid.

References

2020/07/03 01:02