Legends : Legends for variables and samples

# customLegend
Custom legends : Array of objects [{ size : [], shape : [], shapeColor : [], line : [], lineColor : [], lineStart : [], lineEnd : [], text : [], x : number, y : number, title : string, paddingX : number, paddingY : number }]. When legendInside is true, paddingX / paddingY (default 0) inset the legend box from the x,y plotting panel edges so it stays inside for any legendPosition; an explicit x / y pins the legend instead and ignores the padding
Type: array
Default: []

# legendBackgroundBorderColor
Color for the border in legend background
Type: color
Default: rgba(255,255,255,0)

legendBackgroundBorderColor : "#9e0adb"

legendBackgroundBorderColor : "#ff7d00"


# legendBackgroundBorderLineType
Type of line for the border in legend background
Type: string
Default: solid
Options: rect, solid, spline, dotted, dashed, dotdash, longdash, twodash

legendBackgroundBorderLineType : "rect"

legendBackgroundBorderLineType : "dashed"


# legendBackgroundBorderSize
Size for the border line in legend background
Type: float
Default: 0.5

legendBackgroundBorderSize : 2

legendBackgroundBorderSize : 0.5


# legendBackgroundColor
Color for the legend background
Type: color
Default: rgba(255,255,255,0)

legendBackgroundColor : "lightblue"

legendBackgroundColor : "lightgoldenrodyellow"


# legendColumns
Number of columns in legends
Type: integer
Default: 1

legendColumns : 1

legendColumns : 2

legendColumns : 3


# legendDirection
Direction for legend
Type: string
Default: vertical
Options: vertical, horizontal

# legendHorizontalJustification
Horizontal justification (0 left, 0.5 centre, 1 right) for a legend in the top or bottom position. A corner legendPosition supplies its own justification and ignores this. The edge it is measured from is set by legendJustifyTo
Type: float
Default: 0.5

# legendInside
Flag to position the legend inside the graphs
Type: boolean
Default: false

legendInside : true

legendInside : false


# legendJustifyTo
What a justified legend aligns to: the panel (plot area) edge or the whole plot (canvas) edge, like titleAlign plot::0. Applies to every justification of a top or bottom legend, centred included, and to the corner positions
Type: string
Default: panel
Options: panel, plot

legendJustifyTo : "panel"

legendJustifyTo : "plot"


# legendKeyBackgroundBorderColor
Color for the border in legend key background
Type: color
Default: rgba(255,255,255,0)

legendKeyBackgroundBorderColor : "#9e0adb"

legendKeyBackgroundBorderColor : "#ff7d00"


# legendKeyBackgroundBorderLineType
Type of line for the border in legend key background
Type: string
Default: solid
Options: rect, solid, spline, dotted, dashed, dotdash, longdash, twodash

legendKeyBackgroundBorderLineType : "rect"

legendKeyBackgroundBorderLineType : "dotted"


# legendKeyBackgroundBorderSize
Size for the border line in legend key background
Type: float
Default: 1

legendKeyBackgroundBorderSize : 1

legendKeyBackgroundBorderSize : 0.5


# legendKeyBackgroundColor
Color for the legend key background
Type: color
Default: rgba(255,255,255,0)

legendKeyBackgroundColor : "#9e0adb"

legendKeyBackgroundColor : "#ff7d00"


# legendKeyMargin
Width in pixels for the legend key margin
Type: integer
Default: 5

# legendKeySize
Width in pixels for the legend key
Type: integer
Default: 15

legendKeySize : 5

legendKeySize : 50


# legendMax
Maximum number of items in the variable legends. If there are more items the legend will be hidden
Type: integer
Default: 50

legendMax : 2

legendMax : 4


# legendOrder
Object to specify custom order for the levels in the legends. The key of the object is the name of a valid sample or variable annotation included in the data object. The value for element is an array with the levels for the corresponding factor
Type: object
Default:

# legendOrderByCols
Flag to draw legends by columns in the graphs
Type: boolean
Default: true

# legendPosition
Position for the legend. All eight positions work whether the legend is inside or outside the plot. Inside, a corner anchors the legend to that corner of the plotting panel. Outside, the legend gets one band or one column, so a corner is the top or bottom band flush with that side: topLeft / bottomLeft are justified left and topRight / bottomRight right, overriding legendHorizontalJustification; left and right are a column justified by legendVerticalJustification
Type: string
Default: right
Options: topRight, right, bottomRight, bottom, bottomLeft, left, topLeft, top

legendPosition : "right"

legendPosition : "bottom"


# legendPositionAuto
Flag to automatically select the legend position (top or right) that maximizes the area available for the plot. When true the legend dimensions are computed for both candidates and the one that leaves the larger plotting area wins. Ignored when legendPosition is set explicitly in the configuration, when legendInside is true, for a faceted (layout) chart or for cxplot / ggplot specifications
Type: boolean
Default: true

legendPositionAuto : true

legendPositionAuto : false


# legendRows
Number of rows in legends
Type: integer
Default: 1

# legendStyleGgplot
Flag to use ggplot style for the size legends
Type: boolean
Default: false

# legendTextColor
Color for the text in legends
Type: color
Default: rgb(0,0,0)

legendTextColor : "#9e0adb"

legendTextColor : "#ff7d00"


# legendTextFontSize
Font size for the text in legends. Be aware that auto scaling font must be turned off for this property to take effect. A more convenient way to modify the size is to use the legendTextScaleFontFactor
Type: integer
Default: 10

# legendTextFontStyle
Font style for the legends
Type: string
Default:
Options: , bold, italic, bold italic

legendTextFontStyle : "bold"

legendTextFontStyle : "bold italic"


# legendTextMargin
Margin to pad or separate the characters in the legends
Type: float
Default: 8

legendTextMargin : 5

legendTextMargin : 15


# legendTextRotate
Rotation in degrees for the legends
Type: integer
Default:

# legendTextScaleFontFactor
Scaling factor used to increase or decrease the legends font size in the canvas
Type: float
Default: 1

legendTextScaleFontFactor : 0.5

legendTextScaleFontFactor : 1.5


# legendTitleAlign
Alignment (or position) for the legends
Type: string
Default: left
Options: left, center, right

legendTitleAlign : "left"

legendTitleAlign : "center"

legendTitleAlign : "right"


# legendTitleColor
Color for the text in legends
Type: color
Default: rgb(0,0,0)

legendTitleColor : "#9e0adb"

legendTitleColor : "#ff7d00"


# legendTitleFontSize
Font size for the text in legends. Be aware that auto scaling font must be turned off for this property to take effect. A more convenient way to modify the size is to use the legendTitleScaleFontFactor
Type: integer
Default: 10

# legendTitleFontStyle
Font style for the legends
Type: string
Default:
Options: , bold, italic, bold italic

legendTitleFontStyle : "bold"

legendTitleFontStyle : "bold italic"


# legendTitleMargin
Margin to pad or separate the characters in the legends
Type: float
Default: 8

legendTitleMargin : 5

legendTitleMargin : 15


# legendTitleRotate
Rotation in degrees for the legends
Type: integer
Default:

# legendTitleScaleFontFactor
Scaling factor used to increase or decrease the legends font size in the canvas
Type: float
Default: 1

legendTitleScaleFontFactor : 0.5

legendTitleScaleFontFactor : 1.5


# legendVerticalJustification
Vertical justification (0 top, 0.5 middle, 1 bottom) for a legend in the left or right position, down the column the legend reserves. The mirror of legendHorizontalJustification for a side legend
Type: float
Default: 0.5

# showColorEdgeLegend
Flag to show/hide the legend edge color
Type: boolean
Default: true

showColorEdgeLegend : true

showColorEdgeLegend : false


# showColorLabelLegend
Flag to show/hide the legend label color
Type: boolean
Default: true

showColorLabelLegend : true

showColorLabelLegend : false


# showColorLegend
Flag to show/hide the legend color
Type: boolean
Default: true

showColorLegend : true

showColorLegend : false


# showColorNodeLegend
Flag to show/hide the legend node color
Type: boolean
Default: true

showColorNodeLegend : true

showColorNodeLegend : false


# showConnectLegend
Flag to show/hide the legend connect
Type: boolean
Default: true

showConnectLegend : true

showConnectLegend : false


# showLegend
Flag to show/hide the legend
Type: boolean
Default: true

showLegend : true

showLegend : false


# showLegendBorder
Flag to show/hide the the legend border
Type: boolean
Default: true

showLegendBorder : true

showLegendBorder : false


# showLegendTitle
Flag to show/hide the the legend title
Type: boolean
Default: true

showLegendTitle : true

showLegendTitle : false


# showLineEdgeLegend
Flag to show/hide the legend edge line style
Type: boolean
Default: true

# showLineLegend
Flag to show/hide the legend line
Type: boolean
Default: true

showLineLegend : true

showLineLegend : false


# showOutlineLegend
Flag to show/hide the legend outline
Type: boolean
Default: true

# showPatternLegend
Flag to show/hide the legend pattern
Type: boolean
Default: true

showPatternLegend : true

showPatternLegend : false


# showPatternNodeLegend
Flag to show/hide the legend node pattern
Type: boolean
Default: true

showPatternNodeLegend : true

showPatternNodeLegend : false


# showSampleLegend
Flag to show/hide the legend sample
Type: boolean
Default: true

showSampleLegend : true

showSampleLegend : false


# showShapeLegend
Flag to show/hide the legend shape
Type: boolean
Default: true

showShapeLegend : true

showShapeLegend : false


# showShapeNodeLegend
Flag to show/hide the legend node shape
Type: boolean
Default: true

showShapeNodeLegend : true

showShapeNodeLegend : false


# showSizeEdgeLegend
Flag to show/hide the legend edge size
Type: boolean
Default: true

showSizeEdgeLegend : true

showSizeEdgeLegend : false


# showSizeLabelLegend
Flag to show/hide the legend label size
Type: boolean
Default: true

showSizeLabelLegend : true

showSizeLabelLegend : false


# showSizeLegend
Flag to show/hide the legend size
Type: boolean
Default: true

showSizeLegend : true

showSizeLegend : false


# showSizeNodeLegend
Flag to show/hide the legend node size
Type: boolean
Default: true

showSizeNodeLegend : true

showSizeNodeLegend : false


# showVariableLegend
Flag to show/hide the legend variable
Type: boolean
Default: true

showVariableLegend : true

showVariableLegend : false


# sizeLegendNested
Flag to draw the size legend as nested (concentric) bubbles sharing a common bottom edge, with a dashed leader line from each circle to its value label, instead of a column of separate size keys. Applies to proportional-circle size legends (e.g. a sizeBy bubble map or Dorling cartogram)
Type: boolean
Default: false

sizeLegendNested : true

sizeLegendNested : false


⇧