Compartilhar via

Excel.Interfaces.ShapeData interface

  • Referência
Pacote:
excel

Uma interface que descreve os dados retornados chamando shape.toJSON().

Propriedades

altTextDescription

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

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

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

Obtém o nome de exibição da forma. Uma forma recém-criada tem um nome gerado que é localizado e pode não corresponder ao seu name. Nesse cenário, você pode usar essa API para obter o nome exibido na interface do usuário.
fill

Retorna a formatação de preenchimento dessa forma.
geometricShapeType

Especifica o tipo de forma geométrica dessa forma geométrica. Confira Excel.GeometricShapeType detalhes. Retorna null se o tipo de forma não for "GeometricShape".
height

Especifica a altura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como uma entrada.
id

Especifica o identificador de forma.
left

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

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.
lineFormat

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

Especifica se a proporção dessa forma está bloqueada.
name

Especifica o nome da forma.
placement

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

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

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

Retorna o tipo dessa forma. Confira Excel.ShapeType detalhes.
visible

Especifica se a forma está visível.
width

Especifica a largura, em pontos, da forma. Gera uma exceção InvalidArgument quando definida com um valor negativo ou zero como uma entrada.
zOrderPosition

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

Detalhes da propriedade

altTextDescription

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

altTextDescription?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

altTextTitle

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

altTextTitle?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

connectionSiteCount

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

connectionSiteCount?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

displayName

Obtém o nome de exibição da forma. Uma forma recém-criada tem um nome gerado que é localizado e pode não corresponder ao seu name. Nesse cenário, você pode usar essa API para obter o nome exibido na interface do usuário.

displayName?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.15 ]

fill

Retorna a formatação de preenchimento dessa forma.

fill?: Excel.Interfaces.ShapeFillData;

Valor da propriedade

Excel.Interfaces.ShapeFillData

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

geometricShapeType

Especifica o tipo de forma geométrica dessa forma geométrica. Confira Excel.GeometricShapeType detalhes. Retorna null se o tipo de forma não for "GeometricShape".

geometricShapeType?: Excel.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";

Valor da propriedade

Excel.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"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

height

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

height?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

id

Especifica o identificador de forma.

id?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

left

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

left?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

level

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.

level?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

lineFormat

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

lineFormat?: Excel.Interfaces.ShapeLineFormatData;

Valor da propriedade

Excel.Interfaces.ShapeLineFormatData

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

lockAspectRatio

Especifica se a proporção dessa forma está bloqueada.

lockAspectRatio?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

name

Especifica o nome da forma.

name?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

placement

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

placement?: Excel.Placement | "TwoCell" | "OneCell" | "Absolute";

Valor da propriedade

Excel.Placement | "TwoCell" | "OneCell" | "Absolute"

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

rotation

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

rotation?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

top

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

top?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

type

Retorna o tipo dessa forma. Confira Excel.ShapeType detalhes.

type?: Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";

Valor da propriedade

Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line"

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

visible

Especifica se a forma está visível.

visible?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

width

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

width?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

zOrderPosition

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

zOrderPosition?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]