Preparing search index...

    This class represents a scrollbar component that can be used with a ScrollView. It manages the scrollbar's position, size, and interaction events. The class calculates the height offset to prevent the scrollbar mesh from extending past the canvas and integrates with the ScrollView to handle scrolling.

    in favor of using SpectaclesUIKit's ScrollBar component. See https://developers.snap.com/spectacles/spectacles-frameworks/spectacles-ui-kit/get-started for more details.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    api: Record<string, any>

    Generic object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.

    This property is no longer needed, you can use a reference to the ScriptComponent, including 'script', directly

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    true
    
    isBeingDestroyed: boolean

    Returns true if this Component is currently being destroyed. Becomes true as soon as destruction begins via Component#destroy or destruction of its owning SceneObject, before any OnDestroyEvent callbacks fire.

    Lens Scripting Version 364

    if (!script.isBeingDestroyed) {
    // Component is still fully alive
    }
    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    name: string
    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string

    Lens Scripting Version 176

    updateOrder: number

    The relative execution order of this script's lifecycle callbacks (onStart, onUpdate, onLateUpdate, etc.) among all scripts in the Lens. Scripts with a smaller updateOrder run before scripts with a larger updateOrder. Reflects the updateOrder set on the attached ScriptAsset. Defaults to 0.

    updateOrder only orders scripts relative to each other; it does not affect ordering relative to non-script engine Components.

    Lens Scripting Version 367

    if (script.updateOrder < 0) {
    // This script runs before scripts at the default updateOrder.
    }
    updatePriority: number

    Accessors

    • get boundingHeightOffset(): number

      Returns number

      how far (in cm) the top edge of the ScrollBar mesh should sit from the edge of the canvas when at the top of the content.

    • set boundingHeightOffset(offset: number): void

      Sets the offset between the top edge of the mesh and the edge of the canvas.

      Parameters

      • offset: number

        how far (in cm) the top edge of the ScrollBar mesh should sit from the edge of the canvas when at the top of the content.

      Returns void

    • get isEnabled(): boolean

      Returns boolean

    • set isEnabled(enabled: boolean): void

      Parameters

      • enabled: boolean

      Returns void

    • get overflow(): number

      Returns number

    • get scrollPercentage(): number

      Returns number

    Methods

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Type Parameters

      Parameters

      • this: T

      Returns TypeName<InstanceType<T>>

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns void

    • Returns void

    • Returns void