Visio.Shape class
Representa a classe Shape.
- Extends
Comentários
Propriedades
| comments | Retorna a Coleção de Comentários. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| hyperlinks | Retorna a coleção de Hiperlinks para um objeto Forma. |
| id | Identificador da forma. |
| name | Nome da Shape. |
| select | Retorna verdadeiro, se a forma estiver selecionada. O usuário pode definir como verdadeiro para selecionar a forma explicitamente. |
| shape |
Retorna a Seção de Dados da Shape. |
| sub |
Obtém a Coleção SubShape. |
| text | Texto da forma. |
| view | Retorna a visualização da forma. |
Métodos
| get |
Retorna o objeto AbsoluteBoundingBox que especifica a caixa delimitadora absoluta da forma. |
| get |
Retorna o objeto BoundingBox que especifica a caixa delimitadora da forma. |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| set |
Definir dados simulados |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
comments
Retorna a Coleção de Comentários.
readonly comments: Visio.CommentCollection;Valor da propriedade
Comentários
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
hyperlinks
Retorna a coleção de Hiperlinks para um objeto Forma.
readonly hyperlinks: Visio.HyperlinkCollection;Valor da propriedade
Comentários
id
Identificador da forma.
readonly id: number;Valor da propriedade
number
Comentários
name
Nome da Shape.
readonly name: string;Valor da propriedade
string
Comentários
select
Retorna verdadeiro, se a forma estiver selecionada. O usuário pode definir como verdadeiro para selecionar a forma explicitamente.
select: boolean;Valor da propriedade
boolean
Comentários
shapeDataItems
Retorna a Seção de Dados da Shape.
readonly shapeDataItems: Visio.ShapeDataItemCollection;Valor da propriedade
Comentários
subShapes
Obtém a Coleção SubShape.
readonly subShapes: Visio.ShapeCollection;Valor da propriedade
Comentários
text
Texto da forma.
readonly text: string;Valor da propriedade
string
Comentários
view
Retorna a visualização da forma.
readonly view: Visio.ShapeView;Valor da propriedade
Comentários
Detalhes do método
getAbsoluteBounds()
Retorna o objeto AbsoluteBoundingBox que especifica a caixa delimitadora absoluta da forma.
getAbsoluteBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;Retornos
Comentários
getBounds()
Retorna o objeto BoundingBox que especifica a caixa delimitadora da forma.
getBounds(): OfficeExtension.ClientResult<Visio.BoundingBox>;Retornos
Comentários
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Visio.Interfaces.ShapeLoadOptions): Visio.Shape;Parâmetros
Fornece opções para quais propriedades do objeto carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Visio.Shape;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
Exemplos
Visio.run(session, function (ctx) {
const activePage = ctx.document.getActivePage();
const shapeName = "Sample Name";
const shape = activePage.shapes.getItem(shapeName);
shape.load(["name", "id", "text", "select"]);
return ctx.sync().then(function () {
console.log(shape.name);
console.log(shape.id);
console.log(shape.text);
console.log(shape.select);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
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));
}
});
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Shape;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Visio.Interfaces.ShapeUpdateData
Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
set(properties: Visio.Shape): void;Parâmetros
- properties
- Visio.Shape
Retornos
void
setMockData(data)
Definir dados simulados
setMockData(data: Visio.Interfaces.ShapeData): void;Parâmetros
Retornos
void
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Visio.Shape original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Visio.Interfaces.ShapeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Visio.Interfaces.ShapeData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de