VerticalLegendLayout Class
Contains methods for displaying items vertically in a legend.
Item Index
Methods
_getLayoutDimensions
()
Object
protected
Positions the legend in a chart and returns the properties of the legend to be used in the chart's layout algorithm.
Returns:
_positionLegendItems
-
items
-
maxWidth
-
maxHeight
-
totalWidth
-
totalHeight
-
padding
-
horizontalGap
-
verticalGap
-
hAlign
-
vAlign
Displays items vertically in a legend.
Parameters:
-
items
ArrayArray of items to display in the legend.
-
maxWidth
NumberThe width of the largest item in the legend.
-
maxHeight
NumberThe height of the largest item in the legend.
-
totalWidth
NumberThe total width of all items in a legend.
-
totalHeight
NumberThe total height of all items in a legend.
-
padding
NumberThe left, top, right and bottom padding properties for the legend.
-
horizontalGap
NumberThe horizontal distance between items in a legend.
-
verticalGap
NumberThe vertical distance between items in a legend.
-
hAlign
StringThe horizontal alignment of the legend.
-
vAlign
StringThe vertical alignment of the legend.
_redraw
()
private
Redraws and position all the components of the chart instance.
_setColumnArrays
-
items
-
limit
-
verticalGap
Creates column and total height arrays used for displaying multiple columns of legend items based on the items, available height and verticalGap for the legend.
Parameters:
-
items
ArrayArray of legend items to display in a legend.
-
limit
NumberTotal available height for displaying items in a legend.
-
verticalGap
NumberVertical distance between items in a legend.
destructor
()
protected
Destructor implementation for the CartesianChart class. Calls destroy on all axes, series, legend (if available) and the Graph instance. Removes the tooltip and overlay HTML elements.
getStartPoint
-
h
-
totalHeight
-
align
-
padding
Returns the starting y-coordinate for a column of legend items.
Parameters:
-
h
NumberHeight of the legend.
-
totalHeight
NumberTotal height of all labels in the column.
-
align
StringVertical alignment of items for the legend.
-
padding
ObjectObject contain left, top, right and bottom padding properties.