Cumulative

public struct Cumulative : Encodable

Undocumented

  • If true, display the cumulative distribution by summing the binned values.

    Use the direction and centralbin attributes to tune the accumulation method. Note: in this mode, the density histnorm settings behave the same as their equivalents without density: ** and density both rise to the number of data points, and probability and probability density both rise to the number of sample points.

    Declaration

    Swift

    public var enabled: Bool?
  • Only applies if cumulative is enabled.

    If increasing (default) we sum all prior bins, so the result increases from left to right. If decreasing we sum later bins so the result decreases from left to right.

    See more

    Declaration

    Swift

    public enum Direction : String, Encodable
  • Only applies if cumulative is enabled.

    If increasing (default) we sum all prior bins, so the result increases from left to right. If decreasing we sum later bins so the result decreases from left to right.

    Declaration

    Swift

    public var direction: Direction?
  • Only applies if cumulative is enabled.

    Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. include is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. exclude makes the opposite half-bin bias, and half removes it.

    See more

    Declaration

    Swift

    public enum CurrentBin : String, Encodable
  • Only applies if cumulative is enabled.

    Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. include is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. exclude makes the opposite half-bin bias, and half removes it.

    Declaration

    Swift

    public var currentBin: CurrentBin?
  • Creates Cumulative object with specified properties.

    Declaration

    Swift

    public init(enabled: Bool? = nil, direction: Direction? = nil, currentBin: CurrentBin? = nil)

    Parameters

    enabled

    If true, display the cumulative distribution by summing the binned values.

    direction

    Only applies if cumulative is enabled.

    currentBin

    Only applies if cumulative is enabled.