Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New: Allow BoxAnnotations to be instantiated independently and passed into Preview as an option #68

Merged
merged 4 commits into from
Dec 11, 2017
Merged

New: Allow BoxAnnotations to be instantiated independently and passed into Preview as an option #68

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2377813
New: Allow annoatations to be passed into Preview/Viewers
pramodsum Dec 9, 2017
d58697e
Fix: setting of supported annotation types from options
pramodsum Dec 11, 2017
cd31245
Merge branch 'master' into func
pramodsum Dec 11, 2017
d908a54
Fix: tests
pramodsum Dec 11, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 18 additions & 15 deletions src/BoxAnnotations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,18 @@ class BoxAnnotations {
/**
* [constructor]
*
* @param {Object} options - Viewer-specific annotator options
* @return {BoxAnnotations} BoxAnnotations instance
*/
constructor() {
constructor(options = {}) {
this.annotators = ANNOTATORS;
this.options = options;

// Filter out supported annotation types based on provided options
Object.keys(options).forEach((annotatorName) => {
const annotator = this.annotators[annotatorName];
annotator.TYPE = this.getAnnotatorTypes(annotator);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Guard for whether or not annotator exists

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

re-working how these configs are set

});
}

/**
Expand All @@ -67,8 +75,8 @@ class BoxAnnotations {
/**
* Get all annotators for a given viewer.
*
* @param {string} viewerName - Name of the viewer to get annotators for
* @param {Array} [disabledAnnotators] - List of disabled annotators
* @param {string} viewerName Name of the viewer to get annotators for
* @param {Array} [disabledAnnotators] List of disabled annotators
* @return {Object} Annotator for the viewer
*/
getAnnotatorsForViewer(viewerName, disabledAnnotators = []) {
Expand All @@ -86,7 +94,7 @@ class BoxAnnotations {
* has already been instantiated or the config is invalid.
*
* @private
* @param {Object} annotatorConfig - The config where annotation type controller instances should be attached
* @param {Object} annotatorConfig The config where annotation type controller instances should be attached
* @return {void}
*/
instantiateControllers(annotatorConfig) {
Expand All @@ -110,7 +118,7 @@ class BoxAnnotations {
* if provided, otherwise using the viewer defaults
*
* @private
* @param {Object} annotatorConfig - The config where annotation type controller instances should be attached
* @param {Object} annotatorConfig The config where annotation type controller instances should be attached
* @return {void}
*/
getAnnotatorTypes(annotatorConfig) {
Expand All @@ -134,25 +142,20 @@ class BoxAnnotations {
/**
* Chooses an annotator based on viewer.
*
* @param {Object} options - Viewer options
* @param {Object} [viewerConfig] - Viewer-specific annotations configs
* @param {Array} [disabledAnnotators] - List of disabled annotators
* @param {Object} options Viewer options
* @param {Object} [viewerConfig] Viewer-specific annotations configs
* @param {Array} [disabledAnnotators] List of disabled annotators
* @return {Object|null} A copy of the annotator to use, if available
*/
determineAnnotator(options, viewerConfig = {}, disabledAnnotators = []) {
let modifiedAnnotator = null;

this.viewerConfig = viewerConfig;
const hasAnnotationPermissions = canLoadAnnotations(options.file.permissions);
const annotator = this.getAnnotatorsForViewer(options.viewer.NAME, disabledAnnotators);
if (!hasAnnotationPermissions || !annotator || this.viewerConfig.enabled === false) {
return modifiedAnnotator;
return null;
}

modifiedAnnotator = Object.assign({}, annotator);
modifiedAnnotator.TYPE = this.getAnnotatorTypes(modifiedAnnotator);

return modifiedAnnotator;
return this.getAnnotatorsForViewer(options.viewer.NAME, disabledAnnotators);
}
}

Expand Down