Visio.ShapeView class

Представляет класс ShapeView.

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
highlight	Представляет выделение фигуры.

Методы

addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)	Добавляет слой на фигуру.
addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)	Добавляет слой на фигуру.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
removeOverlay(OverlayId)	Удаляет заданный слой или все слои фигуры.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
setText(Text)	API SetText предназначен для обновления текста внутри фигуры Visio во время выполнения. Обновленный текст сохраняет существующие свойства форматирования текста фигуры.
showOverlay(overlayId, show)	Показывает определенное наложение на фигуре.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод объекта, который ему передается.) В то время как исходный объект Visio.ShapeView является объектом API, метод `toJSON` возвращает простой объект JavaScript (типизированный как `Visio.Interfaces.ShapeViewData`), содержащий поверхностные копии любых загруженных дочерних свойств исходного объекта.

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

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

Visio.RequestContext

highlight

Представляет выделение фигуры.

highlight: Visio.Highlight;

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

Visio.Highlight

Примеры

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    shape.view.highlight = { color: "#E7E7E7", width: 100 };
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)

Добавляет слой на фигуру.

addOverlay(OverlayType: Visio.OverlayType, Content: string, OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment, OverlayVerticalAlignment: Visio.OverlayVerticalAlignment, Width: number, Height: number): OfficeExtension.ClientResult<number>;

Параметры

OverlayType: Visio.OverlayType

Тип наложения. Может принимать значение "Text", 'Image' или 'Html'.

Content: string

Содержимое слоя.

OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment

Горизонтальное выравнивание наложения. Может иметь значение "Слева", "По центру" или "Справа".

OverlayVerticalAlignment: Visio.OverlayVerticalAlignment

Вертикальное выравнивание наложения. Может быть 'Top', 'Middle', 'Bottom'.

Width: number

Ширина слоя.

Height: number

Высота слоя.

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

OfficeExtension.ClientResult<number>

Примеры

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    const overlayId = shape.view.addOverlay("Image", "Visio Online", "Center", "Middle", 50, 50);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)

Добавляет слой на фигуру.

addOverlay(OverlayType: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignment: "Left" | "Center" | "Right", OverlayVerticalAlignment: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult<number>;

Параметры

OverlayType: "Text" | "Image" | "Html"

Тип наложения. Может принимать значение "Text", 'Image' или 'Html'.

Content: string

Содержимое слоя.

OverlayHorizontalAlignment: "Left" | "Center" | "Right"

Горизонтальное выравнивание наложения. Может иметь значение "Слева", "По центру" или "Справа".

OverlayVerticalAlignment: "Top" | "Middle" | "Bottom"

Вертикальное выравнивание наложения. Может быть 'Top', 'Middle', 'Bottom'.

Width: number

Ширина слоя.

Height: number

Высота слоя.

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

OfficeExtension.ClientResult<number>

load(options)

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

load(options?: Visio.Interfaces.ShapeViewLoadOptions): Visio.ShapeView;

Параметры

options: Visio.Interfaces.ShapeViewLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

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

Visio.ShapeView

load(propertyNames)

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

load(propertyNames?: string | string[]): Visio.ShapeView;

Параметры

propertyNames: string | string[]

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

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

Visio.ShapeView

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Visio.ShapeView;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

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

Visio.ShapeView

removeOverlay(OverlayId)

Удаляет заданный слой или все слои фигуры.

removeOverlay(OverlayId: number): void;

Параметры

OverlayId: number

Идентификатор слоя. Удаляет специальный идентификатор слоя на фигуре.

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

void

Примеры

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shape = activePage.shapes.getItem(0);
    shape.view.removeOverlay(1);
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.ShapeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Visio.Interfaces.ShapeViewUpdateData

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

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

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

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Visio.ShapeView): void;

Параметры

properties: Visio.ShapeView

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

void

setText(Text)

API SetText предназначен для обновления текста внутри фигуры Visio во время выполнения. Обновленный текст сохраняет существующие свойства форматирования текста фигуры.

setText(Text: string): void;

Параметры

Text: string

Текстовый параметр — это обновленный текст для отображения на фигуре.

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

void

showOverlay(overlayId, show)

Показывает определенное наложение на фигуре.

showOverlay(overlayId: number, show: boolean): void;

Параметры

overlayId: number

Идентификатор наложения в контексте.

show: boolean

Следует ли показывать наложение.

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

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод объекта, который ему передается.) В то время как исходный объект Visio.ShapeView является объектом API, метод toJSON возвращает простой объект JavaScript (типизированный как Visio.Interfaces.ShapeViewData), содержащий поверхностные копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Visio.Interfaces.ShapeViewData;

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

Visio.Interfaces.ShapeViewData

Комментарии

Используется

Свойства

Методы

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

context

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

highlight

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

Комментарии

Примеры

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

addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)

Параметры

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

Комментарии

Примеры

addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

removeOverlay(OverlayId)

Параметры

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

Комментарии

Примеры

set(properties, options)

Параметры

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

set(properties)

Параметры

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

setText(Text)

Параметры

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

Комментарии

showOverlay(overlayId, show)

Параметры

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

Комментарии

toJSON()

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

Обратная связь