Visio.ShapeView class
Representa a classe ShapeView.
- Extends
Comentários
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| highlight | Representa o realce ao redor da forma. |
Métodos
| add |
Adiciona uma sobreposição no topo da forma. |
| add |
Adiciona uma sobreposição no topo 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 |
| remove |
Remove uma sobreposição específica ou todas as sobreposições na Forma. |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| set |
O objetivo da API SetText é atualizar o texto dentro de uma Forma do Visio em tempo de execução. O texto atualizado mantém as propriedades de formatação existentes do texto da forma. |
| show |
Mostra uma sobreposição específica na Forma. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;Valor da propriedade
highlight
Representa o realce ao redor da forma.
highlight: Visio.Highlight;Valor da propriedade
Comentários
Exemplos
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));
}
});
Detalhes do método
addOverlay(OverlayType, Content, OverlayHorizontalAlignment, OverlayVerticalAlignment, Width, Height)
Adiciona uma sobreposição no topo da forma.
addOverlay(OverlayType: Visio.OverlayType, Content: string, OverlayHorizontalAlignment: Visio.OverlayHorizontalAlignment, OverlayVerticalAlignment: Visio.OverlayVerticalAlignment, Width: number, Height: number): OfficeExtension.ClientResult<number>;Parâmetros
- OverlayType
- Visio.OverlayType
Um Tipo de Sobreposição. Pode ser "Texto", "Imagem" ou "Html".
- Content
-
string
Conteúdo de Sobreposição.
- OverlayHorizontalAlignment
- Visio.OverlayHorizontalAlignment
Alinhamento Horizontal da Sobreposição. Pode ser "Esquerda", "Centro" ou "Direita".
- OverlayVerticalAlignment
- Visio.OverlayVerticalAlignment
Alinhamento Vertical da Sobreposição. Pode ser "Superior", "Médio", "Inferior".
- Width
-
number
Largura de Sobreposição.
- Height
-
number
Altura de Sobreposição.
Retornos
OfficeExtension.ClientResult<number>
Comentários
Exemplos
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(OverlayTypeString, Content, OverlayHorizontalAlignmentString, OverlayVerticalAlignmentString, Width, Height)
Adiciona uma sobreposição no topo da forma.
addOverlay(OverlayTypeString: "Text" | "Image" | "Html", Content: string, OverlayHorizontalAlignmentString: "Left" | "Center" | "Right", OverlayVerticalAlignmentString: "Top" | "Middle" | "Bottom", Width: number, Height: number): OfficeExtension.ClientResult<number>;Parâmetros
- OverlayTypeString
-
"Text" | "Image" | "Html"
Um Tipo de Sobreposição. Pode ser "Texto", "Imagem" ou "Html".
- Content
-
string
Conteúdo de Sobreposição.
- OverlayHorizontalAlignmentString
-
"Left" | "Center" | "Right"
Alinhamento Horizontal da Sobreposição. Pode ser "Esquerda", "Centro" ou "Direita".
- OverlayVerticalAlignmentString
-
"Top" | "Middle" | "Bottom"
Alinhamento Vertical da Sobreposição. Pode ser "Superior", "Médio", "Inferior".
- Width
-
number
Largura de Sobreposição.
- Height
-
number
Altura de Sobreposição.
Retornos
OfficeExtension.ClientResult<number>
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.ShapeViewLoadOptions): Visio.ShapeView;Parâmetros
Fornece opções para as propriedades do objeto a 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.ShapeView;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
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.ShapeView;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
removeOverlay(OverlayId)
Remove uma sobreposição específica ou todas as sobreposições na Forma.
removeOverlay(OverlayId: number): void;Parâmetros
- OverlayId
-
number
Uma ID de sobreposição. Remove a id de sobreposição específica da forma.
Retornos
void
Comentários
Exemplos
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)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.ShapeViewUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Visio.Interfaces.ShapeViewUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Visio.ShapeView): void;Parâmetros
- properties
- Visio.ShapeView
Retornos
void
setText(Text)
O objetivo da API SetText é atualizar o texto dentro de uma Forma do Visio em tempo de execução. O texto atualizado mantém as propriedades de formatação existentes do texto da forma.
setText(Text: string): void;Parâmetros
- Text
-
string
O parâmetro de texto é o texto atualizado a apresentar na forma.
Retornos
void
Comentários
showOverlay(overlayId, show)
Mostra uma sobreposição específica na Forma.
showOverlay(overlayId: number, show: boolean): void;Parâmetros
- overlayId
-
number
O ID de sobreposição no contexto.
- show
-
boolean
Se pretende mostrar a sobreposição.
Retornos
void
Comentários
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Visio.ShapeView original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Visio.Interfaces.ShapeViewData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Visio.Interfaces.ShapeViewData;