Excel.ChartDataLabels class

Пакет:
excel

Представляет коллекцию всех меток данных в точке диаграммы.

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: ExcelApi 1.1

Используется

Свойства

autoText

Указывает, автоматически ли метки данных создают соответствующий текст на основе контекста.
context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
format

Формат меток данных диаграммы, включая заливку и шрифт.
geometricShapeType

Определяет тип геометрической формы меток данных. Дополнительные сведения см. в разделе Excel.GeometricShapeType. Значение в том случае, null если метки данных не являются геометрическими фигурами.
horizontalAlignment

Выравнивание по горизонтали для меток данных диаграммы. См. Excel.ChartTextHorizontalAlignment дополнительные сведения. Это свойство допустимо только в том случае, если TextOrientation метка данных равна 0.
leaderLines

Получает объект, представляющий линии выноски меток данных.
linkNumberFormat

Указывает, связан ли числовой формат с ячейками. Если true, то числовой формат будет изменяться в метках при изменении в ячейках.
numberFormat

Задает код формата для меток данных.
position

Значение, определяющее положение метки данных. См. Excel.ChartDataLabelPosition дополнительные сведения.
separator

Строка, представляющая разделитель, который используется для меток данных на диаграмме.
showAsStickyCallout

Указывает, отображаются ли метки данных в виде выноски с хвостовой привязкой, прикрепленной к точке данных. Если true, выноска имеет одно из следующих значений: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" или "WedgeEllipseCallout". Смотрите GeometricShapeType для получения более подробной информации.
showBubbleSize

Указывает, виден ли размер пузырька метки данных.
showCategoryName

Указывает, отображается ли имя категории меток данных.
showLeaderLines

Указывает, отображаются ли линии выноски для меток данных. true если отображаются линии выноски; в противном случае, false.
showLegendKey

Указывает, виден ли ключ легенды метки данных.
showPercentage

Указывает, отображается ли процент метки данных.
showSeriesName

Указывает, отображается ли имя ряда меток данных.
showValue

Указывает, видимо ли значение метки данных.
textOrientation

Указывает угол, под которым текст ориентирован для меток данных. Значение должно быть либо целым числом от -90 до 90, либо целым числом 180 для вертикально ориентированного текста.
verticalAlignment

Представляет вертикальное выравнивание для метки данных диаграммы. См. Excel.ChartTextVerticalAlignment дополнительные сведения. Это свойство допустимо только в том случае, если TextOrientation метка данных имеет значение -90, 90 или 180.

Методы

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartDataLabels объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ChartDataLabelsData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

Сведения о свойстве

autoText

Указывает, автоматически ли метки данных создают соответствующий текст на основе контекста.

autoText: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.8

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

format

Формат меток данных диаграммы, включая заливку и шрифт.

readonly format: Excel.ChartDataLabelFormat;

Значение свойства

Excel.ChartDataLabelFormat

Комментарии

Набор API: ExcelApi 1.1

geometricShapeType

Определяет тип геометрической формы меток данных. Дополнительные сведения см. в разделе Excel.GeometricShapeType. Значение в том случае, null если метки данных не являются геометрическими фигурами.

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

Значение свойства

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"

Комментарии

Набор API: ExcelApi 1.19

horizontalAlignment

Выравнивание по горизонтали для меток данных диаграммы. См. Excel.ChartTextHorizontalAlignment дополнительные сведения. Это свойство допустимо только в том случае, если TextOrientation метка данных равна 0.

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

Значение свойства

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

Комментарии

Набор API: ExcelApi 1.8

leaderLines

Получает объект, представляющий линии выноски меток данных.

readonly leaderLines: Excel.ChartLeaderLines;

Значение свойства

Excel.ChartLeaderLines

Комментарии

Набор API: ExcelApi 1.19

linkNumberFormat

Указывает, связан ли числовой формат с ячейками. Если true, то числовой формат будет изменяться в метках при изменении в ячейках.

linkNumberFormat: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.9

numberFormat

Задает код формата для меток данных.

numberFormat: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.8

position

Значение, определяющее положение метки данных. См. Excel.ChartDataLabelPosition дополнительные сведения.

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

Значение свойства

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

Комментарии

Набор API: ExcelApi 1.1

separator

Строка, представляющая разделитель, который используется для меток данных на диаграмме.

separator: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.1

showAsStickyCallout

Указывает, отображаются ли метки данных в виде выноски с хвостовой привязкой, прикрепленной к точке данных. Если true, выноска имеет одно из следующих значений: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" или "WedgeEllipseCallout". Смотрите GeometricShapeType для получения более подробной информации.

readonly showAsStickyCallout: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.19

showBubbleSize

Указывает, виден ли размер пузырька метки данных.

showBubbleSize: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.1

showCategoryName

Указывает, отображается ли имя категории меток данных.

showCategoryName: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.1

showLeaderLines

Указывает, отображаются ли линии выноски для меток данных. true если отображаются линии выноски; в противном случае, false.

showLeaderLines: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.19

showLegendKey

Указывает, виден ли ключ легенды метки данных.

showLegendKey: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.1

showPercentage

Указывает, отображается ли процент метки данных.

showPercentage: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.1

showSeriesName

Указывает, отображается ли имя ряда меток данных.

showSeriesName: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.1

showValue

Указывает, видимо ли значение метки данных.

showValue: boolean;

Значение свойства

boolean

Комментарии

Набор API: ExcelApi 1.1

textOrientation

Указывает угол, под которым текст ориентирован для меток данных. Значение должно быть либо целым числом от -90 до 90, либо целым числом 180 для вертикально ориентированного текста.

textOrientation: number;

Значение свойства

number

Комментарии

Набор API: ExcelApi 1.8

verticalAlignment

Представляет вертикальное выравнивание для метки данных диаграммы. См. Excel.ChartTextVerticalAlignment дополнительные сведения. Это свойство допустимо только в том случае, если TextOrientation метка данных имеет значение -90, 90 или 180.

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

Значение свойства

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

Комментарии

Набор API: ExcelApi 1.8

Сведения о методе

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;

Параметры

options
Excel.Interfaces.ChartDataLabelsLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Excel.ChartDataLabels

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.ChartDataLabels;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Excel.ChartDataLabels

Примеры

// 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)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartDataLabels;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Excel.ChartDataLabels

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.ChartDataLabelsUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties
Excel.Interfaces.ChartDataLabelsUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options
OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

Возвращаемое значение

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Excel.ChartDataLabels): void;

Параметры

properties
Excel.ChartDataLabels

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartDataLabels объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ChartDataLabelsData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Excel.Interfaces.ChartDataLabelsData;

Возвращаемое значение

Excel.Interfaces.ChartDataLabelsData