model

Type Members

1. sealed trait DataDef extends AnyRef

   

   Defines data to show in the graph.

2. case class GraphDef(plots: List[PlotDef], startTime: Instant, endTime: Instant, timezones: List[ZoneId] = List(ZoneOffset.UTC), step: Long = 60000, width: Int = 400, height: Int = 200, layout: Layout = Layout.CANVAS, zoom: Double = 1.0, title: Option[String] = None, legendType: LegendType = LegendType.LABELS_WITH_STATS, onlyGraph: Boolean = false, numberFormat: String = "%f", loadTime: Long = 1, stats: CollectorStats = CollectorStats.unknown, warnings: List[String] = Nil, source: Option[String] = None) extends Product with Serializable

   

   Definition of a time series graph.

   Definition of a time series graph.

   plots

   Plot definitions. Each plot has its own y-axis and set of lines.

   startTime

   Start time (inclusive) for the first datapoint.

   endTime

   End time (exclusive) for the last datapoint.

   timezones

   Time zones to show as time axes on the chart. The first time zone in the list will be the primary used when dislaying time stamps or for formats that don't support multiple time zone rendering.

   step

   Step size for each datapoint.

   width

   Width in pixels for the chart area. This excludes axes and other padding. The final image size will get calculated using this width as a starting point.

   height

   Height in pixels for the chart area. This excludes the title, time axis, legend, etc. The final image size will get calculated using this height as a starting point.

   layout

   Layout mode to use for rendering the image. Default is CANVAS.

   zoom

   Zoom factor to apply as a transform to the image.

   title

   Title of the graph.

   legendType

   How to show the legend when rendering the graph.

   onlyGraph

   Show only the chart without other details like axes, legends, labels, etc.

   numberFormat

   Pattern used for formatting the number values in text based outputs.

   loadTime

   How long it took to load the data for the chart in milliseconds.

   stats

   Stats on how much data was processed to render the chart.

   warnings

   Warnings to display to the user.

   source

   Used to provide metadata for how the graph definition was created. For example the uri input by the user.

3. case class HSpanDef(v1: Double, v2: Double, color: Color, labelOpt: Option[String]) extends DataDef with Product with Serializable

   

   Defintion for a horizontal span.

   Defintion for a horizontal span.

   v1

   Starting value for the span.

   v2

   Ending value for the span.

   color

   Color to use when rendering the span.

   labelOpt

   Label associated with the span to use in the legend.

4. final class Layout extends Enum[Layout]

   

5. final class LegendType extends Enum[LegendType]

   

6. case class LineDef(data: TimeSeries, color: Color = Color.RED, lineStyle: LineStyle = LineStyle.LINE, lineWidth: Float = 1.0f, legendStats: SummaryStats = SummaryStats.empty) extends DataDef with Product with Serializable

   

   Defintion for a time series line.

   Defintion for a time series line.

   data

   Time series with the underlying data to render.

   color

   Color to use when rendering the line.

   lineStyle

   Style to use when rendering. Values are LINE, AREA, STACK, and VSPAN.

   lineWidth

   Width of the stroke when rendering the line. Has no effect for styles other than LINE.

   legendStats

   Summary stats for the data in the line.

7. final class LineStyle extends Enum[LineStyle]

   

8. case class MessageDef(label: String, color: Color = Color.BLACK) extends DataDef with Product with Serializable

   

   Definition for a message that is included in the legend, but not displayed.

   Definition for a message that is included in the legend, but not displayed.

   label

   Label associated with the span to use in the legend.

   color

   Color to use when rendering the text in the legend.

9. case class Palette(name: String, colors: (Int) ⇒ Color) extends Product with Serializable

   

10. sealed trait PlotBound extends AnyRef

    

    Upper or lower bound to use for an axis.

11. case class PlotDef(data: List[DataDef], ylabel: Option[String] = None, axisColor: Option[Color] = None, scale: Scale = Scale.LINEAR, upper: PlotBound = AutoStyle, lower: PlotBound = AutoStyle, tickLabelMode: TickLabelMode = TickLabelMode.DECIMAL) extends Product with Serializable

    

    Definition for a plot, i.e., a y-axis and associated data elements.

    Definition for a plot, i.e., a y-axis and associated data elements.

    data

    List of data items to include in the plot.

    ylabel

    Label to show for the axis.

    axisColor

    Color to use when rendering the axis.

    scale

    Type of scale to use on the axis, linear or logarithmic.

    upper

    Upper limit for the axis.

    lower

    Lower limit for the axis.

    tickLabelMode

    Mode to use for displaying tick labels.

12. final class Scale extends Enum[Scale]

    

13. final class TickLabelMode extends Enum[TickLabelMode]

    

14. case class VSpanDef(t1: Instant, t2: Instant, color: Color, labelOpt: Option[String]) extends DataDef with Product with Serializable

    

    Defintion for a vertical span.

    Defintion for a vertical span.

    t1

    Starting time for the span.

    t2

    Ending time for the span.

    color

    Color to use when rendering the span.

    labelOpt

    Label associated with the span to use in the legend.

15. final class VisionType extends Enum[VisionType]