GetChartCorridor

Syntax

Result GetChartCorridor(ChartCorridorId tCorridor)

Parameters

tCorridor. Moniker for working with a chart corridor.

Description

The GetChartCorridor operation gets chart corridor settings.

Comments

To execute the operation, in the tCorridor field specify chart corridor moniker, and in the tArg field specify settings to be determined. 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!'corridor key'.

The operation results in the obtained corridor settings.

Example

Below is the example of getting corridor settings. The request contains corridor moniker. 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">
<GetChartCorridor xmlns="http://www.fsight.ru/PP.SOM.Som">
<tCorridor xmlns="">
  <id>EDKKJPHJEHILFOAEPIMEEFNEPLBBPMIENIOCOOKNODOIOCGE!M!S!PPDJOMGIJEHILFOAEKDIEBFPLEKLKDGJEDJIIBCHBAEAKDPIA!Sheets!1!Objects!PrxChart1!Corridors!1</id>
  </tCorridor>
  </GetChartCorridor>
  </s:Body>
  </s:Envelope>

SOAP response:

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

JSON request:

{
"GetChartCorridor" :
{
"tCorridor" :
{
"id" : "EDKKJPHJEHILFOAEPIMEEFNEPLBBPMIENIOCOOKNODOIOCGE!M!S!PPDJOMGIJEHILFOAEKDIEBFPLEKLKDGJEDJIIBCHBAEAKDPIA!Sheets!1!Objects!PrxChart1!Corridors!1"
}
}
}

JSON response:

{
"GetChartCorridorResult" :
{
"s1" : "2",
"s2" : "3",
"gf" : "1",
"clr" : "#EF9859",
"tp" : "50",
"name" : "Germany - France",
"dl" : "0"
}
}
public static ChartCorridor GetChartCorridor(string chartMoniker, string corridorKey)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetChartCorridor()
{
tCorridor = new ChartCorridorId
{
id = chartMoniker + "!Corridors!" + corridorKey
}
};
// Get chart corridor settings
var result = somClient.GetChartCorridor(tGet);
return result;
}

See also:

Chart