Skip to content

clear.py

rerun.log.clear

def log_cleared(entity_path, *, recursive=False, recording=None)

Indicate that an entity at a given path should no longer be displayed.

If recursive is True this will also clear all sub-paths

Parameters:

Name Type Description Default
entity_path str

The path of the affected entity.

required

recursive: Should this apply to all entity paths below entity_path?

recording: Specifies the rerun.RecordingStream to use. If left unspecified, defaults to the current active data recording, if there is one. See also: rerun.init, rerun.set_global_data_recording.