Excel.ChartDataLabel class
Representa o rótulo de dados de um ponto do gráfico.
- Extends
Comentários
[Conjunto de apis: ExcelApi 1.7]
Propriedades
| auto |
Especifica se o rótulo de dados gera automaticamente o texto apropriado com base no contexto. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host 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 do rótulo 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. Consulte |
| 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á vinculado às células (de modo que o formato do número seja alterado nos rótulos quando for alterado nas células). |
| number |
Especifica o código de formato do rótulo de dados. |
| position | Valor que representa a posição do rótulo de dados. Consulte |
| separator | Cadeia de caracteres que representa o separador usado para o rótulo de dados em um gráfico. |
| show |
Especifica se o rótulo de dados é mostrado como um balão com a âncora final anexada ao ponto de dados. Se |
| show |
Especifica se o tamanho da bolha do rótulo de dados está visível. |
| show |
Especifica se o nome da categoria do rótulo de dados é visível. |
| show |
Especifica se a chave da legenda do rótulo de dados está visível. |
| show |
Especifica se a porcentagem do rótulo de dados está visível. |
| show |
Especifica se o nome da série de rótulos de dados é visível. |
| show |
Especifica se o valor do rótulo de dados é visível. |
| text | Cadeia de caracteres que representa o texto do rótulo de dados em um gráfico. |
| text |
Representa o ângulo no qual o texto é orientado para o rótulo de dados do gráfico. O valor deve ser um inteiro de -90 a 90 ou o 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. Consulte |
| width | Retorna a largura, em pontos, do rótulo de dados do gráfico. O valor é |
Métodos
| get |
Retorna uma subcadeia de caracteres do rótulo de dados. O caractere de quebra de linha '\n' conta como um caractere. |
| get |
Retorna a âncora final do rótulo de dados, que é mostrado como um texto explicativo auto-adesivo. |
| 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 |
Define a altura do rótulo de dados em pontos. |
| set |
Define a largura do rótulo de dados em pontos. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
autoText
Especifica se o rótulo de dados gera automaticamente o texto apropriado com base no contexto.
autoText: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.8]
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
format
Representa o formato do rótulo de dados do gráfico.
readonly format: Excel.ChartDataLabelFormat;
Valor da propriedade
Comentários
[Conjunto de apis: ExcelApi 1.8]
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
[Conjunto de apis: ExcelApi 1.8]
geometricShapeType
Especifica o tipo de forma geométrica do rótulo de dados. Veja Excel.GeometricShapeType para obter detalhes. O valor é null se o rótulo 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
[Conjunto de apis: ExcelApi 1.19]
height
Retorna a altura, em pontos, do rótulo de dados do gráfico. O valor é null se o rótulo de dados do gráfico não estiver visível.
readonly height: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.8]
horizontalAlignment
Representa o alinhamento horizontal de rótulo de dados do gráfico. Consulte Excel.ChartTextHorizontalAlignment para obter detalhes. Essa propriedade é válida somente quando TextOrientation o rótulo 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
[Conjunto de apis: ExcelApi 1.8]
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 o rótulo de dados do gráfico não estiver visível.
left: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.8]
linkNumberFormat
Especifica se o formato de número está vinculado às células (de modo que o formato do número seja alterado nos rótulos quando for alterado nas células).
linkNumberFormat: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.9]
numberFormat
Especifica o código de formato do rótulo de dados.
numberFormat: string;
Valor da propriedade
string
Comentários
[Conjunto de apis: ExcelApi 1.8]
position
Valor que representa a posição do rótulo de dados. Consulte 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
[Conjunto de apis: ExcelApi 1.7]
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
[Conjunto de apis: ExcelApi 1.7]
showAsStickyCallout
Especifica se o rótulo de dados é mostrado como um balão com a âncora final anexada ao ponto de dados. Se true, o texto explicativo é um dos seguintes valores: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" ou "WedgeEllipseCallout". Consulte GeometricShapeType para obter mais detalhes.
readonly showAsStickyCallout: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.19]
showBubbleSize
Especifica se o tamanho da bolha do rótulo de dados está visível.
showBubbleSize: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
showCategoryName
Especifica se o nome da categoria do rótulo de dados é visível.
showCategoryName: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
showLegendKey
Especifica se a chave da legenda do rótulo de dados está visível.
showLegendKey: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
showPercentage
Especifica se a porcentagem do rótulo de dados está visível.
showPercentage: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
showSeriesName
Especifica se o nome da série de rótulos de dados é visível.
showSeriesName: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
showValue
Especifica se o valor do rótulo de dados é visível.
showValue: boolean;
Valor da propriedade
boolean
Comentários
[Conjunto de apis: ExcelApi 1.7]
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
[Conjunto de apis: ExcelApi 1.8]
textOrientation
Representa o ângulo no qual o texto é orientado para o rótulo de dados do gráfico. O valor deve ser um inteiro de -90 a 90 ou o inteiro 180 para texto orientado verticalmente.
textOrientation: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.8]
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 o rótulo de dados do gráfico não estiver visível.
top: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.8]
verticalAlignment
Representa o alinhamento vertical do rótulo de dados do gráfico. Consulte Excel.ChartTextVerticalAlignment para obter detalhes. Esta propriedade é válida somente quando TextOrientation o rótulo de dados é 0.
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
Valor da propriedade
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Comentários
[Conjunto de apis: ExcelApi 1.8]
width
Retorna a largura, em pontos, do rótulo de dados do gráfico. O valor é null se o rótulo de dados do gráfico não estiver visível.
readonly width: number;
Valor da propriedade
number
Comentários
[Conjunto de apis: ExcelApi 1.8]
Detalhes do método
getSubstring(start, length)
Retorna uma subcadeia de caracteres do rótulo de dados. O caractere de quebra de linha '\n' conta como um caractere.
getSubstring(start: number, length?: number): Excel.ChartFormatString;
Parâmetros
- start
-
number
A posição do caractere inicial com base em zero de uma subcadeia de caracteres no rótulo de dados.
- length
-
number
Opcional. O número de caracteres na subcadeia de caracteres. Se o comprimento for omitido, todos os caracteres do início ao fim do rótulo de dados serão recuperados.
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.19]
getTailAnchor()
Retorna a âncora final do rótulo de dados, que é mostrado como um texto explicativo auto-adesivo.
getTailAnchor(): Excel.ChartDataLabelAnchor;
Retornos
Comentários
[Conjunto de apis: ExcelApi 1.19]
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 quais propriedades do objeto devem ser carregadas.
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 de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
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 de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula 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.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Excel.Interfaces.ChartDataLabelUpdateData
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 de propriedades tentar definir 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: Excel.ChartDataLabel): void;
Parâmetros
- properties
- Excel.ChartDataLabel
Retornos
void
setHeight(height)
Define a altura do rótulo de dados em pontos.
setHeight(height: number): void;
Parâmetros
- height
-
number
A altura do rótulo de dados em pontos.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.19]
setWidth(width)
Define a largura do rótulo de dados em pontos.
setWidth(width: number): void;
Parâmetros
- width
-
number
A largura do rótulo de dados em pontos.
Retornos
void
Comentários
[Conjunto de apis: ExcelApi 1.19]
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.ChartDataLabel é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ChartDataLabelData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.ChartDataLabelData;