ExcelScript.Shape interface

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

Методы

copyTo(destinationSheet)

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

delete()

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

getAltTextDescription()

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

getAltTextTitle()

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

getAsImage(format)

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

getConnectionSiteCount()

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

getFill()

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

getGeometricShape()

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

getGeometricShapeType()

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

getGroup()

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

getHeight()

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

getId()

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

getImage()

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

getLeft()

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

getLevel()

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

getLine()

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

getLineFormat()

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

getLockAspectRatio()

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

getName()

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

getParentGroup()

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

getPlacement()

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

getRotation()

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

getTextFrame()

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

getTop()

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

getType()

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

getVisible()

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

getWidth()

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

getZOrderPosition()

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

incrementLeft(increment)

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

incrementRotation(increment)

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

incrementTop(increment)

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

scaleHeight(scaleFactor, scaleType, scaleFrom)

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

scaleWidth(scaleFactor, scaleType, scaleFrom)

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

setAltTextDescription(altTextDescription)

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

setAltTextTitle(altTextTitle)

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

setGeometricShapeType(geometricShapeType)

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

setHeight(height)

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

setLeft(left)

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

setLockAspectRatio(lockAspectRatio)

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

setName(name)

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

setPlacement(placement)

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

setRotation(rotation)

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

setTop(top)

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

setVisible(visible)

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

setWidth(width)

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

setZOrder(position)

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

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

copyTo(destinationSheet)

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

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

Параметры

destinationSheet
Worksheet | string

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

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

delete()

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

delete(): void;

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

void

getAltTextDescription()

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

getAltTextDescription(): string;

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

string

getAltTextTitle()

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

getAltTextTitle(): string;

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

string

getAsImage(format)

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

getAsImage(format: PictureFormat): string;

Параметры

format
PictureFormat

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

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

string

getConnectionSiteCount()

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

getConnectionSiteCount(): number;

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

number

getFill()

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

getFill(): ShapeFill;

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

getGeometricShape()

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

getGeometricShape(): GeometricShape;

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

getGeometricShapeType()

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

getGeometricShapeType(): GeometricShapeType;

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

getGroup()

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

getGroup(): ShapeGroup;

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

getHeight()

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

getHeight(): number;

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

number

getId()

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

getId(): string;

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

string

getImage()

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

getImage(): Image;

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

getLeft()

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

getLeft(): number;

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

number

getLevel()

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

getLevel(): number;

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

number

getLine()

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

getLine(): Line;

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

getLineFormat()

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

getLineFormat(): ShapeLineFormat;

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

getLockAspectRatio()

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

getLockAspectRatio(): boolean;

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

boolean

getName()

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

getName(): string;

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

string

getParentGroup()

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

getParentGroup(): Shape;

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

getPlacement()

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

getPlacement(): Placement;

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

getRotation()

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

getRotation(): number;

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

number

getTextFrame()

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

getTextFrame(): TextFrame;

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

getTop()

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

getTop(): number;

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

number

getType()

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

getType(): ShapeType;

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

getVisible()

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

getVisible(): boolean;

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

boolean

getWidth()

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

getWidth(): number;

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

number

getZOrderPosition()

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

getZOrderPosition(): number;

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

number

incrementLeft(increment)

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

incrementLeft(increment: number): void;

Параметры

increment
number

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

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

void

incrementRotation(increment)

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

incrementRotation(increment: number): void;

Параметры

increment
number

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

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

void

incrementTop(increment)

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

incrementTop(increment: number): void;

Параметры

increment
number

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

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

void

scaleHeight(scaleFactor, scaleType, scaleFrom)

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

scaleHeight(
            scaleFactor: number,
            scaleType: ShapeScaleType,
            scaleFrom?: ShapeScaleFrom
        ): void;

Параметры

scaleFactor
number

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

scaleType
ShapeScaleType

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

scaleFrom
ShapeScaleFrom

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

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

void

scaleWidth(scaleFactor, scaleType, scaleFrom)

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

scaleWidth(
            scaleFactor: number,
            scaleType: ShapeScaleType,
            scaleFrom?: ShapeScaleFrom
        ): void;

Параметры

scaleFactor
number

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

scaleType
ShapeScaleType

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

scaleFrom
ShapeScaleFrom

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

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

void

setAltTextDescription(altTextDescription)

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

setAltTextDescription(altTextDescription: string): void;

Параметры

altTextDescription
string

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

void

setAltTextTitle(altTextTitle)

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

setAltTextTitle(altTextTitle: string): void;

Параметры

altTextTitle
string

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

void

setGeometricShapeType(geometricShapeType)

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

setGeometricShapeType(geometricShapeType: GeometricShapeType): void;

Параметры

geometricShapeType
GeometricShapeType

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

void

setHeight(height)

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

setHeight(height: number): void;

Параметры

height
number

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

void

setLeft(left)

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

setLeft(left: number): void;

Параметры

left
number

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

void

setLockAspectRatio(lockAspectRatio)

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

setLockAspectRatio(lockAspectRatio: boolean): void;

Параметры

lockAspectRatio
boolean

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

void

setName(name)

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

setName(name: string): void;

Параметры

name
string

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

void

setPlacement(placement)

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

setPlacement(placement: Placement): void;

Параметры

placement
Placement

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

void

setRotation(rotation)

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

setRotation(rotation: number): void;

Параметры

rotation
number

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

void

setTop(top)

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

setTop(top: number): void;

Параметры

top
number

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

void

setVisible(visible)

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

setVisible(visible: boolean): void;

Параметры

visible
boolean

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

void

setWidth(width)

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

setWidth(width: number): void;

Параметры

width
number

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

void

setZOrder(position)

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

setZOrder(position: ShapeZOrder): void;

Параметры

position
ShapeZOrder

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

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

void