Excel.Shape interface

Представляет объект универсальной фигуры на листе. Фигурой может быть геометрическая фигура, линия, Группа фигур и т. д. Чтобы узнать больше об объектной модели фигур, прочтите Работа с фигурами с помощью API JavaScript для Excel.

Свойства

altTextDescription

Задает текст альтернативного описания для объекта Shape.

altTextTitle

Указывает альтернативный текст заголовка для объекта Shape.

connectionSiteCount

Возвращает количество точек соединения на фигуре.

fill

Возвращает формат заливки фигуры.

geometricShape

Возвращает геометрическую фигуру, связанную с линией. Если тип фигуры отличается от GeometricShape, возникает ошибка.

geometricShapeType

Указывает тип геометрической фигуры для этой геометрической фигуры. Дополнительные сведения см. в статье Excel.GeometricShapeType. Возвращает значение null, если тип фигуры отличается от GeometricShape.

group

Возвращает группу фигур, связанную с фигурой. Если тип фигуры отличается от GroupShape, возникает ошибка.

height

Задает высоту фигуры в пунктах. При задании с отрицательным значением или нулем в качестве входных данных создается исключение недопустимого аргумента.

id

Задает идентификатор фигуры.

image

Возвращает изображение, связанное с фигурой. Если тип фигуры отличается от Image, возникает ошибка.

left

Расстояние в пунктах от левого края фигуры до левого края листа. При задании с отрицательным значением в качестве входных данных создается исключение недопустимого аргумента.

level

Задает уровень указанной фигуры. Например, уровень 0 означает, что фигура не является частью групп; уровень 1 означает, что фигура является частью группы верхнего уровня; уровень 2 означает, что фигура является частью подгруппы верхнего уровня.

line

Возвращает линию, связанную с фигурой. Если тип фигуры отличается от Line, возникает ошибка.

lineFormat

Возвращает формат линии для фигуры.

lockAspectRatio

Указывает, заблокировано ли пропорции данной фигуры.

name

Задает имя фигуры.

parentGroup

Задает родительскую группу этой фигуры.

placement

Представляет способ прикрепления объекта к ячейкам под ним.

rotation

Задает поворот фигуры в градусах.

textFrame

Возвращает объект рамки с текстом для фигуры. Только для чтения.

top

Расстояние в пунктах от верхнего края фигуры до верхнего края листа. При задании с отрицательным значением в качестве входных данных создается исключение недопустимого аргумента.

type

Возвращает тип фигуры. Дополнительные сведения см. в статье Excel.ShapeType.

visible

Указывает, отображается ли фигура.

width

Задает ширину фигуры в пунктах. При задании с отрицательным значением или нулем в качестве входных данных создается исключение недопустимого аргумента.

zOrderPosition

Возвращает положение указанной фигуры по оси Z. Значение 0 представляет нижнее положение по оси.

Методы

copyTo(destinationSheet)

Копирует и вставляет объект Shape. Вставленная фигура копируется в то же расположение пикселя, что и эта фигура.

delete()

Удаляет фигуру с листа.

getAsImage(format)

Преобразует фигуру в изображение и возвращает изображение в виде строки в кодировке base64. Число точек на дюйм: 96. Поддерживаются только форматыExcel.PictureFormat.BMP, Excel.PictureFormat.PNG, Excel.PictureFormat.JPEG, аExcel.PictureFormat.GIF.

incrementLeft(increment)

Перемещает фигуру по горизонтали на указанное число пунктов.

incrementRotation(increment)

Поворачивает фигуру по часовой стрелке относительно оси Z на указанное число градусов. Используйте rotation свойство, чтобы задать абсолютный поворот фигуры.

incrementTop(increment)

Перемещает фигуру по вертикали на указанное число пунктов.

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. context.sync()Перед чтением свойств необходимо вызвать метод.

scaleHeight(scaleFactor, scaleType, scaleFrom)

Масштабирует высоту фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей высоты.

scaleWidth(scaleFactor, scaleType, scaleFrom)

Масштабирует ширину фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей ширины.

setZOrder(position)

Перемещает указанную фигуру вверх или вниз по оси Z в коллекции, что переносит ее вперед или назад относительно других фигур.

Сведения о свойстве

altTextDescription

Задает текст альтернативного описания для объекта Shape.

altTextDescription: string;

Значение свойства

string

altTextTitle

Указывает альтернативный текст заголовка для объекта Shape.

altTextTitle: string;

Значение свойства

string

connectionSiteCount

Возвращает количество точек соединения на фигуре.

readonly connectionSiteCount: number;

Значение свойства

number

fill

Возвращает формат заливки фигуры.

readonly fill: ShapeFill;

Значение свойства

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.smileyFace);
    shape.left = 300;
    shape.top = 100;
    shape.height = 100;
    shape.width = 100;
    shape.fill.foregroundColor = "yellow"
    await context.sync();
}

geometricShape

Возвращает геометрическую фигуру, связанную с линией. Если тип фигуры отличается от GeometricShape, возникает ошибка.

readonly geometricShape: GeometricShape;

Значение свойства

geometricShapeType

Указывает тип геометрической фигуры для этой геометрической фигуры. Дополнительные сведения см. в статье Excel.GeometricShapeType. Возвращает значение null, если тип фигуры отличается от GeometricShape.

geometricShapeType:
            | GeometricShapeType
            | "LineInverse"
            | "Triangle"
            | "RightTriangle"
            | "Rectangle"
            | "Diamond"
            | "Parallelogram"
            | "Trapezoid"
            | "NonIsoscelesTrapezoid"
            | "Pentagon"
            | "Hexagon"
            | "Heptagon"
            | "Octagon"
            | "Decagon"
            | "Dodecagon"
            | "Star4"
            | "Star5"
            | "Star6"
            | "Star7"
            | "Star8"
            | "Star10"
            | "Star12"
            | "Star16"
            | "Star24"
            | "Star32"
            | "RoundRectangle"
            | "Round1Rectangle"
            | "Round2SameRectangle"
            | "Round2DiagonalRectangle"
            | "SnipRoundRectangle"
            | "Snip1Rectangle"
            | "Snip2SameRectangle"
            | "Snip2DiagonalRectangle"
            | "Plaque"
            | "Ellipse"
            | "Teardrop"
            | "HomePlate"
            | "Chevron"
            | "PieWedge"
            | "Pie"
            | "BlockArc"
            | "Donut"
            | "NoSmoking"
            | "RightArrow"
            | "LeftArrow"
            | "UpArrow"
            | "DownArrow"
            | "StripedRightArrow"
            | "NotchedRightArrow"
            | "BentUpArrow"
            | "LeftRightArrow"
            | "UpDownArrow"
            | "LeftUpArrow"
            | "LeftRightUpArrow"
            | "QuadArrow"
            | "LeftArrowCallout"
            | "RightArrowCallout"
            | "UpArrowCallout"
            | "DownArrowCallout"
            | "LeftRightArrowCallout"
            | "UpDownArrowCallout"
            | "QuadArrowCallout"
            | "BentArrow"
            | "UturnArrow"
            | "CircularArrow"
            | "LeftCircularArrow"
            | "LeftRightCircularArrow"
            | "CurvedRightArrow"
            | "CurvedLeftArrow"
            | "CurvedUpArrow"
            | "CurvedDownArrow"
            | "SwooshArrow"
            | "Cube"
            | "Can"
            | "LightningBolt"
            | "Heart"
            | "Sun"
            | "Moon"
            | "SmileyFace"
            | "IrregularSeal1"
            | "IrregularSeal2"
            | "FoldedCorner"
            | "Bevel"
            | "Frame"
            | "HalfFrame"
            | "Corner"
            | "DiagonalStripe"
            | "Chord"
            | "Arc"
            | "LeftBracket"
            | "RightBracket"
            | "LeftBrace"
            | "RightBrace"
            | "BracketPair"
            | "BracePair"
            | "Callout1"
            | "Callout2"
            | "Callout3"
            | "AccentCallout1"
            | "AccentCallout2"
            | "AccentCallout3"
            | "BorderCallout1"
            | "BorderCallout2"
            | "BorderCallout3"
            | "AccentBorderCallout1"
            | "AccentBorderCallout2"
            | "AccentBorderCallout3"
            | "WedgeRectCallout"
            | "WedgeRRectCallout"
            | "WedgeEllipseCallout"
            | "CloudCallout"
            | "Cloud"
            | "Ribbon"
            | "Ribbon2"
            | "EllipseRibbon"
            | "EllipseRibbon2"
            | "LeftRightRibbon"
            | "VerticalScroll"
            | "HorizontalScroll"
            | "Wave"
            | "DoubleWave"
            | "Plus"
            | "FlowChartProcess"
            | "FlowChartDecision"
            | "FlowChartInputOutput"
            | "FlowChartPredefinedProcess"
            | "FlowChartInternalStorage"
            | "FlowChartDocument"
            | "FlowChartMultidocument"
            | "FlowChartTerminator"
            | "FlowChartPreparation"
            | "FlowChartManualInput"
            | "FlowChartManualOperation"
            | "FlowChartConnector"
            | "FlowChartPunchedCard"
            | "FlowChartPunchedTape"
            | "FlowChartSummingJunction"
            | "FlowChartOr"
            | "FlowChartCollate"
            | "FlowChartSort"
            | "FlowChartExtract"
            | "FlowChartMerge"
            | "FlowChartOfflineStorage"
            | "FlowChartOnlineStorage"
            | "FlowChartMagneticTape"
            | "FlowChartMagneticDisk"
            | "FlowChartMagneticDrum"
            | "FlowChartDisplay"
            | "FlowChartDelay"
            | "FlowChartAlternateProcess"
            | "FlowChartOffpageConnector"
            | "ActionButtonBlank"
            | "ActionButtonHome"
            | "ActionButtonHelp"
            | "ActionButtonInformation"
            | "ActionButtonForwardNext"
            | "ActionButtonBackPrevious"
            | "ActionButtonEnd"
            | "ActionButtonBeginning"
            | "ActionButtonReturn"
            | "ActionButtonDocument"
            | "ActionButtonSound"
            | "ActionButtonMovie"
            | "Gear6"
            | "Gear9"
            | "Funnel"
            | "MathPlus"
            | "MathMinus"
            | "MathMultiply"
            | "MathDivide"
            | "MathEqual"
            | "MathNotEqual"
            | "CornerTabs"
            | "SquareTabs"
            | "PlaqueTabs"
            | "ChartX"
            | "ChartStar"
            | "ChartPlus";

Значение свойства

| GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"

group

Возвращает группу фигур, связанную с фигурой. Если тип фигуры отличается от GroupShape, возникает ошибка.

readonly group: ShapeGroup;

Значение свойства

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");

    let shapeGroup = sheet.shapes.getItem("Group").group;
    shapeGroup.ungroup();
    console.log("Shapes ungrouped");

    await context.sync();
}

height

Задает высоту фигуры в пунктах. При задании с отрицательным значением или нулем в качестве входных данных создается исключение недопустимого аргумента.

height: number;

Значение свойства

number

id

Задает идентификатор фигуры.

readonly id: string;

Значение свойства

string

image

Возвращает изображение, связанное с фигурой. Если тип фигуры отличается от Image, возникает ошибка.

readonly image: Image;

Значение свойства

left

Расстояние в пунктах от левого края фигуры до левого края листа. При задании с отрицательным значением в качестве входных данных создается исключение недопустимого аргумента.

left: number;

Значение свойства

number

level

Задает уровень указанной фигуры. Например, уровень 0 означает, что фигура не является частью групп; уровень 1 означает, что фигура является частью группы верхнего уровня; уровень 2 означает, что фигура является частью подгруппы верхнего уровня.

readonly level: number;

Значение свойства

number

line

Возвращает линию, связанную с фигурой. Если тип фигуры отличается от Line, возникает ошибка.

readonly line: Line;

Значение свойства

Примеры

async function main(context: Excel.RequestContext) {
    let shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    let line = shapes.getItem("StraightLine").line;
    line.beginArrowheadLength = Excel.ArrowheadLength.long;
    line.beginArrowheadWidth = Excel.ArrowheadWidth.wide;
    line.beginArrowheadStyle = Excel.ArrowheadStyle.oval;

    line.endArrowheadLength = Excel.ArrowheadLength.long;
    line.endArrowheadWidth = Excel.ArrowheadWidth.wide;
    line.endArrowheadStyle = Excel.ArrowheadStyle.triangle;

    await context.sync();
}

lineFormat

Возвращает формат линии для фигуры.

readonly lineFormat: ShapeLineFormat;

Значение свойства

lockAspectRatio

Указывает, заблокировано ли пропорции данной фигуры.

lockAspectRatio: boolean;

Значение свойства

boolean

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Octagon")
    shape.lockAspectRatio = true;
    shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize);
    await context.sync();
}

name

Задает имя фигуры.

name: string;

Значение свойства

string

parentGroup

Задает родительскую группу этой фигуры.

readonly parentGroup: Shape;

Значение свойства

placement

Представляет способ прикрепления объекта к ячейкам под ним.

placement: Placement | "TwoCell" | "OneCell" | "Absolute";

Значение свойства

Placement | "TwoCell" | "OneCell" | "Absolute"

rotation

Задает поворот фигуры в градусах.

rotation: number;

Значение свойства

number

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.triangle);
    shape.left = 100;
    shape.top = 300;
    shape.height = 150;
    shape.width = 200;
    shape.rotation = 45;
    shape.fill.clear();
    await context.sync();
}

textFrame

Возвращает объект рамки с текстом для фигуры. Только для чтения.

readonly textFrame: TextFrame;

Значение свойства

top

Расстояние в пунктах от верхнего края фигуры до верхнего края листа. При задании с отрицательным значением в качестве входных данных создается исключение недопустимого аргумента.

top: number;

Значение свойства

number

type

Возвращает тип фигуры. Дополнительные сведения см. в статье Excel.ShapeType.

readonly type:
            | ShapeType
            | "Unsupported"
            | "Image"
            | "GeometricShape"
            | "Group"
            | "Line";

Значение свойства

| ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line"

visible

Указывает, отображается ли фигура.

visible: boolean;

Значение свойства

boolean

width

Задает ширину фигуры в пунктах. При задании с отрицательным значением или нулем в качестве входных данных создается исключение недопустимого аргумента.

width: number;

Значение свойства

number

zOrderPosition

Возвращает положение указанной фигуры по оси Z. Значение 0 представляет нижнее положение по оси.

readonly zOrderPosition: number;

Значение свойства

number

Сведения о методе

copyTo(destinationSheet)

Копирует и вставляет объект Shape. Вставленная фигура копируется в то же расположение пикселя, что и эта фигура.

copyTo(destinationSheet?: Worksheet | string): Shape;

Параметры

destinationSheet
Worksheet | string

Лист, на который будет вставлен объект фигуры. Значение по умолчанию — лист скопированной фигуры.

Возвращаемое значение

delete()

Удаляет фигуру с листа.

delete(): void;

Возвращаемое значение

void

Примеры

async function main(context: Excel.RequestContext) {
    context.workbook.worksheets.getItemOrNullObject("Shapes").delete();
    let sheet = context.workbook.worksheets.add("Shapes");

    let shapes = sheet.shapes;

    // load all the shapes in the collection without loading their properties
    shapes.load("items/$none");
    await context.sync();

    shapes.items.forEach((shape) => shape.delete());
    await context.sync();
}

getAsImage(format)

Преобразует фигуру в изображение и возвращает изображение в виде строки в кодировке base64. Число точек на дюйм: 96. Поддерживаются только форматыExcel.PictureFormat.BMP, Excel.PictureFormat.PNG, Excel.PictureFormat.JPEG, аExcel.PictureFormat.GIF.

getAsImage(
            format:
                | PictureFormat
                | "Unknown"
                | "Bmp"
                | "Jpeg"
                | "Gif"
                | "Png"
                | "Svg"
        ): ClientResult<string>;

Параметры

format
| PictureFormat | "Unknown" | "Bmp" | "Jpeg" | "Gif" | "Png" | "Svg"

Задает формат изображения.

Возвращаемое значение

ClientResult<string>

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Image");
    let result = shape.getAsImage(Excel.PictureFormat.png);
    await context.sync();

    let imageString = result.value;
    // Your add-in would save this string as a .png file.
    console.log("The image's base64-encoded string: " + imageString);
}

incrementLeft(increment)

Перемещает фигуру по горизонтали на указанное число пунктов.

incrementLeft(increment: number): void;

Параметры

increment
number

Приращение фигуры будет горизонтально перемещено в пункт точки. Положительное значение перемещает фигуру вправо, а отрицательное значение — влево. Если лист ориентирован справа налево, это значение изменяется на противоположный: положительные значения перемещают фигуру влево, а отрицательные — вправо.

Возвращаемое значение

void

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Square")
    shape.incrementLeft(-25);
    await context.sync();
}

incrementRotation(increment)

Поворачивает фигуру по часовой стрелке относительно оси Z на указанное число градусов. Используйте rotation свойство, чтобы задать абсолютный поворот фигуры.

incrementRotation(increment: number): void;

Параметры

increment
number

Количество градусов, на котором будет вращаться фигура. Положительное значение поворачивает фигуру по часовой стрелке; отрицательное значение поворачивает его против часовой стрелки.

Возвращаемое значение

void

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Image");
    shape.incrementRotation(180);
    await context.sync();
}

incrementTop(increment)

Перемещает фигуру по вертикали на указанное число пунктов.

incrementTop(increment: number): void;

Параметры

increment
number

Увеличение (в пунктах) фигура будет перемещена по вертикали. в пунктах. Положительное значение перемещает фигуру вниз и отрицательное значение перемещается вверх.

Возвращаемое значение

void

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Pentagon")
    shape.incrementTop(25);
    await context.sync();
}

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. context.sync()Перед чтением свойств необходимо вызвать метод.

load(propertyNames?: string | string[]): void;

Параметры

propertyNames
string | string[]

Строка, разделенная запятыми, или массив строк, указывающий свойства для загрузки.

Возвращаемое значение

void

scaleHeight(scaleFactor, scaleType, scaleFrom)

Масштабирует высоту фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей высоты.

scaleHeight(
            scaleFactor: number,
            scaleType: ShapeScaleType | "CurrentSize" | "OriginalSize",
            scaleFrom?:
                | ShapeScaleFrom
                | "ScaleFromTopLeft"
                | "ScaleFromMiddle"
                | "ScaleFromBottomRight"
        ): void;

Параметры

scaleFactor
number

Задает отношение высоты фигуры после изменения ее размера и текущей или исходной высоты.

scaleType
ShapeScaleType | "CurrentSize" | "OriginalSize"

Указывает, масштабируется ли фигура относительно исходного или текущего размера. Параметр масштабирование исходного размера работает только для изображений.

scaleFrom
| ShapeScaleFrom | "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

Необязательный параметр. Указывает, какая часть фигуры сохраняет свое положение при масштабировании фигуры. Если этот параметр опущен, то он представляет свое положение в левом верхнем углу фигуры.

Возвращаемое значение

void

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Octagon")
    shape.lockAspectRatio = true;
    shape.scaleHeight(1.25, Excel.ShapeScaleType.currentSize);
    await context.sync();
}

scaleWidth(scaleFactor, scaleType, scaleFrom)

Масштабирует ширину фигуры с применением указанного коэффициента. Для изображений можно указать изменение масштаба фигуры относительно исходного или текущего размера. Фигуры, не являющиеся изображениями, всегда масштабируются относительно их текущей ширины.

scaleWidth(
            scaleFactor: number,
            scaleType: ShapeScaleType | "CurrentSize" | "OriginalSize",
            scaleFrom?:
                | ShapeScaleFrom
                | "ScaleFromTopLeft"
                | "ScaleFromMiddle"
                | "ScaleFromBottomRight"
        ): void;

Параметры

scaleFactor
number

Задает отношение ширины фигуры после изменения ее размера и текущей или исходной ширины.

scaleType
ShapeScaleType | "CurrentSize" | "OriginalSize"

Указывает, масштабируется ли фигура относительно исходного или текущего размера. Параметр масштабирование исходного размера работает только для изображений.

scaleFrom
| ShapeScaleFrom | "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"

Необязательный параметр. Указывает, какая часть фигуры сохраняет свое положение при масштабировании фигуры. Если этот параметр опущен, то он представляет свое положение в левом верхнем углу фигуры.

Возвращаемое значение

void

setZOrder(position)

Перемещает указанную фигуру вверх или вниз по оси Z в коллекции, что переносит ее вперед или назад относительно других фигур.

setZOrder(
            position:
                | ShapeZOrder
                | "BringToFront"
                | "BringForward"
                | "SendToBack"
                | "SendBackward"
        ): void;

Параметры

position
| ShapeZOrder | "BringToFront" | "BringForward" | "SendToBack" | "SendBackward"

Место перемещения фигуры в стеке z по отношению к другим фигурам. Дополнительные сведения см. в статье Excel. Шапезордер.

Возвращаемое значение

void

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.getItem("Octagon")
    shape.setZOrder(Excel.ShapeZOrder.sendBackward);
    await context.sync();
}