Class: MdqRunView

MdqRunView()

A view that fetches and displays a Metadata Assessment Report

Constructor

new MdqRunView()

Source:

Extends

  • Backbone.View

Members

The selector for the element that will contain the breadcrumbs
Type:
  • string
Source:

el

Source:

events

Source:

loadingContainer :string

A JQuery selector for the element in the template that will contain the loading image
Type:
  • string
Since:
  • 2.15.0
Source:

loadingTemplate :function

The template to use to indicate that the view is loading
Type:
  • function
Source:

pid :string

The identifier of the object to be assessed
Type:
  • string
Source:

suiteId :string

The currently selected/requested suite
Type:
  • string
Source:

suiteIdList :Array.<string>

The list of all potential suites for this theme
Type:
  • Array.<string>
Source:

template :function

The main template for this view
Type:
  • function
Source:

Methods

addCheckItems(groupedResults)

Add the check result item els to the view
Parameters:
Name Type Description
groupedResults object The results grouped by status
Since:
  • 2.31.0
Source:

createCheckItem(result, className, iconClass) → {string}

Create a check item element
Parameters:
Name Type Description
result object The check result
className string The class name for the check item
iconClass string The class
Since:
  • 2.31.0
Source:
Returns:
The HTML for the check item
Type
string

drawScoreChart(results, groupedResults)

Draw a donut chart showing the distribution of checks by status
Parameters:
Name Type Description
results Array The array of check results
groupedResults object The results grouped by status
Source:

getHTMLFromMarkdown(markdown) → {Promise}

Get the HTML from markdown
Parameters:
Name Type Description
markdown string The markdown to convert to HTML
Source:
Returns:
A promise that resolves with the HTML
Type
Promise

getOutputHTML(outputs) → {string}

Get the HTML for the output
Parameters:
Name Type Description
outputs Array The outputs from the quality service
Source:
Returns:
The HTML for the output
Type
string

handleQualityReportError()

Handles errors that occur when fetching the quality report
Source:

hideLoading()

Remove the loading image and message.
Source:

insertBreadcrumbs()

Insert breadcrumbs into the view
Source:

render()

Source:

renderQualityReport()

Render the quality report once it has been fetched
Source:

show()

Show the view
Source:

showCitation()

Render a citation view for the object and display it in the view
Source:

showLoading()

Render a loading image with message
Source:

showMessage(message, showHelpopt, showLinkopt)

Updates the message in the loading image
Parameters:
Name Type Attributes Description
message string The new message to display
showHelp boolean <optional>
If set to true, and an email contact is configured in MetacatUI, then the contact email will be shown at the bottom of the message.
showLink boolean <optional>
If set to true, a link back to the dataset will be appended to the end of the message.
Since:
  • 2.15.0
Source:

switchSuite(event) → {boolean}

Handles the event when the user selects a different suite
Parameters:
Name Type Description
event Event The event object
Source:
Returns:
False, to prevent the default action
Type
boolean