[Contents] [Back] [Prev] [Up] [Next] [Forward]

# Package Gtk.Extra.Plot

This package implements a high-level, general purpose plotting widget. You can display any set of data (set of points, curve defined by a parametric function, ...). This widget can automatically display them as a curve, along with labelled axis, axis tic marks, legends,...

This is the base class, that provides 2D graphics. Some children provide polar-coordinates and 3D graphics in addition.

It fully supports the drag-and-drop protocol for all of its children, which means that the user can interactively move them in the Gtk_Plot area.

A Gtk_Plot is closely associated with a Gdk_Drawable, on which all the drawings are done. It can be done anywhere within that drawable, its "position" is indicated by a tuple (X, Y), which are two values between 0.0 and 1.0 (from left to right, or from top to bottom). Its size is also given as a ratio other the drawable's size.

Most points in the plot have also this relative coordinates systems, which makes it really easy to handle resizing of a plot window.

See the package Gtk.Extra.Plot_Ps for a way to easily print a Gtk_Plot to a postscript file.

- Gtk.Extra.Plot Widget Hierarchy
- Gtk.Extra.Plot Signals
- Gtk.Extra.Plot Types
- Gtk.Extra.Plot Subprograms

## Widget Hierarchy

    Gtk_Object                    (see section Package Gtk.Object)
       \___ Gtk_Widget            (see section Package Gtk.Widget)
          \___ Gtk_Plot           (see section Package Gtk.Extra.Plot)

## Signals

- "changed" procedure Handler (Plot : access Gtk_Plot_Record'Class);
  Called every time some property of the widget is changed, or the widget is moved or resized.
- "moved" function Handler (Plot : access Gtk_Plot_Record'Class;
  X : Gdouble;
  Y : Gdouble)
  return Boolean;
  Called when the widget has been moved relative to its drawable. Its new position is given in parameters.
- "resized" function Handler (Plot : access Gtk_Plot_Record'Class;
  Width : Gdouble;
  Height : Gdouble)
  return Boolean;
  Called when the widget has been resized relative to its drawable. Its new size is given in parameters.
- "tick_label" function Handler (Axis : access Gtk_Plot_Axis_Record'Class;
  Tick : Gdouble_Access;
  Label : Interfaces.C.Strings.chars_ptr)
  return Boolean;
  Called when a label should be drawn. You can modify the contents of Label (up to 100 characters) a

## Types

    type Gtk_Plot_Line is new Gdk.C_Proxy;

| A simple line drawn on the plot.

    type Gtk_Plot_Text is new Gdk.C_Proxy;

| A text that can be displayed anywhere on the plot.

    type Plot3D_Function is access function
        (Plot  : System.Address;

    type Plot_Angle is
        (Angle_0,
         Angle_90,
         Angle_180,
         Angle_270);

| Valid values for the angles of texts and titles.

    type Plot_Axis_Pos is
        (Axis_Left,
         Axis_Right,
         Axis_Top,
         Axis_Bottom);

| Where the axis should be put

    type Plot_Border_Style is
        (Border_None,
            -- No border is drawn

         Border_Line,
            -- A simple line on each side

         Border_Shadow
            -- The right and bottom lines are
            -- thicker
         );

| Border types used for legends.

    type Plot_Error is
        (Error_Div_Zero,
         Error_Log_Neg);

| Errors that can be encountered while calculating a graph.

    type Plot_Label_Pos is new Integer;

| Position of labels along an axis.

    type Plot_Label_Style is
        (Label_Float,
         Label_Exp,
         Label_Pow);

| The style of labels (floating point, or scientific notation)

    type Plot_Orientation is
        (Axis_X,
         Axis_Y,
         Axis_Z);

| How to reference axis in 3D plots

    type Plot_Scale is
        (Scale_Linear, Scale_Log10);

| Type of scale used for each axis of a graph.

    type Plot_Ticks_Pos is new Integer;

| The position and orientation of the ticks along an axis. See the constants below for the possible values. Note also that not all the values are valid with all types of axis.

## Subprograms

### Creating a plot

    procedure Gtk_New
      (Plot               : out    Gtk_Plot;
       Drawable           : in     Gdk.Drawable.Gdk_Drawable
                           := Gdk.Drawable.Null_Drawable);

| Create a new plot, that will be displayed in Drawable. All the dataset, labels, axis,... associated with the plot will be drawn in that drawable, which must have been created beforehand. Note that the drawable can also be set later with Set_Drawable.

    procedure Gtk_New
      (Plot               : out    Gtk_Plot;
       Width              : in     Gdouble;
       Height             : in     Gdouble;
       Drawable           : in     Gdk.Drawable.Gdk_Drawable
                           := Gdk.Drawable.Null_Drawable);

| Create a new plot with a specific size.

    function Get_Type              return Gtk.Gtk_Type;

| Return the internal value associated with a Gtk_Plot.

    procedure Set_Drawable
      (Plot               : access Gtk_Plot_Record;
       Drawable           : in     Gdk.Drawable.Gdk_Drawable);

| Modify the drawable on which the graphs are displayed. From now on, all the drawings will be done on that drawable. Note that they are not automatically copied to the new Drawable until the Plot needs to be redrawn.

    function Get_Drawable
      (Plot               : access Gtk_Plot_Record)
       return Gdk.Drawable.Gdk_Drawable;

| Return the drawable on which the graphs are plotted.

    procedure Set_Background
      (Plot               : access Gtk_Plot_Record;
       Background         : in     Gdk.Color.Gdk_Color);

| Change the background for the plot. Note that this has no effect if the plot has been set to transparent (see the flags below). The Plot is also redrawn as soon as you modify this color.

    procedure Paint
      (Plot               : access Gtk_Plot_Record);

| Force an immediate repaint of the widget in its pixmap. The modification won't appear on the screen until you call Refresh. It is probably not a good idea to call this function directly, and it is more efficient to queue a draw request (see the Gtk.Widget package for related functions).

    procedure Refresh
      (Plot               : access Gtk_Plot_Record;
       Area               : in     Gdk.Rectangle.Gdk_Rectangle);

| Copy the plot's pixmap to the screen. The same comment as for Paint applies here, and you probably don't have to call this function yourself, since queuing a draw request is more efficient.

    procedure Set_Magnification
      (Plot               : access Gtk_Plot_Record;
       Magnification      :        Gdouble);

| Change the magnification level of the plot. 1.0 is the default magnification, higher values will zoom in while lower values will zoom out.

    procedure Draw_Line
      (Plot               : access Gtk_Plot_Record;
       Line               :        Gtk_Plot_Line;
       X1, Y1, X2, Y2     :        Gdouble);

| Draw a line on the plot

### Coordinates and sizes

    procedure Get_Position
      (Plot               : access Gtk_Plot_Record;
       X                  : out    Gdouble;
       Y                  : out    Gdouble);

| Return the position of the Plot within its drawable. X and Y are in the range 0.0 .. 1.0, where (0.0, 0.0) is the top-left corner and (1.0, 1.0) the bottom-right corner. The position can be modified by Move below.

    procedure Get_Size
      (Plot               : access Gtk_Plot_Record;
       Width              : out    Gdouble;
       Height             : out    Gdouble);

| Return the size of the Plot. Width and Height are both in the range 0.0 .. 1.0, where 1.0 means they occupy all the space available in the Drawable, 0.5 means they only occupy half of it.

    function Get_Internal_Allocation
      (Plot               : access Gtk_Plot_Record)
       return Gtk.Widget.Gtk_Allocation;

| Return the real position/size of the plot inside its parent container. You should use this function instead of converting yourself the result of Get_Position and Get_Size.

    procedure Move
      (Plot               : access Gtk_Plot_Record;
       X                  : in     Gdouble;
       Y                  : in     Gdouble);

| Move the plot widget inside its drawable. X and Y should both be in the range 0.0 .. 1.0 (from top-left corner to bottom-right corner).

    procedure Resize
      (Plot               : access Gtk_Plot_Record;
       Width              : in     Gdouble;
       Height             : in     Gdouble);

| Resize the widget. Width and Height should both be in the range 0.0 .. 1.0, this indicates which ratio of the drawable's screen real-estate they should use.

    procedure Move_Resize
      (Plot               : access Gtk_Plot_Record;
       X                  : in     Gdouble;
       Y                  : in     Gdouble;
       Width              : in     Gdouble;
       Height             : in     Gdouble);

| Move and resize the widget in a single operation. This is faster than doing each operation separately.

    procedure Get_Pixel
      (Plot               : access Gtk_Plot_Record;
       Xx                 : in     Gdouble;
       Yy                 : in     Gdouble;
       X                  : out    Gdouble;
       Y                  : out    Gdouble);

| Get the screen coordinate (relative to Plot's parent) of a point. The initial coordinates (Xx, Yy) should be in the range 0.0 .. 1.0.

    procedure Clip_Data
      (Plot               : access Gtk_Plot_Record;
       Clip               :        Boolean);

| If Clip is True, any drawing of a Gtk_Plot_Data will be limited to the area occupied by Plot. Otherwise, it might draw outside of Plot.

    procedure Get_Point
      (Plot               : access Gtk_Plot_Record;
       X                  : in     Gint;
       Y                  : in     Gint;
       Xx                 : out    Gdouble;
       Yy                 : out    Gdouble);

| Convert from an absolute screen coordinate to a relative one. (X, Y) should be relative to Plot's parent. This function is the opposite of Get_Pixel.

    procedure Set_Xrange
      (Plot               : access Gtk_Plot_Record;
       Xmin               : in     Gdouble := 0.0;
       Xmax               : in     Gdouble := 1.0);

| Set the range of visible points for this plot. Only the points of the graph those coordinates are in the range Xmin .. Xmax will be visible.

    procedure Set_Yrange
      (Plot               : access Gtk_Plot_Record;
       Ymin               : in     Gdouble := 0.0;
       Ymax               : in     Gdouble := 1.0);

| Set the range of visible points for this plot. Only the points of the graph those coordinates are in the range Xmin .. Xmax will be visible.

    procedure Set_Range
      (Plot               : access Gtk_Plot_Record;
       Xmin               : in     Gdouble := 0.0;
       Xmax               : in     Gdouble := 1.0;
       Ymin               : in     Gdouble := 0.0;
       Ymax               : in     Gdouble := 1.0);

| Set both ranges at the same time

    procedure Autoscale
      (Plot               : access Gtk_Plot_Record);

| Calculate automically the appropriate ranges for the plot.

    procedure Get_Xrange
      (Plot               : access Gtk_Plot_Record;
       Xmin               : out    Gdouble;
       Xmax               : out    Gdouble);

| Get the current range for the X axis.

    procedure Get_Yrange
      (Plot               : access Gtk_Plot_Record;
       Ymin               : out    Gdouble;
       Ymax               : out    Gdouble);

| Get the current range for the X axis.

    procedure Set_Xscale
      (Plot               : access Gtk_Plot_Record;
       Scale_Type         : in     Plot_Scale);

| Set the type of the X axis (logarithmic, linear, ...).

    procedure Set_Yscale
      (Plot               : access Gtk_Plot_Record;
       Scale_Type         : in     Plot_Scale);

| Set the type of the Y axis (logarithmic, linear, ...).

    function Get_Xscale
      (Plot               : access Gtk_Plot_Record)
       return Plot_Scale;

| Get the type of the X axis.

    function Get_Yscale
      (Plot               : access Gtk_Plot_Record)
       return Plot_Scale;

| Get the type of the Y axis.

### Axis

A Gtk_Plot has four axis, one one each of its sides. These axis can have ticks, labels for ticks, titles, ... associated with them.

    procedure Gtk_New
      (Axis               : out    Gtk_Plot_Axis;
       Orientation        :        Plot_Orientation);

| Create a new axis

    function Axis_Get_Type         return Gtk_Type;

| Return the internal value associated with a Gtk_Plot_Axis.

    function Get_Axis
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos)
       return Gtk_Plot_Axis;

| Get a pointer to an axis.

    procedure Axis_Set_Visible
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Visible            : in     Boolean);

| Indicate whether the axis should be visible or not.

    function Axis_Visible
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos)
       return Boolean;

| Return the visibility state of the axis

    procedure Axis_Set_Title
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Title              : in     String);

| Modify the title of the axis. Each axis has a title that is displayed along its line (vertically for the left and right sides).

    procedure Axis_Show_Title
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos);

| Show the title associated with the axis.

    procedure Axis_Hide_Title
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos);

| Hide the title associated with the axis.

    procedure Axis_Move_Title
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Angle              : in     Plot_Angle;
       X                  : in     Gdouble;
       Y                  : in     Gdouble);

| Modify the position and orientation of the axis' title. X and Y indicate a position relative to the location of the axis (0.0 to display it to the left (resp. top) of the axis, 1.0 to display it to the right (resp. bottom) of the axis.

    procedure Axis_Justify_Title
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Justification      : in     Gtk.Enums.Gtk_Justification);

| Modify the justification for the axis.

    procedure Axis_Set_Attributes
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Line_Width         : in     Gfloat;
       Color              : in     Gdk.Color.Gdk_Color);

| Modify the attributes of the lines of the axis.

    procedure Axis_Get_Attributes
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Line_Width         : out    Gfloat;
       Color              : out    Gdk.Color.Gdk_Color);

| Get the attributes of the axis.

    procedure Axis_Set_Ticks
      (Plot               : access Gtk_Plot_Record;
       Orientation        : in     Plot_Orientation;
       Major_Step         : in     Gdouble;
       Num_Minor          : in     Gint);

Set up ticks for a specific orientation.
A horizontal orientation will match the left and right sides, whereas a vertical orientation will match the top and bottom sides. Major_Step is a percentage value of the widget size, and indicate the step between each big ticks. For instance, if Major_Step has a value of 0.2, there will be 5 big ticks drawn along the axis. Num_Minor is the number of minor ticks between each major one.

    procedure Axis_Set_Major_Ticks
      (Plot               : access Gtk_Plot_Record;
       Orientation        : in     Plot_Orientation;
       Major_Step         : in     Gdouble);

| Modify the step for major ticks. This is a percentage value that indicates how many major ticks are drawn along the axis. See also Axis_Set_Ticks.

    procedure Axis_Set_Minor_Ticks
      (Plot               : access Gtk_Plot_Record;
       Orientation        : in     Plot_Orientation;
       Num_Minor          : in     Gint);

| Modify the number of minor ticks between each major one. See also Axis_Set_Ticks.

    procedure Axis_Set_Ticks_Length
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Length             : in     Gint);

| Set the length (in pixels) of the big ticks. The small ticks will have half this length.

    procedure Axis_Set_Ticks_Width
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Width              : in     Gfloat);

| Set the width (in pixels) of the ticks. This width is common to both the long and short ticks.

    procedure Axis_Show_Ticks
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Major_Mask         : in     Plot_Ticks_Pos;
       Minor_Mask         : in     Plot_Ticks_Pos);

| Set the style of the ticks.

    procedure Axis_Set_Ticks_Limits
      (Plot               : access Gtk_Plot_Record;
       Orientation        : in     Gtk.Enums.Gtk_Orientation;
       Ticks_Beg          : in     Gdouble;
       Ticks_End          : in     Gdouble);

| Indicate the area of the axis that should have ticks. Ticks will be displayed only from Ticks_Beg to Ticks_End.

    procedure Axis_Unset_Ticks_Limits
      (Plot               : access Gtk_Plot_Record;
       Orientation        : in     Plot_Orientation);

| Cancel the ticks limits set by a previous call to Axis_Set_Ticks_Limits.

    procedure Axis_Show_Labels
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Labels_Mask        : in     Plot_Label_Pos);

| Indicate whether a label should be drawn at each ticks to indicate its value. Not all values of Labels_Mask are relevant for all axis. For instance, for a vertical axis, the relevant values are Label_Right and Label_Left.

    procedure Axis_Title_Set_Attributes
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Ps_Font            : in     String;
       Height             : in     Gint;
       Angle              : in     Plot_Angle;
       Foreground         : in     Gdk.Color.Gdk_Color;
       Background         : in     Gdk.Color.Gdk_Color;
       Transparent        : in     Boolean;
       Justification      : in     Gtk.Enums.Gtk_Justification);

| Set the attributes to be used for the title of the axis. Ps_Font should be a postscript font (see Gtk.Plot.PsFont).

    procedure Axis_Set_Labels_Attributes
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Ps_Font            : in     String;
       Height             : in     Gint;
       Angle              : in     Plot_Angle;
       Foreground         : in     Gdk.Color.Gdk_Color;
       Background         : in     Gdk.Color.Gdk_Color;
       Transparent        : in     Boolean;
       Justification      : in     Gtk.Enums.Gtk_Justification);

| Set the attributes to be used for the ticks labels. Ps_Font should be a postscript font (see Gtk.Plot.PsFont).

    procedure Axis_Set_Labels_Numbers
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Style              : in     Plot_Label_Style;
       Precision          : in     Gint);

| Set the style of labels. This indicates whether the labels should be displayed as floating point values or in the scientific notation. Precision is the number of digits to be printed.

    procedure Axis_Use_Custom_Tick_Labels
      (Plot               : access Gtk_Plot_Record;
       Axis               : in     Plot_Axis_Pos;
       Custom             : in     Boolean := True);

| Indicate which kind of labels should be used for major ticks. If Custom is True, then the labels set by Axis_Set_Tick_Labels will be used.

    procedure Axis_Set_Labels_Suffix
      (Plot               : access Gtk_Plot_Record;
       Axis               :        Plot_Axis_Pos;
       Text               :        String);

| Defines a suffix to add after each label on the axis

    procedure Axis_Set_Labels_Prefix
      (Plot               : access Gtk_Plot_Record;
       Axis               :        Plot_Axis_Pos;
       Text               :        String);

| Defines a suffix to add before each label on the axis

    function Axis_Get_Labels_Suffix
      (Plot               : access Gtk_Plot_Record;
       Axis               :        Plot_Axis_Pos)
       return String;

| Return the suffix added to each label.

    function Axis_Get_Labels_Prefix
      (Plot               : access Gtk_Plot_Record;
       Axis               :        Plot_Axis_Pos)
       return String;

| Return the prefix added to each label.

### Grids

A grid can be displayed in the graph. This makes it easier to understand a graphics in some situations. The grid has two simultaneous line styles, each with its own specific step (minor and major steps). There are two special lines in the grid, that you can display even if you don't display the rest of the line. These are the origin of the coordinates system, ie the lines at X=0 and Y=0.

    procedure X0_Set_Visible
      (Plot               : access Gtk_Plot_Record;
       Visible            : in     Boolean);

| Indicate whether the line at X=0 should be displayed.

    function X0_Visible
      (Plot               : access Gtk_Plot_Record)
       return Boolean;

| Return the visibility state of the line at X=0

    procedure Y0_Set_Visible
      (Plot               : access Gtk_Plot_Record;
       Visible            : in     Boolean);

| Indicate whether the line at Y=0 should be displayed.

    function Y0_Visible
      (Plot               : access Gtk_Plot_Record)
       return Boolean;

| Return the visibility state of the line at Y=0

    procedure X0line_Set_Attributes
      (Plot               : access Gtk_Plot_Record;
       Style              : in     Plot_Line_Style;
       Width              : in     Gfloat;
       Color              : in     Gdk.Color.Gdk_Color);

| Set the attributes of the line at X=0

    procedure Y0line_Set_Attributes
      (Plot               : access Gtk_Plot_Record;
       Style              : in     Plot_Line_Style;
       Width              : in     Gfloat;
       Color              : in     Gdk.Color.Gdk_Color);

| Set the attributes of the line at Y=0

    procedure Grids_Set_Visible
      (Plot               : access Gtk_Plot_Record;
       Vmajor             : in     Boolean;
       Vminor             : in     Boolean;
       Hmajor             : in     Boolean;
       Hminor             : in     Boolean);

| Indicate whether the lines of the grids should be displayed. You can decide separately whether the major and minor lines should be displayed.

    procedure Grids_Visible
      (Plot               : access Gtk_Plot_Record;
       Vmajor             : out    Boolean;
       Vminor             : out    Boolean;
       Hmajor             : out    Boolean;
       Hminor             : out    Boolean);

| Return the visibility state of the grid.

    procedure Major_Hgrid_Set_Attributes
      (Plot               : access Gtk_Plot_Record;
       Style              : in     Plot_Line_Style;
       Width              : in     Gfloat;
       Color              : in     Gdk.Color.Gdk_Color);

| Set the attributes for the major horizontal lines in the grid.

    procedure Major_Vgrid_Set_Attributes
      (Plot               : access Gtk_Plot_Record;
       Style              : in     Plot_Line_Style;
       Width              : in     Gfloat;
       Color              : in     Gdk.Color.Gdk_Color);

| Set the attributes for the major vertical lines in the grid.

    procedure Minor_Hgrid_Set_Attributes
      (Plot               : access Gtk_Plot_Record;
       Style              : in     Plot_Line_Style;
       Width              : in     Gfloat;
       Color              : in     Gdk.Color.Gdk_Color);

| Set the attributes for the minor horizontal lines in the grid.

    procedure Minor_Vgrid_Set_Attributes
      (Plot               : access Gtk_Plot_Record;
       Style              : in     Plot_Line_Style;
       Width              : in     Gfloat;
       Color              : in     Gdk.Color.Gdk_Color);

| Set the attributes for the minor vertical lines in the grid.

### Legends

Each graph is associated with one legend, that is supposed to indicate what the plot represents.

    procedure Show_Legends
      (Plot               : access Gtk_Plot_Record);

| Indicate that the legend should be displayed.

    procedure Hide_Legends
      (Plot               : access Gtk_Plot_Record);

| Indicate that the legend should not be displayed.

    procedure Set_Legends_Border
      (Plot               : access Gtk_Plot_Record;
       Border             :        Plot_Border_Style;
       Shadow_Width       :        Gint);

| Modify the way the borders of the legend look like.

    procedure Legends_Move
      (Plot               : access Gtk_Plot_Record;
       X                  : in     Gdouble;
       Y                  : in     Gdouble);

| Move the legend relative to the widget's area. X and Y are percentage values. (0.0, 0.0) indicates the top-left corner of the plot, (1.0, 1.0) indicates the bottom-right corner.

    procedure Legends_Get_Position
      (Plot               : access Gtk_Plot_Record;
       X                  : out    Gdouble;
       Y                  : out    Gdouble);

| Return the current position of the legend.

    function Legends_Get_Allocation
      (Plot               : access Gtk_Plot_Record)
       return Gtk.Widget.Gtk_Allocation;

| Return the exact coordinates and size in pixels of the legend. The coordinates are relative to the widget's parent container.

    procedure Legends_Set_Attributes
      (Plot               : access Gtk_Plot_Record;
       Ps_Font            : in     String;
       Height             : in     Gint;
       Foreground         : in     Gdk.Color.Gdk_Color;
       Background         : in     Gdk.Color.Gdk_Color);

| Set the attributes to use when displaying the legend. Ps_Font is the name of a postscript font (see Gtk.Plot.PsFont)

### Line

    procedure Set_Line_Style
      (Line               :        Gtk_Plot_Line;
       Style              :        Plot_Line_Style);

| Change the style of the line.

    procedure Set_Line_Width
      (Line               :        Gtk_Plot_Line;
       Width              :        Gfloat);

| Change the width of the line.

    procedure Set_Color
      (Line               :        Gtk_Plot_Line;
       Color              :        Gdk.Color.Gdk_Color);

| Change the color used to draw the line

### Text

    procedure Put_Text
      (Plot               : access Gtk_Plot_Record;
       X                  : in     Gdouble;
       Y                  : in     Gdouble;
       Ps_Font            : in     String := "";
       Font_Height        : in     Gint := 10;
       Angle              : in     Plot_Angle;
       Foreground         : in     Gdk.Color.Gdk_Color
                           := Gdk.Color.Null_Color;
       Background         : in     Gdk.Color.Gdk_Color
                           := Gdk.Color.Null_Color;
       Transparent        : in     Boolean := False;
       Justification      : in     Gtk.Enums.Gtk_Justification
                           := Gtk.Enums.Justify_Center;
       Text               : in     String := "");

Print some text in Plot.
The text will be drawn at the relative coordinates (X, Y), with a specified Angle. If Font is the empty string, a default font and default Font_Height will be used. Likewise, default colors will be used if you don't specify any. Font should be the name of a postscript font, the list of which can be found in Gtk.Plot.Psfont. If Transparent is True, then no background will be drawn for the text.

    procedure Remove_Text
      (Plot               : access Gtk_Plot_Record;
       Text               : in     Gtk_Plot_Text);

| Remove some text that is currently visible on the plot. Nothing is done if Text is currently not visible.

    procedure Text_Get_Area
      (Text               : in     Gtk_Plot_Text;
       Angle              : in     Gint;
       Just               : in     Gtk.Enums.Gtk_Justification;
       Font_Name          : in     String;
       Font_Size          : in     Gint;
       X                  : out    Gint;
       Y                  : out    Gint;
       Width              : out    Gint;
       Height             : out    Gint);

| Return the area currently occupied by a text. The coordinates are relative to the top-left corner of the plot in which the text was put.

    procedure Text_Get_Size
      (Text               : in     Gtk_Plot_Text;
       Angle              : in     Gint;
       Font_Name          : in     String;
       Font_Size          : in     Gint;
       Width              : out    Gint;
       Height             : out    Gint;
       Ascent             : out    Gint;
       Descent            : out    Gint);

| Return the size in pixels occupied by a text in the plot. see section Package Gtk.Extra.Plot`_`Canvas for a function that returns a Gtk_Plot_Text.

    function Get_Texts
      (Plot               : access Gtk_Plot_Record)
       return Texts_List.Glist;

| Return the list of all the texts associated with the plot

    procedure Get_Text_Position
      (Text               : in     Gtk_Plot_Text;
       X                  : out    Gdouble;
       Y                  : out    Gdouble);

| Return the location of the Text.

    function Get_Text_String
      (Text               : in     Gtk_Plot_Text)
       return String;

| Return the string of the text.

    procedure Text_Set_Attributes
      (Text               : in     Gtk_Plot_Text;
       Font               : in     String;
       Height             : in     Gint;
       Angle              : in     Plot_Angle;
       Fg                 : in     Gdk.Color.Gdk_Color;
       Bg                 : in     Gdk.Color.Gdk_Color;
       Transparent        : in     Boolean := False;
       Justification      : in     Gtk.Enums.Gtk_Justification
                           := Gtk.Enums.Justify_Center;
       Str                : in     String := "");

| Change the attributes of Text.

    procedure Draw_Text
      (Plot               : access Gtk_Plot_Record;
       Text               :        Gtk_Plot_Text);

| Draw the text

### Datasets

A dataset is a set of points, either given explicitly by your
application or calculated with a specific function, and that can be plotted on the screen. In Gtk_Plot, such a set is represented with symbols (special points in the graph, that can be manipulated interactively if you so wish), linked by connectors, which are either straight lines, splines, sets, ... Multiple data sets can of course be printed on a single graph.

    procedure Add_Data
      (Plot               : access Gtk_Plot_Record;
       Data               : access Gtk_Plot_Data_Record'Class);

| Add an existing set of data to the plot. This set will automatically be drawn the next time the Plot itself is drawn.

    function Remove_Data
      (Plot               : access Gtk_Plot_Record;
       Data               : access Gtk_Plot_Data_Record'Class)
       return Boolean;

| Remove the dataset from Plot. This function returns True if the dataset was indeed found and could be removed, False otherwise.

    function Add_Function
      (Plot               : access Gtk_Plot_Record;
       Func               : in     Plot_Function)
       return Gtk_Plot_Data;

| Allocate a new dataset, whose point are automatically calculated. Func is a function that takes the X coordinate value, and should return the Y coordinate value. The newly allocated set should be freed by calling Free above. The set is automatically added to the plot, so you don't need to explicitly call Add_Dataset.

### Flags

Some flags are defined for this widget. You can not access them through
the usual interface in Gtk.Object.Flag_Is_Set since this widget is not part of the standard gtk+ packages. Instead, use the functions below.

- "transparent" If this flag is set, the widget's background is not filled, and thus the widget's parent's background is seen through it.

    function Plot_Flag_Is_Set
      (Plot               : access Gtk_Plot_Record;
       Flag               :        Guint8)
       return Boolean;

| Test whether one of the flags for a Gtk_Plot widget or its children is set. This can only be used for the flags defined in the Gtk.Extra.Gtk_Plot package.

    procedure Plot_Set_Flags
      (Plot               : access Gtk_Plot_Record;
       Flags              :        Guint8);

| Set the flags for a Gtk_Plot widget or its children. Note that the flags currently set are not touched by this function. This can only be used for the flags defined in the Gtk.Extra.Gtk_Plot package.

    procedure Plot_Unset_Flags
      (Plot               : access Gtk_Plot_Record;
       Flags              :        Guint8);

| Unset the flags in the widget.

[Contents] [Back] [Prev] [Up] [Next] [Forward]