PersoScan PersoScan

Configuration

Every URL parameter for the PersoScan widget: theme, language, body model, zone detail level, camera behaviour, colours and which UI controls are visible.

Introduction

The PersoScan widget supports extensive customization through URL parameters. Configure appearance, behavior, language, and UI visibility by adding parameters to the iframe src URL.

URL Parameter Format

Add parameters to the embed URL using standard query string syntax:

${WIDGET_URL}?license=your-license-key&param1=value1&param2=value2

General Settings

ParameterTypeDefaultDescription
devModebooleanfalseEnable developer configuration panel for live testing and URL generation
themestringlightColor theme: light or dark
langstringenLanguage code. See Supported lang values
sexstringmaleDefault body model: male or female
initialZonestring-Pre-select a body zone on load. Use a grouped zone key, e.g. lower-back or left-shoulder. See Zone Reference.
instructionsbooleanfalseShow instructions help button for end users

Supported lang values

Use one of these locale codes for the lang parameter.

lang codeLanguage
arArabic
bgBulgarian
csCzech
daDanish
deGerman
enEnglish
esSpanish
etEstonian
fiFinnish
frFrench
hiHindi
huHungarian
itItalian
jaJapanese
koKorean
ltLithuanian
lvLatvian
nbNorwegian (Bokmål)
nlDutch
plPolish
pt-BRPortuguese (Brazilian)
pt-PTPortuguese (European)
roRomanian
svSwedish
trTurkish
ukUkrainian
zh-HansSimplified Chinese

Color Customization

Customize the widget’s color scheme to match your application design. All color parameters accept 6-digit hex codes.

ParameterDefaultDescription
accentColor#0891b2UI accent color for buttons, borders, and interactive elements
highlightColor#0891b2Color for selected body zones on the 3D model
bodyColor#e4edf73D body model base color
elementsLightColor#ffffffUI surface background color used in light theme
elementsDarkColor#171717UI surface background color used in dark theme
transparentBackgroundfalseMake widget background transparent; when true, bgColor is ignored
bgColor#f0f0f0Background color behind the 3D model (used when transparent is off)

Color Example

<iframe
src="https://widget.persoscan.com?license=my-license-key&accentColor=%230891b2&highlightColor=%23ec4899&bodyColor=%23e0e7ff&elementsLightColor=%23ffffff&elementsDarkColor=%23171717&transparentBackground=false&bgColor=%23f9fafb"
width="800"
height="680"
style="border: none; color-scheme: light dark;"
></iframe>

Auto-Rotation

Enable automatic rotation of the 3D body model for a more dynamic presentation.

ParameterTypeDefaultDescription
autoRotatebooleanfalseEnable automatic rotation of the 3D model
autoRotateSpeednumber2Rotation speed (higher = faster, recommended range: 0.5-5)
autoRotateResumeDelaynumber3Seconds to wait before resuming rotation after user interaction

Camera & View

Control the initial camera position, zoom level, and interaction behaviour.

ParameterTypeDefaultDescription
zoomnumber100Initial zoom level (0 to 100)
lockZoombooleanfalsePrevent users from zooming in or out
cameraAnglenumber0Initial vertical camera angle in degrees (-90 to 90)
lockAnglebooleanfalsePrevent users from changing the vertical camera angle
yPosEnabledbooleanfalseEnable vertical body position control
yPosnumber50Initial vertical body position (0 to 100). Requires yPosEnabled=true
lockYPosbooleanfalseLock vertical position; disables scroll and drag controls
changeYOnScrollbooleanfalseAllow scroll wheel to adjust vertical body position. Requires yPosEnabled=true
changeYOnDragbooleanfalseAllow drag to adjust vertical body position. Requires yPosEnabled=true

UI Visibility Toggles

Hide specific UI elements to create simplified or custom user experiences. All visibility parameters are boolean; showForm defaults to false (form hidden), while the other hide* toggles default to false (visible).

ParameterDescription
showFormShow the form UI panel. Default is false (3D model only)
hideSexSelectHide the male/female body model toggle
sexSelectInFormMove the male/female toggle into the form panel instead of on the 3D view
sexSelectPositionPosition of on-screen sex selector when it is shown outside the form
confirmModalOnClickShow a confirmation modal when the user clicks a body zone
hideTooltipHide the hover tooltip that appears over zones
hideHoverMarkerHide the hover highlight marker on the 3D model
hideZoneSelectionHide the zone selection dropdown
hidePainInputHide the entire pain input form
hidePainSliderHide the pain intensity slider (keeps other pain fields)
hidePainTypeHide the pain type selector (sharp, dull, burning, etc.)
hidePainNotesHide the notes text field
hideSubmitButtonHide the submit button
hideExportHide the JSON export button

Zone Detail Level

Control the granularity of body zone names shown to users.

ParameterTypeDefaultDescription
zoneDetailLevelstringgroupedZone granularity: grouped (23 broad body regions, e.g. “Left Arm”) or detailed (158 precise zones, e.g. “Front of Upper Arm”)

Form Positioning

Control where the UI form appears on screen.

ParameterTypeDefaultValid Values
formPositionstringtop lefttop left, top center, top right, center left, center right, bottom left, bottom center, bottom right
sexSelectPositionstringbottom centertop left, top center, top right, center left, center right, bottom left, bottom center, bottom right

Complete Configuration Example

Here’s an advanced example combining multiple customization options:

<!-- Advanced configuration with multiple parameters -->
<iframe
  src="https://widget.persoscan.com?license=my-license-key&theme=dark&sex=female&autoRotate=true&autoRotateSpeed=1.5&hideExport=true&accentColor=%23a855f7&highlightColor=%23c084fc&bodyColor=%232d3748&bgColor=%231a202c"
  width="800"
  height="680"
  allow="fullscreen"
  style="border: none; color-scheme: light dark;"
  title="PersoScan Widget"
></iframe>

This configuration:

  • Uses dark theme
  • Defaults to female body model
  • Enables auto-rotation at 1.5x speed
  • Hides the export button
  • Uses custom purple accent colors
  • Dark body and background colors

Next Steps

Last updated: March 14, 2026