Skip to content

类: ScrollView

示例:创建并添加一个带滚动视图的图片

示例

// 1. 创建图片视图
const img = new LM.ImgView();
img.src = 'Graphics/Background/封面图.png';

// 2. 创建滚动视图
const scrollView = new LM.ScrollView();
scrollView.width = 400;  // 设置宽度
scrollView.height = 400; // 设置高度
scrollView.x = 100;      // 设置x坐标
scrollView.y = 100;      // 设置y坐标
scrollView.orientation = LM.Orientation.vertical; // 设置垂直滚动方向

// 3. 将图片设置为滚动视图的内容容器
scrollView.contentContainer = img;

// 4. 将滚动视图添加到当前场景
scene.addChild(scrollView);

继承

构造函数

构造函数

new ScrollView(): ScrollView

返回

ScrollView

继承自

UIBaseView.constructor

属性

属性类型描述

alias

string

别名 用于标识/获取组件

示例

ts
let img = new LM.ImgView()
// 给控件起一个名字
img.alias = "img01"

alpha

number

对象的透明度

Range

示例

let img = new LM.ImgView()
// 修改透明度
img.alpha = 100

autoHideDelay

number

自动隐藏延迟时间(毫秒)

autoHideScrollBar

boolean

是否在不滚动时自动隐藏滚动条

backgroundColor

string

背景色

示例

ts
let img = new LM.ImgView()
// 修改控件的背景色
img.backgroundColor = "#FF0000"

bounces

boolean

是否支持回弹效果

contentAlignment

string

内容对齐方式

contentContainer

any

滚动内容的容器

contentHeight

number

内容高度

contentWidth

number

内容宽度

decelerationRate

number

减速率(惯性滚动减速程度)

fadeDuration

number

滚动条显示/隐藏的淡入淡出时间(毫秒)

h

number

已被弃用

自v1.3.0起废弃,请使用新的height 对象的宽度 宽高都被设置时才会生效

示例

obj.h = 100

height

number

容器高度(不建议直接使用)

inertia

boolean

是否支持惯性滚动

isPenetrable

boolean

是否可穿透

maxScrollX

number

最大水平滚动位置

maxScrollY

number

最大垂直滚动位置

mouseThrough

boolean

已被弃用

自v1.3.0起废弃,请使用新的 isPenetrable 是否可穿透 默认可穿透 当使用Container创建父子级关系时 需要把自己穿透都打开才能触发到Container的点击事件

orientation

string

padding

number

内容边距

scaleX

number

x轴缩放

Range

scaleY

number

y轴缩放

Range

scrollBarColor

string

滚动滑块颜色

scrollBarCornerRadius

number

滚动条圆角

scrollBarImage

string

滚动滑块图片路径

scrollBarMargin

number

滚动条与容器边缘的距离

scrollBarOpacity

number

滚动条透明度(0-255)

scrollBarVisible

boolean

是否显示滚动条

scrollBarWidth

number

滚动条宽度

scrollDisabled

boolean

禁止滚动

scrollSliderColor

string

滚动条颜色

scrollSliderImage

string

滚动条图片路径

scrollX

number

水平滚动位置

scrollY

number

垂直滚动位置

touchEable

boolean

已被弃用

自v1.3.0起废弃,请使用新的touchEnabled 是否可点击(默认可点击)

touchEnabled

boolean

是否可点击(默认可点击)

visible

boolean

组件是否可见

示例

ts
let img = new LM.ImgView()
// 隐藏该控件
img.visible = false

w

number

已被弃用

自v1.3.0起废弃,请使用新的width 对象的宽度 宽高都被设置时才会生效

示例

obj.w = 100

width

number

容器宽度(不建议直接使用)

worldX

number

对象的全局x坐标 (建议不要频繁设置获取,相较于x比较耗性能)

worldY

number

对象的全局y坐标 (建议不要频繁设置获取,相较于y比较耗性能)

x

number

对象的x坐标

示例

obj.x = 100

y

number

对象的y坐标

示例

obj.y = 100

z

number

对象的层级

示例

let img = new LM.ImgView()
this.addChild(img) //注意:需要先添加到父容器后再设置层级,否则层级设置无效。
img.z = 100

zoomCenterX

number

縮放中心点x 默认为0

Range

zoomCenterY

number

縮放中心点y 默认为0

Range

zoomX

number

x轴缩放

Range

zoomY

number

y轴缩放

Range

方法

addChild()

addChild(child): any

添加子对象到内容容器

参数

child

any

返回

any

重写了

UIBaseView.addChild


click()

click(fn): any

参数

fn

Function

返回

any

已被弃用

自v1.3.0起废弃,请使用新的onClick 点击行为

示例

ts
let img = new LM.ImgView()
// 为这张图片注册了点击事件
img.click( 
   () => {
     console.log("点击了改控件")
   }
)

继承自

UIBaseView.click


dispose()

dispose(): void

销毁组件

返回

void

继承自

UIBaseView.dispose


getParent()

getParent(): UIBaseView

获取父级

返回

UIBaseView

继承自

UIBaseView.getParent


getSaveData()

getSaveData(): any

获取组件的存档信息

返回

any

继承自

UIBaseView.getSaveData


onClick()

onClick(fn): any

点击行为

参数

fn

Function

返回

any

示例

ts
let img = new LM.ImgView()
// 为这张图片注册了点击事件
img.onClick( 
   () => {
     console.log("点击了改控件")
   }
)

继承自

UIBaseView.onClick


onScroll()

onScroll(fn): any

滚动事件

参数

fn

Function

返回

any


onScrollEnd()

onScrollEnd(fn): any

滚动结束事件

参数

fn

Function

返回

any


onScrollStart()

onScrollStart(fn): any

滚动开始事件

参数

fn

Function

返回

any


onTouchCancel()

onTouchCancel(fn): any

鼠标移出

参数

fn

Function

返回

any

示例

ts
let img = new LM.ImgView()
// 注册了移出事件
img.touchOut(()=>{console.log("移出")})

继承自

UIBaseView.onTouchCancel


onTouchDown()

onTouchDown(fn): any

按下行为

参数

fn

Function

返回

any

示例

ts
let text = new LM.TextView()
// 注册了按下事件
text.onTouchDown(()=>{console.log("按下")})

继承自

UIBaseView.onTouchDown


onTouchEnd()

onTouchEnd(fn): any

触摸结束事件

参数

fn

Function

返回

any


onTouchMove()

onTouchMove(fn): any

触摸移动事件

参数

fn

Function

返回

any

重写了

UIBaseView.onTouchMove


onTouchStart()

onTouchStart(fn): any

触摸开始事件

参数

fn

Function

返回

any


onTouchUp()

onTouchUp(fn): any

抬起行为

参数

fn

Function

返回

any

示例

ts
let img = new LM.ImgView()
// 注册了抬起事件
img.onTouchUp(()=>{console.log("抬起")})

继承自

UIBaseView.onTouchUp


removeAllChildren()

removeAllChildren(): void

移除所有子对象

返回

void


removeFromParent()

removeFromParent(): void

从父级移除

返回

void

继承自

UIBaseView.removeFromParent


scrollTo()

scrollTo(x, y, duration?): any

滚动到指定位置

参数

x

number

y

number

duration?

number

返回

any


scrollToBottom()

scrollToBottom(duration?): any

滚动到底部

参数

duration?

number

返回

any


scrollToLeft()

scrollToLeft(duration?): any

滚动到最左侧

参数

duration?

number

返回

any


scrollToRight()

scrollToRight(duration?): any

滚动到最右侧

参数

duration?

number

返回

any


scrollToTop()

scrollToTop(duration?): any

滚动到顶部

参数

duration?

number

返回

any


stopScroll()

stopScroll(): any

停止滚动

返回

any


touchCancel()

touchCancel(fn): any

参数

fn

Function

返回

any

已被弃用

自v1.3.0起废弃,请使用新的onTouchCancel 鼠标移出

示例

ts
let img = new LM.ImgView()
// 注册了移出事件
img.touchOut(()=>{console.log("移出")})

继承自

UIBaseView.touchCancel


touchDown()

touchDown(fn): any

参数

fn

Function

返回

any

已被弃用

自v1.3.0起废弃,请使用新的onTouchDown 按下行为

示例

ts
let text = new LM.TextView()
// 注册了按下事件
text.touchDown(()=>{console.log("按下")})

继承自

UIBaseView.touchDown


touchMove()

touchMove(fn): any

参数

fn

Function

返回

any

已被弃用

自v1.3.0起废弃,请使用新的onTouchMove 鼠标移动行为

示例

ts
let text = new LM.TextView()
// 注册了移动事件
text.touchMove(()=>{console.log("移动了")})

继承自

UIBaseView.touchMove


touchUp()

touchUp(fn): any

参数

fn

Function

返回

any

已被弃用

自v1.3.0起废弃,请使用新的onTouchUp 抬起行为

示例

ts
let img = new LM.ImgView()
// 注册了抬起事件
img.touchUp(()=>{console.log("抬起")})

继承自

UIBaseView.touchUp