ExcelScript.Shape interface

Representa um objeto Shape genérico na planilha. Uma forma pode ser uma forma geométrica, uma linha, um grupo de formas, etc.

Métodos

copyTo(destinationSheet)

Copia e cola um objeto Forma. A forma colada é copiada para o mesmo local de pixel que esta forma.

delete()

Remove a forma da planilha.

getAltTextDescription()

Especifica o texto de descrição alternativa para um objeto Shape.

getAltTextTitle()

Especifica o texto de título alternativo para um objeto Shape.

getAsImage(format)

Converte a forma em uma imagem e retorna a imagem como uma cadeia de caracteres de base 64. O DPI é 96. Os únicos formatos suportados são ExcelScript.PictureFormat.BMP, ExcelScript.PictureFormat.PNG, ExcelScript.PictureFormat.JPEG, e ExcelScript.PictureFormat.GIF.

getConnectionSiteCount()

Retorna o número de locais de conexão nessa forma.

getFill()

Retorna a formatação de preenchimento dessa forma.

getGeometricShape()

Retorna a forma geométrica associada à forma. Um erro será lançado, se o tipo de forma não for "GeometricShape".

getGeometricShapeType()

Especifica o tipo de forma geométrica dessa forma geométrica. Consulte ExcelScript. GeometricShapeType para obter detalhes. Retorna nulo se o tipo de forma não for "GeometricShape".

getGroup()

Retorna o grupo de forma associado à forma. Um erro será lançado, se o tipo de forma não for "GroupShape".

getHeight()

Especifica a altura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

getId()

Especifica o identificador da forma.

getImage()

Retorna a imagem associada à forma. Um erro será lançado, se o tipo de forma não for "Imagem".

getLeft()

A distância, em pontos, da lateral esquerda da forma do lado esquerdo da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

getLevel()

Especifica o nível da forma especificada. Por exemplo, um nível de 0 significa que a forma não faz parte de nenhum grupo, um nível de 1 significa que a forma é parte de um grupo de nível superior e um nível 2 significa que a forma faz parte de um subgrupo do nível superior.

getLine()

Retorna a linha associada à forma. Um erro será lançado, se o tipo de forma não for "Linha".

getLineFormat()

Retorna a formatação de linha do objeto de forma.

getLockAspectRatio()

Especifica se a taxa de proporção desta forma está bloqueada.

getName()

Especifica o nome da forma.

getParentGroup()

Especifica o grupo pai desta forma.

getPlacement()

Representa como o objeto é anexado às células abaixo dela.

getRotation()

Especifica a rotação, em graus, da forma.

getTextFrame()

Retorna o objeto text frame de uma forma. Somente leitura.

getTop()

A distância, em pontos, da borda superior da forma até a borda superior da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

getType()

Retorna o tipo dessa forma. Confira ExcelScript. ShapeType para obter detalhes.

getVisible()

Especifica se a forma está visível.

getWidth()

Especifica a largura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

getZOrderPosition()

Retorna a posição da forma especificada na ordem z, com 0 representando a parte inferior da pilha do pedido.

incrementLeft(increment)

Move a forma horizontalmente pelo número especificado de pontos.

incrementRotation(increment)

O formato é girado em sentido horário ao redor do eixo z pelo número especificado de graus. Use a rotation propriedade para definir a rotação absoluta da forma.

incrementTop(increment)

Move a forma verticalmente pelo número especificado de pontos.

scaleHeight(scaleFactor, scaleType, scaleFrom)

Dimensiona a altura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.

scaleWidth(scaleFactor, scaleType, scaleFrom)

Dimensiona a largura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua largura atual.

setAltTextDescription(altTextDescription)

Especifica o texto de descrição alternativa para um objeto Shape.

setAltTextTitle(altTextTitle)

Especifica o texto de título alternativo para um objeto Shape.

setGeometricShapeType(geometricShapeType)

Especifica o tipo de forma geométrica dessa forma geométrica. Consulte ExcelScript. GeometricShapeType para obter detalhes. Retorna nulo se o tipo de forma não for "GeometricShape".

setHeight(height)

Especifica a altura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

setLeft(left)

A distância, em pontos, da lateral esquerda da forma do lado esquerdo da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

setLockAspectRatio(lockAspectRatio)

Especifica se a taxa de proporção desta forma está bloqueada.

setName(name)

Especifica o nome da forma.

setPlacement(placement)

Representa como o objeto é anexado às células abaixo dela.

setRotation(rotation)

Especifica a rotação, em graus, da forma.

setTop(top)

A distância, em pontos, da borda superior da forma até a borda superior da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

setVisible(visible)

Especifica se a forma está visível.

setWidth(width)

Especifica a largura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

setZOrder(position)

Move a forma especificada para cima ou para baixo na ordem z da coleção, que a desloca para frente ou para trás de outras formas.

Detalhes do método

copyTo(destinationSheet)

Copia e cola um objeto Forma. A forma colada é copiada para o mesmo local de pixel que esta forma.

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

Parâmetros

destinationSheet
Worksheet | string

A planilha à qual o objeto Shape será colado. O valor padrão é a planilha da forma copiada.

Retornos

delete()

Remove a forma da planilha.

delete(): void;

Retornos

void

getAltTextDescription()

Especifica o texto de descrição alternativa para um objeto Shape.

getAltTextDescription(): string;

Retornos

string

getAltTextTitle()

Especifica o texto de título alternativo para um objeto Shape.

getAltTextTitle(): string;

Retornos

string

getAsImage(format)

Converte a forma em uma imagem e retorna a imagem como uma cadeia de caracteres de base 64. O DPI é 96. Os únicos formatos suportados são ExcelScript.PictureFormat.BMP, ExcelScript.PictureFormat.PNG, ExcelScript.PictureFormat.JPEG, e ExcelScript.PictureFormat.GIF.

getAsImage(format: PictureFormat): string;

Parâmetros

format
PictureFormat

Especifica o formato da imagem.

Retornos

string

getConnectionSiteCount()

Retorna o número de locais de conexão nessa forma.

getConnectionSiteCount(): number;

Retornos

number

getFill()

Retorna a formatação de preenchimento dessa forma.

getFill(): ShapeFill;

Retornos

getGeometricShape()

Retorna a forma geométrica associada à forma. Um erro será lançado, se o tipo de forma não for "GeometricShape".

getGeometricShape(): GeometricShape;

Retornos

getGeometricShapeType()

Especifica o tipo de forma geométrica dessa forma geométrica. Consulte ExcelScript. GeometricShapeType para obter detalhes. Retorna nulo se o tipo de forma não for "GeometricShape".

getGeometricShapeType(): GeometricShapeType;

Retornos

getGroup()

Retorna o grupo de forma associado à forma. Um erro será lançado, se o tipo de forma não for "GroupShape".

getGroup(): ShapeGroup;

Retornos

getHeight()

Especifica a altura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

getHeight(): number;

Retornos

number

getId()

Especifica o identificador da forma.

getId(): string;

Retornos

string

getImage()

Retorna a imagem associada à forma. Um erro será lançado, se o tipo de forma não for "Imagem".

getImage(): Image;

Retornos

getLeft()

A distância, em pontos, da lateral esquerda da forma do lado esquerdo da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

getLeft(): number;

Retornos

number

getLevel()

Especifica o nível da forma especificada. Por exemplo, um nível de 0 significa que a forma não faz parte de nenhum grupo, um nível de 1 significa que a forma é parte de um grupo de nível superior e um nível 2 significa que a forma faz parte de um subgrupo do nível superior.

getLevel(): number;

Retornos

number

getLine()

Retorna a linha associada à forma. Um erro será lançado, se o tipo de forma não for "Linha".

getLine(): Line;

Retornos

getLineFormat()

Retorna a formatação de linha do objeto de forma.

getLineFormat(): ShapeLineFormat;

Retornos

getLockAspectRatio()

Especifica se a taxa de proporção desta forma está bloqueada.

getLockAspectRatio(): boolean;

Retornos

boolean

getName()

Especifica o nome da forma.

getName(): string;

Retornos

string

getParentGroup()

Especifica o grupo pai desta forma.

getParentGroup(): Shape;

Retornos

getPlacement()

Representa como o objeto é anexado às células abaixo dela.

getPlacement(): Placement;

Retornos

getRotation()

Especifica a rotação, em graus, da forma.

getRotation(): number;

Retornos

number

getTextFrame()

Retorna o objeto text frame de uma forma. Somente leitura.

getTextFrame(): TextFrame;

Retornos

getTop()

A distância, em pontos, da borda superior da forma até a borda superior da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

getTop(): number;

Retornos

number

getType()

Retorna o tipo dessa forma. Confira ExcelScript. ShapeType para obter detalhes.

getType(): ShapeType;

Retornos

getVisible()

Especifica se a forma está visível.

getVisible(): boolean;

Retornos

boolean

getWidth()

Especifica a largura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

getWidth(): number;

Retornos

number

getZOrderPosition()

Retorna a posição da forma especificada na ordem z, com 0 representando a parte inferior da pilha do pedido.

getZOrderPosition(): number;

Retornos

number

incrementLeft(increment)

Move a forma horizontalmente pelo número especificado de pontos.

incrementLeft(increment: number): void;

Parâmetros

increment
number

O incremento, em pontos, a forma será horizontalmente movida. Um valor positivo move a forma para a direita e um valor negativo a move para a esquerda. Se a planilha for orientada da direita para a esquerda, ela será revertida: os valores positivos moverão a forma para a esquerda e os valores negativos a moverão para a direita.

Retornos

void

incrementRotation(increment)

O formato é girado em sentido horário ao redor do eixo z pelo número especificado de graus. Use a rotation propriedade para definir a rotação absoluta da forma.

incrementRotation(increment: number): void;

Parâmetros

increment
number

Quantos graus a forma será girada. Um valor positivo gira a forma no sentido horário; um valor negativo a gira no sentido anti-horário.

Retornos

void

incrementTop(increment)

Move a forma verticalmente pelo número especificado de pontos.

incrementTop(increment: number): void;

Parâmetros

increment
number

O incremento, em pontos, a forma será movida verticalmente. em pontos. Um valor positivo move a forma para baixo e um valor negativo a move para cima.

Retornos

void

scaleHeight(scaleFactor, scaleType, scaleFrom)

Dimensiona a altura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua altura atual.

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

Parâmetros

scaleFactor
number

Especifica a proporção entre a altura da forma após você redimensioná-la e a altura atual ou original.

scaleType
ShapeScaleType

Especifica se a forma é dimensionada em relação ao seu tamanho original ou atual. A opção de escala de tamanho original só funciona para imagens.

scaleFrom
ShapeScaleFrom

Opcional. Especifica qual parte da forma mantém sua posição quando a forma é dimensionada. Se for omitido, representará o canto superior esquerdo da forma mantém sua posição.

Retornos

void

scaleWidth(scaleFactor, scaleType, scaleFrom)

Dimensiona a largura da forma por um fator especificado. Para imagens, é possível indicar se você deseja dimensionar a forma em relação ao tamanho original ou ao tamanho atual. As formas que não são figuras serão sempre dimensionadas em relação à sua largura atual.

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

Parâmetros

scaleFactor
number

Especifica a proporção entre a largura da forma após você redimensioná-la e a largura atual ou original.

scaleType
ShapeScaleType

Especifica se a forma é dimensionada em relação ao seu tamanho original ou atual. A opção de escala de tamanho original só funciona para imagens.

scaleFrom
ShapeScaleFrom

Opcional. Especifica qual parte da forma mantém sua posição quando a forma é dimensionada. Se for omitido, representará o canto superior esquerdo da forma mantém sua posição.

Retornos

void

setAltTextDescription(altTextDescription)

Especifica o texto de descrição alternativa para um objeto Shape.

setAltTextDescription(altTextDescription: string): void;

Parâmetros

altTextDescription
string

Retornos

void

setAltTextTitle(altTextTitle)

Especifica o texto de título alternativo para um objeto Shape.

setAltTextTitle(altTextTitle: string): void;

Parâmetros

altTextTitle
string

Retornos

void

setGeometricShapeType(geometricShapeType)

Especifica o tipo de forma geométrica dessa forma geométrica. Consulte ExcelScript. GeometricShapeType para obter detalhes. Retorna nulo se o tipo de forma não for "GeometricShape".

setGeometricShapeType(geometricShapeType: GeometricShapeType): void;

Parâmetros

geometricShapeType
GeometricShapeType

Retornos

void

setHeight(height)

Especifica a altura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

setHeight(height: number): void;

Parâmetros

height
number

Retornos

void

setLeft(left)

A distância, em pontos, da lateral esquerda da forma do lado esquerdo da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

setLeft(left: number): void;

Parâmetros

left
number

Retornos

void

setLockAspectRatio(lockAspectRatio)

Especifica se a taxa de proporção desta forma está bloqueada.

setLockAspectRatio(lockAspectRatio: boolean): void;

Parâmetros

lockAspectRatio
boolean

Retornos

void

setName(name)

Especifica o nome da forma.

setName(name: string): void;

Parâmetros

name
string

Retornos

void

setPlacement(placement)

Representa como o objeto é anexado às células abaixo dela.

setPlacement(placement: Placement): void;

Parâmetros

placement
Placement

Retornos

void

setRotation(rotation)

Especifica a rotação, em graus, da forma.

setRotation(rotation: number): void;

Parâmetros

rotation
number

Retornos

void

setTop(top)

A distância, em pontos, da borda superior da forma até a borda superior da planilha. Gera uma exceção de argumento inválida quando definida com um valor negativo como entrada.

setTop(top: number): void;

Parâmetros

top
number

Retornos

void

setVisible(visible)

Especifica se a forma está visível.

setVisible(visible: boolean): void;

Parâmetros

visible
boolean

Retornos

void

setWidth(width)

Especifica a largura, em pontos, da forma. Gera uma exceção de argumento inválida quando definida com um valor negativo ou zero como entrada.

setWidth(width: number): void;

Parâmetros

width
number

Retornos

void

setZOrder(position)

Move a forma especificada para cima ou para baixo na ordem z da coleção, que a desloca para frente ou para trás de outras formas.

setZOrder(position: ShapeZOrder): void;

Parâmetros

position
ShapeZOrder

Onde mover a forma na pilha da ordem z em relação às outras formas. Consulte ExcelScript. ShapeZOrder para obter detalhes.

Retornos

void