Javascript Quick Start

 

Put the following Javascript anywhere on your page.

 

…and then this code where you want the VisualIDX Real Estate Search tool to display in the BODY of your page…

 

The above code will validate that the client’s url is a valid url, and if so will insert the VisualIDX Real Estate Search tool into the specified DIV (i.e. MyVisualIDX).
 

 
Possible Parameters for the Options Object are…

 

* NOTE

All options can be called as query parameters rather than being specified in an options object.

I.E.

 

…is equivalent to…

WordPress Quick Start

 

On the page where you want the VisualIDX Search displayed, place the following shortcode on the page…

 

The above shortcode will display the default implementation of the VisualIDX Real Estate Search tool.

 

However, you can add attributes to the shortcode that correspond to the available Javascript options.

 

i.e. To display listings from a particular Brokerage, you can use the ‘officeid’ attribute.

*NOTE – WordPress requires shortcode attributes to be lower case, where as the options of the same name in the javascript options object can be mixed uppercase and lowercase, and are case-sensitive.

The following attributes are available for the VisualIDX Shortcode for Search:

 

  • activetool – [ grid | list | map ] – the default display for search listings
  • agent  – typically a 4-digit code that the agent/broker was assigned by the local MLS
  • agentid – same as ‘agent’, for compatibility
  • amin – minimum number of acres – i.e. if this =5, then only result >= 5 acres will display
  • amax – max number of acres – i.e. if this = 5, then only result <= 5 acres will display
  • area – Area as defined by CREN or another MLS. i.e. ‘Durango Rural’
  • areas – Areas vis-a-vis WSM. i.e. Subdivision:Tamarron:Durango, or Subdivision:Durango West:Durango. Must have an area type (County,City,Subdivision,SchoolElementary,SchoolMiddle,SchoolHighSchool,Zipcode) and then the actual name exactly as it appears in the database. For many – like subdivisions, will also want the city, since several cities can have same subdivision. */
  • background – Any CSS-compliant background designation like “#ffffff” or “rgba(255,255,255,1)” or even “url(https://mysite.com/background.png)”
  • bathrooms – minimum # of bathrooms
  • bedrooms – minimum # of bedrooms
  • borderRadius – numeric value for border radius of search form elements
  • css – the css file to use. This defaults to the VisualIDX CSS file at https://cdn.visualidx.com/css/hotmap.css
  • features – specify a commas separated list of the following – ;horsesetup’, ‘garage’, ‘views’, ‘waterfront’, ‘irrigationwater’
  • fields – choose which search fields to display in the search form. Use the form field IDs
  • html – the html template file to use. Defaults to https://cdn.visualidx.com/html/hotmap.html
  • iconColor – defines the icon color in the search form – any CSS compliant color – i.e. ‘#000000’ or ‘rgba(0,0,0,1)’
  • initFormMinimized – choose to show just the top row of search form options, or all 10
  • jquery – choose an alternate jQuery library version
  • jqueryui – choose an alternate jQuery UI library version
  • keywords specify a keyword to search for – i.e. ‘granite’ or ‘hottub’
  • lat – starting latitude for the center of the map
  • lng- starting longitude for the center of the map
  • limit – default # of listings to display per chunk of search results
  • mls – list of comma-separated mls #’s
  • newconstruction – [true | false] choice to display only “New Construction”
  • officeid – display listings from a specific brokerage. Typically a 4 digit numer
  • orderby – default is ‘price ASC’. Other options are ‘price DESC’, ‘LastModifiedDateTime DESC’, ‘GreenData DESC’, ‘Bedrooms’, ‘Bathrooms’, ‘SquareFootage’, ‘Acres’ & ‘Year Built’
  • price – specify and exact price for the results
  • prange – specify a hyphenated price range for the search results. i.e. 300000-500000
  • pmin – specify a min price for the listing results
  • pmax – specify a max price for listing results
  • propertyClass – specify the MLS-defined property class for results. options are ‘Residential’, ‘Land’, ‘MultiFamily’, ‘LandRanch’ or ‘Commercial’
  • searchFormSubmit – whether or not to show the search form ‘Search’ button. False by default. Turn this on when displaying the form without the results.
  • showSearchForm – whether or not to show the search form. full|mini|none|[array,of,search,form,element,ids]
  • sortorder – specify ASC (ascending)  or DESC (descending) for the search results
  • sfmin – specify a min squarefootage for the listing results
  • sfmax – specify a min squarefootage for the listing results
  • subdivision – specify a default subdivision for search results
  • target – specify a target page for the print function. Default is a modal popup window, but an SEO Flyer page is another powerful option
  • virtualTour – only display listings with Virtual Tours
  • width – specify the width of the outer VisualIDX div. Default is ‘96%’. Can be any valid CSS3 width in % or px
  • zip – specify a zipcode for the search results
 

* NOTE

All options can be called as query parameters or shortcode parameters rather than being specified in an options object.

I.E.

…is equivalent to…

 

…or…

 

 

*NOTE – The VisualIDX shortcodes for WordPress are an abstraction layer for the Javascript. So any request parameters of the page URL, or after-the-fact modifications via Javascript will still work.

 

Examples

Show all listings with Agent ID of 1234. Display the Map-view by default.


Javascript

First the JavaScript – typically in the HEAD portion of your page.

…and then the HTML in the BODY of you page, where you want VisualIDX to display.


WordPress

Do the same thing, but utilizing the WordPress plugin


QueryString

Do the same thing, but utilizing the QueryString