BarPolar

public struct BarPolar<RData, ThetaData> : Trace, PolarSubplot where RData : Plotable, ThetaData : Plotable

The data visualized by the radial span of the bars is set in r

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?

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

    Sets the radial coordinates

    Declaration

    Swift

    public var r: RData?

  • Sets the angular coordinates

    Declaration

    Swift

    public var theta: ThetaData?
  • r0

    Alternate to r.

    Builds a linear space of r coordinates. Use with dr where r0 is the starting coordinate and dr the step.

    Declaration

    Swift

    public var r0: Anything?
  • dr

    Sets the r coordinate step.

    Declaration

    Swift

    public var dr: Double?

  • Alternate to theta.

    Builds a linear space of theta coordinates. Use with dtheta where theta0 is the starting coordinate and dtheta the step.

    Declaration

    Swift

    public var theta0: Anything?

  • Sets the theta coordinate step.

    By default, the dtheta step equals the subplot’s period divided by the length of the r coordinates.

    Declaration

    Swift

    public var dTheta: Double?

  • Sets the unit of input theta values.

    Has an effect only when on linear angular axes.

    Declaration

    Swift

    public var thetaUnit: ThetaUnit?

  • Sets where the bar base is drawn (in radial axis units).

    In stack barmode, traces that set base will be excluded and drawn in overlay mode instead.

    Declaration

    Swift

    public var base: Data<Anything>?

  • Shifts the angular position where the bar is drawn (in thetatunit units).

    Declaration

    Swift

    public var offset: Data<Double>?

  • Sets the bar angular width (in thetaunit units).

    Declaration

    Swift

    public var width: Data<Double>?

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

  • Undocumented

    Declaration

    Swift

    public var marker: Marker?

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

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

    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?

  • Sets a reference between this trace’s data coordinates and a polar subplot.

    If polar (the default value), the data refer to layout.polar. If polar2, the data refer to layout.polar2, and so on.

    Declaration

    Swift

    public var subplot: Polar

  • Creates BarPolar object from the most frequently used properties.

    Declaration

    Swift

    public init(name: String? = nil, r: RData? = nil, theta: ThetaData? = nil, text: Data<String>? =
        nil, hoverText: Data<String>? = nil, marker: Marker? = nil)

    Parameters

    name

    Sets the trace name.
    r

    Sets the radial coordinates
    theta

    Sets the angular coordinates
    text

    Sets hover text elements associated with each bar.
    hoverText

    Same as text.
    marker

  • Creates BarPolar 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,
        hoverLabel: HoverLabel? = nil, stream: Stream? = nil, transforms: [Transform] = [], uiRevision:
        Anything? = nil, r: RData? = nil, theta: ThetaData? = nil, r0: Anything? = nil, dr: Double? =
        nil, theta0: Anything? = nil, dTheta: Double? = nil, thetaUnit: ThetaUnit? = nil, base:
        Data<Anything>? = nil, offset: Data<Double>? = nil, width: Data<Double>? = nil, text:
        Data<String>? = nil, hoverText: Data<String>? = nil, marker: Marker? = nil, hoverInfo:
        PolarHoverInfo? = nil, hoverTemplate: Data<String>? = nil, selected: Selected? = nil,
        unselected: Unselected? = nil, subplot: Polar = .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.
    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.
    r

    Sets the radial coordinates
    theta

    Sets the angular coordinates
    r0

    Alternate to r.
    dr

    Sets the r coordinate step.
    theta0

    Alternate to theta.
    dTheta

    Sets the theta coordinate step.
    thetaUnit

    Sets the unit of input theta values.
    base

    Sets where the bar base is drawn (in radial axis units).
    offset

    Shifts the angular position where the bar is drawn (in thetatunit units).
    width

    Sets the bar angular width (in thetaunit units).
    text

    Sets hover text elements associated with each bar.
    hoverText

    Same as text.
    marker

    hoverInfo

    Determines which trace information appear on hover.
    hoverTemplate

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

    unselected

    subplot

    Sets a reference between this trace’s data coordinates and a polar subplot.

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws