クラス: FloatingObjectCollection

Sheets.FloatingObjects.FloatingObjectCollection

Table of contents

コンストラクタ

• constructor

メソッド

• add
• all
• clear
• get
• remove
• zIndex

コンストラクタ

constructor

• new FloatingObjectCollection(sheet?, typeName?)

シートのすべてのフローティングオブジェクトを管理するフローティングオブジェクトマネージャを表します。

パラメータ

メソッド

add

▸ add(floatingObjectOrName, src?, x?, y?, width?, height?): FloatingObject

フローティングオブジェクトをシートに追加します。引数には次の2つのモードがあります。パラメーターが1つの場合、それはGC.Spread.Sheets.FloatingObjects.FloatingObject型のフローティングオブジェクトを示します。パラメーターが6つの場合、それらは名前、ソース、x、y、幅、高さを示します。

実例

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);

パラメータ

戻り値

FloatingObject

シートに追加されたフローティングオブジェクト。

all

▸ all(): FloatingObject[]

シートに存在するすべてのフローティングオブジェクトを取得します。

実例

activeSheet.pictures.add("p1", "pics/download.jpg", 1, 6, 400, 400);
activeSheet.pictures.add("p2", "pics/download.jpg", 500, 150, 200, 300);
var pictures = activeSheet.pictures.all();
for (var i = 0; i < pictures.length; i++) {
    alert("Path of picture " + i + " is:  " + pictures[i].src())
}

戻り値

FloatingObject[]

シートに存在するすべてのフローティングオブジェクトのコレクション。

clear

▸ clear(): void

シートに存在するすべてのフローティングオブジェクトを削除します。

実例

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

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

console.log(activeSheet.floatingObjects.all().length); // 結果は 2 です。
activeSheet.floatingObjects.clear(); // すべてのフローティングオブジェクトを削除します。
console.log(activeSheet.floatingObjects.all().length); // 結果は 0 です。

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

戻り値

void

get

▸ get(name): FloatingObject

シートのフローティングオブジェクトを名前によって取得します。

実例

activeSheet.pictures.add("f2","tsoutline.png",100,60,200,100);
// ボタン
$("#button1").click(function () {
 var pic = activeSheet.pictures.get("f2");
});

パラメータ

戻り値

FloatingObject

指定した名前を持つ、シートのフローティングオブジェクト。

remove

▸ remove(name): void

シートのフローティングオブジェクトを名前によって削除します。

実例

activeSheet.pictures.add("f2","tsoutline.png",100,60,200,100);
// ボタン
$("#button1").click(function () {
     activeSheet.resumePaint();
     activeSheet.pictures.remove("f2");
     activeSheet.repaint();
});

パラメータ

戻り値

void

zIndex

▸ zIndex(name, zIndex?): any

フローティングオブジェクトのzインデックスを取得または設定します。

実例

var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 20, 20, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button1";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);
var customFloatingObject1 = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f2", 5, 5, 30, 64);
var btn1 = document.createElement('button');
btn1.style.width = "60px";
btn1.style.height = "30px";
btn1.innerText = "button2";
customFloatingObject1.content(btn1);
activeSheet.floatingObjects.add(customFloatingObject1);
activeSheet.floatingObjects.zIndex("f2", 897);
activeSheet.floatingObjects.zIndex("f1", 898);

パラメータ

戻り値

any

パラメーター'zIndex'がnullまたはundefinedの場合は、指定した名前を持つフローティングオブジェクトのzインデックスが返されます。