User Tools

Site Tools


api:dk11:python:tatukgis.pdk.tgis_layervector

TGIS_LayerVector class

DK11 for Python | tatukgis.pdk.TGIS_LayerVector | Classes | Constructors | Methods | Properties | Events

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

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

Syntax

# Python
class TGIS_LayerVector( tatukgis.pdk.TGIS_Layer ):

Inheritance

→ Object → TGIS_LayerAbstractTGIS_Layer

Constructors

Inherited Overrides Protected
Name Visibility Description
__init__ public Create layer.
(Overrides TGIS_Layer.__init__)

Methods

Inherited Overrides Protected
Name Visibility Description
AddField public Adds a new field.
AddFieldInternal(str, tatukgis.pdk.TGIS_FieldType, int, int) public Adds new field; for internal use.
AddFieldInternal(str, tatukgis.pdk.TGIS_FieldType, int, int, bool, int) public Adds new field; for internal use.
AddShape(tatukgis.pdk.TGIS_Shape) public Adds a copy of shape and makes it editable.
AddShape(tatukgis.pdk.TGIS_Shape, bool) public Adds a copy of shape and makes it editable.
Alive public Makes a layer non-dormant.
(Inherited from TGIS_Layer)
ApplyCuttingPolygon public Sets a cutting polygon for a layer.
(Inherited from TGIS_Layer)
Build(str, tatukgis.pdk.TGIS_Extent, tatukgis.pdk.TGIS_ShapeType) public Builds a new layer - prepares storage.
Build(str, tatukgis.pdk.TGIS_Extent, tatukgis.pdk.TGIS_ShapeType, tatukgis.pdk.TGIS_DimensionType) 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 TGIS_Layer)
ClearModified public Sets IsModified flag to false for a layer and its sublayers.
(Inherited from TGIS_Layer)
CreateShape(tatukgis.pdk.TGIS_ShapeType) public Creates a new shape and makes it editable.
CreateShape(tatukgis.pdk.TGIS_ShapeType, tatukgis.pdk.TGIS_DimensionType) public Creates a new shape and makes it editable
Delete public Deletes a shape.
DeleteField public Deletes a field.
Deselect public Clears selection of shape.
DeselectAll public Clears selection of all shapes.
Dormant public Makes a layer dormant.
(Inherited from TGIS_Layer)
DormantGain public Calculates the approximate gain (in Megabytes) which can be achieved by releasing memory by calling Dormant method.
(Inherited from TGIS_Layer)
Draw public Draws a layer.
(Inherited from TGIS_Layer)
DrawChart public Draws layer charts.
DrawEx public Draws a layer within a defined extent.
(Inherited from TGIS_Layer)
DrawFlash public Draws a flash.
(Inherited from TGIS_Layer)
DrawScope public Draws only shapes that meet a scope criterion.
DrawSelected public Draws only the selected item(s) on layer.
(Inherited from TGIS_Layer)
DrawSelectedEx public Draws only the selected item(s) on layer that are within a defined extent.
(Inherited from TGIS_Layer)
ExportLayer(tatukgis.pdk.TGIS_LayerVector, tatukgis.pdk.TGIS_Extent, tatukgis.pdk.TGIS_ShapeType, str, bool) public Exports the layer.
ExportLayer(tatukgis.pdk.TGIS_LayerVector, tatukgis.pdk.TGIS_Extent, tatukgis.pdk.TGIS_ShapeType, str, tatukgis.pdk.TGIS_Shape, str, bool) public Exports layer.
ExportLayerEx 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(tatukgis.pdk.TGIS_Extent) public Finds the first occurrence of an item which meets an extent.
FindFirst(tatukgis.pdk.TGIS_Extent, str) public Finds the first occurrence of an item which meets an extent and query.
FindFirst(tatukgis.pdk.TGIS_Extent, str, tatukgis.pdk.TGIS_Shape, str) public Finds the first occurrence of an item which meets an extent, query, and additional parameters.
FindFirst(tatukgis.pdk.TGIS_Extent, str, tatukgis.pdk.TGIS_Shape, str, bool) 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.
GetAvailableLayers public Gets a list of layers available in storage.
(Inherited from TGIS_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(TGIS_Uid) public Gets a shape by its unique identifier on default cursor (0).
GetShape(TGIS_Uid, int) 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 TGIS_Layer)
ImportLayer(tatukgis.pdk.TGIS_LayerVector, tatukgis.pdk.TGIS_Extent, tatukgis.pdk.TGIS_ShapeType, str, bool) public Imports a layer from an existing layer.
ImportLayer(tatukgis.pdk.TGIS_LayerVector, tatukgis.pdk.TGIS_Extent, tatukgis.pdk.TGIS_ShapeType, str, tatukgis.pdk.TGIS_Shape, str, bool) public Imports a layer from an existing layer.
ImportLayerEx 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 TGIS_Layer)
IsPixel public Checks if the layer type is pixel.
(Inherited from TGIS_Layer)
IsSupported public Checks if the operation is supported by the layer.
(Inherited from TGIS_Layer)
IsVector public Checks if the layer type is vector.
(Inherited from TGIS_Layer)
IsVector3D public Checks if the layer type is vector 3D.
(Inherited from TGIS_Layer)
IsVisible public Checks if the layer is visible in a defined extent and current params.
(Inherited from TGIS_Layer)
LegendInfo public Returns parameters filled with the renderer styling.
Locate(tatukgis.pdk.TGIS_Point, float) public Locates a shape.
Locate(tatukgis.pdk.TGIS_Point, float, bool) public Locates a shape.
LocateEx(tatukgis.pdk.TGIS_Point, float, TGIS_Uid, float, int, tatukgis.pdk.TGIS_Point) public Locates a shape (more precise).
LocateEx(tatukgis.pdk.TGIS_Point, float, TGIS_Uid, float, int, tatukgis.pdk.TGIS_Point, bool) public Locates a shape (more precise).
LocateEx(tatukgis.pdk.TGIS_Point, float, TGIS_Uid, float, int, tatukgis.pdk.TGIS_Point, float, bool) public Locates a shape (more precise).
Lock public Locks layer in burst-mode operation.
(Inherited from TGIS_Layer)
Loop public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop(tatukgis.pdk.TGIS_Extent) public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop(tatukgis.pdk.TGIS_Extent, str) public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop(tatukgis.pdk.TGIS_Extent, str, tatukgis.pdk.TGIS_Shape, str) public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop(tatukgis.pdk.TGIS_Extent, str, tatukgis.pdk.TGIS_Shape, str, bool) public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
MergeLayer(tatukgis.pdk.TGIS_LayerVector, tatukgis.pdk.TGIS_Extent, tatukgis.pdk.TGIS_ShapeType, str, bool, bool) public Merges layer from an existing layer.
MergeLayer(tatukgis.pdk.TGIS_LayerVector, tatukgis.pdk.TGIS_Extent, tatukgis.pdk.TGIS_ShapeType, str, tatukgis.pdk.TGIS_Shape, str, bool, bool) public Merges layer with an existing layer.
MergeLayerEx public Merges layer with an existing layer.
MergeStructure(tatukgis.pdk.TGIS_LayerVector, bool) public Merges the field structure from another layer.
MergeStructure(tatukgis.pdk.TGIS_LayerVector, bool, bool) public Merges the field structure from another layer.
Move public Moves a layer up or down in the viewer zorder list.
(Inherited from TGIS_Layer)
MoveEx public Moves a layer up or down in the viewer zorder list (only visible layers).
(Inherited from TGIS_Layer)
MustCalculateStatistics public Verifies if all statistics required to properly render the layer are available.
(Inherited from TGIS_Layer)
MustReproject public Checks if the layer must be reprojected.
(Inherited from TGIS_Layer)
MustSave public Checks if the layer was modified by editing.
(Inherited from TGIS_Layer)
Open public Opens the layer.
(Inherited from TGIS_Layer)
Paint public Draws the layer or fires PaintLayer event (if defined).
(Inherited from TGIS_Layer)
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 TGIS_Layer)
PrepareExportFieldNames(int) public Prepares field names to export.
PrepareExportFieldNames(int, bool) public Prepares field names to export.
PrepareExportFieldNames(int, bool, bool) public Prepares field names to export.
PreRecognize public Checks if the layer can read the file.
(Inherited from TGIS_Layer)
Project public Applies a projection on the single point.
(Inherited from TGIS_Layer)
Project3D public Applies a projection on the single point in 3D.
(Inherited from TGIS_Layer)
Project3D_Ref public Applies a projection on the single point in 3D.
(Inherited from TGIS_Layer)
ProjectExtent public Applies a projection on the extent.
(Inherited from TGIS_Layer)
Project_Ref public Applies a projection on the single point.
(Inherited from TGIS_Layer)
RaiseBusyEvent public Fires Busy event of the layer.
(Inherited from TGIS_Layer)
RaiseBusyPrepare public Fires BusyPrepare method of the assigned viewer.
(Inherited from TGIS_Layer)
RaiseBusyRelease public Fires BusyRelease method of the assigned viewer.
(Inherited from TGIS_Layer)
RaiseBusyShake public Fires BusyShake method of the assigned viewer.
(Inherited from TGIS_Layer)
ReadConfig public Reads the layer configuration files.
(Inherited from TGIS_Layer)
ReadConfigParam public Reads the layer configuration parameters.
(Inherited from TGIS_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 TGIS_Layer)
RecalcProjectedExtent public Recalculates a projected extent.
(Inherited from TGIS_Layer)
RenameField public Renames a field.
ReOpen public Reopens the layer.
(Inherited from TGIS_Layer)
RereadConfig public Rereads the layer configuration files.
(Inherited from TGIS_Layer)
Revert public Reverts a shape to its original state.
RevertAll public Reverts layer to its original content.
(Inherited from TGIS_Layer)
RevertShapes public Reverts all shapes to their original state.
RootLayer public Returns the absolute parent layer.
(Inherited from TGIS_Layer)
SaveAll public Saves layer and destroys mirrored items.
(Inherited from TGIS_Layer)
SaveData public Saves layer and destroys mirrored items.
(Inherited from TGIS_Layer)
SaveFieldRules public Save field rules file.
SetCSByEPSG public Sets up Coordinate System to a coordinate system provided by a EPSG code.
(Inherited from TGIS_Layer)
SetCSByWKT public Sets up Coordinate System to a coordinate system provided by a WKT string (GEOGCS or PROJCS).
(Inherited from TGIS_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 TGIS_Layer)
Unlock public Unlocks layer from burst-mode operation.
(Inherited from TGIS_Layer)
Unproject public Applies reverse projection (recovers from the projection) on the single point.
(Inherited from TGIS_Layer)
Unproject3D public Applies reverse projection (recovers from the projection) on the singlepoint in 3D.
(Inherited from TGIS_Layer)
Unproject3D_Ref public Applies reverse projection (recovers from the projection) on the single point in 3D.
(Inherited from TGIS_Layer)
UnprojectExtent public Applies reverse projection (recovers from the projection) on the extent.
(Inherited from TGIS_Layer)
Unproject_Ref public Applies reverse projection (recover from projection) on the single point.
(Inherited from TGIS_Layer)
ViewerReParent public Sets viewer for the layer and its sublayers.
(Inherited from TGIS_Layer)
WriteConfig public Writes layer configuration files.
(Inherited from TGIS_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 TGIS_Layer)
Addition public Additional value.
(Inherited from TGIS_Layer)
Age public Age of the layer (since its creation).
(Inherited from TGIS_Layer)
Basemap public True if the layer must be interpreted as basemap (for background painting).
(Inherited from TGIS_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 TGIS_Layer)
Caption public Caption of layer; if not filed directly then will be filed with Name when adding to the Viewer.
(Inherited from TGIS_Layer)
CodePage public Code Page in which text has been stored.
(Inherited from TGIS_Layer)
Collapsed public Checks if the layer is collapsed? Collapsed means only the layer's title will be visible inside the legend.
(Inherited from TGIS_Layer)
Comments public Additional user comments.
(Inherited from TGIS_Layer)
ConfigFile public Configuration file handle.
(Inherited from TGIS_Layer)
ConfigName public Configuration file name.
(Inherited from TGIS_Layer)
CS public Coordinate System that is assigned to the layer.
(Inherited from TGIS_Layer)
CustomData public List of custom, user-defined data.
(Inherited from TGIS_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 TGIS_Layer)
DormantMode public Dormant mode for the layer.
(Inherited from TGIS_Layer)
Driver public The layer's driver name.
(Inherited from TGIS_Layer)
DynamicAggregator public Aggregation processor is executed upon the drawing process.
Extent public Extent of the layer.
(Inherited from TGIS_Layer)
Extent3D public Three-dimensional extent of the layer.
(Inherited from TGIS_Layer)
Fields public List of database field definitions.
FieldsVirtual public List of virtual fields.
FileCopyrights public Copyright information about the layer.
(Inherited from TGIS_Layer)
FileInfo public Additional textual information about the layer such as compression, number of pixels, copyright, etc.
(Inherited from TGIS_Layer)
HideFromLegend public False if the layer should not be visible in legend.
(Inherited from TGIS_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 TGIS_Layer)
IsLocked public True if the layer is in locked state.
(Inherited from TGIS_Layer)
IsOpened public True if the layer is opened and is ready for operations.
(Inherited from TGIS_Layer)
IsPersistent public True if the layer is persistent.
(Inherited from TGIS_Layer)
IsReadOnly public True if the layer is read-only.
(Inherited from TGIS_Layer)
IsTopmost public True if the layer can be interpreted as the topmost (trackable) layer.
(Inherited from TGIS_Layer)
Items public A list of all ghost items.
JoinCodePage public Code page for JoinADO/JoinDB.
JoinDB public DB Query to be joined.
JoinDBAPI2 public DB-API 2.0 Cursor (e.g.
JoinForeign public Field from Query to be joined.
JoinPrimary public Field from feature table to be joined.
LabelingMode public Labeling mode metadata.
Layer3D public Mode of 3D operations
(Inherited from TGIS_Layer)
MaxTileSize public Maximum allowed tile size for the layer.
(Inherited from TGIS_Layer)
MultipassRendering public Forces multipass rendering.
MultiUserMode public Type of multiuser mode.
(Inherited from TGIS_Layer)
Name public Name of layer; if not filled directly, then will be filled with Path when added to the viewer.
(Inherited from TGIS_Layer)
Params public Returns parameters (colors, fills, etc.) object.
ParamsList public List of all parameter sections attached to the current layer.
(Inherited from TGIS_Layer)
ParentLayer public Parent layer of a sub layer.
(Inherited from TGIS_Layer)
Path public Path to file holding the layer's data.
(Inherited from TGIS_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 TGIS_Layer)
ProjectedExtent public Extent of the layer in projected units.
(Inherited from TGIS_Layer)
Renderer public Handle to a renderer used for drawing shapes.
(Inherited from TGIS_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 TGIS_Layer)
Stream public Reference to a potential layer underlying the stream.
(Inherited from TGIS_Layer)
SubLayers public List of sublayers belonging to the layer.
(Inherited from TGIS_Layer)
SubType public Type of sublayer.
(Inherited from TGIS_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 TGIS_Layer)
TagInternal public TagInternal has no predefined meaning.
(Inherited from TGIS_Layer)
TagPointer public TagPointer has no predefined meaning.
(Inherited from TGIS_Layer)
Transform public Custom transformation.
(Inherited from TGIS_Layer)
Transparency public Transparency value for the layer (0..100).
(Inherited from TGIS_Layer)
UnSupportedOperations public Set of operations not supported by the layer.
(Inherited from TGIS_Layer)
UseConfig public True if config file is active.
(Inherited from TGIS_Layer)
UserObject public UserObject can be used to associate with the layer a user-defined object.
(Inherited from TGIS_Layer)
UseRTree public Sets the use of an index based on RTree structure.
UseShapeStyleField public If true than params style attribute field was defined.
Viewer public Reference to a viewer object.
(Inherited from TGIS_Layer)
ZOrder public Layer's position relative to other layers.
(Inherited from TGIS_Layer)
ZOrderEx public Layer position relative to other visible layers.
(Inherited from TGIS_Layer)

Events

Inherited Protected
Name Visibility Description
CursorAfterFetchEvent published CursorAfterFetch event.
CursorBeforeFetchEvent published CursorBeforeFetch event.
CursorCloseEvent published CursorClose event.
CursorOpenEvent published CursorOpen event.
LabelPosEvent published LabelPos event.
PaintShapeChartEvent published PaintShapeChart event.
PaintShapeEvent published PaintShape event.
PaintShapeLabelEvent published PaintShapeLabel event.
ShapeFieldChangeEvent published ShapeFieldChange event.
ShapeGeometryChangeEvent published ShapeGeometryChange event.

References

2022/11/30 16:02

Page Tools