Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • AppFeatureTypes
    • AppFeatures

Index

Properties

Properties

Optional autoFullscreen

autoFullscreen: boolean

Optional autoOpenOnMobile

autoOpenOnMobile: boolean

Optional autoOpenOnMobileIfFlatIsSelected

autoOpenOnMobileIfFlatIsSelected: boolean

Optional autoscrollDesktop

autoscrollDesktop: boolean

If URL contains data that indicates open flat or view other than first, SmartMakieta will be scrolled into view.

Optional autoscrollIntoViewRatio

autoscrollIntoViewRatio: number

Maximal ratio for autoscroll into view, empty if disabled

Optional autoscrollIntoViewTime

autoscrollIntoViewTime: number

Time required for autoscroll to initiate, default is 5000ms

Optional autoscrollOffset

autoscrollOffset: number

Set offset in pixels to recalculate height of SmartMakieta and website's navigation

Optional availableLanguages

availableLanguages: string[]

Available languages list

Optional blockDigitsInFormName

blockDigitsInFormName: boolean

Block digits in form name field

Optional changeFlatWithFlatMediaOnDesktop

changeFlatWithFlatMediaOnDesktop: "Building" | "Elevation" | "Dollhouse" | "Tour" | "TourOutside"

Force changing flatMedia while changing flat on desktop

Optional closeFilter

closeFilter: boolean

Filters closed on app start

Optional compareCustomPropRoomCount

compareCustomPropRoomCount: string

Set custom prop to be displayed instead roomCount in compare

Optional concealableDesktopSidebar

concealableDesktopSidebar: boolean

Enable concealable sidebar in desktop app

Optional concealableDesktopSidebarDefaultHidden

concealableDesktopSidebarDefaultHidden: boolean

Makes concealable sidebar hidden by default

Optional concealableSidebarSecondaryMenu

concealableSidebarSecondaryMenu: boolean

Open secondary menu when sidebar is hidden

Optional contactFormFullNameOptional

contactFormFullNameOptional: boolean

Optional contactFormPhoneOptional

contactFormPhoneOptional: boolean

Optional currency

currency: string

Currency to use

Optional customDataLayerName

customDataLayerName: string

If SmartMakieta is implemented on site with GTM with custom data layer name (not default dataLayer), this custom data layer name should be passed here

Optional customDollhouseProp

customDollhouseProp: string

Name of prop with list of apartment dollhouses

Optional customExteriorTourProp

customExteriorTourProp: string

Name of prop with list of apartment exterior tours

Optional customFormPhoneValidation

customFormPhoneValidation: boolean

Number validation regex. empty for disabled

Optional customFormPhoneValidationRegex

customFormPhoneValidationRegex: string

Number validation regex. empty for disabled

Optional customHideableTextFontWidthMultiplier

customHideableTextFontWidthMultiplier: number

Custom hideable text font width multiplier, for use with fonts other than default

Optional customStyleClassname

customStyleClassname: string

Adds custom style className

Optional customStyleId

customStyleId: string

Adds custom styles to 3D Twin

Optional customTourProp

customTourProp: string

Name of prop with list of apartment tours

Optional debounceAppModeChangeInMilliseconds

debounceAppModeChangeInMilliseconds: number

Debonces changing application mode (mobile/desktop) after screen resize, value in milliseconds. If value equals 0, there will be no debounce

defaultvalue

300 [ms]

Optional debounceAppResizeInMillisecondsDesktop

debounceAppResizeInMillisecondsDesktop: number

Debounces changing of app size after screen resize on desktop devices

defaultvalue

300 [ms]

Optional debounceAppResizeInMillisecondsMobile

debounceAppResizeInMillisecondsMobile: number

Debounces changing of app size after screen resize on mobile devices

defaultvalue

300 [ms]

Optional defaultFlatListCards

defaultFlatListCards: boolean

Optional desktopNewViewerMaxWidthToHeightRatio

desktopNewViewerMaxWidthToHeightRatio: number | DesktopNewViewerWidthToHeightRatio[]

Enables horizontal stretch of viewer on desktop. Define how stretched can it be. i.e. value 2 will indicate that width of viewer can be 2 times its height Can also take key-value object which defines ratio of app to ratio of viewer

Optional disableAutoOpenOnMobileIfCompareIsOpen

disableAutoOpenOnMobileIfCompareIsOpen: boolean

Disables auto opening app on mobile if url contains info about opened compare view

Optional disableAutoOpenOnMobileIfNotFirstView

disableAutoOpenOnMobileIfNotFirstView: boolean

Optional disableBuildingButton

disableBuildingButton: boolean

Disable Building Button and Building List that is dependent on that

Optional disableCloseOpenFlatWhenSwitchingBuildings

disableCloseOpenFlatWhenSwitchingBuildings: boolean

By default if user has open flat and goes to another view/building (which does not containt open flat) than flat details view is closed and user see flat list. Set this value to true to prevent this behaviour. User will be able to navigate between views/buildings without flat details being closed

Optional disableCompare

disableCompare: boolean

Disables compare feature

Optional disableFlatCardsInForm

disableFlatCardsInForm: boolean

Disable flats cards in contact form

Optional disableFlatInfoCard

disableFlatInfoCard: boolean

Disables flatCardInfo when hovers the flat frame in viewport

Optional disableHideFilters

disableHideFilters: boolean

Disable desktop button to hide filters

Optional disableInquiryForReserved

disableInquiryForReserved: boolean

Disable sending inquiry for reserved flats

Optional disableInquiryViewModeSwitch

disableInquiryViewModeSwitch: boolean

Disables inquiry feature ONLY in viewModeSwitch

Optional disableLocalStorage

disableLocalStorage: boolean

Disable local storage

deprecated

Optional disableMinimapAutoFit

disableMinimapAutoFit: boolean

Disable minimap auto fit

Optional disableMobile3dView

disableMobile3dView: boolean

Disable mobile 3d view

Optional disableMobileLandscapeRotateOverlay

disableMobileLandscapeRotateOverlay: boolean

Disables overlay that is shown on mobile when device is in landscape mode

Optional disableMobileViewsSlider

disableMobileViewsSlider: boolean

Disable bottom mobile views slider

Optional disablePromoFlatsAlwaysOnTop

disablePromoFlatsAlwaysOnTop: boolean

Disable flats with isPromo flag being always on top of flat list

Optional disablePromoOutlineHighlight

disablePromoOutlineHighlight: boolean

Disable highlighting of promotional flats outlines

Optional disableReserved

disableReserved: boolean

Optional disableRightClick

disableRightClick: boolean

Optional disableRightPanelOnDesktop

disableRightPanelOnDesktop: boolean

Hides right panel on desktop See shiftViewYAxisOnDesktop for shifting view in Y axis

Optional disableSendContactRequest

disableSendContactRequest: boolean

Optional disableShareButton

disableShareButton: boolean

Disable share button

Optional disableSold

disableSold: boolean

Optional disableTableHeader

disableTableHeader: boolean

Disable Header in configurable Table List

Optional disableUrlSearchParams

disableUrlSearchParams: boolean

Disable keeping state in url search params

Optional disableViewFrameElementFlatCounter

disableViewFrameElementFlatCounter: boolean

Optional displayFlatsInAvailabilityOrderForEachSortColumn

displayFlatsInAvailabilityOrderForEachSortColumn: boolean

Optional displayFlatsOrderAvailableReservedSold

displayFlatsOrderAvailableReservedSold: boolean

Optional emailToCustomerToken

emailToCustomerToken: string

Optional enableBottomTableCompare

enableBottomTableCompare: boolean

Disables compare button from bottom part of table

Optional enableInvestmentMapSidePanel

enableInvestmentMapSidePanel: boolean

Enable investment map side panels

Optional enableLocalStorage

enableLocalStorage: boolean

Enable localStorage

Optional estateTourIframeUrl

estateTourIframeUrl: string

Pass the URL inside string to enable button and viewer for Estate Tour

Optional filtersSliderDecimalSymbol

filtersSliderDecimalSymbol: string

Set custom decimal symbol for shorten slider values

Optional filtersUseButtonRooms

filtersUseButtonRooms: boolean

Rooms filter - use buttons instead of range picker

Optional flatFileAsOverlay

flatFileAsOverlay: boolean

Optional flatOutlinesAlwaysVisible

flatOutlinesAlwaysVisible: boolean

Always show flats outlines in viewport

Optional flipBuildingCardHeaderOrder

flipBuildingCardHeaderOrder: boolean

Flips building card header order with content

Optional forceFlatFileAsOverlayOnMobile

forceFlatFileAsOverlayOnMobile: boolean

Optional forceHiddenBuildingSliderPlaceholder

forceHiddenBuildingSliderPlaceholder: boolean

Hide tip appearing below viewer

Optional forceKioskMinimapLazyLoad

forceKioskMinimapLazyLoad: boolean

Force lazy loading for minimaps when in kiosk

Optional forceLang

forceLang: string

Set SmartMakieta display language. Supported values: pl, en, fr

Optional gallery

gallery: boolean

Optional heightToInitiateFiltersOpened

heightToInitiateFiltersOpened: number

Minimal view height required to initiate filters in expanded state

Optional hide3DEstateLogo

hide3DEstateLogo: boolean

Hide 3D Estate logo. To use this please contact our sales representative

Optional hideCollectiveInquiryButtons

hideCollectiveInquiryButtons: boolean

Hide buttons to send collective inquiry

Optional hideCompareViewButtons

hideCompareViewButtons: boolean

hide buttons opening compare view

Optional hideEmptyBuildingsOutlines

hideEmptyBuildingsOutlines: boolean

Hide outlines of buildings without available flats

Optional hideFlatsCounter

hideFlatsCounter: boolean

Show flats counter in configurable filters

Optional hideFlatsReserved

hideFlatsReserved: boolean

Optional hideFlatsReservedOnList

hideFlatsReservedOnList: boolean

Optional hideFlatsSold

hideFlatsSold: boolean

Optional hideFlatsSoldOnList

hideFlatsSoldOnList: boolean

Optional hideFlatsViewModeSwitch

hideFlatsViewModeSwitch: boolean

Hide list/cards switch on flat list

Optional hideMobileLogo

hideMobileLogo: boolean

Display logo on mobile

Optional hideNewBuildingButtonsLayout

hideNewBuildingButtonsLayout: boolean

Optional hideReservedPrice

hideReservedPrice: boolean

Hide price of reserved items

Optional hideSoldPrice

hideSoldPrice: boolean

Hide price of sold items

Optional hideViewportOutlinesTime

hideViewportOutlinesTime: number

Hides outlines for number of seconds in viewport view change

Optional highlightPromotion

highlightPromotion: boolean

Add additional promotion marks

Optional initFilterFlatStatus

initFilterFlatStatus: 0 | 1 | 2 | 3

Sets initial flatStatus filter field value 0 - all 1 - available 2 - reserved 3 - sold

Optional initialViewIdOverride

initialViewIdOverride: number

Sets initial view id

Optional investmentsMap

investmentsMap: boolean

Optional isKiosk

isKiosk: boolean

Optional kioskShowCloseButton

kioskShowCloseButton: boolean

Kiosk - Show close button

Optional limitFlatsInCompare

limitFlatsInCompare: number

Specify maximum number of flats user can add to compare.

Optional location

location: boolean

Optional logoMain

logoMain: boolean

Optional mobileHeaderAdditionalMargin

mobileHeaderAdditionalMargin: number

Adds margin to top of header

Optional mobileViewerExpandedByDefault

mobileViewerExpandedByDefault: boolean

Makes mobile viewer initiate with expanded mode

Optional newViewerMobileHeightMultiplier

newViewerMobileHeightMultiplier: number

New viewer mobile height multiplier

Optional openFlatWithFlatMediaOnDesktop

openFlatWithFlatMediaOnDesktop: "Building" | "Elevation" | "Dollhouse" | "Tour" | "TourOutside"

Force changing flatMedia while opening flat on desktop

Optional overrideFiltersInitState

overrideFiltersInitState: {}

Override filters init state

Type declaration

  • [filterId: number]: CFilterState

Optional overrideFlatTourUrl

overrideFlatTourUrl: string

Optional overrideMobileZIndex

overrideMobileZIndex: number

Sets custom z-index in mobile app

Optional preventWheelEventPropagation

preventWheelEventPropagation: boolean

Prevent wheel events from propagation.

Optional pushAPIDataRefreshInSeconds

pushAPIDataRefreshInSeconds: number

Set PushAPI refresh rate [in seconds]

defaultvalue

120

Optional pushAPIGroupId

pushAPIGroupId: string

Use PushAPI to deliver live data about investment

Optional salesmanList

salesmanList: Salesman[]

Optional shiftViewYAxisOnDesktop

shiftViewYAxisOnDesktop: {}

Shifts view in Y axis on desktop if disableRightPanelOnDesktop is true. Accepts map of [viewId] => shiftRatio ShiftRatio should be in range < -1 , 1 >

example:

shiftViewYAxisOnDesktop: { 1: 0.45, 2: 0.55, 3: -0.12}

Type declaration

  • [index: number]: number

Optional showClearOverList

showClearOverList: boolean

Show clear button over flats list

Optional showCustomDisclaimer

showCustomDisclaimer: boolean

Shows custom disclaimer above filters. Use it with custom translation key: custom-disclaimer

Optional showFiltersBuilding

showFiltersBuilding: boolean

Optional showFullscreenButton

showFullscreenButton: boolean

Optional showPrice

showPrice: boolean

Optional showScreenKeyboard

showScreenKeyboard: boolean

Optional startAppWithOpenPage

startAppWithOpenPage: 1 | 2 | 3

Start app with open page 1 - Location 2 - Gallery 3 - InvestmentMap

Optional startMobileWithListOpened

startMobileWithListOpened: boolean

Set list as mobile starting page.

Optional startViewId

startViewId: number

Set initial viewId

Optional twoPercentCredit

twoPercentCredit: boolean

Enable 2% credit info

Optional useCheckboxCompareButton

useCheckboxCompareButton: boolean

Use compare button stylized to checkbox

Optional useDesktopMinimapLazyLoad

useDesktopMinimapLazyLoad: boolean

Use lazy loading for minimaps on desktop

Optional useExperimentalViewer

useExperimentalViewer: boolean

Optional useMobileInvestmentsMap

useMobileInvestmentsMap: boolean

Enables mobile investments map, ands sets it to initial screen

Optional useOldBuildingButtonsLayout

useOldBuildingButtonsLayout: boolean

Optional useOldContactFormAPI

useOldContactFormAPI: boolean

Use old ContactFormAPI

Optional usePreviousPrice

usePreviousPrice: boolean

Show previous price if available

Generated using TypeDoc