[]
        
首页
开发者学堂
文档
论坛
市场
生态机会
活动
在线咨询 立即试用
(Showing Draft Content)

GC.Spread.Sheets.FloatingObjects.FloatingObject

Class: FloatingObject

Sheets.FloatingObjects.FloatingObject

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new FloatingObject(name, x, y, width, height)

表示一个浮动对象。

remarks 这是一个基类,仅供内部使用。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
name string 浮动对象的名称。
x number 浮动对象的 x 坐标位置。
y number 浮动对象的 y 坐标位置。
width number 浮动对象的宽度。
height number 浮动对象的高度。

Properties

typeName

• typeName: string

表示用于支持序列化的类型名称字符串。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject('floatingObject', 10, 10, 64, 30);
console.log(customFloatingObject.typeName); // "0"

Methods

allowMove

▸ allowMove(value?): any

获取或设置是否禁用移动浮动对象。

example

//此示例禁止移动或调整浮动对象大小。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.allowResize(false);
customFloatingObject.allowMove(false);
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 是否禁用移动浮动对象的设置。

Returns

any

如果未设置值,则返回是否禁用移动浮动对象的设置;否则返回浮动对象。


allowResize

▸ allowResize(value?): any

获取或设置是否禁用调整浮动对象大小。

example

//此示例禁止移动或调整浮动对象大小。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.allowResize(false);
customFloatingObject.allowMove(false);
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 是否禁用调整浮动对象大小的设置。

Returns

any

如果未设置值,则返回是否禁用调整浮动对象大小的设置;否则返回浮动对象。


alt

▸ alt(value?): any

获取或设置浮动对象的替代文本(用于屏幕阅读器)。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject('f1', 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
customFloatingObject.alt("一个按钮");
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? string 浮动对象的替代文本。

Returns

any

浮动对象的替代文本。


cloneContent

▸ cloneContent(): HTMLElement

获取实例当前内容的副本。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject('f1', 10, 10, 64, 30);
customFloatingObject.content(createButton('button 1', '64px', '30px'));
activeSheet.floatingObjects.add(customFloatingObject);

var btn = customFloatingObject.cloneContent();
btn.innerText = 'button 2';
customFloatingObject.content(btn);

function createButton (text, width, height) {
    var btn = document.createElement('button');
    btn.style.width = width;
    btn.style.height = height;
    btn.innerText = text;
    return btn;
}

Returns

HTMLElement

实例当前内容的副本。


content

▸ content(value?): any

获取或设置自定义浮动对象的内容。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject('f1', 10, 10, 64, 30);
customFloatingObject.content(createButton('button 1', '64px', '30px'));
activeSheet.floatingObjects.add(customFloatingObject);

console.log(customFloatingObject.content()); // 获取当前内容,结果是文本为"button 1"的按钮元素。
customFloatingObject.content(createButton('button 2', '64px', '30px')); // 设置新内容。

function createButton (text, width, height) {
    var btn = document.createElement('button');
    btn.style.width = width;
    btn.style.height = height;
    btn.innerText = text;
    return btn;
}

Parameters

Name Type Description
value? HTMLElement 自定义浮动对象的内容。

Returns

any

如果未设置值,则返回自定义浮动对象的内容;否则返回浮动对象。


dynamicMove

▸ dynamicMove(value?): any

获取或设置当隐藏或显示、调整大小或移动行或列时,对象是否移动。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isVisible(true);
customFloatingObject.dynamicSize(true);
customFloatingObject.dynamicMove(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 指示当隐藏或显示、调整大小或移动行或列时,对象是否移动的值。

Returns

any

如果未设置值,则返回此浮动对象是否动态移动;否则返回浮动对象。


dynamicSize

▸ dynamicSize(value?): any

获取或设置当隐藏或显示、调整大小或移动行或列时,对象的大小是否改变。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isVisible(true);
customFloatingObject.dynamicSize(true);
customFloatingObject.dynamicMove(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 指示当隐藏或显示、调整大小或移动行或列时,对象的大小是否改变的值。

Returns

any

如果未设置值,则返回此浮动对象是否动态改变大小;否则返回浮动对象。


endColumn

▸ endColumn(value?): any

获取或设置浮动对象位置的结束列索引。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//通过单元格锚点定位浮动对象的右下角。
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象位置的结束列索引。

Returns

any

如果未设置值,则返回浮动对象位置的结束列索引;否则返回浮动对象。


endColumnOffset

▸ endColumnOffset(value?): any

获取或设置浮动对象相对于结束列的偏移量。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//通过单元格锚点定位浮动对象的右下角。
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象相对于结束列的偏移量。

Returns

any

如果未设置值,则返回浮动对象相对于结束列的偏移量;否则返回浮动对象。


endRow

▸ endRow(value?): any

获取或设置浮动对象位置的结束行索引。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//通过单元格锚点定位浮动对象的右下角。
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象位置的结束行索引。

Returns

any

如果未设置值,则返回浮动对象位置的结束行索引;否则返回浮动对象。


endRowOffset

▸ endRowOffset(value?): any

获取或设置相对于浮动对象结束行的偏移量。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//通过单元格锚点定位浮动对象的右下角。
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);

Parameters

Name Type Description
value? number 相对于浮动对象结束行的偏移量。

Returns

any

如果未设置值,则返回相对于浮动对象结束行的偏移量;否则返回浮动对象。


fixedPosition

▸ fixedPosition(value): any

获取或设置浮动对象的位置是否固定。当 fixedPosition 为 true 时,dynamicMove 和 dynamicSize 将被禁用。

example

//此示例将对象的位置设置为固定。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.fixedPosition(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type
value boolean

Returns

any

如果未设置值,则返回浮动对象的位置是否固定;否则返回浮动对象。


getHost

▸ getHost(): HTMLElement[]

获取自定义内容的DOM宿主。

Returns

HTMLElement[]


height

▸ height(value?): any

获取或设置浮动对象的高度。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? number 浮动对象的高度。

Returns

any

如果未设置值,则返回浮动对象的高度;否则返回浮动对象。


isLocked

▸ isLocked(value?): any

获取或设置此浮动对象是否被锁定。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
customFloatingObject.isLocked(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
activeSheet.options.isProtected = true;

Parameters

Name Type Description
value? boolean 指示此浮动对象是否被锁定的值。

Returns

any

如果未设置值,则返回此浮动对象是否被锁定;否则返回浮动对象。


isSelected

▸ isSelected(value?): any

获取或设置此浮动对象是否被选中。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isSelected(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 指示此浮动对象是否被选中的值。

Returns

any

如果未设置值,则返回此浮动对象是否被选中;否则返回浮动对象。


isVisible

▸ isVisible(value?): any

获取或设置此浮动对象是否可见。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
customFloatingObject.isVisible(true);
customFloatingObject.dynamicSize(true);
customFloatingObject.dynamicMove(true);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? boolean 指示此浮动对象是否可见的值。

Returns

any

如果未设置值,则返回此浮动对象是否可见;否则返回浮动对象。


name

▸ name(value?): any

获取浮动对象的名称。

example

//此示例使用name方法。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject();
customFloatingObject.name("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? string 浮动对象的名称。

Returns

any

如果未设置值,则返回浮动对象的名称;否则返回浮动对象。


refreshContent

▸ refreshContent(): void

刷新浮动对象中的内容。用户应该重写此方法以使其内容与浮动对象保持同步。

example

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject('floatingObject', 10, 10, 64, 30);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
// 隐藏浮动对象
customFloatingObject.isVisible(false);
activeSheet.floatingObjects.add(customFloatingObject);

// 显示浮动对象
customFloatingObject.isVisible(true);
customFloatingObject.refreshContent(customFloatingObject.content());

Returns

void


startColumn

▸ startColumn(value?): any

获取或设置浮动对象位置的起始列索引。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象位置的起始列索引。

Returns

any

如果未设置值,则返回浮动对象位置的起始列索引;否则返回浮动对象。


startColumnOffset

▸ startColumnOffset(value?): any

获取或设置浮动对象相对于起始列的偏移量。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象相对于起始列的偏移量。

Returns

any

如果未设置值,则返回浮动对象相对于起始列的偏移量;否则返回浮动对象。


startRow

▸ startRow(value?): any

获取或设置浮动对象位置的起始行索引。

example

//创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象位置的起始行索引。

Returns

any

如果未设置值,则返回浮动对象位置的起始行索引;否则返回浮动对象。


startRowOffset

▸ startRowOffset(value?): any

获取或设置浮动对象相对于起始行的偏移量。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
//通过单元格锚点定位浮动对象的左上角。
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);

Parameters

Name Type Description
value? number 浮动对象相对于起始行的偏移量。

Returns

any

如果未设置值,则返回浮动对象相对于起始行的偏移量;否则返回浮动对象。


width

▸ width(value?): any

获取或设置浮动对象的宽度。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? number 浮动对象的宽度。

Returns

any

如果未设置值,则返回浮动对象的宽度;否则返回浮动对象。


x

▸ x(value?): any

获取或设置浮动对象的水平位置。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? number 浮动对象的水平位置。

Returns

any

如果未设置值,则返回浮动对象的水平位置;否则返回浮动对象。


y

▸ y(value?): any

获取或设置浮动对象的垂直位置。

example

//此示例创建一个浮动对象。
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1");
customFloatingObject.x(10);
customFloatingObject.y(10);
customFloatingObject.width(60);
customFloatingObject.height(64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Parameters

Name Type Description
value? number 浮动对象的垂直位置。

Returns

any

如果未设置值,则返回浮动对象的垂直位置;否则返回浮动对象。