View.Legend Property

Gets or sets a map legend associated with this view.

Syntax

public Legend Legend { get; set; }

Property Value

Type: Legend
Default: null
The map legend associated with this view.

Remarks

The map legend for a view is typically configured in Carmenta Studio. There are two ways to use a Legend object:

As metadata. When a Legend object is used only as the Legend property of a layer or a view, it will not be displayed in the map window. However, you can write application code that will access such a Legend and display in some other GUI panel. Carmenta Explorer is an application that behaves in this way: if a view or a layer with a Legend property is selected in the Layers panel, then the legend will be displayed in the Properties panel.
As part of the map window. When a Legend object is used in a ScreenLayer as one of its ScreenLayer.Elements, it will be displayed in the map window.

Example

// Set a default Legend in the 2D View
public static void SetDefaultLegend(View view, Legend defaultLegend)
{
    // Set the default legend in the view
    view.Legend = defaultLegend;

    // Update the View
    view.Update();
}

Platforms

Windows, Linux, Android

View::legend Property

Gets or sets a map legend associated with this view.

Syntax

C++

public:
LegendPtr legend ( ) const;
void legend ( const LegendPtr& value )

Property Value

Type: Legend
Default: null
The map legend associated with this view.

Remarks

The map legend for a view is typically configured in Carmenta Studio. There are two ways to use a Legend object:

As metadata. When a Legend object is used only as the legend property of a layer or a view, it will not be displayed in the map window. However, you can write application code that will access such a Legend and display in some other GUI panel. Carmenta Explorer is an application that behaves in this way: if a view or a layer with a legend property is selected in the Layers panel, then the legend will be displayed in the Properties panel.
As part of the map window. When a Legend object is used in a ScreenLayer as one of its ScreenLayer::elements, it will be displayed in the map window.

Example

C++

// Set a default legend in the View
static void setDefaultLegend(ViewPtr view, LegendPtr defaultLegend)
{
    // Set the default legend in the view
    view->legend(defaultLegend);

    // Update the View
    view->update();
}

Platforms

Windows, Linux, Android

View.legend Property

Gets or sets a map legend associated with this view.

Syntax

Java

public final Legend getLegend ( );
public final void setLegend ( Legend value );

Property Value

Type: Legend
Default: null
The map legend associated with this view.

Remarks

The map legend for a view is typically configured in Carmenta Studio. There are two ways to use a Legend object:

As metadata. When a Legend object is used only as the legend property of a layer or a view, it will not be displayed in the map window. However, you can write application code that will access such a Legend and display in some other GUI panel. Carmenta Explorer is an application that behaves in this way: if a view or a layer with a legend property is selected in the Layers panel, then the legend will be displayed in the Properties panel.
As part of the map window. When a Legend object is used in a ScreenLayer as one of its ScreenLayer.elements, it will be displayed in the map window.

Example

Java

// Set a default Legend in the 2D View
public static void setDefaultLegend(View view, Legend defaultLegend)
{
    // Set the default legend in the view
    view.setLegend(defaultLegend);

    // Update the View
    view.update();
}

Platforms

Windows, Linux, Android

View.legend Property

Gets or sets a map legend associated with this view.

Syntax

Python

legend

Property Value

Type: Legend
Default: null
The map legend associated with this view.

Remarks

The map legend for a view is typically configured in Carmenta Studio. There are two ways to use a Legend object:

As metadata. When a Legend object is used only as the legend property of a layer or a view, it will not be displayed in the map window. However, you can write application code that will access such a Legend and display in some other GUI panel. Carmenta Explorer is an application that behaves in this way: if a view or a layer with a legend property is selected in the Layers panel, then the legend will be displayed in the Properties panel.
As part of the map window. When a Legend object is used in a ScreenLayer as one of its ScreenLayer.elements, it will be displayed in the map window.

Example

Python

# This example is not available in the selected language.

Platforms

Windows, Linux, Android

View.Legend Property

In this article

Syntax

Property Value

Remarks

Example

Platforms

See Also

Reference

View::legend Property

In this article

Syntax

Property Value

Remarks

Example

Platforms

See Also

Reference

View.legend Property

In this article

Syntax

Property Value

Remarks

Example

Platforms

See Also

Reference

View.legend Property

In this article

Syntax

Property Value

Remarks

Example

Platforms

See Also

Reference