Customise each targeted division with the settings below (all are optional):
$(selector).flightboard({messages: [..., ...]});
afterFlip | beforeFlip | flips | lettersImage | lettersSeq | lettersSize | maxLength | messages | opacity | pause | repeat | selection | sequential | shading | shadingImages | speed
Name | Type | Default | Comments |
---|---|---|---|
lettersImage | string | 'img/flightboard-large.png' | The location (URL) of the image that contains a horizontal amalgamation of the letters to be shown on the flight board. |
lettersSize | number[2] | [25, 34] | The width and height of the individual letters within the
lettersImage setting.
The height should be an even number. |
lettersSeq | string | ' ABCDEFGHIJKLMNOPQ RSTUVWXYZ0123456789' | The sequence of the individual letters within the
lettersImage setting. |
messages | string[] | ['SEE THE FLIGHT BOARD', 'CHANGE MESSAGES'] | The messages to display on the flight board.
The case of these messages must match the case in the
lettersSeq setting. |
maxLength | number | 20 | The number of characters to show on the flight board. |
flips | number or number[2] | [3, 5] | The number of flips made for individual characters during a message flip on the flight board. The value may be a single number or an array with the minimum and maximum values. At each flip a random intermediate character is shown. |
sequential | boolean | false | Set to true to always move sequentially through all the letters
to the target character. Set to false to select random characters
based on the flips option.Since 1.0.1. |
speed | number | 500 | The number of milliseconds that it takes for each individual character
flip to complete. There may be multiple character flips per message flip -
see flips setting. |
repeat | boolean | true | Set to true to automatically flip the board to a new message after
pausing the time below. Set to false to only flip on demand. |
pause | number | 2000 | The number of milliseconds to pause between message flips. |
selection | string | 'forward' | Determine how the next message to be shown is selected. The value should be one of 'forward', 'backward', or 'random'. |
shading | boolean | true | Set to true to add the shading for enhancing the 3D effects.
Set to false to not apply shading. |
opacity | number | 0.5 | The maximum opacity for the highlight and shadow. Valid values are 0.0 to 1.0. |
shadingImages | string[2] | ['img/flightBoardHigh.png', 'img/flightBoardShad.png'] | Locations of the highlight and shadow images used by IE for the shading effects. |
beforeFlip | function | null | A callback made just before each flip starts.
The function receives the current (shown) and next (to be shown) messages
as parameters, while this refers to the containing division. |
afterFlip | function | null | A callback made just after each flip ends.
The function receives the current (just hidden) and next (just displayed) messages
as parameters, while this refers to the containing division.
|