AML PopBlock

Knowledge Checkpoint

A grasp of these concepts will help you understand this documentation better:

• Period Comparison
• AML Dashboard

PopBlock adds a Period-over-Period (PoP) control to the dashboard. Viewers use it to compare metrics across time periods (this month vs last month, this year vs last year) on connected visualization blocks. It is connected to visualization blocks via a PopInteraction.

block <name>: PopBlock {
  label: 'Control Label'
  description: ''      // optional
  default {            // optional
    // --- Relative type ---
    type: 'relative'
    duration: 1
    granularity: 'month'
    show_growth_rate: true

    // --- OR Absolute type ---
    // type: 'absolute'
    // duration: ['2026-01-01', '2026-01-31']
  }
  settings { ... }     // optional
  theme: BlockTheme { ... } // optional
}

Parameters

Parameter	Description
label	Display name shown on the control.
description	Optional description. Supports Markdown.
default	Default comparison period applied when the dashboard loads. See default.
settings	Display settings for the control.
theme	Optional BlockTheme override for visual styling.

default

Sets the initial comparison period when the dashboard loads.

Parameter	Description	Accepted values
type	Whether the comparison period is relative to today or a fixed date range	'relative', 'absolute'
duration	If type is 'relative': number of periods (in granularity units) back to compare against If type is 'absolute': an explicit [start, end] date range	Number (relative) or List[String] (absolute)
granularity	Unit for duration. Only used when type is 'relative'	'day', 'week', 'month', 'quarter', 'year'
show_growth_rate	Whether to show the growth rate (% change) alongside the comparison value	Boolean

settings

Parameter	Description	Accepted values
hide_label	Hides the control's label	Boolean
hide_controls	Hides the control's own interactive controls from viewers	Boolean