cgv_highlight_path: Highlight a Path

View source: R/graph_render.R

cgv_highlight_pathR Documentation

Highlight a Path

Description

Draw a highlighted path between nodes. Path nodes get a distinct color and enlarged size; path edges are drawn as thick colored segments on top of existing edges.

Usage

cgv_highlight_path(
  viewer,
  path,
  color = "#FF0000",
  node_scale = 2,
  edge_width = 5
)

Arguments

viewer

External pointer returned by cgv_viewer.

path

Integer vector of node IDs forming the path (1-based).

color

Color as hex string "#RRGGBB" or "#RRGGBBAA".

node_scale

Numeric: size multiplier for highlighted nodes (default 2.0).

edge_width

Numeric: line width for path edges (default 5.0).

Value

No return value, called for side effects: adds (or replaces) the highlight overlay for the given path. Returns NULL invisibly.


cgvR documentation built on May 12, 2026, 1:06 a.m.