クラス: FloatingObject

Sheets.FloatingObjects.FloatingObject

階層

• FloatingObject

  ↳ Picture

  ↳ DOMTableSlicer

Table of contents

コンストラクタ

• constructor

プロパティ

• typeName

メソッド

• allowMove
• allowResize
• alt
• cloneContent
• content
• dynamicMove
• dynamicSize
• endColumn
• endColumnOffset
• endRow
• endRowOffset
• fixedPosition
• getHost
• height
• isLocked
• isSelected
• isVisible
• name
• refreshContent
• startColumn
• startColumnOffset
• startRow
• startRowOffset
• width
• X
• y

コンストラクタ

constructor

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

フローティングオブジェクトを表します。

備考 これは内部使用を目的とした基本クラスです。

実例

// 次のサンプルコードは、フローティングオブジェクトを作成します。
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);

パラメータ

名前	型	説明
name	string	フローティングオブジェクトの名前。
x	number	フローティングオブジェクトの<i>x</i>位置。
y	number	フローティングオブジェクトの<i>y</i>位置。
width	number	フローティングオブジェクトの幅。
height	number	フローティングオブジェクトの高さ。

プロパティ

typeName

• typeName: string

シリアル化のサポートに使用される型名の文字列を表します。

メソッド

allowMove

▸ allowMove(value?): any

フローティングオブジェクトの移動を無効にするかどうかを取得または設定します。

実例

// 次のサンプルコードは、フローティングオブジェクトを移動またはサイズ変更できないようにします。
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);

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの移動を無効にするかどうかの設定を返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

allowResize

▸ allowResize(value?): any

フローティングオブジェクトのサイズ変更を無効にするかどうかを取得または設定します。

実例

// 次のサンプルコードは、フローティングオブジェクトを移動またはサイズ変更できないようにします。
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);

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、フローティングオブジェクトのサイズ変更を無効にするかどうかの設定を返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

alt

▸ alt(value?): any

スクリーンリーダーのフローティングオブジェクトの代替テキストを取得または設定します。

実例

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("A button");
activeSheet.floatingObjects.add(customFloatingObject);

パラメータ

名前	型
value?	string

戻り値

any

フローティングオブジェクトの代替テキスト。

---

cloneContent

▸ cloneContent(): HTMLElement

インスタンスの現在の内容のコピーを取得します。

実例

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

戻り値

HTMLElement

インスタンスの現在の内容のコピー。

---

content

▸ content(value?): any

カスタムフローティングオブジェクトの内容を取得または設定します。

実例

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

パラメータ

名前	型
value?	HTMLElement

戻り値

any

値が設定されていない場合は、カスタムフローティングオブジェクトの内容を返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

dynamicMove

▸ dynamicMove(value?): any

行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにオブジェクトが移動するかどうかを取得または設定します。

実例

// 次のサンプルコードは、フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、このフローティングオブジェクトが動的に移動するかどうかを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

dynamicSize

▸ dynamicSize(value?): any

行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにオブジェクトのサイズが変更されるかどうかを取得または設定します。

実例

// 次のサンプルコードは、フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、このフローティングオブジェクトのサイズが動的に変更されるかどうかを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

endColumn

▸ endColumn(value?): any

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

実例

// フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの位置の終了列インデックスを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

endColumnOffset

▸ endColumnOffset(value?): any

フローティングオブジェクトの終了列に対するオフセットを取得または設定します。

実例

// フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの終了列に対するオフセットを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

endRow

▸ endRow(value?): any

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

実例

// フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの位置の終了行インデックスを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

endRowOffset

▸ endRowOffset(value?): any

フローティングオブジェクトの終了行に対するオフセットを取得または設定します。

実例

// フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの終了行に対するオフセットを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

fixedPosition

▸ fixedPosition(value): any

フローティングオブジェクトの位置が固定されているかどうかを取得または設定します。fixedPositionがtrueの場合、dynamicMoveとdynamicSizeは無効になります。

実例

// 次のサンプルコードは、オブジェクトの位置を固定します。
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);

パラメータ

名前	型
value	boolean

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの位置が固定されているかどうかを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

getHost

▸ getHost(): HTMLElement[]

カスタムコンテンツのDOMホストを取得します。

戻り値

HTMLElement[]

---

height

▸ height(value?): any

フローティングオブジェクトの高さを取得または設定します。

実例

// 次のサンプルコードは、フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの高さを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

isLocked

▸ isLocked(value?): any

このフローティングオブジェクトがロックされているかどうかを取得または設定します。

実例

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;

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、このフローティングオブジェクトがロックされているかどうかを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

isSelected

▸ isSelected(value?): any

このフローティングオブジェクトが選択されているかどうかを取得または設定します。

実例

// 次のサンプルコードは、フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、このフローティングオブジェクトが選択されているかどうかを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

isVisible

▸ isVisible(value?): any

このフローティングオブジェクトが表示されるかどうかを取得または設定します。

実例

// 次のサンプルコードは、フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、このフローティングオブジェクトが表示されるかどうかを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

name

▸ name(value?): any

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

実例

// 次のサンプルコードは、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);

パラメータ

名前	型
value?	string

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの名前を返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

refreshContent

▸ refreshContent(): void

フローティングオブジェクトの内容を更新します。内容をフローティングオブジェクトと同期させるには、このメソッドをオーバーライドする必要があります。

戻り値

void

---

startColumn

▸ startColumn(value?): any

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

実例

// フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの位置の開始列インデックスを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

startColumnOffset

▸ startColumnOffset(value?): any

フローティングオブジェクトの開始列に対するオフセットを取得または設定します。

実例

// フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの開始列に対するオフセットを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

startRow

▸ startRow(value?): any

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

実例

// フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの位置の開始行インデックスを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

startRowOffset

▸ startRowOffset(value?): any

フローティングオブジェクトの開始行に対するオフセットを取得または設定します。

実例

// 次のサンプルコードは、フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの開始行に対するオフセットを返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

width

▸ width(value?): any

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

実例

// 次のサンプルコードは、フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの幅を返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

x

▸ x(value?): any

フローティングオブジェクトの水平位置を取得または設定します。

実例

// 次のサンプルコードは、フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの水平位置を返します。値が設定されている場合は、フローティングオブジェクトを返します。

---

y

▸ y(value?): any

フローティングオブジェクトの垂直位置を取得または設定します。

実例

// 次のサンプルコードは、フローティングオブジェクトを作成します。
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);

パラメータ

名前	型
value?	number

戻り値

any

値が設定されていない場合は、フローティングオブジェクトの垂直位置を返します。値が設定されている場合は、フローティングオブジェクトを返します。