User Tools

Site Tools


api:dk11:activex:tatukgis_xdk11.tgis_layershp

TGIS_LayerSHP class

DK11 for ActiveX | TatukGIS_XDK11.TGIS_LayerSHP | Classes | Methods | Properties

Layer that can read SHP file.

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

Syntax

// C#
public class TGIS_LayerSHP : ITGIS_LayerSHP, ITGIS_LayerVectorEvents 
{
}
' VisualBasic
Public Class TGIS_LayerSHP
  Implements ITGIS_LayerSHP
  Implements ITGIS_LayerVectorEvents
End Class
// Oxygene
type
  TGIS_LayerSHP = public class
  end;

Implements

Methods

Inherited Overrides Protected
Name Visibility Description
AddField public Add a new field.
(Inherited from ITGIS_LayerVector)
AddFieldInternal public Add new field.
(Inherited from ITGIS_LayerVector)
AddFieldInternal_2 public Add new field.
(Inherited from ITGIS_LayerVector)
AddShape public Add a new shape (a copy) and make it editable.
(Inherited from ITGIS_LayerVector)
AddShape_2 public Add a new shape (a copy) and make it editable.
(Inherited from ITGIS_LayerVector)
Alive public Makes a layer non-dormant.
(Inherited from ITGIS_Layer)
ApplyCuttingPolygon public Set cutting polygon for a layer.
(Inherited from ITGIS_Layer)
AttachDelphiObj public Only for internal use of TatukGIS.
(Inherited from ITBaseObject)
Build public Build new layer - prepare storage.
(Inherited from ITGIS_LayerVector)
Build_2 public Build new layer - prepare storage.
(Inherited from ITGIS_LayerVector)
CentroidScope public Calculate a centroid for a scope.
(Inherited from ITGIS_LayerVector)
ChangeHash public Change hash.
(Inherited from ITGIS_Layer)
ClearModified public Set IsModified flag to false for a layer and sublayers.
(Inherited from ITGIS_Layer)
CreateShape public Create a new shape and make it editable.
(Inherited from ITGIS_LayerVector)
CreateShape_2 public Create a new shape and make it editable
(Inherited from ITGIS_LayerVector)
CursorAfterFetchEvent public CursorAfterFetch event.
(Inherited from ITGIS_LayerVectorEvents)
CursorBeforeFetchEvent public CursorBeforeFetch event.
(Inherited from ITGIS_LayerVectorEvents)
CursorCloseEvent public CursorClose event.
(Inherited from ITGIS_LayerVectorEvents)
CursorOpenEvent public CursorOpen event.
(Inherited from ITGIS_LayerVectorEvents)
Delete public Delete a shape.
(Inherited from ITGIS_LayerVector)
DeleteField public Delete field.
(Inherited from ITGIS_LayerVector)
DelphiObj public Only for internal use of TatukGIS.
(Inherited from ITBaseObject)
Deselect public Clear selection of shape.
(Inherited from ITGIS_LayerVector)
DeselectAll public Clear selection of all shapes.
(Inherited from ITGIS_LayerVector)
Dormant public Makes a layer dormant.
(Inherited from ITGIS_Layer)
DormantGain public Calculate approximate gain (in Megabytes) which can be achieved releasing memory by calling Dormant()
(Inherited from ITGIS_Layer)
Draw public Draws a layer.
(Inherited from ITGIS_Layer)
DrawChart public Draw layer charts.
(Inherited from ITGIS_LayerVector)
DrawEx public Draws a layer with given extent.
(Inherited from ITGIS_Layer)
DrawFlash public Draw flashed
(Inherited from ITGIS_Layer)
DrawScope public Draw only shapes that meet a scope criteria.
(Inherited from ITGIS_LayerVector)
DrawSelected public Draws a layer.
(Inherited from ITGIS_Layer)
DrawSelectedEx public Draws a layer with given extent.
(Inherited from ITGIS_Layer)
ExportLayer public Export layer.
(Inherited from ITGIS_LayerVector)
ExportLayerEx public Export layer.
(Inherited from ITGIS_LayerVector)
ExportLayer_2 public Export layer.
(Inherited from ITGIS_LayerVector)
ExportStructureToFLD public Export fields structure to fld file.
(Inherited from ITGIS_LayerVector)
FieldInfo public Return pointer to GIS_FieldInfo structure.
(Inherited from ITGIS_LayerVector)
FinalizeDirectWrite public Finalize direct writing into a layer storage.
(Inherited from ITGIS_LayerVector)
FindField public Find field in a field list.
(Inherited from ITGIS_LayerVector)
FindFieldInternal public Find field in a field list.
(Inherited from ITGIS_LayerVector)
FindFirst public Find first occurrence of an item which meets extent and query.
(Inherited from ITGIS_LayerVector)
FindFirst_2 public Find first occurrence of an item which meets extent and query.
(Inherited from ITGIS_LayerVector)
FindFirst_3 public Find first occurrence of an item which meets extent and query.
(Inherited from ITGIS_LayerVector)
FindFirst_4 public Find first occurrence of an item which meets extent and query.
(Inherited from ITGIS_LayerVector)
FindFirst_5 public Find first occurrence of an item which meets extent and query.
(Inherited from ITGIS_LayerVector)
FindNext public Find next occurrence of item defined in FindFirst.
(Inherited from ITGIS_LayerVector)
FlashShape public Flash shape several times
(Inherited from ITGIS_LayerVector)
ForEach public Fetch all shapes form the layer using callback function.
(Inherited from ITGIS_LayerVector)
ForEachSubLayer public Return in callback event a layer and all sublayers that belong it.
(Inherited from ITGIS_Layer)
GetAvailableLayers public Get a list of layers available in storage.
(Inherited from ITGIS_Layer)
GetField public Get field value for a shape given by unique identity.
(Inherited from ITGIS_LayerVector)
GetFieldEx public Get field value for a shape given by unique identity.
(Inherited from ITGIS_LayerVector)
GetLastUid public Peek a Uid of last shape.
(Inherited from ITGIS_LayerVector)
GetNewUid public Finds a Uid for a new shape.
(Inherited from ITGIS_LayerVector)
GetSelectedCount public Return the number of selected shapes.
(Inherited from ITGIS_LayerVector)
GetShape public Get shape by unique identifier on default cursor (0).
(Inherited from ITGIS_LayerVector)
GetShape_2 public Get shape by unique identifier.
(Inherited from ITGIS_LayerVector)
GetUniqueFieldName public Suggests unique field name.
(Inherited from ITGIS_LayerVector)
HourglassShake public Notify on hourglass on busy state.
(Inherited from ITGIS_Layer)
ImportLayer public Import layer from an existing layer.
(Inherited from ITGIS_LayerVector)
ImportLayerEx public Import layer from an existing layer.
(Inherited from ITGIS_LayerVector)
ImportLayer_2 public Import layer from an existing layer.
(Inherited from ITGIS_LayerVector)
ImportStructure public Import the field structure from another layer
(Inherited from ITGIS_LayerVector)
InitializeDirectWrite public Build new layer - prepare storage for direct writing.
(Inherited from ITGIS_LayerVector)
InvalidateScope public Invalidate shapes in the scope.
(Inherited from ITGIS_LayerVector)
InvalidateSelection public Invalidate all selected shape (but only to redraw selection not shapes itself.
(Inherited from ITGIS_LayerVector)
IsGrid public Is layer a grid type.
(Inherited from ITGIS_Layer)
IsPixel public Is layer a pixel type.
(Inherited from ITGIS_Layer)
IsSupported public Is operation supported by a layer.
(Inherited from ITGIS_Layer)
IsVector public Is layer a vector type.
(Inherited from ITGIS_Layer)
IsVector3D public Is layer a vector type.
(Inherited from ITGIS_Layer)
IsVisible public Check if a layer is visible in given extent and current params.
(Inherited from ITGIS_Layer)
LabelPosEvent public LabelPos event.
(Inherited from ITGIS_LayerVectorEvents)
LegendInfo public Return parameters filled with the renderer styling.
(Inherited from ITGIS_LayerVector)
Locate public Locate a shape.
(Inherited from ITGIS_LayerVector)
LocateEx public Locate a shape (more precise).
(Inherited from ITGIS_LayerVector)
LocateEx_2 public Locate a shape (more precise).
(Inherited from ITGIS_LayerVector)
LocateEx_3 public Locate a shape (more precise).
(Inherited from ITGIS_LayerVector)
Locate_2 public Locate a shape.
(Inherited from ITGIS_LayerVector)
Lock public Lock a layer burst-mode operation.
(Inherited from ITGIS_Layer)
Loop public Prepare enumerator (also known as iterator or cursor) to iterate layer.
(Inherited from ITGIS_LayerVector)
Loop_2 public Prepare enumerator (also known as iterator or cursor) to iterate layer.
(Inherited from ITGIS_LayerVector)
Loop_3 public Prepare enumerator (also known as iterator or cursor) to iterate layer.
(Inherited from ITGIS_LayerVector)
Loop_4 public Prepare enumerator (also known as iterator or cursor) to iterate layer.
(Inherited from ITGIS_LayerVector)
Loop_5 public Prepare enumerator (also known as iterator or cursor) to iterate layer.
(Inherited from ITGIS_LayerVector)
MergeLayer public Merge layer from an existing layer.
(Inherited from ITGIS_LayerVector)
MergeLayerEx public Merge layer from an existing layer.
(Inherited from ITGIS_LayerVector)
MergeLayer_2 public Merge layer from an existing layer.
(Inherited from ITGIS_LayerVector)
MergeStructure public Merge the field structure from another layer
(Inherited from ITGIS_LayerVector)
MergeStructure_2 public Merge the field structure from another layer
(Inherited from ITGIS_LayerVector)
Move public Move a layer up or down in a viewer zorder list.
(Inherited from ITGIS_Layer)
MoveEx public Move a layer up or down in a viewer zorder list.
(Inherited from ITGIS_Layer)
MustCalculateStatistics public Verify if all statistics required to properly render layer are available.
(Inherited from ITGIS_Layer)
MustReproject public Do layer must reproject.
(Inherited from ITGIS_Layer)
MustSave public Check if the layer was modified by editing.
(Inherited from ITGIS_Layer)
Open public Open the layer.
(Inherited from ITGIS_Layer)
Paint public Draws a layer or fires PaintLayer event ( if defined ).
(Inherited from ITGIS_Layer)
PaintShapeChartEvent public PaintShapeChart event.
(Inherited from ITGIS_LayerVectorEvents)
PaintShapeEvent public PaintShape event.
(Inherited from ITGIS_LayerVectorEvents)
PaintShapeLabelEvent public PaintShapeLabel event.
(Inherited from ITGIS_LayerVectorEvents)
ParamsAsDrawn public Get a shape styling parameters used during drawing on a viewer and fill _params parameter with them.
(Inherited from ITGIS_LayerVector)
Prepare public Open the layer.
(Inherited from ITGIS_Layer)
PrepareExportFieldNames public Prepare export field names.
(Inherited from ITGIS_LayerVector)
PrepareExportFieldNames_2 public Prepare export field names.
(Inherited from ITGIS_LayerVector)
PrepareExportFieldNames_3 public Prepare export field names.
(Inherited from ITGIS_LayerVector)
PreRecognize public Check if layer can read a file.
(Inherited from ITGIS_Layer)
Project public Apply a projection on the single point.
(Inherited from ITGIS_Layer)
Project3D public Apply a projection on the single point in 3D.
(Inherited from ITGIS_Layer)
Project3D_Ref public Apply a projection on the single point in 3D.
(Inherited from ITGIS_Layer)
Project_Ref public Apply a projection on the single point.
(Inherited from ITGIS_Layer)
RaiseBusyEvent public Fire Busy event of a layer.
(Inherited from ITGIS_Layer)
RaiseBusyPrepare public Fire BusyPrepare method of a viewer.
(Inherited from ITGIS_Layer)
RaiseBusyRelease public Fire BusyRelease method of a viewer.
(Inherited from ITGIS_Layer)
RaiseBusyShake public Fire BusyShake method of a viewer.
(Inherited from ITGIS_Layer)
ReadConfig public Read layer configuration files.
(Inherited from ITGIS_Layer)
ReadConfigParam public Read layer configuration parameter.
(Inherited from ITGIS_Layer)
ReadFieldDefinition public Parse field definition file.
(Inherited from ITGIS_LayerVector)
ReadFieldRules public Parse field rules file.
(Inherited from ITGIS_LayerVector)
RecalcExtent public Recalculate extent based on real shapes.
(Inherited from ITGIS_Layer)
RecalcProjectedExtent public Recalculate a projected extent.
(Inherited from ITGIS_Layer)
RenameField public Rename a field.
(Inherited from ITGIS_LayerVector)
ReOpen public Reopen the layer.
(Inherited from ITGIS_Layer)
RereadConfig public Reread layer configuration files.
(Inherited from ITGIS_Layer)
Revert public Revert a shape to the original state.
(Inherited from ITGIS_LayerVector)
RevertAll public Revert a layer to a original content.
(Inherited from ITGIS_Layer)
RevertShapes public Revert all shapes to the original state.
(Inherited from ITGIS_LayerVector)
RootLayer public Return absolute parent layer.
(Inherited from ITGIS_Layer)
SaveAll public Save layer and destroy mirrored items.
(Inherited from ITGIS_Layer)
SaveData public Save layer and destroy mirrored items.
(Inherited from ITGIS_Layer)
SetCSByEPSG public Setup Coordinate System to a coordinate system provided by EPSG code.
(Inherited from ITGIS_Layer)
SetCSByWKT public Setup Coordinate System to a coordinate system provided by WKT string (GEOGCS or PROJCS).
(Inherited from ITGIS_Layer)
SetCSByWKTFile public Setup Coordinate System to a coordinate system provided by file which contains WKT string (GEOGCS or PROJCS).
(Inherited from ITGIS_Layer)
ShapeFieldChangeEvent public ShapeFieldChange event.
(Inherited from ITGIS_LayerVectorEvents)
ShapeGeometryChangeEvent public ShapeGeometryChange event.
(Inherited from ITGIS_LayerVectorEvents)
Unlock public Unlock a layer from burst-mode operation.
(Inherited from ITGIS_Layer)
Unproject public Apply reverse projection (recover from projection) on the single point.
(Inherited from ITGIS_Layer)
Unproject3D public Apply reverse projection (recover from projection) on the single point in 3D.
(Inherited from ITGIS_Layer)
Unproject3D_Ref public Apply reverse projection (recover from projection) on the single point in 3D.
(Inherited from ITGIS_Layer)
Unproject_Ref public Apply reverse projection (recover from projection) on the single point.
(Inherited from ITGIS_Layer)
WriteConfig public Write layer configuration files.
(Inherited from ITGIS_Layer)
WriteShapeDirect public Write a shape directly into the layer storage.
(Inherited from ITGIS_LayerVector)

Properties

Inherited Protected
Name Visibility Description
Active public Is the Layer active? Active means that it can be visible, and that an object can be localized on such layers.
(Inherited from ITGIS_Layer)
Addition public Addition value.
(Inherited from ITGIS_Layer)
Age public Age of the layer.
(Inherited from ITGIS_Layer)
Basemap public True, if layer must be interpreted as basemap (for background painting).
(Inherited from ITGIS_Layer)
BlockRTree public If true, then UseRtree Rtree for the layer can not be enabled.
(Inherited from ITGIS_LayerVector)
CachedPaint public False, if layer must be painted directly (bypassing cache).
(Inherited from ITGIS_Layer)
Caption public Caption of layer, if not filed directly then will be filed with Name while adding to the Viewer.
(Inherited from ITGIS_Layer)
CodePage public Code Page in which text has been stored.
(Inherited from ITGIS_Layer)
Collapsed public Is the Layer collapsed? Collapsed means that inside legend only title will be visible.
(Inherited from ITGIS_Layer)
Comments public Additional user comments.
(Inherited from ITGIS_Layer)
ConfigFile public Configuration file handle.
(Inherited from ITGIS_Layer)
ConfigName public Configuration file name.
(Inherited from ITGIS_Layer)
CS public Coordinate System assigned to the layer.
(Inherited from ITGIS_Layer)
CustomData public List of custom, user-defined data.
(Inherited from ITGIS_Layer)
DefaultDimension public Default shape dimension for layer.
(Inherited from ITGIS_LayerVector)
DefaultShapeType public Default shape type for layer.
(Inherited from ITGIS_LayerVector)
DirectMode public Return True, if the layer is direct-mode (bypassing cache).
(Inherited from ITGIS_Layer)
DormantMode public Dormant mode for the layer.
(Inherited from ITGIS_Layer)
Driver public Layer driver name.
(Inherited from ITGIS_Layer)
Extent public Extent of the layer.
(Inherited from ITGIS_Layer)
Extent3D public Extent 3D of the layer.
(Inherited from ITGIS_Layer)
Fields public List of database fields definitions.
(Inherited from ITGIS_LayerVector)
FieldsVirtual public List of virtual fields.
(Inherited from ITGIS_LayerVector)
FileCopyrights public Copyright information about the layer.
(Inherited from ITGIS_Layer)
FileInfo public Additional textual information about the layer such compression, number of pixels, copyright etc.
(Inherited from ITGIS_Layer)
HideFromLegend public False, if layer should not be visible in a legend.
(Inherited from ITGIS_Layer)
IgnoreShapeParams public If True then only layer level params will be used.
(Inherited from ITGIS_LayerVector)
InMemoryRTree public True, if rtree file will be created in-memory.
(Inherited from ITGIS_LayerVector)
IsExportable public True if layer is exportable.
(Inherited from ITGIS_Layer)
IsLocked public True, if layer is in locked state Lock.
(Inherited from ITGIS_Layer)
IsOpened public True, if layer was opened and is ready for operations.
(Inherited from ITGIS_Layer)
IsPersistent public True if layer is persistent.
(Inherited from ITGIS_Layer)
IsReadOnly public Is layer read only.
(Inherited from ITGIS_Layer)
IsTopmost public True, if layer can be interpreted as topmost (trackable).
(Inherited from ITGIS_Layer)
Items public List of all ghost items.
(Inherited from ITGIS_LayerVector)
JoinADO public ADO Query to be joined.
(Inherited from ITGIS_LayerVector)
JoinCodePage public Code page for JoinADO/JoindDB.
(Inherited from ITGIS_LayerVector)
JoinForeign public Field from Query to be joined.
(Inherited from ITGIS_LayerVector)
JoinPrimary public Field from feature table to be joined.
(Inherited from ITGIS_LayerVector)
LabelingMode public Labeling mode metadata.
(Inherited from ITGIS_LayerVector)
MaxTileSize public Maximum allowed tile size for the layer.
(Inherited from ITGIS_Layer)
MultipassRendering public Force multipass rendering.
(Inherited from ITGIS_LayerVector)
MultiUserMode public Multiuser mode.
(Inherited from ITGIS_Layer)
Name public Name of layer, if not field directly then will be field with Path while adding to the Viewer.
(Inherited from ITGIS_Layer)
Params public Returns parameters (colors, fills, etc.) object.
(Inherited from ITGIS_LayerVector)
ParamsList public List of all parameters sections attached to the current layer.
(Inherited from ITGIS_Layer)
Params_ public Parameters (colors, fills etc) object.
(Inherited from ITGIS_Layer)
ParentLayer public Sub layer parent layer.
(Inherited from ITGIS_Layer)
Path public Path to file with layer data.
(Inherited from ITGIS_Layer)
PathCPG public Path to a CPG file.
PathDBF public Path to a DBF file.
PathFLD public Path to fields definition ini file.
(Inherited from ITGIS_LayerVector)
PathFLDX public Path to field rules file.
(Inherited from ITGIS_LayerVector)
PathPRJ public Path to a PRJ file.
PathRTree public Path to RTree index.
(Inherited from ITGIS_LayerVector)
PathSHP public Path to a SHP file.
PathSHX public Path to a SHX file.
PathWithDriver public Path to file with layer data extended with driver name.
(Inherited from ITGIS_Layer)
ProjectedExtent public Extent of the layer in projected units.
(Inherited from ITGIS_Layer)
Renderer public Handle to a renderer used for drawing shapes.
(Inherited from ITGIS_Layer)
Scope public Scope zone.
(Inherited from ITGIS_LayerVector)
ScopeExtent public Scope extent.
(Inherited from ITGIS_LayerVector)
SelectedList public List of uids of selected shapes.
(Inherited from ITGIS_LayerVector)
Statistics public Layer statistics engine
(Inherited from ITGIS_Layer)
Stream public Reference to a potential layer underlying stream.
(Inherited from ITGIS_Layer)
SubLayers public Sub layers list.
(Inherited from ITGIS_Layer)
SubType public Layer type.
(Inherited from ITGIS_Layer)
SupportedDimensions public Set of dimensions supported by a layer.
(Inherited from ITGIS_LayerVector)
SupportedShapes public Set of shapes supported by a layer.
(Inherited from ITGIS_LayerVector)
SymbolingMode public Symboling mode metadata.
(Inherited from ITGIS_LayerVector)
Tag public Tag has no predefined meaning.
(Inherited from ITGIS_Layer)
TagInternal public TagInternal has no predefined meaning.
(Inherited from ITGIS_Layer)
TagPointer public TagPointer has no predefined meaning.
(Inherited from ITGIS_Layer)
Transform public Custom transformation.
(Inherited from ITGIS_Layer)
Transparency public Transparency value.
(Inherited from ITGIS_Layer)
UnSupportedOperations public Set of operations not supported by a layer.
(Inherited from ITGIS_Layer)
UseConfig public Is config file active?
(Inherited from ITGIS_Layer)
UserObject public UserObject can be used to associate with the layer a user defined objects.
(Inherited from ITGIS_Layer)
UseRTree public Set the use of an index based on RTree structure.
(Inherited from ITGIS_LayerVector)
Viewer public Reference to viewer object.
(Inherited from ITGIS_Layer)
ZOrder public Layer position relative to other layers.
(Inherited from ITGIS_Layer)
ZOrderEx public Layer position relative to other layers.
(Inherited from ITGIS_Layer)

Remarks

- Supported shape types (one per each file): TGIS_ShapeType.Point, TGIS_ShapeType.MultiPoint, TGIS_ShapeType.Arc, TGIS_ShapeType.Polygon. 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.

2019/07/11 01:04