Package org.apache.juneau.console.freemarker

Class Bands

java.lang.Object
org.apache.juneau.console.freemarker.Bands
All Implemented Interfaces:
Decorator
public final class Bands extends Object implements Decorator
The built-in bands decorator: shaded x ranges from a list, a same-origin src, a data: topic, or the gaps in the first series (gaps()). The areas ride a carrier series juneau-bands-<n>.
Example:

Bands.from("/rest/outages").start("from").end("to").label("Outage"); Bands.gaps().label("No data");

Since:
10.0.0

  • Method Details

    • from

      public static Bands from(String path)
      Parameters:
      path - A same-origin path returning rows. @return A new decorator.

    • values

      public static Bands values(List<? extends Map<String,?>> rows)
      Parameters:
      rows - Inline rows {start, end, label?}. @return A new decorator.

    • source

      public static Bands source(String dataTopic)
      Parameters:
      dataTopic - A data: topic. @return A new decorator.

    • gaps

      public static Bands gaps()
      Shades the runs of empty buckets in the first series. @return A new decorator.

    • start

      public Bands start(String field)
      Parameters:
      field - The row field holding the range start. @return This object.

    • end

      public Bands end(String field)
      Parameters:
      field - The row field holding the range end. @return This object.

    • label

      public Bands label(String v)
      Parameters:
      v - The band label. @return This object.

    • minGap

      public Bands minGap(int buckets)
      Parameters:
      buckets - The shortest gap shaded by gaps(), at least 1. @return This object.

    • onClick

      public Bands onClick(String topic)
      Parameters:
      topic - A custom topic the card publishes a click on a band to. @return This object.

    • toJson

      public JsonMap toJson()
      Specified by:
      toJson in interface Decorator
      Returns:
      A new map {"use": name, ...args}; a string topic key is published on click, and ChartDef.decorate(Decorator) adds it to the card's publishes.