api:dk11:activex:tatukgis_xdk11.tgis_layerjpg
Table of Contents
TGIS_LayerJPG class
DK11 for ActiveX | TatukGIS_XDK11.TGIS_LayerJPG | Classes | Methods | Properties
Encapsulation of a JPEG layer.
Syntax
// C# public class TGIS_LayerJPG : ITGIS_LayerJPG, ITGIS_LayerPixelEvents { }
' VisualBasic Public Class TGIS_LayerJPG Implements ITGIS_LayerJPG Implements ITGIS_LayerPixelEvents End Class
// Oxygene type TGIS_LayerJPG = public class end;
Implements
Methods
Inherited
Overrides
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| Alive | public | Makes a layer non-dormant. (Inherited from ITGIS_Layer) |
|
| ApplyAntialiasSettings | public | Applies antialias settings used in scaling operations. (Inherited from ITGIS_LayerPixel) |
|
| ApplyAntialiasSettings_2 | public | Applies antialias settings used in scaling operations. (Inherited from ITGIS_LayerPixel) |
|
| ApplyCuttingPolygon | public | Sets a cutting polygon for a layer. (Inherited from ITGIS_Layer) |
|
| AssignedParentLayerInternal | public | Assigns a parent layer. (Inherited from ITGIS_LayerPixel) |
|
| AttachDelphiObj | public | Only for internal use of TatukGIS. (Inherited from ITBaseObject) |
|
| Build | public | Builds an in-memory layer. (Inherited from ITGIS_LayerPixel) |
|
| Build_2 | public | Builds a layer. (Inherited from ITGIS_LayerPixel) |
|
| Build_3 | public | Builds an image layer. (Inherited from ITGIS_LayerPixel) |
|
| Build_4 | public | Builds an in-memory layer. (Inherited from ITGIS_LayerPixel) |
|
| Build_5 | public | Builds a layer. (Inherited from ITGIS_LayerPixel) |
|
| Build_6 | public | Builds an image layer. (Inherited from ITGIS_LayerPixel) |
|
| ChangeHash | public | Changes the hash for the purpose of verifying layer's modifications. (Inherited from ITGIS_Layer) |
|
| ClearModified | public | Sets IsModified flag to false for a layer and its sublayers. (Inherited from ITGIS_Layer) |
|
| DelphiObj | public | Only for internal use of TatukGIS. (Inherited from ITBaseObject) |
|
| Dormant | public | Makes a layer dormant. (Inherited from ITGIS_Layer) |
|
| DormantGain | public | Calculates the approximate gain (in Megabytes) which can be achieved by releasing memory by calling Dormant method. (Inherited from ITGIS_Layer) |
|
| Draw | public | Draws a layer. (Inherited from ITGIS_Layer) |
|
| DrawEx | public | Draws a layer within a defined extent. (Inherited from ITGIS_Layer) |
|
| DrawFlash | public | Draws a flash. (Inherited from ITGIS_Layer) |
|
| DrawSelected | public | Draws only the selected item(s) on layer. (Inherited from ITGIS_Layer) |
|
| DrawSelectedEx | public | Draws only the selected item(s) on layer that are within a defined extent. (Inherited from ITGIS_Layer) |
|
| ExportLayer | public | Export layer. (Inherited from ITGIS_LayerPixel) |
|
| FinalizeWrite | public | Performs any operation required to safely finalize write operation, such as building quad trees for TGIS_FilePixelStore. (Inherited from ITGIS_LayerPixel) |
|
| ForEachSubLayer | public | Returns in callback event the layer and all sublayers belonging to it. (Inherited from ITGIS_Layer) |
|
| GenerateRamp | public | Generates a grid ramp. (Inherited from ITGIS_LayerPixel) |
|
| GenerateRampEx | public | Generates a grid ramp from a mapped color array. (Inherited from ITGIS_LayerPixel) |
|
| GenerateRampEx_2 | public | Generates a grid ramp from a mapped color array. (Inherited from ITGIS_LayerPixel) |
|
| GenerateRamp_2 | public | Generates a grid ramp. (Inherited from ITGIS_LayerPixel) |
|
| GetAvailableLayers | public | Gets a list of layers available in storage. (Inherited from ITGIS_Layer) |
|
| GetBitmap | public | Fills provided _bitmap array with values defined by _extent. (Inherited from ITGIS_LayerPixel) |
|
| GetColorRamp | public | Calculates default color ramp RGB values. (Inherited from ITGIS_LayerPixel) |
|
| GetGrid | public | Fills provided _grid array with values defined by _extent. (Inherited from ITGIS_LayerPixel) |
|
| GetRawBitmap | public | Fills provided _bitmap array with values defined by _extent. (Inherited from ITGIS_LayerPixel) |
|
| GridOperationEvent | public | Grid operation event. (Inherited from ITGIS_LayerPixelEvents) |
|
| HourglassShake | public | Notifies of busy state using an hourglass. (Inherited from ITGIS_Layer) |
|
| ImportLayer | public | Imports layer from an existing pixel layer. (Inherited from ITGIS_LayerPixel) |
|
| ImportLayer_2 | public | Imports layer from an existing pixel layer. (Inherited from ITGIS_LayerPixel) |
|
| ImportLayer_3 | public | Imports layer from an existing pixel layer. (Inherited from ITGIS_LayerPixel) |
|
| InitializeWrite | public | Performs any operation required to safely initialize write operation, such as batch operations for TGIS_FilePixelStore. (Inherited from ITGIS_LayerPixel) |
|
| IsGrid | public | Checks if the layer type is grid. (Inherited from ITGIS_Layer) |
|
| IsPixel | public | Checks if the layer type is pixel. (Inherited from ITGIS_Layer) |
|
| IsSupported | public | Checks if the operation is supported by the layer. (Inherited from ITGIS_Layer) |
|
| IsVector | public | Checks if the layer type is vector. (Inherited from ITGIS_Layer) |
|
| IsVector3D | public | Checks if the layer type is vector 3D. (Inherited from ITGIS_Layer) |
|
| IsVisible | public | Checks if the layer is visible in a defined extent and current params. (Inherited from ITGIS_Layer) |
|
| Locate | public | If a given point is located in the image area, returns true and sets variables. (Inherited from ITGIS_LayerPixel) |
|
| LocateEx | public | If a given point is located in the image area, returns true and sets variables. (Inherited from ITGIS_LayerPixel) |
|
| Lock | public | Locks layer in burst-mode operation. (Inherited from ITGIS_Layer) |
|
| LockEstimate | public | Estimates memory size for pixel layer to be update. (Inherited from ITGIS_LayerPixel) |
|
| LockPixels | public | Locks a fragment of the pixel layer for updating. (Inherited from ITGIS_LayerPixel) |
|
| LockPixels_2 | public | Locks a fragment of the pixel layer for updating. (Inherited from ITGIS_LayerPixel) |
|
| LockPixels_3 | public | Locks a fragment of the pixel layer for updating. (Inherited from ITGIS_LayerPixel) |
|
| LockPixels_4 | public | Locks a fragment of the pixel layer for updating. (Inherited from ITGIS_LayerPixel) |
|
| LockPixels_5 | public | Locks a fragment of the pixel layer for updating. (Inherited from ITGIS_LayerPixel) |
|
| LockPixels_6 | public | Locks a fragment of the pixel layer for updating. (Inherited from ITGIS_LayerPixel) |
|
| LockPixels_7 | public | Locks a fragment of the pixel layer for updating. (Inherited from ITGIS_LayerPixel) |
|
| Loop | public | Prepares enumerator to iterate the layer through the linear shape. (Inherited from ITGIS_LayerPixel) |
|
| Loop_2 | public | Prepares enumerator to iterate the layer (pixels are treated as points). (Inherited from ITGIS_LayerPixel) |
|
| Loop_3 | public | Prepares enumerator to iterate the layer. (Inherited from ITGIS_LayerPixel) |
|
| Loop_4 | public | Prepares enumerator to iterate the layer (pixels are treated as points). (Inherited from ITGIS_LayerPixel) |
|
| Loop_5 | public | Prepares enumerator to iterate the layer through the linear shape. (Inherited from ITGIS_LayerPixel) |
|
| Loop_6 | public | Prepares enumerator to iterate the layer. (Inherited from ITGIS_LayerPixel) |
|
| Loop_7 | public | Prepares enumerator to iterate the layer (pixels are treated as points). (Inherited from ITGIS_LayerPixel) |
|
| Loop_8 | public | Prepares enumerator to iterate the layer (pixels are treated as points). (Inherited from ITGIS_LayerPixel) |
|
| MapColorValue | public | Maps color value to pixel color. (Inherited from ITGIS_LayerPixel) |
|
| MapGridValue | public | Maps grid value to pixel color. (Inherited from ITGIS_LayerPixel) |
|
| MapToRaster | public | Converts map coordinates to raster pixel location. (Inherited from ITGIS_LayerPixel) |
|
| MapToRasterRect | public | Converts map extent to raster rectangle. (Inherited from ITGIS_LayerPixel) |
|
| MergeLayer | public | Merge layer to an existing layer. (Inherited from ITGIS_LayerPixel) |
|
| Move | public | Moves a layer up or down in the viewer zorder list. (Inherited from ITGIS_Layer) |
|
| MoveEx | public | Moves a layer up or down in the viewer zorder list (only visible layers). (Inherited from ITGIS_Layer) |
|
| MustCalculateStatistics | public | Verifies if all statistics required to properly render the layer are available. (Inherited from ITGIS_Layer) |
|
| MustReproject | public | Checks if the layer must be reprojected. (Inherited from ITGIS_Layer) |
|
| MustSave | public | Checks if the layer was modified by editing. (Inherited from ITGIS_Layer) |
|
| Open | public | Opens the layer. (Inherited from ITGIS_Layer) |
|
| Paint | public | Draws the layer or fires PaintLayer event (if defined). (Inherited from ITGIS_Layer) |
|
| PixelOperationEvent | public | Pixel operation event. (Inherited from ITGIS_LayerPixelEvents) |
|
| Prepare | public | Opens the layer. (Inherited from ITGIS_Layer) |
|
| PreRecognize | public | Checks if the layer can read the file. (Inherited from ITGIS_Layer) |
|
| Project | public | Applies a projection on the single point. (Inherited from ITGIS_Layer) |
|
| Project3D | public | Applies a projection on the single point in 3D. (Inherited from ITGIS_Layer) |
|
| Project3D_Ref | public | Applies a projection on the single point in 3D. (Inherited from ITGIS_Layer) |
|
| ProjectExtent | public | Applies a projection on the extent. (Inherited from ITGIS_Layer) |
|
| Project_Ref | public | Applies a projection on the single point. (Inherited from ITGIS_Layer) |
|
| PutGrid | public | Puts _grid array into layer at the place defined by _extent. (Inherited from ITGIS_LayerPixel) |
|
| RaiseBusyEvent | public | Fires Busy event of the layer. (Inherited from ITGIS_Layer) |
|
| RaiseBusyPrepare | public | Fires BusyPrepare method of the assigned viewer. (Inherited from ITGIS_Layer) |
|
| RaiseBusyRelease | public | Fires BusyRelease method of the assigned viewer. (Inherited from ITGIS_Layer) |
|
| RaiseBusyShake | public | Fires BusyShake method of the assigned viewer. (Inherited from ITGIS_Layer) |
|
| RasterToMap | public | Converts raster pixel location to map coordinates (Inherited from ITGIS_LayerPixel) |
|
| RasterToMapRect | public | Convert raster rectangle to map extent (Inherited from ITGIS_LayerPixel) |
|
| ReadConfig | public | Reads the layer configuration files. (Inherited from ITGIS_Layer) |
|
| ReadConfigParam | public | Reads the layer configuration parameters. (Inherited from ITGIS_Layer) |
|
| ReadGridLine | public | Reads a specific line of the grid into the preallocated buffer. (Inherited from ITGIS_LayerPixel) |
|
| RecalcExtent | public | Recalculates extent based on real shapes. (Inherited from ITGIS_Layer) |
|
| RecalcProjectedExtent | public | Recalculates a projected extent. (Inherited from ITGIS_Layer) |
|
| Recalculate | public | Recalculates layer MinZ and MaxZ values. (Inherited from ITGIS_LayerPixel) |
|
| ReOpen | public | Reopens the layer. (Inherited from ITGIS_Layer) |
|
| RereadConfig | public | Rereads the layer configuration files. (Inherited from ITGIS_Layer) |
|
| RevertAll | public | Reverts layer to its original content. (Inherited from ITGIS_Layer) |
|
| RootLayer | public | Returns the absolute parent layer. (Inherited from ITGIS_Layer) |
|
| SaveAll | public | Saves layer and destroys mirrored items. (Inherited from ITGIS_Layer) |
|
| SaveData | public | Saves layer and destroys mirrored items. (Inherited from ITGIS_Layer) |
|
| ScaleGrid | public | Scales grid array using a linear filter by default. (Inherited from ITGIS_LayerPixel) |
|
| ScaleGrid_2 | public | Scales grid array using defined filtering. (Inherited from ITGIS_LayerPixel) |
|
| SetCSByEPSG | public | Sets up Coordinate System to a coordinate system provided by a EPSG code. (Inherited from ITGIS_Layer) |
|
| SetCSByWKT | public | Sets up Coordinate System to a coordinate system provided by a WKT string (GEOGCS or PROJCS). (Inherited from ITGIS_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 ITGIS_Layer) |
|
| SetCurrentFileScale | public | Sets internal file scales - (1.0, 1.0) is always possible (Inherited from ITGIS_LayerPixel) |
|
| SetWorld | public | Sets world parameters (equivalent to worldfile). (Inherited from ITGIS_LayerPixel) |
|
| Unlock | public | Unlocks layer from burst-mode operation. (Inherited from ITGIS_Layer) |
|
| UnlockPixels | public | UnLocks a fragment. (Inherited from ITGIS_LayerPixel) |
|
| Unproject | public | Applies reverse projection (recovers from the projection) on the single point. (Inherited from ITGIS_Layer) |
|
| Unproject3D | public | Applies reverse projection (recovers from the projection) on the singlepoint in 3D. (Inherited from ITGIS_Layer) |
|
| Unproject3D_Ref | public | Applies reverse projection (recovers from the projection) on the single point in 3D. (Inherited from ITGIS_Layer) |
|
| UnprojectExtent | public | Applies reverse projection (recovers from the projection) on the extent. (Inherited from ITGIS_Layer) |
|
| Unproject_Ref | public | Applies reverse projection (recover from projection) on the single point. (Inherited from ITGIS_Layer) |
|
| ViewerReParent | public | Sets viewer for the layer and its sublayers. (Inherited from ITGIS_Layer) |
|
| WriteConfig | public | Writes layer configuration files. (Inherited from ITGIS_Layer) |
|
Properties
Inherited
Protected
Private
| 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 ITGIS_Layer) |
|
| Addition | public | Additional value. (Inherited from ITGIS_Layer) |
|
| Age | public | Age of the layer (since its creation). (Inherited from ITGIS_Layer) |
|
| Antialias | public | Antialias scaling (for some layers only like PNG and JPG). (Inherited from ITGIS_LayerPixel) |
|
| AntialiasFilter | public | Scaling filter (like Linear, Lanczos) to be used for scaling images and grids. (Inherited from ITGIS_LayerPixel) |
|
| BandsCount | public | Number of bands in a file. (Inherited from ITGIS_LayerPixel) |
|
| Basemap | public | True if the layer must be interpreted as basemap (for background painting). (Inherited from ITGIS_Layer) |
|
| BitHeight | public | Height of the layer in pixels. (Inherited from ITGIS_LayerPixel) |
|
| BitWidth | public | Width of the layer in pixels. (Inherited from ITGIS_LayerPixel) |
|
| CachedPaint | public | False if layer must be painted directly (bypassing cache). (Inherited from ITGIS_Layer) |
|
| Capabilities | public | Pixel sub-format list that is available for write operation. (Inherited from ITGIS_LayerPixel) |
|
| Caption | public | Caption of layer; if not filed directly then will be filed with Name when adding to the Viewer. (Inherited from ITGIS_Layer) |
|
| CellHeight | public | Height of a cell in pixels. (Inherited from ITGIS_LayerPixel) |
|
| CellWidth | public | Width of a cell in pixels. (Inherited from ITGIS_LayerPixel) |
|
| CodePage | public | Code Page in which text has been stored. (Inherited from ITGIS_Layer) |
|
| Collapsed | public | Checks if the layer is collapsed? Collapsed means only the layer's title will be visible inside the legend. (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 that is assigned to the layer. (Inherited from ITGIS_Layer) |
|
| CurrentPage | public | Current page of multipage file. (Inherited from ITGIS_LayerPixel) |
|
| CustomData | public | List of custom, user-defined data. (Inherited from ITGIS_Layer) |
|
| CuttingPolygon | public | Cutting polygon that defines an input image's valid area. (Inherited from ITGIS_LayerPixel) |
|
| DefaultSubFormat | public | Default subformat information. (Inherited from ITGIS_LayerPixel) |
|
| DirectMode | public | 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 | The layer's driver name. (Inherited from ITGIS_Layer) |
|
| Extent | public | Extent of the layer. (Inherited from ITGIS_Layer) |
|
| Extent3D | public | Three-dimensional extent of the layer. (Inherited from ITGIS_Layer) |
|
| FileCopyrights | public | Copyright information about the layer. (Inherited from ITGIS_Layer) |
|
| FileInfo | public | Additional textual information about the layer such as compression, number of pixels, copyright, etc. (Inherited from ITGIS_Layer) |
|
| ForcedBandsDefinition | public | Forced interpretation of bands in a layer. (Inherited from ITGIS_LayerPixel) |
|
| GridBand | public | Grid band number. (Inherited from ITGIS_LayerPixel) |
|
| HideFromLegend | public | False if the layer should not be visible in legend. (Inherited from ITGIS_Layer) |
|
| Interpretation | public | The way the layer is interpreted: the default is as a grid, or as an image. (Inherited from ITGIS_LayerPixel) |
|
| IsExportable | public | True if the layer is exportable. (Inherited from ITGIS_Layer) |
|
| IsGridImage | public | True if image is a grid. (Inherited from ITGIS_LayerPixel) |
|
| IsLocked | public | True if the layer is in locked state. (Inherited from ITGIS_Layer) |
|
| IsNativeGridImage | public | True if image is a native grid. (Inherited from ITGIS_LayerPixel) |
|
| IsOpened | public | True if the layer is opened and is ready for operations. (Inherited from ITGIS_Layer) |
|
| IsPersistent | public | True if the layer is persistent. (Inherited from ITGIS_Layer) |
|
| IsReadOnly | public | True if the layer is read-only. (Inherited from ITGIS_Layer) |
|
| IsTiled | public | True if layer is tiled. (Inherited from ITGIS_LayerPixel) |
|
| IsTopmost | public | True if the layer can be interpreted as the topmost (trackable) layer. (Inherited from ITGIS_Layer) |
|
| Layer3D | public | Mode of 3D operations (Inherited from ITGIS_Layer) |
|
| MaxHeight | public | Maximum elevation value of the grid. (Inherited from ITGIS_LayerPixel) |
|
| MaxHeightThreshold | public | Maximum threshold of the grid elevation values to display. (Inherited from ITGIS_LayerPixel) |
|
| MaxTileSize | public | Maximum allowed tile size for the layer. (Inherited from ITGIS_Layer) |
|
| MinHeight | public | Minimum elevation value of the grid. (Inherited from ITGIS_LayerPixel) |
|
| MinHeightThreshold | public | Minimum threshold of the grid elevation values to display. (Inherited from ITGIS_LayerPixel) |
|
| MultiUserMode | public | Type of multiuser mode. (Inherited from ITGIS_Layer) |
|
| Name | public | Name of layer; if not filled directly, then will be filled with Path when added to the viewer. (Inherited from ITGIS_Layer) |
|
| NoDataColor | public | Color property to define default color to be used to fill "empty" area upon PixelExportManager. (Inherited from ITGIS_LayerPixel) |
|
| NoDataValue | public | Grid NoData value. (Inherited from ITGIS_LayerPixel) |
|
| PageCount | public | Number of pages in an image file. (Inherited from ITGIS_LayerPixel) |
|
| Params | public | Returns parameters for pixel layer. (Inherited from ITGIS_LayerPixel) |
|
| ParamsList | public | List of all parameter sections attached to the current layer. (Inherited from ITGIS_Layer) |
|
| Params_ | public | Parameters (colors, fills, etc.) object. (Inherited from ITGIS_Layer) |
|
| ParentLayer | public | Parent layer of a sub layer. (Inherited from ITGIS_Layer) |
|
| Path | public | Path to file holding the layer's data. (Inherited from ITGIS_Layer) |
|
| PathTAB | public | Path to a TAB referencing file. (Inherited from ITGIS_LayerPixel) |
|
| PathWithDriver | public | Path to file with the layer's data extended with driver name. (Inherited from ITGIS_Layer) |
|
| Progressive | public | If true (default), then layer can be drawn as progressive. (Inherited from ITGIS_LayerPixel) |
|
| 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) |
|
| Statistics | public | Layer statistics engine (Inherited from ITGIS_Layer) |
|
| Stream | public | Reference to a potential layer underlying the stream. (Inherited from ITGIS_Layer) |
|
| SubFormat | public | Current sub-format information. (Inherited from ITGIS_LayerPixel) |
|
| SubLayers | public | List of sublayers belonging to the layer. (Inherited from ITGIS_Layer) |
|
| SubType | public | Type of sublayer. (Inherited from ITGIS_Layer) |
|
| 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 for the layer (0..100). (Inherited from ITGIS_Layer) |
|
| UnSupportedOperations | public | Set of operations not supported by the layer. (Inherited from ITGIS_Layer) |
|
| UseConfig | public | True if config file is active. (Inherited from ITGIS_Layer) |
|
| UserObject | public | UserObject can be used to associate with the layer a user-defined object. (Inherited from ITGIS_Layer) |
|
| Viewer | public | Reference to a viewer object. (Inherited from ITGIS_Layer) |
|
| ZOrder | public | Layer's position relative to other layers. (Inherited from ITGIS_Layer) |
|
| ZOrderEx | public | Layer position relative to other visible layers. (Inherited from ITGIS_Layer) |
|
Remarks
Error codes
During some operations, “File … has wrong format or was corrupted” exception is raised with a code referring to known limitations:
| Code | Description |
|---|---|
| 1-87 | Invalid decoding of JPG file |
2022/11/16 01:06