Excel.ChartDataLabel class
Representa a etiqueta de dados de um ponto de gráfico.
- Extends
Comentários
Propriedades
auto |
Especifica se a etiqueta de dados gera automaticamente texto adequado com base no contexto. |
context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
format | Representa o formato do rótulo de dados do gráfico. |
formula | Valor de cadeia de caracteres que representa a fórmula do título do rótulo de dados usando a notação no estilo A1. |
geometric |
Especifica o tipo de forma geométrica da etiqueta de dados. Veja |
height | Retorna a altura, em pontos, do rótulo de dados do gráfico. O valor é |
horizontal |
Representa o alinhamento horizontal de rótulo de dados do gráfico. Veja |
left | Representa a distância, em pontos, da borda esquerda do rótulo de dados do gráfico até a borda esquerda da área do gráfico. O valor é |
link |
Especifica se o formato de número está ligado às células (para que o formato de número seja alterado nas etiquetas quando for alterado nas células). |
number |
Valor de cadeia de caracteres que representa o código do formato do rótulo de dados. |
position | Valor que representa a posição da etiqueta de dados. Veja |
separator | Cadeia de caracteres que representa o separador usado para o rótulo de dados em um gráfico. |
show |
Obtém um valor que indica se a etiqueta de dados é apresentada como uma nota de aviso com a âncora de cauda anexada ao ponto de dados. Se |
show |
Especifica se o tamanho da bolha da etiqueta de dados está visível. |
show |
Especifica se o nome da categoria da etiqueta de dados está visível. |
show |
Especifica se a chave de legenda da etiqueta de dados está visível. |
show |
Especifica se a percentagem da etiqueta de dados está visível. |
show |
Especifica se o nome da série de etiquetas de dados está visível. |
show |
Especifica se o valor da etiqueta de dados está visível. |
text | Cadeia de caracteres que representa o texto do rótulo de dados em um gráfico. |
text |
Representa o ângulo para o qual o texto é orientado para a etiqueta de dados do gráfico. O valor deve ser um número inteiro de -90 a 90 ou o número inteiro 180 para texto orientado verticalmente. |
top | Representa a distância, em pontos, da borda superior do rótulo de dados do gráfico até a borda superior da área do gráfico. O valor é |
vertical |
Representa o alinhamento vertical do rótulo de dados do gráfico. Veja |
width | Retorna a largura, em pontos, do rótulo de dados do gráfico. O valor é |
Métodos
get |
Devolve uma subcadeia da etiqueta de dados. O caráter de quebra de linha '\n' conta como um caráter. |
get |
Devolve a âncora traseira da etiqueta de dados que é apresentada como uma nota de aviso autocolante. |
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. 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 |
Define a altura da etiqueta de dados em pontos. |
set |
Define a largura da etiqueta de dados em pontos. |
toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
autoText
Especifica se a etiqueta de dados gera automaticamente texto adequado com base no contexto.
autoText: boolean;
Valor da propriedade
boolean
Comentários
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
format
Representa o formato do rótulo de dados do gráfico.
readonly format: Excel.ChartDataLabelFormat;
Valor da propriedade
Comentários
formula
Valor de cadeia de caracteres que representa a fórmula do título do rótulo de dados usando a notação no estilo A1.
formula: string;
Valor da propriedade
string
Comentários
geometricShapeType
Especifica o tipo de forma geométrica da etiqueta de dados. Veja Excel.GeometricShapeType
para obter detalhes. O valor é null
se a etiqueta de dados não for uma forma geométrica.
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
height
Retorna a altura, em pontos, do rótulo de dados do gráfico. O valor é null
se a etiqueta de dados do gráfico não estiver visível.
readonly height: number;
Valor da propriedade
number
Comentários
horizontalAlignment
Representa o alinhamento horizontal de rótulo de dados do gráfico. Veja Excel.ChartTextHorizontalAlignment
para obter detalhes. Esta propriedade só é válida quando TextOrientation
a etiqueta de dados é -90, 90 ou 180.
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";
Valor da propriedade
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
Comentários
left
Representa a distância, em pontos, da borda esquerda do rótulo de dados do gráfico até a borda esquerda da área do gráfico. O valor é null
se a etiqueta de dados do gráfico não estiver visível.
left: number;
Valor da propriedade
number
Comentários
linkNumberFormat
Especifica se o formato de número está ligado às células (para que o formato de número seja alterado nas etiquetas quando for alterado nas células).
linkNumberFormat: boolean;
Valor da propriedade
boolean
Comentários
numberFormat
Valor de cadeia de caracteres que representa o código do formato do rótulo de dados.
numberFormat: string;
Valor da propriedade
string
Comentários
position
Valor que representa a posição da etiqueta de dados. Veja Excel.ChartDataLabelPosition
para obter detalhes.
position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";
Valor da propriedade
Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"
Comentários
separator
Cadeia de caracteres que representa o separador usado para o rótulo de dados em um gráfico.
separator: string;
Valor da propriedade
string
Comentários
showAsStickyCallout
Obtém um valor que indica se a etiqueta de dados é apresentada como uma nota de aviso com a âncora de cauda anexada ao ponto de dados. Se true
, a nota de aviso é um dos seguintes valores: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" ou "WedgeEllipseCallout". Veja GeometricShapeType para obter mais detalhes.
readonly showAsStickyCallout: boolean;
Valor da propriedade
boolean
Comentários
showBubbleSize
Especifica se o tamanho da bolha da etiqueta de dados está visível.
showBubbleSize: boolean;
Valor da propriedade
boolean
Comentários
showCategoryName
Especifica se o nome da categoria da etiqueta de dados está visível.
showCategoryName: boolean;
Valor da propriedade
boolean
Comentários
showLegendKey
Especifica se a chave de legenda da etiqueta de dados está visível.
showLegendKey: boolean;
Valor da propriedade
boolean
Comentários
showPercentage
Especifica se a percentagem da etiqueta de dados está visível.
showPercentage: boolean;
Valor da propriedade
boolean
Comentários
showSeriesName
Especifica se o nome da série de etiquetas de dados está visível.
showSeriesName: boolean;
Valor da propriedade
boolean
Comentários
showValue
Especifica se o valor da etiqueta de dados está visível.
showValue: boolean;
Valor da propriedade
boolean
Comentários
text
Cadeia de caracteres que representa o texto do rótulo de dados em um gráfico.
text: string;
Valor da propriedade
string
Comentários
textOrientation
Representa o ângulo para o qual o texto é orientado para a etiqueta de dados do gráfico. O valor deve ser um número inteiro de -90 a 90 ou o número inteiro 180 para texto orientado verticalmente.
textOrientation: number;
Valor da propriedade
number
Comentários
top
Representa a distância, em pontos, da borda superior do rótulo de dados do gráfico até a borda superior da área do gráfico. O valor é null
se a etiqueta de dados do gráfico não estiver visível.
top: number;
Valor da propriedade
number
Comentários
verticalAlignment
Representa o alinhamento vertical do rótulo de dados do gráfico. Veja Excel.ChartTextVerticalAlignment
para obter detalhes. Esta propriedade só é válida quando TextOrientation
a etiqueta de dados é 0.
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
Valor da propriedade
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Comentários
width
Retorna a largura, em pontos, do rótulo de dados do gráfico. O valor é null
se a etiqueta de dados do gráfico não estiver visível.
readonly width: number;
Valor da propriedade
number
Comentários
Detalhes do método
getSubstring(start, length)
Devolve uma subcadeia da etiqueta de dados. O caráter de quebra de linha '\n' conta como um caráter.
getSubstring(start: number, length?: number): Excel.ChartFormatString;
Parâmetros
- start
-
number
A posição do caráter inicial baseado em zero de uma subcadeia na etiqueta de dados.
- length
-
number
Opcional. O número de carateres na subcadeia. Se o comprimento for omitido, todos os carateres do início ao fim da etiqueta de dados são obtidos.
Retornos
Comentários
getTailAnchor()
Devolve a âncora traseira da etiqueta de dados que é apresentada como uma nota de aviso autocolante.
getTailAnchor(): Excel.ChartDataLabelAnchor;
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?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel;
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[]): Excel.ChartDataLabel;
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;
}): Excel.ChartDataLabel;
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
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.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Excel.Interfaces.ChartDataLabelUpdateData
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: Excel.ChartDataLabel): void;
Parâmetros
- properties
- Excel.ChartDataLabel
Retornos
void
setHeight(height)
Define a altura da etiqueta de dados em pontos.
setHeight(height: number): void;
Parâmetros
- height
-
number
A altura da etiqueta de dados em pontos.
Retornos
void
Comentários
setWidth(width)
Define a largura da etiqueta de dados em pontos.
setWidth(width: number): void;
Parâmetros
- width
-
number
A largura da etiqueta de dados em pontos.
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.stringify
por sua vez, chama o toJSON
método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.ChartDataLabel
é um objeto de API, o toJSON
método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartDataLabelData
) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartDataLabelData;