Edit

Share via

Excel.Interfaces.ChartDataLabelData interface

  • Reference
Package:
excel

An interface describing the data returned by calling chartDataLabel.toJSON().

Properties

autoText

Specifies if the data label automatically generates appropriate text based on context.
format

Represents the format of chart data label.
formula

String value that represents the formula of chart data label using A1-style notation.
geometricShapeType

Gets or sets the geometric shape type of the data label. See Excel.GeometricShapeType for more details. Value is null if the data label is not a geometric shape.
height

Returns the height, in points, of the chart data label. Value is null if the chart data label is not visible.
horizontalAlignment

Represents the horizontal alignment for chart data label. See Excel.ChartTextHorizontalAlignment for details. This property is valid only when TextOrientation of data label is -90, 90, or 180.
left

Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value is null if the chart data label is not visible.
linkNumberFormat

Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
numberFormat

String value that represents the format code for data label.
position

Value that represents the position of the data label. See Excel.ChartDataLabelPosition for details.
separator

String representing the separator used for the data label on a chart.
showAsStickyCallout

Gets a value that indicates whether the data label is shown as a callout with the tail anchor attached to the data point. If true, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See GeometricShapeType for more details.
showBubbleSize

Specifies if the data label bubble size is visible.
showCategoryName

Specifies if the data label category name is visible.
showLegendKey

Specifies if the data label legend key is visible.
showPercentage

Specifies if the data label percentage is visible.
showSeriesName

Specifies if the data label series name is visible.
showValue

Specifies if the data label value is visible.
text

String representing the text of the data label on a chart.
textOrientation

Represents the angle to which the text is oriented for the chart data label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
top

Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is null if the chart data label is not visible.
verticalAlignment

Represents the vertical alignment of chart data label. See Excel.ChartTextVerticalAlignment for details. This property is valid only when TextOrientation of data label is 0.
width

Returns the width, in points, of the chart data label. Value is null if the chart data label is not visible.

Property Details

autoText

Specifies if the data label automatically generates appropriate text based on context.

autoText?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

format

Represents the format of chart data label.

format?: Excel.Interfaces.ChartDataLabelFormatData;

Property Value

Excel.Interfaces.ChartDataLabelFormatData

Remarks

[ API set: ExcelApi 1.8 ]

formula

String value that represents the formula of chart data label using A1-style notation.

formula?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.8 ]

geometricShapeType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets or sets the geometric shape type of the data label. See Excel.GeometricShapeType for more details. Value is null if the data label is not a geometric shape.

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";

Property Value

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"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

height

Returns the height, in points, of the chart data label. Value is null if the chart data label is not visible.

height?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

horizontalAlignment

Represents the horizontal alignment for chart data label. See Excel.ChartTextHorizontalAlignment for details. This property is valid only when TextOrientation of data label is -90, 90, or 180.

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

Property Value

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

Remarks

[ API set: ExcelApi 1.8 ]

left

Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value is null if the chart data label is not visible.

left?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

linkNumberFormat

Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).

linkNumberFormat?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

numberFormat

String value that represents the format code for data label.

numberFormat?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.8 ]

position

Value that represents the position of the data label. See Excel.ChartDataLabelPosition for details.

position?: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";

Property Value

Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"

Remarks

[ API set: ExcelApi 1.7 ]

separator

String representing the separator used for the data label on a chart.

separator?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.7 ]

showAsStickyCallout

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a value that indicates whether the data label is shown as a callout with the tail anchor attached to the data point. If true, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See GeometricShapeType for more details.

showAsStickyCallout?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

showBubbleSize

Specifies if the data label bubble size is visible.

showBubbleSize?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

showCategoryName

Specifies if the data label category name is visible.

showCategoryName?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

showLegendKey

Specifies if the data label legend key is visible.

showLegendKey?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

showPercentage

Specifies if the data label percentage is visible.

showPercentage?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

showSeriesName

Specifies if the data label series name is visible.

showSeriesName?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

showValue

Specifies if the data label value is visible.

showValue?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

text

String representing the text of the data label on a chart.

text?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.8 ]

textOrientation

Represents the angle to which the text is oriented for the chart data label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.

textOrientation?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

top

Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is null if the chart data label is not visible.

top?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]

verticalAlignment

Represents the vertical alignment of chart data label. See Excel.ChartTextVerticalAlignment for details. This property is valid only when TextOrientation of data label is 0.

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

Property Value

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

Remarks

[ API set: ExcelApi 1.8 ]

width

Returns the width, in points, of the chart data label. Value is null if the chart data label is not visible.

width?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.8 ]