IMapLegend.CustomFormat

Fore Syntax

CustomFormat: String;

Fore.NET Syntax

CustomFormat: String;

Description

The CustomFormat property enables the user to set a custom number format for a legend.

Comments

The data display format is formed by reserved format codes. Codes are described in the Number Format section. Set data display format in the Russian version of format code to correctly show while changing language interface settings of Foresight Analytics Platform. For example, the format of date display DD.MM.YYYY will be correctly displayed in any selected system interface language. At the same time the format DD.MM.YYYY will be available only in the English version.

Fore Example

Executing the example requires a form with the Button1 button, the UiMap component named UiMap1 that is a data source for the MapBox component. The UiMap1 component must have a connected map that contains a map factor only.

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);
Var
    Map: IMap;
    Layer: IMapLayer;
    Legend: IMapLegend;
Begin
    Map := UiMap1.Map;
    Legend := New DxMapLegend.Create As IMapLegend;
    Map.View.Legend := Legend;
    Legend.Visible := True;
    Legend.BeginUpdate;
    Layer := Map.Layers.FindByName("Regions");
    Legend.Visual := Layer.Visuals.Item(0);
    Legend.CustomFormat := "0,0";
    Legend.EndUpdate;
End Sub Button1OnClick;

After executing the example the legend is displayed for the map factor. The values in the legend are displayed in numeric format with one decimal digit.

Fore.NET Example

Executing the example requires a form with the Button1 button, the UiMapNet component named UiMapNet1 that is a data source for the MapBoxNet component. The UiMapNet1 component must have a connected map that contains a map factor only.

Imports System;
Imports Prognoz.Platform.Interop.Metabase;
Imports Prognoz.Platform.Interop.Map;

Private Sub button1_Click(sender: System.Object; e: System.EventArgs);
Var
    Map: IMap;
    Layer: IMapLayer;
    Legend: DxMapLegend = New DxMapLegendClass();
Begin
    Map := UiMapNet1.Map;
    Map.View.Legend := Legend As DxMapLegend;
    Legend.Visible := True;
    Legend.BeginUpdate();
    Layer := Map.Layers.FindByName["Regions"];
    Legend.Visual := Layer.Visuals.Item[0];
    Legend.CustomFormat := "0,0";
    Legend.EndUpdate();
End Sub;

After executing the example the legend is displayed for the map factor. The values in the legend are displayed in numeric format with one decimal digit.