RangeThemeInfo() 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

Purpose

Returns information about a specific thematic layer in a map. You can call this function from the MapBasic window in MapInfo Pro.

Syntax

RangeThemeInfo ( map_window_id, thematic_layer_id, attribute )

map_window_id is a Map window identifier.

thematic_layer_id is a SmallInt that identifies a range thematic layer in a Map.

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

Return Value

Depends on the attribute parameter.

Description

The attribute parameter can be any value from the table below.
attribute code ID RangeThemeInfo() returns
RANGETHEME_INFO_ITEMS_COUNT 1 SmallInt result, representing the count of ranges in the theme (excluding All others range).
RANGETHEME_INFO_VARY_STYLE 2 SmallInt result, representing how styles are applied. Three values are possible.

RANGETHEME_INFO_VARY_BY_ALL(0) All attribute of a style are used.

RANGETHEME_INFO_VARY_BY_COLOR(1) Only color of style is used.

RANGETHEME_INFO_VARY_BY_SIZE(2) Only size of style is used.

RANGETHEME_INFO_REPLACE_STYLE 3 Logical result (T or F) whether range theme style replaces the underlying reference layer's object style or not.
RANGETHEME_OTHERS_INFO_LINE 4 Line style clause used for displaying objects that belong to All others range. If the theme is not a line based theme, a default line style will be returned using the foreground color of the predominant geometry (regions or points) All others item style.
RANGETHEME_OTHERS_INFO_PEN 5 Pen style clause used for displaying border of objects that belong to All others range. If the theme is not region based theme, a default pen will be returned: Pen(1, 2, 0).
RANGETHEME_OTHERS_INFO_BRUSH 6 Brush style clause used for displaying objects that belong to All others range. If the theme is not region based theme, a default brush will be returned using the color of the predominant geometry (lines or points) All others range style.
RANGETHEME_OTHERS_INFO_SYMBOL 7 Symbol style clause used for displaying objects that belong to All others range. If the theme is not point based theme, a default style will be returned using the color of the predominant geometry (regions or lines) All others range style.
RANGETHEME_INFO_BASE_LINE 8 Line style clause used for base style. If the theme is not a line based theme, an error is displayed.
RANGETHEME_INFO_BASE_BRUSH 9 Brush style clause used for base style. If the theme is not a region based theme, an error is displayed.
RANGETHEME_INFO_BASE_SYMBOL 10 Symbol style clause used for base style. If the theme is not a point based theme, an error is displayed.

See Also:

RangeThemeItemInfo() function