TGIS_LayerVector class

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

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

Syntax

// Delphi
type
  TGIS_LayerVector = class( TGIS_Layer )
  end;

// C++ Builder
class PASCALIMPLEMENTATION TGIS_LayerVector : public TGIS_Layer
{
};

Inheritance

→ TGIS_BaseObjectDisposable → TGIS_LayerAbstract → TGIS_Layer

Constructors

Inherited Overrides Protected

	Name	Visibility	Description
	Create	public	Create layer. _{(Overrides TGIS_Layer.Create)}

Fields

Inherited Protected

Name	Visibility	Description
bIgnoreShapeParams	protected	Internal status of IgnoreShapeParams property.
cursorState	protected	Whole cursor status.
cursorStateStore	protected	Whole cursor status.
FActive	protected	Is layer active? _{(Inherited from TGIS_Layer)}
FAddition	protected	Addition value. _{(Inherited from TGIS_Layer)}
FAge	protected	Age of the layer. _{(Inherited from TGIS_Layer)}
FBasemap	protected	True if the layer is interpreted as basemap. _{(Inherited from TGIS_Layer)}
FBasemapDraw	protected	If True, the layer at the moment is drawn inside a basemap thread. _{(Inherited from TGIS_Layer)}
FBlockRTree	protected	True if rtree can not 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 has been stored. _{(Inherited from TGIS_Layer)}
FCodePageForced	protected	Code Page forced by project file or property setting. _{(Inherited from TGIS_Layer)}
FCollapsed	protected	Is layer collapsed? _{(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	Projection 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	Layer extent 3D. _{(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, number of pixels, copyright etc. _{(Inherited from TGIS_Layer)}
FHideFromLegend	protected	True if layer should not be visible in a legend. _{(Inherited from TGIS_Layer)}
findSmartSizeFactor	protected	SmartSize scaling factor (to scale between projected/unprojected size.
FInMemoryRTree	protected	True if rtree file will be created in-memory.
FInPaint	protected	True if the layer upon paint process. _{(Inherited from TGIS_Layer)}
FIsLocked	protected	True if layer is in locked state Lock. _{(Inherited from TGIS_Layer)}
FIsModified	protected	True if structure (field, geometry etc) was modified. _{(Inherited from TGIS_Layer)}
FIsOpened	protected	True if layer was opened. _{(Inherited from TGIS_Layer)}
FIsPrepared	protected	True if layer was opened. _{(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. _{(Inherited from TGIS_Layer)}
FOnCursorAfterFetch	protected	OnCursorAfterFetch event.
FOnCursorBeforeFetch	protected	OnCursorBeforeFetch event.
FOnCursorClose	protected	OnCursorClose event.
FOnCursorInterrupt	protected	OnCursorInterrupt event.
FOnCursorOpen	protected	CursorOpen event.
FOnCursorShapeFetch	protected	OnCursorShapeFetch event.
FOnLabelPos	protected	ShapeLabelPos events.
FOnPaintLayer	protected	PaintLayer event. _{(Inherited from TGIS_Layer)}
FOnPaintShape	protected	PaintShape event.
FOnPaintShapeChart	protected	PaintShapeChart event.
FOnPaintShapeLabel	protected	PaintShapeLabel event.
FOnPassword	protected	Will be fired upon opening layer to resolve any username/password _{(Inherited from TGIS_Layer)}
FOnRead	protected	Will be fired upon each file Read request. _{(Inherited from TGIS_Layer)}
FOnShapeFieldChange	protected	OnShapeFieldChange event.
FOnShapeGeometryChange	protected	OnShapeGeometryChange event.
FOnWrite	protected	Will be fired upon each file Write request. _{(Inherited from TGIS_Layer)}
forceCachedMode	protected	Set tor True to force cached (bitmap) type of drawing. _{(Inherited from TGIS_Layer)}
FParamsList	protected	List of parameters set (sections). _{(Inherited from TGIS_Layer)}
FParentLayer	protected	Parent layer. _{(Inherited from TGIS_Layer)}
FPath	protected	Layer path. _{(Inherited from TGIS_Layer)}
FPixelsPerInch	protected	Pixel density.
FProjectedExtent	protected	Precalculated projected extent. _{(Inherited from TGIS_Layer)}
FProjectedExtentBase	protected	Precalculated projected extent - Base extent (unprojected). _{(Inherited from TGIS_Layer)}
FProjectedExtentEPSG	protected	Precalculated projected extent - Layer CS Context. _{(Inherited from TGIS_Layer)}
FProjectedExtentRotationAngle	protected	Precalculated projected extent - Rotation context. _{(Inherited from TGIS_Layer)}
FProjectedExtentRotationPoint	protected	Precalculated projected extent - Rotation context. _{(Inherited from TGIS_Layer)}
FProjectedExtentViewerEPSG	protected	Precalculated projected extent - Viewer CS Context. _{(Inherited from TGIS_Layer)}
FRenderer	protected	Handle to a renderer used for drawing shapes. _{(Inherited from TGIS_Layer)}
FRTreeFile	protected	Rtree based 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	Sub layers list. _{(Inherited from TGIS_Layer)}
FSubType	protected	Type of sublayer. _{(Inherited from TGIS_Layer)}
FSupportedDimensions	protected	Set of dimensions supported by a layer.
FSupportedShapes	protected	Set of shapes supported by a 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)}
FTiledDrawMode	protected	If not None then the layer at the moment is drawn inside 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 a layer. _{(Inherited from TGIS_Layer)}
FUseConfig	protected	Is config file active? _{(Inherited from TGIS_Layer)}
FUserObject	protected	User object. _{(Inherited from TGIS_Layer)}
FUseRTree	protected	True if rtree is in use.
FViewer	protected	Reference to viewer object. _{(Inherited from TGIS_Layer)}
inDraw	protected	True if layer paint procedure not yet complete. _{(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	If True, parameters are ready to render _{(Inherited from TGIS_Layer)}
View3D	public	3D Representation properties. _{(Inherited from TGIS_Layer)}

Methods

Inherited Overrides Protected

Name	Visibility	Description
AddField	public	Adds a new field.
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 copy of shape and makes it editable.
AddShape(TGIS_Shape; Boolean)	public	Adds a copy of shape and makes it editable.
Alive	public	Makes a layer non-dormant. _{(Inherited from TGIS_Layer)}
ApplyAutoStyle	public	Applies auto-styling to the layer. _{(Overrides TGIS_Layer.ApplyAutoStyle)}
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	Binds layer to SQL query object to provided field access methods.
Build(String; TGIS_Extent; TGIS_ShapeType)	public	Builds a new layer - prepares storage.
Build(String; TGIS_Extent; TGIS_ShapeType; 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)}
checkParamsCache	protected	Check if shape is visible based on current paramsCache setup.
ClearModified	public	Sets IsModified flag to false for a layer and its sublayers. _{(Inherited from TGIS_Layer)}
CreateShape(TGIS_ShapeClass)	public	Creates a new shape and makes it editable.
CreateShape(TGIS_ShapeType)	public	Creates a new shape and makes it editable.
CreateShape(TGIS_ShapeType; TGIS_DimensionType)	public	Creates a new shape and makes it editable
cursorClose	protected	Free cursor allocated by cursorOpen().
cursorEof	protected	Is it the end of the shapes?
cursorEofInternal	protected	Has the end of shapes been reached?
cursorFindFirst	protected	Find first occurrence of an item which meets extent and query.
cursorFindNext	protected	Find next occurrence of item defined in cursorFindFirst.
cursorFinish	protected	Notify about finishing reading inside a cursor.
cursorFirst	protected	Move to the first shape in the cursor.
cursorFirstInternal	protected	Move to the first shape in the Layer.
cursorInterrupt	protected	Notify about interrupting reading inside a cursor.
cursorNext	protected	Move to the next shape in the cursor.
cursorNextInternal	protected	Move to next shape in Layer.
cursorOpen	protected	Allocate new cursor.
cursorShape	protected	Get current shape.
cursorShapeEx	protected	Get current shape.
cursorShapeInternal	protected	Get current shape.
cursorStateRestore	protected	Restore cursor state to previously stored value.
cursorStateSave	protected	Store cursor state.
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. _{(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	Flashes queued shapes. _{(Overrides TGIS_Layer.DrawFlash)}
DrawLabel	public	Draws layer labels.
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. _{(Overrides TGIS_Layer.DrawSelectedEx)}
ExportLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; Boolean)	public	Exports the layer.
ExportLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; TGIS_Shape; String; Boolean)	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.
FinalizeRead	public	Finalizes reading trying to close active queries.
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(TGIS_Extent)	public	Finds the first occurrence of an item which meets an extent.
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	Finds the next occurrence of an item defined in FindFirst.
FlashShape	public	Flashes shape several times
ForEach	public	Fetches all shapes from the layer using callback function.
ForEachSubLayer	public	Returns in callback event the layer and all sublayers belonging to it. _{(Inherited from 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	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.
getFieldInternal	protected	Get the stored field value for a shape specified by unique identifier.
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; Integer)	public	Gets a shape by unique identifier.
getShapePos	protected	Get shape using bisection.
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 a unique field name.
HourglassShake	public	Notifies of busy state using an hourglass. _{(Inherited from TGIS_Layer)}
ImportLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; Boolean)	public	Imports a layer from an existing layer.
ImportLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; TGIS_Shape; String; Boolean)	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)}
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)}
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	Returns parameters filled with the renderer styling.
LegendInfo(Integer; TGIS_ParamsSectionVector)	public	Returns current parameters filled with the renderer styling.
legendRender	protected	Prepare colors and sizes for rendering the legend.
Locate(TGIS_Point; Double)	public	Locates a shape.
Locate(TGIS_Point; Double; Boolean)	public	Locates a shape.
LocateEx(TGIS_Point; Double; TGIS_Uid; Double; Integer; TGIS_Point)	public	Locates a shape (more precise).
LocateEx(TGIS_Point; Double; TGIS_Uid; Double; Integer; TGIS_Point; Boolean)	public	Locates a shape (more precise).
LocateEx(TGIS_Point; Double; TGIS_Uid; Double; Integer; TGIS_Point; Double; Boolean)	public	Locates a shape (more precise).
Lock	public	Locks layer in burst-mode operation. _{(Inherited from TGIS_Layer)}
lockRender	protected	Prepare colors and size for a shape using automatic renderer.
LockRenderInternal	public	This method is used only for internal use on layer reading.
lockThread	protected	Locks thread. _{(Inherited from TGIS_Layer)}
Loop	public	Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop(TGIS_Extent)	public	Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop(TGIS_Extent; String)	public	Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop(TGIS_Extent; String; TGIS_Shape; String)	public	Prepares enumerator (also known as iterator or cursor) to iterate the layer.
Loop(TGIS_Extent; String; TGIS_Shape; String; Boolean)	public	Prepares enumerator (also known as iterator or cursor) to iterate the layer.
MergeLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; Boolean; Boolean)	public	Merges layer from an existing layer.
MergeLayer(TGIS_LayerVector; TGIS_Extent; TGIS_ShapeType; String; TGIS_Shape; String; Boolean; Boolean)	public	Merges layer with an existing layer.
MergeLayerEx	public	Merges layer with an existing layer.
MergeStructure(TGIS_LayerVector; Boolean)	public	Merges the field structure from another layer.
MergeStructure(TGIS_LayerVector; Boolean; Boolean)	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. _{(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	Provides next shape from the candidate list.
Open	public	Opens the layer. _{(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	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)}
prepareCandidates	protected	Prepare list of scope candidates for SQL Layers.
PrepareExportFieldNames(Integer)	public	Prepares field names to export.
PrepareExportFieldNames(Integer; Boolean)	public	Prepares field names to export.
PrepareExportFieldNames(Integer; Boolean; Boolean)	public	Prepares field names to export.
PrepareExportFieldNames(Integer; Boolean; Boolean; Boolean)	public	Prepares field names to export.
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	Prepare colors and size for a shape using automatic renderer.
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	Used by TGIS_Shape to add itself to the flash 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	Parses the field definition file.
ReadFieldRules	public	Parses the field rules file.
RecalcExtent	public	Recalculates extent. _{(Overrides TGIS_Layer.RecalcExtent)}
RecalcProjectedExtent	public	Recalculates a projected extent. _{(Inherited from TGIS_Layer)}
releaseFlash	protected	Used by TGIS_Shape to remove itself from the flash queue.
removeCandidate	protected	Remove shape from the candidate list.
RenameField	public	Renames a field.
ReOpen	public	Reopens the layer. _{(Inherited from TGIS_Layer)}
ReorderShapeUids	public	Internal method to rebuild shape's uid values and ensure ascending order.
RereadConfig	public	Rereads the layer configuration files. _{(Inherited from TGIS_Layer)}
resetMustReproject	protected	Reset MustReporoject state. _{(Inherited from TGIS_Layer)}
Revert	public	Reverts a shape to its original state.
RevertAll	public	Reverts layer to its original content. _{(Overrides TGIS_Layer.RevertAll)}
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. _{(Overrides TGIS_Layer.SaveData)}
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)}
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)}
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	Do after lockRender.
UnlockRenderInternal	public	This method is used only for internal use on layer reading.
unlockThread	protected	Unlocks thread. _{(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)}
BasemapDraw	public	If True, the layer at the moment is drawn inside a basemap thread. _{(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.
InPaint	public	True if the layer upon paint process. _{(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)}
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.
JoinADO	public	ADO Query to be joined.
JoinCodePage	public	Code page for JoinADO/JoinDB.
JoinDB	public	DB Query to be joined.
JoinForeign	public	Field from Query to be joined.
JoinJDBC	public	JDBC ResultSet of Query to be joined.
JoinJDBCQuery	public	JDBC 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)}
RTreeFile	public	Rtree based index.
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.
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 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)}
TiledDrawMode	public	If True, the layer at the moment is drawn by tiler. _{(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.
CursorInterruptEvent	published	OnCursorInterrupt event.
CursorOpenEvent	published	CursorOpen event.
CursorShapeFetchEvent	published	CursorShapeFetch 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.

Remarks

Available metadata keys

Metadata	Values	Default	Description
TGIS_Viewer.RotationMode.Labels	NO BYFIELD WITHANGLE ALL	BYFIELD	Labels rotation modes.
TGIS_LayerVector.WriteOriginalUid	TRUE FALSE	FALSE	Field with original uid (ORIG_ID) will be added during layer import.
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.

(to be accessed by TGIS_Shape.GetField)

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

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