Changeset 16110 for lang/perl

Timestamp:

07/23/08 09:26:41 (5 years ago)

Author:

daisuke

Message:

docs

Files:

• lang/perl/Google-Chart/branches/moose/lib/Google/Chart.pm (modified) (3 diffs)

lang/perl/Google-Chart/branches/moose/lib/Google/Chart.pm

@@ -36 +36 @@
     required => 1,
     lazy     => 1,
-    default  => sub { Google::Chart::Size->new( width => 200, height => 300 ) },
+    default  => sub { Google::Chart::Size->new( width => 400, height => 300 ) },
 );
 
@@ -77 +77 @@
     }
 
-    my $uri = BASE_URI->clone;
+    # If in case you want to change this for debugging or whatever...
+    my $uri = $ENV{GOOGLE_CHART_URI} ? 
+        URI->new($ENV{GOOGLE_CHART_URI}) :
+        BASE_URI->clone;
     $uri->query_form( %query );
     return $uri;
@@ -118 +121 @@
   );
   print $chart->as_uri, "\n";
-  print $chart->render_to_file( 'filename.jpg' );
+  print $chart->render_to_file( filename => 'filename.png' );
+
+=head1 METHODS
+
+=head2 new(%args)
+
+=over 4
+
+=item type
+
+Specifies the chart type, such as line, bar, pie, etc. If given a string like
+'Bar', it will instantiate an instance of Google::Chart::Type::Bar by
+invoking argument-less constructor.
+
+If you want to pass parameters to the constructor, either pass in an
+already instanstiated object, or pass in a hash, which will be coerced to
+the appropriate object
+
+  my $chart = Google::Chart->new(
+    type => {
+      module => "Bar",
+      args   => {
+        orientation => "horizontal"
+      }
+    }
+  );
+
+=item size
+
+Specifies the chart size. Strings like "400x300", hash references, or already
+instantiated objects can be used:
+
+  my $chart = Google::Chart->new(
+    size => "400x300",
+  );
+
+  my $chart = Google::Chart->new(
+    size => {
+      width => 400,
+      height => 300
+    }
+  );
+
+=back
+
+=head2 as_uri()
+
+Returns the URI that represents the chart object.
+
+=head2 render()
+
+Generates the chart image, and returns the contents.
+
+=head2 render_to_file( %args )
+
+Generates the chart, and writes the contents out to the file specified by
+`filename' parameter
 
 =cut