TopLegend Object

The TopLegend object is the container for the samples and legend information for one or more map layers. The TopLegend object includes properties for the top legend frame line and fill as well as which layers are included in the legend and how samples are displayed.

Derived from: Legend object which is derived from Shape object (All methods and properties of Legend and Shape apply to this object.)

The following table provides all the properties of the TopLegend object.

Property

Description

LayerLayout Sets the layer layout using SrfLegendLayerLayout
LayerNameFont Returns the FontFormat object for the layer name
LegendLayers Returns the LegendLayers collection
LayerSpacing Sets the layer spacing in page units
SampleFont Returns the FontFormat object. It is a read-only property
SampleFormat Returns the LabelFormat object. It is a read-only property
SampleOrder Sets/returns the order of the legend sample items using SrfLegendSampleOrder
ShowLayerName True to show the layer name