atlas-chart
API
Generated with
atlas-chart/com.netflix.atlas.chart/com.netflix.atlas.chart.model

com.netflix.atlas.chart.model

package com.netflix.atlas.chart.model

Members list

Type members

Classlikes

sealed trait DataDef

Defines data to show in the graph.

Defines data to show in the graph.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class HSpanDef
class LineDef
class MessageDef
class VSpanDef
case class GraphDef(plots: List[PlotDef], startTime: Instant, endTime: Instant, timezones: List[ZoneId], step: Long, width: Int, height: Int, layout: Layout, zoom: Double, title: Option[String], legendType: LegendType, onlyGraph: Boolean, numberFormat: String, loadTime: Long, stats: CollectorStats, warnings: List[String], source: Option[String], themeName: String, renderingHints: Set[String])

Definition of a time series graph.

Definition of a time series graph.

Value parameters

endTime

End time (exclusive) for the last datapoint.

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.

legendType

How to show the legend when rendering the graph.

loadTime

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

numberFormat

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

onlyGraph

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

plots

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

renderingHints

Arbitrary hints passed to the rendering engine to adjust behavior.

source

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

startTime

Start time (inclusive) for the first datapoint.

stats

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

step

Step size for each datapoint.

themeName

Which theme to use for the chart, typically light or dark mode.

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.

title

Title of the graph.

warnings

Warnings to display to the user.

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.

zoom

Zoom factor to apply as a transform to the image.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GraphDef

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
GraphDef.type
case class HSpanDef(v1: Double, v2: Double, color: Color, labelOpt: Option[String]) extends DataDef

Defintion for a horizontal span.

Defintion for a horizontal span.

Value parameters

color

Color to use when rendering the span.

labelOpt

Label associated with the span to use in the legend.

v1

Starting value for the span.

v2

Ending value for the span.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait DataDef
class Object
trait Matchable
class Any
Show all
case class HeatmapDef(colorScale: Scale, upper: PlotBound, lower: PlotBound, palette: Option[Palette], label: Option[String])

A configuration used to compute and optionally plot a heatmap.

A configuration used to compute and optionally plot a heatmap.

Value parameters

colorScale

The color scale to use for counts within a cell.

label

A string to use for the legend.

lower

An optional lower boundary for the cell count.

palette

An optional palette to use for the heatmap

upper

An optional upper boundary for the cell count.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class LineDef(data: TimeSeries, query: Option[String], groupByKeys: List[String], color: Color, lineStyle: LineStyle, lineWidth: Float, legendStats: SummaryStats) extends DataDef

Defintion for a time series line.

Defintion for a time series line.

Value parameters

color

Color to use when rendering the line.

data

Time series with the underlying data to render.

groupByKeys

Set of keys used in the final grouping for the time series.

legendStats

Summary stats for the data in 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.

query

Expression for the time series. Note, the same expression can result in many time series when using group by. For matching the data for a particular time series the id field should be used.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait DataDef
class Object
trait Matchable
class Any
Show all
case class MessageDef(label: String, color: Color) extends DataDef

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.

Value parameters

color

Color to use when rendering the text in the legend.

label

Label associated with the span to use in the legend.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait DataDef
class Object
trait Matchable
class Any
Show all
case class Palette(name: String, colorArray: ArraySeq[Color])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Palette

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Palette.type
sealed trait PlotBound

Upper or lower bound to use for an axis.

Upper or lower bound to use for an axis.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AutoData
object AutoStyle
class Explicit
object PlotBound

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
PlotBound.type
case class PlotDef(data: List[DataDef], ylabel: Option[String], axisColor: Option[Color], scale: Scale, upper: PlotBound, lower: PlotBound, tickLabelMode: TickLabelMode, heatmap: Option[HeatmapDef])

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.

Value parameters

axisColor

Color to use when rendering the axis.

data

List of data items to include in the plot.

heatmap

Optional heatmap settings for the plot.

lower

Lower limit for the axis.

scale

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

tickLabelMode

Mode to use for displaying tick labels.

upper

Upper limit for the axis.

ylabel

Label to show for the axis.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class VSpanDef(t1: Instant, t2: Instant, color: Color, labelOpt: Option[String]) extends DataDef

Defintion for a vertical span.

Defintion for a vertical span.

Value parameters

color

Color to use when rendering the span.

labelOpt

Label associated with the span to use in the legend.

t1

Starting time for the span.

t2

Ending time for the span.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait DataDef
class Object
trait Matchable
class Any
Show all
Generated with