Legend Structure Reference


                    
                    
                    backgroundColor

Sets the legend background color.

Defaults to layout.paper_bgcolor.

Declaration

Swift

public var backgroundColor: Color?


                    
                    
                    borderColor

Sets the color of the border enclosing the legend.

Declaration

Swift

public var borderColor: Color?


                    
                    
                    borderWidth

Sets the width (in px) of the border enclosing the legend.

Declaration

Swift

public var borderWidth: Double?


                    
                    
                    font

Sets the font used to text the legend items.

Declaration

Swift

public var font: Font?


                    
                    
                    orientation

Sets the orientation of the legend.

Declaration

Swift

public var orientation: Orientation?


                    
                    
                    TraceOrder

Determines the order at which the legend items are displayed.

If normal, the items are displayed top-to-bottom in the same order as the input data. If reversed, the items are displayed in the opposite order as normal. If grouped, the items are displayed in groups (when a trace legendgroup is provided). if grouped+reversed, the items are displayed in the opposite order as grouped.

Declaration

Swift

public struct TraceOrder : OptionSet, Encodable


                    
                    
                    traceOrder

Determines the order at which the legend items are displayed.

If normal, the items are displayed top-to-bottom in the same order as the input data. If reversed, the items are displayed in the opposite order as normal. If grouped, the items are displayed in groups (when a trace legendgroup is provided). if grouped+reversed, the items are displayed in the opposite order as grouped.

Declaration

Swift

public var traceOrder: TraceOrder?


                    
                    
                    traceGroupGap

Sets the amount of vertical space (in px) between legend groups.

Declaration

Swift

public var traceGroupGap: Double?


                    
                    
                    ItemSizing

Determines if the legend items symbols scale with their corresponding trace attributes or remain constant independent of the symbol size on the graph.

Declaration

Swift

public enum ItemSizing : String, Encodable


                    
                    
                    itemSizing

Determines if the legend items symbols scale with their corresponding trace attributes or remain constant independent of the symbol size on the graph.

Declaration

Swift

public var itemSizing: ItemSizing?


                    
                    
                    itemWidth

Sets the width (in px) of the legend item symbols (the part other than the title.text).

Declaration

Swift

public var itemWidth: Double?


                    
                    
                    ItemClick

Determines the behavior on legend item click.

toggle toggles the visibility of the item clicked on the graph. toggleothers makes the clicked item the sole visible item on the graph. false disable legend item click interactions.

Declaration

Swift

public enum ItemClick : Encodable


                    
                    
                    itemClick

Determines the behavior on legend item click.

toggle toggles the visibility of the item clicked on the graph. toggleothers makes the clicked item the sole visible item on the graph. false disable legend item click interactions.

Declaration

Swift

public var itemClick: ItemClick?


                    
                    
                    ItemDoubleClick

Determines the behavior on legend item double-click.

toggle toggles the visibility of the item clicked on the graph. toggleothers makes the clicked item the sole visible item on the graph. false disable legend item double-click interactions.

Declaration

Swift

public enum ItemDoubleClick : Encodable


                    
                    
                    itemDoubleClick

Determines the behavior on legend item double-click.

toggle toggles the visibility of the item clicked on the graph. toggleothers makes the clicked item the sole visible item on the graph. false disable legend item double-click interactions.

Declaration

Swift

public var itemDoubleClick: ItemDoubleClick?

Sets the x position (in normalized coordinates) of the legend.

Defaults to 1.02 for vertical legends and defaults to 0 for horizontal legends.

Declaration

Swift

public var x: Double?


                    
                    
                    xAnchor

Sets the legend’s horizontal position anchor.

This anchor binds the x position to the left, center or right of the legend. Value auto anchors legends to the right for x values greater than or equal to 2/3, anchors legends to the left for x values less than or equal to 1/3 and anchors legends with respect to their center otherwise.

Declaration

Swift

public var xAnchor: XAutoAnchor?

Sets the y position (in normalized coordinates) of the legend.

Defaults to 1 for vertical legends, defaults to -0.1 for horizontal legends on graphs w/o range sliders and defaults to 1.1 for horizontal legends on graph with one or multiple range sliders.

Declaration

Swift

public var y: Double?


                    
                    
                    yAnchor

Sets the legend’s vertical position anchor This anchor binds the y position to the top, middle or bottom of the legend.

Value auto anchors legends at their bottom for y values less than or equal to 1/3, anchors legends to at their top for y values greater than or equal to 2/3 and anchors legends with respect to their middle otherwise.

Declaration

Swift

public var yAnchor: YAutoAnchor?


                    
                    
                    uiRevision

Controls persistence of legend-driven changes in trace and pie label visibility.

Defaults to layout.uirevision.

Declaration

Swift

public var uiRevision: Anything?


                    
                    
                    verticalAlign

Sets the vertical alignment of the symbols with respect to their associated text.

Declaration

Swift

public var verticalAlign: VerticalAlign?


                    
                    
                    title

Undocumented

Declaration

Swift

public var title: LegendTitle?


                    
                    
                    init(backgroundColor:borderColor:borderWidth:font:orientation:traceOrder:traceGroupGap:itemSizing:itemWidth:itemClick:itemDoubleClick:x:xAnchor:y:yAnchor:uiRevision:verticalAlign:title:)

Creates Legend object with specified properties.

Declaration

Swift

public init(backgroundColor: Color? = nil, borderColor: Color? = nil, borderWidth: Double? =
        nil, font: Font? = nil, orientation: Orientation? = nil, traceOrder: TraceOrder? = nil,
        traceGroupGap: Double? = nil, itemSizing: ItemSizing? = nil, itemWidth: Double? = nil,
        itemClick: ItemClick? = nil, itemDoubleClick: ItemDoubleClick? = nil, x: Double? = nil, xAnchor:
        XAutoAnchor? = nil, y: Double? = nil, yAnchor: YAutoAnchor? = nil, uiRevision: Anything? = nil,
        verticalAlign: VerticalAlign? = nil, title: LegendTitle? = nil)

Parameters

`backgroundColor`	Sets the legend background color.
`borderColor`	Sets the color of the border enclosing the legend.
`borderWidth`	Sets the width (in px) of the border enclosing the legend.
`font`	Sets the font used to text the legend items.
`orientation`	Sets the orientation of the legend.
`traceOrder`	Determines the order at which the legend items are displayed.
`traceGroupGap`	Sets the amount of vertical space (in px) between legend groups.
`itemSizing`	Determines if the legend items symbols scale with their corresponding trace attributes or remain constant independent of the symbol size on the graph.
`itemWidth`	Sets the width (in px) of the legend item symbols (the part other than the title.text).
`itemClick`	Determines the behavior on legend item click.
`itemDoubleClick`	Determines the behavior on legend item double-click.
`x`	Sets the x position (in normalized coordinates) of the legend.
`xAnchor`	Sets the legend’s horizontal position anchor.
`y`	Sets the y position (in normalized coordinates) of the legend.
`yAnchor`	Sets the legend’s vertical position anchor This anchor binds the `y` position to the top, middle or bottom of the legend.
`uiRevision`	Controls persistence of legend-driven changes in trace and pie label visibility.
`verticalAlign`	Sets the vertical alignment of the symbols with respect to their associated text.
`title`