Documentation Docs
Documentation Docs

IHeader

A survey header configuration interface.

An IHeader object configures advanced survey header appearance settings. To apply them, you need to assign the object to the header property of your theme configuration and set the headerView property to "advanced".

backgroundImage property

An image to display in the background of the header. Accepts a base64 or URL string value.

Type:
string readonly
Implemented in:
IHeader

A string value that specifies how to resize a background image to fit it into the header.

Possible values:

  • "cover" (default)
    Scales the image to the smallest possible size that fills the header. The image preserves its aspect ratio but can be cropped if the header's proportions differ from that of the element.
  • "fill"
    Stretches the image to fill the entire header.
  • "contain"
    Scales the image to the largest possible size without cropping or stretching it.
  • "tile"
    Tiles as many copies of the image as needed to fill the entire header.
Type:
"contain" | "cover" | "fill" | "tile" readonly
Implemented in:
IHeader

A value from 0 to 1 that specifies how transparent the background image should be: 0 makes the image completely transparent, and 1 makes it opaque.

Type:
number readonly
Implemented in:
IHeader

A string value that specifies the survey description position within the header in the horizontal direction.

Possible values:

  • "left" (default)
  • "right"
  • "center"

To specify a survey description, set SurveyModel's description property.

Type:
HorizontalAlignment readonly
Implemented in:
IHeader

A string value that specifies the survey description position within the header in the vertical direction.

Possible values:

  • "bottom" (default)
  • "top"
  • "middle"

To specify a survey description, set SurveyModel's description property.

Type:
VerticalAlignment readonly
Implemented in:
IHeader
height property

The height of the survey header in pixels.

Default value: 256

Type:
number readonly
Implemented in:
IHeader
inheritWidthFrom property

A string value that specifies whether the header spans the width of the survey or that of the survey container.

Possible values:

  • "survey"
    The header width is the same as the survey width.
  • "container" (default)
    The header width is the same as the survey container width.
Type:
"survey" | "container" readonly
Implemented in:
IHeader
See also:
SurveyModel.width , SurveyModel.widthMode
logoPositionX property

A string value that specifies the logo position within the header in the horizontal direction.

Possible values:

  • "right" (default)
  • "left"
  • "center"

To specify a logo, set SurveyModel's logo property.

Type:
HorizontalAlignment readonly
Implemented in:
IHeader
logoPositionY property

A string value that specifies the logo position within the header in the vertical direction.

Possible values:

  • "top" (default)
  • "bottom"
  • "middle"

To specify a logo, set SurveyModel's logo property.

Type:
VerticalAlignment readonly
Implemented in:
IHeader
overlapEnabled property

A Boolean value that specifies whether the header overlaps the survey content.

Default value: false

Type:
boolean readonly
Implemented in:
IHeader
textAreaWidth property

The width of the header area that contains the survey title and description, measured in pixels.

Default value: 512

Type:
number readonly
Implemented in:
IHeader
titlePositionX property

A string value that specifies the survey title position within the header in the horizontal direction.

Possible values:

  • "left" (default)
  • "right"
  • "center"

To specify a survey title, set SurveyModel's title property.

Type:
HorizontalAlignment readonly
Implemented in:
IHeader
titlePositionY property

A string value that specifies the survey title position within the header in the vertical direction.

Possible values:

  • "bottom" (default)
  • "top"
  • "middle"

To specify a survey title, set SurveyModel's title property.

Type:
VerticalAlignment readonly
Implemented in:
IHeader

Copyright © 2024 Devsoft Baltic OÜ. All rights reserved.

Your cookie settings

We use cookies on our site to make your browsing experience more convenient and personal. In some cases, they are essential to making the site work properly. By clicking "Accept All", you consent to the use of all cookies in accordance with our Terms of Use & Privacy Statement. However, you may visit "Cookie settings" to provide a controlled consent.

Your renewal subscription expires soon.

Since the license is perpetual, you will still have permanent access to the product versions released within the first 12 month of the original purchase date.

If you wish to continue receiving technical support from our Help Desk specialists and maintain access to the latest product updates, make sure to renew your subscription by clicking the "Renew" button below.

Your renewal subscription has expired.

Since the license is perpetual, you will still have permanent access to the product versions released within the first 12 month of the original purchase date.

If you wish to continue receiving technical support from our Help Desk specialists and maintain access to the latest product updates, make sure to renew your subscription by clicking the "Renew" button below.