LegendInfo() function - MapBasic - 2023

Purpose

Returns information about a legend, such as the orientation, number of legend frames, and the sample size style of small or large. You can call this function from the MapBasic window in MapInfo Pro.

Syntax

LegendInfo( window_id, attribute )

window_id is a number that specifies which legend window you want to query.

attribute is an integer code indicating which type of information to return. For values, see the table later in this description.

Return Value

Depends on the attribute parameter, see the table later in this description.

Description

The window_id parameter specifies which window to query. To obtain a window identifier, call the FrontWindow() function immediately after opening a window, or call the WindowID() function at any time after the window's creation.

There are several attributes that LegendInfo() returns about any given Legend window. The attribute parameter tells the LegendInfo() function what Legend window statistic to return. The attribute parameter should be one of the codes from the following table; codes are defined in MAPBASIC.DEF.

Example

dim wndLegend, wndMap as integer
for i = 1 to NumWindows() 
	If WindowInfo(WindowID(i), WIN_INFO_TYPE) = WIN_MAPPER then
		wndMap = WindowInfo(WindowID(i), WIN_INFO_WINDOWID)
	end if
	if WindowInfo(WindowID(i), WIN_INFO_TYPE) = WIN_LEGEND_DESIGNER then
		wndLegend = WindowInfo(WindowID(i), WIN_INFO_WINDOWID)
	end if
next

This example illustrates how to see which map window ID was used for creating the Legend Window.

If LegendInfo(wndLegend, LEGEND_INFO_MAP_ID) = wndMap then
	Print "Map ID: " + str$(MapID) + " was correct"
End if

See Also:

FrontWindow() function, LegendFrameInfo() function, LegendTextFrameInfo() function, LegendStyleInfo() function, WindowID() function