GXEMAPTEMPLATE class

class geosoft.gx.GXEMAPTEMPLATE

             The EMAPTEMPLATE class provides access to a map template as displayed within
Oasis montaj, but does not change data within the template itself.
It performs functions such as setting the currently displayed area,
or drawing "tracking" lines or boxes on the template (which are not
part of the template itself).

Note:

             To obtain access to the map template itself, it is recommended practice
to begin with an EMAPTEMPLATE object, and use the Lock function to
lock the underlying template to prevent external changes. The returned
MAPTEMPLATE object may then be safely used to make changes to the template itself.

VIRTUAL EMAPTEMPLATE SUPPORT

These methods are only available when running in an external application.
They allow the GX to open a map template and then create a Virtual EMAPTEMPLATE from that
map template. The GX can then call MakeCurrent and set the current EMAPTEMPLATE so
that code that follows sees this map template as the current MAPTEMPLATE.

Supported methods on Virtual EMAPTEMPLATEs are:

  geosoft.gx.GXEMAPTEMPLATE.current()
  geosoft.gx.GXEMAPTEMPLATE.make_current()
  geosoft.gx.GXEMAPTEMPLATE.have_current()
  geosoft.gx.GXEMAPTEMPLATE.current_if_exists()

  geosoft.gx.GXEMAPTEMPLATE.lock()
  geosoft.gx.GXEMAPTEMPLATE.un_lock()

  geosoft.gx.GXEMAPTEMPLATE.get_name()

  geosoft.gx.GXEMAPTEMPLATE.loaded()
  geosoft.gx.GXEMAPTEMPLATE.load()
  geosoft.gx.GXEMAPTEMPLATE.un_load_verify()
  geosoft.gx.GXEMAPTEMPLATE.un_load()

  geosoft.gx.GXEMAPTEMPLATE.create_virtual()

is_null() → bool

Check if the instance of geosoft.gx.GXEMAPTEMPLATE is null (undefined)

Returns:True if this is a null instance of geosoft.gx.GXEMAPTEMPLATE, False otherwise. Return type:bool`

static null() → GXEMAPTEMPLATE

A null (undefined) instance of geosoft.gx.GXEMAPTEMPLATE

Returns:A null geosoft.gx.GXEMAPTEMPLATE Return type:geosoft.gx.GXEMAPTEMPLATE

EMAPTEMPLATE_PATH constants

Four forms

gx.EMAPTEMPLATE_PATH_FULL = 0

d:\directory\file.gdb

gx.EMAPTEMPLATE_PATH_DIR = 1

\directory\file.gdb

gx.EMAPTEMPLATE_PATH_NAME_EXT = 2

file.gdb

gx.EMAPTEMPLATE_PATH_NAME = 3

file

EMAPTEMPLATE_TRACK constants

Tracking Options

gx.EMAPTEMPLATE_TRACK_ERASE = 1

Erase Object after you return?

gx.EMAPTEMPLATE_TRACK_RMENU = 2

Allow use of right-menu

gx.EMAPTEMPLATE_TRACK_CYCLE = 4

If user holds down left-mouse, will return many times

EMAPTEMPLATE_WINDOW_STATE constants

Window State Options

gx.EMAPTEMPLATE_WINDOW_RESTORE = 0

gx.EMAPTEMPLATE_WINDOW_MINIMIZE = 1

gx.EMAPTEMPLATE_WINDOW_MAXIMIZE = 2