Excel.ShapeCollection interface

Представляет коллекцию всех фигур в рабочем листе.

Методы

_GetItem(shapeId)

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

addGeometricShape(geometricShapeType)

Добавляет геометрическую фигуру на лист. Возвращает объект Shape, представляющий новую фигуру.

addGroup(values)

Группирует подмножество фигур на листе этой коллекции. Возвращает объект Shape, представляющий новую группу фигур.

addImage(base64ImageString)

Создает изображение из строки в кодировке base64 и добавляет его на лист. Возвращает объект Shape, представляющий новое изображение.

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Добавляет линию на лист. Возвращает объект Shape, представляющий новую линию.

addTextBox(text)

Добавляет текстовое поле на лист с указанным текстом в качестве содержимого. Возвращает объект Shape, представляющий новое текстовое поле.

getCount()

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

getItem(key)

Получает фигуру по имени или идентификатору.

getItemAt(index)

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

load(propertyNames)

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

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

_GetItem(shapeId)

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

_GetItem(shapeId: string): Shape;

Параметры

shapeId
string

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

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

addGeometricShape(geometricShapeType)

Добавляет геометрическую фигуру на лист. Возвращает объект Shape, представляющий новую фигуру.

addGeometricShape(
            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"
        ): Shape;

Параметры

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"

Представляет тип геометрической фигуры. Дополнительные сведения см. в статье Excel.GeometricShapeType.

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

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let shape = sheet.shapes.addGeometricShape(Excel.GeometricShapeType.hexagon);
    shape.left = 5;
    shape.top = 5;
    shape.height = 175;
    shape.width = 200;
    await context.sync();
}

addGroup(values)

Группирует подмножество фигур на листе этой коллекции. Возвращает объект Shape, представляющий новую группу фигур.

addGroup(values: Array<string | Shape>): Shape;

Параметры

values
Array<string | Shape>

Массив ИДЕНТИФИКАТОРов фигуры или объектов Shape.

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

Примеры

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Shapes");
    let square = sheet.shapes.getItem("Square");
    let pentagon = sheet.shapes.getItem("Pentagon");
    let octagon = sheet.shapes.getItem("Octagon");

    let shapeGroup = sheet.shapes.addGroup([square, pentagon, octagon]);
    shapeGroup.name = "Group";
    console.log("Shapes grouped");

    await context.sync();
}

addImage(base64ImageString)

Создает изображение из строки в кодировке base64 и добавляет его на лист. Возвращает объект Shape, представляющий новое изображение.

addImage(base64ImageString: string): Shape;

Параметры

base64ImageString
string

Строка в кодировке Base64, представляющая изображение в формате JPEG или PNG.

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

Примеры

let myFile = <HTMLInputElement>document.getElementById("selectedFile");
let reader = new FileReader();

reader.onload = (event) => {
    Excel.run((context) => {
        let startIndex = reader.result.toString().indexOf("base64,");
        let mybase64 = reader.result.toString().substr(startIndex + 7);
        let sheet = context.workbook.worksheets.getItem("Shapes");
        let image = sheet.shapes.addImage(mybase64);
        image.name = "Image";
        return context.sync();
    });
};

// Read in the image file as a data URL.
reader.readAsDataURL(myFile.files[0]);

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Добавляет линию на лист. Возвращает объект Shape, представляющий новую линию.

addLine(
            startLeft: number,
            startTop: number,
            endLeft: number,
            endTop: number,
            connectorType?: ConnectorType | "Straight" | "Elbow" | "Curve"
        ): Shape;

Параметры

startLeft
number

Расстояние от начала линии до левого края листа (в пунктах).

startTop
number

Расстояние (в пунктах) от начала линии до верхней границы листа.

endLeft
number

Расстояние в пунктах от конца строки до левого края листа.

endTop
number

Расстояние в пунктах от конца линии до верхней границы листа.

connectorType
ConnectorType | "Straight" | "Elbow" | "Curve"

Представляет тип соединителя. Дополнительные сведения см. в статье Excel. Коннектортипе.

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

Примеры

async function main(context: Excel.RequestContext) {
    let shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    let line = shapes.addLine(200, 50, 300, 150, Excel.ConnectorType.straight);
    line.name = "StraightLine";
    await context.sync();
}

addTextBox(text)

Добавляет текстовое поле на лист с указанным текстом в качестве содержимого. Возвращает объект Shape, представляющий новое текстовое поле.

addTextBox(text?: string): Shape;

Параметры

text
string

Представляет текст, который будет отображаться в созданном текстовом поле.

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

Примеры

async function main(context: Excel.RequestContext) {
    let shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    let textbox = shapes.addTextBox("A box with text");
    textbox.left = 100;
    textbox.top = 100;
    textbox.height = 20;
    textbox.width = 175;
    textbox.name = "Textbox";
    await context.sync();
}

getCount()

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

getCount(): ClientResult<number>;

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

ClientResult<number>

getItem(key)

Получает фигуру по имени или идентификатору.

getItem(key: string): Shape;

Параметры

key
string

Имя или Идентификатор извлекаемой фигуры.

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

getItemAt(index)

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

getItemAt(index: number): Shape;

Параметры

index
number

Отсчитываемый от нуля индекс извлекаемой фигуры.

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

load(propertyNames)

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

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

Параметры

propertyNames
string | string[]

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

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

void