[]
        
(Showing Draft Content)

GC.Spread.Sheets.Shapes.PictureShape

クラス: PictureShape

Sheets.Shapes.PictureShape

Hierarchy

Table of contents

コンストラクタ

メソッド

コンストラクタ

constructor

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

パラメータ

名前 説明
worksheet Worksheet シェイプのホストワークシート。
name string ピクチャシェイプの名前。名前が空の文字列の場合、一意の名前が生成します。
src string ピクチャのソース。
left? number -
top? number -
width? number -
height? number -

オーバーライド

ShapeBase.constructor

メソッド

allowMove

allowMove(value?): any

シェイプの移動を無効にするかどうかを取得または設定します。

実例

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

パラメータ

名前 説明
value? boolean シェイプの移動を無効にするかどうかの設定。

戻り値

any

値が設定されていない場合、シェイプの移動を無効にするかどうかの設定を返します。

継承元

ShapeBase.allowMove


allowResize

allowResize(value?): any

シェイプのサイズ変更モードを取得または設定します。

実例

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

パラメータ

名前 説明
value? boolean | ResizeMode シェイプのサイズ変更を無効にするかどうかの設定。

戻り値

any

値が設定されていない場合、シェイプのサイズ変更を無効にするかどうかの設定を返します。

継承元

ShapeBase.allowResize


allowRotate

allowRotate(value?): any

シェイプの回転を無効にするかどうかを取得または設定します。

実例

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

パラメータ

名前 説明
value? boolean シェイプの回転を無効にするかどうかの設定。

戻り値

any

値が設定されていない場合、シェイプの回転を無効にするかどうかの設定を返します。

継承元

ShapeBase.allowRotate


alt

alt(value?): any

スクリーンリーダーのシェイプの代替テキストを取得または設定します。

実例

var heart = sheet.shapes.add("Shape1", GC.Spread.Sheets.Shapes.AutoShapeType.heart, 100, 60, 200, 160);
heart.alt("A heart shape");

パラメータ

名前
value? string

戻り値

any

シェイプの代替テキスト。

継承元

ShapeBase.alt


canPrint

canPrint(value?): any

このシェイプが印刷可能かどうかを取得または設定します。

実例

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(); // ハートシェイプが印刷されません。

パラメータ

名前
value? boolean

戻り値

any

値が設定されていない場合、このシェイプが印刷可能かどうかを返します。

継承元

ShapeBase.canPrint


dynamicMove

dynamicMove(value?): any

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

実例

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

パラメータ

名前 説明
value? boolean 行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにシェイプが移動するかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプが動的に移動するかどうかを返します。

継承元

ShapeBase.dynamicMove


dynamicSize

dynamicSize(value?): any

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

実例

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

パラメータ

名前 説明
value? boolean 行または列を表示/非表示にするとき、サイズ変更するとき、または移動するときにシェイプのサイズが変更されるかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプのサイズが動的に変更されるかどうかを返します。

継承元

ShapeBase.dynamicSize


endColumn

endColumn(value?): any

シェイプの位置の終了列インデックスを取得または設定します。

実例

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

パラメータ

名前 説明
value? number シェイプの位置の終了列インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の終了列インデックスを返します。

継承元

ShapeBase.endColumn


endColumnOffset

endColumnOffset(value?): any

シェイプの終了列に対するオフセットを取得または設定します。

実例

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

パラメータ

名前 説明
value? number シェイプの終了列に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの終了列に対するオフセットを返します。

継承元

ShapeBase.endColumnOffset


endRow

endRow(value?): any

シェイプの位置の終了行インデックスを取得または設定します。

実例

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

パラメータ

名前 説明
value? number シェイプの位置の終了行インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の終了行インデックスを返します。

継承元

ShapeBase.endRow


endRowOffset

endRowOffset(value?): any

シェイプの終了行に対するオフセットを取得または設定します。

実例

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

パラメータ

名前 説明
value? number シェイプの終了行に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの終了行に対するオフセットを返します。

継承元

ShapeBase.endRowOffset


geometryType

geometryType(value?): void | AutoShapeType

ピクチャのジオメトリタイプを取得または設定します。

実例

// 次のサンプルコードは、ピクチャのジオメトリタイプを設定します。
var shape = sheet.shapes.addPictureShape("Picture 1", "data:image/svg+xml;base64.....", 100, 50, 100, 100);
shape.geometryType(GC.Spread.Sheets.Shapes.AutoShapeType.oval);

パラメータ

名前
value? AutoShapeType

戻り値

void | AutoShapeType

値が設定されていない場合は、ピクチャの現在のジオメトリタイプを返します。


getFormula

getFormula(path): string

パスによってシェイプから数式の文字列を取得します。

実例

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"

パラメータ

名前 説明
path string 数式の文字列を受け入れることができるパス。 「x」、「y」、「width」、「height」のいずれかに設定できます。

戻り値

string

パスによってシェイプから数式の文字列を返します。

継承元

ShapeBase.getFormula


getOriginalHeight

getOriginalHeight(): undefined | number

画像の元の高さを取得します。

実例

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

戻り値

undefined | number

画像の元の高さを返します。画像がない場合、または画像の読み込みが完了していない場合は、undefiend が返されます。


getOriginalWidth

getOriginalWidth(): undefined | number

画像の元の幅を取得します。

実例

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

戻り値

undefined | number

画像の元の幅を返します。画像がない場合、または画像の読み込みが完了していない場合は、undefiend が返されます。


height

height(value?): any

シェイプの高さを取得または設定します。

実例

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

パラメータ

名前 説明
value? string | number 数値によって指定されたシェイプの高さ、または数値を取得できる数式(=で始まる)。

戻り値

any

値が設定されていない場合、シェイプの高さを返します。

継承元

ShapeBase.height


hyperlink(value?): void | IHyperlink

シェイプのハイパーリンクを取得または設定します。

実例

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

パラメータ

名前
value? IHyperlink

戻り値

void | IHyperlink

値が設定されていない場合は、シェイプの現在のハイパーリンク設定を返します。

継承元

ShapeBase.hyperlink


isLocked

isLocked(value?): any

このシェイプがロックされているかどうかを取得または設定します。

実例

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

パラメータ

名前 説明
value? boolean このシェイプがロックされているかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプがロックされているかどうかを返します。

継承元

ShapeBase.isLocked


isSelected

isSelected(value?): any

このシェイプが選択されているかどうかを取得または設定します。

実例

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

パラメータ

名前 説明
value? boolean このシェイプが選択されているかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプが選択されているかどうかを返します。

継承元

ShapeBase.isSelected


isVisible

isVisible(value?): any

このシェイプが表示されるかどうかを取得または設定します。

実例

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

パラメータ

名前 説明
value? boolean このシェイプが表示されるかどうかを示す値。

戻り値

any

値が設定されていない場合、このシェイプが表示されるかどうかを返します。

継承元

ShapeBase.isVisible


name

name(value?): any

シェイプの名前を取得または設定します。

実例

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

パラメータ

名前 説明
value? string シェイプの名前。

戻り値

any

値が設定されていない場合、シェイプの名前を返します。

継承元

ShapeBase.name


pictureFormat

pictureFormat(value?): void | IPictureFormat

ピクチャの形式を取得または設定します。

実例

// 次のサンプルコードは、ピクチャの形式を設定します。
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 }});

パラメータ

名前
value? IPictureFormat

戻り値

void | IPictureFormat

値が設定されていない場合は、ピクチャの現在の形式を返します。


rotate

rotate(value?): number | void

シェイプの回転角度(度単位)を取得または設定します。

実例

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

パラメータ

名前 説明
value? string | number 数値によって指定されたシェイプの回転角度(度単位)、または数値を取得できる数式(=で始まる)。

戻り値

number | void

値が設定されていない場合、シェイプの回転角度(度単位)を返します。


setFormula

setFormula(path, formula): void

パスによってシェイプに数式の文字列を設定します。

実例

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

パラメータ

名前 説明
path string 数式の文字列を受け入れることができるパス。 「x」、「y」、「width」、「height」のいずれかに設定できます。
formula string 数式文字列。

戻り値

void

継承元

ShapeBase.setFormula


showHandle

showHandle(value?): any

シェイプのハンドルを表示するかどうかを取得または設定します。

実例

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

パラメータ

名前 説明
value? boolean シェイプのハンドルを表示するかどうかの設定。

戻り値

any

値が設定されていない場合、シェイプのハンドルを表示するかどうかの設定を返します。

継承元

ShapeBase.showHandle


src

src(value?): string | void

ピクチャのソースを取得または設定します。

実例

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

パラメータ

名前
value? string

戻り値

string | void

値が設定されていない場合は、ピクチャの現在のソースを返します。


startColumn

startColumn(value?): any

シェイプの位置の開始列インデックスを取得または設定します。

実例

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

パラメータ

名前 説明
value? number シェイプの位置の開始列インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の開始列インデックスを返します。

継承元

ShapeBase.startColumn


startColumnOffset

startColumnOffset(value?): any

シェイプの開始列に対するオフセットを取得または設定します。

実例

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

パラメータ

名前 説明
value? number シェイプの開始列に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの開始列に対するオフセットを返します。

継承元

ShapeBase.startColumnOffset


startRow

startRow(value?): any

シェイプの位置の開始行インデックスを取得または設定します。

実例

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

パラメータ

名前 説明
value? number シェイプの位置の開始行インデックス。

戻り値

any

値が設定されていない場合、シェイプの位置の開始行インデックスを返します。

継承元

ShapeBase.startRow


startRowOffset

startRowOffset(value?): any

シェイプの開始行に対するオフセットを取得または設定します。

実例

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

パラメータ

名前 説明
value? number シェイプの開始行に対するオフセット。

戻り値

any

値が設定されていない場合、シェイプの開始行に対するオフセットを返します。

継承元

ShapeBase.startRowOffset


style

style(value?): any

ピクチャのスタイルを取得または設定します。

実例

// 次のサンプルコードは、シェイプのスタイルを設定します。
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);

パラメータ

名前 説明
value? ShapeStyle シェイプのスタイル。

戻り値

any

値が設定されていない場合、シェイプの現在のスタイルを返します。


width

width(value?): any

シェイプの幅を取得または設定します。

実例

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

パラメータ

名前 説明
value? string | number 数値によって指定されたシェイプの幅、または数値を取得できる数式(=で始まる)。

戻り値

any

値が設定されていない場合、シェイプの幅を返します。

継承元

ShapeBase.width


x

x(value?): any

シェイプの水平位置を取得または設定します。

実例

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

パラメータ

名前 説明
value? string | number 数値によって指定されたシェイプの水平位置、または数値を取得できる数式(=で始まる)。

戻り値

any

値が設定されていない場合、シェイプの水平位置を返します。

継承元

ShapeBase.x


y

y(value?): any

シェイプの垂直位置を取得または設定します。

実例

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

パラメータ

名前 説明
value? string | number 数値によって指定されたシェイプの垂直位置、または数値を取得できる数式(=で始まる)。

戻り値

any

値が設定されていない場合、シェイプの垂直位置を返します。

継承元

ShapeBase.y