LayerStyleInfo() function - MapBasic - 2023

Returns style information for a stacked style (a style composed of one or more style definitions).

Syntax

LayerStyleInfo ( 
	window_id, layer_number, override_index, pass_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 (0-based, where 0 for the layer's base set of properties) and 1 or higher is for a style override.

pass_index is an integer index (1-based) where the index corresponds to a pass within the stacked style. The first pass is the part of the style drawn first, the second pass is the part of the style drawn next, and so on.

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

Return Value

Return value depends on attribute parameter.

Description

The LayerStyleInfo() function returns style information for a stacked style. A stacked style is made up of one or more style definitions. For example, a line style drawn with two separate styles; a thin light red line drawn on top of a thicker dark red line would be descried as follows using MapBasic syntax:

	Line (7,2,12582912), Line (3,2,16736352)

The thicker dark red line in this example is drawn first.

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.

Example

LayerStyleInfo(nMID, nLayer, nOverride, nPass, STYLE_OVR_INFO_PEN)

See Also:

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