Skip to content

Batched Illustrations

Overview

Tip

For FlowJo users, this feature is akin to the Layout Editor. For BD FACSDiva users, this feature is akin to exporting the global worksheet for all samples in an experiment.

Batched illustrations allow you to create a template page, and then render that page for each value in a set of variables. For example, you could use flow plots, text boxes and arrows to create a gating hierarchy, and then render that gating hierarchy for all of your FCS files.

Batch variables can be used to control the selected FCS file, x/y channel and/or population in flow plots, and to insert variable text into textboxes.

Variable iteration in batched illustrations works similarly as in pivot tables (see the pivoting model), except that batched variables are rendered as separate pages on-screen or in the exported PDF.

Creating a Batched Illustration

Howto

  1. Create a new illustration. In the top menu bar, toggle on the batched illustration switch.

    batched illustration switch

  2. Insert components such as text boxes, flow plots and lines/arrows to create your template.

    While a flow plot is selected, enable batching for the desired settings in the settings panel on the right. If this is the first time in this illustration that you have enabled batching for that variable, the settings will say “No files match!” Click the CHANGE PAGE VARIABLES button to setup the variable.

  3. In the Page Variables dialog that opens, select the variable name(s) for which you have enabled batching, and then select the values that you want to iterate. You can also toggle the All switch, which will use all values, even if you upload more FCS files or change annotation values in the future. When batching more than one variable, each combination of variables will be generated. Click CLOSE.

    If at any time you need to change these selections, click the PAGE VARIABLES button in the top toolbar.

  4. While typing into a textbox, you can insert text variables using the Insert Batch Variable dropdown in the toolbar.

    insert batch variable

    These show up with dotted outlines in the textbox:

    batch variable placeholder example

  5. Continue laying out your illustration as desired.

  6. Now you can use the flipper at the bottom of the screen to view your illustration for different batched variables (pages), or export your illustration as a multi-page PDF using the File menu.

Tip

You may prefer to enable a fixed page size instead of the default extra-large page size. Do so using the File > Page Size menu.

Example: Exporting a gating hierarchy for all FCS files in your experiment

  1. Create a new illustration.

  2. Toggle on the Batched Illustration switch.

    batched illustration switch

  3. Insert a flow plot. While it is selected, enable the Batch switch for the FCS File setting in the settings panel, and then click CHANGE PAGE VARIABLES.

    batch setting for flow plot

  4. In the Page Variables dialog that opens, for Batch variable 1, select “FCS Files” and select all of your files. Close the dialog.

    page variables settings

  5. Continue laying out your illustration, using flow plots, text boxes, lines/arrows and other components as desired to create your gating hierarchy. Tip: you can copy and paste the first flow plot or select multiple flow plots at once to avoid having to enable the Batch switch on each plot individually.

  6. Now let’s add a textbox so we can label each page with the FCS file that is currently displayed. Click the Textbox component in the toolbar and place it in your illustration. While your cursor is inside of the textbox, click Insert batch variable from the toolbar and select Filename.

    insert batch variable

    Your textbox will show this variable value in a dotted outline. You can insert other batch variables or any other text that you want in the same text box.

    variable in textbox

  7. By now your gating hierarchy might look something like below. You can use the flipper controls at the bottom to view your hierarchy for other samples, or export the illustration as a PDF using the File menu. final result