HoverLabel

public struct HoverLabel : Encodable

Note

Used by Layout.hoverLabel, Scatter<XData, YData>.hoverLabel, Bar<XData, YData>.hoverLabel, Box<YData, XData, QData>.hoverLabel, Heatmap<ZData, XYData>.hoverLabel, Histogram<XData, YData>.hoverLabel, Histogram2D<XData, YData, ZData>.hoverLabel, Histogram2DContour<XData, YData, ZData>.hoverLabel, Contour<ZData, XData, YData>.hoverLabel, ScatterTernary<AData, BData, CData>.hoverLabel, Violin<YData, XData>.hoverLabel, Funnel<XData, YData>.hoverLabel, Waterfall<XData, YData>.hoverLabel, Image<ZData>.hoverLabel, Pie<LabelsData, ValuesData>.hoverLabel, Sunburst<ValuesData>.hoverLabel, Treemap<ValuesData>.hoverLabel, FunnelArea<LabelsData, ValuesData>.hoverLabel, Scatter3D<XData, YData, ZData>.hoverLabel, Surface<ZSurfaceData, XYData>.hoverLabel, Isosurface<XData, YData, ZData, ValueData>.hoverLabel, Volume<XYZData, ValueData>.hoverLabel, Mesh3D<XData, YData, ZData, IntensityData, VertexcolorData, FacecolorData>.hoverLabel, Cone<XYZData, UVWData>.hoverLabel, StreamTube<XYZData, UVWData>.hoverLabel, ScatterGeo<CoordinateData, LocationsData>.hoverLabel, Choropleth<LocationsData, ZData>.hoverLabel, ScatterGL<XData, YData>.hoverLabel, ScatterPlotMatrix.hoverLabel, PointCloud<XYData>.hoverLabel, HeatmapGL<ZData, XYData>.hoverLabel, ScatterMapbox<CoordinateData>.hoverLabel, ChoroplethMapbox<LocationsData, ZData>.hoverLabel, DensityMapbox<CoordinateData, ZData>.hoverLabel, Sankey.hoverLabel, Sankey.Node.hoverLabel, Sankey.Link.hoverLabel, Table<CellData>.hoverLabel, ScatterCarpet<AData, BData>.hoverLabel, ScatterPolar<RData, ThetaData>.hoverLabel, ScatterPolarGL<RData, ThetaData>.hoverLabel, BarPolar<RData, ThetaData>.hoverLabel.

  • Sets the background color of all hover labels on graph

    Declaration

    Swift

    public var backgroundColor: Color?

  • Sets the border color of all hover labels on graph.

    Declaration

    Swift

    public var borderColor: Color?

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

    Declaration

    Swift

    public var font: Font?

  • 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

    Declaration

    Swift

    public var align: AutoAlign?

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

    Declaration

    Swift

    public var nameLength: Int?

  • Creates HoverLabel object with specified properties.

    Declaration

    Swift

    public init(backgroundColor: Color? = nil, borderColor: Color? = nil, font: Font? = nil, align:
        AutoAlign? = nil, nameLength: Int? = nil)

    Parameters

    backgroundColor

    Sets the background color of all hover labels on graph
    borderColor

    Sets the border color of all hover labels on graph.
    font

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

    Sets the horizontal alignment of the text content within hover label box.
    nameLength

    Sets the default length (in number of characters) of the trace name in the hover labels for all traces.