StyleOverrideInfo() function - MapBasic - 2023

MapInfo MapBasic Reference
Product type
Software
Portfolio
Locate
Product family
MapInfo
Product
MapInfo > MapBasic
Version
2023
Language
English
Product name
MapBasic
Title
MapInfo MapBasic Reference
First publish date
1985
Last updated
2023-09-12
Published on
2023-09-12T16:32:32.686312

Returns information about a specific display style override.

Syntax

StyleOverrideInfo( window_id, layer_number, override_index, attribute )

window_id is the integer window identifier of a Map window.

layer_number is the number of a layer in the current Map window (for example, 1 for the top layer); to determine the number of layers in a Map window, call the MapperInfo() function.

override_index is an integer index (1-based) for the override definition within the layer.

attribute is a code indicating the type of information to return; see table below.

Return Value

Return value depends on attribute parameter.

Description

This function returns information about the specified display style override for one layer in an existing Map window. The layer_number must be a valid layer (1 is the topmost table layer, and so on). The attribute parameter must be one of the codes from the following table; codes are defined in MAPBASIC.DEF.

Attribute Code ID LayerInfo() Return Value
STYLE_OVR_INFO_NAME 1 Style override name.
STYLE_OVR_INFO_VISIBILITY 2 Smallint value, indicating whether the style override is visible; Return value will be one of the values:

  • STYLE_OVR_INFO_VIS_OFF (0)

    override is disabled/off; never visible

  • STYLE_OVR_INFO_VIS_ON (1)

    override is currently visible in the map

  • STYLE_OVR_INFO_VIS_ZOOM (2)

    override is currently not visible because it is outside the map zoom range
STYLE_OVR_INFO_ZOOM_MIN 3 Float value, indicating the minimum zoom value at which the style override displays.
STYLE_OVR_INFO_ZOOM_MAX 4 Float value, indicating the maximum zoom value at which the style override displays.
STYLE_OVR_INFO_ARROWS 5 Logical value; TRUE if override displays direction arrows on linear objects.
STYLE_OVR_INFO_NODES 6 Logical value; TRUE if override displays object nodes.
STYLE_OVR_INFO_CENTROIDS 7 Logical value; TRUE if override displays object centroids.
STYLE_OVR_INFO_ALPHA 8 SmallInt value, representing the alpha factor for the specified override.
  • 0=fully transparent.
  • 255=fully opaque.
STYLE_OVR_INFO_TRANSLUCENCY 9 SmallInt value, representing the translucency percentage for the specified override.
  • 100=fully transparent.
  • 0=fully opaque.
STYLE_OVR _INFO_LINE 10 Pen style used for displaying linear objects. If there are multiple styles, the bottom Pen style is returned.
STYLE_OVR _INFO_PEN 11 Pen style used for displaying the borders of filled objects. If there are multiple styles, the bottom Pen style is returned.
STYLE_OVR_INFO_BRUSH 12 Brush style used for displaying filled objects. If there are multiple styles, the bottom Brush style is returned.
STYLE_OVR_INFO_SYMBOL 13 Symbol style used for displaying point objects. If there are multiple styles, the bottom Symbol style is returned.
STYLE_OVR_INFO_FONT 14 Font style used for displaying text objects. If there are multiple styles, the bottom Font style is returned.
STYLE_OVR_INFO_SYMBOL_COUNT 15 SmallInt value, indicating the number of multiple SYMBOL styles.
STYLE_OVR_INFO_LINE_COUNT 16 SmallInt value, indicating the number of multiple LINE styles.
STYLE_OVR_INFO_PEN_COUNT 17 SmallInt value, indicating the number of multiple PEN styles.
STYLE_OVR_INFO_BRUSH_COUNT 18 SmallInt value, indicating the number of multiple BRUSH styles.
STYLE_OVR_INFO_FONT_COUNT 19 SmallInt value, indicating the number of multiple FONT styles.

Example

StyleOverrideInfo(nMID, nLayer, nOverride, STYLE_OVR_INFO_PEN_COUNT)

See Also:

LabelOverrideInfo() function, LayerStyleInfo() function, Set Map statement, LayerInfo() function