GetChartCorridors

Syntax

Result GetChartCorridors(ChartCorridorsId tCorridors)

Parameters

tCorridors. Moniker for working with chart corridors.

Description

The GetChartCorridors operation gets chart corridor settings.

Comments

To execute the operation, in the tCorridors field specify chart corridor moniker, and in the tArg field specify the settings to be applied. The moniker can be created based on the chart moniker specified in the GetChart, SetChart, GetChartSeries operations. The moniker is created in the following format: 'Chart moniker'!Corridors.

The operation results in the obtained chart corridor settings.

Example

Below is the example of getting chart corridor settings. The request contains moniker for working with corridors. The response contains the obtained settings.

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">
<GetChartCorridors xmlns="http://www.fsight.ru/PP.SOM.Som">
<tCorridors xmlns="">
  <id>EDKKJPHJEHILFOAEPIMEEFNEPLBBPMIENIOCOOKNODOIOCGE!M!S!PPDJOMGIJEHILFOAEKDIEBFPLEKLKDGJEDJIIBCHBAEAKDPIA!Sheets!1!Objects!PrxChart1!Corridors</id>
  </tCorridors>
  </GetChartCorridors>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetChartCorridorsResult 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">
<corridors xmlns="">
<it>
  <s1>0</s1>
  <s2>1</s2>
  <gf>1</gf>
  <clr>#705E70</clr>
  <tp>62</tp>
  <name>USA - Canada</name>
  <dl>1</dl>
  </it>
<it>
  <s1>2</s1>
  <s2>3</s2>
  <gf>1</gf>
  <clr>#EF9859</clr>
  <tp>50</tp>
  <name>Germany - France</name>
  <dl>0</dl>
  </it>
  </corridors>
  </GetChartCorridorsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetChartCorridors" :
{
"tCorridors" :
{
"id" : "EDKKJPHJEHILFOAEPIMEEFNEPLBBPMIENIOCOOKNODOIOCGE!M!S!PPDJOMGIJEHILFOAEKDIEBFPLEKLKDGJEDJIIBCHBAEAKDPIA!Sheets!1!Objects!PrxChart1!Corridors"
}
}
}

JSON response:

{
"GetChartCorridorsResult" :
{
"corridors" :
{
"it" :
[
{
"s1" : "0",
"s2" : "1",
"gf" : "1",
"clr" : "#705E70",
"tp" : "62",
"name" : "USA - Canada",
"dl" : "1"
},
{
"s1" : "2",
"s2" : "3",
"gf" : "1",
"clr" : "#EF9859",
"tp" : "50",
"name" : "Germany - France",
"dl" : "0"
}
]
}
}
}
public static ChartCorridors GetChartCorridors(string chartMoniker)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetChartCorridors()
{
tCorridors = new ChartCorridorsId
{
id = chartMoniker + "!Corridors"
}
};
// Get chart corridors
var result = somClient.GetChartCorridors(tGet);
return result;
}

See also:

Chart