-
- All Implemented Interfaces:
-
com.patrykandpatrick.vico.core.component.dimension.Padding,com.patrykandpatrick.vico.core.dimensions.BoundsAware,com.patrykandpatrick.vico.core.legend.Legend
public class HorizontalLegend implements Legend, Padding
HorizontalLegend displays legend items beside one another in lines.
-
-
Field Summary
Fields Modifier and Type Field Description private final RectFboundsprivate Collection<LegendItem>itemsprivate FloaticonSizeDpprivate FloaticonPaddingDpprivate FloatlineSpacingDpprivate FloatspacingDpprivate final MutableDimensionspadding
-
Constructor Summary
Constructors Constructor Description HorizontalLegend(Collection<LegendItem> items, Float iconSizeDp, Float iconPaddingDp, Float lineSpacingDp, Float spacingDp, MutableDimensions padding)
-
Method Summary
Modifier and Type Method Description RectFgetBounds()The bounds of the abstract component. final Collection<LegendItem>getItems()final UnitsetItems(Collection<LegendItem> items)final FloatgetIconSizeDp()final UnitsetIconSizeDp(Float iconSizeDp)final FloatgetIconPaddingDp()final UnitsetIconPaddingDp(Float iconPaddingDp)final FloatgetLineSpacingDp()final UnitsetLineSpacingDp(Float lineSpacingDp)final FloatgetSpacingDp()final UnitsetSpacingDp(Float spacingDp)MutableDimensionsgetPadding()FloatgetHeight(MeasureContext context, Float availableWidth)Returns the height of the legend. Unitdraw(ChartDrawContext context)Draws the legend. -
Methods inherited from class com.patrykandpatrick.vico.core.legend.Legend
setBounds -
Methods inherited from class com.patrykandpatrick.vico.core.legend.HorizontalLegend
setPadding, setPadding, setPadding -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
HorizontalLegend
HorizontalLegend(Collection<LegendItem> items, Float iconSizeDp, Float iconPaddingDp, Float lineSpacingDp, Float spacingDp, MutableDimensions padding)
- Parameters:
items- a Collection of LegendItems to be displayed by this HorizontalLegend.iconSizeDp- defines the size of all LegendItem.icons.iconPaddingDp- defines the padding between each LegendItem.icon and its corresponding LegendItem.label.lineSpacingDp- defines the spacing between adjacent lines.spacingDp- defines the horizontal spacing between adjacent LegendItems.padding- defines the padding of the content.
-
-
Method Detail
-
getItems
final Collection<LegendItem> getItems()
-
setItems
final Unit setItems(Collection<LegendItem> items)
- Parameters:
items- a Collection of LegendItems to be displayed by this HorizontalLegend.
-
getIconSizeDp
final Float getIconSizeDp()
-
setIconSizeDp
final Unit setIconSizeDp(Float iconSizeDp)
- Parameters:
iconSizeDp- defines the size of all LegendItem.icons.
-
getIconPaddingDp
final Float getIconPaddingDp()
-
setIconPaddingDp
final Unit setIconPaddingDp(Float iconPaddingDp)
- Parameters:
iconPaddingDp- defines the padding between each LegendItem.icon and its corresponding LegendItem.label.
-
getLineSpacingDp
final Float getLineSpacingDp()
-
setLineSpacingDp
final Unit setLineSpacingDp(Float lineSpacingDp)
- Parameters:
lineSpacingDp- defines the spacing between adjacent lines.
-
getSpacingDp
final Float getSpacingDp()
-
setSpacingDp
final Unit setSpacingDp(Float spacingDp)
- Parameters:
spacingDp- defines the horizontal spacing between adjacent LegendItems.
-
getPadding
MutableDimensions getPadding()
-
getHeight
Float getHeight(MeasureContext context, Float availableWidth)
Returns the height of the legend.
-
draw
Unit draw(ChartDrawContext context)
Draws the legend.
-
-
-
-