Interface: ScrollViewProps
Gorilla Engine JavaScript API / GorillaEngine / UI / ScrollViewProps
Properties and scrolling methods for a viewport containing child components.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Properties
Section titled “Properties”alpha:
number
Sets the opacity level of the component, ranging from 0.0 (fully transparent)
to 1.0 (fully opaque).
Inherited from
Section titled “Inherited from”alwaysOnTop
Section titled “alwaysOnTop”alwaysOnTop:
boolean
If true, the component will always be rendered on top of other components
within the same stacking context, regardless of their Z-order.
Inherited from
Section titled “Inherited from”clickGrabsKeyboardFocus
Section titled “clickGrabsKeyboardFocus”clickGrabsKeyboardFocus:
boolean
If true, a mouse click on this component will automatically
transfer keyboard focus to it, allowing for immediate keyboard interaction.
Inherited from
Section titled “Inherited from”Common.clickGrabsKeyboardFocus
enabled
Section titled “enabled”enabled:
boolean
Determines if the component is active. If false, the component
will not respond to user input (e.g., clicks, keyboard events) but may still be visible.
Inherited from
Section titled “Inherited from”height
Section titled “height”height:
number
The height of the component in pixels.
Inherited from
Section titled “Inherited from”hideHorizontalScrollbar
Section titled “hideHorizontalScrollbar”hideHorizontalScrollbar:
boolean
Hides the horizontal scrollbar.
Default
Section titled “Default”falsehideVerticalScrollbar
Section titled “hideVerticalScrollbar”hideVerticalScrollbar:
boolean
Hides the vertical scrollbar.
Default
Section titled “Default”falseid:
string
A unique identifier for the component. This ID is needed for referencing and managing the component within the application’s hierarchy.
Inherited from
Section titled “Inherited from”ignoreKeypressEvent
Section titled “ignoreKeypressEvent”ignoreKeypressEvent:
boolean
Whether the scroll view declines keyboard input instead of handling it for scrolling.
Default
Section titled “Default”falsescrollbar?
Section titled “scrollbar?”
optionalscrollbar?:object
Defines the color of the background, thumb and track of the scrollbar.
background?
Section titled “background?”
optionalbackground?:string
thumb?
Section titled “thumb?”
optionalthumb?:string
track?
Section titled “track?”
optionaltrack?:string
Inherited from
Section titled “Inherited from”scrollbarThickness
Section titled “scrollbarThickness”scrollbarThickness:
number
The thickness of the scrollbar in pixels.
visible
Section titled “visible”visible:
boolean
Controls the visibility of the component. If set to false, the component
will not be rendered.
Inherited from
Section titled “Inherited from”wantsKeyboardFocus
Section titled “wantsKeyboardFocus”wantsKeyboardFocus:
boolean
Indicates whether the component requests keyboard focus when it becomes active or is programmatically highlighted. This is important for keyboard navigation and input.
Inherited from
Section titled “Inherited from”width:
number
The width of the component in pixels.
Inherited from
Section titled “Inherited from”x:
number
The x-coordinate of the component’s top-left corner, typically measured from the left edge of its containing element or viewport.
Inherited from
Section titled “Inherited from”y:
number
The y-coordinate of the component’s top-left corner, typically measured from the top edge of its containing element or viewport.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”scrollChildIntoView()
Section titled “scrollChildIntoView()”scrollChildIntoView(
childIndex):void
Scrolls the child at the given index into view.
Parameters
Section titled “Parameters”childIndex
Section titled “childIndex”number
The index of the child to scroll into view.
Returns
Section titled “Returns”void
setScrollPositionProportionately()
Section titled “setScrollPositionProportionately()”setScrollPositionProportionately(
xPos,yPos):void
Sets the scroll position of the view.
Parameters
Section titled “Parameters”number
The horizontal scroll position in pixels.
number
The vertical scroll position in pixels.
Returns
Section titled “Returns”void