Highslide JS API Reference

Close Move
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam dapibus leo quis nisl. In lectus. Vivamus consectetuer pede in nisl. Mauris cursus pretium mauris. Suspendisse condimentum mi ac tellus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec sed enim. Ut vel ipsum. Cras consequat velit et justo. Donec mollis, mi at tincidunt vehicula, nisl mi luctus risus, quis scelerisque arcu nibh ac nisi. Sed risus. Curabitur urna. Aliquam vitae nisl. Quisque imperdiet semper justo. Pellentesque nonummy pretium tellus.
Resize

Object: hs

Variables

Functions

Events

Object: hs.Expander

Variables

Functions

Events



hs.overrides

Defines which settings of the hs object that will be inherited by the single hs.Expander.

The concept of overrides is important in Highslide. Since hs.Expander does not extend the hs object directly, only those properties listed in the hs.overrides array are copied over to the hs.Expander object. The implication is that these properties can be set both at page-level and for each single expander. A collection of overriding options is defined in the second parameter of the hs.expand and hs.htmlExpand functions as seen below.

This is the overrides array when all options are checked in the Configurator:

hs.overrides = [
	'allowSizeReduction',
	'anchor',
	'align',
	'targetX',
	'targetY',
	'outlineType',
	'outlineWhileAnimating',
	'captionId',
	'captionText',
	'captionEval',
	'captionOverlay',
	'headingId',
	'headingText',
	'headingEval',
	'headingOverlay',
	'dragByHeading',
	'autoplay',
	'numberPosition',
	'transitions',
	'dimmingOpacity',	
	'contentId',
	'width',
	'height',
	'allowWidthReduction',
	'allowHeightReduction',
	'preserveContent',
	'maincontentId',
	'maincontentText',
	'maincontentEval',
	'objectType',	
	'cacheAjax',	
	'objectWidth',
	'objectHeight',
	'objectLoadTime',	
	'swfOptions',
	'wrapperClassName',
	'minWidth',
	'minHeight',
	'maxWidth',
	'maxHeight',
	'slideshowGroup',
	'easing',
	'easingClose',
	'fadeInOut',
	'src'
];

Details

Type array
Default value
Overrideable inline No

Example

General setting to all expanders

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

<script type="text/javascript">
   hs.anchor = 'bottom left';
</script>

Specifically setting it to a single expander

Define the property in an object (notated by brackets) in the second argument of hs.expand or hs.htmlExpand

<a class="highslide" href="full1.jpg" onclick="return hs.expand(this, { anchor: 'top right' })">
   <img src="../samples/thumb1.jpg" alt=""/>
</a>

The effect:

No inline setting is given, the expander takes 'bottom left' from the hs object (page-level):

The anchor setting is defined inline as 'top right' for this single expander:

See also

New, Edit