SurveyFactory Documentation Documentation Ranking List template variables
Ranking List template variables

Template variables > Ranking List

Ranking List template variables are defined for each question in your survey that is of type Ranking List. If you are looking for template variables for another question type, please see template variables. This page details the structure of the question template variables so you can know what to expect when designing your templates.

question.
   # Variables in common with all question types
   id
   type = 'RankingList'
   text
   instructions
   required
   number
   sortorder
   scored
   hidden
   valid
   answered
   inloop[]
   loops.
   template.
   errors[]

   # Additional variables for Ranking List question type
   unique_answers
   rank_minimum
   rank_maximum
   rank_step
   rank_strategy
   rank_strategyauto

   answerorder
   answers[]
      # Variables for each answer in question.answers[]
      id
      label
      default
      required
      fixedposition
      f_name
      f_value
      f_uniqueid
      template.

question.

This document assumes that you have the question object in a variable named question. This is most often achieved in a loop, such as:

[% FOREACH question IN survey.questions; %]

or using a custom template function such as getQuestion:

[% question = getQuestion(id); %]

question.id

Contains the ID # of the question as listed in the survey editor. This is unique across all of your surveys and is used in getQuestion and other custom template functions.

question.type

This variable will be set to 'RankingList' for a Ranking List question type.