GetDataAreaGridDimRanges

Syntax

DataAreaGridDimRanges GetDataAreaGridDimRanges(string mon, DataAreaGridDimRanges tArg)

Parameters

mon. Moniker of the Table visualizer.

tArg. Parameters of cell ranges that should be obtained.

Description

The GetDataAreaGridDimRanges operation gets information about cell ranges corresponding to heading and sidehead dimensions.

Comments

To execute the operation, in the mon field specify regular report instance moniker with the !DataArea!DataSources!source key!DataSourceSlices!slice key!Views!table key postfix. The moniker can be obtained on executing the OpenPrxMeta operation. In the tArg field specify empty values or default values for the fields, which values should be obtained.

The operation returns the obtained information about cell ranges.

Example

Below is the example of getting information about the cell ranges, which contain dimension elements. The request contains table moniker. The response contains the obtained information about ranges.

 

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">
<GetDataAreaGridDimRanges xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">GLCLGKOCBPDOFOAEENFEDILEMKNEILDEEJBICAEDMGPNBJLP!M!S!PIKDEKAPCBPDOFOAEIFJLGPOHDBHHIAFEFIDCDPHPDEAMFAID!DataArea!DataSources!1!DataSourceSlices!1!Views!6</mon>
<tArg xmlns="">
<its>
<it>
<dimKey>
  <dimKey>-1</dimKey>
  </dimKey>
  </it>
  </its>
  </tArg>
  </GetDataAreaGridDimRanges>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetDataAreaGridDimRangesResult 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>
<dimKey>
  <dimKey>5858</dimKey>
  </dimKey>
<range>
  <left>0</left>
  <top>0</top>
  <width>0</width>
  <height>0</height>
  <type>None</type>
  </range>
  </it>
<it>
<dimKey>
  <dimKey>112</dimKey>
  </dimKey>
<range>
  <left>2</left>
  <top>1</top>
  <width>2</width>
  <height>1</height>
  <type>MultiPart</type>
  <address>C1:D1</address>
<parts>
<it>
  <left>2</left>
  <top>1</top>
  <width>2</width>
  <height>1</height>
  <type>Cells</type>
  <address>C1:D1</address>
  </it>
  </parts>
  </range>
  </it>
<it>
<dimKey>
  <dimKey>116</dimKey>
  </dimKey>
<range>
  <left>1</left>
  <top>2</top>
  <width>1</width>
  <height>2</height>
  <type>MultiPart</type>
  <address>B2:B3</address>
<parts>
<it>
  <left>1</left>
  <top>2</top>
  <width>1</width>
  <height>2</height>
  <type>Cells</type>
  <address>B2:B3</address>
  </it>
  </parts>
  </range>
  </it>
<it>
<dimKey>
  <dimKey>991</dimKey>
  </dimKey>
<range>
  <left>0</left>
  <top>0</top>
  <width>0</width>
  <height>0</height>
  <type>None</type>
  </range>
  </it>
  </its>
  </GetDataAreaGridDimRangesResult>
  </soapenv:Body>
  </soapenv:Envelope>
 

JSON request:

{
 "GetDataAreaGridDimRanges" : 
  {
   "mon" : "GLCLGKOCBPDOFOAEENFEDILEMKNEILDEEJBICAEDMGPNBJLP!M!S!PIKDEKAPCBPDOFOAEIFJLGPOHDBHHIAFEFIDCDPHPDEAMFAID!DataArea!DataSources!1!DataSourceSlices!1!Views!6",
   "tArg" : 
    {
     "its" : 
      {
       "it" : 
        [
          {
           "dimKey" : 
            {
             "dimKey" : "-1"
            }
          }
        ]
      }
    }
  }
}

JSON response:

{
 "GetDataAreaGridDimRangesResult" : 
  {
   "its" : 
    {
     "it" : 
      [
        {
         "dimKey" : 
          {
           "dimKey" : "5858"
          },
         "range" : 
          {
           "left" : "0",
           "top" : "0",
           "width" : "0",
           "height" : "0",
           "type" : "None"
          }
        },
        {
         "dimKey" : 
          {
           "dimKey" : "112"
          },
         "range" : 
          {
           "left" : "2",
           "top" : "1",
           "width" : "2",
           "height" : "1",
           "type" : "MultiPart",
           "address" : "C1:D1",
           "parts" : 
            {
             "it" : 
              {
               "left" : "2",
               "top" : "1",
               "width" : "2",
               "height" : "1",
               "type" : "Cells",
               "address" : "C1:D1"
              }
            }
          }
        },
        {
         "dimKey" : 
          {
           "dimKey" : "116"
          },
         "range" : 
          {
           "left" : "1",
           "top" : "2",
           "width" : "1",
           "height" : "2",
           "type" : "MultiPart",
           "address" : "B2:B3",
           "parts" : 
            {
             "it" : 
              {
               "left" : "1",
               "top" : "2",
               "width" : "1",
               "height" : "2",
               "type" : "Cells",
               "address" : "B2:B3"
              }
            }
          }
        },
        {
         "dimKey" : 
          {
           "dimKey" : "991"
          },
         "range" : 
          {
           "left" : "0",
           "top" : "0",
           "width" : "0",
           "height" : "0",
           "type" : "None"
          }
        }
      ]
    }
  }
}
  
public static DataAreaGridDimRanges GetDataAreaGridDimRanges(string moniker, uint sourceKey, uint sliceKey, uint viewKey)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetDataAreaGridDimRanges()
    {
        tArg = new DataAreaGridDimRanges()
        {
            its = new DataAreaGridDimRange[]
            {
                new DataAreaGridDimRange()
                {
                    dimKey = new DataAreaGridDimIdent() { dimKey = uint.MaxValue }
                }
            }
        },
        mon = moniker + "!DataArea!DataSources!" + sourceKey.ToString() + "!DataSourceSlices!" + sliceKey.ToString() + "!Views!" + viewKey.ToString()
    };
    // Get information about dimension ranges
    var result = somClient.GetDataAreaGridDimRanges(tGet);
    return result;
}

See also:

Working with Regular Reports