Skip to Content

Wiki source code of 03d. Venn

Last modified by Tom Jardine on 06/11/2025, 14:24
Hide last authors
Tom Jardine 1.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 The Venn diagram functionality enables users to quickly and easily build complex search terms by manipulating visual representations of data, known as sets. By positioning the sets so they overlay, relationships can be established to allow a broader understanding of the underlying data.
6
7 To access the Venn diagram functionality, click **Venn** at the top of the screen.
8
9 The Venn diagram functionality runs in two distinct modes: **Edit** and **Run**. When first accessed, **Edit** mode will be activated.
10
11 To clear the canvas and start the building process again, click **New Venn** on the control panel.
12
13 = Edit Mode =
14
15 In this mode, the sets are configured with the required data. Click on any set to edit the values used.
16
17 == Adding a Single Set ==
18
19 Click on a set to open the **Create Set** window. The **Fields** drop-down list contains all available fields in the loaded index and, once selected, the associated values will be displayed.
20
21 There are three view options for the list of available values. The **List** option will display the values in a list, where clicking the checkbox next to the required field will load it as a set and return to **Edit** mode.
22
23 The **Numbers** option allows a number range to be specified using the **From** and **To** textboxes. Not specifying a range will create an open-ended range search. Click **Add To Selected** then **Set Value** to add the range as a set.
24
25 The **Dates** option allows data range selection via a date picker. To use a single data value, use only the **From** data picker. To add a data range as a set, enter the required dates in the **From** and **To** date picker boxes, click **Add To Selected** then **Set Value**.
26
27 == Adding Multiple Sets ==
28
29 To add more than one set in a single selection, the **Multi Select** option is required.
30
31 Follow the same process as adding a single set but click **Multi Select** before selecting the values. Any number of sets can be created, with the **Selected Values** list displaying all currently selected values. To remove a value, click the checkbox next to the relevant value.
32
33 Click **Create Multiple Sets** to separate the values into individual sets.
34
35 To combine the values into a single set, type a name in the **Combined Set Name** textbox and click either **Combine Into Set (OR)** to generate a set with all of the values selected or click **Combine Into Set (AND)** to generate a set with the only values that are shared across the different sets. If multiple values from the same field are selected and **Combine Into Set (AND)** is selected, no values will be displayed.
36
37 == Adding Saved Reports ==
38
39 In the **Create Set** screen, click **Saved Queries** to select from a list of saved queries created from the currently loaded index. Load an individual report by clicking the checkbox next to the relevant report or load multiple reports by clicking **Multi Select** before clicking **Saved Queries**. Once multiple reports have been selected, review the selections in the **Selected Reports** tab and click **Add to Venn** to complete the process.
40
41 == Adding the Current Query ==
42
43 In the **Create Set** screen, click **Add Current Query**. Search terms and filter values will only affect the values in the individual set.
44
45 = Run Mode =
46
47 Click **Run Venn** on the control panel located on the right of the screen to enter **Run** mode.
48
49 To move a set or label, drag and drop it to the desired position on the canvas. To manually resize a set, right click it and move the mouse towards or away from the set. To move the canvas to ensure all intersections are kept intact, click anywhere on the canvas and drag it into the required position.
50
51 == Drill Through ==
52
53 To drill through to the underlying data, double click on the set or intersection. This will display the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen with the data filtered to show the specified records.
54
55 To return to the previous screen, click the **Undo** button. Alternatively, clicking **Venn** in the navigation bar will return to the previous screen while preserving the resulting query.
56
57 == Removing Sets ==
58
59 To remove a set from the canvas, drag it to the **Recycle Bin** located at the bottom-left of the canvas.
60
61 == Set Information ==
62
63 When in **Run** mode, clicking the **Sets** button on the control panel provides three tabs: **Hits**, **Workspace** and **Measures**. A fourth tab, **Sets**, becomes available when adding a **Multi Select **Venn** **set to a canvas already containing overlapped** Multi Select **Venn sets.
64
65 === Hits ===
66
67 The **Hits** tab displays detailed information regarding the sets and any intersections, each represented by a scaled image.
68
69 Each set and intersection description details its contents along with a count of the records.
70
71 Hovering the mouse cursor over each section highlights the position on the Venn canvas and clicking any of the images toggles the visibility of the associated label.
72
73 By default, labels are displayed in a collapsed state. Expand the label by click the down arrow on the label. Hide the label using the **X** icon and show it by clicking the relevant image in the **Hits** tab. Only totals that have been created in the **Measures** tab will be displayed on a label.
74
75 To change the value of a set without entering **Edit** mode, click the **Cog** icon next to any individual set to open the **Filter Panel**. Change the value of the field using the drop-down list and click **Modify Set** to update the set on the canvas. To modify the field used for the set, click **New Set**. This will empty the existing field value and allow the addition of one or more fields to the **Filter Panel**. Use the **Name** textbox to customise the name, otherwise a default name will be applied. Configure the field options using the drop-down list and click **Add Set** to add the new set to the canvas.
76
77 === Workspace ===
78
79 The Workspace tab provides the option to store an intersection as a single saved set. This is saved for future reference when the Venn diagram functionality is accessed and is not session dependent.
80
81 To add an intersection to the **Workspace**, drag it into the tab. To remove an intersection, drag it to the **Recycle Bin** located at the bottom of the canvas or click the red **X** icon inside the **Workspace** tab.
82
83 When the **Workspace** tab is selected, the movement of sets around the canvas is disabled. Choose any other tab in the control panel to reactivate this feature.
84
85 === Measures ===
86
87 The **Measures** tab allows the configuration of totals that are displayed in the set labels or over the sets. By default, there will be a single count total for a set when it created.
88
89 Clicking the **Cog** icon displays the **Totals** window. To amend the existing total, make the required changes and click **Close** to save changes. To add additional totals, click the **New Total** button.
90
91 Name the total using the **Total Label** textbox and select an aggregation from the **Total Type** drop-down list. The **Value Prefix** and **Value Suffix** allows characters to be inserted before and after a value and the **Value Format** drop-down list contains options to customise how values are displayed. Use the arrows next to the aggregation name to reorder the totals and delete a total by clicking the **X** icon. Click **Close** to return to the **Measures** tab, where all created totals will be displayed in the specified order.
92
93 To toggle between the totals displayed, click the radio button for the required total in the **Measures** tab.
94
95 The **Measures** tab also allows **Distinct Counts** to be applied to sets on the canvas. This provides a count of the unique values for a given set or intersection rather than a count of all values. Use the radio buttons to select a distinct count that will be applied.
96
97 Please note that **Distinct Counts** are only available if the system administrator has created them.
98
99 === Sets ===
100
101 This tab becomes available when more than one instance of the **Create Multiple Sets** option is used in the **Create Set** window. When added, the multiple sets will not be automatically visible on the canvas. By dragging and dropping them from this tab, they can be moved onto the canvas.
102
103 = Shapes =
104
105 To change the shape of a set, click the **Shapes** button in **Run** or **Edit** mode.
106
107 A selection of shapes are available and are applied by dragging the shape selection onto the required set.
108
109 = Colours =
110
111 The change the colour of a set, click the **Colours** button in **Run** mode.
112
113 A selection of colours are available and are applied by dragging the colour selection onto the required set.
114
115 = Layout =
116
117 To further customise the appearance of sets, click the **Layout** button in **Run** mode.
118
119 == Global Settings ==
120
121 The following options will apply to all sets on the canvas.
122
123 The **Auto Size Sets** option will proportionally size the sets based on the total that is selected under the Measures tab. This option disables manual sizing of sets.
124
125 To display the details of an intersection inside a set, enable the **Show Names Inside Sets** option. This provides a means of hiding the label without losing a descriptor of the set.
126
127 The **Show Field Names** option will prefix the value of sets with the name of the field, especially useful when distinguishing between sets that contain similar values.
128
129 Use the **Font Size** drop-down list to apply a standardised font size across all sets. This only applies to the total in the set and not to the set label. The **Shape** drop-down list will change all sets that are currently on the canvas to the same selection. Subsequent sets will continue to be generated using the default circle shape.
130
131 == Individual Settings ==
132
133 Click the set name to expand the individual set options.
134
135 Use the **Colour** option to specify a custom colour by either typing the hex code or selecting a colour from the popup colour picker. The **Shape** drop-down list allows the selection of the predefined shape options.
136
137 Click **Apply** to save settings changes and return to the **Venn** screen.
138
139 = Actions =
140
141 The Actions button provides a number of options for changing the layout during **Run** mode.
142
143 (% border="1" cellspacing="0" class="MsoTableGrid" style="border-collapse:collapse; border:1pt solid windowtext; width:1024px" %)
144 |(% style="background-color:#ed7d31; background:#ed7d31; border-style:solid; border-width:1pt; width:118px" width="83" %)(((
145 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
146 (% style="color:white" %)Icon
147 )))|(% style="background-color:#ed7d31; background:#ed7d31; border-bottom-style:solid; border-bottom-width:1pt; border-left:1pt solid; border-right-style:solid; border-right-width:1pt; border-top-style:solid; border-top-width:1pt; width:1362px" width="667" %)(((
148 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
149 (% style="color:white" %)Description
150 )))
151 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:118px" width="83" %)(((
152 (% style="text-align:center" %)
153 [[image:venn-1.png||queryString="width=50&height=51" height="51" width="50"]]
154
155 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
156
157 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:1362px" width="667" %)(((
158 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
159 **Apply To All**
160
161 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
162 When enabled, resizing a single set will result in all sets on the canvas being resized at the same time.
163 )))
164 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:118px" width="83" %)(((
165 (% style="text-align:center" %)
166 [[image:venn-2.png||queryString="width=50&height=51" height="51" width="50"]]
167
168 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
169
170 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:1362px" width="667" %)(((
171 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
172 **Reset Sets**
173
174 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
175 Places sets back to their original starting position and original size.
176 )))
177 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:118px" width="83" %)(((
178 (% style="text-align:center" %)
179 [[image:venn-3.png||queryString="width=50&height=50" height="50" width="50"]]
180
181 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
182
183 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:1362px" width="667" %)(((
184 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
185 **Arrange Sets**
186
187 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
188 Only available when there are less than six sets on the canvas, this button automatically arranges sets so that they intersect with each other. Any sets that have been resized will be restored to their original size.
189 )))
190 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:118px" width="83" %)(((
191 (% style="text-align:center" %)
192 [[image:venn-4.png||queryString="width=50&height=49" height="49" width="50"]]
193
194 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
195
196 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:1362px" width="667" %)(((
197 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
198 **Rename Elements**
199
200 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
201 Renames the label of a set. Click this button then either the label or set to rename it. Enter a new name and click **Rename** to complete the process.
202 )))
203 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:118px" width="83" %)(((
204 (% style="text-align:center" %)
205 [[image:venn-5.png||queryString="width=50&height=50" height="50" width="50"]]
206
207 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
208
209 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:1362px" width="667" %)(((
210 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
211 **Rotate Sets**
212
213 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
214 Use this option to change the rotation of a set. Once selected, click on the desired set and move the mouse towards or away from the set to change the rotation.
215 )))
216 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:118px" width="83" %)(((
217 (% style="text-align:center" %)
218 [[image:venn-6.png||queryString="width=50&height=50" height="50" width="50"]]
219
220 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
221
222 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:1362px" width="667" %)(((
223 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
224 **Toggle External labels**
225
226 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
227 Click this option to hide all external labels from any sets currently visible on the canvas.
228 )))