Annotation

Constructors

Constructor	Description
`new()` Signature: unit -> Annotation

Instance members

Instance member	Description
`align()` Signature: unit -> string	Sets the vertical alignment of the text in the annotation with respect to the set 'x', 'y' position. Has only an effect if the text linked to 'text' spans more two or more lines (using HTML one or more tags).
`align()` Signature: unit -> unit	Sets the vertical alignment of the text in the annotation with respect to the set 'x', 'y' position. Has only an effect if the text linked to 'text' spans more two or more lines (using HTML one or more tags).
`arrowcolor()` Signature: unit -> string	Sets the color of the arrowhead. Has an effect only if 'showarrow' is set to TRUE.
`arrowcolor()` Signature: unit -> unit	Sets the color of the arrowhead. Has an effect only if 'showarrow' is set to TRUE.
`arrowhead()` Signature: unit -> string	Sets the arrowhead style. Has an effect only if 'showarrow' is set to True.
`arrowhead()` Signature: unit -> unit	Sets the arrowhead style. Has an effect only if 'showarrow' is set to True.
`arrowsize()` Signature: unit -> float	Scales the arrowhead's size. Has an effect only if 'showarrow' is set to TRUE.
`arrowsize()` Signature: unit -> unit	Scales the arrowhead's size. Has an effect only if 'showarrow' is set to TRUE.
`arrowwidth()` Signature: unit -> float	Sets the arrowhead's width (in pixels). Has an effect only if 'showarrow' is set to TRUE.
`arrowwidth()` Signature: unit -> unit	Sets the arrowhead's width (in pixels). Has an effect only if 'showarrow' is set to TRUE.
`ax()` Signature: unit -> float	Position of the annotation text relative to the arrowhead about the x-axis. Has an effect only if 'showarrow' is set to TRUE.
`ax()` Signature: unit -> unit	Position of the annotation text relative to the arrowhead about the x-axis. Has an effect only if 'showarrow' is set to TRUE.
`ay()` Signature: unit -> float	Position of the annotation text relative to the arrowhead about the y-axis. Has an effect only if 'showarrow' is set to TRUE.
`ay()` Signature: unit -> unit	Position of the annotation text relative to the arrowhead about the y-axis. Has an effect only if 'showarrow' is set to TRUE.
`bgcolor()` Signature: unit -> string	Sets the background (bg) color of this annotation.
`bgcolor()` Signature: unit -> unit	Sets the background (bg) color of this annotation.
`bordercolor()` Signature: unit -> string	The color of the enclosing boarder of this annotation.
`bordercolor()` Signature: unit -> unit	The color of the enclosing boarder of this annotation.
`borderpad()` Signature: unit -> float	The amount of space (padding) between the text and the enclosing boarder.
`borderpad()` Signature: unit -> unit	The amount of space (padding) between the text and the enclosing boarder.
`borderwidth()` Signature: unit -> float	Sets the width of the boarder enclosing this annotation
`borderwidth()` Signature: unit -> unit	Sets the width of the boarder enclosing this annotation
`font()` Signature: unit -> Font	Links a dictionary describing the font settings within this annotation.
`font()` Signature: unit -> unit	Links a dictionary describing the font settings within this annotation.
`opacity()` Signature: unit -> float	Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant.
`opacity()` Signature: unit -> unit	Sets the opacity, or transparency, of the entire object, also known as the alpha channel of colors. If the object's color is given in terms of 'rgba' color model, 'opacity' is redundant.
`ShouldSerializealign()` Signature: unit -> bool
`ShouldSerializearrowcolor()` Signature: unit -> bool
`ShouldSerializearrowhead()` Signature: unit -> bool
`ShouldSerializearrowsize()` Signature: unit -> bool
`ShouldSerializearrowwidth()` Signature: unit -> bool
`ShouldSerializeax()` Signature: unit -> bool
`ShouldSerializeay()` Signature: unit -> bool
`ShouldSerializebgcolor()` Signature: unit -> bool
`ShouldSerializebordercolor()` Signature: unit -> bool
`ShouldSerializeborderpad()` Signature: unit -> bool
`ShouldSerializeborderwidth()` Signature: unit -> bool
`ShouldSerializefont()` Signature: unit -> bool
`ShouldSerializeopacity()` Signature: unit -> bool
`ShouldSerializeshowarrow()` Signature: unit -> bool
`ShouldSerializetext()` Signature: unit -> bool
`ShouldSerializetextangle()` Signature: unit -> bool
`ShouldSerializex()` Signature: unit -> bool
`ShouldSerializexanchor()` Signature: unit -> bool
`ShouldSerializexref()` Signature: unit -> bool
`ShouldSerializey()` Signature: unit -> bool
`ShouldSerializeyanchor()` Signature: unit -> bool
`ShouldSerializeyref()` Signature: unit -> bool
`showarrow()` Signature: unit -> string	Toggle whether or not the arrow associated with this annotation with be shown. If FALSE, then the text linked to 'text' lines up with the 'x', 'y' coordinates'. If TRUE (the default), then 'text' is placed near the arrow's tail.
`showarrow()` Signature: unit -> unit	Toggle whether or not the arrow associated with this annotation with be shown. If FALSE, then the text linked to 'text' lines up with the 'x', 'y' coordinates'. If TRUE (the default), then 'text' is placed near the arrow's tail.
`text()` Signature: unit -> string	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.}}
`text()` Signature: unit -> unit	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.}}
`textangle()` Signature: unit -> float	Sets the angle of the text linked to 'text' with respect to the horizontal.
`textangle()` Signature: unit -> unit	Sets the angle of the text linked to 'text' with respect to the horizontal.
`x()` Signature: unit -> float	Sets the 'x' position of this annotation. Use in conjunction with 'xref' and 'xanchor' to fine-tune the location of this annotation.
`x()` Signature: unit -> unit	Sets the 'x' position of this annotation. Use in conjunction with 'xref' and 'xanchor' to fine-tune the location of this annotation.
`xanchor()` Signature: unit -> string	Sets the horizontal position anchor of this annotation. That is, bind the position set with the 'x' key to the 'left' or 'center' or 'right' of this annotation. For example, if 'x' is set to 1, 'xref' to 'paper', and 'xanchor' to 'right', the right-most portion of this object will line up with the right-most edge of the plotting area.
`xanchor()` Signature: unit -> unit	Sets the horizontal position anchor of this annotation. That is, bind the position set with the 'x' key to the 'left' or 'center' or 'right' of this annotation. For example, if 'x' is set to 1, 'xref' to 'paper', and 'xanchor' to 'right', the right-most portion of this object will line up with the right-most edge of the plotting area.
`xref()` Signature: unit -> string	Sets the x coordinate system which this object refers to. If you reference an axis, e.g., 'x2', the object will move with pan-and-zoom to stay fixed to this point. If you reference the 'paper', it remains fixed regardless of pan-and-zoom. In other words, if set to 'paper', the 'x' location refers to the distance from the left side of the plotting area in normalized coordinates where 0 is 'left' and 1 is 'right'. If set to refer to an xaxis' , e.g., 'x1', 'x2', 'x3', etc., the 'x' location will refer to the location in terms of this axis.
`xref()` Signature: unit -> unit	Sets the x coordinate system which this object refers to. If you reference an axis, e.g., 'x2', the object will move with pan-and-zoom to stay fixed to this point. If you reference the 'paper', it remains fixed regardless of pan-and-zoom. In other words, if set to 'paper', the 'x' location refers to the distance from the left side of the plotting area in normalized coordinates where 0 is 'left' and 1 is 'right'. If set to refer to an xaxis' , e.g., 'x1', 'x2', 'x3', etc., the 'x' location will refer to the location in terms of this axis.
`y()` Signature: unit -> float	Sets the 'y' position of this annotation. Use in conjunction with 'yref' and 'yanchor' to fine-tune the location of this annotation.
`y()` Signature: unit -> unit	Sets the 'y' position of this annotation. Use in conjunction with 'yref' and 'yanchor' to fine-tune the location of this annotation.
`yanchor()` Signature: unit -> string	Sets the vertical position anchor of this annotation. That is, bind the position set with the 'y' key to the 'bottom' or 'middle' or 'top' of this annotation. For example, if 'y' is set to 1, 'yref' to 'paper', and 'yanchor' to 'top', the top-most portion of this object will line up with the top-most edge of the plotting area.
`yanchor()` Signature: unit -> unit	Sets the vertical position anchor of this annotation. That is, bind the position set with the 'y' key to the 'bottom' or 'middle' or 'top' of this annotation. For example, if 'y' is set to 1, 'yref' to 'paper', and 'yanchor' to 'top', the top-most portion of this object will line up with the top-most edge of the plotting area.
`yref()` Signature: unit -> string	Sets the y coordinate system which this object refers to. If you reference an axis, e.g., 'y2', the object will move with pan-and-zoom to stay fixed to this point. If you reference the 'paper', it remains fixed regardless of pan-and-zoom. In other words, if set to 'paper', the 'y' location refers to the distance from the left side of the plotting area in normalized coordinates where 0 is 'bottom' and 1 is 'top'. If set to refer to an yaxis' , e.g., 'y1', 'y2', 'y3', etc., the 'y' location will refer to the location in terms of this axis.
`yref()` Signature: unit -> unit	Sets the y coordinate system which this object refers to. If you reference an axis, e.g., 'y2', the object will move with pan-and-zoom to stay fixed to this point. If you reference the 'paper', it remains fixed regardless of pan-and-zoom. In other words, if set to 'paper', the 'y' location refers to the distance from the left side of the plotting area in normalized coordinates where 0 is 'bottom' and 1 is 'top'. If set to refer to an yaxis' , e.g., 'y1', 'y2', 'y3', etc., the 'y' location will refer to the location in terms of this axis.

XPlot

Annotation

Constructors

Instance members