laya-coreui-es
Version:
laya核心库、ui库es版本,剔除了媒体、TTF等功能。基于 LayaAir-release_2.12.0 修改
175 lines (174 loc) • 6.93 kB
TypeScript
import { Texture } from "../resource/Texture";
import { AutoBitmap } from "./AutoBitmap";
import { UIComponent } from "./UIComponent";
/**
* 资源加载完成后调度。
* @eventType Event.LOADED
*/
/**
* <code>Image</code> 类是用于表示位图图像或绘制图形的显示对象。
* Image和Clip组件是唯一支持异步加载的两个组件,比如img.skin = "abc/xxx.png",其他UI组件均不支持异步加载。
*
* @example <caption>以下示例代码,创建了一个新的 <code>Image</code> 实例,设置了它的皮肤、位置信息,并添加到舞台上。</caption>
* package
* {
* import laya.ui.Image;
* public class Image_Example
* {
* public function Image_Example()
* {
* Laya.init(640, 800);//设置游戏画布宽高。
* Laya.stage.bgColor = "#efefef";//设置画布的背景颜色。
* onInit();
* }
* private function onInit():void
* {
* var bg:Image = new Image("resource/ui/bg.png");//创建一个 Image 类的实例对象 bg ,并传入它的皮肤。
* bg.x = 100;//设置 bg 对象的属性 x 的值,用于控制 bg 对象的显示位置。
* bg.y = 100;//设置 bg 对象的属性 y 的值,用于控制 bg 对象的显示位置。
* bg.sizeGrid = "40,10,5,10";//设置 bg 对象的网格信息。
* bg.width = 150;//设置 bg 对象的宽度。
* bg.height = 250;//设置 bg 对象的高度。
* Laya.stage.addChild(bg);//将此 bg 对象添加到显示列表。
* var image:Image = new Image("resource/ui/image.png");//创建一个 Image 类的实例对象 image ,并传入它的皮肤。
* image.x = 100;//设置 image 对象的属性 x 的值,用于控制 image 对象的显示位置。
* image.y = 100;//设置 image 对象的属性 y 的值,用于控制 image 对象的显示位置。
* Laya.stage.addChild(image);//将此 image 对象添加到显示列表。
* }
* }
* }
* @example
* Laya.init(640, 800);//设置游戏画布宽高
* Laya.stage.bgColor = "#efefef";//设置画布的背景颜色
* onInit();
* function onInit() {
* var bg = new laya.ui.Image("resource/ui/bg.png");//创建一个 Image 类的实例对象 bg ,并传入它的皮肤。
* bg.x = 100;//设置 bg 对象的属性 x 的值,用于控制 bg 对象的显示位置。
* bg.y = 100;//设置 bg 对象的属性 y 的值,用于控制 bg 对象的显示位置。
* bg.sizeGrid = "40,10,5,10";//设置 bg 对象的网格信息。
* bg.width = 150;//设置 bg 对象的宽度。
* bg.height = 250;//设置 bg 对象的高度。
* Laya.stage.addChild(bg);//将此 bg 对象添加到显示列表。
* var image = new laya.ui.Image("resource/ui/image.png");//创建一个 Image 类的实例对象 image ,并传入它的皮肤。
* image.x = 100;//设置 image 对象的属性 x 的值,用于控制 image 对象的显示位置。
* image.y = 100;//设置 image 对象的属性 y 的值,用于控制 image 对象的显示位置。
* Laya.stage.addChild(image);//将此 image 对象添加到显示列表。
* }
* @example
* class Image_Example {
* constructor() {
* Laya.init(640, 800);//设置游戏画布宽高。
* Laya.stage.bgColor = "#efefef";//设置画布的背景颜色。
* this.onInit();
* }
* private onInit(): void {
* var bg: laya.ui.Image = new laya.ui.Image("resource/ui/bg.png");//创建一个 Image 类的实例对象 bg ,并传入它的皮肤。
* bg.x = 100;//设置 bg 对象的属性 x 的值,用于控制 bg 对象的显示位置。
* bg.y = 100;//设置 bg 对象的属性 y 的值,用于控制 bg 对象的显示位置。
* bg.sizeGrid = "40,10,5,10";//设置 bg 对象的网格信息。
* bg.width = 150;//设置 bg 对象的宽度。
* bg.height = 250;//设置 bg 对象的高度。
* Laya.stage.addChild(bg);//将此 bg 对象添加到显示列表。
* var image: laya.ui.Image = new laya.ui.Image("resource/ui/image.png");//创建一个 Image 类的实例对象 image ,并传入它的皮肤。
* image.x = 100;//设置 image 对象的属性 x 的值,用于控制 image 对象的显示位置。
* image.y = 100;//设置 image 对象的属性 y 的值,用于控制 image 对象的显示位置。
* Laya.stage.addChild(image);//将此 image 对象添加到显示列表。
* }
* }
* @see laya.ui.AutoBitmap
*/
export declare class Image extends UIComponent {
/**@private */
protected _skin: string;
/**@private */
protected _group: string;
/**
* 创建一个 <code>Image</code> 实例。
* @param skin 皮肤资源地址。
*/
constructor(skin?: string | null);
/**
* @inheritDoc
* @override
*/
destroy(destroyChild?: boolean): void;
/**
* 销毁对象并释放加载的皮肤资源。
*/
dispose(): void;
/**
* @inheritDoc
* @override
*/
protected createChildren(): void;
/**
* <p>对象的皮肤地址,以字符串表示。</p>
* <p>如果资源未加载,则先加载资源,加载完成后应用于此对象。</p>
* <b>注意:</b>资源加载完成后,会自动缓存至资源库中。
*/
get skin(): string;
set skin(value: string);
/**
* @copy laya.ui.AutoBitmap#source
*/
get source(): Texture;
set source(value: Texture);
/**
* 资源分组。
*/
get group(): string;
set group(value: string);
/**
* @private
* 设置皮肤资源。
*/
protected setSource(url: string, img?: any): void;
/**
* @inheritDoc
* @override
*/
protected measureWidth(): number;
/**
* @inheritDoc
* @override
*/
protected measureHeight(): number;
/**
* @inheritDoc
* @override
*/
set width(value: number);
/**
* @inheritDoc
* @override
*/
get width(): number;
/**
* @inheritDoc
* @override
*/
set height(value: number);
/**
* @inheritDoc
* @override
*/
get height(): number;
/**
* <p>当前实例的位图 <code>AutoImage</code> 实例的有效缩放网格数据。</p>
* <p>数据格式:"上边距,右边距,下边距,左边距,是否重复填充(值为0:不重复填充,1:重复填充)",以逗号分隔。
* <ul><li>例如:"4,4,4,4,1"。</li></ul></p>
* @see laya.ui.AutoBitmap#sizeGrid
*/
get sizeGrid(): string;
set sizeGrid(value: string);
/**
* @inheritDoc
* @override
*/
set dataSource(value: any);
/**
* @inheritDoc
* @override
*/
get dataSource(): any;
}