FunnelArea

public struct FunnelArea<LabelsData, ValuesData> : Trace, DomainSubplot where LabelsData : Plotable, ValuesData : Plotable

Visualize stages in a process using area-encoded trapezoids.

This trace can be used to show data in a part-to-whole representation similar to a “pie” trace, wherein each item appears in a single stage. See also the “funnel” trace type for a different approach to visualizing funnel data.

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>?

  • 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?

  • Sets the sector labels.

    If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

    Declaration

    Swift

    public var labels: LabelsData?

  • Alternate to labels.

    Builds a numeric set of labels. Use with dlabel where label0 is the starting label and dlabel the step.

    Declaration

    Swift

    public var label0: Double?

  • Sets the label step.

    See label0 for more info.

    Declaration

    Swift

    public var dLabel: Double?

  • Sets the values of the sectors.

    If omitted, we count occurrences of each label.

    Declaration

    Swift

    public var values: ValuesData?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Marker : Encodable

  • Undocumented

    Declaration

    Swift

    public var marker: Marker?

  • Sets text elements associated with each sector.

    If trace textinfo contains a text flag, these elements will be seen on the chart. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

    Declaration

    Swift

    public var text: Data<String>?

  • Sets hover text elements associated with each sector.

    If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a text flag.

    Declaration

    Swift

    public var hoverText: Data<String>?

  • If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

    Declaration

    Swift

    public var scaleGroup: String?

  • Determines which trace information appear on the graph.

    See more

    Declaration

    Swift

    public struct TextInfo : OptionSet, Encodable

  • Determines which trace information appear on the graph.

    Declaration

    Swift

    public var textInfo: TextInfo?

  • Template string used for rendering the information text that appear on points.

    Note that this will override textinfo. 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. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. variables label, color, value, text and percent.

    Declaration

    Swift

    public var textTemplate: Data<String>?

  • 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.

    See more

    Declaration

    Swift

    public struct HoverInfo : OptionSet, Encodable

  • 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?

  • 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. variables label, color, value, text and percent. 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>?

  • Specifies the location of the textinfo.

    See more

    Declaration

    Swift

    public enum TextPosition : String, Encodable

  • Specifies the location of the textinfo.

    Declaration

    Swift

    public var textPosition: TextPosition?

  • Sets the font used for textinfo.

    Declaration

    Swift

    public var textFont: VariableFont?

  • Sets the font used for textinfo lying inside the sector.

    Declaration

    Swift

    public var insideTextFont: VariableFont?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Title : Encodable

  • Undocumented

    Declaration

    Swift

    public var title: Title?

  • Declaration

    Swift

    public var domain: Domain?

  • Sets the ratio between height and width

    Declaration

    Swift

    public var aspectRatio: Double?

  • Sets the ratio between bottom length and maximum top length.

    Declaration

    Swift

    public var baseRatio: Double?

  • Creates FunnelArea object from the most frequently used properties.

    Declaration

    Swift

    public init(name: String? = nil, labels: LabelsData? = nil, values: ValuesData? = nil, marker:
        Marker? = nil, text: Data<String>? = nil, hoverText: Data<String>? = nil)

    Parameters

    name

    Sets the trace name.
    labels

    Sets the sector labels.
    values

    Sets the values of the sectors.
    marker

    text

    Sets text elements associated with each sector.
    hoverText

    Sets hover text elements associated with each sector.

  • Creates FunnelArea 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, hoverLabel: HoverLabel? = nil, stream:
        Stream? = nil, transforms: [Transform] = [], uiRevision: Anything? = nil, labels: LabelsData? =
        nil, label0: Double? = nil, dLabel: Double? = nil, values: ValuesData? = nil, marker: Marker? =
        nil, text: Data<String>? = nil, hoverText: Data<String>? = nil, scaleGroup: String? = nil,
        textInfo: TextInfo? = nil, textTemplate: Data<String>? = nil, hoverInfo: HoverInfo? = nil,
        hoverTemplate: Data<String>? = nil, textPosition: TextPosition? = nil, textFont: VariableFont? =
        nil, insideTextFont: VariableFont? = nil, title: Title? = nil, domain: Domain? = nil,
        aspectRatio: Double? = nil, baseRatio: Double? = nil)

    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.
    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.
    labels

    Sets the sector labels.
    label0

    Alternate to labels.
    dLabel

    Sets the label step.
    values

    Sets the values of the sectors.
    marker

    text

    Sets text elements associated with each sector.
    hoverText

    Sets hover text elements associated with each sector.
    scaleGroup

    If there are multiple funnelareas that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.
    textInfo

    Determines which trace information appear on the graph.
    textTemplate

    Template string used for rendering the information text that appear on points.
    hoverInfo

    Determines which trace information appear on hover.
    hoverTemplate

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

    Specifies the location of the textinfo.
    textFont

    Sets the font used for textinfo.
    insideTextFont

    Sets the font used for textinfo lying inside the sector.
    title

    domain

    aspectRatio

    Sets the ratio between height and width
    baseRatio

    Sets the ratio between bottom length and maximum top length.

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws