| Style | Description | Defined by |
| |
blockSize
| Type: Number Format: Length CSS Inheritance: no
Specifies the size of the blocks in the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type(s) | Parameter Description/Format for this Usage | Default |
PixelDissolveInOut, PixelDissolveIn, PixelDissolveOut | The size of each of the masking blocks. This value is overridden by the maxBlocks parameter | 20 |
BlindsInOut, BlindsIn, BlindsOut | The size of each 'slat' in the blinds. | 20 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
blur
| Type: flash.filters.BlurFilter Format: BlurFilter CSS Inheritance: no
Specifies the blur filter applied to the internal bitmaps used by the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type(s) | Parameter Description for this Usage | Default |
Cube, Flip, Pixelate | Specifies the blur filter to be used on the bitmap effect. Omit this parameter or use BlurFilter(0,0,0) to not enable any blur filter. Format: Blur Filter Instance - e.g. BlurFilter(blurX,blurY,quality) . | BlurFilter(7,0,1) |
Slide, BlurFadeFly, SoftWipe, PopInOut, PopIn, PopOut, PixelDissolveInOut, PixelDissolveIn, PixelDissolveOut, SoftIrisInOut, SoftIrisIn, SoftIrisOut, BlindsInOut, BlindsIn, BlindsOut | Specifies the blur filter to be used on the bitmap effect. Omit this parameter or use BlurFilter(0,0,0) to not enable any blur filter. Format: Blur Filter Instance - e.g. BlurFilter(blurX,blurY,quality) . | null (none) |
This value is specified by using the blur filter attribute format. For more information, see the XMLAttributeFormats.BLUR_FILTER constant.
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
compositeOffset
| Type: Number Format: Time CSS Inheritance: no
Specifies the offset, in milliseconds, between the two parts of the transition -- the "hide-the-old-slide" part and the "show-the-new-slide" part (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type(s) | Parameter Description for this Usage | Default |
FadeStandard, BlurFadeFly, SoftWipe, PopIn, BlurFadeIn, PixelDissolveIn, SoftIrisInOut, SoftIrisIn, BlindsIn | Time, in milliseconds, that the reveal effect is delayed by after the start of the hide effect. Set this value to be equal to the duration to create a two-part effect where the old image is fully hidden prior to the new image being revealed. | 0 |
PopInOut | Time, in milliseconds, that the reveal effect is delayed by after the start of the hide effect. Set this value to be equal to the duration to create a two-part effect where the old image is fully hidden prior to the new image being revealed. | 1000 |
PopOut, BlurFadeOut, PixelDissolveOut, SoftIrisOut, BlindsOut | Time, in milliseconds, that the reveal effect is delayed by after the start of the hide effect. Set this value to be equal to the duration to create a two-part effect where the old image is fully hidden prior to the new image being revealed. | 500 |
BlurFadeInOut | Time, in milliseconds, that the reveal effect is delayed by after the start of the hide effect. Set this value to be equal to the duration to create a two-part effect where the old image is fully hidden prior to the new image being revealed. | 800 |
PixelDissolveInOut, BlindsInOut | Time, in milliseconds, that the reveal effect is delayed by after the start of the hide effect. Set this value to be equal to the duration to create a two-part effect where the old image is fully hidden prior to the new image being revealed. | 1500 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
constrain
| Type: Boolean CSS Inheritance: no
Specifies if the transition is constrained to its original dimension, or can "pop out" to provide a more realistic 3D effect (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type | Parameter Description/Format for this Usage | Default |
Cube | Specifies whether the cube is constrained to the target's original boundaries. If set to false, the cube will 'pop out' of the screen and provide a more realistic effect. | false |
Flip | Specifies whether the flip is constrained to the target's original boundaries. If set to false, the flip will 'pop out' of the screen and provide a more realistic effect. | false |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
direction
| Type: String CSS Inheritance: no
Specifies the direction of the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type(s) | Parameter Description/Format for this Usage | Default |
Cube | Controls the direction that the cube rotates. Supported Values: "left", "right", "up", "down", "random" | "left" |
Flip | Controls the direction that the flip happends. Supported Values: "left", "right", "up", "down", "random" | "left" |
Slide | Controls the direction that the slide happens from/to. Supported Values: "left", "right", "up", "down", "random" | "left" |
BlurFadeFly | Controls the direction that the target flys in from or flys out to. Supported Values: "left", "right", "up", "down" | "left" |
SoftWipe | The direction parameter controls the direction of the wipe effect. Supported Values: "left", "right", "up", "down", "topLeft", "topRight", "bottomLeft", "bottomRight" | "left" |
SoftIrisInOut, SoftIrisIn, SoftIrisOut | Specifies the direction of the effect.\n\nIf set to grow and revealing the image, the visible portion of the image will grow from a small circle
in the center until the entire image is visible. If set to grow and hiding the image, a hole will appear in the middle of the image and grow until the entire image has been hidden. If set to shrink and revealing
the image, a hole in the middle of the image will shrink until it is gone and the entire image is visible. If set to shrink and hiding the image, the visible circle will shrink until the entire image has been
hidden. Supported Values: "grow", "shrink" | "grow" |
BlindsInOut, BlindsIn, BlindsOut | The direction parameter controls the vertical/horizontal orientation as well as which side the blinds grow from or shrink to. Supported Values: "left", "right", "up", "down", "topLeft", "topRight", "bottomLeft", "bottomRight" | "left" |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
displayOffsetX
| Type: Number Format: Length CSS Inheritance: no
Specifies the pixel x-offset of the bitmap overlay used in the transition effect (if there is one).
This advanced parameter should only be specified if you notice a horizontal 'shift' when the effect starts and ends.
The default value is 0 . | ImagesStandardTransition |
| |
displayOffsetY
| Type: Number Format: Length CSS Inheritance: no
Specifies the pixel y-offset of the bitmap overlay used in the transition effect (if ther is one).
This advanced parameter should only be specified if you notice a vertical 'shift' when the effect starts and ends.
The default value is 0 . | ImagesStandardTransition |
| |
duration
| Type: Number Format: Time CSS Inheritance: no
Specifies the duration, in milliseconds, of the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type(s) | Parameter Description for this Usage | Default |
FadeStandard, Cube, Flip, Pixelate, Slide, BlurFadeFly, SoftWipe | Duration of the effect in milliseconds | 1500 |
PopInOut, PopIn, BlurFadeInOut, BlurFadeIn | Duration of the first part of the effect in milliseconds | 800 |
PopOut, BlurFadeOut, PixelDissolveOut, SoftIrisOut, BlindsOut | Duration of the first part of the effect in milliseconds | 500 |
PixelDissolveInOut, PixelDissolveIn, SoftIrisInOut, SoftIrisIn, BlindsInOut, BlindsIn | Duration of the first part of the effect in milliseconds | 1500 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
durationHide
| Type: Number Format: Time CSS Inheritance: no
Specifies the duration, in milliseconds, of the second part of the transition, where the new slide is revealed (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type(s) | Parameter Description for this Usage | Default |
SoftWipe, PixelDissolveInOut, PixelDissolveIn, PixelDissolveOut, SoftIrisInOut, SoftIrisIn, BlindsInOut, BlindsIn | Duration, in milliseconds, of the portion of the effect which hides the old slide | Value specified for duration , 1500 |
PopInOut, PopIn, BlurFadeInOut, BlurFadeIn | Duration, in milliseconds, of the portion of the effect which hides the old slide | Value specified for duration , 800 |
PopOut, BlurFadeOut, SoftIrisOut, BlindsOut | Duration, in milliseconds, of the portion of the effect which hides the old slide | Value specified for duration , 500 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
easingFunction
| Type: Function Format: Easing CSS Inheritance: no
Specifies the easing function used by the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type(s) | Parameter Description for this Usage | Default |
FadeStandard, Cube, Flip, Pixelate, Slide, BlurFadeFly, SoftWipe, PopInOut, PopIn, PopOut, BlurFadeInOut, BlurFadeIn, BlurFadeOut, PixelDissolveInOut, PixelDissolveIn, PixelDissolveOut, SoftIrisInOut, SoftIrisIn, SoftIrisOut BlindsInOut, BlindsIn, BlindsOut
| The easing function for the animation. | Easing(Quartic.easeInOut) |
This value is specified by using the easing function attribute format. For more information, see the XMLAttributeFormats.EASING_FUNCTION_REFERENCE constant.
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
effectType
| Type: String CSS Inheritance: no
Specifies the transition type or types.
The available transition names are listed below.
If you specify only one transition name, that transition will always be used. If you specify "Random" as the transition type, all of the transitions listed below will randomly be cycled through.
If you specify a list of transitions separated by commas (e.g. "Cube,Flip,Pixelate" ) those specified transitions will be randomly cycled through.
In the list of supported transition types below, there is enumerated the other style parameters which control the transition's configuration. See each of these style parameters for more
information about what the control and possible values.
Supported Transition Types:
Type | Description | Relevant Configuration Styles |
FadeStandard | The FadeStandard transition is the standard fade transition used in most slideshows, where the old image fades out and the new image fades in (usually at the same time). |
compositeOffset, duration, easingFunction |
Random | This option, if used, must be selected as the sole selection. Selecting 'Random' means that all of the transitions will be randomly used when the images change. |
(see all other effects) |
Cube | The Cube transition shows a cube which has the old and new images on adjacent faces. The cube rotates to transition from one image to the other. |
direction, constrain, duration, smoothing, blur, easingFunction |
Flip | The Flip transition is like a playing card with the old image on one face and the new image on the other. The card flips to transition from one image to the other. |
direction, constrain, duration, smoothing, blur, easingFunction |
Pixelate | The Pixelate transition makes the old image become highly pixelated and then become unpixelated. When it becomes unpixelated, the new image is revealed in the old image's place. |
maxPixelSize, duration, smoothing, blur, easingFunction |
Slide | The Slide transition slides the old image out and slides the new image in at the same time, giving the appearance of both images being contiguous. |
direction, spacing, duration, smoothing, blur, easingFunction |
BlurFadeFly | The BlurFadeFly transition makes the old image blur, fade, and fly out. Then, the new image blurs, fades, and flies in. |
direction, flyDistance, maxBlur, compositeOffset, duration, smoothing, blur, easingFunction |
SoftWipe | The SoftWipe transition makes the old image wipe away, while the new image wipes in. The wipe effect has a soft edge, giving a softened, polished look. |
direction, softenSize, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
PopInOut | The PopInOut transition makes the old image 'pop' out of its place, then the new image 'pop' back in to replace it. |
strength, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
PopIn | The PopIn transition makes the new image 'pop' in on top of the old image, replacing it. |
strength, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
PopOut | The PopOut transition makes the old image 'pop' out to reveal the new image below it. |
strength, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
BlurFadeInOut | The BlurFadeInOut transition makes the old image blur and fade out, then the new image blurs and fades in to replace it. |
maxBlur, minAlpha, compositeOffset, duration, durationHide, smoothing, easingFunction |
BlurFadeIn | The BlurFadeIn transition makes the new image blur and fade in on top of the old image, replacing it. |
maxBlur, minAlpha, compositeOffset, duration, durationHide, smoothing, easingFunction |
BlurFadeOut | The BlurFadeOut transition makes the old image blur and fade out to reveal the new image below it. |
maxBlur, minAlpha, compositeOffset, duration, durationHide, smoothing, easingFunction |
PixelDissolveInOut | The PixelDissolveInOut transition uses the PixelDissolve effect to hide the old image block-by-block, then uses the same type of effect to reveal the new image. |
blockSize, maxBlocks, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
PixelDissolveIn | The PixelDissolveIn transition uses the PixelDissolve effect to reveal the new image on top of the old image, replacing it. |
blockSize, maxBlocks, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
PixelDissolveOut | The PixelDissolveOut transition uses the PixelDissolve effect to hide the old image block-by-block, revealing the new image below it. |
blockSize, maxBlocks, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
SoftIrisInOut | The SoftIrisInOut transition uses an Iris effect to hide the old image, then uses the same type of effect to reveal the new image. |
direction, softenSize, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
SoftIrisIn | The SoftIrisIn transition uses an Iris effect to reveal the new image on top of the old image, replacing it. |
direction, softenSize, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
SoftIrisOut | The SoftIrisOut transition uses an Iris effect to hide the old image, revealing the new image below it. |
direction, softenSize, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
BlindsInOut | The BlindsInOut transition uses a Blinds effect to hide the old image, then uses the same type of effect to reveal the new image. |
direction, blockSize, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
BlindsIn | The BlindsIn transition uses a Blinds effect to reveal the new image on top of the old image, replacing it. |
direction, blockSize, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
BlindsOut | The BlindsOut transition uses a Blinds effect to hide the old image, revealing the new image below it. |
direction, blockSize, compositeOffset, duration, durationHide, smoothing, blur, easingFunction |
The default value is "FadeStandard" . | ImagesStandardTransition |
| |
flyDistance
| Type: Number Format: Length CSS Inheritance: no
Specifies the distance over which the 'flying' effect takes place in the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type | Parameter Description/Format for this Usage | Default |
BlurFadeFly | The distance from the home location that the target either starts flying (if revealing the image) or finishes flying (if hiding the image). | 40 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
lockImages
| Type: Boolean CSS Inheritance: no
Specifies if the images should be locked while slide transitions take place.
If set to true and an image transition is taking place, SlideshowEvent.IMAGES_SETIMAGE control event calls will be ignored
until the new slide has finished opening.
Changing this setting to true will mean that users must wait for slide transitions to fully complete before selecting a new image. It can be annoying to users,
so it is generally best to leave it at the default value of false .
The default value is false . | ImagesStandardTransition |
| |
maxBlocks
| Type: Number CSS Inheritance: no
Specifies the maximum number of blocks in the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type(s) | Parameter Description/Format for this Usage | Default |
PixelDissolveInOut, PixelDissolveIn, PixelDissolveOut | The maximum number of blocks to be used. This value overrides the blockSize parameter
to ensure that there aren't so many blocks that performance is significantly degraded. | 10000 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
maxBlur
| Type: Number Format: Length CSS Inheritance: no
Specifies the maximum strength of the blur effect in the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type | Parameter Description/Format for this Usage | Default |
BlurFadeFly | The maximum strength of the blur. This is the value which will be used at the beginning of the effect if revealing the image, or the end of the effect if hiding the image. | 40 |
BlurFadeInOut, BlurFadeIn, BlurFadeOut | The maximum strength of the blur. | 40 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
maxPixelSize
| Type: Number Format: Length CSS Inheritance: no
Specifies the maximum size of the pixels in the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type | Parameter Description/Format for this Usage | Default |
Pixelate | The maximum size of the pixelated pixels. Value must be at least 10. | 200 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
minAlpha
| Type: Number Format: Alpha CSS Inheritance: no
Specifies the minimum alpha (opacity) value used in the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type(s) | Parameter Description/Format for this Usage | Default |
BlurFadeInOut, BlurFadeIn, BlurFadeOut | The minimum opacity of the slides. Valid values range from 0.0 (fully transparent) to 1.0 (fully opaque). | 0.0 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
smoothing
| Type: Boolean CSS Inheritance: no
Specifies whether smoothing is applied to the internal bitmaps used by the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type(s) | Parameter Description for this Usage | Default |
Cube, Flip, Pixelate, Slide | Specifies if smoothing should be enabled for the bitmap effect. Usually, this value should be set to true. However, it can slightly reduce effect performance. | true |
BlurFadeFly, SoftWipe, PopInOut, PopIn, PopOut, BlurFadeInOut, BlurFadeIn, BlurFadeOut, PixelDissolveInOut, PixelDissolveIn, PixelDissolveOut, SoftIrisInOut, SoftIrisIn, SoftIrisOut, BlindsInOut, BlindsIn, BlindsOut
| Specifies if smoothing should be enabled for the bitmap effect. Usually, this value should be set to true. However, it can slightly reduce effect performance. | false |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
softenSize
| Type: Number Format: Length CSS Inheritance: no
Specifies the amount of edge softening which should used in the transition (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type | Parameter Description/Format for this Usage | Default |
SoftWipe | The amount, in pixels, the edges of the mask should be softened (faded). | 100 |
SoftIrisInOut, SoftIrisIn, SoftIrisOut | The amount, in pixels, the edges of the mask circle should be softened (faded). | 150 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
spacing
| Type: Number Format: Length CSS Inheritance: no
Specifies the additional spacing beyond the size of the target that the transition should take place from (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type | Parameter Description/Format for this Usage | Default |
Slide | The additional spacing (beyond the size of the target) that the slide should take place from. This can be used to make the effect appear to slide the component in from outside of the visible area. | 40 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |
| |
strength
| Type: Number CSS Inheritance: no
Specifies the strength of the transition effect (with some variation based on effectType ; see below).
The table below summarizes: (1) What transition types (as specified by effectType ) this parameter is applicable for; (2) What this parameter controls for that specific transition; and
(3) The parameter's default value when using that transition.
Transition Type(s) | Parameter Description/Format for this Usage | Default |
PopInOut, PopIn, PopOut | The largest magnified size of the slides as a percentage, where 1.0 is the original size. | 1.3 |
The default value depends on which transition is being used; see the default values listed in the table above.
| ImagesStandardTransition |