Hoverlabel Type

Namespace: Plotly.NET.LayoutObjects
Assembly: Plotly.NET.dll
Base Type: DynamicObj
All Interfaces: IDynamicMetaObjectProvider

Hoverlabels that appear while hovering over elements on charts

Constructors

Constructor Description

Hoverlabel()

Full Usage: Hoverlabel()

Returns: Hoverlabel

Returns: Hoverlabel

Static members

Static member Description

Hoverlabel.init (?Align, ?BgColor, ?BorderColor, ?Font, ?GroupTitleFont, ?Namelength)

Full Usage: Hoverlabel.init (?Align, ?BgColor, ?BorderColor, ?Font, ?GroupTitleFont, ?Namelength)

Parameters:
    ?Align : Align - Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    ?BgColor : Color - Sets the background color of all hover labels on graph
    ?BorderColor : Color - Sets the border color of all hover labels on graph.
    ?Font : Font - Sets the default hover label font used by all traces on the graph.
    ?GroupTitleFont : Font - Sets the font for group titles in hover (unified modes). Defaults to `hoverlabel.font`.
    ?Namelength : int - Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.

Returns: Hoverlabel

Returns a new Hoverlabel object with the given styles

?Align : Align

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

?BgColor : Color

Sets the background color of all hover labels on graph

?BorderColor : Color

Sets the border color of all hover labels on graph.

?Font : Font

Sets the default hover label font used by all traces on the graph.

?GroupTitleFont : Font

Sets the font for group titles in hover (unified modes). Defaults to `hoverlabel.font`.

?Namelength : int

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.

Returns: Hoverlabel

Hoverlabel.style (?BgColor, ?BorderColor, ?Font, ?GroupTitleFont, ?Align, ?Namelength)

Full Usage: Hoverlabel.style (?BgColor, ?BorderColor, ?Font, ?GroupTitleFont, ?Align, ?Namelength)

Parameters:
    ?BgColor : Color - Sets the background color of all hover labels on graph
    ?BorderColor : Color - Sets the border color of all hover labels on graph.
    ?Font : Font - Sets the default hover label font used by all traces on the graph.
    ?GroupTitleFont : Font - Sets the font for group titles in hover (unified modes). Defaults to `hoverlabel.font`.
    ?Align : Align - Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines
    ?Namelength : int - Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.

Returns: Hoverlabel -> Hoverlabel

Returns a function that applies the given styles to a Legend object

?BgColor : Color

Sets the background color of all hover labels on graph

?BorderColor : Color

Sets the border color of all hover labels on graph.

?Font : Font

Sets the default hover label font used by all traces on the graph.

?GroupTitleFont : Font

Sets the font for group titles in hover (unified modes). Defaults to `hoverlabel.font`.

?Align : Align

Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

?Namelength : int

Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.

Returns: Hoverlabel -> Hoverlabel