GetDashboardVisualizers

Syntax

DashboardVisualizers GetDashboardVisualizers(string mon, DashboardVisualizers tArg)

Parameters

mon. Moniker for working with information panel visualizers.

tArg. Operation execution parameters.

Description

The GetDashboardVisualizers operation gets information about visualizers created in information panel.

Comments

To execute the operation, in the mon field specify moniker of opened information panel instance with the !Visualizers postfix, and in the tArg.its field specify empty values or default values for the fields, which values should be obtained. The moniker can be obtained on executing the OpenDashboard operation.

The operation results in the obtained information about information panel visualizers.

Example

Below is the example of getting a list of information panel visualizers. The request contains moniker for working with visualizers and a list of obtained visualizer settings. The response contains the obtained information.

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">
<GetDashboardVisualizers xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI!Visualizers</mon>
<tArg xmlns="">
<its>
<it>
  <k>-1</k>
  <n />
  <x>2147483647</x>
  <y>2147483647</y>
  <height>-1</height>
  <width>-1</width>
  <metaModelKey>-1</metaModelKey>
  <type>Chart</type>
  <chartType>Areas</chartType>
  <parentKey>-1</parentKey>
  <title />
  <useSync>false</useSync>
  <useSelectionSync>false</useSelectionSync>
<syncGroups>
<its>
<it>
  <k>-1</k>
  <dimKeys />
  </it>
  </its>
  </syncGroups>
  <settings />
  </it>
  </its>
  </tArg>
  </GetDashboardVisualizers>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetDashboardVisualizersResult 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">
<its xmlns="">
<it>
  <k>1</k>
  <n />
  <x>630</x>
  <y>101</y>
  <height>423</height>
  <width>714</width>
  <metaModelKey>1</metaModelKey>
  <type>Grid</type>
  <chartType>Bars</chartType>
  <parentKey>0</parentKey>
  <title>Table title</title>
  <useSync>0</useSync>
  <useSelectionSync>0</useSelectionSync>
<syncGroups>
<its>
<it>
  <k>-1</k>
  <dimKeys />
  </it>
  </its>
  </syncGroups>
  <settings>{"exportLayout":"Landscape","exportFileFormat":"pdf"}</settings>
  </it>
<it>
  <k>2</k>
  <n />
  <x>641</x>
  <y>537</y>
  <height>560</height>
  <width>640</width>
  <metaModelKey>2</metaModelKey>
  <type>Chart</type>
  <chartType>Petals</chartType>
  <parentKey>0</parentKey>
  <title />
  <useSync>0</useSync>
  <useSelectionSync>0</useSelectionSync>
<syncGroups>
<its>
<it>
  <k>-1</k>
  <dimKeys />
  </it>
  </its>
  </syncGroups>
  <settings>{"exportLayout":"Landscape","exportFileFormat":"pdf"}</settings>
  </it>
  </its>
  </GetDashboardVisualizersResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetDashboardVisualizers" : 
  {
   "mon" : "NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI!Visualizers",
   "tArg" : 
    {
     "its" : 
      {
       "it" : 
        [
          {
           "k" : "-1",
           "n" : "",
           "x" : "2147483647",
           "y" : "2147483647",
           "height" : "-1",
           "width" : "-1",
           "metaModelKey" : "-1",
           "type" : "Chart",
           "chartType" : "Areas",
           "parentKey" : "-1",
           "title" : "",
           "useSync" : "false",
           "useSelectionSync" : "false",
           "syncGroups" : 
            {
             "its" : 
              {
               "it" : 
                [
                  {
                   "k" : "-1",
                   "dimKeys" : ""
                  }
                ]
              }
            },
           "settings" : ""
          }
        ]
      }
    }
  }
}

JSON response:

{
 "GetDashboardVisualizersResult" : 
  {
   "its" : 
    {
     "it" : 
      [
        {
         "k" : "1",
         "n" : "",
         "x" : "630",
         "y" : "101",
         "height" : "423",
         "width" : "714",
         "metaModelKey" : "1",
         "type" : "Grid",
         "chartType" : "Bars",
         "parentKey" : "0",
         "title" : "Table title",
         "useSync" : "0",
         "useSelectionSync" : "0",
         "syncGroups" : 
          {
           "its" : 
            {
             "it" : 
              [
                {
                 "k" : "4294967295",
                 "dimKeys" : ""
                }
              ]
            }
          },
         "settings" : "{"exportLayout":"Landscape","exportFileFormat":"pdf"}"
        },
        {
         "k" : "2",
         "n" : "",
         "x" : "641",
         "y" : "537",
         "height" : "560",
         "width" : "640",
         "metaModelKey" : "2",
         "type" : "Chart",
         "chartType" : "Petals",
         "parentKey" : "0",
         "title" : "",
         "useSync" : "0",
         "useSelectionSync" : "0",
         "syncGroups" : 
          {
           "its" : 
            {
             "it" : 
              [
                {
                 "k" : "4294967295",
                 "dimKeys" : ""
                }
              ]
            }
          },
         "settings" : "{"exportLayout":"Landscape","exportFileFormat":"pdf"}"
        }
      ]
    }
  }
}
public static DashboardVisualizers GetDashboardVisualizers(string moniker)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetDashboardVisualizers()
    {
        tArg = new DashboardVisualizers()
        {
            its = new DashboardVisualizer[]
            {
                new DashboardVisualizer()
                {
                    k = uint.MaxValue,
                    n = string.Empty,
                    type = SomDashboardVisualizerType.Chart,
                    chartType = SomDashboardChartType.Areas,
                    x = int.MaxValue,
                    y = int.MaxValue,
                    height = uint.MaxValue,
                    width = uint.MaxValue,
                    settings = string.Empty,
                    metaModelKey = uint.MaxValue,
                    parentKey = uint.MaxValue,
                    useSync = new bool(),
                    useSelectionSync = new bool(),
                    title = string.Empty,
                    syncGroups = new DataAreaSyncGroups()
                    {
                        its = new DataAreaSyncGroup[]
                        {
                            new DataAreaSyncGroup()
                            {
                                k = uint.MaxValue,
                                dimKeys = new uint[0]
                            }
                        }
                    }
                }
            }
        },
        // Moniker for working with information panel visualizers
        mon = moniker + "!Visualizers"
    };
    // Get information about information panel visualizers
    var result = somClient.GetDashboardVisualizers(tGet);
    return result;
}

See also:

Working with Information Panel