Packages

package histogram

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Cumulative(enabled: Opt[Boolean] = Blank, direction: Opt[Direction] = Blank, currentbin: Opt[CurrentBin] = Blank) extends Component with Product with Serializable

    This is an option for a histogram chart.

    This is an option for a histogram chart. If enabled == true, it shows cumulative distribution by summing the bin values.

    enabled

    : A boolean that specifies whether the cumulative distribution is enabled.

    direction

    : If 'increasing' will sum all prior bins. if 'decreasing' will sum the later bins.

    currentbin

    : only applies if enabled == true. Sets whether the bin is included, excluded, or has half of its value in the current cumulative value.

  2. sealed trait CurrentBin extends AnyRef

    this trait acts as an ENUM for the current bin option.

    this trait acts as an ENUM for the current bin option. Only applies if cumulative is enabled.

  3. sealed trait Direction extends AnyRef

    This trait acts as an ENUM for direction option.

    This trait acts as an ENUM for direction option. Only applies if cumulative is enabled.

  4. sealed trait HistFunction extends AnyRef

    Specifies the binning function used for the histogram.

  5. sealed trait HistNorm extends AnyRef

    Specifies how the histogram is normalized.

  6. final case class HistOptions(orientation: Orientation = VERTICAL, cumulative: Opt[Cumulative] = Blank, histnorm: Opt[HistNorm] = Blank, histfunc: Opt[HistFunction] = Blank, xbins: Opt[Xbins] = Blank, ybins: Opt[Ybins] = Blank) extends Component with Product with Serializable

    This class sets the options for a histogram.

    This class sets the options for a histogram. Generally this will be manipulated by a component that sits higher up in the class hierarchy.

    orientation

    : Specifies whether the histogram is vertical or horizontal.

    cumulative

    : This takes in a Cumulative type which specifies how the histogram cumulative function works.

    histnorm

    : Specifies the type of normalization for the histogram series.

    histfunc

    : Specifies the binning function for the histogram series.

    xbins

    : An Xbin specified by the user.

    ybins

    : A Ybin specified by the user.

  7. final case class Xbins(start: Opt[Double] = Blank, end: Opt[Double] = Blank, size: Opt[Double] = Blank) extends HistBins with Product with Serializable

    A case class that represents the Xbins option.

    A case class that represents the Xbins option.

    start

    : The starting value for the bin. If not provided, rendering will default to the minimum data value.

    end

    : The ending value for the bin. If not provided, rendering will default to the maximum data value.

    size

    : Sets the size of each bin.

  8. final case class Ybins(start: Opt[Double] = Blank, end: Opt[Double] = Blank, size: Opt[Double] = Blank) extends HistBins with Product with Serializable

    A case class that represents the Ybins option.

    A case class that represents the Ybins option.

    start

    : The starting value for the bin. If not provided, rendering will default to the minimum data value.

    end

    : The ending value for the bin. If not provided, rendering will default to the maximum data value.

    size

    : Sets the size of each bin.

Value Members

  1. case object AVG extends HistFunction with Product with Serializable

    Histogram values are equal to the average of the values lying in the bin.

  2. case object COUNT extends HistFunction with Product with Serializable

    Histogram values are equal to the number of values lying in the bin.

  3. case object DECREASING extends Direction with Product with Serializable

    Sum later bins so that the result decreases from left to right.

  4. case object DENSITY extends HistNorm with Product with Serializable

    The length of each bar equals the number of occurrences in a bin divided by the length of the bin interval.

  5. case object EXCLUDE extends CurrentBin with Product with Serializable

    exclude current bin from the current cumulative value.

  6. case object HALF extends CurrentBin with Product with Serializable

    half the value of the current bin is included in the current cumulative value.

  7. case object INCLUDE extends CurrentBin with Product with Serializable

    include current bin from the current cumulative value.

  8. case object INCREASING extends Direction with Product with Serializable

    Sum prior bins so that the result increases from left to right.

  9. case object MAX extends HistFunction with Product with Serializable

    Histogram values are equal to the max of the values lying in the bin.

  10. case object MIN extends HistFunction with Product with Serializable

    Histogram values are equal to the min of the values lying in the bin.

  11. case object NUMBER extends HistNorm with Product with Serializable

    The length of each bar corresponds to the number of occurrences.

  12. case object PERCENT extends HistNorm with Product with Serializable

    The length of each bar equals the percentage of occurrences with respect to the total number of points.

  13. case object PROBABILITY_DENSITY extends HistNorm with Product with Serializable

    The area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

  14. case object SUM extends HistFunction with Product with Serializable

    Histogram values are equal to the sum of the values lying in the bin.

Ungrouped