GetChartLabels

Syntax

ChartLabels GetChartLabels(ChartId tChart)

Parameters

tChart. Chart moniker.

Description

The GetChartLabels operation gets settings of all data labels specified for chart series/points.

Comments

To execute the operation, in the tLabel field specify chart moniker. The chart moniker is based on the moniker of the repository object, which chart is worked with, according to the following rules:

The operation results in the data label settings determined for chart series/series points.

Example

Below is the example of getting settings of all data labels determined for chart series/series points. The request contains chart moniker. The response contains the obtained settings.

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">
<GetChartLabels xmlns="http://www.fsight.ru/PP.SOM.Som">
<tChart xmlns="">
  <id>S1!M!S!P1!Sheets!1!Objects!PrxChart3</id>
  </tChart>
  </GetChartLabels>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetChartLabelsResult 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">
<labels xmlns="">
<it>
  <v>1</v>
  <p>Left</p>
  <t>X: %XValue</t>
<f>
  <family>Tahoma</family>
<style>
  <it>Regular</it>
  </style>
<size>
  <width>-1</width>
  <height>8</height>
  <units>Pt</units>
  </size>
  </f>
  <fc>#918F8D</fc>
  </it>
<it>
  <v>1</v>
  <p>Left</p>
  <t>X: %XValue</t>
<f>
  <family>Tahoma</family>
<style>
  <it>Regular</it>
  </style>
<size>
  <width>-1</width>
  <height>8</height>
  <units>Pt</units>
  </size>
  </f>
  <fc>#918F8D</fc>
  </it>
<it>
  <v>1</v>
  <p>Left</p>
  <t>X: %XValue</t>
<f>
  <family>Tahoma</family>
<style>
  <it>Regular</it>
  </style>
<size>
  <width>-1</width>
  <height>8</height>
  <units>Pt</units>
  </size>
  </f>
  <fc>#918F8D</fc>
  </it>
<it>
  <v>1</v>
  <p>Left</p>
  <t>X: %XValue</t>
<f>
  <family>Tahoma</family>
<style>
  <it>Regular</it>
  </style>
<size>
  <width>-1</width>
  <height>8</height>
  <units>Pt</units>
  </size>
  </f>
  <fc>#918F8D</fc>
  </it>
<it>
  <v>1</v>
  <p>Left</p>
  <t>X: %XValue</t>
<f>
  <family>Tahoma</family>
<style>
  <it>Regular</it>
  </style>
<size>
  <width>-1</width>
  <height>8</height>
  <units>Pt</units>
  </size>
  </f>
  <fc>#918F8D</fc>
  </it>
  </labels>
  </GetChartLabelsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetChartLabels" : 
  {
   "tChart" : 
    {
     "id" : "S1!M!S!P1!Sheets!1!Objects!PrxChart3"
    }
  }
}

JSON response:

{
 "GetChartLabelsResult" : 
  {
   "labels" : 
    {
     "it" : 
      [
        {
         "v" : "1",
         "p" : "Left",
         "t" : "X: %XValue",
         "f" : 
          {
           "family" : "Tahoma",
           "style" : 
            {
             "it" : "Regular"
            },
           "size" : 
            {
             "width" : "-1",
             "height" : "8",
             "units" : "Pt"
            }
          },
         "fc" : "#918F8D"
        },
        {
         "v" : "1",
         "p" : "Left",
         "t" : "X: %XValue",
         "f" : 
          {
           "family" : "Tahoma",
           "style" : 
            {
             "it" : "Regular"
            },
           "size" : 
            {
             "width" : "-1",
             "height" : "8",
             "units" : "Pt"
            }
          },
         "fc" : "#918F8D"
        },
        {
         "v" : "1",
         "p" : "Left",
         "t" : "X: %XValue",
         "f" : 
          {
           "family" : "Tahoma",
           "style" : 
            {
             "it" : "Regular"
            },
           "size" : 
            {
             "width" : "-1",
             "height" : "8",
             "units" : "Pt"
            }
          },
         "fc" : "#918F8D"
        },
        {
         "v" : "1",
         "p" : "Left",
         "t" : "X: %XValue",
         "f" : 
          {
           "family" : "Tahoma",
           "style" : 
            {
             "it" : "Regular"
            },
           "size" : 
            {
             "width" : "-1",
             "height" : "8",
             "units" : "Pt"
            }
          },
         "fc" : "#918F8D"
        },
        {
         "v" : "1",
         "p" : "Left",
         "t" : "X: %XValue",
         "f" : 
          {
           "family" : "Tahoma",
           "style" : 
            {
             "it" : "Regular"
            },
           "size" : 
            {
             "width" : "-1",
             "height" : "8",
             "units" : "Pt"
            }
          },
         "fc" : "#918F8D"
        }
      ]
    }
  }
}
public static ChartLabels GetChartLabels(string chartMoniker)
{
    var somClient = new SomPortTypeClient();    // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetChartLabels()
    {
        tChart = new ChartId()
        {
            id = chartMoniker
        }
    };
    // Get data label settings
    var result = somClient.GetChartLabels(tGet);
    return result;
}

See also:

Chart