JavaScript API v3.14

osapi.jive.corev3.HeaderSettings

This object defines the configuration for displaying the header. It is currently only used for places but may be used in other parts of the application in the future, such as pages or profiles.

 {
     "bgPresetImageUrl" : "/resources/statics/1234/header_img.jpg",
     "bgColor" : "cccccc",
     "bgRepeat" : "cover",
     "bgPosition" : "center center",
     "bgType" : "preset",
     "textColor" : "ffffff"
 }

Since: 3.9

Properties

bgColor
bgCustomImageName
bgCustomImageUrl
bgPosition
bgPresetImageUrl
bgRepeat
bgType
textColor

Properties

Property	Type	Mode †	Description
`bgColor`	`String`	optional	↑ The header color expressed as an HTML color code, e.g. transparent, ffffff = white, 000000 = black.
`bgCustomImageName`	`String`	optional	↑ The display name of the custom header background image
`bgCustomImageUrl`	`String`	optional	↑ The URL of the header background image for an image other than the pre-installed background images.
`bgPosition`	`String`	optional	↑ The background image position value expressed as a "background-position" CSS value. Possible values are: left top left center left bottom center top center center center bottom right top right center right bottom If only one keyword is specified, the other value is assumed to be "center"
`bgPresetImageUrl`	`String`	optional	↑ The URL of the header background image when a pre-installed header background image is selected.
`bgRepeat`	`String`	optional	↑ The background image repeat value. Possible values are: repeat - The background image will repeat both vertically and horizontally. repeat-x - The background image will repeat horizontally. repeat-y - The background image will repeat vertically. no-repeat - The background image will not repeat. cover - The background image will be scaled to fit.
`bgType`	`String`	optional	↑ Indicates whether the background image is a pre-installed image ("preset") or an image specified or uploaded by a user ("custom")
`textColor`	`String`	optional	↑ The header text color expressed as an HTML color code, e.g. transparent, ffffff = white, 000000 = black.