SetChartCorridor

Syntax

bool SetChartCorridor(ChartCorridorId tCorridor, SetChartCorridorArg tArg)

Parameters

tCorridor. Chart corridor moniker.

tArg. Operation execution parameters.

Description

The SetChartCorridor operation changes 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 logical True if the settings were changed successfully.

Example

Below is the example of changing chart corridor settings. The request contains corridor moniker and settings to be determined. The response contains whether changes were applied successfully.

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">
<SetChartCorridor xmlns="http://www.fsight.ru/PP.SOM.Som">
<tCorridor xmlns="">
  <id>EDKKJPHJEHILFOAEPIMEEFNEPLBBPMIENIOCOOKNODOIOCGE!M!S!PPDJOMGIJEHILFOAEKDIEBFPLEKLKDGJEDJIIBCHBAEAKDPIA!Sheets!1!Objects!PrxChart1!Corridors!1</id>
  </tCorridor>
<tArg xmlns="">
<meta>
  <s1>3</s1>
  <s2>4</s2>
  <gf>false</gf>
  <clr>#00FFFF</clr>
  <tp>75</tp>
  </meta>
  </tArg>
  </SetChartCorridor>
  </s:Body>
  </s:Envelope>

SOAP response:

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

JSON request:

{
 "SetChartCorridor" : 
  {
   "tCorridor" : 
    {
     "id" : "EDKKJPHJEHILFOAEPIMEEFNEPLBBPMIENIOCOOKNODOIOCGE!M!S!PPDJOMGIJEHILFOAEKDIEBFPLEKLKDGJEDJIIBCHBAEAKDPIA!Sheets!1!Objects!PrxChart1!Corridors!1"
    },
   "tArg" : 
    {
     "meta" : 
      {
       "s1" : "3",
       "s2" : "4",
       "gf" : "false",
       "clr" : "#00FFFF",
       "tp" : "75"
      }
    }
  }
}

JSON response:

{
 "SetChartCorridorResult" : "1"
}
public static bool SetChartCorridor(string chartMoniker, string corridorKey)
{
    var somClient = new SomPortTypeClient();    // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new SetChartCorridor()
    {
        tCorridor = new ChartCorridorId
        {
            id = chartMoniker + "!Corridors!" + corridorKey
        },
        tArg = new SetChartCorridorArg()
        {
            meta = new ChartCorridor()
            {
                s1 = 3,
                s2 = 4,
                gf = false,
                clr = "#00FFFF", //Cyan
                tp = 75
            }
        }
    };
    // Create a chart corridor
    var result = somClient.SetChartCorridor(tSet);
    return result;
}

See also:

Chart