Skip to content
🚀  Book a demo💡  Explore the Comet website
Doc version: 3.14.0

comet_ml.api_objects.view.View dataclass ¶

View(
    name: str,
    template_id: Optional[str] = None,
    project_id: Optional[str] = None,
    experiment_key: Optional[str] = None,
    query_state: Optional[str] = None,
    chart_state: Optional[str] = None,
    table_state: Optional[str] = None,
    v2: Optional[Any] = None,
    v3: Optional[Any] = None,
    source: Optional[str] = None,
    view_source: Optional[str] = None,
    current: Optional[bool] = None,
    unsaved_view: Optional[bool] = None,
    created_by: Optional[str] = None,
    created_from_template_id: Optional[str] = None,
    project_default: Optional[bool] = None,
    project_personal_default: Optional[bool] = None,
    auto_refresh_enabled: Optional[bool] = None,
    last_update: Optional[int] = None,
    pinned_experiments: Optional[List[str]] = None,
    code_panel_template_ids: Optional[List[str]] = None,
)

Represents a saved dashboard view configuration.

A View stores dashboard layout and query state for a project or experiment. Views can be created and retrieved via the API or APIExperiment classes.

Parameters:

  • name (str) –

    The display name of the view (required).

  • template_id (Optional[str], default: None ) –

    Unique identifier for the view template.

  • project_id (Optional[str], default: None ) –

    The project this view belongs to.

  • experiment_key (Optional[str], default: None ) –

    The experiment this view is scoped to.

  • query_state (Optional[str], default: None ) –

    Serialized experiment query/filter state.

  • chart_state (Optional[str], default: None ) –

    Serialized dashboard chart configuration.

  • table_state (Optional[str], default: None ) –

    Serialized react grid table configuration.

  • v2 (Optional[Any], default: None ) –

    v2-format view state dict returned by the backend.

Attributes¶

auto_refresh_enabled class-attribute instance-attribute ¶

auto_refresh_enabled: Optional[bool] = None

chart_state class-attribute instance-attribute ¶

chart_state: Optional[str] = None

code_panel_template_ids class-attribute instance-attribute ¶

code_panel_template_ids: Optional[List[str]] = field(default=None)

created_by class-attribute instance-attribute ¶

created_by: Optional[str] = None

created_from_template_id class-attribute instance-attribute ¶

created_from_template_id: Optional[str] = None

current class-attribute instance-attribute ¶

current: Optional[bool] = None

experiment_key class-attribute instance-attribute ¶

experiment_key: Optional[str] = None

last_update class-attribute instance-attribute ¶

last_update: Optional[int] = None

name instance-attribute ¶

name: str

pinned_experiments class-attribute instance-attribute ¶

pinned_experiments: Optional[List[str]] = field(default=None)

project_default class-attribute instance-attribute ¶

project_default: Optional[bool] = None

project_id class-attribute instance-attribute ¶

project_id: Optional[str] = None

project_personal_default class-attribute instance-attribute ¶

project_personal_default: Optional[bool] = None

query_state class-attribute instance-attribute ¶

query_state: Optional[str] = None

source class-attribute instance-attribute ¶

source: Optional[str] = None

table_state class-attribute instance-attribute ¶

table_state: Optional[str] = None

template_id class-attribute instance-attribute ¶

template_id: Optional[str] = None

unsaved_view class-attribute instance-attribute ¶

unsaved_view: Optional[bool] = None

v2 class-attribute instance-attribute ¶

v2: Optional[Any] = None

v3 class-attribute instance-attribute ¶

v3: Optional[Any] = None

view_source class-attribute instance-attribute ¶

view_source: Optional[str] = None

Functions¶

Jul. 24, 2026