Class: EditCollectionView

EditCollectionView()

A view that allows the user to edit the search filters that define their dataset collection

Constructor

new EditCollectionView()

Source:

Extends

  • Backbone.View

Members

className :string

The HTML classes to use for this view's element
Type:
  • string
Source:

collectionControlsContainer :string

A jQuery selector for the element that the Save and Cancel buttons should be inserted into
Type:
  • string
Source:

dataCatalogViewContainer :string

A jQuery selector for the element that the DataCatalogViewWithFilters should be inserted into
Type:
  • string
Source:

editorView :PortalEditorView

A reference to the parent editor view, if there is one
Type:
Source:

events :Object

The events this view will listen to and the associated function to call.
Type:
  • Object
Source:

helpTextContainer :string

A jQuery selector for the element that contains the filter help text
Type:
  • string
Source:

model :CollectionModel

The Collection model that is being edited
Type:
Source:

queryBuilderExcludeFields :Array.<string>

Query fields to exclude in the metadata field selector of each Query Rule. This is a list of field names that exist in the query service index (i.e. Solr), but which should be hidden in the Query Builder
Type:
  • Array.<string>
Source:

queryBuilderNestedExcludeFields :Array.<string>

Query fields to exclude in the metadata field selector for any Query Rules that are in nested Query Builders (i.e. in nested Filter Groups). This is a list of field names that exist in the query service index (i.e. Solr), but which should be hidden in nested Query Builders
Type:
  • Array.<string>
Source:

queryBuilderSpecialFields :Array.<SpecialField>

Query fields that do not exist in the query service index, but which we would like to show as options in the Query Builder field input.
Type:
Since:
  • 2.15.0
Source:

queryBuilderViewContainer :string

A jQuery selector for the element that the QueryBuilder should be inserted into
Type:
  • string
Source:

ruleColorPalette :Array.<string>

An array of hex color codes used to help distinguish between different rules
Type:
  • Array.<string>
Source:

tagName :string

The HTML tag name to use for this view's element
Type:
  • string
Source:

template

The template for this view. An HTML file is converted to an Underscore.js template
Source:

type :string

The type of View this is
Type:
  • string
Source:

Methods

initialize(options)

Is exexcuted when a new EditCollectionView is created
Parameters:
Name Type Description
options Object A literal object with options to pass to the view
Properties:
Name Type Description
options.model CollectionModel The collection whose search results will be displayed and edited in this view
Source:

render()

Renders this view
Source:

renderCollectionControls()

Renders the edit collection controls - e.g. a Save and Cancel buttton
Source:

renderDataCatalog()

Render the DataCatalogViewWithFilters
Source:

renderQueryBuilder()

renderQueryBuilder - Render the QueryBuilder and insert it into this view
Source:

toggleHelpText()

Either hides or shows the help message that lets the user know they can add filters when the collection is empty.
Source: