DisplayOptions#

class nominal.core.DisplayOptions(style='html', timezone='UTC', time_format='iso', time_precision='s', show_link=True, fetch_details=True, collapse_threshold=0, max_items=50, fetch_timeout=5.0, show_graph=True, graph_max_nodes=20)#

Bases: object

How Nominal resources display in notebooks.

Change these with set_display_options, and read the current values with get_display_options.

style: Literal['html', 'text'] = 'html'#

"html" shows resources as formatted cards. "text" shows their plain repr.

timezone: str = 'UTC'#

"UTC", "local" for the notebook kernel’s time zone, or an IANA name such as "Europe/Berlin".

Type:

Time zone for timestamps

time_format: Literal['iso', 'readable'] = 'iso'#

"iso" shows timestamps as ISO 8601, such as 2026-11-02T16:33:03Z. "readable" uses a space and the time zone’s name, such as 2026-11-02 16:33:03 UTC.

time_precision: Literal['s', 'ms', 'us', 'ns'] = 's'#

"s", "ms", "us" or "ns". Finer digits are cut off, not rounded, and trailing zeros are left out, so "ns" shows each timestamp exactly.

Type:

The finest unit timestamps show

Whether cards link resources to their pages in the Nominal app.

Building a link resolves the client’s workspace. The first card for a client that hasn’t resolved it yet makes one request; later cards reuse the result.

fetch_details: bool = True#

Whether cards load related resources from Nominal, such as an asset’s datasets and runs, a dataset’s channels and a numeric channel’s statistics.

Each card then makes a few requests. With this off, cards show only the fields the object already holds.

collapse_threshold: int = 0#

Sections with more items than this start collapsed, and a diagram with more nodes than this does too. With the default, 0, every section with items starts collapsed, so a card shows its fields and the titles of its sections. A section that holds only a note, such as a load that failed, stays open so the note shows.

max_items: int = 50#

The most items a section lists, and loads where it can. The section says how many more were left out.

fetch_timeout: float = 5.0#

Seconds a card waits for what it loads from Nominal, in total. Sections still loading then say so, and links that need the workspace show as plain text.

show_graph: bool = True#

Whether cards draw a diagram of the resource and the resources around it, such as an asset’s datasets and runs. Each node links to its page in the Nominal app.

The diagram uses only what the card already loads, so it makes no requests of its own. Cards draw none with fetch_details=False.

graph_max_nodes: int = 20#

The most nodes a diagram draws. Past it, each group of related resources shows its first few and a node counting the rest, which links to the card’s section listing them. The card’s own node and one node of each group always show, so a cap below one more than the number of groups is exceeded.