GXCSYMB class

class GXCSYMB(handle=0)[source]

GXCSYMB class.

This class is used for generating and modifying colored symbol objects. Symbol fills are assigned colors based on their Z values and a zone, Aggregate or GXITR file which defines what colors are associated with different ranges of Z values. The position of a symbol is defined by its X,Y coordinates.

__init__(handle=0)[source]

Initialize self. See help(type(self)) for accurate signature.

add_data(vv_x, vv_y, vv_z)[source]

Add x,y,z data to a color symbol object.

Parameters

New in version 5.0.

License: Geosoft Open License

classmethod create(itr)[source]

Create a GXCSYMB.

Parameters

itr (str) – ZON, GXAGG, or GXITR file name

Returns

GXCSYMB handle

Return type

GXCSYMB

New in version 5.0.

License: Geosoft Open License

get_itr(itr)[source]

Get the GXITR of the GXCSYMB

Parameters

itr (GXITR) – GXITR object

New in version 9.3.

License: Geosoft Open License

get_stat(st)[source]

Get the GXST of the GXCSYMB

Parameters

st (GXST) – GXST object

New in version 2021.2.

License: Geosoft Open License

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

classmethod null()[source]

A null (undefined) instance of GXCSYMB

Returns

A null GXCSYMB

Return type

GXCSYMB

set_angle(angle)[source]

Set the symbol angle.

Parameters

angle (float) – Symbol angle

New in version 5.0.

License: Geosoft Open License

set_base(base)[source]

Set base value to subtract from Z values.

Parameters

base (float) – Symbol Base

New in version 5.0.

License: Geosoft Open License

set_dynamic_col(att)[source]

Associate symbol edge or fill colors with Z data and color transform.

Parameters

att (int) – CSYMB_COLOR constants

New in version 5.0.

License: Geosoft Open License

Note: Use this method after a call to set_static_col. This method reestablishes the symbol color association with their Z data values and color transform.

set_fixed(fixed)[source]

Set symbol sizing to fixed (or proportionate)

Parameters

fixed (int) – TRUE = Fixed symbol sizing FALSE = Proportionate sizing

New in version 5.0.

License: Geosoft Open License

set_font(font, geo_font, weight, italic)[source]

Set the symbol font name.

Parameters

  • font (str) – Font name

  • geo_font (int) – Geosoft font? (TRUE or FALSE)

  • weight (int) – MVIEW_FONT_WEIGHT constants

  • italic (int) – Italics? (TRUE or FALSE)

New in version 5.0.

License: Geosoft Open License

set_number(number)[source]

Set the symbol number.

Parameters

number (int) – Symbol number (0x1-0x1ffff)

New in version 5.0.

License: Geosoft Open License

Note: The lower 16 bits of the number is interpreted as UTF-16 with a valid Unicode character code point. GFN fonts wil produce valid symbols depending on the font for 0x01-0x7f and the degree, plus-minus and diameter symbol (latin small letter o with stroke) for 0xB0, 0xB1 and 0xF8 respectively.

It is possible to check if a character is valid using GXUNC.is_valid_utf16_char. The high 16-bits are reserved for future use. Also see: GXUNC.valid_symbol and GXUNC.validate_symbols

set_scale(scale)[source]

Set the symbol scale.

Parameters

scale (float) – Symbol scale (> 0.0)

New in version 5.0.

License: Geosoft Open License

set_static_col(col, att)[source]

Set a static color for the symbol edge or fill.

Parameters

New in version 5.0.

License: Geosoft Open License

Note: Use this method to set a STATIC color for symbol edge or fill. By default, both edge and fill colors vary according to their Z data values and a color transform.

CSYMB_COLOR constants

Color Symbol filling defines

CSYMB_COLOR_EDGE

Draw Edges only

gxapi.CSYMB_COLOR_EDGE = 0
CSYMB_COLOR_FILL

Fill Symbols

gxapi.CSYMB_COLOR_FILL = 1