[]
Sheets.FloatingObjects.Picture
↳ Picture
• new Picture(name
, src
, x
, y
, width
, height
)
Represents a picture.
Name | Type | Description |
---|---|---|
name |
string |
The name of the picture. |
src |
string |
The image source of the picture. |
x |
number |
The x location of the picture. |
y |
number |
The y location of the picture. |
width |
number |
The width of the picture. |
height |
number |
The height of the picture. |
• typeName: string
Represents the type name string used for supporting serialization.
▸ allowMove(value?
): any
Gets or sets whether to disable moving the floating object.
example
//This example prevents you from moving or resizing the floating object.
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);
Name | Type |
---|---|
value? |
boolean |
any
If no value is set, returns the setting for whether to disable moving the floating object; otherwise, returns the floating object.
▸ allowResize(value?
): any
Gets or sets whether to disable resizing the floating object.
example
//This example prevents you from moving or resizing the floating object.
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);
Name | Type |
---|---|
value? |
boolean |
any
If no value is set, returns the setting for whether to disable resizing the floating object; otherwise, returns the floating object.
▸ alt(value?
): any
Gets or sets the alternative text of the floating object for screen readers.
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("A button");
activeSheet.floatingObjects.add(customFloatingObject);
Name | Type |
---|---|
value? |
string |
any
The alternative text of the floating object.
▸ backColor(value?
): any
Gets or sets the background color of the picture.
example
//This example sets the backcolor of the picture.
var picture = activeSheet.pictures.add("f2","Event.png",50,50,100,100);
picture.borderStyle("solid");
picture.borderWidth(2);
picture.borderColor("red");
Name | Type |
---|---|
value? |
string |
any
If no value is set, returns the backcolor of the picture; otherwise, returns the picture.
▸ borderColor(value?
): any
Gets or sets the border color of the picture.
example
//This example sets the border color of the picture.
var picture = activeSheet.pictures.add("f2","Event.png",50,50,100,100);
picture.borderStyle("solid");
picture.borderWidth(2);
picture.borderColor("red");
Name | Type |
---|---|
value? |
string |
any
If no value is set, returns the border color of the picture; otherwise, returns the picture.
▸ borderRadius(value?
): any
Gets or sets the border radius of the picture.
example
//This example uses the borderRadius method.
var picture = activeSheet.pictures.add("f2","Event.png",50,50,100,100);
picture.backColor("blue");
picture.borderWidth(2);
picture.borderColor("red");
picture.borderStyle("dotted");
picture.borderRadius(5);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the border radius of the picture; otherwise, returns the picture.
▸ borderStyle(value?
): any
Gets or sets the border style of the picture.
example
//This example uses the borderStyle method.
var picture = activeSheet.pictures.add("f2","Event.png",50,50,100,100);
picture.borderStyle("dotted");
picture.borderWidth(2);
picture.borderColor("red");
Name | Type |
---|---|
value? |
string |
any
If no value is set, returns the border style of the picture; otherwise, returns the picture.
▸ borderWidth(value?
): any
Gets or sets the border width of the picture.
example
//This example uses the borderWidth method.
var picture = activeSheet.pictures.add("f2","Event.png",50,50,100,100);
picture.borderStyle("solid");
picture.borderWidth(2);
picture.borderColor("red");
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the border width of the picture; otherwise, returns the picture.
▸ cloneContent(): HTMLElement
Gets a copy of the current content of the instance.
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;
}
HTMLElement
A copy of the current content of the instance.
▸ content(value?
): any
Gets or sets the content of the custom floating object.
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()); // get current content, the result is button element with the text "button 1".
customFloatingObject.content(createButton('button 2', '64px', '30px')); // set new content.
function createButton (text, width, height) {
var btn = document.createElement('button');
btn.style.width = width;
btn.style.height = height;
btn.innerText = text;
return btn;
}
Name | Type |
---|---|
value? |
HTMLElement |
any
If no value is set, returns the content of the custom floating object; otherwise, returns the floating object.
▸ dynamicMove(value?
): any
Gets or sets whether the object moves when hiding or showing, resizing, or moving rows or columns.
example
//This example creates a floating object.
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);
Name | Type |
---|---|
value? |
boolean |
any
If no value is set, returns whether this floating object dynamically moves; otherwise, returns the floating object.
▸ dynamicSize(value?
): any
Gets or sets whether the size of the object changes when hiding or showing, resizing, or moving rows or columns.
example
//This example creates a floating object.
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);
Name | Type |
---|---|
value? |
boolean |
any
If no value is set, returns whether this floating object dynamically changes size; otherwise, returns the floating object.
▸ endColumn(value?
): any
Gets or sets the end column index of the floating object position.
example
//Creates a floating object.
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);
//Position the upper left corner of the floating object by cell anchors.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//Position the lower right corner of the floating object by cell anchors.
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the end column index of the floating object position; otherwise, returns the floating object.
▸ endColumnOffset(value?
): any
Gets or sets the offset relative to the end column of the floating object.
example
//Creates a floating object.
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);
//Position the upper left corner of the floating object by cell anchors.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//Position the lower right corner of the floating object by cell anchors.
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the offset relative to the end column of the floating object; otherwise, returns the floating object.
FloatingObject.endColumnOffset
▸ endRow(value?
): any
Gets or sets the end row index of the floating object position.
example
//Creates a floating object.
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);
//Position the upper left corner of the floating object by cell anchors.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//Position the lower right corner of the floating object by cell anchors.
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the end row index of the floating object position; otherwise, returns the floating object.
▸ endRowOffset(value?
): any
Gets or sets the offset relative to the end row of the floating object.
example
//Creates a floating object.
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);
//Position the upper left corner of the floating object by cell anchors.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
//Position the lower right corner of the floating object by cell anchors.
customFloatingObject.endRow(7);
customFloatingObject.endColumn(5);
customFloatingObject.endRowOffset(10);
customFloatingObject.endColumnOffset(10);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the offset relative to the end row of the floating object; otherwise, returns the floating object.
▸ fixedPosition(value
): any
Gets or sets whether the position of the floating object is fixed. When fixedPosition is true, dynamicMove and dynamicSize are disabled.
example
//This example sets the position of the object to fixed.
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);
Name | Type |
---|---|
value |
boolean |
any
If no value is set, returns whether the position of the floating object is fixed; otherwise, returns the floating object.
▸ getHost(): HTMLElement
[]
Gets the dom host of the custom content.
HTMLElement
[]
▸ getOriginalHeight(): number
Gets the original height of the picture.
example
activeSheet.pictures.add("f2","Event.png",2,2,6,6);
activeSheet.pictures.add("f1","tsoutline.png",3,0,6,6);
var picture = activeSheet.pictures.get("f2");
picture.pictureStretch(GC.Spread.Sheets.ImageLayout.center);
//button
$("#button1").click(function () {
alert(picture.getOriginalHeight());
});
number
The original height of the picture.
▸ getOriginalWidth(): number
Gets the original width of the picture.
example
activeSheet.pictures.add("f2","Event.png",2,2,6,6);
activeSheet.pictures.add("f1","tsoutline.png",3,0,6,6);
var picture = activeSheet.pictures.get("f2");
picture.pictureStretch(GC.Spread.Sheets.ImageLayout.center);
//button
$("#button1").click(function () {
alert(picture.getOriginalWidth());
});
number
The original width of the picture.
▸ height(value?
): any
Gets or sets the height of a floating object.
example
//This example creates a floating object.
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);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the height of a floating object; otherwise, returns the floating object.
▸ isLocked(value?
): any
Gets or sets whether this floating object is locked.
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;
Name | Type |
---|---|
value? |
boolean |
any
If no value is set, returns whether this floating object is locked; otherwise, returns the floating object.
▸ isSelected(value?
): any
Gets or sets whether this floating object is selected.
example
//This example creates a floating object.
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);
Name | Type |
---|---|
value? |
boolean |
any
If no value is set, returns whether this floating object is selected; otherwise, returns the floating object.
▸ isVisible(value?
): any
Gets or sets whether this floating object is visible.
example
//This example creates a floating object.
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);
Name | Type |
---|---|
value? |
boolean |
any
If no value is set, returns whether this floating object is visible; otherwise, returns the floating object.
▸ name(value?
): any
Gets the name of the floating object.
example
//This example uses the name method.
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);
Name | Type |
---|---|
value? |
string |
any
If no value is set, returns the name of the floating object; otherwise, returns the floating object.
▸ pictureStretch(value?
): any
Gets or sets the stretch of the picture.
example
//This example uses the pictureStretch method.
var picture = activeSheet.pictures.add("f2","Event.png",50,50,100,100);
picture.pictureStretch(GC.Spread.Sheets.ImageLayout.stretch);
picture.backColor("blue");
Name | Type |
---|---|
value? |
ImageLayout |
any
If no value is set, returns the stretch of the picture; otherwise, returns the picture.
▸ refreshContent(): void
Refresh the content in floatingObject.The user should override this method to make their content synchronize with the floatingObject.
void
▸ src(value?
): any
Gets or sets the src of the picture.
example
var pic = sheet.pictures.add("Picture 1", "Event.png", 100, 50, 200, 200);
var src = pic.src(); // get current image source, the result is "Event.png".
pic.src("tsoutline.png"); // set new image source.
Name | Type |
---|---|
value? |
string |
any
If no value is set, returns the src of the picture; otherwise, returns the picture.
▸ startColumn(value?
): any
Gets or sets the starting column index of the floating object position.
example
//Creates a floating object.
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);
//Position the upper left corner of the floating object by cell anchors.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the starting column index of the floating object position; otherwise, returns the floating object.
▸ startColumnOffset(value?
): any
Gets or sets the offset relative to the start column of the floating object.
example
//Creates a floating object.
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);
//Position the upper left corner of the floating object by cell anchors.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the offset relative to the start column of the floating object; otherwise, returns the floating object.
FloatingObject.startColumnOffset
▸ startRow(value?
): any
Gets or sets the starting row index of the floating object position.
example
//Creates a floating object.
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);
//Position the upper left corner of the floating object by cell anchors.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the starting row index of the floating object position; otherwise, returns the floating object.
▸ startRowOffset(value?
): any
Gets or sets the offset relative to the start row of the floating object.
example
//This example creates a floating object.
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);
//Position the upper left corner of the floating object by cell anchors.
customFloatingObject.startRow(2);
customFloatingObject.startColumn(2);
customFloatingObject.startRowOffset(10);
customFloatingObject.startColumnOffset(10);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the offset relative to the start row of the floating object; otherwise, returns the floating object.
▸ width(value?
): any
Gets or sets the width of a floating object.
example
//This example creates a floating object.
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);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the width of a floating object; otherwise, returns the floating object.
▸ x(value?
): any
Gets or sets the horizontal location of the floating object.
example
//This example creates a floating object.
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);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the horizontal location of the floating object; otherwise, returns the floating object.
▸ y(value?
): any
Gets or sets the vertical location of the floating object.
example
//This example creates a floating object.
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);
Name | Type |
---|---|
value? |
number |
any
If no value is set, returns the vertical location of the floating object; otherwise, returns the floating object.