Differences

This shows you the differences between two versions of the page.

--- choicegroupanchorexclusive [2022/09/28 20:42] – [choiceGroupAnchorExclusive - Anchor or make choices exclusive in a choice group] admin
+++ choicegroupanchorexclusive [2023/09/24 16:47] (current) – [choiceGroupAnchorExclusive - Anchor or make choices exclusive in a choice group] admin
@@ Line 2: / Line 2: @@
 The choiceGroupAnchorExclusive function can be used to anchor choices in a randomized choice group and/or make choices exclusive in multi-select choice group.
-This function is available for a reasonable fee. Contact **[[https://community.qualtrics.com/XMcommunity/messages/add/TomG|TomG]]** on the Qualtrics Community to learn more.
+This function is available for a reasonable fee. Contact **[[https://community.qualtrics.com/inbox/conversation?with=373|TomG]]** on the Qualtrics Community to learn more.
 ===== Set-up Instructions =====
 ==== Survey Header ====
-To make the function available to all questions in the survey, copy the function to the Survey Header inside a script tag:
 Add the choiceGroupAnchorExclusive function to the survey header to make it available to any question in the survey.   Go to Look & Feel -> General -> Header edit -> {{::icon_source.jpg?20|}} and paste the provided choiceGroupAnchorExclusive function JS:
 <code>
@@ Line 11: / Line 10: @@
 </code>
 Alternatively, paste the choiceGroupAnchorExclusive function JS into a question's JS outside the existing Qualtrics functions to make it available to questions on the page.
+==== Choice Group Setup ====
+For **choiceGroupAnchorExclusive** to work, the choice group names **MUST NOT** be hidden in Qualtrics.
+To hide choice group names on an individual basis, put the group name inside a span with the class ''hide''. For example:
+<code>
+<span class="hide">Group name</span>
+</code>
+If **ALL** choice groups are to be hidden and only 'anchor' functionality is required ('exclusive' is NOT required), choice groups can be removed after anchoring by using the **[[choicegroupanchorexclusive#removeCgs|removeCgs]]** option.
 ==== Choice Setup ====
-To anchor a choice within the choice group, put the choice text inside a span with the class anchor. For example:
+To anchor a choice within the choice group, put the choice text inside a span with the class ''anchor''. For example:
 <code>
 <span class="anchor">Choice text</span>
 </code>
-To make a choice exclusive within a choice group, put the choice text inside a span with the class exclusive. For example:
+To make a choice exclusive within a choice group, put the choice text inside a span with the class ''exclusive''. For example:
 <code>
 <span class="exclusive">Choice text</span>
@@ Line 25: / Line 32: @@
 </code>
 If there are multiple anchored choices within a choice group, exclusive choices will be anchored below non-exclusive choices.
+==== JavaScript Function Call ====
+Call the choicegroupAnchorExclusive function from the question's addOnload function using the default settings as follows:
+<code>
+Qualtrics.SurveyEngine.addOnload(function() {
+	choicegroupAnchorExclusive(this);
+});
+</code>
+To override the default options, specify the desired options in the second function argument as an object. For example:
+<code>
+Qualtrics.SurveyEngine.addOnload(function() {
+	choicegroupAnchorExclusive(this,{removeCgs:true});
+});
+</code>
+See **[[choicegroupAnchorExclusive#Options|Options]]** for details.
+===== Options =====
+==== removeCgs ====
+**removeCgs** is a boolean that specifies if choice groups should be removed after choices are anchored. Setting **removeCgs** to true cancels all exclusive choice group functionality since choice groups are required for operation. Therefore, **removeCgs** should only be used if **only** anchor functionality if required.
+Default: false
 ====== Qualtrics Wiki ======
 [[start|Qualtrics Wiki]]