Indicator

public struct Indicator : Trace, DomainSubplot

An indicator is used to visualize a single value along with some contextual information such as steps or a threshold, using a combination of three visual elements: a number, a delta, and/or a gauge.

Deltas are taken with respect to a reference. Gauges can be either angular or bullet (aka linear) gauges.

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?

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

  • Determines how the value is displayed on the graph.

    number displays the value numerically in text. delta displays the difference to a reference value in text. Finally, gauge displays the value graphically on an axis.

    See more

    Declaration

    Swift

    public struct Mode : OptionSet, Encodable

  • Determines how the value is displayed on the graph.

    number displays the value numerically in text. delta displays the difference to a reference value in text. Finally, gauge displays the value graphically on an axis.

    Declaration

    Swift

    public var mode: Mode?

  • Sets the number to be displayed.

    Declaration

    Swift

    public var value: Double?

  • Sets the horizontal alignment of the text within the box.

    Note that this attribute has no effect if an angular gauge is displayed: in this case, it is always centered

    Declaration

    Swift

    public var align: HorizontalAlign?

  • Declaration

    Swift

    public var domain: Domain?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Title : Encodable

  • Undocumented

    Declaration

    Swift

    public var title: Title?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Number : Encodable

  • Undocumented

    Declaration

    Swift

    public var number: Number?

  • Undocumented

    See more

    Declaration

    Swift

    public struct Delta : Encodable

  • Undocumented

    Declaration

    Swift

    public var delta: Delta?

  • The gauge of the Indicator plot.

    See more

    Declaration

    Swift

    public struct Gauge : Encodable

  • The gauge of the Indicator plot.

    Declaration

    Swift

    public var gauge: Gauge?

  • Creates Indicator object from the most frequently used properties.

    Declaration

    Swift

    public init(name: String? = nil, mode: Mode? = nil)

    Parameters

    name

    Sets the trace name.
    mode

    Determines how the value is displayed on the graph.

  • Creates Indicator object with specified properties.

    Declaration

    Swift

    public init(visible: Visible? = nil, name: String? = nil, uid: String? = nil, ids: [String]? =
        nil, customData: [String]? = nil, meta: Data<Anything>? = nil, stream: Stream? = nil,
        transforms: [Transform] = [], uiRevision: Anything? = nil, mode: Mode? = nil, value: Double? =
        nil, align: HorizontalAlign? = nil, domain: Domain? = nil, title: Title? = nil, number: Number?
        = nil, delta: Delta? = nil, gauge: Gauge? = nil)

    Parameters

    visible

    Determines whether or not this trace is visible.
    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.
    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.
    mode

    Determines how the value is displayed on the graph.
    value

    Sets the number to be displayed.
    align

    Sets the horizontal alignment of the text within the box.
    domain

    title

    number

    delta

    gauge

    The gauge of the Indicator plot.

  • Encodes the object in a format compatible with Plotly.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws