XPlot


Annotation

Namespace: XPlot.Plotly
Parent Module: Graph

Constructors

ConstructorDescription
new()
Signature: unit -> Annotation

CompiledName: .ctor

Instance members

Instance memberDescription
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

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

arrowcolor()
Signature: unit -> string

Sets the color of the annotation arrow.

CompiledName: set_arrowcolor

arrowcolor()
Signature: unit -> unit

Sets the color of the annotation arrow.

CompiledName: get_arrowcolor

arrowhead()
Signature: unit -> int

Sets the annotation arrow head style.

CompiledName: set_arrowhead

arrowhead()
Signature: unit -> unit

Sets the annotation arrow head style.

CompiledName: get_arrowhead

arrowsize()
Signature: unit -> float

Sets the size (in px) of annotation arrow head.

CompiledName: set_arrowsize

arrowsize()
Signature: unit -> unit

Sets the size (in px) of annotation arrow head.

CompiledName: get_arrowsize

arrowwidth()
Signature: unit -> float

Sets the width (in px) of annotation arrow.

CompiledName: set_arrowwidth

arrowwidth()
Signature: unit -> unit

Sets the width (in px) of annotation arrow.

CompiledName: get_arrowwidth

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

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

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

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

bgcolor()
Signature: unit -> string

Sets the background color of the annotation.

CompiledName: set_bgcolor

bgcolor()
Signature: unit -> unit

Sets the background color of the annotation.

CompiledName: get_bgcolor

bordercolor()
Signature: unit -> string

Sets the color of the border enclosing the annotation text.

CompiledName: set_bordercolor

bordercolor()
Signature: unit -> unit

Sets the color of the border enclosing the annotation text.

CompiledName: get_bordercolor

borderpad()
Signature: unit -> float

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

CompiledName: set_borderpad

borderpad()
Signature: unit -> unit

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

CompiledName: get_borderpad

borderwidth()
Signature: unit -> float

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

CompiledName: set_borderwidth

borderwidth()
Signature: unit -> unit

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

CompiledName: get_borderwidth

font()
Signature: unit -> Font

CompiledName: set_font

font()
Signature: unit -> unit

CompiledName: get_font

opacity()
Signature: unit -> float

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

CompiledName: set_opacity

opacity()
Signature: unit -> unit

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

CompiledName: get_opacity

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

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

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

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

textangle()
Signature: unit -> float

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

CompiledName: set_textangle

textangle()
Signature: unit -> unit

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

CompiledName: get_textangle

x()
Signature: unit -> obj

Sets the annotation's x position. Note that dates and categories are converted to numbers.

CompiledName: set_x

x()
Signature: unit -> unit

Sets the annotation's x position. Note that dates and categories are converted to numbers.

CompiledName: get_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

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

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

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

y()
Signature: unit -> obj

Sets the annotation's y position. Note that dates and categories are converted to numbers.

CompiledName: set_y

y()
Signature: unit -> unit

Sets the annotation's y position. Note that dates and categories are converted to numbers.

CompiledName: get_y

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

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

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

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

Fork me on GitHub