User Tools

Site Tools


api:dk11:java:tatukgis.jdk.tgis_layershp

TGIS_LayerSHP class

DK11 for Java | tatukgis.jdk.TGIS_LayerSHP | Classes | Constructors | Fields | Methods | Properties

Layer that can read SHP file.

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

Syntax

// Java
public class TGIS_LayerSHP extends TGIS_LayerVector {
};
// Oxygene
type
  TGIS_LayerSHP = public class( TGIS_LayerVector )
  end;

Inheritance

→ TGIS_BaseObjectDisposable → TGIS_LayerAbstractTGIS_LayerTGIS_LayerVector

Constructors

Inherited Overrides Protected
Name Visibility Description
TGIS_LayerSHP() public Create layer.
(Overrides TGIS_LayerVector.TGIS_LayerVector())

Fields

Inherited Protected
Name Visibility Description
bIgnoreShapeParams protected Internal status of IgnoreShapeParams property.
(Inherited from TGIS_LayerVector)
cursorState protected Whole cursor status.
(Inherited from TGIS_LayerVector)
cursorStateStore protected Whole cursor status.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
FInMemoryRTree protected True if rtree file will be created in-memory.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
FOnCursorBeforeFetch protected OnCursorBeforeFetch event.
(Inherited from TGIS_LayerVector)
FOnCursorClose protected OnCursorClose event.
(Inherited from TGIS_LayerVector)
FOnCursorInterrupt protected OnCursorInterrupt event.
(Inherited from TGIS_LayerVector)
FOnCursorOpen protected CursorOpen event.
(Inherited from TGIS_LayerVector)
FOnCursorShapeFetch protected OnCursorShapeFetch event.
(Inherited from TGIS_LayerVector)
FOnLabelPos protected ShapeLabelPos events.
(Inherited from TGIS_LayerVector)
FOnPaintLayer protected PaintLayer event.
(Inherited from TGIS_Layer)
FOnPaintShape protected PaintShape event.
(Inherited from TGIS_LayerVector)
FOnPaintShapeChart protected PaintShapeChart event.
(Inherited from TGIS_LayerVector)
FOnPaintShapeLabel protected PaintShapeLabel event.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
FOnShapeGeometryChange protected OnShapeGeometryChange event.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
FSelectedList protected List of uids of selected shapes.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
FSupportedShapes protected Set of shapes supported by a layer.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
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).
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
AddFieldInternal(java.lang.String, TGIS_FieldType, int, int) public Adds new field; for internal use.
(Inherited from TGIS_LayerVector)
AddFieldInternal(java.lang.String, TGIS_FieldType, int, int, bool, int) public Adds new field; for internal use.
(Inherited from TGIS_LayerVector)
AddShape(TGIS_Shape) public Adds a copy of shape and makes it editable.
(Inherited from TGIS_LayerVector)
AddShape(TGIS_Shape, bool) public Adds a copy of shape and makes it editable.
(Inherited from TGIS_LayerVector)
Alive public Makes a layer non-dormant.
(Inherited from TGIS_Layer)
ApplyAutoStyle public
(Inherited from TGIS_LayerVector)
applyConfigOptions protected
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
bindFieldInternal protected Obtain a bind number for a given field name.
(Inherited from TGIS_LayerVector)
BindSqlQueryInternal public Binds layer to SQL query object to provided field access methods.
(Inherited from TGIS_LayerVector)
Build(java.lang.String, TGIS_Extent, TGIS_ShapeType) public Builds a new layer - prepares storage.
(Inherited from TGIS_LayerVector)
Build(java.lang.String, TGIS_Extent, TGIS_ShapeType, TGIS_DimensionType) public Builds s new layer - prepare storage.
(Overrides TGIS_LayerVector.Build)
CentroidScope public Calculates a centroid for a scope.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
CreateShape(TGIS_ShapeType) public Creates a new shape and makes it editable.
(Inherited from TGIS_LayerVector)
CreateShape(TGIS_ShapeType, TGIS_DimensionType) public Creates a new shape and makes it editable
(Inherited from TGIS_LayerVector)
cursorClose protected Free cursor allocated by cursorOpen().
(Overrides TGIS_LayerVector.cursorClose)
cursorEof protected Is it the end of the shapes?
(Overrides TGIS_LayerVector.cursorEof)
cursorEofInternal protected Has the end of shapes been reached?
(Inherited from TGIS_LayerVector)
cursorFindFirst protected Find first occurrence of an item which meets extent and query.
(Inherited from TGIS_LayerVector)
cursorFindNext protected Find next occurrence of item defined in cursorFindFirst.
(Inherited from TGIS_LayerVector)
cursorFinish protected Notify about finishing reading inside a cursor.
(Inherited from TGIS_LayerVector)
cursorFirst protected Move to the first shape in the cursor.
(Overrides TGIS_LayerVector.cursorFirst)
cursorFirstInternal protected Move to the first shape in the Layer.
(Inherited from TGIS_LayerVector)
cursorInterrupt protected Notify about interrupting reading inside a cursor.
(Inherited from TGIS_LayerVector)
cursorNext protected Move to the next shape in the cursor.
(Overrides TGIS_LayerVector.cursorNext)
cursorNextInternal protected Move to next shape in Layer.
(Inherited from TGIS_LayerVector)
cursorOpen protected Allocate new cursor.
(Overrides TGIS_LayerVector.cursorOpen)
cursorShape protected Get current shape.
(Overrides TGIS_LayerVector.cursorShape)
cursorShapeEx protected Get current shape.
(Inherited from TGIS_LayerVector)
cursorShapeInternal protected Get current shape.
(Inherited from TGIS_LayerVector)
cursorStateRestore protected Restore cursor state to previously stored value.
(Inherited from TGIS_LayerVector)
cursorStateSave protected Store cursor state.
(Inherited from TGIS_LayerVector)
Delete public Deletes a shape.
(Inherited from TGIS_LayerVector)
DeleteField public Deletes a field.
(Inherited from TGIS_LayerVector)
Deselect public Clears selection of shape.
(Inherited from TGIS_LayerVector)
DeselectAll public Clears selection of all shapes.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
DrawEx public Draws a layer within a defined extent.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
DrawLabel public Draws layer labels.
(Inherited from TGIS_LayerVector)
DrawScope public Draws only shapes that meet a scope criterion.
(Inherited from TGIS_LayerVector)
DrawSelected public Draws only the selected item(s) on layer.
(Inherited from TGIS_Layer)
DrawSelectedEx public
(Inherited from TGIS_LayerVector)
ExportLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, bool) public Exports the layer.
(Inherited from TGIS_LayerVector)
ExportLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, TGIS_Shape, java.lang.String, bool) public Exports layer.
(Inherited from TGIS_LayerVector)
ExportLayerEx public Exports layer.
(Inherited from TGIS_LayerVector)
ExportStructureToFLD public Exports fields structure to a fld file.
(Inherited from TGIS_LayerVector)
FieldInfo public Returns pointer to GIS_FieldInfo structure.
(Inherited from TGIS_LayerVector)
FinalizeDirectWrite public Finalizes direct writing into layer storage.
(Overrides TGIS_LayerVector.FinalizeDirectWrite)
FinalizeRead public Finalizes reading trying to close active queries.
(Inherited from TGIS_LayerVector)
FindField public Finds a field in the fields list.
(Inherited from TGIS_LayerVector)
FindFieldInternal public Finds a field in the fields list (for internal use).
(Inherited from TGIS_LayerVector)
FindFirst public Finds the first shape in layer.
(Inherited from TGIS_LayerVector)
FindFirst(TGIS_Extent) public Finds the first occurrence of an item which meets an extent.
(Inherited from TGIS_LayerVector)
FindFirst(TGIS_Extent, java.lang.String) public Finds the first occurrence of an item which meets an extent and query.
(Inherited from TGIS_LayerVector)
FindFirst(TGIS_Extent, java.lang.String, TGIS_Shape, java.lang.String) public Finds the first occurrence of an item which meets an extent, query, and additional parameters.
(Inherited from TGIS_LayerVector)
FindFirst(TGIS_Extent, java.lang.String, TGIS_Shape, java.lang.String, bool) public Finds the first occurrence of an item which meets an extent, query, and additional parameters.
(Inherited from TGIS_LayerVector)
FindNext public Finds the next occurrence of an item defined in FindFirst.
(Inherited from TGIS_LayerVector)
FlashShape public Flashes shape several times
(Inherited from TGIS_LayerVector)
ForEach public Fetches all shapes from the layer using callback function.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
getBindedField protected Get field value for a shape given by unique identity.
(Inherited from TGIS_LayerVector)
getBindedFieldInternal protected Get field value for a shape given by unique identity.
(Overrides TGIS_LayerVector.getBindedFieldInternal)
getEdited protected Internally used by TGIS_Viewer.
(Inherited from TGIS_LayerVector)
GetField public Gets a field value for a shape determined by its unique identity.
(Inherited from TGIS_LayerVector)
GetFieldEx public Gets a field value for a shape determined by its unique identity.
(Inherited from TGIS_LayerVector)
getFieldInternal protected Get the stored field value for a shape specified by unique identifier.
(Overrides TGIS_LayerVector.getFieldInternal)
getFileExtCPG protected Get CPG file extension.
getFileExtDBF protected Get DBF file extension.
getFileExtFLD protected Get FLD file extension.
getFileExtPRJ protected Get PRJ file extension.
getFileExtSHX protected Get SXH file extension.
GetLastUid public Gets the Uid of the last shape.
(Overrides TGIS_LayerVector.GetLastUid)
GetNewUid public Gets the Uid for a new shape.
(Overrides TGIS_LayerVector.GetNewUid)
GetSelectedCount public Returns the quantity of selected shapes.
(Inherited from TGIS_LayerVector)
GetShape(long) public Gets a shape by its unique identifier on default cursor (0).
(Inherited from TGIS_LayerVector)
GetShape(long, int) public Gets a shape by unique identifier.
(Overrides TGIS_LayerVector.GetShape)
getShapePos protected Get shape using bisection.
(Inherited from TGIS_LayerVector)
getStatistics protected Parse label string (to expand fields etc.).
(Inherited from TGIS_LayerVector)
GetSubLayer public Retrieve the layer identified by a name.
(Inherited from TGIS_Layer)
GetUniqueFieldName public Suggests a unique field name.
(Inherited from TGIS_LayerVector)
HourglassShake public Notifies of busy state using an hourglass.
(Inherited from TGIS_Layer)
ImportLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, bool) public Imports a layer from an existing layer.
(Inherited from TGIS_LayerVector)
ImportLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, TGIS_Shape, java.lang.String, bool) public Imports a layer from an existing layer.
(Inherited from TGIS_LayerVector)
ImportLayerEx public Imports a layer from an existing layer.
(Overrides TGIS_LayerVector.ImportLayerEx)
ImportStructure public Imports the field structure from another layer
(Inherited from TGIS_LayerVector)
InitializeDirectWrite public Builds a new layer - prepares storage for direct writing.
(Overrides TGIS_LayerVector.InitializeDirectWrite)
InvalidateScope public Invalidates shapes in the scope.
(Inherited from TGIS_LayerVector)
InvalidateSelection public Invalidates all selected shapes (but only to redraw the selection, not the shapes themselves).
(Inherited from TGIS_LayerVector)
IsGrid public Checks if the layer type is grid.
(Inherited from TGIS_Layer)
isInScope protected Internally used by TGIS_Viewer.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
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
(Inherited from TGIS_LayerVector)
IsVector3D public
(Inherited from TGIS_LayerVector)
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 Returns parameters filled with the renderer styling.
(Inherited from TGIS_LayerVector)
LegendInfo(int, TGIS_ParamsSectionVector) public Returns current parameters filled with the renderer styling.
(Inherited from TGIS_LayerVector)
legendRender protected Prepare colors and sizes for rendering the legend.
(Inherited from TGIS_LayerVector)
Locate(TGIS_Point, double) public Locates a shape.
(Inherited from TGIS_LayerVector)
Locate(TGIS_Point, double, bool) public Locates a shape.
(Inherited from TGIS_LayerVector)
LocateEx(TGIS_Point, double, long, double, int, TGIS_Point) public Locates a shape (more precise).
(Inherited from TGIS_LayerVector)
LocateEx(TGIS_Point, double, long, double, int, TGIS_Point, bool) public Locates a shape (more precise).
(Inherited from TGIS_LayerVector)
LocateEx(TGIS_Point, double, long, double, int, TGIS_Point, double, bool) public Locates a shape (more precise).
(Inherited from TGIS_LayerVector)
Lock public Locks layer in burst-mode operation.
(Inherited from TGIS_Layer)
lockRender protected Prepare colors and size for a shape using automatic renderer.
(Inherited from TGIS_LayerVector)
LockRenderInternal public This method is used only for internal use on layer reading.
(Inherited from TGIS_LayerVector)
lockThread protected Locks thread.
(Inherited from TGIS_Layer)
Loop public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
(Inherited from TGIS_LayerVector)
Loop(TGIS_Extent) public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
(Inherited from TGIS_LayerVector)
Loop(TGIS_Extent, java.lang.String) public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
(Inherited from TGIS_LayerVector)
Loop(TGIS_Extent, java.lang.String, TGIS_Shape, java.lang.String) public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
(Inherited from TGIS_LayerVector)
Loop(TGIS_Extent, java.lang.String, TGIS_Shape, java.lang.String, bool) public Prepares enumerator (also known as iterator or cursor) to iterate the layer.
(Inherited from TGIS_LayerVector)
MergeLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, bool, bool) public Merges layer from an existing layer.
(Inherited from TGIS_LayerVector)
MergeLayer(TGIS_LayerVector, TGIS_Extent, TGIS_ShapeType, java.lang.String, TGIS_Shape, java.lang.String, bool, bool) public Merges layer with an existing layer.
(Inherited from TGIS_LayerVector)
MergeLayerEx public Merges layer with an existing layer.
(Overrides TGIS_LayerVector.MergeLayerEx)
MergeStructure(TGIS_LayerVector, bool) public Merges the field structure from another layer.
(Inherited from TGIS_LayerVector)
MergeStructure(TGIS_LayerVector, bool, bool) public Merges the field structure from another layer.
(Inherited from TGIS_LayerVector)
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
(Inherited from TGIS_LayerVector)
MustReproject public Checks if the layer must be reprojected.
(Inherited from TGIS_Layer)
MustSave public
(Inherited from TGIS_LayerVector)
nextCandidate protected Provides next shape from the candidate list.
(Inherited from TGIS_LayerVector)
Open public Opens the layer.
(Inherited from TGIS_Layer)
optimizeParamsCache(int) protected Move section specified by _idx to the top of the cached list.
(Inherited from TGIS_Layer)
optimizeParamsCache(int, bool) 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.
(Inherited from TGIS_LayerVector)
Prepare public Opens the layer.
(Inherited from TGIS_Layer)
prepareCandidates protected Prepare list of scope candidates for SQL Layers.
(Inherited from TGIS_LayerVector)
PrepareExportFieldNames(int) public Prepares field names to export.
(Inherited from TGIS_LayerVector)
PrepareExportFieldNames(int, bool) public Prepares field names to export.
(Inherited from TGIS_LayerVector)
PrepareExportFieldNames(int, bool, bool) public Prepares field names to export.
(Inherited from TGIS_LayerVector)
PrepareExportFieldNames(int, bool, bool, bool) public Prepares field names to export.
(Inherited from TGIS_LayerVector)
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(java.lang.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.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
ReadFieldRules public Parses the field rules file.
(Inherited from TGIS_LayerVector)
RecalcExtent public Recalculates extent.
(Inherited from TGIS_LayerVector)
RecalcProjectedExtent public Recalculates a projected extent.
(Inherited from TGIS_Layer)
releaseFlash protected Used by TGIS_Shape to remove itself from the flash queue.
(Inherited from TGIS_LayerVector)
removeCandidate protected Remove shape from the candidate list.
(Inherited from TGIS_LayerVector)
RenameField public Renames a field.
(Inherited from TGIS_LayerVector)
ReOpen public Reopens the layer.
(Inherited from TGIS_Layer)
ReorderShapeUids public Internal method to rebuild shape's uid values and ensure ascending order.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
RevertAll public
(Inherited from TGIS_LayerVector)
RevertShapes public Reverts all shapes to their original state.
(Inherited from TGIS_LayerVector)
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_LayerVector.SaveData)
SaveFieldRules public Save field rules file.
(Inherited from TGIS_LayerVector)
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_LayerVector.setUp)
setUp2 protected
(Inherited from TGIS_LayerVector)
setUp3 protected
(Inherited from TGIS_LayerVector)
storeConfigOptions protected
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
UnlockRenderInternal public This method is used only for internal use on layer reading.
(Inherited from TGIS_LayerVector)
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.
(Overrides TGIS_LayerVector.WriteShapeDirect)

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.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
DefaultShapeType public Default shape type for the layer.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
FieldsVirtual public List of virtual fields.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
InMemoryRTree public True if RTree file will be created in-memory.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
JoinADO public ADO Query to be joined.
(Inherited from TGIS_LayerVector)
JoinCodePage public Code page for JoinADO/JoinDB.
(Inherited from TGIS_LayerVector)
JoinDB public DB Query to be joined.
(Inherited from TGIS_LayerVector)
JoinForeign public Field from Query to be joined.
(Inherited from TGIS_LayerVector)
JoinJDBC public JDBC ResultSet of Query to be joined.
(Inherited from TGIS_LayerVector)
JoinJDBCQuery public JDBC Query to be joined.
(Inherited from TGIS_LayerVector)
JoinPrimary public Field from feature table to be joined.
(Inherited from TGIS_LayerVector)
LabelingMode public Labeling mode metadata.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
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)
PathCPG public Path to a CPG file.
PathDBF public Path to a DBF file.
PathFLD public Path to field definitions ini file.
(Inherited from TGIS_LayerVector)
PathFLDX public Path to field rules file.
(Inherited from TGIS_LayerVector)
PathPRJ public Path to a PRJ file.
PathRTree public Path to RTree index.
(Inherited from TGIS_LayerVector)
PathSHP public Path to a SHP file.
PathSHX public Path to a SHX file.
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.
(Inherited from TGIS_LayerVector)
Scope public Scope zone.
(Inherited from TGIS_LayerVector)
ScopeExtent public Scope extent.
(Inherited from TGIS_LayerVector)
SelectedList public List of uids of the selected shapes.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
SupportedShapes public Set of shapes supported by a layer.
(Inherited from TGIS_LayerVector)
SupportedShapesAll public Similar to SupportedShapesSet, but this lists also includes shape types added temporarily by the aggregator.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
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.
(Inherited from TGIS_LayerVector)
UseShapeStyleField public If true than params style attribute field was defined.
(Inherited from TGIS_LayerVector)
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)

Remarks

Metadata

Available metadata keys :

Metadata Values Default Description
TGIS_LayerSHP.SafeFieldName TRUE FALSE FALSE False force shorter field name size. Due to some misunderstanding, some application accepts 11 characters names while others accept only 10 characters.
TGIS_LayerSHP.CheckWinding TRUE FALSE FALSE Fix winding of polygon before export.
TGIS_LayerSHP.DefaultCodePage code page 0 Default code page to be used if not .cpg file nor .dbf header are set.
TGIS_LayerSHP.IgnoreHeaderShapeType TRUE FALSE FALSE For XYZM dimension each shape is verified instead of using header shape type info.

Limitations

Geometry limitations:

  • 2 GB size limit for any shapefile component file

Attribute limitations:

  • store numeric attributes in character format rather than binary format
  • The dBASE file standard only supports ANSI characters in their field names and values
  • Date fields only support date,not support time
  • Field names cannot be longer than 10 characters
  • The maximum record length for an attribute is 32767
  • The maximum number of fields is 255
  • The dBASE file must contain at least one field
  • Null values are not supported

Shape types

Mixing shape types is not allowed. For example, when concerning wells (point), rivers (polyline) and lakes (polygon), they must be stored in three separate shapefiles.

Error codes

During some operations, “File … has wrong format or was corrupted” exception is raised with a code referring to known limitations:

Code Description
65536 The maximum buffer size of geometry exceeded
32767 The maximum buffer size of attribute exceeded

References

2024/09/13 01:13

Page Tools