pulsatrix 1.1.0
Loading...
Searching...
No Matches
pulsatrix::TokenRelevanceView Class Reference

Draws a document's pieces as running text that wraps to the window, each scored piece on a background colored by its relevance (DivergingColormap, scaled to the largest |relevance|), as the SVG token strip does. Unscored pieces (the spaces between words) are plain text, and a newline starts a new line. Hovering a piece shows its text and score. More...

#include <token_relevance_view.hpp>

Static Public Member Functions

static void Draw (const char *id, const TokenRelevanceDocument &doc, float shared_max_abs=-1.0f)
 

Detailed Description

Draws a document's pieces as running text that wraps to the window, each scored piece on a background colored by its relevance (DivergingColormap, scaled to the largest |relevance|), as the SVG token strip does. Unscored pieces (the spaces between words) are plain text, and a newline starts a new line. Hovering a piece shows its text and score.

Note
Text in any script shows when the system has a font for it: VizWindow merges system fonts in as fallbacks (viz/fonts.hpp). ImGui doesn't shape text, so Arabic, Hebrew and Indic scripts appear unjoined and left to right; the SVG strip shows them correctly.
Call from an ImGui::Begin/End window body. Not unit-tested, like the other widgets (GoogleTest can't exercise ImGui draw calls); the document builders it is meant for are (viz/text_relevance.hpp).

Member Function Documentation

◆ Draw()

static void pulsatrix::TokenRelevanceView::Draw ( const char *  id,
const TokenRelevanceDocument &  doc,
float  shared_max_abs = -1.0f 
)
static
Parameters
idImGui id for the widget.
shared_max_absWhen > 0, the color scale's end instead of this document's largest |relevance|, so several documents shown together share one scale.

The documentation for this class was generated from the following file: