TatukGIS Developer Kernel

User Tools

Site Tools

api:dk11:python:tatukgis_pdk.tgis_config

Table of Contents

TGIS_Config class

Abstract wrapper for layer and project configuration content.

Syntax

# Python
class TGIS_Config( TGIS_ConfigAbstract ):

Inheritance

→ Object → TGIS_ConfigAbstract

Constructors

Inherited Overrides Protected
Name Visibility Description
__init__ public Creates a configuration wrapper for a layer or project file.

Methods

Inherited Overrides Protected
Name Visibility Description
AbsolutePath public Computes an absolute path from a path relative to the configuration file.
AddSubLayer public Adds a sublayer entry to the configuration.
BuildProject public Build a project config from the current project and layers attached to the viewer.
ClearActiveSection public Deletes elements related to the current active section.
ClearGroups public Deletes group sections related to the selected group.
ClearSave public Clears the
ClearSections public Deletes sections related to the selected layer.
ClearSubSections public Deletes subsections related to the selected layer.
GetStrings public Fills a string list with values parsed from the config.
Lock public Locks the configuration so MustSave is evaluated on Unlock.
LockThread public Locks config operations to the current thread only.
Read3DLayerType public Read parameters given by _name.
ReadAlignment public Reads a label alignment value from the active section.
ReadBasement public Read parameters given by _name.
ReadBitmap public Reads a bitmap value from the active section.
ReadBoolean public Reads a Boolean value from the active section.
ReadChart public Read parameters given by _name.
ReadColor public Reads a color value from the active section.
ReadColorInterpolationMode public Read parameters given by _name.
ReadColorRamp(str, TGIS_ColorMapArray) public Read a deprecated color ramp parameter by name.
ReadColorRamp(str, TGIS_GradientMap) public Read a color ramp parameter by name.
ReadCustomData public Read custom configuration parameters.
ReadDormant public Reads a layer dormant mode value from the active section.
ReadFloat public Read parameters given by _name.
ReadFontStyle public Reads a font style set from the active section.
ReadGround public Read parameters given by _name.
ReadHierarchyGroups public Reads hierarchy groups from the config.
ReadInteger public Reads an integer value from the active section.
ReadInterpretation public Read parameters given by _name.
ReadMarker public Read parameters given by _name.
ReadNormalized public Read parameters given by _name.
ReadOffsetPosition public Read parameters given by _name.
ReadPattern public Read parameters given by _name.
ReadPen public Read parameters given by _name.
ReadPosition public Read parameters given by _name.
ReadSectionValues public Reads all values from the named section into a list.
ReadString public Read parameters given by _name.
ReadSymbol public Read parameters given by _name.
ReadZone(str, TGIS_PixelZoneListAbstract) public Read parameters given by zone _name.
ReadZone(str, TGIS_StringList) public Read parameters given by zone _name.
RelativePath public Computes a path relative to the configuration file.
Reread public Reread configuration file.
Save public Saves the configuration file and its backup copy.
SetGroup public Selects the group whose configuration section will be used.
SetGroupSection public Selects the active group section for subsequent operations.
SetLayer public Selects the layer whose configuration section will be used.
SetSection public Selects the active section for subsequent operations.
SetStrings public Parses values from a string list and stores them in the config.
SetSubLayer public Selects the sublayer whose configuration section will be used.
SetSubSection public Selects the active subsection for subsequent operations.
Unlock public Unlocks the configuration and evaluates the actual MustSave state.
UnlockThread public Unlocks config operations previously locked by
Write3DLayerType public Write parameters given by _name.
WriteAlignment public Writes a label alignment value to the active section.
WriteBasement public Write parameters given by _name.
WriteBitmap public Writes a bitmap value to the active section.
WriteBoolean public Writes a Boolean value to the active section.
WriteChart public Write parameters given by _name.
WriteColor public Writes a color value to the active section.
WriteColorInterpolationMode public Write parameters given by _name.
WriteColorRamp(str, TGIS_ColorMapArray, TGIS_ColorMapArray) public Write a deprecated color ramp parameter by name.
WriteColorRamp(str, TGIS_GradientMap, TGIS_GradientMap) public Write a color ramp parameter by name.
WriteCustomData public Write custom configuration parameters.
WriteDormant public Writes a layer dormant mode value to the active section.
WriteFloat public Write parameters given by _name.
WriteFontStyle public Writes a font style set to the active section.
WriteGround public Write parameters given by _name.
WriteHierarchyGroups public Write hierarchy groups to the config.
WriteInteger public Writes an integer value to the active section.
WriteInterpretation public Write parameters given by _name.
WriteMarker public Write parameters given by _name.
WriteNormalized public Write parameters given by _name.
WriteOffsetPosition public Writes an offset position parameter identified by
WritePattern public Write parameters given by _name.
WritePen public Write parameters given by _name.
WritePosition public Write parameters given by _name.
WriteString public Write parameters given by _name.
WriteStyle public Write a style parameter by name.
WriteSymbol public Write parameters given by _name.
WriteZone(str, TGIS_PixelZoneListAbstract, TGIS_PixelZoneListAbstract) public Write parameters given by zone _name.
WriteZone(str, TGIS_StringList, TGIS_StringList) public Write parameters given by zone _name.

Properties

Inherited Protected
Name Visibility Description
ConfigFormat public Gets the internal config format.
FileName public Gets the configuration file name.
IsProject public True if the config represents a project.
IsShapeStyle public True if config is for shape style embedding.
MustSave public True if the config has been changed.
PrjLayerConfig public Config file name without extension for the layer at a given index in a project file.
PrjLayerName public Returns the name of the layer at the specified index in a project file.
PrjLayerPath public Returns the path of the layer at the specified index in a project file.
PrjLayersCount public Returns the number of layers defined in the project config file.
Section public Overrides the current section used for config read and write operations.
UseRelativePath public If True, file paths are saved relative to the config file location.
Version public Gets the config version number.
WriteFull public If True, all config keys are saved; otherwise only changed keys are saved.

Remarks

PURPOSE: Provides a high-level API for reading, writing, and navigating TatukGIS configuration data for projects, layers, styles, custom sections, and zones.

BEHAVIOR: This class manages the current section context, typed parameter serialization, path conversion, change tracking, and project-building helpers. Low-level storage operations are abstract and must be implemented by descendants for a specific config format.

CONSTRAINTS: This is an abstract base class and cannot be used directly. Many typed read methods return the supplied default value when a parameter is missing or invalid.

References

2026/07/10 23:48

Page Tools

©2026 TatukGIS. All Rights Reserved.
Send feedback