core

Type Members

1. case class Board(title: String, boxes: Seq[Box], aggregate: (Seq[View]) ⇒ View, layout: Layout, links: Seq[(Box, Box)] = Seq.empty)(implicit valueStore: ValueStore) extends Product with Serializable

   

   Top level component

   Top level component

   title

   The board title

   boxes

   The children boxes

   aggregate

   Aggregates its children boxes views

   layout

   The layout of the board

   links

   Defines links between boxes, will draw lines in the UI

   valueStore

   The store used for

2. case class Box(title: String, checks: Seq[Check[_]], aggregate: (Seq[View]) ⇒ View, description: Option[String] = None, labelLimit: Option[Int] = None) extends Product with Serializable

   

   A box that groups checks

   A box that groups checks

   title

   The title

   checks

   The checks

   aggregate

   Aggregates the views of its checks, return a view

   description

   The description of the box in markdown syntax

   labelLimit

   The limit of visible check labels shown on the box

3. case class Check[V](id: String, title: String, apply: () ⇒ Future[V], display: (V, Context) ⇒ View)(implicit evidence$1: Metrical[V]) extends Product with Serializable

   

   A class for declaring a metric to check

   A class for declaring a metric to check

   V

   A type parameter which corresponds to the type of the checked value

   id

   The identifier

   title

   The title of the check

   apply

   A function when called, should return a future of target value

   display

   A function that takes a checked value and a Context

4. case class Column(percentage: Double, rows: Seq[Row]) extends Product with Serializable

   

   Represents a column on a board

   Represents a column on a board

   percentage

   The percentage it takes as width

   rows

   The rows in the column

5. case class Context(when: Instant) extends Product with Serializable

   

   Represents the context when a check occurs

   Represents the context when a check occurs

   when

   The datetime when it occurs

6. case class Layout(columns: Seq[Column]) extends Product with Serializable

   

   Defines the layout of a board

   Defines the layout of a board

   columns

   List of Column

7. trait Metrical[T] extends AnyRef

   

   Defines types that are serializable to metrical values, and deserializable from metrical values

   Defines types that are serializable to metrical values, and deserializable from metrical values

   T

   The underlying type that implements Metrical interfaces

8. case class Row(title: String, percentage: Double = 100, boxes: Seq[Box]) extends Product with Serializable

   

   Represents a row inside a column

   Represents a row inside a column

   title

   The title

   percentage

   The percentage it takes as height, defaults to 100

   boxes

   The boxes to be displayed in the row

9. sealed class Status extends Ordered[Status]

   

   The status of a check

10. trait ValueStore extends AnyRef

    

    A store provides a service to upload and fetch metrics

11. case class View(status: Status, message: String, label: Option[String] = None) extends Product with Serializable

    

    A view represents the status of a given check

    A view represents the status of a given check

    status

    The status of the underlying check

    message

    The message to show

    label

    The label