Olympe SDK

Class: Gradient

olympe.ui.vectorial. Gradient

Gradient fill base class

<abstract> new Gradient(uiProxy)

Creates a Gradient.

Parameters:
Name Type Description
uiProxy olympe.df.Proxy.<olympe.uiapi.vectorial.Gradient> | olympe.uiapi.vectorial.Gradient

Extends

Methods

addStop(stop, childId)

Adds a gradient stop

Parameters:
Name Type Description
stop olympe.ui.vectorial.GradientStop
childId string
Returns:
Type
olympe.ui.vectorial.Gradient

getUIProxyGradient()

This method needs to be public for GraphicsElement to be able to access this uiProxy

Returns:
Type
olympe.uiapi.vectorial.Gradient

<protected> getUIProxySvgElement()

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

isHidden()

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

removeStop(childId)

Removes a stop

Parameters:
Name Type Description
childId string
Returns:
Type
olympe.ui.vectorial.Gradient

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: