XPlot


Legend

Constructors

ConstructorDescription
new()
Signature: unit -> Legend

Instance members

Instance memberDescription
bgcolor()
Signature: unit -> string

Sets the background (bg) color of the legend.

bgcolor()
Signature: unit -> unit

Sets the background (bg) color of the legend.

bordercolor()
Signature: unit -> string

Sets the enclosing border color for the legend.

bordercolor()
Signature: unit -> unit

Sets the enclosing border color for the legend.

borderwidth()
Signature: unit -> float

Sets the width of the border enclosing for the legend.

borderwidth()
Signature: unit -> unit

Sets the width of the border enclosing for the legend.

font()
Signature: unit -> Font

Links a dictionary describing the font settings within the legend.

font()
Signature: unit -> unit

Links a dictionary describing the font settings within the legend.

ShouldSerializebgcolor()
Signature: unit -> bool
ShouldSerializebordercolor()
Signature: unit -> bool
ShouldSerializeborderwidth()
Signature: unit -> bool
ShouldSerializefont()
Signature: unit -> bool
ShouldSerializetraceorder()
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
traceorder()
Signature: unit -> string

Trace order is set by the order of trace in the data dictionary. The 'traceorder' key sets whether the legend labels are shown from first-to-last trace ('normal') or from last-to-first ('reversed').

traceorder()
Signature: unit -> unit

Trace order is set by the order of trace in the data dictionary. The 'traceorder' key sets whether the legend labels are shown from first-to-last trace ('normal') or from last-to-first ('reversed').

x()
Signature: unit -> float

Sets the 'x' position of this legend. Use in conjunction with 'xref' and 'xanchor' to fine-tune the location of this legend.

x()
Signature: unit -> unit

Sets the 'x' position of this legend. Use in conjunction with 'xref' and 'xanchor' to fine-tune the location of this legend.

xanchor()
Signature: unit -> string

Sets the horizontal position anchor of this legend. That is, bind the position set with the 'x' key to the 'left' or 'center' or 'right' of this legend. 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 legend. That is, bind the position set with the 'x' key to the 'left' or 'center' or 'right' of this legend. 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 legend. Use in conjunction with 'yref' and 'yanchor' to fine-tune the location of this legend.

y()
Signature: unit -> unit

Sets the 'y' position of this legend. Use in conjunction with 'yref' and 'yanchor' to fine-tune the location of this legend.

yanchor()
Signature: unit -> string

Sets the vertical position anchor of this legend. That is, bind the position set with the 'y' key to the 'bottom' or 'middle' or 'top' of this legend. 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 legend. That is, bind the position set with the 'y' key to the 'bottom' or 'middle' or 'top' of this legend. 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.

Fork me on GitHub