SetChartAxisY

Syntax

bool SetChartAxisY(AxisId tAxis, ChartAxisY tArg)

Parameters

tAxis. Chart axis moniker.

tArg. Settings that should be applied for Y axis.

Description

The SetChartAxisY operation changes chart's Y axis settings.

Comments

To execute the operation, in the tAxis field specify Y axis moniker, and in the tArg field specify 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!AxisY.

The operation results in the logical true if the settings were applied successfully.

Example

Below is the example of changing chart's Y axis settings. The request contains axis moniker and settings to be applied. The response contains whether the settings are 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">
<SetChartAxisY xmlns="http://www.fsight.ru/PP.SOM.Som">
<tAxis xmlns="">
  <id>S1!M!S!P1!Sheets!1!Objects!PrxChart3!AxisY</id>
  </tAxis>
<tArg xmlns="">
  <ct>Progress percentage</ct>
  <max>100</max>
  <amax>false</amax>
  <min>0</min>
  <amin>false</amin>
  </tArg>
  </SetChartAxisY>
  </s:Body>
  </s:Envelope>

SOAP response:

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

JSON request:

{
 "SetChartAxisY" : 
  {
   "tAxis" : 
    {
     "id" : "S1!M!S!P1!Sheets!1!Objects!PrxChart3!AxisY"
    },
   "tArg" : 
    {
     "ct" : "Progress percentage",
     "max" : "100",
     "amax" : "false",
     "min" : "0",
     "amin" : "false"
    }
  }
}

JSON response:

{
 "SetChartAxisYResult" : "1"
}
public static bool ChangeAxisYSettings(string moniker)
{
    var somClient = new SomPortTypeClient();    // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new SetChartAxisY()
    {
        tAxis = new AxisId()
        {
            id = moniker + "!AxisY"
        },
        tArg = new ChartAxisY()
        {
            amax = false,
            max = 100,
            amin = false,
            min = 0,
            ct = "Progress percentage"
        }
    };
    // Change Y axis settings
    var result = somClient.SetChartAxisY(tSet);
    return result;
}

See also:

Chart