Annotation

public struct Annotation : Encodable

Undocumented

  • Determines whether or not this annotation is visible.

    Declaration

    Swift

    public var visible: Bool?

  • Sets the text associated with this annotation.

    Plotly uses a subset of HTML tags to do things like newline (
    ), bold (), italics (), hyperlinks (). Tags , , are also supported.

    Declaration

    Swift

    public var text: String?

  • Sets the angle at which the text is drawn with respect to the horizontal.

    Declaration

    Swift

    public var textAngle: Angle?

  • Sets the annotation text font.

    Declaration

    Swift

    public var font: Font?

  • Sets an explicit width for the text box.

    null (default) lets the text set the box width. Wider text will be clipped. There is no automatic wrapping; use
    to start a new line.

    Declaration

    Swift

    public var width: Double?

  • Sets an explicit height for the text box.

    null (default) lets the text set the box height. Taller text will be clipped.

    Declaration

    Swift

    public var height: Double?

  • Sets the opacity of the annotation (text + arrow).

    Declaration

    Swift

    public var opacity: Double?

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

    Has an effect only if text spans two or more lines (i.e. text contains one or more
    HTML tags) or if an explicit width is set to override the text width.

    Declaration

    Swift

    public var align: HorizontalAlign?

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

    Has an effect only if an explicit height is set to override the text height.

    Declaration

    Swift

    public var verticalAlign: VerticalAlign?

  • Sets the background color of the annotation.

    Declaration

    Swift

    public var backgroundColor: Color?

  • Sets the color of the border enclosing the annotation text.

    Declaration

    Swift

    public var borderColor: Color?

  • Sets the padding (in px) between the text and the enclosing border.

    Declaration

    Swift

    public var borderPadding: Double?

  • Sets the width (in px) of the border enclosing the annotation text.

    Declaration

    Swift

    public var borderWidth: Double?

  • Determines whether or not the annotation is drawn with an arrow.

    If true, text is placed near the arrow’s tail. If false, text lines up with the x and y provided.

    Declaration

    Swift

    public var showArrow: Bool?

  • Sets the color of the annotation arrow.

    Declaration

    Swift

    public var arrowColor: Color?

  • Sets the end annotation arrow head style.

    Declaration

    Swift

    public var arrowHead: Int?

  • Sets the start annotation arrow head style.

    Declaration

    Swift

    public var startArrowHead: Int?

  • Sets the annotation arrow head position.

    See more

    Declaration

    Swift

    public struct ArrowSide : OptionSet, Encodable

  • Sets the annotation arrow head position.

    Declaration

    Swift

    public var arrowSide: ArrowSide?

  • Sets the size of the end annotation arrow head, relative to arrowwidth.

    A value of 1 (default) gives a head about 3x as wide as the line.

    Declaration

    Swift

    public var arrowSize: Double?

  • Sets the size of the start annotation arrow head, relative to arrowwidth.

    A value of 1 (default) gives a head about 3x as wide as the line.

    Declaration

    Swift

    public var startArrowSize: Double?

  • Sets the width (in px) of annotation arrow line.

    Declaration

    Swift

    public var arrowWidth: Double?

  • Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom.

    Note that this shortens the arrow from the ax / ay vector, in contrast to xshift / yshift which moves everything by this amount.

    Declaration

    Swift

    public var standoff: Double?

  • Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom.

    Note that this shortens the arrow from the ax / ay vector, in contrast to xshift / yshift which moves everything by this amount.

    Declaration

    Swift

    public var startStandoff: Double?
  • ax

    Sets the x component of the arrow tail about the arrow head.

    If axref is pixel, a positive (negative) component corresponds to an arrow pointing from right to left (left to right). If axref is not pixel and is exactly the same as xref, this is an absolute value on that axis, like x, specified in the same coordinates as xref.

    Declaration

    Swift

    public var ax: Anything?
  • ay

    Sets the y component of the arrow tail about the arrow head.

    If ayref is pixel, a positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom). If ayref is not pixel and is exactly the same as yref, this is an absolute value on that axis, like y, specified in the same coordinates as yref.

    Declaration

    Swift

    public var ay: Anything?

  • Indicates in what coordinates the tail of the annotation (ax,ay) is specified.

    If set to a ax axis id (e.g. ax or ax2), the ax position refers to a ax coordinate. If set to paper, the ax position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a ax axis ID followed by domain (separated by a space), the position behaves like for paper, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., ax2 domain refers to the domain of the second ax axis and a ax position of 0.5 refers to the point between the left and the right of the domain of the second ax axis. In order for absolute positioning of the arrow to work, axref must be exactly the same as xref, otherwise axref will revert to pixel (explained next). For relative positioning, axref can be set to pixel, in which case the ax value is specified in pixels relative to x. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.

    See more

    Declaration

    Swift

    public enum AxReference : Encodable

  • Indicates in what coordinates the tail of the annotation (ax,ay) is specified.

    If set to a ax axis id (e.g. ax or ax2), the ax position refers to a ax coordinate. If set to paper, the ax position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a ax axis ID followed by domain (separated by a space), the position behaves like for paper, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., ax2 domain refers to the domain of the second ax axis and a ax position of 0.5 refers to the point between the left and the right of the domain of the second ax axis. In order for absolute positioning of the arrow to work, axref must be exactly the same as xref, otherwise axref will revert to pixel (explained next). For relative positioning, axref can be set to pixel, in which case the ax value is specified in pixels relative to x. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.

    Declaration

    Swift

    public var axReference: AxReference?

  • Indicates in what coordinates the tail of the annotation (ax,ay) is specified.

    If set to a ay axis id (e.g. ay or ay2), the ay position refers to a ay coordinate. If set to paper, the ay position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a ay axis ID followed by domain (separated by a space), the position behaves like for paper, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., ay2 domain refers to the domain of the second ay axis and a ay position of 0.5 refers to the point between the bottom and the top of the domain of the second ay axis. In order for absolute positioning of the arrow to work, ayref must be exactly the same as yref, otherwise ayref will revert to pixel (explained next). For relative positioning, ayref can be set to pixel, in which case the ay value is specified in pixels relative to y. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.

    See more

    Declaration

    Swift

    public enum AyReference : Encodable

  • Indicates in what coordinates the tail of the annotation (ax,ay) is specified.

    If set to a ay axis id (e.g. ay or ay2), the ay position refers to a ay coordinate. If set to paper, the ay position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a ay axis ID followed by domain (separated by a space), the position behaves like for paper, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., ay2 domain refers to the domain of the second ay axis and a ay position of 0.5 refers to the point between the bottom and the top of the domain of the second ay axis. In order for absolute positioning of the arrow to work, ayref must be exactly the same as yref, otherwise ayref will revert to pixel (explained next). For relative positioning, ayref can be set to pixel, in which case the ay value is specified in pixels relative to y. Absolute positioning is useful for trendline annotations which should continue to indicate the correct trend when zoomed. Relative positioning is useful for specifying the text offset for an annotated point.

    Declaration

    Swift

    public var ayReference: AyReference?

  • Sets the annotation’s x coordinate axis.

    If set to a x axis id (e.g. x or x2), the x position refers to a x coordinate. If set to paper, the x position refers to the distance from the left of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right). If set to a x axis ID followed by domain (separated by a space), the position behaves like for paper, but refers to the distance in fractions of the domain length from the left of the domain of that axis: e.g., x2 domain refers to the domain of the second x axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis.

    Declaration

    Swift

    public var xReference: XAxisReference?
  • x

    Sets the annotation’s x position.

    If the axis type is log, then you must take the log of your desired range. If the axis type is date, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is category, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

    Declaration

    Swift

    public var x: Anything?

  • Sets the text box’s horizontal position anchor This anchor binds the x position to the left, center or right of the annotation.

    For example, if x is set to 1, xref to paper and xanchor to right then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If auto, the anchor is equivalent to center for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.

    Declaration

    Swift

    public var xAnchor: XAutoAnchor?

  • Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.

    Declaration

    Swift

    public var xShift: Double?

  • Sets the annotation’s y coordinate axis.

    If set to a y axis id (e.g. y or y2), the y position refers to a y coordinate. If set to paper, the y position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top). If set to a y axis ID followed by domain (separated by a space), the position behaves like for paper, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., y2 domain refers to the domain of the second y axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.

    Declaration

    Swift

    public var yReference: YAxisReference?
  • y

    Sets the annotation’s y position.

    If the axis type is log, then you must take the log of your desired range. If the axis type is date, it should be date strings, like date data, though Date objects and unix milliseconds will be accepted and converted to strings. If the axis type is category, it should be numbers, using the scale where each category is assigned a serial number from zero in the order it appears.

    Declaration

    Swift

    public var y: Anything?

  • Sets the text box’s vertical position anchor This anchor binds the y position to the top, middle or bottom of the annotation.

    For example, if y is set to 1, yref to paper and yanchor to top then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If auto, the anchor is equivalent to middle for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.

    Declaration

    Swift

    public var yAnchor: YAutoAnchor?

  • Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.

    Declaration

    Swift

    public var yShift: Double?

  • Makes this annotation respond to clicks on the plot.

    If you click a data point that exactly matches the x and y values of this annotation, and it is hidden (visible: false), it will appear. In onoff mode, you must click the same point again to make it disappear, so if you click multiple points, you can show multiple annotations. In onout mode, a click anywhere else in the plot (on another data point or not) will hide this annotation. If you need to show/hide this annotation in response to different x or y values, you can set xclick and/or yclick. This is useful for example to label the side of a bar. To label markers though, standoff is preferred over xclick and yclick.

    See more

    Declaration

    Swift

    public enum ClickToShow : Encodable

  • Makes this annotation respond to clicks on the plot.

    If you click a data point that exactly matches the x and y values of this annotation, and it is hidden (visible: false), it will appear. In onoff mode, you must click the same point again to make it disappear, so if you click multiple points, you can show multiple annotations. In onout mode, a click anywhere else in the plot (on another data point or not) will hide this annotation. If you need to show/hide this annotation in response to different x or y values, you can set xclick and/or yclick. This is useful for example to label the side of a bar. To label markers though, standoff is preferred over xclick and yclick.

    Declaration

    Swift

    public var clickToShow: ClickToShow?

  • Toggle this annotation when clicking a data point whose x value is xclick rather than the annotation’s x value.

    Declaration

    Swift

    public var xClick: Anything?

  • Toggle this annotation when clicking a data point whose y value is yclick rather than the annotation’s y value.

    Declaration

    Swift

    public var yClick: Anything?

  • Sets text to appear when hovering over this annotation.

    If omitted or blank, no hover label will appear.

    Declaration

    Swift

    public var hoverText: String?

  • Undocumented

    See more

    Declaration

    Swift

    public struct HoverLabel : Encodable

  • Undocumented

    Declaration

    Swift

    public var hoverLabel: HoverLabel?

  • Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation.

    By default captureevents is false unless hovertext is provided. If you use the event plotly_clickannotation without hovertext you must explicitly enable captureevents.

    Declaration

    Swift

    public var captureEvents: Bool?

  • When used in a template, named items are created in the output figure in addition to any items the figure already has in this array.

    You can modify these items in the output figure by making your own item with templateitemname matching this name alongside your modifications (including visible: false or enabled: false to hide it). Has no effect outside of a template.

    Declaration

    Swift

    public var name: String?

  • Used to refer to a named item in this array in the template.

    Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with templateitemname matching its name, alongside your modifications (including visible: false or enabled: false to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with visible: true.

    Declaration

    Swift

    public var templateItemName: String?

  • Creates Annotation object with specified properties.

    Declaration

    Swift

    public init(visible: Bool? = nil, text: String? = nil, textAngle: Angle? = nil, font: Font? =
        nil, width: Double? = nil, height: Double? = nil, opacity: Double? = nil, align:
        HorizontalAlign? = nil, verticalAlign: VerticalAlign? = nil, backgroundColor: Color? = nil,
        borderColor: Color? = nil, borderPadding: Double? = nil, borderWidth: Double? = nil, showArrow:
        Bool? = nil, arrowColor: Color? = nil, arrowHead: Int? = nil, startArrowHead: Int? = nil,
        arrowSide: ArrowSide? = nil, arrowSize: Double? = nil, startArrowSize: Double? = nil,
        arrowWidth: Double? = nil, standoff: Double? = nil, startStandoff: Double? = nil, ax: Anything?
        = nil, ay: Anything? = nil, axReference: AxReference? = nil, ayReference: AyReference? = nil,
        xReference: XAxisReference? = nil, x: Anything? = nil, xAnchor: XAutoAnchor? = nil, xShift:
        Double? = nil, yReference: YAxisReference? = nil, y: Anything? = nil, yAnchor: YAutoAnchor? =
        nil, yShift: Double? = nil, clickToShow: ClickToShow? = nil, xClick: Anything? = nil, yClick:
        Anything? = nil, hoverText: String? = nil, hoverLabel: HoverLabel? = nil, captureEvents: Bool? =
        nil, name: String? = nil, templateItemName: String? = nil)

    Parameters

    visible

    Determines whether or not this annotation is visible.
    text

    Sets the text associated with this annotation.
    textAngle

    Sets the angle at which the text is drawn with respect to the horizontal.
    font

    Sets the annotation text font.
    width

    Sets an explicit width for the text box.
    height

    Sets an explicit height for the text box.
    opacity

    Sets the opacity of the annotation (text + arrow).
    align

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

    Sets the vertical alignment of the text within the box.
    backgroundColor

    Sets the background color of the annotation.
    borderColor

    Sets the color of the border enclosing the annotation text.
    borderPadding

    Sets the padding (in px) between the text and the enclosing border.
    borderWidth

    Sets the width (in px) of the border enclosing the annotation text.
    showArrow

    Determines whether or not the annotation is drawn with an arrow.
    arrowColor

    Sets the color of the annotation arrow.
    arrowHead

    Sets the end annotation arrow head style.
    startArrowHead

    Sets the start annotation arrow head style.
    arrowSide

    Sets the annotation arrow head position.
    arrowSize

    Sets the size of the end annotation arrow head, relative to arrowwidth.
    startArrowSize

    Sets the size of the start annotation arrow head, relative to arrowwidth.
    arrowWidth

    Sets the width (in px) of annotation arrow line.
    standoff

    Sets a distance, in pixels, to move the end arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom.
    startStandoff

    Sets a distance, in pixels, to move the start arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom.
    ax

    Sets the x component of the arrow tail about the arrow head.
    ay

    Sets the y component of the arrow tail about the arrow head.
    axReference

    Indicates in what coordinates the tail of the annotation (ax,ay) is specified.
    ayReference

    Indicates in what coordinates the tail of the annotation (ax,ay) is specified.
    xReference

    Sets the annotation’s x coordinate axis.
    x

    Sets the annotation’s x position.
    xAnchor

    Sets the text box’s horizontal position anchor This anchor binds the x position to the left, center or right of the annotation.
    xShift

    Shifts the position of the whole annotation and arrow to the right (positive) or left (negative) by this many pixels.
    yReference

    Sets the annotation’s y coordinate axis.
    y

    Sets the annotation’s y position.
    yAnchor

    Sets the text box’s vertical position anchor This anchor binds the y position to the top, middle or bottom of the annotation.
    yShift

    Shifts the position of the whole annotation and arrow up (positive) or down (negative) by this many pixels.
    clickToShow

    Makes this annotation respond to clicks on the plot.
    xClick

    Toggle this annotation when clicking a data point whose x value is xclick rather than the annotation’s x value.
    yClick

    Toggle this annotation when clicking a data point whose y value is yclick rather than the annotation’s y value.
    hoverText

    Sets text to appear when hovering over this annotation.
    hoverLabel

    captureEvents

    Determines whether the annotation text box captures mouse move and click events, or allows those events to pass through to data points in the plot that may be behind the annotation.
    name

    When used in a template, named items are created in the output figure in addition to any items the figure already has in this array.
    templateItemName

    Used to refer to a named item in this array in the template.