Excel.ChartDataLabel class
Представляет метку данных точки диаграммы.
- Extends
Комментарии
Свойства
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", "WedgeRectCallout" или "WedgeEllipseCallout". Дополнительные сведения см. в разделе GeometryShapeType .
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
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
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;