Warning
This document is for an old release of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.
galaxy.web.legacy_framework package
Submodules
galaxy.web.legacy_framework.grids module
- class galaxy.web.legacy_framework.grids.GridColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
object
- class galaxy.web.legacy_framework.grids.ReverseSortColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
GridColumn
Column that reverses sorting; this is useful when the natural sort is descending.
- class galaxy.web.legacy_framework.grids.TextColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
GridColumn
Generic column that employs freetext and, hence, supports freetext, case-independent filtering.
- filter(trans, user, query, column_filter)[source]
Modify query to filter using free text, case independence.
- get_filter(trans, user, column_filter)[source]
Returns a SQLAlchemy criterion derived from column_filter.
- class galaxy.web.legacy_framework.grids.DateTimeColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
TextColumn
- class galaxy.web.legacy_framework.grids.BooleanColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
TextColumn
- class galaxy.web.legacy_framework.grids.IntegerColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
TextColumn
Integer column that employs freetext, but checks that the text is an integer, so support filtering on integer values.
IMPORTANT NOTE: grids that use this column type should not include the column in the cols_to_filter list of MulticolFilterColumn ( i.e., searching on this column type should not be performed in the grid’s standard search - it won’t throw exceptions, but it also will not find what you’re looking for ). Grids that search on this column should use ‘filterable=”advanced”’ so that searching is only performed in the advanced search component, restricting the search to the specific column.
This is useful for searching on object ids or other integer columns. See the JobIdColumn column in the SpecifiedDateListGrid class in the jobs controller of the reports webapp for an example.
- class galaxy.web.legacy_framework.grids.CommunityRatingColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
GridColumn
,UsesItemRatings
Column that displays community ratings for an item.
- class galaxy.web.legacy_framework.grids.OwnerAnnotationColumn(col_name, key, model_class=None, model_annotation_association_class=None, filterable=None)[source]
Bases:
TextColumn
,UsesAnnotations
Column that displays and filters item owner’s annotations.
- class galaxy.web.legacy_framework.grids.CommunityTagsColumn(col_name, key, model_class=None, model_tag_association_class=None, filterable=None, grid_name=None)[source]
Bases:
TextColumn
Column that supports community tags.
- __init__(col_name, key, model_class=None, model_tag_association_class=None, filterable=None, grid_name=None)[source]
Create a grid column.
- class galaxy.web.legacy_framework.grids.IndividualTagsColumn(col_name, key, model_class=None, model_tag_association_class=None, filterable=None, grid_name=None)[source]
Bases:
CommunityTagsColumn
Column that supports individual tags.
- class galaxy.web.legacy_framework.grids.MulticolFilterColumn(col_name, cols_to_filter, key, visible, filterable='default')[source]
Bases:
TextColumn
Column that performs multicolumn filtering.
- class galaxy.web.legacy_framework.grids.OwnerColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
TextColumn
Column that lists item’s owner.
- class galaxy.web.legacy_framework.grids.PublicURLColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
TextColumn
Column displays item’s public URL based on username and slug.
- class galaxy.web.legacy_framework.grids.DeletedColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
GridColumn
Column that tracks and filters for items with deleted attribute.
- class galaxy.web.legacy_framework.grids.StateColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
GridColumn
Column that tracks and filters for items with state attribute.
- class galaxy.web.legacy_framework.grids.SharingStatusColumn(label, key=None, model_class=None, method=None, format=None, link=None, attach_popup=False, visible=True, nowrap=False, filterable=None, sortable=True, label_id_prefix=None, target=None)[source]
Bases:
GridColumn
Grid column to indicate sharing status.
- class galaxy.web.legacy_framework.grids.GridOperation(label, key=None, condition=None, allow_multiple=True, allow_popup=True, target=None, url_args=None, async_compatible=False, confirm=None, global_operation=None)[source]
Bases:
object
- class galaxy.web.legacy_framework.grids.DisplayByUsernameAndSlugGridOperation(label, key=None, condition=None, allow_multiple=True, allow_popup=True, target=None, url_args=None, async_compatible=False, confirm=None, global_operation=None)[source]
Bases:
GridOperation
Operation to display an item by username and slug.
- class galaxy.web.legacy_framework.grids.GridAction(label=None, url_args=None, target=None)[source]
Bases:
object
- class galaxy.web.legacy_framework.grids.Grid[source]
Bases:
object
Specifies the content and format of a grid (data table).
- title = ''
- show_item_checkboxes = False
- template = 'legacy/grid_base.mako'
- async_template = 'legacy/grid_base_async.mako'
- use_async = False
- use_hide_message = True
- global_actions: List[GridAction] = []
- columns: List[GridColumn] = []
- operations: List[GridOperation] = []
- standard_filters: List[GridColumnFilter] = []
- use_paging = False
- num_rows_per_page = 25
- num_page_links = 10
- allow_fetching_all_results = True
- cur_filter_pref_name = '.filter'
- cur_sort_key_pref_name = '.sort_key'
- legend = None
- info_text = None