<abstract> new GraphicsElement(uiProxy)
Creates a GraphicsElement.
Parameters:
Name | Type | Description |
---|---|---|
uiProxy |
olympe.df.Proxy.<olympe.uiapi.vectorial.GraphicsElement> | olympe.uiapi.vectorial.GraphicsElement |
Extends
Methods
-
getDimension()
-
Gets the dimension of this element
- Inherited From:
- Overrides:
Returns:
- Type
- olympe.df.PVector2
-
getEventClickOrTap()
-
Gets the 'Click' or 'Tap' events.
Returns:
Data flow for mouse events.
-
getEventDoubleClick()
-
Gets the 'Double click' events. These events are generated when the mouse button is clicked twice in rapid succession.
Returns:
Dataflow for double click events
-
getEventHorizontalPan()
-
Gets the 'Horizontal Pan' events.
Horizontal Pan is a touch move / mousedown+mousemove performed horizontally
Returns:
Data flow of gesture events
-
getEventHorizontalSwipe()
-
Gets the 'Horizontal Swipe' events.
Horizontal Swipe is quick touch move + released / mouse move + released performed horizontally.
Returns:
Data flow of gesture events
-
getEventLongPress( [time])
-
Gets the 'Long Press' events.
LongPress gesture is a long mouse down or a long touch down (250ms).
Parameters:
Name Type Argument Default Description time
number <optional>
250 Time needed to press before emitting the event.
Returns:
Data flow of gesture events
-
getEventLongPressUp()
-
Gets the 'Long Press Up' events.
Long Press Up event is a touch down performed during 250ms on this element and released.
Returns:
Data flow of gesture events
-
getEventMouseDown()
-
Gets then 'Mouse Down' events.
Returns:
Dataflow of mouse down events
-
getEventMouseEnter()
-
Gets the 'Mouse Enter' events. These events are generated when the pointer enters the bounding box of the element.
Returns:
Dataflow of mouse enter events
-
getEventMouseLeave()
-
Gets the 'Mouse Leave' events. These events are generated when the pointer leaves the bounding box of the element.
Returns:
Dataflow of mouse leave events
-
getEventMouseMove()
-
Gets the 'Mouse Move' events.
Returns:
Dataflow of mouse moves events
-
getEventMouseOver()
-
Gets the 'Mouse Over' events.
Returns:
Dataflow of mouse moves events
-
getEventMouseUp()
-
Gets the 'Mouse Up' events.
- Implements:
Returns:
Dataflow of mouse up events
-
getEventMouseWheel()
-
Gets the 'Mouse Wheel' events.
Returns:
Dataflow of mouse wheel events
-
getEventPinch()
-
Gets the 'Pinch' events.
Pinch gesture is a two fingers touchdown typically used to zoom in or out.
- Implements:
Returns:
Data flow of gesture events
-
getEventRotate()
-
Gets the 'Rotate' events.
Rotate gesture is a two fingers touchdown rotation.
- Implements:
Returns:
Data flow of gesture events
-
getEventTouchCancel()
-
Gets the 'Touch Cancel' events.
Returns:
Dataflow of touch cancel events
-
getEventTouchEnd()
-
Gets the 'Touch End' events.
- Implements:
Returns:
Dataflow of touch end events
-
getEventTouchMove()
-
Gets the 'Touch Move' events.
Returns:
Dataflow of touch move events
-
getEventTouchStart()
-
Gets the 'Touch Start' events.
Returns:
Dataflow of touch start events
-
getEventVerticalPan()
-
Gets the 'Vertical Pan' events.
Vertical Pan is a touch move / mousedown+mousemove performed vertically
Returns:
Data flow of gesture events
-
getEventVerticalSwipe()
-
Gets the 'Vertical Swipe' events.
Vertical Swipe is quick touch move + released / mouse move + released performed vertically.
Returns:
Data flow of gesture events
-
<protected> getGestureEvent()
-
Gets the gesture event manager attached to this element
Returns:
-
<protected> getMouseEvent()
-
Gets the mouse event manager attached to this element
Returns:
-
getMoveEvent()
-
Gets the 'Move' events. These events are generated when the mouse moves.
- Implements:
Returns:
-
getPosition()
-
Gets the position of this element
- Inherited From:
- Overrides:
Returns:
- Type
- olympe.df.PVector2
-
getScale()
-
Gets the scale of this element
- Inherited From:
- Overrides:
Returns:
- Type
- olympe.df.PONumber
-
<protected> getUIProxyBoxElement()
-
- Inherited From:
- Overrides:
Returns:
- Type
- olympe.uiapi.vectorial.BoxElement
-
getUIProxyGraphicsElement()
-
Get the UI proxy object. This method needs to be public for the SvgContainer to be able to access it.
Returns:
Proxified box element
- Type
- olympe.uiapi.vectorial.GraphicsElement
-
<protected> getUIProxySvgElement()
-
- Inherited From:
- Overrides:
Returns:
- Type
- olympe.uiapi.vectorial.SvgElement
-
isHidden()
-
- Inherited From:
- Overrides:
Returns:
- Type
- olympe.df.POBoolean
-
isMouseDown()
-
Checks whether the mouse button is pressed down.
- Implements:
Returns:
True if a mouse button is down on this object
- Type
- olympe.df.POBoolean
-
isMouseOver()
-
Checks whether the pointer is over this element.
- Implements:
Returns:
True if mouse is over object
- Type
- olympe.df.POBoolean
-
isMouseUp()
-
Checks whether the mouse button is not pressed down.
- Implements:
Returns:
True if a mouse button is up on this object
- Type
- olympe.df.POBoolean
-
offClickOrTap(id)
-
Unregisters a callback for 'click or tap' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onClickOrTap
)- Implements:
-
offDoubleClick(id)
-
Unregisters a callback for 'Double Click' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onClickOrTap
)- Implements:
-
offHorizontalPan(id)
-
Unregisters a callback from the 'Horizontal Pan' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onHorizontalPan
) -
offHorizontalSwipe(id)
-
Unregisters a callback from the 'Horizontal Swipe' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onHorizontalSwipe
) -
offLongPress(id)
-
Unregisters a callback from the 'Long Press' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onLongPress
)- Implements:
-
offLongPressUp(id)
-
Unregisters a callback from the 'Long Press Up' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onLongPressUp
)- Implements:
-
offMouseDown(id)
-
Unregisters a callback for 'Mouse Down' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onMouseDown
)- Implements:
-
offMouseEnter(id)
-
Unregisters a callback for 'Mouse Enter' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onMouseEnter
)- Implements:
-
offMouseLeave(id)
-
Unregisters a callback for 'Mouse Leave' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onMouseLeave
)- Implements:
-
offMouseMove(id)
-
Unregisters a callback for 'Mouse Move' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onMouseMove
)- Implements:
-
offMouseOver(id)
-
Unregisters a callback for 'Mouse Over' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onMouseOver
)- Implements:
-
offMouseUp(id)
-
Unregisters a callback for 'Mouse Up' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onMouseUp
)- Implements:
-
offMouseWheel(id)
-
Unregisters a callback for 'Mouse Wheel' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onMouseWheel
)- Implements:
-
offMoveEnd(id)
-
Unregisters a callback for 'Move End' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onMoveEnd
)- Implements:
-
offMoveStart(id)
-
Unregisters a callback for 'Move Start' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onMoveStart
)- Implements:
-
offPinch(id)
-
Unregisters a callback from the 'Pinch' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onPinch
)- Implements:
-
offRotate(id)
-
Unregisters a callback from the 'Rotate' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onRotate
)- Implements:
-
offTouchCancel(id)
-
Unregisters a callback for 'Touch Cancel' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onTouchCancel
)- Implements:
-
offTouchEnd(id)
-
Unregisters a callback for 'Touch End' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onTouchEnd
)- Implements:
-
offTouchMove(id)
-
Unregisters a callback for 'Touch Move' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onTouchMove
)- Implements:
-
offTouchStart(id)
-
Unregisters a callback for 'Touch Start' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onTouchStart
)- Implements:
-
offVerticalPan(id)
-
Unregisters a callback from the 'Vertical Pan' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onVerticalPan
)- Implements:
-
offVerticalSwipe(id)
-
Unregisters a callback from the 'Vertical Swipe' events.
Parameters:
Name Type Description id
string ID of callback (returned by
onVerticalSwipe
) -
onClickOrTap(callback [, id] [, priority])
-
Registers a callback for 'click or tap' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnMouseEventCallback the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onDoubleClick(callback [, id] [, priority])
-
Registers a callback for 'Double Click' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnMouseEventCallback the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onHorizontalPan(callback [, id] [, priority])
-
Registers a callback for the 'Horizontal Pan' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnGestureEventCallback id
string <optional>
Id of event auto-generated if omitted, necessary to unregister
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
- See:
Returns:
Id of the callback
- Type
- string
-
onHorizontalSwipe(callback [, id] [, priority])
-
Registers a callback for the 'Horizontal Swipe' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnGestureEventCallback id
string <optional>
Id of event auto-generated if omitted, necessary to unregister
priority
number <optional>
0 Priority of event (higher number = higher priority)
Returns:
Id of the callback
- Type
- string
-
onLongPress(callback [, id] [, priority] [, time])
-
Registers a callback for 'Long Press' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnGestureEventCallback id
string <optional>
Id of event auto-generated if omitted, necessary to unregister
priority
number <optional>
0 Priority of event (higher number = higher priority)
time
number <optional>
250 Time needed to press before emitting the event.
- Implements:
- See:
Returns:
Id of the callback
- Type
- string
-
onLongPressUp(callback [, id] [, priority])
-
Registers a callback for 'Long Press Up' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnGestureEventCallback id
string <optional>
Id of event auto-generated if omitted, necessary to unregister
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
- See:
Returns:
Id of the callback
- Type
- string
-
onMouseDown(callback [, id] [, priority])
-
Registers a callback for the 'Mouse Down' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnMouseEventCallback the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onMouseEnter(callback [, id] [, priority])
-
Registers a callback for the 'Mouse Enter' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnMouseEventCallback the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onMouseLeave(callback [, id] [, priority])
-
Registers a callback for the 'Mouse Leave' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnMouseEventCallback the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onMouseMove(callback [, id] [, priority])
-
Registers a callback for the 'Mouse Move' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnMouseEventCallback the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onMouseOver(callback [, id] [, priority])
-
Registers a callback for the 'Mouse Over' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnMouseEventCallback the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onMouseUp(callback [, id] [, priority])
-
Registers a callback for the 'Mouse Up' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnMouseEventCallback the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onMouseWheel(callback [, id] [, priority])
-
Registers a callback for the 'Mouse Wheel' events.
Parameters:
Name Type Argument Default Description callback
function the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onMoveEnd(callback [, id] [, priority])
-
Registers a callback for the 'Move End' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnMoveEventCallback the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onMoveStart(callback [, id] [, priority])
-
Registers a callback for the 'Move Start' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnMoveEventCallback the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onPinch(callback [, id] [, priority])
-
Registers a callback for 'Pinch' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnGestureEventCallback id
string <optional>
Id of event auto-generated if omitted, necessary to unregister
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
- See:
Returns:
Id of the callback
- Type
- string
-
onRotate(callback [, id] [, priority])
-
Registers a callback for 'Rotate' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnGestureEventCallback id
string <optional>
Id of event auto-generated if omitted, necessary to unregister
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
- See:
Returns:
Id of the callback
- Type
- string
-
onTouchCancel(callback [, id] [, priority])
-
Registers a callback for the 'Touch Cancel' events.
Parameters:
Name Type Argument Default Description callback
function the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onTouchEnd(callback [, id] [, priority])
-
Registers a callback for the 'Touch End' events.
Parameters:
Name Type Argument Default Description callback
function the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onTouchMove(callback [, id] [, priority])
-
Registers a callback for the 'Touch Move' events.
Parameters:
Name Type Argument Default Description callback
function the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onTouchStart(callback [, id] [, priority])
-
Registers a callback for the 'Touch Start' events.
Parameters:
Name Type Argument Default Description callback
function the function to call
id
string <optional>
Id of callback, auto-generated if omitted
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
Returns:
Id of the callback
- Type
- string
-
onVerticalPan(callback [, id] [, priority])
-
Registers a callback for the 'Vertical Pan' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnGestureEventCallback id
string <optional>
Id of event auto-generated if omitted, necessary to unregister
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
- See:
Returns:
Id of the callback
- Type
- string
-
onVerticalSwipe(callback [, id] [, priority])
-
Registers a callback for the 'Vertical Swipe' events.
Parameters:
Name Type Argument Default Description callback
olympe.ui.events.OnGestureEventCallback id
string <optional>
Id of event auto-generated if omitted, necessary to unregister
priority
number <optional>
0 Priority of event (higher number = higher priority)
- Implements:
- See:
-
getEventVerticalSwipe
Returns:
Id of the callback
- Type
- string
-
removeTooltip()
-
Removes the tooltip from this element.
Returns:
This element.
-
rotate(alpha [, x] [, y])
-
Parameters:
Name Type Argument Description alpha
olympe.df.PONumber | number x
olympe.df.PONumber | number <optional>
y
olympe.df.PONumber | number <optional>
Returns:
-
setDimension(dimension)
-
Sets the dimension of this element
Parameters:
Name Type Description dimension
olympe.df.PVector2 Dimension of this element
- Inherited From:
- Overrides:
Returns:
-
setFillColor(color)
-
Sets a uniform color fill and opacity
Parameters:
Name Type Description color
olympe.df.Proxy.<olympe.df.Color> | olympe.df.Color Returns:
-
setFilled(filled)
-
Sets if the element should be filled or not (essentially used to disable events on not filled area).
Parameters:
Name Type Description filled
olympe.df.Proxy.<olympe.df.OBoolean> | olympe.df.OBoolean | boolean -
setFilter(filter)
-
Sets a filter
Parameters:
Name Type Description filter
olympe.df.Proxy.<olympe.ui.vectorial.Filter> | olympe.ui.vectorial.Filter Returns:
-
setGradient(gradient)
-
Sets a gradient
Parameters:
Name Type Description gradient
olympe.df.Proxy.<olympe.ui.vectorial.Gradient> | olympe.ui.vectorial.Gradient Returns:
-
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:
-
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:
-
setMask(mask)
-
Sets a mask.
Parameters:
Name Type Description mask
olympe.df.Proxy.<olympe.ui.vectorial.Mask> | olympe.ui.vectorial.Mask Returns:
-
setPosition(position)
-
Sets the position of this element
Parameters:
Name Type Description position
olympe.df.PVector2 | olympe.df.Vector2 The position of this element
- Inherited From:
- Overrides:
Returns:
-
setScale(scale)
-
Sets the scale of this element
Parameters:
Name Type Description scale
olympe.df.PONumber | number Scale of this element
- Inherited From:
- Overrides:
Returns:
-
setStrokeColor(color)
-
Sets the stroke color and opacity
Parameters:
Name Type Description color
olympe.df.Proxy.<olympe.df.Color> | olympe.df.Color Returns:
-
setStrokeDashOffset(dashOffset)
-
Sets the stroke dash offset
Parameters:
Name Type Description dashOffset
olympe.df.PONumber | number The stroke dash offset value [px]
Returns:
-
setStrokeDashPattern(dashPattern)
-
Sets the stroke dash pattern
Parameters:
Name Type Description dashPattern
olympe.df.POString | string The stroke dash pattern, see SVG documentation for examples [px]
Returns:
-
setStrokeLinecap(linecap)
-
Sets the stroke linecap
Parameters:
Name Type Description linecap
olympe.df.POString | string The stroke linecap (round, butt or square. Default: butt)
Returns:
-
setStrokeWidth(width)
-
Sets the stroke width
Parameters:
Name Type Description width
olympe.df.PONumber | number Returns:
-
setTooltip(text [, options])
-
Assigns a tooltip to that element that will show up when the mouse hovers over it.
Parameters:
Name Type Argument Description text
olympe.df.POString The text of the tooltip.
options
Object <optional>
Various options for displaying the tooltip.
Properties
Name Type Argument Description position
olympe.df.PVector2 <optional>
The absolute position of the tooltip.
background
olympe.df.PColor <optional>
The background color.
foreground
olympe.df.PColor <optional>
The text color.
fontSize
olympe.df.PONumber <optional>
The font size.
borderSize
olympe.df.PONumber <optional>
The size of the border. Default is 1.
borderColor
olympe.df.PColor <optional>
The color of the border. Default is black.
delay
olympe.df.ONumber | number The delay, in milliseconds, before showing the tooltip. Default is 500.
startingPos
olympe.df.Vector2 <optional>
The starting position of the mouse. Default is (0,0).
Returns:
This Element.
-
unsetFilter()
-
Unsets a filter
-
unsetGradient()
-
Unsets a gardient
-
unsetMask()
-
Unsets a mask