Returns the specified Z value (bubble size) of a series in the chart object (for Bubble charts).

float object->GetSeriesZValue( 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 Z value in the series specified by index.

Return Value

A floating-point number containing the Z 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 GetSeriesZValue method raises an invalid series index error.

If the valueindex argument refers to a Z value that does not exist in the specified series, the GetSeriesZValue 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 Bubble data series required for displaying Bubble charts. Note that the Chart type (bubble, 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 GetSeriesZValue method.

// Set the series data
$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 .= "(" . $chart->GetSeriesXValue($i, $j);
      $str .= ",";
      $str .= $chart->GetSeriesYValue($i, $j);
      $str .= ",";
      $str .= $chart->GetSeriesZValue($i, $j) . ")<br>";
      print( $str );
      }
    }
  }

See Also

GetSeriesXValue Method | GetSeriesYValue Method | GetSeriesCount Method | SetSeriesZValuesFromString Method | SetSeriesZValuesFromArray Method

Applies To: Chart Object