Maptitude GISDK Help

DropLegendItem()

Summary

Drops an item from a manual legend.

 

Syntax

result = DropLegendItem(string map_name, array item_info)

 

Argument

Contents

map_name

The name of the map

item_info

An array containing the item type (a string) and other information about the item, as indicated below.

 

Item Type

Other Information

Space

An integer that is the position in the legend at which the space is located

Text

Two strings - the first is the text, the second is the font with which to display the text

Set

One string - the name of the set

Theme

A string with the name of the theme

Theme Bin

One string and one integer - the name of the theme and the number of the class

 

Returns

The number of items dropped: the number of bins in the theme if a theme is dropped, otherwise 1.

 

Example

rslt = DropLegendItem("My Map", {"Space", 4})

rslt = DropLegendItem("U.S. States", {"Set", "High Income States"})

 

Error Codes

Error Type

Meaning

Error

The type of the item was incorrect or the additional information is not specified correctly

NotFound

The named map does not exist or has no legend; the item array is null; or the specified item was not found

 

See Also

Function

Summary

CreateLegend()

Creates a map legend

AddLegendItem()

Adds an item to a manual map legend

 

 

©2025 Caliper Corporation www.caliper.com