GetSeriesGroupTree

Syntax

ChartStyleAbsoluteGroup GetSeriesGroupTree(ChartAbsoluteGroupId mon)

Parameters

mon. Moniker for working with histogram series groups.

Description

The GetSeriesGroupTree operation gets a tree of histogram series grouping.

Comments

The operation is used on working with histograms that display data as groups. To execute the operation, in the mon field specify regular report instance moniker with the !Sheets!sheet key!Objects!chart identifier!Group postfix to work with series groups. Moniker of regular report instance can be obtained on executing the OpenPrxMeta operation.

The operation results in the tree of series groups.

Example

Below is the example of getting a tree of histogram series grouping located on a regular report sheet. The request contains moniker for working with series groups. The response contains the obtained tree of series groups.

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">
<GetSeriesGroupTree xmlns="http://www.fsight.ru/PP.SOM.Som">
<mon xmlns="">
  <id>DJKIICCJHNCAGOAEAEMMLBNLKMJNJKJEKJKGJNLJPENPPEMD!M!S!PCJENOHCJHNCAGOAEOFHBIKJIBIKIODFEDIEGIMLOAMBJKDAG!Sheets!1!Objects!PrxChart4!Group</id>
  </mon>
  </GetSeriesGroupTree>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetSeriesGroupTreeResult 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">
<rg xmlns="">
<it>
<s>
<it>
  <idx>0</idx>
  <di>0</di>
  <n>Item 1</n>
  </it>
  </s>
  </it>
<it>
<s>
<it>
  <idx>1</idx>
  <di>1</di>
  <n>Item 2</n>
  </it>
<it>
  <idx>2</idx>
  <di>2</di>
  <n>Item 3</n>
  </it>
<it>
  <idx>3</idx>
  <di>3</di>
  <n>Item 4</n>
  </it>
  </s>
  </it>
  </rg>
  </GetSeriesGroupTreeResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetSeriesGroupTree" :
{
"mon" :
{
"id" : "DJKIICCJHNCAGOAEAEMMLBNLKMJNJKJEKJKGJNLJPENPPEMD!M!S!PCJENOHCJHNCAGOAEOFHBIKJIBIKIODFEDIEGIMLOAMBJKDAG!Sheets!1!Objects!PrxChart4!Group"
}
}
}

JSON response:

{
"GetSeriesGroupTreeResult" :
{
"rg" :
{
"it" :
[
{
"s" :
{
"it" :
{
"idx" : "0",
"di" : "0",
"n" : "First element"
}
}
},
{
"s" :
{
"it" :
[
{
"idx" : "1",
"di" : "1",
"n" : "Second element"
},
{
"idx" : "2",
"di" : "2",
"n" : "Third element"
},
{
"idx" : "3",
"di" : "3",
"n" : "Fourth element"
}
]
}
}
]
}
}
}
public static ChartStyleAbsoluteGroup GetSeriesGroupTree(string moniker, string sheetKey, string chartId)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetSeriesGroupTree()
{
mon = new ChartAbsoluteGroupId() { id = moniker + "!Sheets!" + sheetKey + "!Objects!" + chartId + "!Group" }
};
// Get tree of series groups
var result = somClient.GetSeriesGroupTree(tGet);
return result;
}

See also:

Working with Regular Reports