Skip to content

Latest commit

 

History

History
112 lines (101 loc) · 2.55 KB

README.md

File metadata and controls

112 lines (101 loc) · 2.55 KB

FENIX metadata viewer

var Viewer = require('fx-md-v/start');

var viewer = new Viewer(options);

Configuration

Check fx-md-v/config/config.js to have a look of the default configuration.

Parameter Type Default Value Example Description
el CSS3 Selector/JavaScript DOM element/jQuery DOM element - "#container" component container
cache boolean false true whether or not to use FENIX bridge cache
model Object - - FENIX resource
popover Object - - Bootstrap popover configuration
config Object - - jquery-treegrid configuration
whiteList Object - - -
hideExportButton boolean true false Whether or not to show export button
expandAttributes Array of metadata attributes [] ["uid"] Expand metadata attributes by default
expandAttributesRecursively Array of metadata attributes [] ['meContent'] Expand metadata attributes and their children by default
environment string 'develop' 'production' Server environment

API

//This is an example
viewer.on("export", function (state) {...});
  • viewer.on(event, callback[, context]) : pub/sub
  • viewer.dispose() : dispose the catalog instance

Events

  • ready : triggered when the metadata viewer is ready
  • dispose : triggered when the box is disposed
  • export : triggered when export button is clicked