api:dk11:delphi:gislayervector.tgis_layervector_methods
TGIS_LayerVector methods
DK for Delphi | GisLayerVector.TGIS_LayerVector | Constructors | Fields | Methods | Properties | Events
Methods
Inherited
Overrides
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| AddField | public | Adds a new attribute field to the layer's schema. | |
| AddFieldInternal(String; TGIS_FieldType; Integer; Integer) | public | Adds new field; for internal use. | |
| AddFieldInternal(String; TGIS_FieldType; Integer; Integer; Boolean; Integer) | public | Adds new field; for internal use. | |
| AddShape(TGIS_Shape) | public | Adds a shape to the layer by creating an editable copy of the geometry (attributes not copied, geometry only). | |
| AddShape(TGIS_Shape; Boolean) | public | Adds a shape to the layer by creating an editable copy, optionally copying attribute fields and data 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(Boolean) | public | Applies auto-styling to the layer. (Inherited from TGIS_Layer) |
|
| applyConfigOptions | protected | Read config option parameters. (Overrides TGIS_Layer.applyConfigOptions) |
|
| applyConfigProjection(TGIS_ConfigAbstract) | protected | Read config projection parameters. (Inherited from TGIS_Layer) |
|
| applyConfigProjection(TGIS_ConfigAbstract; TGIS_Layer) | protected | Read config projection parameters. (Inherited from TGIS_Layer) |
|
| ApplyCuttingPolygon | public | Sets a cutting polygon for a layer. (Inherited from TGIS_Layer) |
|
| bindField | protected | Obtain a bind number for a given field name. | |
| bindFieldInternal | protected | Obtain a bind number for a given field name. | |
| BindSqlQueryInternal | public | Bind layer to SQL query object for attribute field value access. | |
| Build(String; TGIS_Extent; TGIS_ShapeType) | public | Creates and initializes layer storage (file or database) with specified geometry type and extent. | |
| Build(String; TGIS_Extent; TGIS_ShapeType; TGIS_DimensionType) | public | Builds s new layer - prepare storage. | |
| CentroidScope | public | Calculates the centroid point for the first shape matching a SQL WHERE clause query, or returns fallback point if no match found. | |
| ChangeHash | public | Changes the hash for the purpose of verifying layer's modifications. (Inherited from TGIS_Layer) |
|
| checkParamsCache | protected | Check whether shape passes visibility criteria (layer params cache, query filter, hidden state). | |
| ClearModified | public | Sets IsModified flag to false for a layer and its sublayers. (Inherited from TGIS_Layer) |
|
| CreateShape(TGIS_ShapeClass) | public | Creates new shape instance of extended type (e.g., custom class) in editable state, ready for geometry input and addition to layer. | |
| CreateShape(TGIS_ShapeType) | public | Creates a new empty shape with specified geometry type using the layer's default coordinate dimensionality, ready for vertex input or direct addition. | |
| CreateShape(TGIS_ShapeType; TGIS_DimensionType) | public | Creates a new empty shape with specified geometry type and coordinate dimensionality, ready for geometry input and addition to this layer. | |
| cursorClose | protected | Release cursor and free associated resources. | |
| cursorEof | protected | Test whether cursor at end-of-file (all matching shapes exhausted). | |
| cursorEofInternal | protected | Internal variant of cursorEof. | |
| cursorFindFirst | protected | Find first shape matching extent, query, and spatial predicates. | |
| cursorFindNext | protected | Find next shape matching cursorFindFirst() criteria. | |
| cursorFinish | protected | Complete cursor iteration and release resources. | |
| cursorFirst | protected | Initialize cursor to first shape matching extent, query, and spatial predicates. | |
| cursorFirstInternal | protected | Internal variant of cursorFirst. | |
| cursorInterrupt | protected | Interrupt cursor iteration prematurely. | |
| cursorNext | protected | Advance cursor to next shape matching filter criteria. | |
| cursorNextInternal | protected | Internal variant of cursorNext. | |
| cursorOpen | protected | Allocate and initialize new iteration cursor. | |
| cursorShape | protected | Retrieve current shape from cursor position. | |
| cursorShapeEx | protected | Retrieve current shape with extended/alternative access. | |
| cursorShapeInternal | protected | Internal variant of cursorShape. | |
| cursorStateRestore | protected | Restore cursor to previously saved state. | |
| cursorStateSave | protected | Save cursor position for nested iteration. | |
| Delete | public | Marks a shape as deleted, removing it from queries and drawing while preserving deletion information for undo/revert operations. | |
| DeleteField | public | Removes a field from layer schema. | |
| Deselect | public | Deselects a single shape, removing it from the selection set (sets IsSelected property to false). | |
| DeselectAll | public | Clears selection of all shapes in the layer, removing all shapes from the selection set (sets IsSelected=false for all). | |
| doApplyAutoStyle | protected | Layer implementation of auto-styling. (Overrides TGIS_Layer.doApplyAutoStyle) |
|
| 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 | Render all layer charts directly without full shape redraw. | |
| DrawEx | public | Draws a layer within a defined extent. (Overrides TGIS_Layer.DrawEx) |
|
| drawExtent | protected | Calculates the drawing area /clipping area of device/. (Inherited from TGIS_Layer) |
|
| drawExtentEx | protected | Calculates the drawing area /clipping area of device/. (Inherited from TGIS_Layer) |
|
| DrawFlash | public | Render all queued flashing shapes. (Overrides TGIS_Layer.DrawFlash) |
|
| DrawLabel | public | Render layer's labels directly without full shape redraw. | |
| DrawScope | public | Render shapes matching SQL WHERE clause using specified rendering 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 | Custom shape rendering via specialized renderer object. (Overrides TGIS_Layer.DrawSpecial) |
|
| ExportLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; Boolean) | public | Copy layer subset to destination layer. | |
| ExportLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; TGIS_Shape; String; Boolean) | public | Export with topological relationship filtering. | |
| ExportLayerEx | public | Virtual export handler for subclass override. | |
| ExportStructureToFLD | public | Write layer's field schema to FLD (field definition) file format. | |
| FieldInfo | public | Returns pointer to field schema definition (TGIS_FieldInfo record). | |
| FinalizeDirectWrite | public | Completes direct streaming write session and finalizes storage (files/tables). | |
| FinalizeRead | public | Finalizes reading and closes any active query/cursor states for the layer. | |
| FindField | public | Find field index by name in layer's schema. | |
| FindFieldInternal | public | Internal field lookup using saved file format name. | |
| FindFirst | public | Initiates iteration by finding first shape in layer with optional RTree spatial acceleration. | |
| FindFirst(TGIS_Extent) | public | Finds the first shape in layer intersecting the specified spatial extent, using spatial index (R-Tree) for fast O(log n) lookup if available. | |
| FindFirst(TGIS_Extent; String) | public | Finds the first occurrence of an item which meets an extent and query. | |
| FindFirst(TGIS_Extent; String; TGIS_Shape; String) | public | Finds the first occurrence of an item which meets an extent, query, and additional parameters. | |
| FindFirst(TGIS_Extent; String; TGIS_Shape; String; Boolean) | public | Finds the first occurrence of an item which meets an extent, query, and additional parameters. | |
| FindNext | public | Retrieves the next shape from a prior FindFirst query iterator. | |
| FlashShape | public | Flash shape with customizable timing. | |
| ForEach | public | Iterates shapes matching complex criteria (spatial, attribute, topology) and invokes callback for each shape with rendering parameters prepared. | |
| ForEachSubLayer | public | Returns in callback event the layer and all sublayers belonging to it. (Inherited from TGIS_Layer) |
|
| GetAvailableLayers | public | Gets a list of layers available in storage. (Overrides TGIS_Layer.GetAvailableLayers) |
|
| getBindedField | protected | Get field value for a shape given by unique identity. | |
| getBindedFieldInternal | protected | Get field value for a shape given by unique identity. | |
| getEdited | protected | Internally used by TGIS_Viewer. | |
| GetField | public | Retrieves an attribute field value for a shape by its unique identifier, with NULL values converted to field default values. | |
| GetFieldEx | public | Retrieves an attribute field value for a shape by unique identifier, preserving SQL NULL values unchanged (vs GetField which converts NULLs to defaults). | |
| getFieldInternal | protected | Get the stored field value for a shape specified by unique identifier. | |
| GetLastUid | public | Gets the unique identifier (UID) of the last shape in the layer (highest numbered shape, not necessarily last added). | |
| GetNewUid | public | Allocates the next available unique identifier (UID) for a new shape, automatically incrementing from the last used UID. | |
| GetSelectedCount | public | Returns the count of shapes currently selected in this layer's selection list. | |
| GetShape(TGIS_Uid) | public | Retrieves a shape by its unique identifier (UID) using the default cursor (0). | |
| GetShape(TGIS_Uid; Integer) | public | Gets a shape by unique identifier. | |
| getShapePos | protected | Locate shape in sorted collection using binary search. | |
| getStatistics | protected | Parse label string (to expand fields etc.). | |
| GetSubLayer | public | Retrieve the layer identified by a name. (Inherited from TGIS_Layer) |
|
| GetUniqueFieldName | public | Suggests unique field name avoiding schema conflicts. | |
| HourglassShake | public | Notifies of busy state using an hourglass. (Inherited from TGIS_Layer) |
|
| ImportLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; Boolean) | public | Imports shapes from an existing vector layer into this layer, optionally filtering by spatial extent and SQL WHERE clause. | |
| ImportLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; TGIS_Shape; String; Boolean) | public | Import shapes with spatial and topological relationship filtering. | |
| ImportLayerEx | public | Import shapes with extended spatial and topological filtering (virtual). | |
| ImportStructure | public | Copies the complete attribute field schema from another layer, replacing this layer's existing field definitions. | |
| InitializeDirectWrite | public | Prepares layer storage for direct streaming writes (high-volume bulk operations). | |
| InvalidateScope | public | Marks shapes matching a WHERE clause for viewport redraw with specified rendering style. | |
| InvalidateSelection | public | Marks all selected shapes for viewport redraw (selection highlighting only), without affecting shape geometry or style rendering. | |
| IsGrid | public | Checks if the layer type is grid. (Inherited from TGIS_Layer) |
|
| isInScope | protected | Internally used by TGIS_Viewer. | |
| 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 | Calculate a visibility of a given shape. | |
| 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(Integer; Integer; TGIS_ParamsSectionVector) | public | Retrieves rendering parameters for a specific legend zone (class), populated from current layer styling. | |
| LegendInfo(Integer; TGIS_ParamsSectionVector) | public | Deprecated: Retrieves styling parameters for a legend zone. | |
| legendRender | protected | Prepare legend entry styling colors and sizes for specified symbol rule section. | |
| Locate(TGIS_Point; Double) | public | Locates the shape closest to a reference point within a specified precision distance. | |
| Locate(TGIS_Point; Double; Boolean) | public | Locate shape with visibility filter. | |
| LocateEx(TGIS_Point; Double; TGIS_Uid; Double; Integer; TGIS_Point) | public | Locate nearest shape with detailed output: actual distance to shape, part index of closest element, and projected point on shape geometry. | |
| LocateEx(TGIS_Point; Double; TGIS_Uid; Double; Integer; TGIS_Point; Boolean) | public | Locate nearest shape with detailed output and visibility filtering. | |
| LocateEx(TGIS_Point; Double; TGIS_Uid; Double; Integer; TGIS_Point; Double; Boolean) | public | Locate nearest shape with full output metrics including shape-type preference distance. | |
| Lock | public | Locks layer in burst-mode operation. (Inherited from TGIS_Layer) |
|
| lockRender | protected | Lock shape rendering context and prepare colors/sizes for rendering. | |
| LockRenderInternal | public | Lock layer rendering for bulk load operations. | |
| lockThread | protected | Locks thread. (Inherited from TGIS_Layer) |
|
| Loop | public | Creates an enumerator (iterator/cursor) for traversing all shapes in the layer using Delphi for..in syntax or manual iteration. | |
| Loop(TGIS_Extent) | public | Creates an enumerator for shapes intersecting the specified spatial extent using RTree-accelerated spatial filtering. | |
| Loop(TGIS_Extent; String) | public | Creates an enumerator for shapes matching spatial extent and attribute query criteria using RTree + SQL-like filtering. | |
| Loop(TGIS_Extent; String; TGIS_Shape; String) | public | Creates an enumerator for shapes matching spatial extent, attribute query, and topological relationship criteria (DE-9IM). | |
| Loop(TGIS_Extent; String; TGIS_Shape; String; Boolean) | public | Creates an enumerator for shapes matching spatial extent, attribute query, topological criteria, with optional soft-deleted shape inclusion control. | |
| MarkAsProxy | public | Mark layer to be used as a proxy layer. (Inherited from TGIS_Layer) |
|
| MergeLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; Boolean; Boolean) | public | Consolidate shapes from another layer into this layer, preserving attribute data and enforcing field schema compatibility. | |
| MergeLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; TGIS_Shape; String; Boolean; Boolean) | public | Merge shapes with attribute data and topological relationship filtering. | |
| MergeLayerEx | public | Virtual merge handler for subclass override. | |
| MergeStructure(TGIS_LayerVector; Boolean) | public | Merges field schema from another layer into this layer's existing schema (additive). | |
| MergeStructure(TGIS_LayerVector; Boolean; Boolean) | public | Merges field schema from another layer with control over exported field naming (export name vs. | |
| 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. (Overrides TGIS_Layer.MustCalculateStatistics) |
|
| MustReproject | public | Checks if the layer must be reprojected. (Inherited from TGIS_Layer) |
|
| MustSave | public | Checks if the layer was modified by editing. (Overrides TGIS_Layer.MustSave) |
|
| nextCandidate | protected | Retrieve next candidate shape from list. | |
| Open | public | Opens the layer. (Inherited from TGIS_Layer) |
|
| OpenAsync | public | Opens the layer asynchronously. (Inherited from TGIS_Layer) |
|
| optimizeParamsCache(Integer) | protected | Move section specified by _idx to the top of the cached list. (Inherited from TGIS_Layer) |
|
| optimizeParamsCache(Integer; Boolean) | protected | Move section specified by _idx 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 actual rendering parameters (style, color, width, fill) applied to a specific shape during drawing. | |
| Prepare | public | Opens the layer. (Inherited from TGIS_Layer) |
|
| prepareCandidates | protected | Build candidate list for spatial query. | |
| PrepareExportFieldNames(Integer) | public | Prepares field names for export to target format. | |
| PrepareExportFieldNames(Integer; Boolean) | public | Prepares field names for export with control over which fields to process (new vs saved). | |
| PrepareExportFieldNames(Integer; Boolean; Boolean) | public | Prepares field names for export with optional case conversion (UPPERCASE or mixed case preservation). | |
| PrepareExportFieldNames(Integer; Boolean; Boolean; Boolean) | public | Prepares field names for export with case conversion and SQL strictness (alphanumeric + underscore only). | |
| PrepareForExport | public | Prepares layer for export. (Inherited from TGIS_Layer) |
|
| PrepareParams | public | For internal use only. (Inherited from TGIS_Layer) |
|
| prepareParamsCache | protected | Prepare cached section list meeting the _style name. (Inherited from TGIS_Layer) |
|
| prepareParamsCache(String) | protected | Prepare cached section list meeting the _style name. (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 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) |
|
| queueFlash | protected | Add shape to flash (highlight) queue. | |
| 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 | Parse layer's field definition file (.fld) and restore field schema. | |
| ReadFieldRules | public | Load field validation/constraint rules from FLD rules file. | |
| RecalcExtent | public | Recalculates the layer's bounding extent (MinX, MinY, MaxX, MaxY) by scanning all visible shapes. (Overrides TGIS_Layer.RecalcExtent) |
|
| RecalcProjectedExtent | public | Recalculates a projected extent. (Inherited from TGIS_Layer) |
|
| releaseFlash | protected | Remove shape from flash (highlight) queue. | |
| removeCandidate | protected | Remove shape from candidate list. | |
| RenameField | public | Renames an existing field and optionally resizes it. | |
| ReOpen | public | Reopens the layer. (Inherited from TGIS_Layer) |
|
| ReorderShapeUids | public | Rebuild shape UIDs to ensure ascending, consecutive order after Items list reordering. | |
| RereadConfig | public | Rereads the layer configuration files. (Inherited from TGIS_Layer) |
|
| resetMustReproject | protected | Reset MustReporoject state. (Inherited from TGIS_Layer) |
|
| Revert | public | Reverts a single shape to its last saved/original state, undoing all edits. | |
| RevertAll | public | Reverts layer to its original content. (Overrides TGIS_Layer.RevertAll) |
|
| RevertShapes | public | Reverts all shapes in the layer to their last saved/original state, discarding all pending edits (geometry and attributes). | |
| 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. (Overrides TGIS_Layer.SaveData) |
|
| SaveFieldRules | public | Persist field validation/constraint rules to FLD 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) |
|
| setUp | protected | Makes a general layer setup first step. (Overrides TGIS_Layer.setUp) |
|
| setUp2 | protected | Makes a general layer setup second step. (Overrides TGIS_Layer.setUp2) |
|
| setUp3 | protected | Makes a general layer setup third step. (Overrides TGIS_Layer.setUp3) |
|
| setUpAsync | protected | Makes a general layer setup first step asynchronously. (Inherited from TGIS_Layer) |
|
| storeConfigOptions | protected | Store layer options in a configuration file. (Overrides TGIS_Layer.storeConfigOptions) |
|
| transformExtent | protected | Custom transformation of the extent. (Inherited from TGIS_Layer) |
|
| Unlock | public | Unlocks layer from burst-mode operation. (Inherited from TGIS_Layer) |
|
| unlockRender | protected | Release rendering lock acquired by lockRender(). | |
| UnlockRenderInternal | public | Unlock layer rendering and resume cache updates. | |
| unlockThread | protected | Unlocks 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 (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 to persistent storage (file/database) without buffering through layer collection. | |
2026/06/12 22:43