GXMAPL class¶
- class GXMAPL(handle=0)[source]¶
GXMAPL class.
The
GXMAPL
class is the interface with the MAPPLOT program, which reads a MAPPLOT control file and plots graphical entities to a map. TheGXMAPL
object is created for a given control file, then passed to the MAPPLOT program, along with the targetGXMAP
object on which to do the drawing- classmethod create(name, ref_name, line)[source]¶
Create a
GXMAPL
.- Parameters:
name (str) –
GXMAPL
file nameref_name (str) – Map base reference name
line (int) – Start line number in file (0 is first)
- Returns:
GXMAPL
, aborts if creation fails- Return type:
New in version 5.0.
License: Geosoft Open License
Note: The default map groups will use the reference name with “_Data” and “_Base” added. If no reference name is specified, the name “
GXMAPL
” is used
- classmethod create_reg(name, ref_name, line, reg)[source]¶
-
- Parameters:
name (str) –
GXMAPL
file nameref_name (str) – Map base reference name
line (int) – Start line number in file (0 is first)
- Returns:
GXMAPL
, aborts if creation fails- Return type:
New in version 5.0.
License: Geosoft Open License
Note: The default map groups will use the reference name with “_Data” and “_Base” added. If no reference name is specified, the name “
GXMAPL
” is used
- is_null()[source]¶
Check if this is a null (undefined) instance
- Returns:
True if this is a null (undefined) instance, False otherwise.
- Return type:
bool
- process(map)[source]¶
Process a
GXMAPL
New in version 5.0.
License: Geosoft Open License
- replace_string(var, repl)[source]¶
Adds a replacement string to a mapplot control file.
- Parameters:
var (str) – Variable
repl (str) – Replacement
New in version 5.0.
License: Geosoft Open License