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

GC.Spread.Sheets.Shapes.PictureShape

Class: PictureShape

Sheets.Shapes.PictureShape

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

• new PictureShape(worksheet, name, src, left?, top?, width?, height?)

SpreadJS 中的图片形状(PictureShape)是一种用于在工作表中插入和显示图像的形状对象,支持对其尺寸、位置和外观进行全面控制。

Parameters

Name Type Description
worksheet Worksheet 形状所在的工作表。
name string 图片形状的名称。如果名称为空字符串,将自动生成一个唯一名称。
src string 图片的源地址(用于加载图像资源)。
left? number 可选参数。形状的 x 坐标位置(水平位置)。
top? number 可选参数。形状的 y 坐标位置(垂直位置)。
width? number 可选参数。图片形状的宽度,留空则默认与图片的原始宽度一致。
height? number 可选参数。图片形状的高度,留空则默认与图片的原始高度一致。

Overrides

ShapeBase.constructor

Methods

allowMove

▸ allowMove(value?): any

获取或设置是否禁用移动形状。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.allowMove();
heart.allowMove(!state);

Parameters

Name Type Description
value? boolean 是否禁用移动形状的设置。

Returns

any

如果未设置值,返回是否禁用移动形状的设置。

Inherited from

ShapeBase.allowMove


allowResize

▸ allowResize(value?): any

获取或设置形状的调整大小模式。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.allowResize();
heart.allowResize(GC.Spread.Sheets.Shapes.ResizeMode.aspect);

Parameters

Name Type Description
value? boolean | ResizeMode 是否禁用调整形状大小的设置。

Returns

any

如果未设置值,返回是否禁用调整形状大小的设置。

Inherited from

ShapeBase.allowResize


allowRotate

▸ allowRotate(value?): any

获取或设置是否禁用旋转形状。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.allowRotate();
heart.allowRotate(!state);

Parameters

Name Type Description
value? boolean 是否禁用旋转形状的设置。

Returns

any

如果未设置值,返回是否禁用旋转形状的设置。

Inherited from

ShapeBase.allowRotate


alt

▸ alt(value?): any

获取或设置形状的替代文本(用于屏幕阅读器)。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
heart.alt("一个心形");

Parameters

Name Type Description
value? string 形状的替代文本。

Returns

any

形状的替代文本。

Inherited from

ShapeBase.alt


canPrint

▸ canPrint(value?): any

获取或设置此形状是否可打印。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.canPrint(); // 获取形状是否可打印,默认值为 true.
workbook.print(); // 心形被打印。
heart.canPrint(false);
workbook.print(); // 心形不被打印。

Parameters

Name Type Description
value? boolean 指示此形状是否可打印的值。

Returns

any

如果未设置值,返回此形状是否可打印。

Inherited from

ShapeBase.canPrint


dynamicMove

▸ dynamicMove(value?): any

获取或设置形状在隐藏或显示、调整大小或移动行或列时是否移动。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.dynamicMove();
heart.dynamicMove(!state);

Parameters

Name Type Description
value? boolean 指示形状在隐藏或显示、调整大小或移动行或列时是否移动的值。

Returns

any

如果未设置值,返回此形状是否动态移动。

Inherited from

ShapeBase.dynamicMove


dynamicSize

▸ dynamicSize(value?): any

获取或设置形状在隐藏或显示、调整大小或移动行或列时是否改变大小。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.dynamicSize();
heart.dynamicSize(!state);

Parameters

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

Returns

any

如果未设置值,返回此形状是否动态改变大小。

Inherited from

ShapeBase.dynamicSize


endColumn

▸ endColumn(value?): any

获取或设置形状位置的结束列索引。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endColumn();
heart.endColumn(n + 1);

Parameters

Name Type Description
value? number 形状位置的结束列索引。

Returns

any

如果未设置值,返回形状位置的结束列索引。

Inherited from

ShapeBase.endColumn


endColumnOffset

▸ endColumnOffset(value?): any

获取或设置相对于形状结束列的偏移量。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endColumnOffset();
heart.endColumnOffset(0);

Parameters

Name Type Description
value? number 相对于形状结束列的偏移量。

Returns

any

如果未设置值,返回相对于形状结束列的偏移量。

Inherited from

ShapeBase.endColumnOffset


endRow

▸ endRow(value?): any

获取或设置形状位置的结束行索引。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endRow();
heart.endRow(n + 2);

Parameters

Name Type Description
value? number 形状位置的结束行索引。

Returns

any

如果未设置值,返回形状位置的结束行索引。

Inherited from

ShapeBase.endRow


endRowOffset

▸ endRowOffset(value?): any

获取或设置相对于形状结束行的偏移量。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.endRowOffset();
heart.endRowOffset(0);

Parameters

Name Type Description
value? number 相对于形状结束行的偏移量。

Returns

any

如果未设置值,返回相对于形状结束行的偏移量。

Inherited from

ShapeBase.endRowOffset


geometryType

▸ geometryType(value?): void | AutoShapeType

获取或设置图片的几何类型。

example

//此示例为图片形状设置几何类型。
var shape = sheet.shapes.addPictureShape("Picture 1", "data:image/svg+xml;base64.....", 100, 50, 100, 100);
shape.geometryType(GC.Spread.Sheets.Shapes.AutoShapeType.oval);

Parameters

Name Type Description
value? AutoShapeType 图片的几何类型。

Returns

void | AutoShapeType

如果未设置值,返回图片当前的几何类型。


getFormula

▸ getFormula(path): string

通过路径获取形状的公式字符串。

example

sheet.name("Sheet1");
sheet.setValue(0, 1, 150);
var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 100, 100, 200, 200);
shape1.setFormula("x", "=Sheet1!B1");
shape1.getFormula("x");//returns "=Sheet1!B1"

Parameters

Name Type Description
path string 可以接受公式字符串的路径,可以是以下之一:"x", "y", "width", "height"。

Returns

string

返回通过路径获取的形状公式字符串。

Inherited from

ShapeBase.getFormula


getOriginalHeight

▸ getOriginalHeight(): undefined | number

获取图片的原始高度。

example

sheet.bind(GC.Spread.Sheets.Events.ShapeChanged, function(s, e) {
    if (e.propertyName === "originalSize") {
        // 将图片形状的大小设置为图片的原始大小。
        e.shape.width(e.shape.getOriginalWidth());
        e.shape.height(e.shape.getOriginalHeight());
    }
});
var src = "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pjxzdmcgd2lkdGg9IjEwMCIgaGVpZ2h0PSIxMDAiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48Y2lyY2xlIGN4PSI1MCIgY3k9IjUwIiByPSI1MCIgZmlsbD0iYmx1ZSIvPjxwYXRoIGQ9Ik0xMCw1MCBRNDAsMzAgNTAsNTAgVDkwLDUwIiBmaWxsPSJub25lIiBzdHJva2U9Im9yYW5nZSIgc3Ryb2tlLXdpZHRoPSI1Ii8+PC9zdmc+";
var shape = sheet.shapes.addPictureShape("Picture 1", src, 100, 50, 200, 200);

Returns

undefined | number

返回图片的原始高度,如果没有图片或图片未完成加载,则返回undefined。


getOriginalWidth

▸ getOriginalWidth(): undefined | number

获取图片的原始宽度。

example

sheet.bind(GC.Spread.Sheets.Events.ShapeChanged, function(s, e) {
    if (e.propertyName === "originalSize") {
        // 将图片形状的大小设置为图片的原始大小。
        e.shape.width(e.shape.getOriginalWidth());
        e.shape.height(e.shape.getOriginalHeight());
    }
});
var src = "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pjxzdmcgd2lkdGg9IjEwMCIgaGVpZ2h0PSIxMDAiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48Y2lyY2xlIGN4PSI1MCIgY3k9IjUwIiByPSI1MCIgZmlsbD0iYmx1ZSIvPjxwYXRoIGQ9Ik0xMCw1MCBRNDAsMzAgNTAsNTAgVDkwLDUwIiBmaWxsPSJub25lIiBzdHJva2U9Im9yYW5nZSIgc3Ryb2tlLXdpZHRoPSI1Ii8+PC9zdmc+";
var shape = sheet.shapes.addPictureShape("Picture 1", src, 100, 50, 200, 200);

Returns

undefined | number

返回图片的原始宽度,如果没有图片或图片未完成加载,则返回undefined。


height

▸ height(value?): any

获取或设置形状的高度。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.height();
heart.height(n + 50);

Parameters

Name Type Description
value? string | number 形状的高度,可以是数值或公式(以=开头)。

Returns

any

如果未设置值,返回形状的高度。

Inherited from

ShapeBase.height


▸ hyperlink(value?): void | IHyperlink

获取或设置形状的超链接。

example

var shape = sheet.shapes.add("myShape", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 62 * 9, 0, 200, 200);
shape.hyperlink({url: "http://www.spreadjs.com", target: 0, tooltip: 'goes to SpreadJS'});

Parameters

Name Type Description
value? IHyperlink 超链接设置。

Returns

void | IHyperlink

如果未设置值,返回形状当前的超链接设置。

Inherited from

ShapeBase.hyperlink


isLocked

▸ isLocked(value?): any

获取或设置此形状是否被锁定。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isLocked();
heart.isLocked(!state);

Parameters

Name Type Description
value? boolean 指示此形状是否被锁定的值。

Returns

any

如果未设置值,返回此形状是否被锁定。

Inherited from

ShapeBase.isLocked


isSelected

▸ isSelected(value?): any

获取或设置此形状是否被选中。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isSelected();
heart.isSelected(!state);

Parameters

Name Type Description
value? boolean 指示此形状是否被选中的值。

Returns

any

如果未设置值,返回此形状是否被选中。

Inherited from

ShapeBase.isSelected


isVisible

▸ isVisible(value?): any

获取或设置此形状是否可见。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.isVisible();
heart.isVisible(!state);

Parameters

Name Type Description
value? boolean 指示此形状是否可见的值。

Returns

any

如果未设置值,返回此形状是否可见。

Inherited from

ShapeBase.isVisible


name

▸ name(value?): any

获取或设置形状的名称。

example

var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 62 * 9, 0, 200, 200);
var shape2 = sheet.shapes.add("myShape2", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 20, 20, 200, 200);
var shape = sheet.shapes.group([shape1, shape2]);
shape.name("myGroupShape");
var shapeName = shape.name();

Parameters

Name Type Description
value? string 形状的名称。

Returns

any

如果未设置值,返回形状的名称。

Inherited from

ShapeBase.name


pictureFormat

▸ pictureFormat(value?): void | IPictureFormat

获取或设置图片的格式。

example

//此示例为图片形状设置格式。
var shape = sheet.shapes.addPictureShape("Picture 1", "data:image/svg+xml;base64.....", 100, 50, 100, 100);
shape.pictureFormat({ grayscale: true, crop: { left: 0.25, right: 0.25, top: 0.25, bottom: 0.25 }});

Parameters

Name Type Description
value? IPictureFormat 图片的格式。

Returns

void | IPictureFormat

如果未设置值,返回图片当前的格式。


rotate

▸ rotate(value?): number | void

获取或设置图片形状的旋转角度(单位为度)。

example

var shape = sheet.shapes.addPictureShape("Picture 1", "data:image/svg+xml;base64.....", 100, 50, 100, 100);
var n = shape.rotate();
shape.rotate(n + 30);

Parameters

Name Type Description
value? string | number 图片形状的旋转角度(单位为度),可以是数值或公式(以=开头)。

Returns

number | void

如果未设置值,返回图片形状的旋转角度(单位为度)。


setFormula

▸ setFormula(path, formula): void

通过路径设置形状的公式字符串。

example

sheet.name("Sheet1");
sheet.setValue(0, 1, 150);
var shape1 = sheet.shapes.add("myShape1", GC.Spread.Sheets.Shapes.AutoShapeType.rectangle, 100, 100, 200, 200);
shape1.setFormula("x", "=Sheet1!B1");

Parameters

Name Type Description
path string 可以接受公式字符串的路径,可以是以下之一:"x", "y", "width", "height"。
formula string 公式字符串。

Returns

void

Inherited from

ShapeBase.setFormula


showHandle

▸ showHandle(value?): any

获取或设置是否显示形状的控制柄。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var state = heart.showHandle();
heart.showHandle(!state);

Parameters

Name Type Description
value? boolean 是否显示形状控制柄的设置。

Returns

any

如果未设置值,返回是否显示形状控制柄的设置。

Inherited from

ShapeBase.showHandle


src

▸ src(value?): string | void

获取或设置图片的源地址。

example

var dataURL = "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pjxzdmcgd2lkdGg9IjEwMCIgaGVpZ2h0PSIxMDAiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48Y2lyY2xlIGN4PSI1MCIgY3k9IjUwIiByPSI1MCIgZmlsbD0iYmx1ZSIvPjxwYXRoIGQ9Ik0xMCw1MCBRNDAsMzAgNTAsNTAgVDkwLDUwIiBmaWxsPSJub25lIiBzdHJva2U9Im9yYW5nZSIgc3Ryb2tlLXdpZHRoPSI1Ii8+PC9zdmc+";
var shape = sheet.shapes.addPictureShape("Picture 1", dataURL, 100, 50, 200, 200);
// 获取当前图片源地址,src等于dataURL。
var src = shape.src();
// 设置新的图片源地址。
shape.src("data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pjxzdmcgd2lkdGg9IjEwMCIgaGVpZ2h0PSIxMDAiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48Y2lyY2xlIGN4PSI1MCIgY3k9IjUwIiByPSI1MCIgZmlsbD0iYmxhY2siLz48cGF0aCBkPSJNMTAsNTAgUTQwLDMwIDUwLDUwIFQ5MCw1MCIgZmlsbD0ibm9uZSIgc3Ryb2tlPSJvcmFuZ2UiIHN0cm9rZS13aWR0aD0iNSIvPjwvc3ZnPg==");

Parameters

Name Type Description
value? string 图片的源地址。

Returns

string | void

如果未设置值,返回图片当前的源地址。


startColumn

▸ startColumn(value?): any

获取或设置形状位置的起始列索引。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startColumn();
heart.startColumn(n + 2);

Parameters

Name Type Description
value? number 形状位置的起始列索引。

Returns

any

如果未设置值,返回形状位置的起始列索引。

Inherited from

ShapeBase.startColumn


startColumnOffset

▸ startColumnOffset(value?): any

获取或设置相对于形状起始列的偏移量。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startColumnOffset();
heart.startColumnOffset(0);

Parameters

Name Type Description
value? number 相对于形状起始列的偏移量。

Returns

any

如果未设置值,返回相对于形状起始列的偏移量。

Inherited from

ShapeBase.startColumnOffset


startRow

▸ startRow(value?): any

获取或设置形状位置的起始行索引。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startRow();
heart.startRow(n + 2);

Parameters

Name Type Description
value? number 形状位置的起始行索引。

Returns

any

如果未设置值,返回形状位置的起始行索引。

Inherited from

ShapeBase.startRow


startRowOffset

▸ startRowOffset(value?): any

获取或设置相对于形状起始行的偏移量。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.startRowOffset();
heart.startRowOffset(0);

Parameters

Name Type Description
value? number 相对于形状起始行的偏移量。

Returns

any

如果未设置值,返回相对于形状起始行的偏移量。

Inherited from

ShapeBase.startRowOffset


style

▸ style(value?): any

获取或设置图片形状的样式。

example

// 此示例为图片形状设置样式。
var shape = sheet.shapes.addPictureShape("Picture 1", "data:image/svg+xml;base64.....", 100, 50, 100, 100);
var oldStyle = shape.style();
oldStyle.fill.color = "red";
oldStyle.line.color = "green";
oldStyle.line.lineStyle = GC.Spread.Sheets.Shapes.PresetLineDashStyle.dashDot;
oldStyle.line.width = 5;
oldStyle.line.capType = GC.Spread.Sheets.Shapes.LineCapStyle.square;
oldStyle.line.joinType = GC.Spread.Sheets.Shapes.LineJoinStyle.miter;
oldStyle.line.transparency = 0.5;
shape.style(oldStyle);

Parameters

Name Type Description
value? ShapeStyle 图片形状的样式。

Returns

any

如果未设置值,返回图片形状当前的样式。


toImageSrc

▸ toImageSrc(): string

获取形状的Base64字符串类型的图片源。

example

let shapeImageSrc = sheet.shapes.all()[0].toImageSrc();

Returns

string

返回形状的Base64字符串类型的图片源。

Inherited from

ShapeBase.toImageSrc


toImageSrcAsync

▸ toImageSrcAsync(): Promise<string>

获取形状的Base64字符串类型的图片源。

example

let shapeImageSrc = await sheet.shapes.all()[0].toImageSrcAsync();

Returns

Promise<string>

返回形状的Base64字符串类型的图片源。

Inherited from

ShapeBase.toImageSrcAsync


width

▸ width(value?): any

获取或设置形状的宽度。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.width();
heart.width(n + 50);

Parameters

Name Type Description
value? string | number 形状的宽度,可以是数值或公式(以=开头)。

Returns

any

如果未设置值,返回形状的宽度。

Inherited from

ShapeBase.width


x

▸ x(value?): any

获取或设置形状的水平位置。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.x();
heart.x(n + 50);

Parameters

Name Type Description
value? string | number 形状的水平位置,可以是数值或公式(以=开头)。

Returns

any

如果未设置值,返回形状的水平位置。

Inherited from

ShapeBase.x


y

▸ y(value?): any

获取或设置形状的垂直位置。

example

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
var n = heart.y();
heart.y(n + 50);

Parameters

Name Type Description
value? string | number 形状的垂直位置,可以是数值或公式(以=开头)。

Returns

any

如果未设置值,返回形状的垂直位置。

Inherited from

ShapeBase.y