Excel.ChartDataLabel class
Представляет метку данных точки диаграммы.
- Extends
Комментарии
Используется
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
// This function styles substrings within data label text using font formatting.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem(sheetName);
const chart = sheet.charts.getItemAt(0);
await context.sync();
const series = chart.series.getItemAt(0);
series.load("points");
await context.sync();
series.points.load("items");
await context.sync();
// Style a substring in the first data label.
let searchString = "sports";
let dataLabel = series.points.getItemAt(dataLabelInfo[0].index).dataLabel.load("text");
await context.sync();
let substringStart = dataLabel.text.indexOf(searchString);
let subLabel = dataLabel.getSubstring(substringStart, searchString.length);
subLabel.font.size = 13;
subLabel.font.bold = true;
// Style a substring in the second data label.
searchString = "'Titanic'";
dataLabel = series.points.getItemAt(dataLabelInfo[1].index).dataLabel.load("text");
await context.sync();
substringStart = dataLabel.text.indexOf(searchString);
subLabel = dataLabel.getSubstring(substringStart, searchString.length);
subLabel.font.name = "Calibri";
subLabel.font.size = 13;
subLabel.font.italic = true;
subLabel.font.color = "blue";
await context.sync();
});
Свойства
| auto |
Указывает, автоматически ли метка данных создает соответствующий текст на основе контекста. |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| format | Представляет формат метки данных диаграммы. |
| formula | Строковое значение, представляющее формулу метки данных диаграммы с использованием нотации стиля A1. |
| geometric |
Определяет тип геометрической фигуры метки данных. Дополнительные сведения см. в разделе |
| height | Возвращает высоту метки данных диаграммы (в пунктах). Значение, |
| horizontal |
Представляет горизонтальное выравнивание для метки данных диаграммы. См. |
| left | Представляет расстояние от левого края метки данных диаграммы до левого края области диаграммы (в пунктах). Значение, |
| link |
Указывает, связан ли числовой формат с ячейками (таким образом, числовой формат изменяется в метках при изменении в ячейках). |
| number |
Указывает код формата для метки данных. |
| position | Значение, определяющее положение метки данных. См. |
| separator | Строка, представляющая разделитель для метки данных на диаграмме. |
| show |
Указывает, отображается ли метка данных в виде выноски с хвостовой привязкой, прикрепленной к точке данных. Если |
| show |
Указывает, виден ли размер пузырька метки данных. |
| show |
Указывает, отображается ли имя категории меток данных. |
| show |
Указывает, виден ли ключ легенды метки данных. |
| show |
Указывает, отображается ли процент метки данных. |
| show |
Указывает, отображается ли имя ряда меток данных. |
| show |
Указывает, видимо ли значение метки данных. |
| text | Строка, представляющая текст метки данных на диаграмме. |
| text |
Указывает угол, под которым ориентирован текст для метки данных диаграммы. Значение должно быть либо целым числом от -90 до 90, либо целым числом 180 для вертикально ориентированного текста. |
| top | Представляет расстояние от верхнего края метки данных диаграммы до верха области диаграммы (в пунктах). Значение, |
| vertical |
Представляет вертикальное выравнивание для метки данных диаграммы. См. |
| width | Возвращает ширину метки данных диаграммы (в пунктах). Значение, |
Методы
| get |
Возвращает подстроку метки данных. Символ разрыва строки "\n" считается за один символ. |
| get |
Возвращает хвостовую привязку метки данных, которая отображается в виде прикрепленной выноски. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| set |
Высота метки данных в точках. |
| set |
Ширина метки данных в точках. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
autoText
Указывает, автоматически ли метка данных создает соответствующий текст на основе контекста.
autoText: boolean;Значение свойства
boolean
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
format
Представляет формат метки данных диаграммы.
readonly format: Excel.ChartDataLabelFormat;Значение свойства
Комментарии
formula
Строковое значение, представляющее формулу метки данных диаграммы с использованием нотации стиля A1.
formula: string;Значение свойства
string
Комментарии
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"
Комментарии
height
Возвращает высоту метки данных диаграммы (в пунктах). Значение, null если подпись данных диаграммы не отображается.
readonly height: number;Значение свойства
number
Комментарии
horizontalAlignment
Представляет горизонтальное выравнивание для метки данных диаграммы. См. Excel.ChartTextHorizontalAlignment дополнительные сведения. Это свойство допустимо только в том случае, если TextOrientation метка данных имеет значение -90, 90 или 180.
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";Значение свойства
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
Комментарии
left
Представляет расстояние от левого края метки данных диаграммы до левого края области диаграммы (в пунктах). Значение, null если подпись данных диаграммы не отображается.
left: number;Значение свойства
number
Комментарии
linkNumberFormat
Указывает, связан ли числовой формат с ячейками (таким образом, числовой формат изменяется в метках при изменении в ячейках).
linkNumberFormat: boolean;Значение свойства
boolean
Комментарии
numberFormat
Указывает код формата для метки данных.
numberFormat: string;Значение свойства
string
Комментарии
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"
Комментарии
separator
Строка, представляющая разделитель для метки данных на диаграмме.
separator: string;Значение свойства
string
Комментарии
showAsStickyCallout
Указывает, отображается ли метка данных в виде выноски с хвостовой привязкой, прикрепленной к точке данных. Если true, выноска имеет одно из следующих значений: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" или "WedgeEllipseCallout". Смотрите GeometricShapeType для получения более подробной информации.
readonly showAsStickyCallout: boolean;Значение свойства
boolean
Комментарии
showBubbleSize
Указывает, виден ли размер пузырька метки данных.
showBubbleSize: boolean;Значение свойства
boolean
Комментарии
showCategoryName
Указывает, отображается ли имя категории меток данных.
showCategoryName: boolean;Значение свойства
boolean
Комментарии
showLegendKey
Указывает, виден ли ключ легенды метки данных.
showLegendKey: boolean;Значение свойства
boolean
Комментарии
showPercentage
Указывает, отображается ли процент метки данных.
showPercentage: boolean;Значение свойства
boolean
Комментарии
showSeriesName
Указывает, отображается ли имя ряда меток данных.
showSeriesName: boolean;Значение свойства
boolean
Комментарии
showValue
Указывает, видимо ли значение метки данных.
showValue: boolean;Значение свойства
boolean
Комментарии
text
Строка, представляющая текст метки данных на диаграмме.
text: string;Значение свойства
string
Комментарии
textOrientation
Указывает угол, под которым ориентирован текст для метки данных диаграммы. Значение должно быть либо целым числом от -90 до 90, либо целым числом 180 для вертикально ориентированного текста.
textOrientation: number;Значение свойства
number
Комментарии
top
Представляет расстояние от верхнего края метки данных диаграммы до верха области диаграммы (в пунктах). Значение, null если подпись данных диаграммы не отображается.
top: number;Значение свойства
number
Комментарии
verticalAlignment
Представляет вертикальное выравнивание для метки данных диаграммы. См. Excel.ChartTextVerticalAlignment дополнительные сведения. Это свойство допустимо только в том случае, если TextOrientation метка данных равна 0.
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";Значение свойства
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Комментарии
width
Возвращает ширину метки данных диаграммы (в пунктах). Значение, null если подпись данных диаграммы не отображается.
readonly width: number;Значение свойства
number
Комментарии
Сведения о методе
getSubstring(start, length)
Возвращает подстроку метки данных. Символ разрыва строки "\n" считается за один символ.
getSubstring(start: number, length?: number): Excel.ChartFormatString;Параметры
- start
-
number
Начальная позиция подстроки в метке данных, отсчитывающая от нуля.
- length
-
number
Необязательный параметр. Количество знаков в подстроке. Если значение аргумента "длина" опущено, возвращаются все знаки от начала до конца метки данных.
Возвращаемое значение
Комментарии
getTailAnchor()
Возвращает хвостовую привязку метки данных, которая отображается в виде прикрепленной выноски.
getTailAnchor(): Excel.ChartDataLabelAnchor;Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ChartDataLabel;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartDataLabel;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.ChartDataLabelUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.ChartDataLabel): void;Параметры
- properties
- Excel.ChartDataLabel
Возвращаемое значение
void
setHeight(height)
Высота метки данных в точках.
setHeight(height: number): void;Параметры
- height
-
number
Высота метки данных в точках.
Возвращаемое значение
void
Комментарии
setWidth(width)
Ширина метки данных в точках.
setWidth(width: number): void;Параметры
- width
-
number
Ширина метки данных в точках.
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ChartDataLabel объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ChartDataLabelData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.ChartDataLabelData;