spinetoolbox.mvcmodels.pivot_table_models

Provides pivot table models for the Tabular View.

author:

16. Vennström (VTT)

date:

1.11.2018

Module Contents

class spinetoolbox.mvcmodels.pivot_table_models.PivotTableModel(parent)

Bases: PySide2.QtCore.QAbstractTableModel

Parameters:parent (TabularViewForm) –

_V_HEADER_WIDTH = 5

_ITEMS_TO_FETCH = 1024

plot_x_column

Returns the index of the column designated as Y values for plotting or None.

reset_data_count(self)

canFetchMore(self, parent)

fetchMore(self, parent)

fetch_more_rows(self, parent)

fetch_more_columns(self, parent)

reset_model(self, data, index_ids, rows=(), columns=(), frozen=(), frozen_value=())

clear_model(self)

update_model(self, data)

add_to_model(self, data)

remove_from_model(self, data)

set_pivot(self, rows, columns, frozen, frozen_value)

set_frozen_value(self, frozen_value)

set_plot_x_column(self, column, is_x)

Sets or clears the Y flag on a column

first_data_row(self)

Returns the row index to the first data row.

headerRowCount(self)

Returns number of rows occupied by header.

headerColumnCount(self)

Returns number of columns occupied by header.

dataRowCount(self)

Returns number of rows that contain actual data.

dataColumnCount(self)

Returns number of columns that contain actual data.

emptyRowCount(self)

emptyColumnCount(self)

rowCount(self, parent=QModelIndex())

Number of rows in table, number of header rows + datarows + 1 empty row

columnCount(self, parent=QModelIndex())

Number of columns in table, number of header columns + datacolumns + 1 empty columns

flags(self, index)

Roles for data

top_left_indexes(self)

Returns indexes in the top left area.

Returns

list(QModelIndex): top indexes (horizontal headers, associated to rows) list(QModelIndex): left indexes (vertical headers, associated to columns)

index_in_top(self, index)

index_in_left(self, index)

index_in_top_left(self, index)

Returns whether or not the given index is in top left corner, where pivot names are displayed

index_in_column_headers(self, index)

Returns whether or not the given index is in column headers (horizontal) area

index_in_row_headers(self, index)

Returns whether or not the given index is in row headers (vertical) area

index_in_headers(self, index)

index_in_empty_column_headers(self, index)

Returns whether or not the given index is in empty column headers (vertical) area

index_in_empty_row_headers(self, index)

Returns whether or not the given index is in empty row headers (vertical) area

index_in_data(self, index)

Returns whether or not the given index is in data area

headerData(self, section, orientation, role=Qt.DisplayRole)

map_to_pivot(self, index)

Returns a tuple of row and column in the pivot model that corresponds to the given model index.

Parameters:index (QModelIndex) – Returns:row int: column Return type:int

_top_left_id(self, index)

Returns the id of the top left header corresponding to the given header index.

Parameters:index (QModelIndex) – Returns:int, NoneType

_header_id(self, index)

Returns the id of the given row or column header index.

Parameters:index (QModelIndex) – Returns:int, NoneType

_header_ids(self, row, column)

Returns the ids for the headers at given row and column.

Parameters:

• row (int) –
• column (int) –

Returns:

tuple(int)

_header_name(self, top_left_id, header_id)

Returns the name of the header given by top_left_id and header_id.

Parameters:

• top_left_id (int) – The id of the top left header
• header_id (int) – The header id

Returns

str

header_name(self, index)

Returns the name corresponding to the given header index.

Parameters:index (QModelIndex) – Returns:str

header_data(self, index, role=Qt.DisplayRole)

Returns the data corresponding to the given header index based on role enum.

Parameters:

• index (QModelIndex) –
• role (enum Qt.ItemDataRole) –

Returns:

str

header_names(self, index)

Returns the header names corresponding to the given data index.

Parameters:index (QModelIndex) – Returns:object names str: parameter name Return type:list(str)

value_name(self, index)

Returns a string that concatenates the header names corresponding to the given data index.

Parameters:index (QModelIndex) – Returns:str

column_name(self, column)

Returns a string that concatenates the header names corresponding to the given column.

Parameters:column (int) – Returns:str

_color_data(self, index)

data(self, index, role=Qt.DisplayRole)

setData(self, index, value, role=Qt.EditRole)

batch_set_data(self, indexes, values)

_batch_set_inner_data(self, inner_data)

_batch_set_parameter_value_data(self, row_map, column_map, data, values)

_checked_parameter_values(self, items)

_add_parameter_values(self, items)

_update_parameter_values(self, items)

_batch_set_relationship_data(self, row_map, column_map, data, values)

_batch_set_header_data(self, header_data)

_batch_set_empty_header_data(self, header_data, get_top_left_id)

class spinetoolbox.mvcmodels.pivot_table_models.PivotTableSortFilterProxy(parent=None)

Bases: PySide2.QtCore.QSortFilterProxyModel

Initialize class.

set_filter(self, identifier, filter_value)

Sets filter for a given index (object class) name.

Parameters:

• identifier (int) – index identifier
• filter_value (set, None) – A set of accepted values, or None if no filter (all pass)

clear_filter(self)

accept_index(self, index, index_ids)

filterAcceptsRow(self, source_row, source_parent)

Returns true if the item in the row indicated by the given source_row and source_parent should be included in the model; otherwise returns false.

filterAcceptsColumn(self, source_column, source_parent)

Returns true if the item in the column indicated by the given source_column and source_parent should be included in the model; otherwise returns false.

batch_set_data(self, indexes, values)