Sage-ST ä

Graph2d

Documentation

Annotate CloseGraph DefineArea DrawAxis
DrawDataAreaBackground DrawGraphAreaBackground DrawGrid GetAxisStyle
GetBarGraphStyle GetDataArea GetDataValueStyle GetDataWindow
GetGraphArea GetGraphError GetGraphStyle GetGraphWindow
GetLabelStyle GetPieWedgePullOut GetPieWedgePullOutPercent GetSeriesStyle
GraphData OpenGraph SetAxisStyle SetBarGraphStyle
SetDataArea SetDataValueStyle SetGraphArea SetGraphStyle
SetLabelStyle SetPieWedgePullOut SetPieWedgePullOutPercent SetSeriesStyle




  procedure Annotate
             (graphHandle : in out GPGraph;
              XVal        : in     SGK.GTCoordinate;
              YVal        : in     SGK.GTCoordinate;
              theText     : in     string;
              style       : in     GRAnnotateStyle);

  --*
  --  Annotate - Place text in the given graphHandle.
  --
  --
  --  Draw 'theText' in the current graph at location 'x,y' in using
  --  the fill, line, and text style given by 'style'.
  --
  --  CALLING SEQUENCE -
  --
  --    Annotate (graphHandle, x, y, theText, style);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the graph.
  --
  --    XVal, y : SGK.GTCoordinate
  --      Location of text to be drawn - in graph coordinates.
  --
  --    theText : string
  --      The text to be drawn.
  --
  --    style : GRTextStyle
  --      The style the text is to be drawn with.
  --




  procedure CloseGraph
             (graphHandle : in out GPGraph);

  --*
  --  CloseGraph - Close the graph.
  --
  --
  --  Close the graph pointed to by graphHandle.
  --
  --  Any memory allocated is returned, graphHandle is undefined and
  --  the graph space is cleared.
  --
  --  CALLING SEQUENCE -
  --
  --    CloseGraph (graphHandle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the graph.
  --




  procedure DefineArea
             (area        : in out GRArea;
              lowerLeftX  : in     SGK.GTCoordinate;
              lowerLeftY  : in     SGK.GTCoordinate;
              upperRightX : in     SGK.GTCoordinate;
              upperRightY : in     SGK.GTCoordinate;
              minX        : in     SGK.GTCoordinate;
              minY        : in     SGK.GTCoordinate;
              maxX        : in     SGK.GTCoordinate;
              maxY        : in     SGK.GTCoordinate);

  --*
  --  DefineArea - Assigns values to 'area'.
  --
  --
  --  The eight fields of 'area' are assigned with the eight coordinates
  --  in the parameter list.
  --
  --  CALLING SEQUENCE -
  --
  --    DefineArea (area, lowerLeftX, lowerLeftY,
  --                upperRightX, upperRightY,
  --                minX, minY, maxX, maxY);
  --
  --  ENTRY -
  --
  --    lowerLeftX : SGK.GTCoordinate
  --      The values assigned to the structure 'area'
  --
  --    lowerLeftY : SGK.GTCoordinate
  --      The values assigned to the structure 'area'
  --
  --    upperRightX : SGK.GTCoordinate
  --      The values assigned to the structure 'area'
  --
  --    upperRightY : SGK.GTCoordinate
  --      The values assigned to the structure 'area'
  --
  --    minX : SGK.GTCoordinate
  --      The values assigned to the structure 'area'
  --
  --    minY : SGK.GTCoordinate
  --      The values assigned to the structure 'area'
  --
  --    maxX : SGK.GTCoordinate
  --      The values assigned to the structure 'area'
  --
  --    maxY : SGK.GTCoordinate
  --      The values assigned to the structure 'area'
  --
  --  EXIT -
  --
  --    area : GRArea
  --      The structure receiving the eight values
  --




  procedure DrawAxis
             (graphHandle        : in     GPGraph;
              axisLayout         : in     GEAxisLayout;
              axisOffset         : in     SGK.GTCoordinate;
              numberOfMajorTicks : in     ModSys.S_Integer;
              numberOfMinorTicks : in     ModSys.S_Integer;
              labelsArray        : in     string);

  --*
  --  DrawAxis - Draw an axis on the graph.
  --
  --
  --  Draw an axis on the data area of the graph.
  --
  --  The axis orientation is defined by 'axisLayout'.
  --
  --  'axisOffset' is the distance the axis is to be drawn from
  --  the data area edge.
  --
  --  The axis is drawn with 'numberOfMajorTicks' major tick marks and
  --  'numberOfMinorTicks' minor tick marks.  The array 'labelsArray'
  --  contains the labels for each major tick.  If 'labelsArray' is
  --  equal to the nul string then numerical labels will be drawn.
  --
  --  The format of numerical labels depends on 'labelFormat' defined
  --  in "SetAxisStyle".
  --
  --  Colors, line styles, tick placement and tick sizes are defined
  --  in the call "SetAxisStyle".
  --
  --  CALLING SEQUENCE -
  --
  --    DrawAxis (graphHandle, axisLayout, axisOffset,
  --              numberOfMajorTicks, numberOfMinorTicks, labelArray);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    axisLayout : GEAxisLayout
  --      Enumeration defining the orientation of the axis.
  --
  --    axisOffset : SGK.GTCoordinate
  --      The amount the axis will deviate from the origin.
  --
  --    numberOfMajorTicks : ModSys.S_Integer
  --      The number of major tick marks drawn on the axis.
  --
  --    numberOfMinorTicks : ModSys.S_Integer
  --      The number of minor tick marks drawn on the axis.
  --
  --    labelsArray : string
  --      Array of chars defining each label for every major tick
  --      mark.  The first character must be the delimiter.
  --




  procedure DrawDataAreaBackground
             (graphHandle     : in     GPGraph;
              backgroundStyle : in     SGK.GRFillStyle);

  --*
  --  DrawDataAreaBackground - Draw the background area of graph.
  --
  --
  --  Draw the region defining the graph data area in 'backgroundStyle'.
  --
  --  CALLING SEQUENCE -
  --
  --    DrawDataAreaBackground (graphHandle, backgroundStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    backgroundStyle : SGK.GRFillStyle
  --      background fill style.
  --




  procedure DrawGraphAreaBackground
             (graphHandle     : in     GPGraph;
              backgroundStyle : in     SGK.GRFillStyle);

  --*
  --  DrawGraphAreaBackground - Draw background area of graph.
  --
  --
  --  Draw the area defining the graph in 'backgroundStyle'.
  --
  --  CALLING SEQUENCE -
  --
  --    DrawGraphAreaBackground (graphHandle, backgroundStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    backgroundStyle : SGK.GRFillStyle
  --      background fill style.
  --




  procedure DrawGrid
             (graphHandle   : in     GPGraph;
              gridLayout    : in     GEGridLayout;
              numberOfLines : in     ModSys.S_Integer;
              lineStyle     : in     SGK.GRLineStyle);

  --*
  --  DrawGrid - Draw vertical, horizontal grid lines.
  --
  --
  --  Draw vertical or horizontal grid lines along the axis.
  --
  --  'gridLayout' may have one of the following attributes:
  --
  --    horzGridLines  - Draw horizontal lines along the vertical axis
  --    vertGridLines  - Draw vertical lines along the vertical axis
  --    bothGridLines  - Draw horizontal and vertical lines.
  --
  --  The grid will be drawn with 'numberOfLines' + 1 divisions with a
  --  line defined by 'lineStyle' drawn at each division.
  --
  --  CALLING SEQUENCE -
  --
  --    DrawGrid (graphHandle, gridLayout, numberOfLines, lineStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    gridLayout : GEGridLayout
  --      One of
  --        Graph2D.horzGridLines,
  --        Graph2D.vertGridLines,
  --        Graph2D.bothGridLines
  --
  --    numberOfLines : ModSys.S_Integer
  --      how many lines to draw on the grid.
  --
  --    lineStyle : SGK.GRLineStyle
  --      The line style to draw the grid with.
  --




  procedure GetAxisStyle
             (graphHandle : in     GPGraph;
              axisStyle   : in out GRAxisStyle);

  --*
  --  GetAxisStyle - Get the axis style defaults.
  --
  --
  --  Get the style attributes for the axes.
  --
  --  axis style consists of the following:
  --
  --    lineStyle      : SGK.GRLineStyle
  --    majorTickStyle : SGK.GRLineStyle
  --    minorTickStyle : SGK.GRLineStyle
  --    majorTickSize  : SGK.GTCoordinate
  --    minorTickSize  : SGK.GTCoordinate
  --    horzTickLayout : GEPlacement      -- Place tick inside on or outside
  --    vertTickLayout : GEPlacement      -- Place tick inside on or outside
  --
  --  CALLING SEQUENCE -
  --
  --    GetAxisStyle (graphHandle, axisStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    axisStyle : GRAxisStyle
  --      Structure defining the axis attributes.
  --




  procedure GetBarGraphStyle
             (graphHandle   : in     GPGraph;
              barGraphStyle : in out GRBarStyle);

  --*
  --  GetBarGraphStyle - Get the style attributes for bars.
  --
  --
  --  Get the style attributes defined for a bar graph.
  --
  --  The attributes consist of:
  --
  --    barOrientation     = Graph2D.horzBar or Graph2D.vertBar;
  --    barOverlap         = percentage of bar width;
  --    spacingBetweenBars = percentage of bar width;
  --
  --  CALLING SEQUENCE -
  --
  --    GetBarGraphStyle (graphHandle, barGraphStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    barGraphStyle : GRBarStyle
  --      The structure defining bar graph attributes.
  --




  procedure GetDataArea
             (graphHandle : in     GPGraph;
              dataArea    : in out GRArea);

  --*
  --  GetDataArea - Get the data area for the graph.
  --
  --
  --  Get the rectangle defined to contain the data region.
  --
  --  CALLING SEQUENCE -
  --
  --    GetDataArea (graphHandle, dataArea);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    dataArea : GRArea
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    lowerLeftX : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    lowerLeftY : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    upperRightX : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    upperRightY : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    minX : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --
  --    minY : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --
  --    maxX : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --
  --    maxY : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --




  procedure GetDataValueStyle
             (graphHandle    : in     GPGraph;
              dataValueStyle : in out GRDataValue);

  --*
  --  GetDataValueStyle - Get the style defined for data values.
  --
  --
  --  Get the style defined for data values.
  --
  --  If the graph is of type "Graph2D.barGraph" or "Graph2d.pieGraph"
  --  the raw data values may be displayed on the graph.
  --  'dataValueStyle' defines if and how these values are to be displayed.
  --
  --  'dataValueStyle' has the following attributes.
  --
  --      show            : BOOLEAN        -- Show the data values for pie and bars
  --      placement       : GEPlacement    -- Place values inside,outside or across
  --      backgroundStyle : SGK.GRFillStyle
  --      fillStyle       : SGK.GRFillStyle
  --      lineStyle       : SGK.GRLineStyle
  --      textStyle       : SGK.GRTextStyle
  --
  --  CALLING SEQUENCE -
  --
  --    GetDataValueStyle (graphHandle, dataValueStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    dataValueStyle : GRDataValue
  --      The structure defining the style for data value annotations.
  --




  procedure GetDataWindow
             (graphHandle : in     GPGraph;
              dataWindow  : in out SGK.GPWindow);

  --*
  --  GetDataWindow - Get the data area window handle for graph.
  --
  --
  --  Get the data area window handle for the data region
  --  defined for the graph.
  --
  --  CALLING SEQUENCE -
  --
  --    GetDataWindow (graphHandle, dataWindow);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    dataWindow : SGK.GPWindow
  --      Pointer to the data window.
  --




  procedure GetGraphArea
             (graphHandle : in     GPGraph;
              graphArea   : in out GRArea);

  --*
  --  GetGraphArea - Get the graph area for the graph.
  --
  --
  --  Get the rectangle defined for the graph area.
  --
  --  CALLING SEQUENCE -
  --
  --    GetGraphArea (graphHandle, graphArea);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    graphArea : GRArea
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    lowerLeftX : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    lowerLeftY : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    upperRightX : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    upperRightY : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    minX : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --
  --    minY : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --
  --    maxX : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --
  --    maxY : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --




  function GetGraphError
            (graphHandle : in     GPGraph) return ModSys.S_Natural;

  --*
  --  GetGraphError - Get the error status and reset.
  --
  --
  --  This procedure gets and returns the current error status of Graph2D.
  --  In addition it sets the Graph2D's error status to Graph2D.ERROROK.
  --
  --  CALLING SEQUENCE -
  --
  --    error := GetGraphError (graphHandle)
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    error : ModSys.S_Integer
  --      The current error status of Graph2D.
  --
  --    The Graph2D's error status is set to Graph2D.ERROROK.
  --




  procedure GetGraphStyle
             (graphHandle : in     GPGraph;
              GraphStyle  : in out GRGraphStyle);

  --*
  --  GetGraphStyle - Get the style attributes for the graph.
  --
  --
  --  Get the 'graphStyle' for the given graph handle.
  --
  --  'graphStyle' contains these attributes:
  --
  --    graphLayout          : GELayout        -- stacked,unstacked,stacked100%
  --    graphOptions         : GTOptions       -- At least one of GTOptions
  --    graphType            : GEGraph         -- areaGraph,barGraph, etc.
  --    marginSpacingPercent : SGK.GTCoordinate-- % of graph area is margin
  --
  --  CALLING SEQUENCE -
  --
  --    GetGraphStyle (graphHandle, graphStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    graphStyle : GRGraphStyle
  --      The structure defining the style attributes for the graph.
  --




  procedure GetGraphWindow
             (graphHandle : in     GPGraph;
              graphWindow : in out SGK.GPWindow);

  --*
  --  GetGraphWindow - Get the data area window handle for graph.
  --
  --
  --  Get the window handle for the graph region
  --
  --  CALLING SEQUENCE -
  --
  --    GetGraphWindow (graphHandle, graphWindow);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    graphWindow : SGK.GPWindow
  --      Pointer to the graph window.
  --




  procedure GetSeriesStyle
             (graphHandle : in     GPGraph;
              styleIndex  : in     GTSeriesStyleIndex;
              SeriesStyle : in out GRSeriesStyle);

  --*
  --  GetSeriesStyle - Get the fill, line and marker style for a series.
  --
  --
  --  Get the fill, line and marker style for a series within
  --  the series style list.
  --
  --  CALLING SEQUENCE -
  --
  --    GetSeriesStyle (styleIndex, seriesStyle);
  --
  --  ENTRY -
  --
  --    styleIndex : GTSeriesStyleIndex
  --      Index into the series style list.
  --
  --  EXIT -
  --
  --    seriesStyle : GRSeriesStyle
  --      Structure defining the fill, line and marker style.
  --




  procedure GetLabelStyle
             (graphHandle : in     GPGraph;
              labelStyle  : in out GRLabelStyle);

  --*
  --  GetLabelStyle - Get the style for labels.
  --
  --
  --  Get line style, fill style, text style, axis to label offset and
  --  format for labels.
  --
  --  The structure 'labelStyle' has the following format:
  --    axisLabelOffset : SGK.GTCoordinate
  --    labelFormat     : GELabelFormat    -- float, integer, or string label
  --    fillStyle       : SGK.GRFillStyle
  --    lineStyle       : SGK.GRLineStyle
  --    textStyle       : SGK.GRTextStyle
  --
  --  CALLING SEQUENCE -
  --
  --    GetLabelStyle (graphHandle, labelStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    labelStyle : GRLabelStyle
  --      Style attributes for labels.
  --




  procedure GetPieWedgePullOut
             (graphHandle : in     GPGraph;
              wedgeNumber : in     GTIndex;
              pulled      : in out boolean);

  --*
  --  GetPieWedgePullOut - Get the pull out status of a pie wedge.
  --
  --
  --  Get the pull out status of a pie wedge denoted by 'wedge number'.
  --
  --  'pulled' equal TRUE if the wedge is to be drawn pulled out from
  --  the rest of the pie graph.
  --
  --  Wedges are numbered from the top of the pie clockwise.
  --
  --  CALLING SEQUENCE -
  --
  --    GetPieWedgePullOut (graphHandle, wedgeNumber, pulled);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    wedgeNumber : GTIndex
  --      number indicating the wedge in question.
  --
  --  EXIT -
  --
  --    pulled : BOOLEAN
  --      TRUE = wedge is to be pulled.
  --      FALSE otherwise.
  --




  procedure GetPieWedgePullOutPercent
             (graphHandle    : in     GPGraph;
              pullOutPercent : in out SGK.GTCoordinate);

  --*
  --  GetPieWedgePullOutPercent - Get pie wedge pull out percent.
  --
  --
  --  Get the amount the pie wedge is to be pulled away from the center
  --  of the pie graph.
  --
  --  The amount is a percentage of the data window distance
  --
  --  CALLING SEQUENCE -
  --
  --    GetPieWedgePullOutPercent (graphHandle, pullOutPercent);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    pullOutPercent : SGK.GTCoordinate
  --      The percentage of the pie radius for the pull out.
  --




  procedure GraphData
             (graphHandle : in     GPGraph;
              Data        : in     GroupData.DPData);

  --*
  --  GraphData - Draw the data into the graph.
  --
  --
  --  Draw the data into the data area of the graph.
  --
  --  The graph structure determines the manner in which
  --  the graph is to be drawn.
  --
  --  'data' is a pointer to GroupData.DPData defining the data.
  --
  --  CALLING SEQUENCE -
  --
  --    GraphData (graph, data);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    data : GroupData.DPData
  --      Pointer to the data definitions.
  --




  procedure OpenGraph
             (graphHandle : in out GPGraph;
              graphArea   : in     GRArea;
              dataArea    : in     GRArea);

  --*
  --  OpenGraph - Open 'graph'.
  --
  --
  --  The 'graph' is opened by allocating any needed memory and
  --  initializing the graph structure to these defaults.
  --
  --     Axis Style
  --       lineStyle.lineColor        := 16;
  --       lineStyle.linePattern      := SGK.SOLIDLINE;
  --       lineStyle.lineWidth        := 0.0;
  --       horzTickLayout             := Graph2D.outsidePlacement;
  --       vertTickLayout             := Graph2D.outsidePlacement;
  --       majorTickSize              := 1.0;
  --       minorTickSize              := 1.0;
  --       majorTickStyle.lineColor   := 16;
  --       majorTickStyle.linePattern := SGK.SOLIDLINE;
  --       majorTickStyle.lineWidth   := 0.0;
  --
  --     Bar Style
  --       barOrientation             := Graph2D.vertBar;
  --       barOverlap                 := 0.2;
  --       spacingBetweenBars         := 0.1;
  --
  --     Data Value Style
  --       show                       := TRUE;
  --       placement                  := Graph2D.insidePlacement;
  --       backgroundStyle            := SGK.HOLLOWSTYLE;
  --       fillStyle                  := SGK.HOLLOWSTYLE;
  --       lineStyle.lineColor        := 16;
  --       lineStyle.linePattern      := SGK.SOLIDLINE;
  --       lineStyle.lineWidth        := 0.0;
  --       textStyle.horzSize         := 1.0;
  --       textStyle.vertSize         := 1.0;
  --       textStyle.charAngleDegrees := 0.0;
  --       textStyle.textAngleDegrees := 0.0;
  --       textStyle.font             := NIL;
  --       textStyle.horzJust         := SGK.centerJust;
  --       textStyle.vertJust         := SGK.centerJust;
  --       textStyle.horzSpacing      := 0.1;
  --       textStyle.vertSpacing      := 0.1;
  --
  --     Graph Style
  --       graphLayout                := Graph2D.unstacked;
  --       graphOptions               := Graph2D.MARKEROPTION +
  --                                     Graph2D.MARGINSOPTION +
  --                                     Graph2D.DROPLINEOPTION +
  --                                     Graph2D.JOINDATAOPTION;
  --       graphType                  := Graph2D.barGraph;
  --       marginSpacingPercent       := 0.071;
  --
  --     Label Style
  --       axisLabelOffset            := 0.5;
  --       labelFormat                := Graph2D.integerFormat;
  --       fillStyle                  := SGK.HOLLOWSTYLE;
  --       lineStyle.lineColor        := 16;
  --       lineStyle.linePattern      := SGK.SOLIDLINE;
  --       lineStyle.lineWidth        := 0.0;
  --       textStyle.horzSize         := 1.0;
  --       textStyle.vertSize         := 1.0;
  --       textStyle.charAngleDegrees := 0.0;
  --       textStyle.textAngleDegrees := 0.0;
  --       textStyle.font             := NIL;
  --       textStyle.horzJust         := SGK.centerJust;
  --       textStyle.vertJust         := SGK.centerJust;
  --       textStyle.horzSpacing      := 0.1;
  --       textStyle.vertSpacing      := 0.1;
  --
  --     piePulloutPercent            := 0.1;
  --
  --  CALLING SEQUENCE -
  --
  --    OpenGraph (graph);
  --
  --  ENTRY -
  --
  --    graph : GRGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    graphArea : GRArea
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    lowerLeftX : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    lowerLeftY : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    upperRightX : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    upperRightY : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    minX : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --
  --    minY : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --
  --    maxX : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --
  --    maxY : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --
  --    dataArea : GRArea
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    lowerLeftX : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    lowerLeftY : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    upperRightX : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    upperRightY : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    minX : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --
  --    minY : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --
  --    maxX : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --
  --    maxY : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --




  procedure SetAxisStyle
             (graphHandle : in     GPGraph;
              axisStyle   : in     GRAxisStyle);

  --*
  --  SetAxisStyle - Get the axis style defaults.
  --
  --
  --  Set the style attributes for the axes.
  --
  --  axis style consists of the following:
  --    lineStyle      : SGK.GRLineStyle;
  --    majorTickStyle : SGK.GRLineStyle;
  --    minorTickStyle : SGK.GRLineStyle;
  --    majorTickSize  : SGK.GTCoordinate;
  --    minorTickSize  : SGK.GTCoordinate;
  --    horzTickLayout : GEPlacement;      -- Place tick inside on or outside
  --    vertTickLayout : GEPlacement;      -- Place tick inside on or outside
  --
  --  CALLING SEQUENCE -
  --
  --    SetAxisStyle (graphHandle, axisStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    axisStyle : GRAxisStyle
  --      Structure defining the axis attributes.
  --




  procedure SetBarGraphStyle
             (graphHandle   : in     GPGraph;
              barGraphStyle : in     GRBarStyle);

  --*
  --  SetBarGraphStyle - Set the style attributes for bars.
  --
  --
  --  Set the style attributes for a bar graph.
  --
  --  The attributes consist of:
  --
  --    barOrientation     = Graph2D.horzBar or Graph2D.vertBar;
  --    barOverlap         = percentage of bar width;
  --    spacingBetweenBars = percentage of bar width;
  --
  --  CALLING SEQUENCE -
  --
  --    SetBarGraphStyle (graphHandle, barGraphStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    barGraphStyle : GRBarStyle
  --      The structure defining bar graph attributes.
  --




  procedure SetDataArea
             (graphHandle : in     GPGraph;
              dataArea    : in     GRArea);

  --*
  --  SetDataArea - Set the data area for the graph.
  --
  --
  --  Define the rectangle containing the data region.
  --
  --  CALLING SEQUENCE -
  --
  --    SetDataArea (graphHandle, dataArea);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    dataArea : GRArea
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    lowerLeftX : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    lowerLeftY : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    upperRightX : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    upperRightY : SGK.GTCoordinate
  --      Rectangle defining the location of the data area (in graph coordinates)
  --
  --    minX : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --
  --    minY : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --
  --    maxX : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --
  --    maxY : SGK.GTCoordinate
  --      Rectangle defining the max and min of the data.
  --




  procedure SetDataValueStyle
             (graphHandle    : in     GPGraph;
              dataValueStyle : in out GRDataValue);

  --*
  --  SetDataValueStyle - Set the style for data values.
  --
  --
  --  If the graph is of type "Graph2D.barGraph" or "Graph2d.pieGraph"
  --  the raw data values may be displayed on the graph.
  --  'dataValueStyle' defines if and how these values are to be displayed.
  --
  --  'dataValueStyle' has the following attributes.
  --
  --      show            : BOOLEAN;        -- Show the data values for pie and bars
  --      placement       : GEPlacement;    -- Place values inside,outside or across
  --      backgroundStyle : SGK.GRFillStyle
  --      fillStyle       : SGK.GRFillStyle;
  --      lineStyle       : SGK.GRLineStyle;
  --      textStyle       : SGK.GRTextStyle;
  --
  --  CALLING SEQUENCE -
  --
  --    SetDataValueStyle (graphHandle, dataValueStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    dataValueStyle : GRDataValue
  --      The structure defining the style for data value annotations.
  --




  procedure SetGraphArea
             (graphHandle : in     GPGraph;
              graphArea   : in     GRArea);

  --*
  --  SetGraphArea - Set the graph area for the graph.
  --
  --
  --  Define the rectangle for the graph area.
  --
  --  CALLING SEQUENCE -
  --
  --    SetGraphArea (graphHandle, graphArea);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    graphArea : GRArea
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    lowerLeftX : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    lowerLeftY : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    upperRightX : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    upperRightY : SGK.GTCoordinate
  --      Rectangle defining the location of the graph (in base coordinates)
  --
  --    minX : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --
  --    minY : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --
  --    maxX : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --
  --    maxY : SGK.GTCoordinate
  --      Rectangle defining the coordinate system of the graph.
  --




  procedure SetGraphStyle
             (graphHandle : in     GPGraph;
              GraphStyle  : in     GRGraphStyle);

  --*
  --  SetGraphStyle - Set the style attributes for the graph.
  --
  --
  --  Set the 'graphStyle' for the given graph handle.
  --
  --  'graphStyle' contains these attributes:
  --
  --    graphLayout          : GELayout;        -- stacked,unstacked,stacked100%
  --    graphOptions         : GTOptions;       -- At least one of GTOptions
  --    graphType            : GEGraph;         -- areaGraph,barGraph, etc.
  --    marginSpacingPercent : SGK.GTCoordinate;-- % of graph area is margin
  --
  --  CALLING SEQUENCE -
  --
  --    SetGraphStyle (graphHandle, graphStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    graphStyle : GRGraphStyle
  --      The structure defining the style attributes for the graph.
  --




  procedure SetSeriesStyle
             (graphHandle : in     GPGraph;
              styleIndex  : in     GTSeriesStyleIndex;
              SeriesStyle : in     GRSeriesStyle);

  --*
  --  SetSeriesStyle - Set the fill, line and marker style for a series.
  --
  --
  --  Set the fill, line and marker style for a series within
  --  the series style list.
  --
  --  CALLING SEQUENCE -
  --
  --    SetSeriesStyle (graphHandle, styleIndex, seriesStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    styleIndex : GTSeriesStyleIndex
  --      Index into the series style list.
  --
  --  EXIT -
  --
  --    seriesStyle : GRSeriesStyle
  --      Structure defining the fill, line and marker style.
  --




  procedure SetLabelStyle
             (graphHandle : in     GPGraph;
              labelStyle  : in     GRLabelStyle);

  --*
  --  SetLabelStyle - Set the style for labels.
  --
  --
  --  Set line style, fill style, text style, axis to label offset and
  --  format for labels.
  --
  --  The structure 'labelStyle' has the following format:
  --
  --    axisLabelOffset : SGK.GTCoordinate;
  --    labelFormat     : GELabelFormat;    -- float, integer, or string label
  --    fillStyle       : SGK.GRFillStyle;
  --    lineStyle       : SGK.GRLineStyle;
  --    textStyle       : SGK.GRTextStyle;
  --
  --  CALLING SEQUENCE -
  --
  --    SetLabelStyle (graphHandle, labelStyle);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    labelStyle : GRLabelStyle
  --      Style attributes for labels.
  --




  procedure SetPieWedgePullOut
             (graphHandle : in     GPGraph;
              wedgeNumber : in     GTIndex;
              pull        : in     boolean);

  --*
  --  SetPieWedgePullOut - Set the pull out status of a pie wedge.
  --
  --
  --  Set the pull out status of a pie wedge denoted by 'wedge number'.
  --
  --  'pull' equal TRUE if the wedge is to be drawn pulled out from
  --  the rest of the pie graph.
  --
  --  Wedges are number from the top of the pie clockwise.
  --
  --  CALLING SEQUENCE -
  --
  --    SetPieWedgePullOut (graphHandle, wedgeNumber, pulled);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --    wedgeNumber : GTIndex
  --      number indicating the wedge in question.
  --
  --    pulled : BOOLEAN
  --      TRUE = wedge is to be pulled.
  --      FALSE otherwise.
  --




  procedure SetPieWedgePullOutPercent
             (graphHandle    : in     GPGraph;
              pullOutPercent : in     SGK.GTCoordinate);

  --*
  --  SetPieWedgePullOutPercent - Set pie wedge pull out percent.
  --
  --
  --  Set the amount the pie wedge is to be pulled away from the center
  --  of the pie graph.
  --
  --  The amount is a percentage of the data window distance
  --
  --  CALLING SEQUENCE -
  --
  --    SetPieWedgePullOutPercent (graphHandle, pullOutPercent);
  --
  --  ENTRY -
  --
  --    graphHandle : GPGraph
  --      Pointer to the structure defining the graph attributes.
  --
  --  EXIT -
  --
  --    pullOutPercent : SGK.GTCoordinate
  --      The percentage of the pie radius for the pull out.
  --




Send mail to   warren.merrill@inl.gov with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance