RingRenderer (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.web.helpers.RingRenderer

```
public class RingRenderer
extends Object
```
Reusable SVG ring chart generator for health-ring dashboards. Produces inline SVG markup compatible with the ring CSS in shared.css.

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class RingRenderer.RingSection
A section of a multi-section ring with a proportion and color class.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RingRenderer.RingSection` A section of a multi-section ring with a proportion and color class.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static double`	`ANOMALY_GREEN_BAND` Green anomaly band threshold
`(package private) static double`	`ANOMALY_YELLOW_BAND` Yellow anomaly band threshold
`static String`	`MODE_ACTIVITY` MODE_ACTIVITY.
`static String`	`MODE_ANOMALY` Mode: anomaly — color by deviation from the router's own baseline, not an absolute cap
`static String`	`MODE_HEALTH` Mode: health (green/yellow/red), activity (blue/cyan)
`static String`	`MODE_LATENCY` MODE_LATENCY.
`static String`	`MODE_NEUTRAL` Mode: neutral (green/yellow/gray, never red — for uptime, metrics that aren't inherently bad)
`static String`	`MODE_RATIO` Mode: dual-arc ratio (green + red arcs showing a proportion)
`static String`	`PLOT_BARS` Plot type: mini bars at the bottom of the ring
`static String`	`PLOT_LINE` Plot type: line chart clipped to the inner circle area

Constructor Summary
Constructors
Constructor and Description
RingRenderer()

Constructors
Constructor and Description
`RingRenderer()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`(package private) static String`	`getColorClass(double score, boolean collecting, String mode)` Determine the CSS color class based on score, collecting state, and mode.
`static String`	`renderRing(double score, String label, String value)` Render a single SVG ring chart.
`static String`	`renderRing(double score, String label, String value, String mode)` Render a single SVG ring chart with a specified color mode.
`static String`	`renderRing(double score, String label, String value, String mode, double[] history)` Render a single SVG ring chart with sparkline history.
`static String`	`renderRing(double score, String label, String value, String mode, double[] history, String plotType)` Render a single SVG ring chart with sparkline history and configurable plot type.
`static String`	`renderRing(double score, String label, String value, String mode, double[] history, String plotType, String forcedColor)` Render a ring with an explicit color class override.
`static String`	`renderRing(RingRenderer.RingSection[] sections, String value, String label)` Render a multi-section ring SVG with proportional colored arcs.
`static String`	`renderRingCell(double score, String label, String value, String[] details)` Render a ring cell (ring + optional tooltip) for use inside a grid.
`static String`	`renderRingCell(double score, String label, String value, String[] details, String mode)` Render a ring cell with a specified color mode.
`static String`	`renderRingCell(double score, String label, String value, String[] details, String mode, double[] history)` Render a ring cell with sparkline history bars.
`static String`	`renderRingCell(double score, String label, String value, String[] details, String mode, double[] history, String forcedColor)` Render a ring cell with an explicit color class override.
`static String`	`renderRingCell(RingRenderer.RingSection[] sections, String value, String label, String[] details)` Render a multi-section ring cell.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- ANOMALY_GREEN_BAND
```
static final double ANOMALY_GREEN_BAND
```
  Green anomaly band threshold
  See Also:
  Constant Field Values
- ANOMALY_YELLOW_BAND
```
static final double ANOMALY_YELLOW_BAND
```
  Yellow anomaly band threshold
  See Also:
  Constant Field Values
- MODE_ACTIVITY
```
public static final String MODE_ACTIVITY
```
  MODE_ACTIVITY.
  See Also:
  Constant Field Values
- MODE_ANOMALY
```
public static final String MODE_ANOMALY
```
  Mode: anomaly — color by deviation from the router's own baseline, not an absolute cap
  See Also:
  Constant Field Values
- MODE_HEALTH
```
public static final String MODE_HEALTH
```
  Mode: health (green/yellow/red), activity (blue/cyan)
  See Also:
  Constant Field Values
- MODE_LATENCY
```
public static final String MODE_LATENCY
```
  MODE_LATENCY.
  See Also:
  Constant Field Values
- MODE_NEUTRAL
```
public static final String MODE_NEUTRAL
```
  Mode: neutral (green/yellow/gray, never red — for uptime, metrics that aren't inherently bad)
  See Also:
  Constant Field Values
- MODE_RATIO
```
public static final String MODE_RATIO
```
  Mode: dual-arc ratio (green + red arcs showing a proportion)
  See Also:
  Constant Field Values
- PLOT_BARS
```
public static final String PLOT_BARS
```
  Plot type: mini bars at the bottom of the ring
  See Also:
  Constant Field Values
- PLOT_LINE
```
public static final String PLOT_LINE
```
  Plot type: line chart clipped to the inner circle area
  See Also:
  Constant Field Values

Constructor Detail
- RingRenderer
```
public RingRenderer()
```

Method Detail

getColorClass
```
static String getColorClass(double score,
                            boolean collecting,
                            String mode)
```
Determine the CSS color class based on score, collecting state, and mode.
Parameters:
score - 0.0–1.0 (never negative here)
collecting - true if data is still being gathered
mode - color mode
Returns:
CSS class name

renderRing
```
public static String renderRing(double score,
                                String label,
                                String value)
```
Render a single SVG ring chart.
Parameters:
score - 0.0–1.0 fill level, or < 0 for "collecting" (gray)
label - short label displayed below the percentage
value - value string displayed in the center (e.g. "93%", "12", "1.2s")
Returns:
inline SVG markup

renderRing
```
public static String renderRing(double score,
                                String label,
                                String value,
                                String mode)
```
Render a single SVG ring chart with a specified color mode.
Parameters:
score - 0.0–1.0 fill level, or < 0 for "collecting" (gray)
label - short label displayed below the percentage
value - value string displayed in the center
mode - color mode (MODE_HEALTH, MODE_ACTIVITY, MODE_LATENCY)
Returns:
inline SVG markup

renderRing
```
public static String renderRing(double score,
                                String label,
                                String value,
                                String mode,
                                double[] history)
```
Render a single SVG ring chart with sparkline history.
Parameters:
score - 0.0–1.0 fill level, or < 0 for "collecting" (gray)
label - short label displayed below the percentage
value - value string displayed in the center
mode - color mode (MODE_HEALTH, MODE_ACTIVITY, MODE_LATENCY)
history - recent data points for sparkline, or null to omit
Returns:
inline SVG markup

renderRing
```
public static String renderRing(double score,
                                String label,
                                String value,
                                String mode,
                                double[] history,
                                String plotType)
```
Render a single SVG ring chart with sparkline history and configurable plot type.
Parameters:
score - 0.0–1.0 fill level, or < 0 for "collecting" (gray)
label - short label displayed below the percentage
value - value string displayed in the center
mode - color mode (MODE_HEALTH, MODE_ACTIVITY, MODE_LATENCY)
history - recent data points for sparkline, or null to omit
plotType - PLOT_BARS or PLOT_LINE (defaults to PLOT_LINE when null)
Returns:
inline SVG markup

renderRing

public static String renderRing(double score,
                                String label,
                                String value,
                                String mode,
                                double[] history,
                                String plotType,
                                String forcedColor)

Render a ring with an explicit color class override. When forcedColor is non-null it is used for the arc/text/plot color instead of the score-derived class (used by MODE_ANOMALY, where color reflects deviation from baseline rather than the raw fill level).

Parameters:: forcedColor - explicit CSS class ("green"/"yellow"/"red"/"gray"), or null

renderRing

public static String renderRing(RingRenderer.RingSection[] sections,
                                String value,
                                String label)

Render a multi-section ring SVG with proportional colored arcs.

Parameters:: sections - array of sections (values normalized to sum 1.0); value - center text (e.g. "70%"); label - label below the center text
Returns:: inline SVG markup

renderRingCell

public static String renderRingCell(double score,
                                    String label,
                                    String value,
                                    String[] details)

Render a ring cell (ring + optional tooltip) for use inside a grid.

Parameters:: score - 0.0–1.0 fill level; label - short label; value - value string in the center; details - tooltip lines, or null/empty for no tooltip
Returns:: HTML for the ring-cell div

renderRingCell

public static String renderRingCell(double score,
                                    String label,
                                    String value,
                                    String[] details,
                                    String mode)

Render a ring cell with a specified color mode.

Parameters:: score - 0.0–1.0 fill level; label - short label; value - value string in the center; details - tooltip lines, or null/empty for no tooltip; mode - color mode (MODE_HEALTH, MODE_ACTIVITY, MODE_LATENCY)
Returns:: HTML for the ring-cell div

renderRingCell

public static String renderRingCell(double score,
                                    String label,
                                    String value,
                                    String[] details,
                                    String mode,
                                    double[] history)

Render a ring cell with sparkline history bars.

Parameters:: score - 0.0–1.0 fill level; label - short label; value - value string in the center; details - tooltip lines, or null/empty for no tooltip; mode - color mode (MODE_HEALTH, MODE_ACTIVITY, MODE_LATENCY); history - recent data points for sparkline, or null to omit
Returns:: HTML for the ring-cell div

renderRingCell

public static String renderRingCell(double score,
                                    String label,
                                    String value,
                                    String[] details,
                                    String mode,
                                    double[] history,
                                    String forcedColor)

Render a ring cell with an explicit color class override. When forcedColor is non-null it is used for the arc/text/plot color instead of the score-derived class (used by MODE_ANOMALY).

Parameters:: forcedColor - explicit CSS class ("green"/"yellow"/"red"/"gray"), or null

renderRingCell

public static String renderRingCell(RingRenderer.RingSection[] sections,
                                    String value,
                                    String label,
                                    String[] details)

Render a multi-section ring cell.

Parameters:: sections - array of sections (values normalized to sum 1.0); value - center text; label - label below the center text; details - tooltip lines, or null/empty to omit
Returns:: HTML for the ring-cell div

Class RingRenderer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANOMALY_GREEN_BAND

ANOMALY_YELLOW_BAND

MODE_ACTIVITY

MODE_ANOMALY

MODE_HEALTH

MODE_LATENCY

MODE_NEUTRAL

MODE_RATIO

PLOT_BARS

PLOT_LINE

Constructor Detail

RingRenderer

Method Detail

getColorClass

renderRing

renderRing

renderRing

renderRing

renderRing

renderRing

renderRingCell

renderRingCell

renderRingCell

renderRingCell

renderRingCell