Class ScrollViewComponentElement

The ScrollViewComponentElement interface provides properties and methods for manipulating <pc-scrollview> elements. The ScrollViewComponentElement interface also inherits the properties and methods of the HTMLElement interface.

Hierarchy (View Summary)

ComponentElement
- ScrollViewComponentElement

Index

Accessors

bounceAmount component content enabled friction horizontal horizontalScrollbar horizontalScrollbarVisibility mouseWheelSensitivity scrollMode useMouseWheel vertical verticalScrollbar verticalScrollbarVisibility viewport

Methods

_onReady ready

Accessors

bounceAmount

get bounceAmount(): number
Gets the bounce amount.

Returns number
The bounce amount.
- Defined in src/components/scrollview-component.ts:175
set bounceAmount(value: number): void
Sets how far the content is allowed to bounce beyond its bounds when scroll-mode is bounce, in the range 0 to 1.
Parameters
- value: number
  The bounce amount.
Returns void
- Defined in src/components/scrollview-component.ts:164

component

get component(): ScrollViewComponent | null
Gets the underlying PlayCanvas scroll view component.

Returns ScrollViewComponent | null
The scroll view component.
Overrides ComponentElement.component
- Defined in src/components/scrollview-component.ts:97

content

get content(): string
Gets the reference to the <pc-entity> used as the content.

Returns string
The content entity reference.
- Defined in src/components/scrollview-component.ts:313
set content(value: string): void
Sets the reference (CSS selector, element id or entity name) to the <pc-entity> used as the content, which is moved as the scroll view is scrolled.
Parameters
- value: string
  The content entity reference.
Returns void
- Defined in src/components/scrollview-component.ts:301

enabled

get enabled(): boolean
Gets the enabled state of the component.

Returns boolean
The enabled state of the component.
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:80
set enabled(value: boolean): void
Sets the enabled state of the component.
Parameters
- value: boolean
  The enabled state of the component.
Returns void
Inherited from ComponentElement.enabled
- Defined in src/components/component.ts:69

friction

get friction(): number
Gets the friction.

Returns number
The friction.
- Defined in src/components/scrollview-component.ts:194
set friction(value: number): void
Sets how freely the content moves once thrown, in the range 0 (no friction) to 1.
Parameters
- value: number
  The friction.
Returns void
- Defined in src/components/scrollview-component.ts:183

horizontal

get horizontal(): boolean
Gets whether horizontal scrolling is enabled.

Returns boolean
Whether horizontal scrolling is enabled.
- Defined in src/components/scrollview-component.ts:116
set horizontal(value: boolean): void
Sets whether horizontal scrolling is enabled.
Parameters
- value: boolean
  Whether horizontal scrolling is enabled.
Returns void
- Defined in src/components/scrollview-component.ts:105

horizontalScrollbar

get horizontalScrollbar(): string
Gets the reference to the <pc-entity> containing the horizontal scrollbar.

Returns string
The horizontal scrollbar entity reference.
- Defined in src/components/scrollview-component.ts:334
set horizontalScrollbar(value: string): void
Sets the reference (CSS selector, element id or entity name) to the <pc-entity> containing the horizontal <pc-scrollbar>.
Parameters
- value: string
  The horizontal scrollbar entity reference.
Returns void
- Defined in src/components/scrollview-component.ts:322

horizontalScrollbarVisibility

get horizontalScrollbarVisibility(): number
Gets the visibility of the horizontal scrollbar.

Returns number
The horizontal scrollbar visibility.
- Defined in src/components/scrollview-component.ts:252
set horizontalScrollbarVisibility(value: number): void
Sets the visibility of the horizontal scrollbar. Can be always (0) or when-required (1).
Parameters
- value: number
  The horizontal scrollbar visibility.
Returns void
- Defined in src/components/scrollview-component.ts:241

mouseWheelSensitivity

get mouseWheelSensitivity(): Vec2
Gets the mouse wheel sensitivity.

Returns Vec2
The mouse wheel sensitivity.
- Defined in src/components/scrollview-component.ts:233
set mouseWheelSensitivity(value: Vec2): void
Sets the mouse wheel sensitivity as a Vec2 (horizontal, vertical). A value of 0 on an axis disables mouse wheel scrolling for that axis.
Parameters
- value: Vec2
  The mouse wheel sensitivity.
Returns void
- Defined in src/components/scrollview-component.ts:222

scrollMode

get scrollMode(): number
Gets how the scroll view behaves when the content is scrolled beyond its bounds.

Returns number
The scroll mode.
- Defined in src/components/scrollview-component.ts:155
set scrollMode(value: number): void
Sets how the scroll view should behave when the content is scrolled beyond its bounds. Can be clamp (0), bounce (1) or infinite (2).
Parameters
- value: number
  The scroll mode.
Returns void
- Defined in src/components/scrollview-component.ts:144

useMouseWheel

get useMouseWheel(): boolean
Gets whether the scroll view responds to mouse wheel events.

Returns boolean
Whether the mouse wheel is used.
- Defined in src/components/scrollview-component.ts:213
set useMouseWheel(value: boolean): void
Sets whether the scroll view responds to mouse wheel events.
Parameters
- value: boolean
  Whether to use the mouse wheel.
Returns void
- Defined in src/components/scrollview-component.ts:202

vertical

get vertical(): boolean
Gets whether vertical scrolling is enabled.

Returns boolean
Whether vertical scrolling is enabled.
- Defined in src/components/scrollview-component.ts:135
set vertical(value: boolean): void
Sets whether vertical scrolling is enabled.
Parameters
- value: boolean
  Whether vertical scrolling is enabled.
Returns void
- Defined in src/components/scrollview-component.ts:124

verticalScrollbar

get verticalScrollbar(): string
Gets the reference to the <pc-entity> containing the vertical scrollbar.

Returns string
The vertical scrollbar entity reference.
- Defined in src/components/scrollview-component.ts:355
set verticalScrollbar(value: string): void
Sets the reference (CSS selector, element id or entity name) to the <pc-entity> containing the vertical <pc-scrollbar>.
Parameters
- value: string
  The vertical scrollbar entity reference.
Returns void
- Defined in src/components/scrollview-component.ts:343

verticalScrollbarVisibility

get verticalScrollbarVisibility(): number
Gets the visibility of the vertical scrollbar.

Returns number
The vertical scrollbar visibility.
- Defined in src/components/scrollview-component.ts:271
set verticalScrollbarVisibility(value: number): void
Sets the visibility of the vertical scrollbar. Can be always (0) or when-required (1).
Parameters
- value: number
  The vertical scrollbar visibility.
Returns void
- Defined in src/components/scrollview-component.ts:260

viewport

get viewport(): string
Gets the reference to the <pc-entity> used as the viewport.

Returns string
The viewport entity reference.
- Defined in src/components/scrollview-component.ts:292
set viewport(value: string): void
Sets the reference (CSS selector, element id or entity name) to the <pc-entity> used as the viewport, which clips the content to the scroll view's bounds.
Parameters
- value: string
  The viewport entity reference.
Returns void
- Defined in src/components/scrollview-component.ts:280

Methods

`Protected`_onReady

_onReady(): void
Called when the element is fully initialized and ready. Subclasses should call this when they're ready.

Returns void
Inherited from ComponentElement._onReady
- Defined in src/async-element.ts:32

ready

ready(): Promise<ScrollViewComponentElement>
Returns a promise that resolves with this element when it's ready.

Returns Promise<ScrollViewComponentElement>
A promise that resolves with this element when it's ready.
Inherited from ComponentElement.ready
- Defined in src/async-element.ts:41

Class ScrollViewComponentElement

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

bounceAmount

Returns number

Parameters

Returns void

component

Returns ScrollViewComponent | null

content

Returns string

Parameters

Returns void

enabled

Returns boolean

Parameters

Returns void

friction

Returns number

Parameters

Returns void

horizontal

Returns boolean

Parameters

Returns void

horizontalScrollbar

Returns string

Parameters

Returns void

horizontalScrollbarVisibility

Returns number

Parameters

Returns void

mouseWheelSensitivity

Returns Vec2

Parameters

Returns void

scrollMode

Returns number

Parameters

Returns void

useMouseWheel

Returns boolean

Parameters

Returns void

vertical

Returns boolean

Parameters

Returns void

verticalScrollbar

Returns string

Parameters

Returns void

verticalScrollbarVisibility

Returns number

Parameters

Returns void

viewport

Returns string

Parameters

Returns void

Methods

Protected_onReady

Returns void

ready

Returns Promise<ScrollViewComponentElement>

Settings

On This Page

`Protected`_onReady