embedInstaShow

Use the embedInstaShow JavaScript call to place an instashow into your web page. See the instashow overview for more background.

var configOptions = {option: value, ...};
PhotoShow.widgets.embedInstaShow(configOptions);

configOptions

object, required

An associative array of additional parameters used to configure the instashow. Any of the parameters described below can be included in the configOptions object.

Instashow Customization Options

developerKey

string, optional

Your developer key.

rssFeed

string, required

The URL of a Media RSS feed that lists the pictures for the show.

Default: none

style

string, optional

The name of a PhotoShow One Click Style to be used to style the show.

Default: "Simple Show"

divId

string, optional

The id of the <div> where the instashow should be inserted. The contents of this <div> will be completely replaced by the instashow.

If divId is not specified, the instashow will be inserted in place at the JavaScript call.

Default: none

title

string, optional

The text to display as the title of the show. To prevent the show from having a title, set this option to the empty string (""). (You should specify at most one of title or titleTag.)

Default: Pulls the title from the top-level <title> tag in the RSS feed.

titleTag

string, optional

The name of the RSS feed tag (underneath <channel>) that supplies the title for the show. By default, this will pull the value of the feed's <title> . But you could set it to a different tag name to use a different feed element as the show title. For example:

titleTag: "description" -- display the RSS feed's <description> as the show's title

titleTag: "managingEditor" -- display the RSS feed's <managingEditor> as the show's title

(Do not include the <> characters in the titleTag. You should supply at most one of title or titleTag. If you supply both, the title will override the titleTag.)

Default: "title" (to use the RSS feed's <title>)

captionTag

string, optional

The name of the RSS feed tag (underneath each <item>) that supplies the caption for each photo. By default, this will pull the value of each item's <title>. But you could set it to a different tag name to use a different feed element for the captions, or to disable captions altogether. For example:

captionTag: "description" -- display each photo item's <description> as its caption

captionTag: "author" -- display each photo item's <author> as its caption

captionTag: "media:category" -- display each photo item's <media:category> as its caption

captionTag: "link" -- display each photo item's <link> as its caption

captionTag: "" -- do not include captions on any photos

(Do not include the <> characters in the captionTag.) If the tag name you specify does not appear on a particular photo, that photo will not include a caption in the show. Set the captionTag to the empty string ("") to disable captions altogether.

Default: "title" (to use each feed item's <title>)

permalink

string, optional

The absolute URL at which this particular instashow can be viewed. This link is used for "send to a friend" emails initiated from the viewer widget, and is provided to users within the viewer widget to copy and paste for sharing the show. It defaults to the page containing the PhotoShow, so in most cases you will not need to override it. However, if you have a preferred public link format, or if the page URL contains session keys or other information that should not be shared, you should specify a more appropriate permalink.

(If you set permalink to the empty string, the instashow will have no permalink and email sharing and linking from within the viewer will be disabled.)

Default: the page on which the instashow is currently being displayed (that is, window.location.href)

PhotoShow Viewer Settings Options

viewerWidth

integer, optional

The desired width of the embedded PhotoShow Viewer widget, in pixels. You should specify at most one of viewerWidth or viewerHeight.

Default: 466

Minimum: 272

viewerHeight

integer, optional

The desired height of the embedded PhotoShow Viewer widget, in pixels. You should specify at most one of viewerWidth or viewerHeight. If both viewerWidth and viewerHeight settings are specified, viewerHeight will be ignored in order to preserve the standard PhotoShow Viewer aspect ratio.

Default: 375, or (viewerWidth * 3/4) + 25

Minimum: 229

autoPlayBack

boolean, optional

Controls whether the PhotoShow should begin playing immediately (when enough pictures have loaded). If false, the Viewer will wait for the user to click Play before starting the show.

Default: true

muteOnStart

boolean, optional

Controls whether the PhotoShow should have its music/audio muted. This setting only affects the initial state of the Viewer widget; users can always mute or un-mute the audio by clicking the button in the Viewer.

Default: true