Excel.Interfaces.ShapeData interface

  • Ссылка
Пакет:
excel

Интерфейс, описывающий данные, возвращаемые путем вызова shape.toJSON().

Свойства

altTextDescription

Задает замещающий текст описания объекта Shape .
altTextTitle

Задает замещающий текст заголовка Shape для объекта.
connectionSiteCount

Возвращает количество точек соединения на фигуре.
displayName

Возвращает отображаемое имя фигуры. Только что созданная фигура имеет созданное имя, локализованное и не соответствующее ей name. В этом сценарии этот API можно использовать для получения имени, отображаемого в пользовательском интерфейсе.
fill

Возвращает формат заливки фигуры.
geometricShapeType

Указывает тип геометрической фигуры этой геометрической фигуры. Дополнительные сведения см. в этой Excel.GeometricShapeType статье. Возвращает значение null , если тип фигуры не является "GeometryShape".
height

Задает высоту фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.
id

Указывает идентификатор фигуры.
left

Расстояние в пунктах от левого края фигуры до левого края листа. InvalidArgument Создает исключение, если задано отрицательное значение в качестве входных данных.
level

Задает уровень указанной фигуры. Например, уровень 0 означает, что фигура не является частью групп; уровень 1 означает, что фигура является частью группы верхнего уровня; уровень 2 означает, что фигура является частью подгруппы верхнего уровня.
lineFormat

Возвращает формат линии для фигуры.
lockAspectRatio

Указывает, заблокировано ли пропорции этой фигуры.
name

Указывает имя фигуры.
placement

Представляет способ прикрепления объекта к ячейкам под ним.
rotation

Задает поворот фигуры в градусах.
top

Расстояние в пунктах от верхнего края фигуры до верхнего края листа. InvalidArgument Создает исключение, если задано отрицательное значение в качестве входных данных.
type

Возвращает тип фигуры. Дополнительные сведения см. в этой Excel.ShapeType статье.
visible

Указывает, видна ли фигура.
width

Задает ширину фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.
zOrderPosition

Возвращает положение указанной фигуры по оси Z. Значение 0 представляет нижнее положение по оси.

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

altTextDescription

Задает замещающий текст описания объекта Shape .

altTextDescription?: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

altTextTitle

Задает замещающий текст заголовка Shape для объекта.

altTextTitle?: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

connectionSiteCount

Возвращает количество точек соединения на фигуре.

connectionSiteCount?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

displayName

Возвращает отображаемое имя фигуры. Только что созданная фигура имеет созданное имя, локализованное и не соответствующее ей name. В этом сценарии этот API можно использовать для получения имени, отображаемого в пользовательском интерфейсе.

displayName?: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.15 ]

fill

Возвращает формат заливки фигуры.

fill?: Excel.Interfaces.ShapeFillData;

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

Excel.Interfaces.ShapeFillData

Комментарии

[ Набор API: ExcelApi 1.9 ]

geometricShapeType

Указывает тип геометрической фигуры этой геометрической фигуры. Дополнительные сведения см. в этой Excel.GeometricShapeType статье. Возвращает значение null , если тип фигуры не является "GeometryShape".

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.9 ]

height

Задает высоту фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.

height?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

id

Указывает идентификатор фигуры.

id?: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

left

Расстояние в пунктах от левого края фигуры до левого края листа. InvalidArgument Создает исключение, если задано отрицательное значение в качестве входных данных.

left?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

level

Задает уровень указанной фигуры. Например, уровень 0 означает, что фигура не является частью групп; уровень 1 означает, что фигура является частью группы верхнего уровня; уровень 2 означает, что фигура является частью подгруппы верхнего уровня.

level?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

lineFormat

Возвращает формат линии для фигуры.

lineFormat?: Excel.Interfaces.ShapeLineFormatData;

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

Excel.Interfaces.ShapeLineFormatData

Комментарии

[ Набор API: ExcelApi 1.9 ]

lockAspectRatio

Указывает, заблокировано ли пропорции этой фигуры.

lockAspectRatio?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

name

Указывает имя фигуры.

name?: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

placement

Представляет способ прикрепления объекта к ячейкам под ним.

placement?: Excel.Placement | "TwoCell" | "OneCell" | "Absolute";

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

Excel.Placement | "TwoCell" | "OneCell" | "Absolute"

Комментарии

[ Набор API: ExcelApi 1.10 ]

rotation

Задает поворот фигуры в градусах.

rotation?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

top

Расстояние в пунктах от верхнего края фигуры до верхнего края листа. InvalidArgument Создает исключение, если задано отрицательное значение в качестве входных данных.

top?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

type

Возвращает тип фигуры. Дополнительные сведения см. в этой Excel.ShapeType статье.

type?: Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";

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

Excel.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line"

Комментарии

[ Набор API: ExcelApi 1.9 ]

visible

Указывает, видна ли фигура.

visible?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

width

Задает ширину фигуры (в точках). InvalidArgument Создает исключение, если задано отрицательное значение или ноль в качестве входных данных.

width?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

zOrderPosition

Возвращает положение указанной фигуры по оси Z. Значение 0 представляет нижнее положение по оси.

zOrderPosition?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]