Olympe SDK

Class: FloatingElementTheme

olympe.ui.std.theme. FloatingElementTheme

new FloatingElementTheme()

Creates a FloatingElementTheme.

Extends

Members

<protected> autoHeight :olympe.df.POBoolean

Type:

<protected> autoWidth :olympe.df.POBoolean

Type:

Methods

getAnimateContent()

Returns:
Type
olympe.df.POBoolean

getAnimateOverlay()

Returns:
Type
olympe.df.POBoolean

getAnimation()

Returns:
Type
olympe.df.Proxy.<olympe.ui.std.TransitionAnimation>

getAnimationDuration()

Deprecated:
  • Yes
Returns:
Type
olympe.df.PONumber

getAutoHeight()

Returns:
Type
olympe.df.POBoolean

getAutoWidth()

Returns:
Type
olympe.df.POBoolean

getBackgroundColor()

Inherited From:
Overrides:
Returns:
Type
olympe.df.Color | olympe.df.Proxy.<olympe.df.Color>

getBackgroundImagePosition()

Inherited From:
Overrides:
Returns:
Type
olympe.df.PVector2

getBackgroundImageSize()

Inherited From:
Overrides:
Returns:
Type
olympe.df.PVector2

getBackgroundImageUrl()

Inherited From:
Overrides:
Returns:
Type
olympe.df.POString

getBorderColor()

Inherited From:
Overrides:
Returns:
Type
olympe.df.Color | olympe.df.Proxy.<olympe.df.Color>

getBorderWidth()

Inherited From:
Overrides:
Returns:
Type
olympe.df.PONumber

getCornerRadius()

Inherited From:
Overrides:
Returns:
Type
olympe.df.PONumber

getDimension()

Inherited From:
Overrides:
Returns:
Type
olympe.df.PONumber

getOpacity()

Inherited From:
Overrides:
Returns:
Type
olympe.df.PONumber

getOverlayBackgroundColor()

Returns:
Type
olympe.df.Color | olympe.df.Proxy.<olympe.df.Color>

getShadowColor()

Inherited From:
Overrides:
Returns:
Type
olympe.df.Color | olympe.df.Proxy.<olympe.df.Color>

getShadowInset()

Inherited From:
Overrides:
Returns:
Type
olympe.df.POBoolean

getShadowOffset()

Inherited From:
Overrides:
Returns:
Type
olympe.df.PVector2

getShadowRadius()

Inherited From:
Overrides:
Returns:
Type
olympe.df.PONumber

getShadowSpread()

Inherited From:
Overrides:
Returns:
Type
olympe.df.PONumber

setAnimateContent(value)

Set whether to animate content inside the FloatingElement (if true), or the FloatingElement itself (if false)

Parameters:
Name Type Description
value olympe.df.POBoolean | boolean

setAnimateOverlay(value)

Set whether to animate the overlay (for modal elements)

Parameters:
Name Type Description
value olympe.df.POBoolean | boolean

setAnimation(animation)

Parameters:
Name Type Description
animation olympe.ui.std.TransitionAnimation

setAnimationDuration(duration)

Parameters:
Name Type Description
duration number | olympe.df.PONumber
Deprecated:
  • Animation duration is defined inside TransitionAnimation object

setAutoHeight(value)

Parameters:
Name Type Description
value olympe.df.POBoolean | boolean

setAutoWidth(value)

Parameters:
Name Type Description
value olympe.df.POBoolean | boolean

setBackgroundColor(color)

Parameters:
Name Type Description
color olympe.df.Color | olympe.df.Proxy.<olympe.df.Color>
Inherited From:
Overrides:

setBackgroundImagePosition(imagePosition)

Parameters:
Name Type Description
imagePosition olympe.df.PVector2
Inherited From:
Overrides:

setBackgroundImageSize(imageSize)

Parameters:
Name Type Description
imageSize olympe.df.PVector2
Inherited From:
Overrides:

setBackgroundImageUrl(url)

Parameters:
Name Type Description
url olympe.df.POString
Inherited From:
Overrides:

setBorderColor(borderColor)

Parameters:
Name Type Description
borderColor olympe.df.Color | olympe.df.Proxy.<olympe.df.Color>
Inherited From:
Overrides:

setBorderWidth(borderWidth)

Parameters:
Name Type Description
borderWidth olympe.df.PONumber | number
Inherited From:
Overrides:

setCornerRadius(cornerRadius)

Parameters:
Name Type Description
cornerRadius olympe.df.PONumber | number
Inherited From:
Overrides:

setDimension(dimension)

Parameters:
Name Type Description
dimension olympe.df.PVector2
Inherited From:
Overrides:

setDimensionHeight(height)

Parameters:
Name Type Description
height olympe.df.PONumber | number
Inherited From:
Overrides:

setDimensionWidth(width)

Parameters:
Name Type Description
width olympe.df.PONumber | number
Inherited From:
Overrides:

setOpacity(opacity)

Parameters:
Name Type Description
opacity olympe.df.PONumber | number
Inherited From:
Overrides:

setOverlayBackgroundColor(color)

Parameters:
Name Type Description
color olympe.df.PColor

setShadow(offset, radius [, spread] [, color] [, inset])

Parameters:
Name Type Argument Default Description
offset olympe.df.PVector2

Offset in px
radius olympe.df.PONumber | number

Blur radius in px
spread olympe.df.PONumber | number <optional>
 0

Spread radius in px
color olympe.df.Color | olympe.df.Proxy.<olympe.df.Color> <optional>
 '#000000'
inset olympe.df.POBoolean | boolean <optional>
 false

rue if internal shadow
Inherited From:
Overrides:

setShadowColor(color)

Parameters:
Name Type Description
color olympe.df.Color | olympe.df.Proxy.<olympe.df.Color>
Inherited From:
Overrides:

setShadowInset(inset)

Parameters:
Name Type Description
inset olympe.df.POBoolean | boolean
Inherited From:
Overrides:

setShadowOffsetX(offsetX)

Parameters:
Name Type Description
offsetX olympe.df.PONumber | number
Inherited From:
Overrides:

setShadowOffsetY(offsetY)

Parameters:
Name Type Description
offsetY olympe.df.PONumber | number
Inherited From:
Overrides:

setShadowRadius(radius)

Parameters:
Name Type Description
radius olympe.df.PONumber | number
Inherited From:
Overrides:

setShadowSpread(spread)

Parameters:
Name Type Description
spread olympe.df.PONumber | number
Inherited From:
Overrides: