GetMap

Syntax

GetMapResult GetMap(MapId tMap, GetMapArg tArg)

Parameters

tMap. Map moniker.

tArg. Parameters of metadata getting.

Description

The GetMap operation gets map metadata.

Comments

To execute the operation, specify map moniker in the tMap parameter, and metadata getting parameters in the tArg parameter. The moniker can be based on moniker of opened instance of the object, which map is used to work with, following these rules:

In the tArg.pattern field specify the pattern to be used to get metadata. The operation results in the requested information.

Example

Below is the example of using the GetMap operation to get visual settings of express report map. The request contains map moniker and the pattern for settings getting. The response contains requested data.

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetMap xmlns="http://www.fsight.ru/PP.SOM.Som">
<tMap xmlns=" ">
  <id>S1!M!S!E2!Map</id>
  </tMap>
<tArg xmlns=" ">
<pattern>
  <All>false</All>
  <DataSource>false</DataSource>
  <Visual>true</Visual>
  </pattern>
  </tArg>
  </GetMap>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetMapResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id xmlns=" ">
  <id>S1!M!S!E2!Map</id>
  </id>
<meta xmlns=" ">
<md>
<MapChart Type="SVG" Mode="Drawing2D" Background="#FFFFFFFF" Topobase="{Topobase}">
<ItemsDictionary>
  <Font Id="LegendFontHeader" Color="#FF000000" FontFamily="Arial" IsBold="False" IsItalic="False" Size="11" />
  <Font Id="MapFont" Color="#FF010000" FontFamily="Tahoma" IsBold="False" IsItalic="False" Size="7" />
  <Font Id="MapTerritoryTranscriptFont" Color="#FF010000" FontFamily="Arial" IsBold="False" IsItalic="False" Size="9" />
  <Font Id="LegendFont" Color="#FF000000" FontFamily="Arial" IsBold="False" IsItalic="False" Size="21" />
  <Font Id="LegendFontFooter" Color="#FF000000" FontFamily="Arial" IsBold="False" IsItalic="False" Size="11" />
  <Font Id="ToolTipFont" Color="#918F8D" FontFamily="Lucida Grande" IsBold="False" IsItalic="False" Size="13.333000183105469" />
  <MapToolTip Id="MainToolTipStyle" Font="{ToolTipFont}" Background="#FFFFFFFF" BorderColor="#FFC1C1C1" BorderRadius="2" BorderThickness="1" Padding="5 5 5 5" TextWrapping="NoWrap" HoverMode="MouseOver" NoDataText="no data" MaskText="{%Name}" />
  <BorderEffect Id="BorderEffectDefault" BorderColor="Orange" BorderThickness="1" />
  <MapLabel Id="MainLabelStyle" Padding="2 2 2 2" Font="{MapFont}" MaskText="{0}: {1:#,##0.00}" TextWrapping="NoWrap" />
  </ItemsDictionary>
<MapLayers>
  <MapLayer Id="Background" />
  <MapLayer Id="Regions" ToolTip="{MainToolTipStyle}" Effect="{BorderEffectDefault}" />
  <MapLayer Id="Water" />
  <MapLayer Id="SmallRivers" />
  <MapLayer Id="BigRivers" />
  <MapLayer Id="Lakes" />
  <MapLayer Id="Cities" />
  <MapLayer Id="Railways" />
  </MapLayers>
<MapLegends>
<MapLegend Background="#80FFFFFF" BorderRadius="0" Width="0" Height="0" Margin="6 6 6 6" NoDataVisible="TRUE" VerticalAlignment="Top" HorizontalAlignment="Left" BetweenFormat="from {0:#,##0.00} to {1:#,##0.00}" EqualFormat="equal to {0:#,##0.00}" GreaterFormat="greater than {0:#,##0.00}" LessFormat="less than {0:#,##0.00}" NoDataText="no data" IsOuter="False" ColumnCount="8" TextWrapping="NoWrap" Marker="Circle" Font="{LegendFont}" IncludeEquals="False" Visibility="Visible" Padding="3 0 3 0">
<MapLegend.Header>
  <MapLabel Background="#00000000" Text="" Font="{LegendFontHeader}" MaskText="{0}" TextWrapping="NoWrap" />
  </MapLegend.Header>
<MapLegend.Footer>
  <MapLabel Background="#00000000" Text="" Font="{LegendFontFooter}" MaskText="{0}" TextWrapping="NoWrap" />
  </MapLegend.Footer>
  </MapLegend>
<SizeLegend Background="#80FFFFFF" BorderRadius="0" Width="0" Height="0" Margin="6 6 6 6" VerticalAlignment="Center" HorizontalAlignment="Right" IsOuter="False" Font="{LegendFont}" Visibility="Collapsed" Padding="3 0 3 0" ItemFormat="#,##0.00">
<MapLegend.Header>
  <MapLabel Background="#00000000" Text="" Font="{LegendFontHeader}" MaskText="{0}" TextWrapping="NoWrap" />
  </MapLegend.Header>
  </SizeLegend>
  </MapLegends>
  <MapTerritoryTranscript ParentLayer="{Regions}" ColumnCount="0" MaxItemCount="0" Font="{MapTerritoryTranscriptFont}" SortingMode="Asc" Background="#80FFFFFF" BorderColor="#FF000000" BorderThickness="1" Padding="2 2 2 2" TextWrapping="NoWrap" Left="0.01" Top="0.65" VerticalAlignment="Relative" HorizontalAlignment="Relative" Width="0" Height="0" HighlightBrush="#800000FF" Visibility="Collapsed" />
  </MapChart>
  </md>
<topobaseOd isShortcut="0" isLink="0">
  <i>OBJ1533</i>
  <n>RF.tbs</n>
  <k>1533</k>
  <c>3330</c>
  <p>51</p>
  <h>0</h>
  </topobaseOd>
  <options>[{"Name": "mapmaster.timelinepanel.currentstep","Value": 0},{"Name": "mapmaster.signaturespanel.columnscount","Value": 8},{"Name": "mapmaster.stylespanel.enableborder","Value": false},{"Name": "mapmaster.stylespanel.borderthickness","Value": 0},{"Name": "mapmaster.stylespanel.border","Value": "#000000"},{"Name": "mapmaster.stylespanel.background","Value": {"SolidColorBrush": {"@Color": "#ffffff","@Opacity": 0.501960813999176}}},{"Name": "mapmaster.stylespanel.fontfamily","Value": "Arial"},{"Name": "mapmaster.stylespanel.fontsize","Value": 21.3333339691162},{"Name": "mapmaster.stylespanel.isbold","Value": false},{"Name": "mapmaster.stylespanel.isitalic","Value": false},{"Name": "mapmaster.stylespanel.isunderline","Value": false},{"Name": "mapmaster.stylespanel.fontcolor","Value": "#000000"}]</options>
  </meta>
  </GetMapResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetMap" : 
  {
   "tMap" : 
    {
     "id" : "S1!M!S!E2!Map"
    },
   "tArg" : 
    {
     "pattern" : 
      {
       "All" : "false",
       "DataSource" : "false",
       "Visual" : "true"
      }
    }
  }
}

JSON response:

{
 "GetMapResult" : 
  {
   "id" : 
    {
     "id" : "S1!M!S!E2!Map"
    },
   "meta" : 
    {
     "md" : 
      {
       "MapChart" : 
        {
         "@Background" : "#FFFFFFFF",
         "@Type" : "SVG",
         "@Mode" : "Drawing2D",
         "@Topobase" : "{Topobase}",
         "ItemsDictionary" : 
          {
           "Font" : 
            [
              {
               "@IsItalic" : "False",
               "@FontFamily" : "Arial",
               "@Size" : "11",
               "@Id" : "LegendFontHeader",
               "@IsBold" : "False",
               "@Color" : "#FF000000"
              },
              {
               "@IsItalic" : "False",
               "@FontFamily" : "Tahoma",
               "@Size" : "7",
               "@Id" : "MapFont",
               "@IsBold" : "False",
               "@Color" : "#FF010000"
              },
              {
               "@IsItalic" : "False",
               "@FontFamily" : "Arial",
               "@Size" : "9",
               "@Id" : "MapTerritoryTranscriptFont",
               "@IsBold" : "False",
               "@Color" : "#FF010000"
              },
              {
               "@IsItalic" : "False",
               "@FontFamily" : "Arial",
               "@Size" : "21",
               "@Id" : "LegendFont",
               "@IsBold" : "False",
               "@Color" : "#FF000000"
              },
              {
               "@IsItalic" : "False",
               "@FontFamily" : "Arial",
               "@Size" : "11",
               "@Id" : "LegendFontFooter",
               "@IsBold" : "False",
               "@Color" : "#FF000000"
              },
              {
               "@IsItalic" : "False",
               "@FontFamily" : "Lucida Grande",
               "@Size" : "13.333000183105469",
               "@Id" : "ToolTipFont",
               "@IsBold" : "False",
               "@Color" : "#918F8D"
              }
            ],
           "MapToolTip" : 
            {
"@Background" : "#FFFFFFFF",
"@MaskText" : "{%Name}",
"@BorderRadius" : "2",
"@Font" : "{ToolTipFont}",
"@Padding" : "5 5 5 5",
"@HoverMode" : "MouseOver",
"@BorderThickness" : "1",
"@NoDataText" : "no data",
"@Id" : "MainToolTipStyle",
"@BorderColor" : "#FFC1C1C1"
            },
           "BorderEffect" : 
            {
             "@BorderThickness" : "1",
             "@Id" : "BorderEffectDefault",
             "@BorderColor" : "Orange"
            },
           "MapLabel" : 
            {
             "@MaskText" : "{0}: {1:#,##0.00}",
             "@Padding" : "2 2 2 2",
             "@Font" : "{MapFont}",
             "@Id" : "MainLabelStyle",
             "@TextWrapping" : "NoWrap"
            }
          },
         "MapLayers" : 
          {
           "MapLayer" : 
            [
              {
               "@Id" : "Background"
              },
              {
               "@ToolTip" : "{MainToolTipStyle}",
               "@Id" : "Regions",
               "@Effect" : "{BorderEffectDefault}"
              },
              {
               "@Id" : "Water"
              },
              {
               "@Id" : "SmallRivers"
              },
              {
               "@Id" : "BigRivers"
              },
              {
               "@Id" : "Lakes"
              },
              {
               "@Id" : "Cities"
              },
              {
               "@Id" : "Railways"
              }
            ]
          },
         "MapLegends" : 
          {
           "MapLegend" : 
            {
             "@LessFormat" : "less than {0:#,##0.00}",
             "@Width" : "0",
             "@Background" : "#80FFFFFF",
             "@EqualFormat" : "equal {0:#,##0.00}",
             "@Marker" : "Circle",
             "@NoDataVisible" : "TRUE",
             "@BorderRadius" : "0",
             "@Visibility" : "Visible",
             "@HorizontalAlignment" : "Left",
             "@IsOuter" : "False",
             "@TextWrapping" : "NoWrap",
             "@IncludeEquals" : "False",
             "@GreaterFormat" : "greater than {0:#,##0.00}",
             "@BetweenFormat" : "from {0:#,##0.00} to {1:#,##0.00}",
             "@ColumnCount" : "8",
             "@Font" : "{LegendFont}",
             "@Padding" : "3 0 3 0",
             "@VerticalAlignment" : "Top",
             "@Height" : "0",
             "@NoDataText" : "no data",
             "@Margin" : "6 6 6 6",
             "MapLegend.Header" : 
              {
               "MapLabel" : 
                {
                 "@Background" : "#00000000",
                 "@MaskText" : "{0}",
                 "@Text" : "",
                 "@Font" : "{LegendFontHeader}",
                 "@TextWrapping" : "NoWrap"
                }
              },
             "MapLegend.Footer" : 
              {
               "MapLabel" : 
                {
                 "@Background" : "#00000000",
                 "@MaskText" : "{0}",
                 "@Text" : "",
                 "@Font" : "{LegendFontFooter}",
                 "@TextWrapping" : "NoWrap"
                }
              }
            },
           "SizeLegend" : 
            {
             "@Background" : "#80FFFFFF",
             "@Width" : "0",
             "@BorderRadius" : "0",
             "@Font" : "{LegendFont}",
             "@Padding" : "3 0 3 0",
             "@Visibility" : "Collapsed",
             "@ItemFormat" : "#,##0.00",
             "@Height" : "0",
             "@VerticalAlignment" : "Center",
             "@HorizontalAlignment" : "Right",
             "@IsOuter" : "False",
             "@Margin" : "6 6 6 6",
             "MapLegend.Header" : 
              {
               "MapLabel" : 
                {
                 "@Background" : "#00000000",
                 "@MaskText" : "{0}",
                 "@Text" : "",
                 "@Font" : "{LegendFontHeader}",
                 "@TextWrapping" : "NoWrap"
                }
              }
            }
          },
         "MapTerritoryTranscript" : 
          {
           "@Width" : "0",
           "@Background" : "#80FFFFFF",
           "@ParentLayer" : "{Regions}",
           "@Visibility" : "Collapsed",
           "@HorizontalAlignment" : "Relative",
           "@BorderThickness" : "1",
           "@Left" : "0.01",
           "@SortingMode" : "Asc",
           "@TextWrapping" : "NoWrap",
           "@Top" : "0.65",
           "@Padding" : "2 2 2 2",
           "@Font" : "{MapTerritoryTranscriptFont}",
           "@ColumnCount" : "0",
           "@Height" : "0",
           "@VerticalAlignment" : "Relative",
           "@HighlightBrush" : "#800000FF",
           "@BorderColor" : "#FF000000",
           "@MaxItemCount" : "0"
          }
        }
      },
     "topobaseOd" : 
      {
       "@isShortcut" : "0",
       "@isLink" : "0",
       "i" : "OBJ1533",
       "n" : "RF.tbs",
       "k" : "1533",
       "c" : "3330",
       "p" : "51",
       "h" : "0"
      },
     "options" : "[{"Name": "mapmaster.timelinepanel.currentstep","Value": 0},{"Name": "mapmaster.signaturespanel.columnscount","Value": 8},{"Name": "mapmaster.stylespanel.enableborder","Value": false},{"Name": "mapmaster.stylespanel.borderthickness","Value": 0},{"Name": "mapmaster.stylespanel.border","Value": "#000000"},{"Name": "mapmaster.stylespanel.background","Value": {"SolidColorBrush": {"@Color": "#ffffff","@Opacity": 0.501960813999176}}},{"Name": "mapmaster.stylespanel.fontfamily","Value": "Arial"},{"Name": "mapmaster.stylespanel.fontsize","Value": 21.3333339691162},{"Name": "mapmaster.stylespanel.isbold","Value": false},{"Name": "mapmaster.stylespanel.isitalic","Value": false},{"Name": "mapmaster.stylespanel.isunderline","Value": false},{"Name": "mapmaster.stylespanel.fontcolor","Value": "#000000"}]"
    }
  }
}
public static GetMapResult GetMap(EaxId eax)
{
var somClient = new SomPortTypeClient(); //Proxy object for operation execution
//Operation execution parameters
var tArg = new GetMap()
{
tArg = new GetMapArg()
{
pattern = new MapMdPattern()
{
All = false,
DataSource = false,
Visual = true
}
},
tMap = new MapId()
{
id = eax.id + "!Map"
}
};
//Get map metadata
var tResult = somClient.GetMap(tArg);
return tResult;
}

See also:

Interactive Visual Components