figureModel_global_var

[will-moore]

As discussed with @bramalingam, this small change makes the figureModel into a global variable so that it is accessible to the browser devtools console.
See https://trello.com/c/5f4RniW4/159-omerofigure-plugins

This allows users to script various changes to the figure.
E.g. pasting this code into the console will make a 'split-view' figure from all selected panels in the figure:

figureModel.panels.getSelected().forEach(p => {
    var j = p.toJSON();
    for (var c=0; c<j.channels.length; c++){
        // offset to the right each time we create a new panel
        j.x = j.x + (j.width * 1.05);
        // turn all channels off except for the current index
        j.channels.forEach((ch, i) => {
            ch.active = i === c;
        });
        // create new panel from json
        figureModel.panels.create(j);
    };
});

Movie figure

figureModel.panels.getSelected().forEach(p => {
    var j = p.toJSON();
	var left = j.x;
	var top = j.y;
	var columnCount = 10;
    var tIncrement = 2;
	var panelCount = 1;
    for (var t=tIncrement; t<j.sizeT; t+=tIncrement){
        // offset to the right each time we create a new panel
        j.x = left + ((panelCount % columnCount) * j.width * 1.05);
		j.y = top + (parseInt(panelCount / columnCount) * j.height * 1.05);
		panelCount++;
        // Increment T
        j.theT = t;
        // create new panel from json
        figureModel.panels.create(j);
    };
});

To test:

• Open figure with some images
• Open devtools (right-click on page and 'Inspect') and open devtools console.
• Select one or more panels in the figure - e.g. a panel with multiple channels
• Copy and paste the first example above into console. Enter.
• Should see that the selected panels are propagated to the right with 1 channel on in each panel
• Same should work for timelapse image panels with second example.
• Try editing code examples above to get different behaviour.

[will-moore]

@bramalingam Want to try playing with this? I can look over your shoulder or point you at docs etc?

[bramalingam]

@will-moore : I should be fully setup with my laptop by tomorrow. Can start playing around with it tomorrow, if that sounds fine.

[waxenegger]

Very nice feature. Especially for people who want to play around and do things that are programmatically possible but aren't readily usable functions.

[joshmoore]

Biggest bang for your buck? :) Could your example usage go somewhere, @waxenegger ? (I assume as javascript)

[jburel]

Do we start to move some of the examples to https://github.com/ome/community-docs or another repo?
we could rename to community-resources

[will-moore]

It looks like @waxenegger used the Movie figure example above.
I'm not sure if we need to create a space on any repo for users to share examples yet. We can put a couple of examples in the figure help docs and if we hear about any examples from the community we can think of where to put them at the time.

[will-moore]

Another example: This code will load ratings for all selected images and position the images into a histogram of ratings:

var url = window.location.href.split("figure")[0] + "webclient/api/annotations/?type=rating";
var imageIds = figureModel.getSelected().map(p => p.get('imageId'));
url += "&image=" + imageIds.join("&image=");
var paper_width = figureModel.get('paper_width')

$.getJSON(url, function(data) {
    // make a object of imageId:rating
    var ratingMap = {};
    data.annotations.forEach(function(rating){
        var imageId = rating.link.parent.id;
        ratingMap[imageId] = rating.longValue;
    });
    // Need to stack panels in 5 columns - keep track of counts
    var stackCounts = [0,0,0,0,0];
    figureModel.getSelected().forEach(function(p){
        var rating = ratingMap[p.get('imageId')];
        if (rating === undefined) return;
        rating = rating - 1;
        p.set({'x': paper_width * rating/5, 'y':stackCounts[rating] * p.get('height')});
        stackCounts[rating] += 1;
    });
});

[joshmoore]

Nifty!

[joshmoore]

Are these "figure scripts"? :)

[will-moore]

@joshmoore I don't think these are "Figure scripts" since we've used that term previously to refer to Python OMERO.scripts that create figures.
As discussing with @jburel, we will probably put these examples as gists on the figure repo (can gists belong to a repo instead of a user)?

[joshmoore]

re naming: yeah, I definitely see how "scripts" is now taboo.

re gists: no, unfortunately they cannot (easily) belong to the repo. Unfortunately this is going to become another type of download that we will have to manage. (I've been searching for a solution for this myself)

[jburel]

I was looking for option for gist under repo too but that will not be an option

[jburel]

All examples added to https://trello.com/c/5f4RniW4/19-omerofigure-plugins