CodeAPI

EffectOptions

The Rendering API is used to control when code is run as a page is being loaded.

Table of Contents

OBJECTS

?
Objects used when setting, getting, or calling the properties and methods listed above.
ArcEffectOptionsAn object used to customize the "arc" effect.
BounceEffectOptionsAn object used to customize the "bounce" effect.
FadeEffectOptionsAn object used to customize the "fade" effect.
FlipEffectOptionsAn object used to customize the "flip" effect.
FloatEffectOptionsAn object used to customize the "float" effect.
FlyEffectOptionsAn object used to customize the "fly" effect.
FoldEffectOptionsAn object used to customize the "fold" effect.
GlideEffectOptionsAn object used to customize the "glide" effect.
PuffEffectOptionsAn object used to customize the "puff" effect.
RollEffectOptionsAn object used to customize the "roll" effect.
SlideEffectOptionsAn object used to customize the "slide" effect.
SpinEffectOptionsAn object used to customize the "spin" effect.
TurnEffectOptionsAn object used to customize the "turn" effect.
ZoomEffectOptionsAn object used to customize the "zoom" effect.

ArcEffectOptions

An object used to customize the "arc" effect.

Description

The ArcEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "arc" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0
directionleft, rightleft

See Also

show( ), hide( )

Syntax

type ArcEffectOptions = {
  duration: number
  delay: number
  direction: string
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number
direction
string

Examples

Show an element using the arc effect and options

let arcOptions = {
  "duration":   2000,
  "delay":      1000,
  "direction":  "right"
};

$w("#myElement").show("arc", arcOptions);

BounceEffectOptions

An object used to customize the "bounce" effect.

Description

The BounceEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "bounce" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0
directiontopLeft, topRight, bottomRight, bottomLeft, centertopLeft
intensitysoft, medium, hardmedium

See Also

show( ), hide( )

Syntax

type BounceEffectOptions = {
  duration: number
  delay: number
  direction: string
  intensity: string
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number
direction
string
intensity
string

Examples

Show an element using the bounce effect and options

let bounceOptions = {
  "duration":   2000,
  "delay":      1000,
  "direction":  "topRight",
  "intensity":  "soft"
};

$w("#myElement").show("bounce", bounceOptions);

FadeEffectOptions

An object used to customize the "fade" effect.

Description

The FadeEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "fade" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0

See Also

show( ), hide( )

Syntax

type FadeEffectOptions = {
  duration: number
  delay: number
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number

Examples

Show an element using the fade effect and options

let fadeOptions = {
  "duration":   2000,
  "delay":      1000
};

$w("#myElement").show("fade", fadeOptions);

FlipEffectOptions

An object used to customize the "flip" effect.

Description

The FlipEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "flip" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0
directiontop, right, bottom, leftright

See Also

show( ), hide( )

Syntax

type FlipEffectOptions = {
  duration: number
  delay: number
  direction: string
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number
direction
string

Examples

Show an element using the flip effect and options

let flipOptions = {
  "duration":   2000,
  "delay":      1000,
  "direction":  "right"
};

$w("#myElement").show("flip", flipOptions);

FloatEffectOptions

An object used to customize the "float" effect.

Description

The FloatEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "float" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0
directiontop, right, bottom, leftright

See Also

show( ), hide( )

Syntax

type FloatEffectOptions = {
  duration: number
  delay: number
  direction: string
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number
direction
string

Examples

Show an element using the float effect and options

let floatOptions = {
  "duration":   2000,
  "delay":      1000,
  "direction":  "right"
};

$w("#myElement").show("float", floatOptions);

FlyEffectOptions

An object used to customize the "fly" effect.

Description

The FlyEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "fly" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0
directiontop, right, bottom, leftright

See Also

show( ), hide( )

Syntax

type FlyEffectOptions = {
  duration: number
  delay: number
  direction: string
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number
direction
string

Examples

Show an element using the fly effect and options

let flyOptions = {
  "duration":   2000,
  "delay":      1000,
  "direction":  "right"
};

$w("#myElement").show("fly", flyOptions);

FoldEffectOptions

An object used to customize the "fold" effect.

Description

The FoldEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "fold" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0
directiontop, right, bottom, leftleft

See Also

show( ), hide( )

Syntax

type FoldEffectOptions = {
  duration: number
  delay: number
  direction: string
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number
direction
string

Examples

Show an element using the fold effect and options

let foldOptions = {
  "duration":   2000,
  "delay":      1000,
  "direction":  "right"
};

$w("#myElement").show("fold", foldOptions);

GlideEffectOptions

An object used to customize the "glide" effect.

Description

The GlideEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "glide" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0
angle0-360 degrees0
distance0-300 pixels0

See Also

show( ), hide( )

Syntax

type GlideEffectOptions = {
  duration: number
  delay: number
  angle: number
  distance: number
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number
angle
number
distance
number

Examples

Show an element using the glide effect and options

let glideOptions = {
  "duration":   2000,
  "delay":      1000,
  "angle":      180,
  "distance":   150
};

$w("#myElement").show("glide", glideOptions);

PuffEffectOptions

An object used to customize the "puff" effect.

Description

The PuffEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "puff" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0

See Also

show( ), hide( )

Syntax

type PuffEffectOptions = {
  duration: number
  delay: number
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number

Examples

Show an element using the puff effect and options

let puffOptions = {
  "duration":   2000,
  "delay":      1000
};

$w("#myElement").show("puff", puffOptions);

RollEffectOptions

An object used to customize the "roll" effect.

Description

The RollEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "roll" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0
directiontop, right, bottom, leftleft

See Also

show( ), hide( )

Syntax

type RollEffectOptions = {
  duration: number
  delay: number
  direction: string
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number
direction
string

Examples

Show an element using the roll effect and options

let rollOptions = {
  "duration":   2000,
  "delay":      1000,
  "direction":  "right"
};

$w("#myElement").show("roll", rollOptions);

SlideEffectOptions

An object used to customize the "slide" effect.

Description

The SlideEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "slide" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0
directiontop, right, bottom, leftleft

See Also

show( ), hide( )

Syntax

type SlideEffectOptions = {
  duration: number
  delay: number
  direction: string
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number
direction
string

Examples

Show an element using the slide effect and options

let slideOptions = {
  "duration":   2000,
  "delay":      1000,
  "direction":  "right"
};

$w("#myElement").show("slide", slideOptions);

SpinEffectOptions

An object used to customize the "spin" effect.

Description

The SpinEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "spin" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0
directioncw, ccwcw
cycles1-155

See Also

show( ), hide( )

Syntax

type SpinEffectOptions = {
  duration: number
  delay: number
  direction: string
  cycles: number
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number
direction
string
cycles
number

Examples

Show an element using the spin effect and options

let spinOptions = {
  "duration":   2000,
  "delay":      1000,
  "direction":  "ccw",
  "cycles":     10
};

$w("#myElement").show("spin", spinOptions);

TurnEffectOptions

An object used to customize the "turn" effect.

Description

The TurnEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "turn" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0
directionright, leftright

See Also

show( ), hide( )

Syntax

type TurnEffectOptions = {
  duration: number
  delay: number
  direction: string
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number
direction
string

Examples

Show an element using the turn effect and options

let turnOptions = {
  "duration":   2000,
  "delay":      1000,
  "direction":  "left"
};

$w("#myElement").show("turn", turnOptions);

ZoomEffectOptions

An object used to customize the "zoom" effect.

Description

The ZoomEffectOptions object is used for the effectOptions parameter when calling the show() and hide() functions with the "zoom" effect.

KeyValid ValuesDefault
duration0-4000 milliseconds1200
delay0-8000 milliseconds0

See Also

show( ), hide( )

Syntax

type ZoomEffectOptions = {
  duration: number
  delay: number
}
MEMBERS
?
The kind of data the property stores.
duration
number
delay
number

Examples

Show an element using the zoom effect and options

let zoomOptions = {
  "duration":   2000,
  "delay":      1000
};

$w("#myElement").show("zoom", zoomOptions);