DisplayMetadata

Part of Entities in the Python API reference.

Related guidance: concepts/entities, quickstarts/sensor-publisher, how-to/pli-entities, how-to/tracks-detections.

Runnable examples: publish_entity.py, watch_detections.py, watch_tracks.py.

from picogrid_ecn_client import DisplayMetadata

Provide optional reader-facing display hints for an entity.

DisplayMetadata(
    *,
    label: str | None = None,
    symbol: str | None = None,
    color: str | None = None,
)

Source · models/entity.py

Fields

Name	Type	Required	Default	Constraints	Description
label	str | None	no	None	min_length=1, max_length=256	Optional display label, from 1 through 256 characters.
symbol	str | None	no	None	min_length=1, max_length=128	Optional display symbol name, from 1 through 128 characters.
color	str | None	no	None	pattern='^#[0-9A-Fa-f]{6}$'	Optional six-digit hexadecimal display color prefixed by ’#’.