5.45. Example - Image Map from Pie Chart
Prev | Chapter 5. PHPlot Examples | Next

## 5.45. Example - Image Map from Pie Chart

This example produces an HTML page with an embedded image containing a pie chart, and an image map. The image map makes the pie sectors in the chart into hotlinks. In this example, tool-tip text identifies the segment number and its numeric value, and clicking on a pie segment displays the same text in an alert popup. These looks could be used instead to link to another web page, display data in a popup window, etc.

This example also shows getting access to the data values. The callback handler accesses the data array to get the current segment value and uses that in the tool-tip text and alert box. This is dependent on the data type of the array, and the code shown here only works with data type text-data-single.

Unlike the previous example with a bar chart, in this example the callback function needs to do some more significant calculations in order to produce the image map areas. This is because HTML image maps do not directly support any area shape which corresponds to a pie chart segment. Therefore the callback function approximates each pie chart segment with a polygon. This is explained in the code shown below.

See Section 4.10, “Image Maps for Plot Data” for more information on image maps. This capability was added in PHPlot-5.7.0. See EncodeImage for more on embedding plot images within an HTML page.

Example 5.45. Image Map from Pie Chart (Browser screenshot)

    <?php
    # PHPlot example: Pie chart, embedded image with image map
    require_once 'phplot.php';

    # This global string accumulates the image map AREA tags.
    $image_map = "";

    # Data for pie chart:
    $data = array(
      array('',  20),
      array('',  30),
      array('',  10),
      array('',  40),
      array('',  10),
    );

    /*
    Callback handler for generating an image map for a pie chart.

      NOTE: The code in this function is excluded from the license terms for
      PHPlot, the PHPlot Reference Manual, and the PHPlot Test Suite. You may
      freely copy, use, modify, and redistribute the code in this function.
      Attribution is not necessary.  Or, to put it another way, I am placing
      this function in the public domain.

    Arguments:
      $im, $passthru : standard arguments for all callbacks.
      $shape : always 'pie'
      $segment : 0 for the first pie segment, 1 for the next, etc.
      $xc, $yc : Center of the pie, in device coordinates
      $wd, $ht : Pie diameters - width (horizontal), height (vertical)
      $start_angle, $end_angle : Segment arc angles, in degrees, offset from
        360. That is, the values are (360-A) for angle A. This is the way
        PHPlot processes the angles for the GD function imagefilledarc().
        Note that sin(360-A) = -sin(A); and cos(360-A) = cos(A).
        Since the Y axis  (sin) is reversed in device, or image, coordinates
        with Y=0 at the top, this works out correctly.

    Method used:
        Approximate a pie segment using a polygon. Note the pie is not necessarily
    circular, but is an ellipse.
        +  The 1st point is the pie center.
        +  The 2nd point is on the circumference*, at the start angle.
        +  The last point is on the circumference*, at the end angle.
        +  In between the 2nd and last point are N>=0 additional points on the
    circumference*, spaced no more than 20 degrees apart. (20 is chosen by
    trial and error for a reasonable fit.) So small segments will be approximated
    by a single triangle. Larger segments will have more vertices.

        *Note: These points are actually slightly outside the circumference.
    This is done by increasing the two radius values by a small amount (2 pixels).
    This produces a better fit, for the case where we want to make sure all the
    interior is covered, even if some of the exterior is also included.  (Using
    the actual radii would result in the area omitting a small part of the pie
    interior. For an image map, this would result in dead spaces.)

        The segment subdivisions are made to have about equal angles. This results
    in a closer fit. For example, with a maximum sub-segment arc of 20 degrees,
    and a segment of 24 degrees, we make two 12 degree sub-segments rather than a
    20 degree and a 4 degree.

        Note: Web image map coordinates have 0,0 in upper left, so Y is reversed.

    The pass-through argument gets the data array. This is used to include the
    pie segment value in the URL and/or tooltip. This will only work with data
    type text-data-single, where array values map 1:1 to segment values.
    */
    function store_map($im, $data, $shape, $segment, $unused,
                       $xc, $yc, $wd, $ht, $start_angle, $end_angle)
    {
        global $image_map;

        # Choose the largest step_angle <= 20 degrees that divides the segment
        # into equal parts. (20 degrees is chosen as a threshold.)
        # Note start_angle > end_angle due to reversal (360-A) of arguments.
        $arc_angle = $start_angle - $end_angle;
        $n_steps = (int)ceil($arc_angle / 20);
        $step_angle = $arc_angle / $n_steps;

        # Radius along horizontal and vertical, plus a tiny adjustment factor.
        $rx = $wd / 2 + 2;
        $ry = $ht / 2 + 2;
        # Push the initial point into the array: the center of the pie.
        $points = array($xc, $yc);

        # Loop by step_angle from end_angle to start_angle.
        # Don't use "$theta += $step_angle" because of cumulative error.
        # Note $theta and $done_angle are in radians; $step_angle and $end_angle
        # are in degrees.
        $done_angle = deg2rad($start_angle);

        for ($i = 0; ; $i++) {
          # Advance to next step, but not past the end:
          $theta = min($done_angle, deg2rad($end_angle + $i * $step_angle));

          # Generate a point at the current angle:
          $points[] = (int)($xc + $rx * cos($theta));
          $points[] = (int)($yc + $ry * sin($theta));

          # All done after generating a point at done_angle.
          if ($theta >= $done_angle) break;
        }

        # Demonstration data: Title (and tool-tip text), alt text, URL:
        # Fetch segment value from data arrayL
        $value = $data[$segment][1];
        $title = "Segment $segment = $value";
        $alt = "Region for segment $segment";
        $href = "javascript:alert('Segment $segment = $value')";
        $coords = implode(',', $points);

        # Generate the image map area:
        $image_map .= "  <area shape=\"poly\" coords=\"$coords\""
                   .  " title=\"$title\" alt=\"$alt\" href=\"$href\">\n";
    }

    # Create and configure the PHPlot object.
    $plot = new PHPlot(640, 480);
    # Disable error images, since this script produces HTML:
    $plot->SetFailureImage(False);
    # Disable automatic output of the image by DrawGraph():
    $plot->SetPrintImage(False);
    # Set up the rest of the plot:
    $plot->SetTitle("PHPlot Example: Pie Chart with Image Map");
    $plot->SetImageBorderType('plain');
    $plot->SetDataValues($data);
    $plot->SetDataType('text-data-single');
    $plot->SetPlotType('pie');
    # Set the data_points callback which will generate the image map.
    # Include the data array as the pass-through argument, for tooltip text:
    $plot->SetCallback('data_points', 'store_map', $data);
    # Produce the graph; this also creates the image map via callback:
    $plot->DrawGraph();

    # Now output the HTML page, with image map and embedded image:
    ?><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
         "http://www.w3.org/TR/html4/loose.dtd">
    <html>
    <head>
    <title>PHPlot Example: Pie Chart with Image Map</title>
    </head>
    <body>
    <h1>PHPlot Example: Pie Chart with Image Map</h1>
    <map name="map1">
    <?php echo $image_map; ?>
    </map>
    <p>This is a plot with image map and tooltip text.</p>
    <img src="<?php echo $plot->EncodeImage();?>" alt="Plot Image" usemap="#map1">
    </body>
    </html>

Prev | Up | Next
5.44. Example - Image Map from Bar Chart | Home | 5.46. Example - Image Map and Non-embedded Plot Image