volcano-compose/com.taewooyo.volcano.compose

Package-level declarations

Types

data class HeatmapDisplayPolicy(val hideContentBelow: Dp = 16.dp, val showMetricAbove: Dp = 40.dp, val showLabelAbove: Dp = 48.dp, val cellContentPadding: Dp = 6.dp, val adaptiveContent: Boolean = true, val metricFormatter: HeatmapMetricFormatter = SignedMetricFormatter)

Rules that preserve readable content in small heatmap cells.

HeatmapInteraction

data class HeatmapInteraction(val drillDownOnGroupClick: Boolean = true, val selectLeafOnClick: Boolean = true, val showTooltipOnLongClick: Boolean = false, val tooltipDurationMillis: Int, val showTooltipOnHover: Boolean = false, val tooltipHoverDelayMillis: Int = 400)

Defines how a Heatmap updates HeatmapState for its built-in tap targets.

HeatmapLabels

data class HeatmapLabels(val noData: String = "No data", val selected: String = "Selected", val notSelected: String = "Not selected", val currentGroup: String = "Current group", val openGroup: String = "Open group", val navigate: String = "Navigate to", val showDetails: String = "Show details", val metric: String = "metric", val enabled: String = "Enabled", val disabled: String = "Disabled", val back: String = "Back", val value: String = "value")

User-facing defaults. Override through LocalHeatmapLabels for localization.

HeatmapLogoContent

typealias HeatmapLogoContent = @Composable (HeatmapNode, Dp) -> Unit

Optional content rendered above the default label and metric for a sufficiently large leaf.

HeatmapMetricFormatter

fun interface HeatmapMetricFormatter

Formats a node's signed metric for the default heatmap cell.

HeatmapMotion

data class HeatmapMotion(val enabled: Boolean = true, val durationMillis: Int = 180, val initialScale: Float = 0.98f, val pressScale: Float = 0.97f, val pressedAlpha: Float = 0.92f, val pressDurationMillis: Int = 90)

Visual transition settings used when the visible drill-down level changes.

HeatmapState

@Stable

class HeatmapState

State holder for drill-down navigation in Heatmap.

HeatmapStyle

data class HeatmapStyle(val borderColor: Color = Color.White, val groupHeaderColor: Color = Color.White, val groupHeaderTextColor: Color = Color(0xFF252525), val selectedBorderColor: Color = Color(0xFF0F172A), val leafTextColor: Color = Color.White)

Visual defaults used by Heatmap and DefaultHeatmapCell.

HeatmapTooltipContent

typealias HeatmapTooltipContent = @Composable (HeatmapNode, () -> Unit) -> Unit

Optional replacement for the built-in tooltip body. The callback dismisses the tooltip.

HeatmapValueFormatter

fun interface HeatmapValueFormatter

Formats the source value announced for a heatmap leaf.

PercentageMetricFormatter

object PercentageMetricFormatter : HeatmapMetricFormatter

Convenience formatter for metrics expressed as percentages.

PlainHeatmapValueFormatter

object PlainHeatmapValueFormatter : HeatmapValueFormatter

Default formatter that preserves the source value's decimal representation.

SignedMetricFormatter

object SignedMetricFormatter : HeatmapMetricFormatter

Default domain-neutral metric formatter.

Properties

LocalHeatmapLabels

val LocalHeatmapLabels: ProvidableCompositionLocal<HeatmapLabels>

LocalHeatmapValueFormatter

val LocalHeatmapValueFormatter: ProvidableCompositionLocal<HeatmapValueFormatter>

Formatter used by default cell semantics and tooltip content.

Functions

DefaultHeatmapCell

@Composable

fun DefaultHeatmapCell(node: HeatmapNode, modifier: Modifier = Modifier, displayPolicy: HeatmapDisplayPolicy = HeatmapDisplayPolicy(), color: Long? = node.color, selected: Boolean = false, selectedBorderColor: Color = Color.Black, contentColor: Color = Color.White, logoContent: HeatmapLogoContent? = null)

Default leaf renderer.

DefaultHeatmapTooltip

@Composable

fun DefaultHeatmapTooltip(node: HeatmapNode, metricFormatter: HeatmapMetricFormatter = SignedMetricFormatter, modifier: Modifier = Modifier, onDismissRequest: () -> Unit)

Default long-press detail popup.

Heatmap

@Composable

fun Heatmap(state: HeatmapState, modifier: Modifier = Modifier, displayPolicy: HeatmapDisplayPolicy = HeatmapDisplayPolicy(), style: HeatmapStyle = HeatmapStyle(), interaction: HeatmapInteraction = HeatmapInteraction(), colorScale: HeatmapColorScale = SignedMetricColorScale(), logoContent: HeatmapLogoContent? = null, onGroupClick: (HeatmapNode) -> Unit = {}, onLeafClick: (HeatmapNode) -> Unit = {}, onLeafLongClick: (HeatmapNode) -> Unit = {}, onLeafHover: (HeatmapNode?) -> Unit? = null, cellContent: @Composable (HeatmapNode, Modifier) -> Unit = { node, cellModifier -> DefaultHeatmapCell( node = node, modifier = cellModifier, displayPolicy = displayPolicy, color = node.color ?: colorScale.colorOf(node), selected = state.isSelected(node), selectedBorderColor = style.selectedBorderColor, contentColor = style.leafTextColor, logoContent = logoContent, ) }, motion: HeatmapMotion = HeatmapMotion(), tooltipContent: HeatmapTooltipContent? = null)

Renders the visible level in state using the size supplied by modifier's parent.

HeatmapBackButton

@Composable

fun HeatmapBackButton(onClick: () -> Unit, enabled: Boolean, modifier: Modifier = Modifier, label: String? = null)

A small platform-neutral navigation control for heatmap sample chrome.

HeatmapBreadcrumb

@Composable

fun HeatmapBreadcrumb(state: HeatmapState, modifier: Modifier = Modifier, separator: String = " / ")

A compact breadcrumb intended to be displayed above a Heatmap.

HeatmapLegend

@Composable

fun HeatmapLegend(entries: List<HeatmapLegendEntry>, modifier: Modifier = Modifier, indicatorSize: Dp = 12.dp, contentColor: Color = Color(0xFF252525))

A compact, platform-independent legend for a heatmap color scale.

rememberHeatmapState

@Composable

fun rememberHeatmapState(root: HeatmapNode): HeatmapState

Creates and remembers a drill-down state for root.