Highslide JS API Reference : hs.captionId

hs.captionId

The id of the element to be cloned to an image caption.

Since version 3.3 you don't need a captionId to add a full HTML caption to your image. See captions for how to add a full caption the easy way. But there might be cases where you want the caption div to recide elsewhere in your page. Create a div somewhere in the page and give it a class name of highslide-caption and a specific id. Then add a captionId parameter to the hs.expand call, and point to the id of the caption div. If you want the same caption for all images, the captionId can be set generally in the head section of your page.

Details

Requires	overlays
Type	string
Default value	null
Overrideable inline	Yes

Example

A shared caption

Put this in the head section of your page. This affects all expanders on your page.

<script type="text/javascript">
   hs.captionId = 'the-caption';
</script>

Mark up the shared caption somewhere in your page's body.

<div class="highslide-caption" id="the-caption">
   This is the caption
</div>

Highslide JS API Reference

Object: hs

Variables

Functions

Events

Object: hs.Expander