XPlot


Annotation Type

Namespace: XPlot.Plotly

Assembly: XPlot.Plotly.dll

Base Type: obj

Constructors

Constructor Description

Annotation()

Full Usage: Annotation()

Returns: Annotation

Returns: Annotation

Instance members

Instance member Description

this.ShouldSerializealign()

Full Usage: this.ShouldSerializealign()

Returns: bool

Returns: bool

this.ShouldSerializearrowcolor()

Full Usage: this.ShouldSerializearrowcolor()

Returns: bool

Returns: bool

this.ShouldSerializearrowhead()

Full Usage: this.ShouldSerializearrowhead()

Returns: bool

Returns: bool

this.ShouldSerializearrowsize()

Full Usage: this.ShouldSerializearrowsize()

Returns: bool

Returns: bool

this.ShouldSerializearrowwidth()

Full Usage: this.ShouldSerializearrowwidth()

Returns: bool

Returns: bool

this.ShouldSerializeax()

Full Usage: this.ShouldSerializeax()

Returns: bool

Returns: bool

this.ShouldSerializeaxref()

Full Usage: this.ShouldSerializeaxref()

Returns: bool

Returns: bool

this.ShouldSerializeay()

Full Usage: this.ShouldSerializeay()

Returns: bool

Returns: bool

this.ShouldSerializeayref()

Full Usage: this.ShouldSerializeayref()

Returns: bool

Returns: bool

this.ShouldSerializebgcolor()

Full Usage: this.ShouldSerializebgcolor()

Returns: bool

Returns: bool

this.ShouldSerializebordercolor()

Full Usage: this.ShouldSerializebordercolor()

Returns: bool

Returns: bool

this.ShouldSerializeborderpad()

Full Usage: this.ShouldSerializeborderpad()

Returns: bool

Returns: bool

this.ShouldSerializeborderwidth()

Full Usage: this.ShouldSerializeborderwidth()

Returns: bool

Returns: bool

this.ShouldSerializefont()

Full Usage: this.ShouldSerializefont()

Returns: bool

Returns: bool

this.ShouldSerializeopacity()

Full Usage: this.ShouldSerializeopacity()

Returns: bool

Returns: bool

this.ShouldSerializeshowarrow()

Full Usage: this.ShouldSerializeshowarrow()

Returns: bool

Returns: bool

this.ShouldSerializetext()

Full Usage: this.ShouldSerializetext()

Returns: bool

Returns: bool

this.ShouldSerializetextangle()

Full Usage: this.ShouldSerializetextangle()

Returns: bool

Returns: bool

this.ShouldSerializex()

Full Usage: this.ShouldSerializex()

Returns: bool

Returns: bool

this.ShouldSerializexanchor()

Full Usage: this.ShouldSerializexanchor()

Returns: bool

Returns: bool

this.ShouldSerializexref()

Full Usage: this.ShouldSerializexref()

Returns: bool

Returns: bool

this.ShouldSerializey()

Full Usage: this.ShouldSerializey()

Returns: bool

Returns: bool

this.ShouldSerializeyanchor()

Full Usage: this.ShouldSerializeyanchor()

Returns: bool

Returns: bool

this.ShouldSerializeyref()

Full Usage: this.ShouldSerializeyref()

Returns: bool

Returns: bool

this.align

Full Usage: this.align

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

this.arrowcolor

Full Usage: this.arrowcolor

Sets the color of the annotation arrow.

this.arrowhead

Full Usage: this.arrowhead

Sets the annotation arrow head style.

this.arrowsize

Full Usage: this.arrowsize

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

this.arrowwidth

Full Usage: this.arrowwidth

Sets the width (in px) of annotation arrow.

this.ax

Full Usage: this.ax

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)

this.axref

Full Usage: this.axref

Sets the annotation's ax coordinate axis. If set to an x axis id (e.g. *x* or *x2*), the `ax` position refers to an x coordinate If set to *paper*, the `ax` 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.

this.ay

Full Usage: this.ay

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)

this.ayref

Full Usage: this.ayref

Sets the annotation's ay coordinate axis. If set to an y axis id (e.g. *y* or *y2*), the `ay` position refers to an y 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).

this.bgcolor

Full Usage: this.bgcolor

Sets the background color of the annotation.

this.bordercolor

Full Usage: this.bordercolor

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

this.borderpad

Full Usage: this.borderpad

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

this.borderwidth

Full Usage: this.borderwidth

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

this.font

Full Usage: this.font

this.opacity

Full Usage: this.opacity

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

this.showarrow

Full Usage: this.showarrow

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.

this.text

Full Usage: this.text

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.

this.textangle

Full Usage: this.textangle

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

this.x

Full Usage: this.x

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

this.xanchor

Full Usage: this.xanchor

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.

this.xref

Full Usage: this.xref

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.

this.y

Full Usage: this.y

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

this.yanchor

Full Usage: this.yanchor

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.

this.yref

Full Usage: this.yref

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