spinetoolbox.spine_db_editor.widgets.graph_view_mixin

Contains the GraphViewMixin class.

author:

13. Marin (KTH)

date:

26.11.2018

Module Contents

Classes

GraphViewMixin

Provides the graph view for the DS form.

class spinetoolbox.spine_db_editor.widgets.graph_view_mixin.GraphViewMixin(*args, **kwargs)

Provides the graph view for the DS form.

Initialize self. See help(type(self)) for accurate signature.

_POS_PARAM_NAME = entity_graph_position

_VERTEX_EXTENT = 64

_ARC_WIDTH

_ARC_LENGTH_HINT

graph_selection_changed

graph_build_finished

populate_graph_db_action_group(self)

_update_graph_db_map(self, action)

add_menu_actions(self)

Adds toggle view actions to View menu.

init_models(self)

connect_signals(self)

Connects signals.

_handle_scene_selection_changed(self)

Filters parameters by selected objects in the graph.

set_show_cascading_relationships(self, checked)

setup_widget_actions(self)

Setups zoom and rotate widget action in view menu.

receive_objects_added(self, db_map_data)

Runs when objects are added to the db. Adds the new objects to the graph if needed.

Parameters:db_map_data (dict) – list of dictionary-items keyed by DiffDatabaseMapping instance.

receive_relationships_added(self, db_map_data)

Runs when relationships are added to the db. Adds the new relationships to the graph if needed.

Parameters:db_map_data (dict) – list of dictionary-items keyed by DiffDatabaseMapping instance.

receive_object_classes_updated(self, db_map_data)

receive_relationship_classes_updated(self, db_map_data)

receive_objects_updated(self, db_map_data)

Runs when objects are updated in the db. Refreshes names of objects in graph.

Parameters:db_map_data (dict) – list of dictionary-items keyed by DiffDatabaseMapping instance.

receive_objects_removed(self, db_map_data)

Runs when objects are removed from the db. Rebuilds graph if needed.

Parameters:db_map_data (dict) – list of dictionary-items keyed by DiffDatabaseMapping instance.

receive_relationships_removed(self, db_map_data)

Runs when relationships are removed from the db. Rebuilds graph if needed.

Parameters:db_map_data (dict) – list of dictionary-items keyed by DiffDatabaseMapping instance.

restore_removed_entities(self, added_ids)

Restores any entities that have been previously removed and returns their ids. This happens in the context of undo/redo.

Parameters:added_ids (set(int)) – Set of newly added ids. Returns:set(int)

hide_removed_entities(self, db_map_data)

Hides removed entities while saving them into a list attribute. This allows entities to be restored in case the user undoes the operation.

refresh_icons(self, db_map_data)

Runs when entity classes are updated in the db. Refreshes icons of entities in graph.

Parameters:db_map_data (dict) – list of dictionary-items keyed by DiffDatabaseMapping instance.

_handle_menu_graph_about_to_show(self)

Enables or disables actions according to current selection in the graph.

_handle_entity_graph_visibility_changed(self, visible)

rebuild_graph(self, selected)

Stores the given selection of entity tree indexes and builds graph.

build_graph(self, persistent=False)

Builds the graph.

Parameters:persistent (bool, optional) – If True, builds the graph on top of the current one.

_complete_graph(self, x, y)

Parameters:

• x (list) – Horizontal coordinates
• y (list) – Vertical coordinates

_get_selected_entity_ids(self)

Returns a set of ids corresponding to selected entities in the trees.

Returns:selected object ids set: selected relationship ids Return type:set

_get_all_relationships_for_graph(self, object_ids, relationship_ids)

_update_graph_data(self)

Updates data for graph according to selection in trees.

_update_src_dst_inds(self, object_id_lists)

_make_layout_generator(self)

Returns a layout generator for the current graph.

Returns:GraphLayoutGenerator

_make_new_items(self, x, y)

Returns new items for the graph.

Parameters:

• x (list) –
• y (list) –

_add_new_items(self)

hide_selected_items(self, checked=False)

Hides selected items.

show_hidden_items(self, checked=False)

Shows hidden items.

_get_selected_entity_names(self)

_get_selected_class_names(self)

prune_selected_entities(self, checked=False)

Prunes selected items.

prune_selected_classes(self, checked=False)

Prunes selected items.

restore_all_pruned_items(self, checked=False)

Reinstates all pruned items.

restore_pruned_items(self, key)

Reinstates last pruned items.

edit_entity_graph_items(self)

Starts editing given indexes.

remove_entity_graph_items(self, checked=False)

Removes all selected items in the graph.

save_positions(self, checked=False)

clear_saved_positions(self, checked=False)

export_as_pdf(self, checked=False)

start_relationship(self, relationship_class, obj_item)

Starts a relationship from the given object item.

Parameters:

• relationship_class (dict) –
• obj_item (.graphics_items.ObjectItem) –

finalize_relationship(self, relationship_class, *object_items)

Tries to add relationships between the given object items.

Parameters:

• relationship_class (dict) –
• object_items (.graphics_items.ObjectItem) –

_begin_add_relationships(self)

_end_add_relationships(self)

_populate_menu_add_parameter_heat_map(self)

Populates the menu ‘Add parameter heat map’ with parameters for currently shown items in the graph.

add_heat_map(self, action)

Adds heat map for the parameter in the action text.

_clean_up_heat_map_items(self)

closeEvent(self, event)

Handle close window.

Parameters:event (QCloseEvent) – Closing event