GXSTK class

class GXSTK(handle=0)[source]

GXSTK class.

The GXSTK class is used for plotting a single data profile in an GXMVIEW. The GXMSTK class (see GXMSTK) is used to plot multiple GXSTK objects to a single map.

Use GXMSTK.add_stk fuction to create a GXSTK object before using functions in this file

SEE GXMSTK FILE FOR DETAILED DESCRIPTIONS OF ALL FUNCTION PARAMETERS.

__init__(handle=0)[source]

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

get_axis_format(xy)[source]

Get axis number display format.

Parameters

xy (int) – STK_AXIS constants

Returns

The current format - DB_CHAN_FORMAT constants

Return type

int

New in version 5.1.5.

License: Geosoft End-User License

Note: By default, DB_CHAN_FORMAT_NORMAL

get_axis_parms(bar_draw, min_loc, max_loc, thick, color, tick_interval, tick_size1, tick_size2, min_tick, xy)[source]

Get parameters in GXSTK object relating drawing X/Y axis

Parameters

  • bar_draw (int_ref) – ?BARDRAW: Bottom and/or Top, or Left and/or Right

  • min_loc (float_ref) – Bottom Y/Left X location

  • max_loc (float_ref) – Top Y/Right X location

  • thick (float_ref) – ?BARLINETHICK - Line thickness in mm. Default is 0.05

  • color (str_ref) – ?BARCOLOR - Line color string in RGB model. Default is black

  • tick_interval (float_ref) – ?BARTICKINTEERVAL

  • tick_size1 (float_ref) – Major tick size in mm for bottom/left axis bar.

  • tick_size2 (float_ref) – Major tick size in mm for top/right axis bar.

  • min_tick (int_ref) – ?BARMINORTICK - Number of minor ticks. (0) none, (-1) automatic

  • xy (int) – STK_AXIS constants

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters ? mark in the note represent either X and Y

get_fid_parms(fid_y_loc, fid_tick_size, fid_interval, fid_text_font, fid_text_size, fid_text_color)[source]

Get parameters in GXSTK object relating drawing fid ticks

Parameters

  • fid_y_loc (float_ref) – Y location in data unit to draw Fid ticks. Default is the bottom of the stack

  • fid_tick_size (float_ref) – Fid tick size in mm. Default is 2.0mm

  • fid_interval (float_ref) – Fid interval to draw ticks. Nice number is calculated by default

  • fid_text_font (str_ref) – Font to use to label fids. Default is use ‘default’ font set in Montaj

  • fid_text_size (float_ref) – Text size in mm to label fids. Default is 5mm

  • fid_text_color (str_ref) – Text color string in RGB model. Default is black

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters

get_flag(part)[source]

Get flag indicating part of GXSTK object is to be drawn or not

Parameters

part (int) – STK_FLAG constants

Returns

FALSE (0) if part of the object is not to be drawn TRUE (1) if part of the object is drawn

Return type

int

New in version 6.0.1.

License: Geosoft End-User License

get_gen_parms(x_ch, y_ch, grp_name, x_scale, y_scale, x_start, x_end, y_start, left, bottom, height)[source]

Get general parameters in GXSTK object

Parameters

  • x_ch (str_ref) – X channel name, REQUIRED

  • y_ch (str_ref) – Y channel name, REQUIRED

  • grp_name (str_ref) – Group name

  • x_scale (float_ref) – X scale (map scale, units/metre), REQUIRED

  • y_scale (float_ref) – Y scale (plot scale, units/mm), REQUIRED

  • x_start (float_ref) – Minimum X value (data unit) to draw

  • x_end (float_ref) – Maximum X value (data unit) to draw

  • y_start (float_ref) – Minimum Y value (data unit) to draw

  • left (float_ref) – Minimum horizontal location in mm of the stack on the map

  • bottom (float_ref) – Minimum vertical location in mm on the map

  • height (float_ref) – Profile height in mm on the map, must be > 0.0

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters

get_grid_parms(grid, min_x, max_x, min_y, max_y, thick, cross, x_sep, y_sep, color, grid12)[source]

Get background grid parameters in GXSTK object

Parameters

  • grid (int_ref) – Type of grid to draw:

  • min_x (float_ref) – Minimum X in ground unit to draw grid

  • max_x (float_ref) – Maximum X in ground unit to draw grid

  • min_y (float_ref) – Minimum Y in ground unit to draw grid

  • max_y (float_ref) – Maximum Y in ground unit to draw grid

  • thick (float_ref) – Line thickness in mm. Default is 0.01mm

  • cross (float_ref) – Cross size or separation between dots in mm.

  • x_sep (float_ref) – Separation between vertical grid lines.

  • y_sep (float_ref) – Separation between horizontal grid lines.

  • color (str_ref) – Grid line color string in RGB model. Default is black

  • grid12 (int) – STK_GRID constants

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters ? mark in the note represent either X and Y

get_label_parms(axis, min_loc, min_orient, max_loc, max_orient, interval, font, text_size, color, bound, xy)[source]

Get parameters in GXSTK object relating X/Y axis labels

Parameters

  • axis (int_ref) – Which axes to draw: Bottom/Top or Left/Right axes

  • min_loc (float_ref) – Bottom or Left axis label location

  • min_orient (int_ref) – Bottom or Left labels orientation.

  • max_loc (float_ref) – Top or Right axis label location

  • max_orient (int_ref) – Top or Right axis label orientation

  • interval (float_ref) – Label interval. Default is to use related axis tick interval

  • font (str_ref) – Font to use to label. Default is use ‘default’ font set in Montaj

  • text_size (float_ref) – Text size in mm to draw profile labels. Default is 5mm

  • color (str_ref) – Text color string in RGB model. Default is black

  • bound (int_ref) – ?LABELBOUND - Edge bound. 0 - No

  • xy (int) – STK_AXIS constants

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters ? mark in the note represent either X and Y Sets the label format to GSF_NORMAL. To override this, use the set_axis_format function AFTER calling this.

get_profile(prof_type, pitch, thick, ln_clr, wrap, clip, smooth, vv_ind, label, ref, font, text_size, text_clr, prof_va_num)[source]

Get profile parameters in GXSTK object

Parameters

  • prof_type (int_ref) – Profile line type. 1 - solid (default)

  • pitch (float_ref) – Patterned line pitch in mm. Default is 10 mm

  • thick (float_ref) – Line thickness in mm. Default is 0.05mm

  • ln_clr (str_ref) – Color string in RGB model. Default is black

  • wrap (int_ref) – Wrap option

  • clip (int_ref) – Clip option

  • smooth (int_ref) – Plot smoothed polyline.

  • vv_ind (GXVV) – Only use for GXVA channels. NULL is acceptable which means all profiles in the GXVA are plotted. GXVV type of INT (integer)

  • label (str_ref) – Characters string to label profiles

  • ref (int_ref) – Reference location to draw label.

  • font (str_ref) – Font to use to draw profile labels. Default is use ‘default’ font set in Montaj

  • text_size (float_ref) – Text size in mm to draw profile labels. Default is 5mm

  • text_clr (str_ref) – Text color string in RGB model. Default is black

  • prof_va_num (int_ref) – Include GXVA column numbers as part of the profile label 0 - no, 1 - yes

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters

get_profile_ex(prof_type, pitch, thick, ln_clr, break_dum, wrap, clip, smooth, vv_ind, label, ref, font, text_size, text_clr, prof_va_num)[source]

Get profile parameters in GXSTK object (added Break on dummy option)

Parameters

  • prof_type (int_ref) – Profile line type. 1 - solid (default)

  • pitch (float_ref) – Patterned line pitch in mm. Default is 10 mm

  • thick (float_ref) – Line thickness in mm. Default is 0.05mm

  • ln_clr (str_ref) – Color string in RGB model. Default is black

  • break_dum (int_ref) – Break on dummy option

  • wrap (int_ref) – Wrap option

  • clip (int_ref) – Clip option

  • smooth (int_ref) – Plot smoothed polyline.

  • vv_ind (GXVV) – Only use for GXVA channels. NULL is acceptable which means all profiles in the GXVA are plotted. GXVV type of INT (integer)

  • label (str_ref) – Characters string to label profiles

  • ref (int_ref) – Reference location to draw label.

  • font (str_ref) – Font to use to draw profile labels. Default is use ‘default’ font set in Montaj

  • text_size (float_ref) – Text size in mm to draw profile labels. Default is 5mm

  • text_clr (str_ref) – Text color string in RGB model. Default is black

  • prof_va_num (int_ref) – Include GXVA column numbers as part of the profile label 0 - no, 1 - yes

New in version 5.0.3.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters

get_symb_parms(symb_font, symb_size, line_clr, fill_clr, wrap, clip, symb_y_loc, no_levels, vv_level, vv_type, label, text_font, text_size, text_clr)[source]

Get parameters in GXSTK object relating drawing symbols

Parameters

  • symb_font (str_ref) – Font to use to draw symbols. Default is use ‘symbols.gfn’ font

  • symb_size (float_ref) – Symbol size in mm. Default is 5mm

  • line_clr (str_ref) – Edge color string in RGB model. Default is black

  • fill_clr (str_ref) – Fill color string in RGB model. Default is black

  • wrap (int_ref) – Wrap option

  • clip (int_ref) – Clip option

  • symb_y_loc (float_ref) – Y location to draw symbols. Default is to use the data from Y channel

  • no_levels (int_ref) – Number of levels to draw symbols

  • vv_level (GXVV) – Y values to define data ranges for each symbol types Type of REAL

  • vv_type (GXVV) – Symbol numbers (given in the symbol font) to draw, default is 20 TYPE of INT

  • label (int_ref) – Draw symbols ID (1) or not (0)

  • text_font (str_ref) – Font to use to draw symbol ID (A,B,C…). Default is use ‘default’

  • text_size (float_ref) – Text size in mm to draw profile labels. Default is 5mm

  • text_clr (str_ref) – Text color string in RGB model. Default is black

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters

get_title_parms(title1, title2, title1_orient, title1_x, title1_y, title2_orient, title2_x, title2_y, font, text_size, color, xy)[source]

Get parameters in GXSTK object relating X/Y axis titles

Parameters

  • title1 (str_ref) – Title for bottom X axis/left Y axis. Default is no title.

  • title2 (str_ref) – Title for top X axis/right Y axis. Default is no title.

  • title1_orient (int_ref) – Bottom/Left axis title orientation.

  • title1_x (float_ref) – X location to draw bottom/left axis title

  • title1_y (float_ref) – Y location to draw bottom/left axis title

  • title2_orient (int_ref) – Top/Right axis title orientation.

  • title2_x (float_ref) – X location to draw top/right axis title

  • title2_y (float_ref) – Y location to draw top/right axis title

  • font (str_ref) – Font to draw titles. Default is use ‘default’ font set in Montaj

  • text_size (float_ref) – Text size in mm to draw titles. Default is 5mm

  • color (str_ref) – Text color string in RGB model. Default is black

  • xy (int) – STK_AXIS constants

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters ? mark in the note represent either X and Y

get_trans_parms(x_trans_t, x_log_min, xvv_lev, xvv_cmp, y_trans_t, y_log_min, yvv_lev, yvv_cmp)[source]

Get transformation parameters in GXSTK object

Parameters

  • x_trans_t (int_ref) – Type of transformation for horizontal axis

  • x_log_min (float_ref) – Minimum value to apply logarithmic

  • xvv_lev (GXVV) – Comma separated parameters defining linear compress data range

  • xvv_cmp (GXVV) – Comma separated parameters defining scaling factors for

  • y_trans_t (int_ref) – Type of scaling for vertical axis

  • y_log_min (float_ref) – Minimum value to apply logarithmic

  • yvv_lev (GXVV) – Comma separated parameters defining linear compress data range

  • yvv_cmp (GXVV) – Comma separated parameters defining scaling factors for

New in version 5.0.

License: Geosoft End-User License

Note: See above full description of each parameters GXVV’s for X channel transformation can be NULL if the transformation is log or loglinear. The same for Y channel.

See GXMSTK for detailed description of all function parameters

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 GXSTK

Returns

A null GXSTK

Return type

GXSTK

set_array_colors(itr)[source]

Set colors for individual channels in a GXVA, via an GXITR

Parameters

itr (GXITR) – GXITR object for colors

New in version 5.0.1.

License: Geosoft End-User License

Note: The GXITR is consulted by taking the channel index and dividing by the number of channels; hence the GXITR maximum values should be in the range: 0 > values >= 1.0.

set_axis_format(format, xy)[source]

Set axis number display format.

Parameters

New in version 5.1.5.

License: Geosoft End-User License

Note: By default, DB_CHAN_FORMAT_NORMAL is used to display the values, or for values > 1.e7, DB_CHAN_FORMAT_EXP.

set_axis_parms(bar_draw, min_loc, max_loc, thick, color, tick_interval, tick_size1, tick_size2, min_tick, xy)[source]

Set parameters in GXSTK object relating drawing X/Y axis

Parameters

  • bar_draw (int) – ?BARDRAW

  • min_loc (float) – Bottom Y/Left X location

  • max_loc (float) – Top Y/Right X location

  • thick (float) – ?BARLINETHICK - Line thickness in mm. Default is 0.05

  • color (str) – ?BARCOLOR - Line color string in RGB model. Default is black

  • tick_interval (float) – ?BARTICKINTEERVAL

  • tick_size1 (float) – Major tick size in mm for bottom/left axis bar.

  • tick_size2 (float) – Major tick size in mm for top/right axis bar.

  • min_tick (int) – ?BARMINORTICK - Number of minor ticks. (0) none, (-1) automatic

  • xy (int) – STK_AXIS constants

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters ? mark in the note represent either X and Y

set_fid_parms(fid_y_loc, fid_tick_size, fid_interval, fid_text_font, fid_text_size, fid_text_color)[source]

Set parameters in GXSTK object relating drawing fid ticks

Parameters

  • fid_y_loc (float) – Y location in data unit to draw Fid ticks. Default is the bottom of the stack

  • fid_tick_size (float) – Fid tick size in mm. Default is 2.0mm

  • fid_interval (float) – Fid interval to draw ticks. Nice number is calculated by default

  • fid_text_font (str) – Font to use to label fids. Default is use ‘default’ font set in Montaj

  • fid_text_size (float) – Text size in mm to label fids. Default is 5mm

  • fid_text_color (str) – Text color string in RGB model. Default is black

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters

set_flag(flag, part)[source]

Set flag indicating part of GXSTK object is to be drawn or not

Parameters

New in version 5.0.

License: Geosoft End-User License

set_gen_parms(x_ch, y_ch, grp_name, x_scale, y_scale, x_start, x_end, y_start, left, bottom, height)[source]

Set general parameters in GXSTK object

Parameters

  • x_ch (str) – X channel name, REQUIRED

  • y_ch (str) – Y channel name, REQUIRED

  • grp_name (str) – Group name

  • x_scale (float) – X scale (map scale, units/metre), REQUIRED

  • y_scale (float) – Y scale (plot scale, units/mm), REQUIRED

  • x_start (float) – Minimum X value (data unit) to draw

  • x_end (float) – Maximum X value (data unit) to draw

  • y_start (float) – Minimum Y value (data unit) to draw

  • left (float) – Minimum horizontal location in mm of the stack on the map

  • bottom (float) – Minimum vertical location in mm on the map

  • height (float) – Profile height in mm on the map, must be > 0.0

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters

set_grid_parms(grid, min_x, max_x, min_y, max_y, thick, cross, x_sep, y_sep, color, grid12)[source]

Set background grid parameters in GXSTK object

Parameters

  • grid (int) – Type of grid to draw:

  • min_x (float) – Minimum X in ground unit to draw grid

  • max_x (float) – Maximum X in ground unit to draw grid

  • min_y (float) – Minimum Y in ground unit to draw grid

  • max_y (float) – Maximum Y in ground unit to draw grid

  • thick (float) – Line thickness in mm. Default is 0.01mm

  • cross (float) – Cross size or separation between dots in mm.

  • x_sep (float) – Separation between vertical grid lines.

  • y_sep (float) – Separation between horizontal grid lines.

  • color (str) – Grid line color string in RGB model. Default is black

  • grid12 (int) – STK_GRID constants

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters ? mark in the note represent either X and Y

set_label_parms(axis, min_loc, min_orient, max_loc, max_orient, interval, font, text_size, color, bound, xy)[source]

Set parameters in GXSTK object relating X/Y axis labels

Parameters

  • axis (int) – Bottom/Top or Left/Right axes

  • min_loc (float) – Bottom or Left axis label location

  • min_orient (int) – Bottom or Left labels orientation.

  • max_loc (float) – Top or Right axis label location

  • max_orient (int) – Top or Right axis label orientation

  • interval (float) – Label interval. Default is to use related axis tick interval

  • font (str) – Font to use to label. Default is use ‘default’ font set in Montaj

  • text_size (float) – Text size in mm to draw profile labels. Default is 5mm

  • color (str) – Text color string in RGB model. Default is black

  • bound (int) – ?LABELBOUND - Edge bound. 0 - No

  • xy (int) – STK_AXIS constants

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters ? mark in the note represent either X and Y Sets the label format to GSF_NORMAL. To override this, use the set_axis_format function AFTER calling this.

set_line_parm(line)[source]

Set line parameter (of Y Chan) in GXSTK object

Parameters

line (int) – Line symb

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters

set_profile(prof_type, pitch, thick, ln_clr, wrap, clip, smooth, vv_ind, label, ref, font, text_size, text_clr, prof_va_num)[source]

Set profile parameters in GXSTK object

Parameters

  • prof_type (int) – Profile line type. 1 - solid (default)

  • pitch (float) – Patterned line pitch in mm. Default is 10 mm

  • thick (float) – Line thickness in mm. Default is 0.05mm

  • ln_clr (str) – Color string in RGB model. Default is black

  • wrap (int) – Wrap option

  • clip (int) – Clip option

  • smooth (int) – Plot smoothed polyline.

  • vv_ind (GXVV) – Integers starting from 0 indicating windows in GXVA channel to draw GXVV type of INT (integer)

  • label (str) – Characters string to label profiles

  • ref (int) – Reference location to draw label.

  • font (str) – Font to use to draw profile labels. Default is use ‘default’ font set in Montaj

  • text_size (float) – Text size in mm to draw profile labels. Default is 5mm

  • text_clr (str) – Text color string in RGB model. Default is black

  • prof_va_num (int) – Include GXVA column numbers as part of the profile label 0 - no, 1 - yes

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters

set_profile_ex(prof_type, pitch, thick, ln_clr, break_dum, wrap, clip, smooth, vv_ind, label, ref, font, text_size, text_clr, prof_va_num)[source]

Set profile parameters in GXSTK object (added Break on dummy option)

Parameters

  • prof_type (int) – Profile line type. 1 - solid (default)

  • pitch (float) – Patterned line pitch in mm. Default is 10 mm

  • thick (float) – Line thickness in mm. Default is 0.05mm

  • ln_clr (str) – Color string in RGB model. Default is black

  • break_dum (int) – Break on dummy option

  • wrap (int) – Wrap option

  • clip (int) – Clip option

  • smooth (int) – Plot smoothed polyline.

  • vv_ind (GXVV) – Integers starting from 0 indicating windows in GXVA channel to draw GXVV type of INT (integer)

  • label (str) – Characters string to label profiles

  • ref (int) – Reference location to draw label.

  • font (str) – Font to use to draw profile labels. Default is use ‘default’ font set in Montaj

  • text_size (float) – Text size in mm to draw profile labels. Default is 5mm

  • text_clr (str) – Text color string in RGB model. Default is black

  • prof_va_num (int) – Include GXVA column numbers as part of the profile label 0 - no, 1 - yes

New in version 5.0.3.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters

set_symb_parms(symb_font, symb_size, line_clr, fill_clr, wrap, clip, symb_y_loc, no_levels, vv_level, vv_type, label, text_font, text_size, text_clr)[source]

Set parameters in GXSTK object relating drawing symbols

Parameters

  • symb_font (str) – Font to use to draw symbols. Default is use ‘symbols.gfn’ font

  • symb_size (float) – Symbol size in mm. Default is 5mm

  • line_clr (str) – Edge color string in RGB model. Default is black

  • fill_clr (str) – Fill color string in RGB model. Default is black

  • wrap (int) – Wrap option

  • clip (int) – Clip option

  • symb_y_loc (float) – Y location to draw symbols. Default is to use the data from Y channel

  • no_levels (int) – Number of symbols levels

  • vv_level (GXVV) – Y values to define data ranges for each symbol types Type of REAL

  • vv_type (GXVV) – Symbol numbers (given in the symbol font) to draw Type of INT

  • label (int) – Draw symbols ID (1) or not (0)

  • text_font (str) – Font to use to draw symbol ID (A,B,C…). Default is use ‘default’

  • text_size (float) – Text size in mm to draw profile labels. Default is 5mm

  • text_clr (str) – Text color string in RGB model. Default is black

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters

set_title_parms(title1, title2, title1_orient, title1_x, title1_y, title2_orient, title2_x, title2_y, font, text_size, color, xy)[source]

Set parameters in GXSTK object relating X/Y axis titles

Parameters

  • title1 (str) – Title for bottom X axis/left Y axis. Default is no title.

  • title2 (str) – Title for top X axis/right Y axis. Default is no title.

  • title1_orient (int) – Bottom/Left axis title orientation.

  • title1_x (float) – X location to draw bottom/left axis title

  • title1_y (float) – Y location to draw bottom/left axis title

  • title2_orient (int) – Top/Right axis title orientation.

  • title2_x (float) – X location to draw top/right axis title

  • title2_y (float) – Y location to draw top/right axis title

  • font (str) – Font to draw titles. Default is use ‘default’ font set in Montaj

  • text_size (float) – Text size in mm to draw titles. Default is 5mm

  • color (str) – Text color string in RGB model. Default is black

  • xy (int) – STK_AXIS constants

New in version 5.0.

License: Geosoft End-User License

Note: See GXMSTK for detailed description of all function parameters ? mark in the note represent either X and Y

set_trans_parms(x_trans_t, x_log_min, xvv_lev, xvv_cmp, y_trans_t, y_log_min, yvv_lev, yvv_cmp)[source]

Set transformation parameters in GXSTK object

Parameters

  • x_trans_t (int) – Type of transformation for horizontal axis

  • x_log_min (float) – Minimum value to apply logarithmic

  • xvv_lev (int) – Future use

  • xvv_cmp (int) – Future use

  • y_trans_t (int) – Type of scaling for vertical axis

  • y_log_min (float) – Minimum value to apply logarithmic

  • yvv_lev (int) – Future use

  • yvv_cmp (int) – Future use

New in version 5.0.

License: Geosoft End-User License

Note: See above full description of each parameters GXVV’s for X channel transformation can be NULL if the transformation is log or loglinear. The same for Y channel. See GXMSTK for detailed description of all function parameters

set_va_index_start(index0)[source]

Start array profile index labels at 0 or 1.

Parameters

index0 (int) – Starting index (0 or 1)

New in version 6.0.1.

License: Geosoft End-User License

Note: By default, the index labels for array channel profiles begin at 0. Use this function to start them at either 0 or 1.

STK_AXIS constants

GXSTK Axis defines

STK_AXIS_X

X Axis

gxapi.STK_AXIS_X = 0
STK_AXIS_Y

Y Axis

gxapi.STK_AXIS_Y = 1

STK_FLAG constants

Stack flags

STK_FLAG_PROFILE

Profile

gxapi.STK_FLAG_PROFILE = 0
STK_FLAG_FID

Fid

gxapi.STK_FLAG_FID = 1
STK_FLAG_SYMBOL

Symbol

gxapi.STK_FLAG_SYMBOL = 2
STK_FLAG_XBAR

Xbar

gxapi.STK_FLAG_XBAR = 3
STK_FLAG_XLABEL

Xlabel

gxapi.STK_FLAG_XLABEL = 4
STK_FLAG_XTITLE

Xtitle

gxapi.STK_FLAG_XTITLE = 5
STK_FLAG_YBAR

Ybar

gxapi.STK_FLAG_YBAR = 6
STK_FLAG_YLABEL

Ylabel

gxapi.STK_FLAG_YLABEL = 7
STK_FLAG_YTITLE

Ytitle

gxapi.STK_FLAG_YTITLE = 8
STK_FLAG_GRID1

Grid1

gxapi.STK_FLAG_GRID1 = 9
STK_FLAG_GRID2

Grid2

gxapi.STK_FLAG_GRID2 = 10

STK_GRID constants

Stack Grid define

STK_GRID_PRIMARY

Primary Grid

gxapi.STK_GRID_PRIMARY = 0
STK_GRID_SECONDARY

Secondary Grid

gxapi.STK_GRID_SECONDARY = 1