Should the Flow wrap around? Defaults to true.
The opacity of the last visible item on either side. The opacity of each item will be calculated by the
calcOpacity function. Defaults to 1.
Fixes the item size, to the calculated size. No adjustments will be done. Images will be croped if bigger.
Defaults to false.
Determines how hard it is to drag the flow. If set to 0 dragging of the flow is deactivated. Defaults to
1.
A flowSpeedFactor > 1 will speedup the scrollspeed, while a factor between 0 and 1 will slow it down.
Defaults to 1.
Defines the keyCodes and the functions, which are triggerd on a keydown event within the ContentFlow. All defined functions are bound to the ContentFlow object. To disable this functionality, set this to an empty object.
Defaults to
{
13: function () { this._onclickActiveItem(this._activeItem) }, // return/enter key
37: function () { this.moveTo('pre') }, // left arrow
38: function () { this.moveTo('visibleNext') }, // up arrow
39: function () { this.moveTo('next') }, // right arrow
40: function () { this.moveTo('visiblePre') } // down arrow
}
Grace time in milliseconds for images to load. Defaults to 3000.
Maximum item height in px. If set to a value greater than 0 the item size will be calculated from this
value instead relative to the width of the ContentFlow. Defaults to 0.
Set the "surface"-color of the reflection. If set to 'overlay' the image given by the option
reflectionOverlaySrc will be lain over the reflection. Defaults to transparent.
Set the size of the gap between the image and the reflection image relative to the original image size.
Defaults to 0.
Set the size of the reflection image relative to the original image. Defaults to 0.5.
Position of item relative to it's coordinate. Defaults to top center. So by default, the item will be
placed above the coordinate point and centered horizontally. If set, this option overrides the
calcRelativeItemPosition option.
Factor by which the item will be scaled. Default to 1.
Factor to scale content images in landscape format by. If set to max, the height of an landscape image
content will be set to the height of the item. Defaults to 1.
Factor to scale content images in portrait format by. If set to max, the width of an portait image content
will be set to the width of the item. Defaults to 1.
Flow will start scrolling on load from this item. If set to none the flow will not scroll in. Default to
pre.
Scales by how many items the flow will be moved with one usage of the mousewheel. Negative values will
reverse the scroll direction. If set to 0 scrolling with the mouse wheel is deactivated. Defaults to 1.
Active Content item to start with. Defaults to center
Addons the ContentFlow should use. Defaults to all
Will turn the ContentFlow 90 degree counterclockwise. This will automatically swap calculated positions and
sizes where needed. You do not have to adjust any calculations or sizes. Should work with any AddOn out of
the box. Defaults to false.
Number of items to show on either side of the active Item. If set to 0 it will be set to the square root of
the number of items in the flow. Defaults to 0.
Called to calculate the position of an item element within the flow.
An item to process.
The calculated position of the item within the flow.
Called to set the calculation function of the relative font-size of an item.
An item to process.
The calculated font size, must not be negative.
Called to calculate the opacity of each item.
An item to process.
The calculated opacity in the range 0...1.
Called to calculate the position of an item relative to it's coordinates. Please note that this function will
be overridden by the relativeItemPosition option.
An item to process.
The calculated relative position of the item.
Called to set the calculation function of the size of a visible item
An item to process.
The calculated size of the item.
Called to set the calculation function of the width of each step to get the next position of the flow. diff
is the targetItemPosition - currentPosition
The different between the target item position and the current position in pixels.
The next position in the flow.
Called to set the calculation function of the z-index of each item. The z-index is only valid within the flow itself.
An item to process.
The calculated z-index in the range -32768...32768.
Called when ever an item is redrawn. Use with caution, because this method is easily called many thousand times.
An item to process.
Called if an item becomes the active item.
The item on which the event occurred.
Called if the active item becomes an inactive item.
The item on which the event occurred.
Called each time a new target is set i.e by calling the moveTo method.
The item on which the event occurred.
Called if the target item becomes the active item.
The item on which the event occurred.
Called if the active item is clicked.
The item on which the event occurred.
Called if an inactive item is clicked.
The item on which the event occurred.
Called if the next button item is clicked.
Called if the pre button item is clicked.
Generated using TypeDoc
Describes the configuration for a content flow gallery.