gui.guilinegraph - ICE 0.1 API documentation

ICE 0.1 API documentation

# gui.guilinegraph

Line graph (like system monitor) widget.

class GUILineGraph: gui.guielement.GUIElement;

  Line graph widget, showing graphs for multiple changing values system monitor style.

  The graph data is managed by a GraphData instance, GUILineGraph only handles display.

  const @property Color graphColor(size_t idx);

    Get color of graph with specified index.

  @property void dataPointTime(real time);

    Set time difference between two graph data points in seconds.

  const @property real dataPointTime();

    Get time between two graph data points.

  void toggleGraphVisibility(in size_t value);

    Toggle visibility of graph of specified value.

  @property void autoScale(in bool scale);

    If true, Y axis of the graph will be scaled automatically according to highest value.

  @property void autoScroll(in bool scroll);

    If true, the graph will automatically scroll to show newest data.

  @property void timeOffset(in float offset);

    Set time offset of the graph. Used for manual scrolling.

  void scroll(in float offset);

    Manually scroll the graph horizontally.

    Disables automatic scrolling.

    Parameters:

    float offset | Screen space offset relative the start of graph.

  const @property float scaleX();

    Get X scale of the graph.

  @property void scaleX(float scaleX);

    Set X scale of the graph. Used for manual zooming.

  const @property float scaleY();

    Get Y scale of the graph.

  @property void scaleY(float scaleY);

    Set Y scale of the graph. Used for manual zooming.

  @property void fontSize(in uint size);

    Set font size of the graph.

  @property void graphMode(in GraphMode mode);

    Set graph mode (data points are average per measurement or sums over time).

  protected this(const(GUIElementParams) params, const(Color[]) colors, GraphData data);

    Construct a GUILineGraph.

    Parameters:

    const(GUIElementParams) params | Parameters for GUIElement constructor.
    const(Color[]) colors | Colors of graphs displayed.
    GraphData data | Reference to GraphData to display. GUILineGraph just displays the GraphData, it doesn't manage it.

class GUILineGraphFactory: gui.guielement.GUIElementFactoryBase!(GUILineGraph).GUIElementFactoryBase;

  Factory used for line graph construction.

  See Also:
  GUIElementFactoryBase
  Parameters:

  graphColors | Colors of graphs (length must be equal to number of graphs.)

  this(GraphData data);

    Construct a factory to produce a GUILineGraph displaying specified GraphData.

  GUILineGraph produce();

    Produce a GUILineGraph with parameters of the factory.

Copyright © Ferdinand Majerech 2011. | Page generated by AutoDDoc and Ddoc.