TGIS_LayerVector class

Abstract base class for vector layers managing collections of geometric shapes with spatial indexing, attribute fields, SQL-like queries, and coordinate transformations.

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

Syntax

// Java
public class TGIS_LayerVector extends TGIS_Layer {
};

// Oxygene
type
  TGIS_LayerVector = public class( TGIS_Layer )
  end;

Inheritance

→ TGIS_BaseObjectDisposable → TGIS_LayerAbstract → TGIS_Layer

Constructors

Inherited Overrides Protected

	Name	Visibility	Description
	TGIS_LayerVector()	public	Create a vector layer instance with default settings. _{(Overrides TGIS_Layer.TGIS_Layer())}
	TGIS_LayerVector(java.lang.String)	public	Creates a layer and sets the Path property. _{(Inherited from TGIS_Layer)}

Fields

Inherited Protected

Name	Visibility	Description
bIgnoreShapeParams	protected	Internal status of IgnoreShapeParams property.
cursorState	protected	Array containing the complete state for all active cursors.
cursorStateStore	protected	Stored cursor state array used to save and restore cursor contexts.
FActive	protected	True if the layer is active. _{(Inherited from TGIS_Layer)}
FAddition	protected	Additional integer value. _{(Inherited from TGIS_Layer)}
FAge	protected	Layer age or last modification timestamp. _{(Inherited from TGIS_Layer)}
FBasemap	protected	True if the layer is interpreted as a basemap. _{(Inherited from TGIS_Layer)}
FBasemapDraw	protected	True if the layer is currently being drawn inside a basemap thread. _{(Inherited from TGIS_Layer)}
FBlockRTree	protected	True if the R-Tree spatial index cannot be enabled.
FCachedPaint	protected	False if layer must be painted directly (bypassing cache). _{(Inherited from TGIS_Layer)}
FCaption	protected	Layer caption. _{(Inherited from TGIS_Layer)}
FCodePage	protected	Code page in which text is stored. _{(Inherited from TGIS_Layer)}
FCodePageForced	protected	Code page forced by the project file or property setting. _{(Inherited from TGIS_Layer)}
FCollapsed	protected	True if the layer is collapsed in the legend hierarchy. _{(Inherited from TGIS_Layer)}
FComments	protected	Additional comments. _{(Inherited from TGIS_Layer)}
FConfigFile	protected	Configuration file handle. _{(Inherited from TGIS_Layer)}
FConfigFile2	protected	Configuration file handle. _{(Inherited from TGIS_Layer)}
FConfigName	protected	Configuration file name. _{(Inherited from TGIS_Layer)}
FCS	protected	Layer CRS (Coordinate Reference System) object. _{(Inherited from TGIS_Layer)}
FCustomData	protected	List of custom data. _{(Inherited from TGIS_Layer)}
FDormantMode	protected	Dormant mode for the layer. _{(Inherited from TGIS_Layer)}
FDriver	protected	Layer driver. _{(Inherited from TGIS_Layer)}
FExtent	protected	Layer extent. _{(Inherited from TGIS_Layer)}
FExtent3D	protected	Three-dimensional layer extent. _{(Inherited from TGIS_Layer)}
FFileCopyright	protected	Additional textual information about layer copyright. _{(Inherited from TGIS_Layer)}
FFileInfo	protected	Additional textual information about the layer, such as compression, pixel count, and copyright. _{(Inherited from TGIS_Layer)}
FGUID	protected	Unique layer identifier. _{(Inherited from TGIS_Layer)}
FHideFromLegend	protected	True if layer should not be visible in a legend. _{(Inherited from TGIS_Layer)}
FIcon	protected	Layer icon displayed in the legend. _{(Inherited from TGIS_Layer)}
findSmartSizeFactor	protected	SmartSize scaling factor used to scale between projected and unprojected sizes.
FInMemoryRTree	protected	True if the R-Tree spatial index file is created in memory.
FInPaint	protected	True while the layer is in the paint process. _{(Inherited from TGIS_Layer)}
FIsLocked	protected	True if the layer is in the locked state. _{(Inherited from TGIS_Layer)}
FIsModified	protected	True if the layer structure or geometry has been modified. _{(Inherited from TGIS_Layer)}
FIsOpened	protected	True if the layer has been opened. _{(Inherited from TGIS_Layer)}
FIsPrepared	protected	True if the layer has been prepared. _{(Inherited from TGIS_Layer)}
FIsReadOnly	protected	Read-only flag. _{(Inherited from TGIS_Layer)}
FMaxTileSize	protected	Maximum allowed tile size for the layer. _{(Inherited from TGIS_Layer)}
FMultiUserMode	protected	Multiuser mode. _{(Inherited from TGIS_Layer)}
FName	protected	Layer name. _{(Inherited from TGIS_Layer)}
FOnBusy	protected	Busy event fired regularly during long-running operations. _{(Inherited from TGIS_Layer)}
FOnCursorAfterFetch	protected	CursorAfterFetch event fired after data is fetched by CursorFirst.
FOnCursorBeforeFetch	protected	CursorBeforeFetch event fired before data is fetched by CursorFirst.
FOnCursorClose	protected	CursorClose event fired when a cursor is closed.
FOnCursorInterrupt	protected	CursorInterrupt event fired after cursor reading is interrupted.
FOnCursorOpen	protected	CursorOpen event fired when a cursor is opened.
FOnCursorShapeFetch	protected	CursorShapeFetch event fired after a shape is fetched.
FOnLabelPos	protected	ShapeLabelPos event fired before label placement is finalized.
FOnPaintLayer	protected	PaintLayer event fired during Paint and related drawing operations. _{(Inherited from TGIS_Layer)}
FOnPaintShape	protected	PaintShape event fired during TGIS_Shape.Paint for each rendered shape.
FOnPaintShapeChart	protected	PaintShapeChart event fired during TGIS_Shape.PaintChart for each rendered chart.
FOnPaintShapeLabel	protected	PaintShapeLabel event fired during TGIS_Shape.PaintLabel for each rendered label.
FOnPassword	protected	Fired when opening a layer to resolve required user name or password values. _{(Inherited from TGIS_Layer)}
FOnRead	protected	Fired for each file read request. _{(Inherited from TGIS_Layer)}
FOnShapeFieldChange	protected	ShapeFieldChange event fired after a shape field value changes.
FOnShapeGeometryChange	protected	ShapeGeometryChange event fired after shape geometry changes.
FOnWrite	protected	Fired for each file write request. _{(Inherited from TGIS_Layer)}
forceCachedMode	protected	Set to True to force cached bitmap drawing. _{(Inherited from TGIS_Layer)}
FOverlappedExtentMargin	protected	Overlapped extent margin. _{(Inherited from TGIS_Layer)}
FParamsList	protected	List of parameter sets grouped by section. _{(Inherited from TGIS_Layer)}
FParentLayer	protected	Parent layer. _{(Inherited from TGIS_Layer)}
FPath	protected	Layer path. _{(Inherited from TGIS_Layer)}
FPixelsPerInch	protected	Pixel density used to avoid improper ZoomEx behavior on ggdPrinter and similar devices.
FProjectedExtent	protected	Cached projected extent. _{(Inherited from TGIS_Layer)}
FProjectedExtentBase	protected	Cached projected extent base extent in unprojected layer coordinates. _{(Inherited from TGIS_Layer)}
FProjectedExtentEPSG	protected	Cached projected extent layer CRS (Coordinate Reference System) context. _{(Inherited from TGIS_Layer)}
FProjectedExtentRotationAngle	protected	Cached projected extent rotation angle context. _{(Inherited from TGIS_Layer)}
FProjectedExtentRotationPoint	protected	Cached projected extent rotation point context. _{(Inherited from TGIS_Layer)}
FProjectedExtentViewerEPSG	protected	Cached projected extent viewer CRS (Coordinate Reference System) context. _{(Inherited from TGIS_Layer)}
FRenderer	protected	Handle to a renderer used for drawing shapes. _{(Inherited from TGIS_Layer)}
FRTreeFile	protected	R-Tree-based spatial index.
FSelectedList	protected	List of uids of selected shapes.
FStatistics	protected	Statistics engine. _{(Inherited from TGIS_Layer)}
FStream	protected	Reference to a potential layer underlying stream. _{(Inherited from TGIS_Layer)}
FSubLayers	protected	Sublayer list. _{(Inherited from TGIS_Layer)}
FSubType	protected	Sublayer type flags for this layer. _{(Inherited from TGIS_Layer)}
FSupportedDimensions	protected	Set of dimensions supported by a layer.
FSupportedShapes	protected	Set of shapes supported by a layer.
FSupportsAsync	protected	Indicates whether the layer implements asynchronous operations. _{(Inherited from TGIS_Layer)}
FSupportsAutoStyle	protected	Indicates whether the layer supports auto styling. _{(Inherited from TGIS_Layer)}
FSupportsTiledPaint	protected	Indicates whether the layer supports tiled paint. _{(Inherited from TGIS_Layer)}
FTag	protected	Tag value. _{(Inherited from TGIS_Layer)}
FTagInternal	protected	Internal Tag value. _{(Inherited from TGIS_Layer)}
FTagPointer	protected	Pointer tag value. _{(Inherited from TGIS_Layer)}
FTileable	protected	True if the layer is currently printed or exported using tiles. _{(Inherited from TGIS_Layer)}
FTiledDrawMode	protected	Current tiled draw mode used while drawing in a basemap thread. _{(Inherited from TGIS_Layer)}
FTransform	protected	Custom transformation. _{(Inherited from TGIS_Layer)}
FTransparency	protected	Transparency value. _{(Inherited from TGIS_Layer)}
FUnSupportedOperations	protected	Set of operations not supported by the layer. _{(Inherited from TGIS_Layer)}
FUseConfig	protected	True if configuration file support is enabled. _{(Inherited from TGIS_Layer)}
FUserObject	protected	User object owned by the layer and destroyed when the layer is destroyed or when replaced. _{(Inherited from TGIS_Layer)}
FUseRTree	protected	True if the R-Tree spatial index is enabled.
FViewer	protected	Reference to viewer object. _{(Inherited from TGIS_Layer)}
inDraw	protected	True while layer drawing is still in progress to avoid circular drawing calls. _{(Inherited from TGIS_Layer)}
oldMarkerPoint	protected	Old marker point screen coordinates (to filter drawing points).
paramsCache	protected	List of prepared parameters. _{(Inherited from TGIS_Layer)}
paramsCacheUpdated	protected	True if cached parameters are ready for rendering. _{(Inherited from TGIS_Layer)}
View3D	public	3D representation settings for the layer. _{(Inherited from TGIS_Layer)}

Methods

Inherited Overrides Protected

Name	Visibility	Description
AddField	public	Adds a new attribute field definition to the layer schema.
AddFieldInternal(java.lang.String, TGIS_FieldType, int, int)	public	Adds a new field definition using internal layer-loading logic.
AddFieldInternal(java.lang.String, TGIS_FieldType, int, int, bool, int)	public	Adds a new field definition using internal layer-loading logic.
AddShape(TGIS_Shape)	public	Adds a shape to the layer by creating an editable copy of its geometry without copying attribute values.
AddShape(TGIS_Shape, bool)	public	Adds a shape to the layer by creating an editable copy, optionally copying attribute fields and values from the source shape.
Alive	public	Makes a layer non-dormant. _{(Inherited from TGIS_Layer)}
ApplyAutoStyle	public	Applies auto-styling to the layer. _{(Inherited from TGIS_Layer)}
ApplyAutoStyle(bool)	public	Applies auto-styling to the layer. _{(Inherited from TGIS_Layer)}
applyConfigOptions	protected	Applies layer option settings from a configuration file. _{(Overrides TGIS_Layer.applyConfigOptions)}
applyConfigProjection(TGIS_ConfigAbstract)	protected	Applies projection settings from a configuration file. _{(Inherited from TGIS_Layer)}
applyConfigProjection(TGIS_ConfigAbstract, TGIS_Layer)	protected	Applies projection settings from a configuration file. _{(Inherited from TGIS_Layer)}
ApplyCuttingPolygon	public	Sets a clipping polygon for the layer. _{(Inherited from TGIS_Layer)}
bindField	protected	Obtain the bind index for a field name.
bindFieldInternal	protected	Obtain the bind index for a field name.
BindSqlQueryInternal	public	Binds the layer to an internal SQL query object used for attribute field access.
Build(java.lang.String, TGIS_Extent, TGIS_ShapeType)	public	Create and initialize layer storage with the specified shape type and extent using the layer default dimensionality.
Build(java.lang.String, TGIS_Extent, TGIS_ShapeType, TGIS_DimensionType)	public	Create and initialize layer storage with an explicit coordinate dimensionality.
CentroidScope	public	Calculates the centroid point for the first shape matching a SQL (Structured Query Language) WHERE clause, or returns a fallback point if no shape matches.
ChangeHash	public	Changes the hash used to verify layer modifications. _{(Inherited from TGIS_Layer)}
checkParamsCache	protected	Check whether a shape passes cached visibility criteria for rendering.
ClearModified	public	Sets IsModified flag to false for a layer and its sublayers. _{(Inherited from TGIS_Layer)}
CreateShape(TGIS_ShapeClass)	public	Creates a new editable shape instance from the specified TGIS_Shape descendant class.
CreateShape(TGIS_ShapeType)	public	Creates a new empty shape with the specified geometry type by using the layer's default coordinate dimensionality.
CreateShape(TGIS_ShapeType, TGIS_DimensionType)	public	Creates a new empty shape with the specified geometry type and coordinate dimensionality.
cursorClose	protected	Release a cursor and free its associated resources.
cursorEof	protected	Test whether the cursor has reached the end of the current iteration result set.
cursorEofInternal	protected	Internal variant of cursorEof.
cursorFindFirst	protected	Find the first shape matching extent, query, and DE-9IM spatial predicate filters and return it directly.
cursorFindNext	protected	Return the next shape matching the criteria established by cursorFindFirst().
cursorFinish	protected	Complete cursor processing and release resources associated with the cursor.
cursorFirst	protected	Initialize a cursor to the first shape matching extent, query, and DE-9IM spatial predicate filters.
cursorFirstInternal	protected	Internal variant of cursorFirst.
cursorInterrupt	protected	Interrupt the current cursor operation before normal completion.
cursorNext	protected	Advance the cursor to the next shape matching the current filter criteria.
cursorNextInternal	protected	Internal variant of cursorNext.
cursorOpen	protected	Allocates and initializes a new cursor for vector-layer iteration.
cursorShape	protected	Return the shape at the current cursor position.
cursorShapeEx	protected	Return the current shape using an extended access path for specialized layer implementations.
cursorShapeInternal	protected	Internal variant of cursorShape.
cursorStateRestore	protected	Restore the cursor to the most recently saved state.
cursorStateSave	protected	Save the current cursor state for later restoration during nested iteration.
Delete	public	Marks a shape as deleted so it is skipped by drawing and queries while retaining enough state to restore it before changes are saved.
DeleteField	public	Deletes a field from the layer schema.
Deselect	public	Deselects a single shape and removes it from the layer's selected shape set.
DeselectAll	public	Clears the selection state of all shapes in the layer.
doApplyAutoStyle	protected	Applies layer-specific auto-styling implementation. _{(Overrides TGIS_Layer.doApplyAutoStyle)}
Dormant	public	Makes a layer dormant. _{(Inherited from TGIS_Layer)}
DormantGain	public	Calculates the approximate memory gain in megabytes that can be achieved by calling Dormant. _{(Inherited from TGIS_Layer)}
Draw	public	Draws a layer. _{(Inherited from TGIS_Layer)}
DrawChart	public	Renders all charts for the layer without redrawing full shape geometry.
DrawEx	public	Draws a layer within a defined extent. _{(Overrides TGIS_Layer.DrawEx)}
drawExtent	protected	Calculates the device drawing and clipping area. _{(Inherited from TGIS_Layer)}
drawExtentEx	protected	Calculates the device drawing and clipping area. _{(Inherited from TGIS_Layer)}
DrawFlash	public	Renders all queued flashing shapes. _{(Overrides TGIS_Layer.DrawFlash)}
DrawLabel	public	Renders layer labels without redrawing full shape geometry.
DrawScope	public	Renders shapes that match a SQL WHERE clause using the specified style.
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. _{(Overrides TGIS_Layer.DrawSelectedEx)}
DrawSpecial	public	Performs custom rendering by delegating drawing to a specialized renderer object. _{(Overrides TGIS_Layer.DrawSpecial)}
ExportLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, bool)	public	Copy a subset of this layer to another layer using spatial and SQL filtering.
ExportLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, TGIS_Shape, java.lang.String, bool)	public	Export shapes with spatial and topological relationship filtering.
ExportLayerEx	public	Virtual export method with spatial and topological relationship filtering.
ExportStructureToFLD	public	Export the layer field schema to an FLD field-definition file.
FieldInfo	public	Returns metadata for the field at the specified zero-based index.
FinalizeDirectWrite	public	Finalize an active direct-write session and complete the target layer storage.
FinalizeRead	public	Finalize reading state and release active query and cursor resources associated with the layer.
FindField	public	Finds a field index by name in the layer's field schema.
FindFieldInternal	public	Internal field lookup using the saved storage field name.
FindFirst	public	Initiates iteration by finding the first shape in the layer, with optional R-Tree spatial acceleration, and prepares cursor state for subsequent FindNext calls.
FindFirst(TGIS_Extent)	public	Finds the first shape whose geometry intersects the specified extent, using an R-Tree spatial index when available.
FindFirst(TGIS_Extent, java.lang.String)	public	Finds the first shape that matches both the specified spatial extent and the SQL-like attribute query, using an R-Tree index when available.
FindFirst(TGIS_Extent, java.lang.String, TGIS_Shape, java.lang.String)	public	Finds the first shape that matches the specified spatial extent, SQL-like attribute query, and DE-9IM topological relation.
FindFirst(TGIS_Extent, java.lang.String, TGIS_Shape, java.lang.String, bool)	public	Finds the first shape that matches the specified spatial extent, SQL-like attribute query, DE-9IM topological relation, and deleted- item visibility setting.
FindNext	public	Retrieves the next shape from the active FindFirst query cursor and continues iteration over shapes matching the original criteria.
FlashShape	public	Flashes a shape to visually highlight it for user feedback.
ForEach	public	Iterates shapes matching complex criteria and invokes a callback for each shape with rendering parameters prepared.
ForEachSubLayer	public	Calls the callback for the layer and all of its sublayers. _{(Inherited from TGIS_Layer)}
GetAvailableLayers	public	Gets a list of layers available in storage. _{(Overrides TGIS_Layer.GetAvailableLayers)}
getBindedField	protected	Get a field value for a shape using a bound field identifier.
getBindedFieldInternal	protected	Get a field value for a shape using a bound field identifier.
getEdited	protected	Get the editable in-memory mirror of a shape when available.
GetField	public	Retrieves an attribute field value for a shape by its unique identifier, converting SQL NULL values to the field default value.
GetFieldEx	public	Retrieves an attribute field value for a shape by unique identifier, preserving SQL NULL values unchanged.
getFieldInternal	protected	Get the stored field value for a shape identified by unique identifier.
GetLastUid	public	Gets the highest unique identifier (UID) currently present in the layer.
GetNewUid	public	Allocates the next available unique identifier (UID) for a new shape.
GetSelectedCount	public	Returns the number of shapes currently selected in this layer.
GetShape(long)	public	Retrieves a shape by its unique identifier (UID) using the default cursor (0).
GetShape(long, int)	public	Retrieves a shape by its unique identifier (UID) using the specified cursor context.
getShapePos	protected	Locate a shape by its unique identifier using binary search.
getStatistics	protected	Calculate an aggregate value for a field using the specified function.
GetSubLayer	public	Retrieves the layer identified by name. _{(Inherited from TGIS_Layer)}
GetUniqueFieldName	public	Returns a unique field name that does not conflict with the current layer schema.
HourglassShake	public	Notifies about a busy state using an hourglass. _{(Inherited from TGIS_Layer)}
ImportLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, bool)	public	Import shapes from another vector layer, optionally filtered by extent, target geometry type, and SQL (Structured Query Language) WHERE clause.
ImportLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, TGIS_Shape, java.lang.String, bool)	public	Import shapes with spatial and topological relationship filtering.
ImportLayerEx	public	Virtual import method with spatial and topological filtering.
ImportStructure	public	Copies the complete attribute field schema from another vector layer, replacing this layer's existing field definitions.
InitializeDirectWrite	public	Prepare layer storage for direct streaming writes during high- volume bulk import operations.
InvalidateScope	public	Invalidates shapes matching a SQL WHERE clause so they are redrawn with the specified style.
InvalidateSelection	public	Invalidates the visual selection state for all currently selected shapes.
IsGrid	public	Checks if the layer type is grid. _{(Inherited from TGIS_Layer)}
isInScope	protected	Test whether a shape is inside the current cursor scope.
IsPixel	public	Checks if the layer type is pixel. _{(Inherited from TGIS_Layer)}
isSectionInVisibilityRange	protected	Checks whether the section is visible by testing layer properties: Level with MinLevel/MaxLevel, ScaleAsFloat with MinScale/MaxScale, and Zoom with MinZoom/MaxZoom. _{(Inherited from TGIS_Layer)}
isShapeVisible	protected	Test whether a shape is visible within the specified extent.
isSublayer	protected	Checks if the layer is a sublayer. _{(Inherited from TGIS_Layer)}
IsSupported	public	Checks if the operation is supported by the layer. _{(Inherited from TGIS_Layer)}
IsTopology	public	Checks if the layer type is topology. _{(Inherited from TGIS_Layer)}
IsVector	public	Checks if the layer type is vector. _{(Overrides TGIS_Layer.IsVector)}
IsVector3D	public	Checks if the layer type is vector 3D. _{(Overrides TGIS_Layer.IsVector3D)}
IsVisible	public	Checks if the layer is visible in a defined extent and current params. _{(Inherited from TGIS_Layer)}
LegendInfo(int, int, TGIS_ParamsSectionVector)	public	Retrieves rendering parameters for a specific legend section and zone identifier.
LegendInfo(int, TGIS_ParamsSectionVector)	public	Deprecated legend-information overload that retrieves styling parameters for a legend zone.
legendRender	protected	Prepare legend styling for the specified renderer section.
Locate(TGIS_Point, double)	public	Locates the nearest shape to a reference point within the specified tolerance distance.
Locate(TGIS_Point, double, bool)	public	Locates the nearest shape to a reference point within the specified tolerance distance, optionally limited to visible shapes.
LocateEx(TGIS_Point, double, long, double, int, TGIS_Point)	public	Locates the nearest shape and returns additional hit-test details, including distance, part index, and projected point.
LocateEx(TGIS_Point, double, long, double, int, TGIS_Point, bool)	public	Locates the nearest shape and returns additional hit-test details, with optional filtering to visible shapes only.
LocateEx(TGIS_Point, double, long, double, int, TGIS_Point, double, bool)	public	Locates the nearest shape and returns raw and preference-adjusted hit-test distances together with part and projection details.
Lock	public	Locks the layer for burst-mode operation. _{(Inherited from TGIS_Layer)}
lockRender	protected	Lock the rendering context and prepare colors and sizes for shape rendering.
LockRenderInternal	public	Lock layer rendering for bulk load operations.
lockThread	protected	Locks the layer thread. _{(Inherited from TGIS_Layer)}
Loop	public	Creates an enumerator factory for traversing all shapes in the layer by using Delphi for..in syntax or manual enumerator access.
Loop(TGIS_Extent)	public	Creates an enumerator factory for shapes intersecting the specified extent, using an R-Tree spatial index when available.
Loop(TGIS_Extent, java.lang.String)	public	Creates an enumerator factory for shapes matching both the specified extent and the SQL-like attribute query.
Loop(TGIS_Extent, java.lang.String, TGIS_Shape, java.lang.String)	public	Creates an enumerator factory for shapes matching the specified extent, SQL-like attribute query, and DE9IM topological relation.
Loop(TGIS_Extent, java.lang.String, TGIS_Shape, java.lang.String, bool)	public	Creates an enumerator factory for shapes matching the specified extent, SQL-like attribute query, DE9IM relation, and deleted-item visibility setting.
MarkModified	public	Sets IsModified flag to true for a layer and its sublayers. _{(Inherited from TGIS_Layer)}
MergeLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, bool, bool)	public	Merge shapes from another layer while preserving attribute data and checking field schema compatibility.
MergeLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, TGIS_Shape, java.lang.String, bool, bool)	public	Merge shapes with attribute data and topological relationship filtering.
MergeLayerEx	public	Virtual merge method with attribute preservation, schema checking, and optional topological filtering.
MergeStructure(TGIS_LayerVector, bool)	public	Merge field definitions from another layer into this layer without removing existing fields.
MergeStructure(TGIS_LayerVector, bool, bool)	public	Merge field definitions from another layer with control over whether export names or internal names are used.
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 whether all statistics required to render the layer are available. _{(Overrides TGIS_Layer.MustCalculateStatistics)}
MustReproject	public	Checks whether the layer must be reprojected. _{(Inherited from TGIS_Layer)}
MustSave	public	Checks whether the layer was modified by editing. _{(Overrides TGIS_Layer.MustSave)}
nextCandidate	protected	Retrieve the next candidate shape from the prepared candidate list.
Open	public	Opens the layer. _{(Inherited from TGIS_Layer)}
optimizeParamsCache(int)	protected	Moves the specified section to the top of the cached list. _{(Inherited from TGIS_Layer)}
optimizeParamsCache(int, bool)	protected	Moves the specified section to the top of the cached list. _{(Inherited from TGIS_Layer)}
Paint	public	Draws the layer or fires PaintLayer event (if defined). _{(Inherited from TGIS_Layer)}
ParamsAsDrawn	public	Retrieves the effective rendering parameters currently used to draw a specific shape.
Prepare	public	Opens the layer for non-drawing operations. _{(Inherited from TGIS_Layer)}
prepareCandidates	protected	Build the candidate shape list used for cursor scope evaluation.
PrepareExportFieldNames(int)	public	Prepares field names for export to a target format with limited field-name length.
PrepareExportFieldNames(int, bool)	public	Prepares field names for export and controls whether all fields or only new fields are processed.
PrepareExportFieldNames(int, bool, bool)	public	Prepares field names for export with optional uppercase conversion.
PrepareExportFieldNames(int, bool, bool, bool)	public	Prepares field names for export with optional uppercase conversion and strict SQL (Structured Query Language)-safe naming.
PrepareForExport	public	Prepares layer for export. _{(Inherited from TGIS_Layer)}
PrepareParams	public	Prepares cached rendering parameters for internal use. _{(Inherited from TGIS_Layer)}
prepareParamsCache	protected	Prepares the cached section list for rendering. _{(Inherited from TGIS_Layer)}
prepareParamsCache(java.lang.String)	protected	Prepares the cached section list for the specified style. _{(Inherited from TGIS_Layer)}
prepareRender	protected	Compute rendering colors and sizes for a shape using automatic renderer rules.
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 projection to a single 3D point. _{(Inherited from TGIS_Layer)}
ProjectExtent	public	Applies a projection on the extent. _{(Inherited from TGIS_Layer)}
Project_Ref	public	Applies projection to a single point. _{(Inherited from TGIS_Layer)}
queueFlash	protected	Add a shape to the flash queue used for temporary visual highlighting.
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 a layer configuration parameter. _{(Inherited from TGIS_Layer)}
ReadFieldDefinition	public	Read the layer field-definition file and rebuild the field schema.
ReadFieldRules	public	Load field validation rules and related constraints from the FLD rules file associated with the layer.
RecalcExtent	public	Recalculates the layer extent from the shapes currently considered by the layer. _{(Overrides TGIS_Layer.RecalcExtent)}
RecalcProjectedExtent	public	Recalculates the projected extent. _{(Inherited from TGIS_Layer)}
releaseFlash	protected	Remove a shape from the flash queue used for temporary visual highlighting.
removeCandidate	protected	Remove a shape from the current cursor candidate list.
RenameField	public	Renames an existing field and can update its width and decimal settings.
ReOpen	public	Reopens the layer. _{(Inherited from TGIS_Layer)}
ReorderShapeUids	public	Rebuild shape UIDs to restore ascending consecutive order after the Items list has been reordered.
RereadConfig	public	Rereads the layer configuration files. _{(Inherited from TGIS_Layer)}
resetMustReproject	protected	Resets the MustReproject state. _{(Inherited from TGIS_Layer)}
Revert	public	Reverts a single shape to its last saved state, undoing pending geometry and attribute edits for that shape.
RevertAll	public	Reverts layer to its original content. _{(Overrides TGIS_Layer.RevertAll)}
RevertShapes	public	Reverts all shapes in the layer to their last saved state and discards all pending shape-level edits.
RootLayer	public	Returns the absolute parent layer. _{(Inherited from TGIS_Layer)}
SaveAll	public	Saves the layer and destroys mirrored items. _{(Inherited from TGIS_Layer)}
SaveData	public	Saves layer and destroys mirrored items. _{(Overrides TGIS_Layer.SaveData)}
SaveFieldRules	public	Save field validation rules and related constraints to the FLD rules file associated with the layer.
SetCSByEPSG	public	Sets the coordinate system using an EPSG code. _{(Inherited from TGIS_Layer)}
SetCSByWKT	public	Sets the coordinate system from a WKT (Well-Known Text) string containing a GEOGCS or PROJCS definition. _{(Inherited from TGIS_Layer)}
SetCSByWKTFile	public	Sets the coordinate system from a file containing a WKT (Well-Known Text) string, such as a Shapefile .PRJ file. _{(Inherited from TGIS_Layer)}
setUp	protected	Performs the first general layer setup step. _{(Overrides TGIS_Layer.setUp)}
setUp2	protected	Performs the second general layer setup step. _{(Overrides TGIS_Layer.setUp2)}
setUp3	protected	Performs the third general layer setup step. _{(Overrides TGIS_Layer.setUp3)}
storeConfigOptions	protected	Stores layer option settings in a configuration file. _{(Overrides TGIS_Layer.storeConfigOptions)}
transformExtent	protected	Transforms an extent using the custom transformation. _{(Inherited from TGIS_Layer)}
Unlock	public	Unlocks the layer from burst-mode operation. _{(Inherited from TGIS_Layer)}
unlockRender	protected	Release the rendering lock acquired by lockRender().
UnlockRenderInternal	public	Unlock layer rendering and resume cache updates after batch operations.
unlockThread	protected	Unlocks the layer thread. _{(Inherited from TGIS_Layer)}
UnprepareForExport	public	Finalizes export initialized with PrepareForExport. _{(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 to a single 3D point. _{(Inherited from TGIS_Layer)}
Unproject3D_Ref	public	Applies reverse projection to a single 3D point. _{(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 to a single point. _{(Inherited from TGIS_Layer)}
ViewerReParent	public	Sets the viewer for the layer and its sublayers. _{(Inherited from TGIS_Layer)}
WriteConfig	public	Writes the layer configuration files. _{(Inherited from TGIS_Layer)}
WriteShapeDirect	public	Writes a shape directly to persistent storage without adding it to the in-memory layer collection.

Properties

Inherited Protected

Name	Visibility	Description
Active	public	True if the layer is visible and can be localized. _{(Inherited from TGIS_Layer)}
Addition	public	Additional blending value. _{(Inherited from TGIS_Layer)}
Age	public	Time elapsed since the layer was created. _{(Inherited from TGIS_Layer)}
Basemap	public	True if the layer must be treated as a basemap for background painting. _{(Inherited from TGIS_Layer)}
BasemapDraw	public	True if the layer is currently being drawn in a basemap thread. _{(Inherited from TGIS_Layer)}
BlockRTree	public	Blocks use of the R-Tree spatial index for this layer even when UseRTree is enabled.
CachedPaint	public	False if the layer must be painted directly, bypassing the cache. _{(Inherited from TGIS_Layer)}
Caption	public	Layer caption; if not assigned directly, it will be filled with Name when the layer is added to the viewer. _{(Inherited from TGIS_Layer)}
CodePage	public	Code page used to store text. _{(Inherited from TGIS_Layer)}
Collapsed	public	True if the layer is collapsed in the legend, meaning only the layer title is visible. _{(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 Reference System (CRS) assigned to the layer. _{(Inherited from TGIS_Layer)}
CustomData	public	List of custom, user-defined data saved to and restored from config and project files. _{(Inherited from TGIS_Layer)}
DefaultDimension	public	Default coordinate dimensionality used by CreateShape when no explicit dimension is provided.
DefaultShapeType	public	Default geometry type used by CreateShape when no explicit shape type is provided.
DirectMode	public	True if the layer is direct-mode (bypassing cache). _{(Inherited from TGIS_Layer)}
DormantMode	public	Memory-management mode for the layer. _{(Inherited from TGIS_Layer)}
Driver	public	The layer's driver name. _{(Inherited from TGIS_Layer)}
DynamicAggregator	public	Dynamic aggregation processor used to cluster, bin, or otherwise aggregate shapes during rendering of large vector datasets.
Extent	public	Extent of the layer. _{(Inherited from TGIS_Layer)}
Extent3D	public	Three-dimensional extent of the layer. _{(Inherited from TGIS_Layer)}
Fields	public	Collection of attribute field definitions for shapes stored in the vector layer.
FieldsVirtual	public	Collection of virtual field definitions generated by the framework for computed or synthetic attribute values.
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)}
GUID	public	Unique layer identifier. _{(Inherited from TGIS_Layer)}
HideFromLegend	public	False if the layer should not be visible in the legend. _{(Inherited from TGIS_Layer)}
Icon	public	Layer icon presented in the legend. _{(Inherited from TGIS_Layer)}
IgnoreShapeParams	public	Forces uniform layer-level rendering style and ignores per-shape rendering parameter overrides.
InMemoryRTree	public	Controls whether the layer uses an in-memory R-Tree spatial index instead of a file-based one.
InPaint	public	True while the layer is being painted. _{(Inherited from TGIS_Layer)}
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)}
IsModified	public	True if structure (field, geometry etc) was modified. _{(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	In-memory collection of editable shapes pending persistence to the underlying layer storage.
JoinADO	public	ADO query object or recordset to be joined with the layer.
JoinCodePage	public	Code page used to decode text fields from JoinADO or JoinDB external data sources.
JoinDB	public	Dataset to be joined with the layer as an external attribute source.
JoinForeign	public	Foreign key field from the external join source used to match records with JoinPrimary.
JoinJDBC	public	JDBC ResultSet containing external query rows to be joined with the layer.
JoinJDBCQuery	public	JDBC query text used to retrieve external rows for joining with the layer.
JoinPrimary	public	Primary key field from the layer's attribute table used to match external records through JoinForeign.
LabelingMode	public	Labeling mode capability flag for the layer.
Layer3D	public	Mode of 3D layer operations. _{(Inherited from TGIS_Layer)}
MaxTileSize	public	Maximum allowed tile size for the layer. _{(Inherited from TGIS_Layer)}
MultipassRendering	public	Forces multi-pass rendering instead of single-pass optimization to preserve rendering order and improve output quality for complex symbol layers.
MultiUserMode	public	Multiuser access mode for the layer. _{(Inherited from TGIS_Layer)}
Name	public	Layer name. _{(Inherited from TGIS_Layer)}
OverlappedExtentMargin	public	Overlap margin applied to the layer extent. _{(Inherited from TGIS_Layer)}
Params	public	Returns the vector rendering parameters object for the layer.
ParamsList	public	List of all parameter sections attached to the current layer. _{(Inherited from TGIS_Layer)}
ParentLayer	public	Parent layer of a sublayer. _{(Inherited from TGIS_Layer)}
Path	public	Path to file holding the layer's data. _{(Inherited from TGIS_Layer)}
PathFLD	public	File path of the FLD field-definition file associated with the layer.
PathFLDX	public	File path of the FLDX field-rules file associated with the layer.
PathRTree	public	File path of the layer R-Tree spatial index file, if one is used.
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)}
RTreeFile	public	R-Tree spatial index object used by the layer for accelerated extent-based shape queries.
Scope	public	SQL (Structured Query Language) WHERE clause used as a persistent attribute filter for shapes in the layer.
ScopeExtent	public	Spatial extent filter used as a persistent scope for shapes in the layer.
SelectedList	public	Read-only list of unique identifiers (UIDs) for all currently selected shapes in the layer.
SelectionGisColor	public	Selection highlight color used when UseLayerSelectionStyle is True.
SelectionOutlineOnly	public	Controls whether selected polygons are rendered with outline only when layer-specific selection styling is enabled.
SelectionWidth	public	Selection outline thickness where values greater than zero are in twips and values less than zero are absolute pixels.
Statistics	public	Layer statistics engine. _{(Inherited from TGIS_Layer)}
Stream	public	Stream providing layer data as an alternative to reading from the file specified by Path. _{(Inherited from TGIS_Layer)}
SubLayers	public	List of sublayers belonging to the layer. _{(Inherited from TGIS_Layer)}
SubType	public	Subtype flags describing the layer role within a layer hierarchy. _{(Inherited from TGIS_Layer)}
SupportedDimensions	public	Set of supported coordinate dimensionalities (2D, 3D, or 4D).
SupportedShapes	public	Set of geometry types supported by this vector layer (Point, Arc/Line, Polygon, or multi-part variants).
SupportedShapesAll	public	Extended set of supported geometry types, including SupportedShapes and any temporary types exposed by the active DynamicAggregator.
SupportsAsync	public	Indicates whether the layer implements asynchronous operations. _{(Inherited from TGIS_Layer)}
SupportsAutoStyle	public	Indicates whether the layer supports auto styling. _{(Inherited from TGIS_Layer)}
SupportsTiledPaint	public	Indicates whether the layer supports tiled paint. _{(Inherited from TGIS_Layer)}
SymbolingMode	public	Symboling mode capability flag for the layer.
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)}
Tileable	public	True if the layer is currently being printed or exported using tiles. _{(Inherited from TGIS_Layer)}
TiledDrawMode	public	Indicates whether the layer is currently being drawn by the tiler. _{(Inherited from TGIS_Layer)}
Transform	public	Custom coordinate transformation applied to the layer. _{(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 the configuration file is active. _{(Inherited from TGIS_Layer)}
UseLayerSelectionStyle	public	Enables layer-specific selection styling instead of using the viewer's global selection appearance.
UserObject	public	Associates a user-defined object with the layer. _{(Inherited from TGIS_Layer)}
UseRTree	public	Enables or disables R-Tree spatial indexing for shape queries in the vector layer.
UseShapeStyleField	public	Enables attribute-driven rendering style selection for shapes based on a style field value instead of uniform layer parameters.
Viewer	public	Reference to the viewer that owns or displays this layer. _{(Inherited from TGIS_Layer)}
ZOrder	public	Layer position relative to all 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	public	Fired after a cursor completes its initial shape fetch.
CursorBeforeFetchEvent	public	Fired before a cursor fetches shapes from the data source.
CursorCloseEvent	public	Fired when a cursor is closed on the layer.
CursorInterruptEvent	public	Fired when cursor iteration is interrupted before reaching the end.
CursorOpenEvent	public	Fired when a cursor is opened on the layer.
CursorShapeFetchEvent	public	Fired for each shape fetched during cursor iteration.
LabelPosEvent	public	Fired before a label is positioned, allowing the handler to adjust the label placement for an individual shape.
PaintShapeChartEvent	public	Fired to perform custom drawing for charts of individual shapes.
PaintShapeEvent	public	Fired to perform custom drawing for individual shapes.
PaintShapeLabelEvent	public	Fired to perform custom drawing for labels of individual shapes.
ShapeFieldChangeEvent	public	Fired after a shape field value changes.
ShapeGeometryChangeEvent	public	Fired after a shape geometry change.

Remarks

PURPOSE: Provides the core vector layer framework used by format-specific and database-backed layers to manage geographic features such as points, lines, and polygons together with their attribute data.

BEHAVIOR: Maintains in-memory shape collections, supports cursor-based iteration, SQL (Structured Query Language) filtering, DE9IM (Dimensionally Extended Nine-Intersection Model) spatial relation tests, and R-Tree-based spatial searching. Coordinates and extents can be evaluated in native or projected coordinate systems. Selection, rendering, joins, aggregation, and event notifications are integrated into the layer workflow.

CONSTRAINTS: Abstract class; descendants must implement the actual data access logic. Behavior may vary by target platform and compile-time options. Shapes and cursor-provided objects are valid only within the active iteration or callback context unless documented otherwise.

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.
TGIS_LayerVector.WriteFldFile	TRUE FALSE	TRUE	fld file will be created 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 a 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 a 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.

TatukGIS Developer Kernel

Table of Contents

TGIS_LayerVector class

Syntax

Inheritance

Constructors

Fields

Methods

Properties

Events

Remarks

Available metadata keys

Virtual fields

References

TatukGIS Developer Kernel

User Tools

Site Tools

Table of Contents

TGIS_LayerVector class

Syntax

Inheritance

Constructors

Fields

Methods

Properties

Events

Remarks

Available metadata keys

Virtual fields

References

Page Tools