Koala Plot Core/io.github.koalaplot.core.bar/BulletBuilderScope

BulletBuilderScope

class BulletBuilderScope

A scope for configuring a bullet graph.

Constructors

BulletBuilderScope

fun BulletBuilderScope()

Types

RangesScope

class RangesScope

A scope for setting range boundaries. See range for specifying a specific range value and its graphical representation.

Functions

comparativeMeasure

fun comparativeMeasure(value: Float, indicator: @Composable () -> Unit = { LineIndicator() })

Sets the comparative measure value and the composable used to draw the indicator. The composable will be centered on the value with a width and height equal to the height of the BulletGraph background fill area.

featuredMeasureBar

fun featuredMeasureBar(value: Float, indicator: @Composable () -> Unit = { HorizontalBarIndicator(SolidColor(MaterialTheme.colors.primary), fraction = FeaturedMeasureDefaultSize) })

Sets the feature measure value and indicator as a bar.

featuredMeasureSymbol

fun featuredMeasureSymbol(value: Float, indicator: @Composable () -> Unit = { DiamondIndicator() })

Sets the feature measure value and indicator as a symbol.

ranges

fun ranges(vararg values: Float)

Defines the qualitative ranges using the default visual representation. If the visual representation needs to be customized then use the overloaded version of this function.

fun ranges(start: Float = 0.0f, block: BulletBuilderScope.RangesScope.() -> Unit)

Defines the qualitative ranges starting at the specified start value. See RangesScope for how to configure individual range values and their graphical representation. If the default visual representation is desired then the overloaded version of this function that takes only a variable number of Float values may be used instead.

Properties

axis

val axis: Slot<AxisSettings.() -> Unit>

Specifies the axis settings and content. See AxisSettings.

label

val label: Slot<@Composable () -> Unit>

Content for the bullet graph's label.

labelWidth

var labelWidth: LabelWidth

Sets the label's width. If the BulletGraph is in a layout of multiple bullet graphs this value will be ignored and instead will take the value specified in BulletGraphScope.labelWidth.