AddChartCorridor

Syntax

ChartCorridorKey AddChartCorridor(ChartCorridorsId tCorridors, SetChartCorridorArg tArg)

Parameters

tCorridors. Moniker for working with chart corridors.

tArg. Operation execution parameters.

Description

The AddChartCorridor operation creates a chart corridor.

Comments

To execute the operation, in the tCorridors field specify moniker for working with chart corridors, and in the tArg field specify parameters of the created corridor. 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 key of the created corridor.

Example

Below is the example of adding a chart corridor. The request contains moniker for working with corridors and parameters of the added corridor. The response contains key of the created corridor.

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">
<AddChartCorridor xmlns="http://www.fsight.ru/PP.SOM.Som">
<tCorridors xmlns="">
  <id>EDKKJPHJEHILFOAEPIMEEFNEPLBBPMIENIOCOOKNODOIOCGE!M!S!PPDJOMGIJEHILFOAEKDIEBFPLEKLKDGJEDJIIBCHBAEAKDPIA!Sheets!1!Objects!PrxChart1!Corridors</id>
  </tCorridors>
<tArg xmlns="">
<meta>
  <s1>2</s1>
  <s2>3</s2>
  <gf>true</gf>
  <tp>50</tp>
  </meta>
  </tArg>
  </AddChartCorridor>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<AddChartCorridorResult 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">
  <k xmlns="">1</k>
  </AddChartCorridorResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"AddChartCorridor" :
{
"tCorridors" :
{
"id" : "EDKKJPHJEHILFOAEPIMEEFNEPLBBPMIENIOCOOKNODOIOCGE!M!S!PPDJOMGIJEHILFOAEKDIEBFPLEKLKDGJEDJIIBCHBAEAKDPIA!Sheets!1!Objects!PrxChart1!Corridors"
},
"tArg" :
{
"meta" :
{
"s1" : "2",
"s2" : "3",
"gf" : "true",
"tp" : "50"
}
}
}
}

JSON response:

{
"AddChartCorridorResult" :
{
"k" : "1"
}
}
public static ChartCorridorKey AddChartCorridor(string chartMoniker)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tAdd = new AddChartCorridor()
{
tCorridors = new ChartCorridorsId
{
id = chartMoniker + "!Corridors"
},
tArg = new SetChartCorridorArg()
{
meta = new ChartCorridor()
{
s1 = 2,
s2 = 3,
gf = true,
tp = 50
}
}
};
// Create a chart corridor
var result = somClient.AddChartCorridor(tAdd);
return result;
}

See also:

Chart