Поделиться через

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", "WedgeRectCallout" или "WedgeEllipseCallout". Дополнительные сведения см. в разделе GeometryShapeType .
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", "WedgeRectCallout" или "WedgeEllipseCallout". Дополнительные сведения см. в разделе GeometryShapeType .

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

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

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

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