Histogram

public struct Histogram<XData, YData> : Trace, XYSubplot where XData : Plotable, YData : Plotable

The sample data from which statistics are computed is set in x for vertically spanning histograms and in y for horizontally spanning histograms.

Binning options are set xbins and ybins respectively if no aggregation data is provided.

See also

Documentation for Python, JavaScript or R

  • Corresponding Plotly trace type.

    Declaration

    Swift

    public let type: String

  • Switch indicating whether the trace supports animation of its data.

    Declaration

    Swift

    public static var animatable: Bool { get }

  • Determines whether or not this trace is visible.

    If legendonly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

    Declaration

    Swift

    public var visible: Visible?

  • Determines whether or not an item corresponding to this trace is shown in the legend.

    Declaration

    Swift

    public var showLegend: Bool?

  • Sets the legend group for this trace.

    Traces part of the same legend group hide/show at the same time when toggling legend items.

    Declaration

    Swift

    public var legendGroup: String?

  • Sets the opacity of the trace.

    Declaration

    Swift

    public var opacity: Double?

  • Sets the trace name.

    The trace name appear as the legend item and on hover.

    Declaration

    Swift

    public var name: String?
  • uid

    Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

    Declaration

    Swift

    public var uid: String?
  • ids

    Assigns id labels to each datum.

    These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

    Declaration

    Swift

    public var ids: [String]?

  • Assigns extra data each datum.

    This may be useful when listening to hover, click and selection events. Note that, scatter traces also appends customdata items in the markers DOM elements

    Declaration

    Swift

    public var customData: [String]?

  • Assigns extra meta information associated with this trace that can be used in various text attributes.

    Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

    Declaration

    Swift

    public var meta: Data<Anything>?

  • Array containing integer indices of selected points.

    Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

    Declaration

    Swift

    public var selectedPoints: Anything?

  • Determines which trace information appear on hover.

    If none or skip are set, no information is displayed upon hovering. But, if none is set, click and hover events are still fired.

    Declaration

    Swift

    public var hoverInfo: HoverInfo?

  • Undocumented

    Declaration

    Swift

    public var hoverLabel: HoverLabel?

  • Undocumented

    Declaration

    Swift

    public var stream: Stream?

  • Undocumented

    Declaration

    Swift

    public var transforms: [Transform]

  • Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title.

    Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

    Declaration

    Swift

    public var uiRevision: Anything?
  • x

    Sets the sample data to be binned on the x axis.

    Declaration

    Swift

    public var x: XData?
  • y

    Sets the sample data to be binned on the y axis.

    Declaration

    Swift

    public var y: YData?

  • Sets hover text elements associated with each bar.

    If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace’s coordinates.

    Declaration

    Swift

    public var text: Data<String>?

  • Same as text.

    Declaration

    Swift

    public var hoverText: Data<String>?

  • Sets the orientation of the bars.

    With v (h), the value of the each bar spans along the vertical (horizontal).

    Declaration

    Swift

    public var orientation: Orientation?

  • Specifies the binning function used for this histogram trace.

    If count, the histogram values are computed by counting the number of values lying inside each bin. If sum, avg, min, max, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

    Declaration

    Swift

    public var binningFunction: BinningFunction?

  • Specifies the type of normalization used for this histogram trace.

    If *, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent / probability, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If density, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, 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).

    Declaration

    Swift

    public var normalization: Normalization?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Cumulative : Encodable

  • Undocumented

    Declaration

    Swift

    public var cumulative: Cumulative?

  • Specifies the maximum number of desired bins.

    This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

    Declaration

    Swift

    public var xNumBins: Int?

  • Undocumented

    Declaration

    Swift

    public var xBins: Bins?

  • Specifies the maximum number of desired bins.

    This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

    Declaration

    Swift

    public var yNumBins: Int?

  • Undocumented

    Declaration

    Swift

    public var yBins: Bins?

  • Obsolete: since v1.42 each bin attribute is auto-determined separately and autobinx is not needed.

    However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

    Declaration

    Swift

    public var xAutoBin: Bool?

  • Obsolete: since v1.42 each bin attribute is auto-determined separately and autobiny is not needed.

    However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

    Declaration

    Swift

    public var yAutoBin: Bool?

  • Set a group of histogram traces which will have compatible bin settings.

    Note that traces on the same subplot and with the same orientation under barmode stack, relative and group are forced into the same bingroup, Using bingroup, traces under barmode overlay and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d* trace can share the same bingroup

    Declaration

    Swift

    public var binGroup: String?

  • Template string used for rendering the information that appear on hover box.

    Note that this will override hoverinfo. Variables are inserted using %{variable}, for example “y: %{y}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format’s syntax %{variable|d3-time-format}, for example “Day: %{2019-01-01|%A}”. https://github.com/d3/d3-time-format#locale_format for details on the date formatting syntax. The variables available in hovertemplate are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are arrayOk: true) are available. variable binNumber Anything contained in tag <extra> is displayed in the secondary box, for example “{fullData.name}”. To hide the secondary box completely, use an empty tag <extra></extra>.

    Declaration

    Swift

    public var hoverTemplate: Data<String>?

  • Undocumented

    Declaration

    Swift

    public var marker: Marker?

  • Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

    Declaration

    Swift

    public var offsetGroup: String?

  • Set several traces linked to the same position axis or matching axes to the same alignmentgroup.

    This controls whether bars compute their positional range dependently or independently.

    Declaration

    Swift

    public var alignmentGroup: String?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Selected : Encodable

  • Undocumented

    Declaration

    Swift

    public var selected: Selected?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Unselected : Encodable

  • Undocumented

    Declaration

    Swift

    public var unselected: Unselected?

  • Undocumented

    Declaration

    Swift

    public var xError: Error?

  • Undocumented

    Declaration

    Swift

    public var yError: Error?

  • Sets the calendar system to use with x date data.

    Declaration

    Swift

    public var xCalendar: Calendar?

  • Sets the calendar system to use with y date data.

    Declaration

    Swift

    public var yCalendar: Calendar?

  • Sets a reference between this trace’s x coordinates and a 2D cartesian x axis.

    If x (the default value), the x coordinates refer to layout.xaxis. If x2, the x coordinates refer to layout.xaxis2, and so on.

    Declaration

    Swift

    public var xAxis: XAxis

  • Sets a reference between this trace’s y coordinates and a 2D cartesian y axis.

    If y (the default value), the y coordinates refer to layout.yaxis. If y2, the y coordinates refer to layout.yaxis2, and so on.

    Declaration

    Swift

    public var yAxis: YAxis

  • Creates Histogram object from the most frequently used properties.

    Declaration

    Swift

    public init(name: String? = nil, x: XData? = nil, y: YData? = nil, text: Data<String>? = nil,
        hoverText: Data<String>? = nil, marker: Marker? = nil)

    Parameters

    name

    Sets the trace name.
    x

    Sets the sample data to be binned on the x axis.
    y

    Sets the sample data to be binned on the y axis.
    text

    Sets hover text elements associated with each bar.
    hoverText

    Same as text.
    marker

  • Creates Histogram object with specified properties.

    Declaration

    Swift

    public init(visible: Visible? = nil, showLegend: Bool? = nil, legendGroup: String? = nil,
        opacity: Double? = nil, name: String? = nil, uid: String? = nil, ids: [String]? = nil,
        customData: [String]? = nil, meta: Data<Anything>? = nil, selectedPoints: Anything? = nil,
        hoverInfo: HoverInfo? = nil, hoverLabel: HoverLabel? = nil, stream: Stream? = nil, transforms:
        [Transform] = [], uiRevision: Anything? = nil, x: XData? = nil, y: YData? = nil, text:
        Data<String>? = nil, hoverText: Data<String>? = nil, orientation: Orientation? = nil,
        binningFunction: BinningFunction? = nil, normalization: Normalization? = nil, cumulative:
        Cumulative? = nil, xNumBins: Int? = nil, xBins: Bins? = nil, yNumBins: Int? = nil, yBins: Bins?
        = nil, xAutoBin: Bool? = nil, yAutoBin: Bool? = nil, binGroup: String? = nil, hoverTemplate:
        Data<String>? = nil, marker: Marker? = nil, offsetGroup: String? = nil, alignmentGroup: String?
        = nil, selected: Selected? = nil, unselected: Unselected? = nil, xError: Error? = nil, yError:
        Error? = nil, xCalendar: Calendar? = nil, yCalendar: Calendar? = nil, xAxis: XAxis = .preset,
        yAxis: YAxis = .preset)

    Parameters

    visible

    Determines whether or not this trace is visible.
    showLegend

    Determines whether or not an item corresponding to this trace is shown in the legend.
    legendGroup

    Sets the legend group for this trace.
    opacity

    Sets the opacity of the trace.
    name

    Sets the trace name.
    uid

    Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
    ids

    Assigns id labels to each datum.
    customData

    Assigns extra data each datum.
    meta

    Assigns extra meta information associated with this trace that can be used in various text attributes.
    selectedPoints

    Array containing integer indices of selected points.
    hoverInfo

    Determines which trace information appear on hover.
    hoverLabel

    stream

    transforms

    uiRevision

    Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title.
    x

    Sets the sample data to be binned on the x axis.
    y

    Sets the sample data to be binned on the y axis.
    text

    Sets hover text elements associated with each bar.
    hoverText

    Same as text.
    orientation

    Sets the orientation of the bars.
    binningFunction

    Specifies the binning function used for this histogram trace.
    normalization

    Specifies the type of normalization used for this histogram trace.
    cumulative

    xNumBins

    Specifies the maximum number of desired bins.
    xBins

    yNumBins

    Specifies the maximum number of desired bins.
    yBins

    xAutoBin

    Obsolete: since v1.42 each bin attribute is auto-determined separately and autobinx is not needed.
    yAutoBin

    Obsolete: since v1.42 each bin attribute is auto-determined separately and autobiny is not needed.
    binGroup

    Set a group of histogram traces which will have compatible bin settings.
    hoverTemplate

    Template string used for rendering the information that appear on hover box.
    marker

    offsetGroup

    Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.
    alignmentGroup

    Set several traces linked to the same position axis or matching axes to the same alignmentgroup.
    selected

    unselected

    xError

    yError

    xCalendar

    Sets the calendar system to use with x date data.
    yCalendar

    Sets the calendar system to use with y date data.
    xAxis

    Sets a reference between this trace’s x coordinates and a 2D cartesian x axis.
    yAxis

    Sets a reference between this trace’s y coordinates and a 2D cartesian y axis.

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws