Compartilhar via

Excel.ChartDataLabels class

  • Referência
Pacote:
excel

Representa uma coleção de todos os rótulos de dados em um ponto do gráfico.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

autoText

Especifica se as etiquetas de dados geram 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

Especifica o formato das etiquetas de dados do gráfico, que inclui a formatação de tipo de letra e preenchimento.
geometricShapeType

Especifica o tipo de forma geométrica das etiquetas de dados. Veja Excel.GeometricShapeType para obter detalhes. O valor é null se as etiquetas de dados não forem formas geométricas.
horizontalAlignment

Especifica o alinhamento horizontal para a etiqueta de dados do gráfico. Veja Excel.ChartTextHorizontalAlignment para obter detalhes. Esta propriedade só é válida quando a TextOrientation etiqueta de dados é 0.
leaderLines

Obtém um objeto que representa as linhas de preenchimento das etiquetas de dados.
linkNumberFormat

Especifica se o formato de número está ligado às células. Se true, o formato de número será alterado nas etiquetas quando for alterado nas células.
numberFormat

Especifica o código de formato para etiquetas de dados.
position

Valor que representa a posição da etiqueta de dados. Veja Excel.ChartDataLabelPosition para obter detalhes.
separator

Cadeia de caracteres que representa o separador usado para os rótulos de dados em um gráfico.
showAsStickyCallout

Obtém um valor que indica se as etiquetas de dados são apresentadas como 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.
showBubbleSize

Especifica se o tamanho da bolha da etiqueta de dados está visível.
showCategoryName

Especifica se o nome da categoria da etiqueta de dados está visível.
showLeaderLines

Especifica um valor que indica se as linhas de preenchimento são apresentadas para as etiquetas de dados. true se forem apresentadas linhas de preenchimento; caso contrário, false.
showLegendKey

Especifica se a chave de legenda da etiqueta de dados está visível.
showPercentage

Especifica se a percentagem da etiqueta de dados está visível.
showSeriesName

Especifica se o nome da série de etiquetas de dados está visível.
showValue

Especifica se o valor da etiqueta de dados está visível.
textOrientation

Representa o ângulo para o qual o texto é orientado para etiquetas de dados. O valor deve ser um número inteiro de -90 a 90 ou o número inteiro 180 para texto orientado verticalmente.
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 é -90, 90 ou 180.

Métodos

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(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
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.
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 original Excel.ChartDataLabels é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartDataLabelsData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

autoText

Especifica se as etiquetas de dados geram automaticamente texto adequado com base no contexto.

autoText: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

Excel.RequestContext

format

Especifica o formato das etiquetas de dados do gráfico, que inclui a formatação de tipo de letra e preenchimento.

readonly format: Excel.ChartDataLabelFormat;

Valor da propriedade

Excel.ChartDataLabelFormat

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

geometricShapeType

Especifica o tipo de forma geométrica das etiquetas de dados. Veja Excel.GeometricShapeType para obter detalhes. O valor é null se as etiquetas de dados não forem formas geométricas.

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.19 ]

horizontalAlignment

Especifica o alinhamento horizontal para a etiqueta de dados do gráfico. Veja Excel.ChartTextHorizontalAlignment para obter detalhes. Esta propriedade só é válida quando a TextOrientation etiqueta de dados é 0.

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

Valor da propriedade

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

leaderLines

Obtém um objeto que representa as linhas de preenchimento das etiquetas de dados.

readonly leaderLines: Excel.ChartLeaderLines;

Valor da propriedade

Excel.ChartLeaderLines

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

linkNumberFormat

Especifica se o formato de número está ligado às células. Se true, o formato de número será alterado nas etiquetas quando for alterado nas células.

linkNumberFormat: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

numberFormat

Especifica o código de formato para etiquetas de dados.

numberFormat: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

[ Conjunto de API: ExcelApi 1.1 ]

separator

Cadeia de caracteres que representa o separador usado para os rótulos de dados em um gráfico.

separator: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

showAsStickyCallout

Obtém um valor que indica se as etiquetas de dados são apresentadas como 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

[ Conjunto de API: ExcelApi 1.19 ]

showBubbleSize

Especifica se o tamanho da bolha da etiqueta de dados está visível.

showBubbleSize: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

showCategoryName

Especifica se o nome da categoria da etiqueta de dados está visível.

showCategoryName: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

showLeaderLines

Especifica um valor que indica se as linhas de preenchimento são apresentadas para as etiquetas de dados. true se forem apresentadas linhas de preenchimento; caso contrário, false.

showLeaderLines: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

showLegendKey

Especifica se a chave de legenda da etiqueta de dados está visível.

showLegendKey: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

showPercentage

Especifica se a percentagem da etiqueta de dados está visível.

showPercentage: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

showSeriesName

Especifica se o nome da série de etiquetas de dados está visível.

showSeriesName: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

showValue

Especifica se o valor da etiqueta de dados está visível.

showValue: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

textOrientation

Representa o ângulo para o qual o texto é orientado para etiquetas de dados. 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

[ Conjunto de API: ExcelApi 1.8 ]

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 é -90, 90 ou 180.

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

Valor da propriedade

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Detalhes do método

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.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;

Parâmetros

options
Excel.Interfaces.ChartDataLabelsLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.ChartDataLabels

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.ChartDataLabels;

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.ChartDataLabels

Exemplos

// Show the series name in data labels and set the position of the data labels to "top".
await Excel.run(async (context) => {
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
    chart.dataLabels.showValue = true;
    chart.dataLabels.position = Excel.ChartDataLabelPosition.top;
    chart.dataLabels.showSeriesName = true;
    await context.sync();

    console.log("Data labels shown");
});

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.ChartDataLabels;

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

Excel.ChartDataLabels

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.ChartDataLabelsUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.ChartDataLabelsUpdateData

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.ChartDataLabels): void;

Parâmetros

properties
Excel.ChartDataLabels

Retornos

void

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 original Excel.ChartDataLabels é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ChartDataLabelsData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.ChartDataLabelsData;

Retornos

Excel.Interfaces.ChartDataLabelsData