DisplayChartCorridors

Syntax

bool DisplayChartCorridors(ChartCorridorsId tCorridors, ChartCorridorsDisplayInfo tArg)

Parameters

tCorridors. Moniker for working with chart corridors.

tArg. Settings for displaying corridors in chart legend.

Description

The DisplayChartCorridors operation changes settings for displaying corridors in chart legend.

Comments

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

Example

Below is the example of changing settings for displaying corridors in chart legend. The request contains moniker for working with corridors and indicator of whether corridors are displayed in chart legend. The response contains whether the setting is successfully changed.

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

SOAP response:

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

JSON request:

{
 "DisplayChartCorridors" : 
  {
   "tCorridors" : 
    {
     "id" : "EDKKJPHJEHILFOAEPIMEEFNEPLBBPMIENIOCOOKNODOIOCGE!M!S!PPDJOMGIJEHILFOAEKDIEBFPLEKLKDGJEDJIIBCHBAEAKDPIA!Sheets!1!Objects!PrxChart1!Corridors"
    },
   "tArg" : 
    {
     "dl" : "true"
    }
  }
}

JSON response:

{
 "DisplayChartCorridorsResult" : "1"
}
public static bool DisplayChartCorridors(string chartMoniker)
{
    var somClient = new SomPortTypeClient();    // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new DisplayChartCorridors()
    {
        tCorridors = new ChartCorridorsId
        {
            id = chartMoniker + "!Corridors"
        },
        tArg = new ChartCorridorsDisplayInfo()
        {
            dl = true
        }
    };
    // Set up displaying of corridors in legend
    var result = somClient.DisplayChartCorridors(tSet);
    return result;
}

See also:

Chart