Annotation

Namespace: XPlot.Plotly
Parent Module: Graph

Constructors

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

Instance members

Instance member	Description
`x.align()` Signature: unit -> obj	Sets the vertical alignment of the `text` with respect to the set `x` and `y` position. Has only an effect if `text` spans more two or more lines (i.e. `text` contains one or more HTML tags). CompiledName: `set_align`
`x.align()` Signature: unit -> unit	Sets the vertical alignment of the `text` with respect to the set `x` and `y` position. Has only an effect if `text` spans more two or more lines (i.e. `text` contains one or more HTML tags). CompiledName: `get_align`
`x.arrowcolor()` Signature: unit -> string	Sets the color of the annotation arrow. CompiledName: `set_arrowcolor`
`x.arrowcolor()` Signature: unit -> unit	Sets the color of the annotation arrow. CompiledName: `get_arrowcolor`
`x.arrowhead()` Signature: unit -> int	Sets the annotation arrow head style. CompiledName: `set_arrowhead`
`x.arrowhead()` Signature: unit -> unit	Sets the annotation arrow head style. CompiledName: `get_arrowhead`
`x.arrowsize()` Signature: unit -> float	Sets the size (in px) of annotation arrow head. CompiledName: `set_arrowsize`
`x.arrowsize()` Signature: unit -> unit	Sets the size (in px) of annotation arrow head. CompiledName: `get_arrowsize`
`x.arrowwidth()` Signature: unit -> float	Sets the width (in px) of annotation arrow. CompiledName: `set_arrowwidth`
`x.arrowwidth()` Signature: unit -> unit	Sets the width (in px) of annotation arrow. CompiledName: `get_arrowwidth`
`x.ax()` Signature: unit -> float	Sets the x component of the arrow tail about the arrow head. A positive (negative) component corresponds to an arrow pointing from right to left (left to right) CompiledName: `set_ax`
`x.ax()` Signature: unit -> unit	Sets the x component of the arrow tail about the arrow head. A positive (negative) component corresponds to an arrow pointing from right to left (left to right) CompiledName: `get_ax`
`x.ay()` Signature: unit -> float	Sets the y component of the arrow tail about the arrow head. A positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom) CompiledName: `set_ay`
`x.ay()` Signature: unit -> unit	Sets the y component of the arrow tail about the arrow head. A positive (negative) component corresponds to an arrow pointing from bottom to top (top to bottom) CompiledName: `get_ay`
`x.bgcolor()` Signature: unit -> string	Sets the background color of the annotation. CompiledName: `set_bgcolor`
`x.bgcolor()` Signature: unit -> unit	Sets the background color of the annotation. CompiledName: `get_bgcolor`
`x.bordercolor()` Signature: unit -> string	Sets the color of the border enclosing the annotation `text`. CompiledName: `set_bordercolor`
`x.bordercolor()` Signature: unit -> unit	Sets the color of the border enclosing the annotation `text`. CompiledName: `get_bordercolor`
`x.borderpad()` Signature: unit -> float	Sets the padding (in px) between the `text` and the enclosing border. CompiledName: `set_borderpad`
`x.borderpad()` Signature: unit -> unit	Sets the padding (in px) between the `text` and the enclosing border. CompiledName: `get_borderpad`
`x.borderwidth()` Signature: unit -> float	Sets the width (in px) of the border enclosing the annotation `text`. CompiledName: `set_borderwidth`
`x.borderwidth()` Signature: unit -> unit	Sets the width (in px) of the border enclosing the annotation `text`. CompiledName: `get_borderwidth`
`x.font()` Signature: unit -> Font	CompiledName: `set_font`
`x.font()` Signature: unit -> unit	CompiledName: `get_font`
`x.opacity()` Signature: unit -> float	Sets the opacity of the annotation (text + arrow). CompiledName: `set_opacity`
`x.opacity()` Signature: unit -> unit	Sets the opacity of the annotation (text + arrow). CompiledName: `get_opacity`
`x.ShouldSerializealign()` Signature: unit -> bool
`x.ShouldSerializearrowcolor()` Signature: unit -> bool
`x.ShouldSerializearrowhead()` Signature: unit -> bool
`x.ShouldSerializearrowsize()` Signature: unit -> bool
`x.ShouldSerializearrowwidth()` Signature: unit -> bool
`x.ShouldSerializeax()` Signature: unit -> bool
`x.ShouldSerializeay()` Signature: unit -> bool
`x.ShouldSerializebgcolor()` Signature: unit -> bool
`x.ShouldSerializebordercolor()` Signature: unit -> bool
`x.ShouldSerializeborderpad()` Signature: unit -> bool
`x.ShouldSerializeborderwidth()` Signature: unit -> bool
`x.ShouldSerializefont()` Signature: unit -> bool
`x.ShouldSerializeopacity()` Signature: unit -> bool
`x.ShouldSerializeshowarrow()` Signature: unit -> bool
`x.ShouldSerializetext()` Signature: unit -> bool
`x.ShouldSerializetextangle()` Signature: unit -> bool
`x.ShouldSerializex()` Signature: unit -> bool
`x.ShouldSerializexanchor()` Signature: unit -> bool
`x.ShouldSerializexref()` Signature: unit -> bool
`x.ShouldSerializey()` Signature: unit -> bool
`x.ShouldSerializeyanchor()` Signature: unit -> bool
`x.ShouldSerializeyref()` Signature: unit -> bool
`x.showarrow()` Signature: unit -> bool	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. CompiledName: `set_showarrow`
`x.showarrow()` Signature: unit -> unit	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. CompiledName: `get_showarrow`
`x.text()` Signature: unit -> string	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.}} CompiledName: `set_text`
`x.text()` Signature: unit -> unit	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.}} CompiledName: `get_text`
`x.textangle()` Signature: unit -> float	Sets the angle at which the `text` is drawn with respect to the horizontal. CompiledName: `set_textangle`
`x.textangle()` Signature: unit -> unit	Sets the angle at which the `text` is drawn with respect to the horizontal. CompiledName: `get_textangle`
`x.x()` Signature: unit -> obj	Sets the annotation's x position. Note that dates and categories are converted to numbers. CompiledName: `set_x`
`x.x()` Signature: unit -> unit	Sets the annotation's x position. Note that dates and categories are converted to numbers. CompiledName: `get_x`
`x.xanchor()` Signature: unit -> obj	Sets the annotation'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 whereas for paper-referenced, the anchor picked corresponds to the closest side. CompiledName: `set_xanchor`
`x.xanchor()` Signature: unit -> unit	Sets the annotation'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 whereas for paper-referenced, the anchor picked corresponds to the closest side. CompiledName: `get_xanchor`
`x.xref()` Signature: unit -> obj	Sets the annotation's x coordinate axis. If set to an x axis id (e.g. x or x2), the `x` position refers to an x coordinate If set to paper, the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right) side. CompiledName: `set_xref`
`x.xref()` Signature: unit -> unit	Sets the annotation's x coordinate axis. If set to an x axis id (e.g. x or x2), the `x` position refers to an x coordinate If set to paper, the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right) side. CompiledName: `get_xref`
`x.y()` Signature: unit -> obj	Sets the annotation's y position. Note that dates and categories are converted to numbers. CompiledName: `set_y`
`x.y()` Signature: unit -> unit	Sets the annotation's y position. Note that dates and categories are converted to numbers. CompiledName: `get_y`
`x.yanchor()` Signature: unit -> obj	Sets the annotation'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 whereas for paper-referenced, the anchor picked corresponds to the closest side. CompiledName: `set_yanchor`
`x.yanchor()` Signature: unit -> unit	Sets the annotation'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 whereas for paper-referenced, the anchor picked corresponds to the closest side. CompiledName: `get_yanchor`
`x.yref()` Signature: unit -> obj	Sets the annotation's y coordinate axis. If set to an y axis id (e.g. y or y2), the `y` position refers to an 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). CompiledName: `set_yref`
`x.yref()` Signature: unit -> unit	Sets the annotation's y coordinate axis. If set to an y axis id (e.g. y or y2), the `y` position refers to an 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). CompiledName: `get_yref`