Olympe SDK

Class: GradientStop

olympe.ui.vectorial. GradientStop

GradientStop color stop

new GradientStop( [offset] [, color])

Creates a Gradient Stop.

Parameters:
Name Type Argument Description
offset olympe.df.PONumber | number <optional>
color olympe.df.PColor <optional>

Extends

Methods

getUIProxyGradientStop()

This method needs to be public so Gradient can access it in order to add color stops to it's uiProxy.

Returns:
Type
olympe.uiapi.vectorial.GradientStop

<protected> getUIProxySvgElement()

Inherited From:
Overrides:
Returns:
Type
olympe.uiapi.vectorial.SvgElement

isHidden()

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

setColor(color)

Sets the color of the stop

Parameters:
Name Type Description
color olympe.df.Proxy.<olympe.df.Color> | olympe.df.Color
Returns:
Type
olympe.ui.vectorial.GradientStop

setHidden(hidden)

Parameters:
Name Type Description
hidden olympe.df.OBoolean | boolean | olympe.df.Proxy | olympe.df.Node

True if content must be hidden, false otherwise
Inherited From:
Overrides:
Returns:
Type
olympe.ui.vectorial.SvgElement

setIgnoreUserInteraction( [ignore])

Disables mouse events for this element. However, mouse events will target its descendants unless they are manually set to also ignore user interactions.

Parameters:
Name Type Argument Default Description
ignore boolean <optional>
 false

ignore If true, this element is never the target of mouse events (but not its descendants).
Inherited From:
Overrides:

setOffset(offset)

Sets the color stop offset

Parameters:
Name Type Description
offset olympe.df.PONumber | number

Color stop offset, between 0 à 1
Returns:
Type
olympe.ui.vectorial.GradientStop