Package 

Class LegendsKt

    • Method Summary

      Modifier and Type Method Description
      final static VerticalLegend verticalLegend(Collection<LegendItem> items, Dp iconSize, Dp iconPadding, Dp spacing, MutableDimensions padding) Creates a VerticalLegend.
      final static LegendItem legendItem(Component icon, TextComponent label, CharSequence labelText) Defines the appearance of an item of a Legend.
      final static LegendItem verticalLegendItem(Component icon, TextComponent label, CharSequence labelText) Defines the appearance of an item of a VerticalLegend.
      final static HorizontalLegend horizontalLegend(Collection<LegendItem> items, Dp iconSize, Dp iconPadding, Dp lineSpacing, Dp spacing, MutableDimensions padding) Creates a HorizontalLegend.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • verticalLegend

        @Composable() final static VerticalLegend verticalLegend(Collection<LegendItem> items, Dp iconSize, Dp iconPadding, Dp spacing, MutableDimensions padding)

        Creates a VerticalLegend.

        Parameters:
        items - a Collection of LegendItems to be displayed by this VerticalLegend.
        iconSize - defines the size of all LegendItem.icons.
        iconPadding - defines the padding between each LegendItem.icon and its corresponding LegendItem.label.
        spacing - defines the vertical spacing between each LegendItem.
        padding - defines the padding of the content.

      • legendItem

        @Composable() final static LegendItem legendItem(Component icon, TextComponent label, CharSequence labelText)

        Defines the appearance of an item of a Legend.

        Parameters:
        icon - the Component used as the item’s icon.
        label - the TextComponent used for the label.
        labelText - the text content of the label.

      • verticalLegendItem

        @Composable()@Deprecated(message = Use `legendItem` instead., replaceWith = @ReplaceWith(imports = {}, expression = legendItem(icon, label, labelText))) final static LegendItem verticalLegendItem(Component icon, TextComponent label, CharSequence labelText)

        Defines the appearance of an item of a VerticalLegend.

        Parameters:
        icon - the Component used as the item’s icon.
        label - the TextComponent used for the label.
        labelText - the text content of the label.

      • horizontalLegend

        @Composable() final static HorizontalLegend horizontalLegend(Collection<LegendItem> items, Dp iconSize, Dp iconPadding, Dp lineSpacing, Dp spacing, MutableDimensions padding)

        Creates a HorizontalLegend.

        Parameters:
        items - a Collection of LegendItems to be displayed by this HorizontalLegend.
        iconSize - defines the size of all LegendItem.icons.
        iconPadding - defines the padding between each LegendItem.icon and its corresponding LegendItem.label.
        lineSpacing - defines the spacing between adjacent lines.
        spacing - defines the horizontal spacing between adjacent LegendItems.
        padding - defines the padding of the content.