RemoveChartCorridor

Syntax

bool RemoveChartCorridor(ChartCorridorsId tCorridors, ChartCorridorRemoveInfo tArg)

Parameters

tCorridors. Moniker for working with chart corridors.

tArg. Operation execution parameters.

Description

The RemoveChartCorridor operation removes chart corridor.

Comments

To execute the operation, in the tCorridors field specify moniker for working with chart corridors, and in the tArg field specify corridor removal parameters. 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 logical True if corridor is removed successfully.

Example

Below is the example of chart corridor removal. The request contains moniker for working with corridors and index of removed corridor. The response contains whether the corridor is successfully removed.

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

SOAP response:

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

JSON request:

{
 "RemoveChartCorridor" : 
  {
   "tCorridors" : 
    {
     "id" : "EDKKJPHJEHILFOAEPIMEEFNEPLBBPMIENIOCOOKNODOIOCGE!M!S!PPDJOMGIJEHILFOAEKDIEBFPLEKLKDGJEDJIIBCHBAEAKDPIA!Sheets!1!Objects!PrxChart1!Corridors"
    },
   "tArg" : 
    {
     "index" : "1"
    }
  }
}

JSON response:

{
 "RemoveChartCorridorResult" : "1"
}
public static bool RemoveChartCorridor(string chartMoniker, uint corridorIndex)
{
    var somClient = new SomPortTypeClient();    // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new RemoveChartCorridor()
    {
        tCorridors = new ChartCorridorsId
        {
            id = chartMoniker + "!Corridors"
        },
        tArg = new ChartCorridorRemoveInfo()
        {
            index = corridorIndex
        }
    };
    // Remove chart corridor
    var result = somClient.RemoveChartCorridor(tSet);
    return result;
}

See also:

Chart