Skip to content

ViewFrame

Source code in docs_src/capo_databrew/types/view_frame.py
class ViewFrame(TypedDict, closed=True):
    start_column_index: "capo_databrew.types.start_column_index.StartColumnIndex"
    """<p>The starting index for the range of columns to return in the view frame.</p>"""
    column_range: NotRequired["capo_databrew.types.column_range.ColumnRange"]
    """<p>The number of columns to include in the view frame, beginning with the <code>StartColumnIndex</code> value and ignoring any columns in the <code>HiddenColumns</code> list.</p>"""
    hidden_columns: NotRequired[
        "capo_databrew.types.hidden_column_list.HiddenColumnList"
    ]
    """<p>A list of columns to hide in the view frame.</p>"""
    start_row_index: NotRequired["capo_databrew.types.start_row_index.StartRowIndex"]
    """<p>The starting index for the range of rows to return in the view frame.</p>"""
    row_range: NotRequired["capo_databrew.types.row_range.RowRange"]
    """<p>The number of rows to include in the view frame, beginning with the <code>StartRowIndex</code> value.</p>"""
    analytics: NotRequired["capo_databrew.types.analytics_mode.AnalyticsMode"]
    """<p>Controls if analytics computation is enabled or disabled. Enabled by default.</p>"""

analytics instance-attribute

analytics: NotRequired[AnalyticsMode]

Controls if analytics computation is enabled or disabled. Enabled by default.

column_range instance-attribute

column_range: NotRequired[ColumnRange]

The number of columns to include in the view frame, beginning with the StartColumnIndex value and ignoring any columns in the HiddenColumns list.

hidden_columns instance-attribute

hidden_columns: NotRequired[HiddenColumnList]

A list of columns to hide in the view frame.

row_range instance-attribute

row_range: NotRequired[RowRange]

The number of rows to include in the view frame, beginning with the StartRowIndex value.

start_column_index instance-attribute

start_column_index: StartColumnIndex

The starting index for the range of columns to return in the view frame.

start_row_index instance-attribute

start_row_index: NotRequired[StartRowIndex]

The starting index for the range of rows to return in the view frame.