GXMAPL class¶
-
class
GXMAPL
(handle=0)¶ 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)¶ Create a
GXMAPL
.Parameters: - name (str) –
GXMAPL
file name - ref_name (str) – Map base reference name
- line (int) – Start line number in file (0 is first)
Returns: GXMAPL
, aborts if creation failsReturn 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- name (str) –
-
classmethod
create_reg
(name, ref_name, line, reg)¶ -
Parameters: - name (str) –
GXMAPL
file name - ref_name (str) – Map base reference name
- line (int) – Start line number in file (0 is first)
Returns: GXMAPL
, aborts if creation failsReturn 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 - name (str) –
-
is_null
()¶ Check if this is a null (undefined) instance
Returns: True if this is a null (undefined) instance, False otherwise. Return type: bool
-
process
(map)¶ Process a
GXMAPL
New in version 5.0.
License: Geosoft Open License
-
replace_string
(var, repl)¶ 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
-
classmethod