Returns the specified X value of a series in the chart object (for XY-Scatter and XY-Curves).

float object->GetSeriesXValue( int index, int valueindex )

Arguments

object

Required. A Chart object.

index

Required. An integer value that specifies the zero-based index of the series in the chart object.

valueindex

Required. An integer value that specifies the zero-based index of the X value in the series specified by index.

Return Value

A floating-point number containing the X value spedified by valueindex in the data series specified by index.

Remarks

If the index argument refers to a series that does not exist in the chart object, the GetSeriesXValue method raises an invalid series index error.

If the valueindex argument refers to a X value that does not exist in the specified series, the GetSeriesXValue method raises an out of bounds error.

• index must be superior or equal to 0.
• index must refer to an existing series.
• valueindex must be superior or equal to 0.
• valueindex must be strictly inferior to GetValuesCount.

Note: This method is available when manipulating XY data series required for displaying XY-Curves and XY-Scatter. Note that the Chart type (ie: bar, column, line, etc.) is defined in the Swiff Chart style file (.scs) which must be loaded via the LoadStyle method.

PHP Code Sample

The following PHP code illustrates use of the GetSeriesXValue method.

// Set the series
$chart->SetDataFromQuery();

// Retrieve the number of series stored in the chart object 
$n_series= $chart->GetSeriesCount();
$n_categories= $chart->GetValuesCount();

if( $n_series == 0 )
  print( "No series available" );
else
  {
  // Enumerate the series stored in the chart object 
  for( $i = 0; $i < $n_series; ++$i )
    {
    // Enumerate the XY points of the series 
    for( $j = 0; $j < $n_categories; ++$j )
      {
      $str= "Series[" . $i . "][" . $j . "]=";
      $str= $str . "(" . $chart->GetSeriesXValue($i, $j); 
      $str= $str . ",";
      $str= $str . $chart->GetSeriesYValue($i, $j) . ")<br>";
      print( $str );
      }
    }
  }

See Also

GetSeriesYValue Method | GetSeriesCount Method | SetSeriesXValuesFromString Method | SetSeriesXValuesFromArray Method

Applies To: Chart Object