Websites v4 docs v5.2.5
Preparing search index...
API Reference/State
GlobalConfig
Interface GlobalConfig
interface
GlobalConfig
{
_id
:
string
|
null
;
agencyId
:
number
|
null
;
brandingRules
?:
BrandingRule
[]
;
buttons
?:
{
[
variant
:
string
]:
{
backgroundColor
?:
string
;
hoverBackgroundColor
?:
string
;
hoverTextColor
?:
string
;
textColor
?:
string
;
}
;
}
;
customVariables
?:
{
[
name
:
string
]:
string
}
;
domain
:
string
;
externalScripts
:
{
analytics
:
{
gtmCustomEventNames
:
{
branchEnquiry
?:
string
;
emailPortal
?:
string
;
expertValuation
?:
string
;
instantValuation
?:
string
;
mortgageEnquiry
?:
string
;
sendPropertyToFriend
?:
string
;
staffEnquiry
?:
string
;
userRegistration
?:
string
;
viewingEnquiry
?:
string
;
}
;
gtmId
?:
string
;
items
:
AnalyticsScriptItem
[]
;
}
;
standalone
:
{
items
:
ScriptItem
[]
}
;
}
;
floatingButtons
?:
FloatingButton
[]
;
footer
:
Footer
;
generalSettings
:
{
buttonRounding
?:
ButtonRounding
;
cookiePolicyLink
?:
string
;
defaultCanonicalDomain
?:
string
;
disableHomeflowCookieConsent
:
boolean
;
disableStaffPages
?:
boolean
;
enableGoogleStaticMaps
:
boolean
;
mapsMaxZoom
?:
number
;
mapsMinZoom
?:
number
;
useLegacyArticles
:
boolean
;
}
;
mainNav
:
{
variant
:
string
}
;
propertyCard
:
{
variant
:
string
}
;
searchForm
:
SearchForm
;
sectionPadding
:
number
;
theme
?:
string
;
typography
:
Typography
;
urls
?:
{
article
?:
string
;
articleList
?:
string
;
branch
?:
string
;
branchList
?:
string
;
propertyReference
?:
boolean
;
}
;
}
Index
Properties
_
id
agency
Id
branding
Rules?
buttons?
custom
Variables?
domain
external
Scripts
floating
Buttons?
footer
general
Settings
main
Nav
property
Card
search
Form
section
Padding
theme?
typography
urls?
Properties
_
id
_id
:
string
|
null
agency
Id
agencyId
:
number
|
null
Optional
branding
Rules
brandingRules
?:
BrandingRule
[]
Optional
buttons
buttons
?:
{
[
variant
:
string
]:
{
backgroundColor
?:
string
;
hoverBackgroundColor
?:
string
;
hoverTextColor
?:
string
;
textColor
?:
string
;
}
;
}
Optional
custom
Variables
customVariables
?:
{
[
name
:
string
]:
string
}
domain
domain
:
string
external
Scripts
externalScripts
:
{
analytics
:
{
gtmCustomEventNames
:
{
branchEnquiry
?:
string
;
emailPortal
?:
string
;
expertValuation
?:
string
;
instantValuation
?:
string
;
mortgageEnquiry
?:
string
;
sendPropertyToFriend
?:
string
;
staffEnquiry
?:
string
;
userRegistration
?:
string
;
viewingEnquiry
?:
string
;
}
;
gtmId
?:
string
;
items
:
AnalyticsScriptItem
[]
;
}
;
standalone
:
{
items
:
ScriptItem
[]
}
;
}
Optional
floating
Buttons
floatingButtons
?:
FloatingButton
[]
footer
footer
:
Footer
general
Settings
generalSettings
:
{
buttonRounding
?:
ButtonRounding
;
cookiePolicyLink
?:
string
;
defaultCanonicalDomain
?:
string
;
disableHomeflowCookieConsent
:
boolean
;
disableStaffPages
?:
boolean
;
enableGoogleStaticMaps
:
boolean
;
mapsMaxZoom
?:
number
;
mapsMinZoom
?:
number
;
useLegacyArticles
:
boolean
;
}
main
Nav
mainNav
:
{
variant
:
string
}
property
Card
propertyCard
:
{
variant
:
string
}
search
Form
searchForm
:
SearchForm
section
Padding
sectionPadding
:
number
Optional
theme
theme
?:
string
typography
typography
:
Typography
Optional
urls
urls
?:
{
article
?:
string
;
articleList
?:
string
;
branch
?:
string
;
branchList
?:
string
;
propertyReference
?:
boolean
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
_
id
agency
Id
branding
Rules
buttons
custom
Variables
domain
external
Scripts
floating
Buttons
footer
general
Settings
main
Nav
property
Card
search
Form
section
Padding
theme
typography
urls
Websites v4 docs v5.2.5
Loading...