From 50dfecbab3317e357154131df64a2a1a07ee76af Mon Sep 17 00:00:00 2001 From: Jake Bailey <5341706+jakebailey@users.noreply.github.com> Date: Fri, 12 Dec 2025 09:26:53 -0800 Subject: [PATCH 1/3] [jqrangeslider] work around 6.0 change (#74213) --- types/jqrangeslider/jqrangeslider-tests.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/jqrangeslider/jqrangeslider-tests.ts b/types/jqrangeslider/jqrangeslider-tests.ts index 4110018ef3d31f..19c0dfe1bc7b56 100644 --- a/types/jqrangeslider/jqrangeslider-tests.ts +++ b/types/jqrangeslider/jqrangeslider-tests.ts @@ -158,7 +158,7 @@ $("#rulersExample").rangeSlider({ return false; }, label: function() { - return null; + return ""; }, }, ], From aae393a5fa464d103f8df32bc96d57262104d625 Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Fri, 12 Dec 2025 10:13:51 -0800 Subject: [PATCH 2/3] [office-js] [office-js-preview] (Word) Updates from CDN (#74210) --- types/office-js-preview/index.d.ts | 204 ++++++++++++++--------------- types/office-js/index.d.ts | 200 ++++++++++++++-------------- 2 files changed, 202 insertions(+), 202 deletions(-) diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 28655ba690b559..c8c50c1188cb5e 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -102965,7 +102965,7 @@ declare namespace Word { }; } /** - * The data specific to content controls of type CheckBox. + * Represents the data specific to content controls of type `CheckBox`. * * @remarks * [Api set: WordApi 1.7] @@ -109036,7 +109036,7 @@ declare namespace Word { toJSON(): Word.Interfaces.DocumentData; } /** - * The `DocumentCreated` object is the top level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. + * The `DocumentCreated` object is the top-level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. * * @remarks * [Api set: WordApi 1.3] @@ -109427,7 +109427,7 @@ declare namespace Word { toJSON(): Word.Interfaces.DocumentPropertiesData; } /** - * The data specific to content controls of type `dropDownList`. + * Represents the data specific to content controls of type `dropDownList`. * * @remarks * [Api set: WordApi 1.9] @@ -109490,7 +109490,7 @@ declare namespace Word { toJSON(): Word.Interfaces.DropDownListContentControlData; } /** - * The data specific to content controls of type `comboBox`. + * Represents the data specific to content controls of type `comboBox`. * * @remarks * [Api set: WordApi 1.9] @@ -120771,7 +120771,7 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -120841,21 +120841,21 @@ declare namespace Word { */ altTextDescription: string; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ geometricShapeType: Word.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"; /** - * The height, in points, of the shape. + * Specifies the height, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ height: number; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -120876,14 +120876,14 @@ declare namespace Word { */ readonly isChild: boolean; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ left: number; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -120897,35 +120897,35 @@ declare namespace Word { */ lockAspectRatio: boolean; /** - * The name of the shape. + * Specifies the name of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ name: string; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -120939,14 +120939,14 @@ declare namespace Word { */ rotation: number; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ top: number; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -120967,14 +120967,14 @@ declare namespace Word { */ visible: boolean; /** - * The width, in points, of the shape. + * Specifies the width, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ width: number; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -124879,7 +124879,7 @@ declare namespace Word { */ interface ContentControlAddedEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -124893,7 +124893,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -124908,7 +124908,7 @@ declare namespace Word { */ interface ContentControlDataChangedEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -124922,7 +124922,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -124937,7 +124937,7 @@ declare namespace Word { */ interface ContentControlDeletedEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -124951,7 +124951,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -124966,7 +124966,7 @@ declare namespace Word { */ interface ContentControlEnteredEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -124980,7 +124980,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -124995,7 +124995,7 @@ declare namespace Word { */ interface ContentControlExitedEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -125009,7 +125009,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -125110,7 +125110,7 @@ declare namespace Word { */ interface ContentControlSelectionChangedEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -125124,7 +125124,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -125139,14 +125139,14 @@ declare namespace Word { */ interface ParagraphAddedEventArgs { /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.6] */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -125168,14 +125168,14 @@ declare namespace Word { */ interface ParagraphChangedEventArgs { /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.6] */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -125197,14 +125197,14 @@ declare namespace Word { */ interface ParagraphDeletedEventArgs { /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.6] */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -125243,7 +125243,7 @@ declare namespace Word { */ commentDetails: Word.CommentDetail[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -125251,7 +125251,7 @@ declare namespace Word { */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -126329,7 +126329,7 @@ declare namespace Word { mixed = "Mixed", } /** - * The {@link Word.Border | border} types. + * Represents the {@link Word.Border | border} type. * * @remarks * [Api set: WordApi 1.3] @@ -151789,7 +151789,7 @@ declare namespace Word { /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ interface ShapeUpdateData { /** - * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -151859,35 +151859,35 @@ declare namespace Word { */ altTextDescription?: string; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ geometricShapeType?: Word.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"; /** - * The height, in points, of the shape. + * Specifies the height, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ height?: number; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ heightRelative?: number; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ left?: number; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -151901,35 +151901,35 @@ declare namespace Word { */ lockAspectRatio?: boolean; /** - * The name of the shape. + * Specifies the name of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ name?: string; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -151943,14 +151943,14 @@ declare namespace Word { */ rotation?: number; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ top?: number; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -151964,14 +151964,14 @@ declare namespace Word { */ visible?: boolean; /** - * The width, in points, of the shape. + * Specifies the width, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ width?: number; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -159664,7 +159664,7 @@ declare namespace Word { /** An interface describing the data returned by calling `shape.toJSON()`. */ interface ShapeData { /** - * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -159734,21 +159734,21 @@ declare namespace Word { */ altTextDescription?: string; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ geometricShapeType?: Word.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"; /** - * The height, in points, of the shape. + * Specifies the height, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ height?: number; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -159769,14 +159769,14 @@ declare namespace Word { */ isChild?: boolean; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ left?: number; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -159790,35 +159790,35 @@ declare namespace Word { */ lockAspectRatio?: boolean; /** - * The name of the shape. + * Specifies the name of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ name?: string; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -159832,14 +159832,14 @@ declare namespace Word { */ rotation?: number; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ top?: number; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -159860,14 +159860,14 @@ declare namespace Word { */ visible?: boolean; /** - * The width, in points, of the shape. + * Specifies the width, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ width?: number; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163103,7 +163103,7 @@ declare namespace Word { name?: boolean; } /** - * The data specific to content controls of type CheckBox. + * Represents the data specific to content controls of type `CheckBox`. * * @remarks * [Api set: WordApi 1.7] @@ -165651,7 +165651,7 @@ declare namespace Word { xmlSaveThroughXslt?: boolean; } /** - * The `DocumentCreated` object is the top level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. + * The `DocumentCreated` object is the top-level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. * * @remarks * [Api set: WordApi 1.3] @@ -172396,7 +172396,7 @@ declare namespace Word { */ $all?: boolean; /** - * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -172466,21 +172466,21 @@ declare namespace Word { */ altTextDescription?: boolean; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ geometricShapeType?: boolean; /** - * The height, in points, of the shape. + * Specifies the height, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ height?: boolean; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -172501,14 +172501,14 @@ declare namespace Word { */ isChild?: boolean; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ left?: boolean; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -172522,35 +172522,35 @@ declare namespace Word { */ lockAspectRatio?: boolean; /** - * The name of the shape. + * Specifies the name of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ name?: boolean; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: boolean; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalSize?: boolean; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: boolean; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -172564,14 +172564,14 @@ declare namespace Word { */ rotation?: boolean; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ top?: boolean; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -172592,14 +172592,14 @@ declare namespace Word { */ visible?: boolean; /** - * The width, in points, of the shape. + * Specifies the width, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ width?: boolean; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -172670,7 +172670,7 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * For EACH ITEM in the collection: Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -172740,21 +172740,21 @@ declare namespace Word { */ altTextDescription?: boolean; /** - * For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape. + * For EACH ITEM in the collection: Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ geometricShapeType?: boolean; /** - * For EACH ITEM in the collection: The height, in points, of the shape. + * For EACH ITEM in the collection: Specifies the height, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ height?: boolean; /** - * For EACH ITEM in the collection: The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * For EACH ITEM in the collection: Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -172775,14 +172775,14 @@ declare namespace Word { */ isChild?: boolean; /** - * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * For EACH ITEM in the collection: Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ left?: boolean; /** - * For EACH ITEM in the collection: The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * For EACH ITEM in the collection: Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -172796,35 +172796,35 @@ declare namespace Word { */ lockAspectRatio?: boolean; /** - * For EACH ITEM in the collection: The name of the shape. + * For EACH ITEM in the collection: Specifies the name of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ name?: boolean; /** - * For EACH ITEM in the collection: The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * For EACH ITEM in the collection: Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: boolean; /** - * For EACH ITEM in the collection: The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * For EACH ITEM in the collection: Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalSize?: boolean; /** - * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * For EACH ITEM in the collection: Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: boolean; /** - * For EACH ITEM in the collection: The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * For EACH ITEM in the collection: Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -172838,14 +172838,14 @@ declare namespace Word { */ rotation?: boolean; /** - * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * For EACH ITEM in the collection: Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ top?: boolean; /** - * For EACH ITEM in the collection: The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * For EACH ITEM in the collection: Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -172866,14 +172866,14 @@ declare namespace Word { */ visible?: boolean; /** - * For EACH ITEM in the collection: The width, in points, of the shape. + * For EACH ITEM in the collection: Specifies the width, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ width?: boolean; /** - * For EACH ITEM in the collection: The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * For EACH ITEM in the collection: Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 0585ec0dc78763..1f0845eb108cd2 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -96574,7 +96574,7 @@ declare namespace Word { }; } /** - * The data specific to content controls of type CheckBox. + * Represents the data specific to content controls of type `CheckBox`. * * @remarks * [Api set: WordApi 1.7] @@ -102101,7 +102101,7 @@ declare namespace Word { toJSON(): Word.Interfaces.DocumentData; } /** - * The `DocumentCreated` object is the top level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. + * The `DocumentCreated` object is the top-level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. * * @remarks * [Api set: WordApi 1.3] @@ -102492,7 +102492,7 @@ declare namespace Word { toJSON(): Word.Interfaces.DocumentPropertiesData; } /** - * The data specific to content controls of type `dropDownList`. + * Represents the data specific to content controls of type `dropDownList`. * * @remarks * [Api set: WordApi 1.9] @@ -102555,7 +102555,7 @@ declare namespace Word { toJSON(): Word.Interfaces.DropDownListContentControlData; } /** - * The data specific to content controls of type `comboBox`. + * Represents the data specific to content controls of type `comboBox`. * * @remarks * [Api set: WordApi 1.9] @@ -113712,7 +113712,7 @@ declare namespace Word { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -113782,21 +113782,21 @@ declare namespace Word { */ altTextDescription: string; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ geometricShapeType: Word.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"; /** - * The height, in points, of the shape. + * Specifies the height, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ height: number; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -113817,14 +113817,14 @@ declare namespace Word { */ readonly isChild: boolean; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ left: number; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -113838,35 +113838,35 @@ declare namespace Word { */ lockAspectRatio: boolean; /** - * The name of the shape. + * Specifies the name of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ name: string; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -113880,14 +113880,14 @@ declare namespace Word { */ rotation: number; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ top: number; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -113908,14 +113908,14 @@ declare namespace Word { */ visible: boolean; /** - * The width, in points, of the shape. + * Specifies the width, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ width: number; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -117731,7 +117731,7 @@ declare namespace Word { */ interface ContentControlAddedEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -117745,7 +117745,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -117760,7 +117760,7 @@ declare namespace Word { */ interface ContentControlDataChangedEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -117774,7 +117774,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -117789,7 +117789,7 @@ declare namespace Word { */ interface ContentControlDeletedEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -117803,7 +117803,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -117818,7 +117818,7 @@ declare namespace Word { */ interface ContentControlEnteredEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -117832,7 +117832,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -117847,7 +117847,7 @@ declare namespace Word { */ interface ContentControlExitedEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -117861,7 +117861,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -117962,7 +117962,7 @@ declare namespace Word { */ interface ContentControlSelectionChangedEventArgs { /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.5] @@ -117976,7 +117976,7 @@ declare namespace Word { */ ids: number[]; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.5] @@ -117991,14 +117991,14 @@ declare namespace Word { */ interface ParagraphAddedEventArgs { /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.6] */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -118020,14 +118020,14 @@ declare namespace Word { */ interface ParagraphChangedEventArgs { /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.6] */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -118049,14 +118049,14 @@ declare namespace Word { */ interface ParagraphDeletedEventArgs { /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the source of the event. It can be local or remote (through coauthoring). * * @remarks * [Api set: WordApi 1.6] */ source: Word.EventSource | "Local" | "Remote"; /** - * The event type. See `Word.EventType` for details. + * Specifies the event type. See `Word.EventType` for details. * * @remarks * [Api set: WordApi 1.6] @@ -119027,7 +119027,7 @@ declare namespace Word { mixed = "Mixed", } /** - * The {@link Word.Border | border} types. + * Represents the {@link Word.Border | border} type. * * @remarks * [Api set: WordApi 1.3] @@ -143056,7 +143056,7 @@ declare namespace Word { /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ interface ShapeUpdateData { /** - * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -143126,35 +143126,35 @@ declare namespace Word { */ altTextDescription?: string; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ geometricShapeType?: Word.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"; /** - * The height, in points, of the shape. + * Specifies the height, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ height?: number; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ heightRelative?: number; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ left?: number; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -143168,35 +143168,35 @@ declare namespace Word { */ lockAspectRatio?: boolean; /** - * The name of the shape. + * Specifies the name of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ name?: string; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -143210,14 +143210,14 @@ declare namespace Word { */ rotation?: number; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ top?: number; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -143231,14 +143231,14 @@ declare namespace Word { */ visible?: boolean; /** - * The width, in points, of the shape. + * Specifies the width, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ width?: number; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -150836,7 +150836,7 @@ declare namespace Word { /** An interface describing the data returned by calling `shape.toJSON()`. */ interface ShapeData { /** - * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -150906,21 +150906,21 @@ declare namespace Word { */ altTextDescription?: string; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ geometricShapeType?: Word.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"; /** - * The height, in points, of the shape. + * Specifies the height, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ height?: number; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -150941,14 +150941,14 @@ declare namespace Word { */ isChild?: boolean; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ left?: number; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -150962,35 +150962,35 @@ declare namespace Word { */ lockAspectRatio?: boolean; /** - * The name of the shape. + * Specifies the name of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ name?: string; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -151004,14 +151004,14 @@ declare namespace Word { */ rotation?: number; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ top?: number; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -151032,14 +151032,14 @@ declare namespace Word { */ visible?: boolean; /** - * The width, in points, of the shape. + * Specifies the width, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ width?: number; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -154251,7 +154251,7 @@ declare namespace Word { name?: boolean; } /** - * The data specific to content controls of type CheckBox. + * Represents the data specific to content controls of type `CheckBox`. * * @remarks * [Api set: WordApi 1.7] @@ -156693,7 +156693,7 @@ declare namespace Word { xmlSaveThroughXslt?: boolean; } /** - * The `DocumentCreated` object is the top level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. + * The `DocumentCreated` object is the top-level object created by `Application.createDocument`. A `DocumentCreated` object is a special `Document` object. * * @remarks * [Api set: WordApi 1.3] @@ -163390,7 +163390,7 @@ declare namespace Word { */ $all?: boolean; /** - * Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163460,21 +163460,21 @@ declare namespace Word { */ altTextDescription?: boolean; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ geometricShapeType?: boolean; /** - * The height, in points, of the shape. + * Specifies the height, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ height?: boolean; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163495,14 +163495,14 @@ declare namespace Word { */ isChild?: boolean; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ left?: boolean; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163516,35 +163516,35 @@ declare namespace Word { */ lockAspectRatio?: boolean; /** - * The name of the shape. + * Specifies the name of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ name?: boolean; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: boolean; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalSize?: boolean; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: boolean; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163558,14 +163558,14 @@ declare namespace Word { */ rotation?: boolean; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ top?: boolean; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163586,14 +163586,14 @@ declare namespace Word { */ visible?: boolean; /** - * The width, in points, of the shape. + * Specifies the width, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ width?: boolean; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163664,7 +163664,7 @@ declare namespace Word { */ $all?: boolean; /** - * For EACH ITEM in the collection: Represents the `Body` object of the shape. Only applies to text boxes and geometric shapes. + * For EACH ITEM in the collection: Gets the `Body` object of the shape. Only applies to text boxes and geometric shapes. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163734,21 +163734,21 @@ declare namespace Word { */ altTextDescription?: boolean; /** - * For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape. + * For EACH ITEM in the collection: Specifies the geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ geometricShapeType?: boolean; /** - * For EACH ITEM in the collection: The height, in points, of the shape. + * For EACH ITEM in the collection: Specifies the height, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ height?: boolean; /** - * For EACH ITEM in the collection: The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * For EACH ITEM in the collection: Specifies the percentage of shape height to the relative vertical size (that is, the `relativeVerticalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163769,14 +163769,14 @@ declare namespace Word { */ isChild?: boolean; /** - * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * For EACH ITEM in the collection: Specifies the distance, in points, from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ left?: boolean; /** - * For EACH ITEM in the collection: The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * For EACH ITEM in the collection: Specifies the relative left position as a percentage from the left side of the shape to the relative horizontal position (that is, the `relativeHorizontalalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163790,35 +163790,35 @@ declare namespace Word { */ lockAspectRatio?: boolean; /** - * For EACH ITEM in the collection: The name of the shape. + * For EACH ITEM in the collection: Specifies the name of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ name?: boolean; /** - * For EACH ITEM in the collection: The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * For EACH ITEM in the collection: Specifies the relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalPosition?: boolean; /** - * For EACH ITEM in the collection: The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * For EACH ITEM in the collection: Specifies the relative horizontal size of the shape. Use with the `widthRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeHorizontalSize?: boolean; /** - * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * For EACH ITEM in the collection: Specifies the relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks * [Api set: WordApiDesktop 1.2] */ relativeVerticalPosition?: boolean; /** - * For EACH ITEM in the collection: The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * For EACH ITEM in the collection: Specifies the relative vertical size of the shape. Use with the `heightRelative` property. For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163832,14 +163832,14 @@ declare namespace Word { */ rotation?: boolean; /** - * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * For EACH ITEM in the collection: Specifies the distance, in points, from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks * [Api set: WordApiDesktop 1.2] */ top?: boolean; /** - * For EACH ITEM in the collection: The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * For EACH ITEM in the collection: Specifies the relative top position as a percentage from the top edge of the shape to the relative vertical position (that is, the `relativeVerticalPosition` property). For an inline or child shape, it will return 0 and can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] @@ -163860,14 +163860,14 @@ declare namespace Word { */ visible?: boolean; /** - * For EACH ITEM in the collection: The width, in points, of the shape. + * For EACH ITEM in the collection: Specifies the width, in points, of the shape. * * @remarks * [Api set: WordApiDesktop 1.2] */ width?: boolean; /** - * For EACH ITEM in the collection: The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * For EACH ITEM in the collection: Specifies the percentage of shape width to the relative horizontal size (that is, the `relativeHorizontalSize` property). For an inline or child shape, it can't be set. * * @remarks * [Api set: WordApiDesktop 1.2] From becfc1c0a5972cb800776d56d075e11e3b11b882 Mon Sep 17 00:00:00 2001 From: mertushka Date: Fri, 12 Dec 2025 23:29:56 +0200 Subject: [PATCH 3/3] =?UTF-8?q?=F0=9F=A4=96=20Merge=20PR=20#74207=20[haxba?= =?UTF-8?q?ll-headless-browser]=20fix:=20return=20types,=20missing=20trait?= =?UTF-8?q?s=20and=20add=20proper=20jsdoc=20documentation=20by=20@mertushk?= =?UTF-8?q?a?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../haxball-headless-browser-tests.ts | 8 + types/haxball-headless-browser/index.d.ts | 639 ++++++++++++++++-- types/haxball-headless-browser/package.json | 2 +- 3 files changed, 602 insertions(+), 47 deletions(-) diff --git a/types/haxball-headless-browser/haxball-headless-browser-tests.ts b/types/haxball-headless-browser/haxball-headless-browser-tests.ts index 8d67bdba8305c8..7406ddbcbb740e 100644 --- a/types/haxball-headless-browser/haxball-headless-browser-tests.ts +++ b/types/haxball-headless-browser/haxball-headless-browser-tests.ts @@ -15,3 +15,11 @@ room.onPlayerJoin = p => { room.setPlayerAvatar(p.id, null); room.setCustomStadium(JSON.stringify(customStadium)); }; + +room.onPlayerChat = (player, message) => { + if (message === "!admin") { + room.setPlayerAdmin(player.id, true); + return false; // Filter the message + } + // Return nothing (void) to allow the message +}; diff --git a/types/haxball-headless-browser/index.d.ts b/types/haxball-headless-browser/index.d.ts index 6c7d6186fb54ff..cc15b857ff69c9 100644 --- a/types/haxball-headless-browser/index.d.ts +++ b/types/haxball-headless-browser/index.d.ts @@ -1,273 +1,820 @@ +/* eslint-disable @typescript-eslint/no-invalid-void-type */ + +/** + * Initializes a Haxball headless room with the specified configuration. + * @param roomConfig - Configuration object for the room. All properties are optional. + * @returns The room object used to control the room. + * @example + * ```js + * var room = HBInit({ + * roomName: "My room", + * maxPlayers: 16, + * noPlayer: true // Remove host player (recommended!) + * }); + * room.setDefaultStadium("Big"); + * room.setScoreLimit(5); + * room.setTimeLimit(0); + * ``` + */ declare function HBInit(roomConfig: RoomConfigObject): RoomObject; +/** + * Configuration object for initializing a Haxball room. + * All properties are optional. + */ interface RoomConfigObject { + /** The name for the room. */ roomName?: string; + /** The name for the host player. */ playerName?: string; + /** The password for the room (no password if omitted). */ password?: string; + /** Max number of players the room accepts. */ maxPlayers?: number; + /** If true the room will appear in the room list. */ public?: boolean; - geo?: { "code": string; "lat": number; "lon": number }; + /** GeoLocation override for the room. */ + geo?: { code: string; lat: number; lon: number }; + /** Token that can be obtained from https://www.haxball.com/headlesstoken to skip recaptcha. These tokens expire after a few minutes. */ token?: string; + /** + * If set to true the room player list will be empty, the playerName setting will be ignored. + * Default value is false but it's recommended to set this to true. + * @warning Events will have null as the byPlayer argument when the event is caused by the host. + */ noPlayer?: boolean; } -declare class RoomObject { - sendChat(msg: string, targetId: number): void; - +/** + * Main interface for controlling the room and listening to its events. + * @note All API functions that modify the game's state execute asynchronously. + */ +interface RoomObject { + /** + * Sends a chat message using the host player. + * @param msg - The message to send. + * @param targetId - If null/undefined, message is sent to all players. Otherwise, sent only to player with matching id. + */ + sendChat(msg: string, targetId?: number): void; + + /** + * Changes the admin status of the specified player. + * @param playerId - The ID of the player. + * @param admin - Whether to grant or revoke admin status. + */ setPlayerAdmin(playerId: number, admin: boolean): void; + /** + * Moves the specified player to a team. + * @param playerId - The ID of the player. + * @param team - The team ID (0 = Spectators, 1 = Red, 2 = Blue). + */ setPlayerTeam(playerId: number, team: number): void; + /** + * Kicks the specified player from the room. + * @param playerId - The ID of the player to kick. + * @param reason - The reason for the kick. + * @param ban - Whether to ban the player. + */ kickPlayer(playerId: number, reason: string, ban: boolean): void; + /** + * Clears the ban for a playerId that belonged to a player that was previously banned. + * @param playerId - The ID of the player to unban. + */ clearBan(playerId: number): void; + /** + * Clears the list of banned players. + */ clearBans(): void; + /** + * Sets the score limit of the room. + * @param limit - The score limit. + * @note If a game is in progress this method does nothing. + */ setScoreLimit(limit: number): void; + /** + * Sets the time limit of the room in minutes. + * @param limitInMinutes - The time limit in minutes. + * @note If a game is in progress this method does nothing. + */ setTimeLimit(limitInMinutes: number): void; + /** + * Parses the stadiumFileContents as a .hbs stadium file and sets it as the selected stadium. + * @param stadiumFileContents - The contents of the .hbs stadium file as a string. + * @note There must not be a game in progress. If a game is in progress this method does nothing. + */ setCustomStadium(stadiumFileContents: string): void; + /** + * Sets the selected stadium to one of the default stadiums. + * @param stadiumName - The name of the stadium (must match exactly, case sensitive). + * @note There must not be a game in progress. If a game is in progress this method does nothing. + */ setDefaultStadium(stadiumName: string): void; + /** + * Sets the teams lock. When teams are locked players cannot change team unless moved by an admin. + * @param locked - Whether teams should be locked. + */ setTeamsLock(locked: boolean): void; + /** + * Sets the colors of a team. + * @param team - The team ID (1 = Red, 2 = Blue). + * @param angle - The angle of the color gradient. + * @param textColor - The text color as an integer (e.g., 0xFF0000 for red). + * @param colors - Array of color integers. + */ setTeamColors(team: TeamID, angle: number, textColor: number, colors: readonly number[]): void; + /** + * Starts the game. + * @note If a game is already in progress this method does nothing. + */ startGame(): void; + /** + * Stops the game. + * @note If no game is in progress this method does nothing. + */ stopGame(): void; + /** + * Sets the pause state of the game. + * @param pauseState - true = paused, false = unpaused. + */ pauseGame(pauseState: boolean): void; - getPlayer(playerId: number): PlayerObject; + /** + * Returns the player with the specified id. + * @param playerId - The ID of the player. + * @returns The player object or null if the player doesn't exist. + */ + getPlayer(playerId: number): PlayerObject | null; + /** + * Returns the current list of players. + */ getPlayerList(): PlayerObject[]; - getScores(): ScoresObject; - - getBallPosition(): { "x": number; "y": number }; - + /** + * Returns the current score information if a game is in progress. + * @returns The scores object or null if no game is in progress. + */ + getScores(): ScoresObject | null; + + /** + * Returns the ball's position in the field. + * @returns The ball's position or null if no game is in progress. + */ + getBallPosition(): { x: number; y: number } | null; + + /** + * Starts recording of a haxball replay. + * @warning Don't forget to call stopRecording or it will cause a memory leak. + */ startRecording(): void; - stopRecording(): Uint8Array; + /** + * Stops the recording previously started with startRecording and returns the replay file contents. + * @returns The replay file contents as a Uint8Array, or null if recording was not started or had already been stopped. + */ + stopRecording(): Uint8Array | null; + /** + * Changes the password of the room. + * @param pass - The new password, or null to clear the password. + */ setPassword(pass: string | null): void; + /** + * Activates or deactivates the recaptcha requirement to join the room. + * @param required - Whether recaptcha is required. + */ setRequireRecaptcha(required: boolean): void; + /** + * Reorders players in the player list. + * First all listed players are removed, then reinserted in the order they appear in playerIdList. + * @param playerIdList - Array of player IDs to reorder. + * @param moveToTop - If true, players are inserted at the top of the list, otherwise at the bottom. + */ reorderPlayers(playerIdList: readonly number[], moveToTop: boolean): void; - sendAnnouncement(msg: string, targetId?: number, color?: number, style?: string, sound?: number): void; - + /** + * Sends a host announcement. + * Unlike sendChat, announcements work without a host player and have a larger character limit. + * @param msg - The message contents. + * @param targetId - If null/undefined, sent to all players. Otherwise, sent only to player with matching id. + * @param color - Color encoded as integer (0xFF0000 = red, 0x00FF00 = green, 0x0000FF = blue). + * @param style - Text style: "normal", "bold", "italic", "small", "small-bold", "small-italic". Default: "normal". + * @param sound - 0 = no sound, 1 = normal chat sound, 2 = notification sound. + */ + sendAnnouncement(msg: string, targetId?: number | null, color?: number, style?: string, sound?: number): void; + + /** + * Sets the room's kick rate limits. + * @param min - Minimum number of logic-frames between two kicks. It is impossible to kick faster than this. Default: 2. + * @param rate - Works like min but lets players save up extra kicks to use later depending on burst. Default: 0. + * @param burst - How many extra kicks the player can save up. Default: 0. + */ setKickRateLimit(min: number, rate: number, burst: number): void; + /** + * Overrides the avatar of the target player. + * @param playerId - The ID of the player. + * @param avatar - The avatar string, or null to clear the override and let the player use their own avatar. + */ setPlayerAvatar(playerId: number, avatar: string | null): void; + /** + * Sets properties of the target disc. + * Properties that are null or undefined will not be set and will preserve the disc's current value. + * @param discIndex - The index of the disc. + * @param properties - Partial disc properties to set. + * @example + * ```js + * // Set position of disc 0 to <0,0> while leaving other values intact + * room.setDiscProperties(0, {x: 0, y: 0}); + * ``` + */ setDiscProperties(discIndex: number, properties: Partial): void; - getDiscProperties(discIndex: number): DiscPropertiesObject; - + /** + * Gets the properties of the disc at discIndex. + * @param discIndex - The index of the disc. + * @returns The disc properties or null if discIndex is out of bounds. + */ + getDiscProperties(discIndex: number): DiscPropertiesObject | null; + + /** + * Same as setDiscProperties but targets the disc belonging to a player with the given Id. + * @param playerId - The ID of the player. + * @param properties - Partial disc properties to set. + */ setPlayerDiscProperties(playerId: number, properties: Partial): void; + /** + * Same as getDiscProperties but targets the disc belonging to a player with the given Id. + * @param playerId - The ID of the player. + * @returns The player's disc properties. + */ getPlayerDiscProperties(playerId: number): DiscPropertiesObject; + /** + * Gets the number of discs in the game including the ball and player discs. + */ getDiscCount(): number; + /** + * Object filled with collision flags constants that compose the cMask and cGroup disc properties. + * @see https://github.com/haxball/haxball-issues/wiki/Collision-Flags + * @example + * ```js + * // Check if disc 4 belongs to collision group "ball": + * var discProps = room.getDiscProperties(4); + * var hasBallFlag = (discProps.cGroup & room.CollisionFlags.ball) != 0; + * + * // Add "wall" to the collision mask of disc 5: + * var discProps = room.getDiscProperties(5); + * room.setDiscProperties(5, {cMask: discProps.cMask | room.CollisionFlags.wall}); + * ``` + */ CollisionFlags: CollisionFlagsObject; - onPlayerJoin(player: PlayerObject): void; + /** + * Event called when a new player joins the room. + * @param player - The player who joined. + */ + onPlayerJoin(player: PlayerJoinObject): void; + /** + * Event called when a player leaves the room. + * @param player - The player who left. + */ onPlayerLeave(player: PlayerObject): void; + /** + * Event called when a team wins. + * @param scores - The final scores. + */ onTeamVictory(scores: ScoresObject): void; - onPlayerChat(player: PlayerObject, msg: string): boolean; - + /** + * Event called when a player sends a chat message. + * @param player - The player who sent the message. + * @param msg - The message text. + * @returns Return false to filter the message and prevent it from reaching other players. + */ + onPlayerChat(player: PlayerObject, msg: string): void | boolean; + + /** + * Event called when a player kicks the ball. + * @param player - The player who kicked the ball. + */ onPlayerBallKick(player: PlayerObject): void; + /** + * Event called when a team scores a goal. + * @param team - The team that scored (1 = Red, 2 = Blue). + */ onTeamGoal(team: TeamID): void; - onGameStart(byPlayer: PlayerObject): void; - - onGameStop(byPlayer: PlayerObject): void; - - onPlayerAdminChange(changedPlayer: PlayerObject, byPlayer: PlayerObject): void; - - onPlayerTeamChange(changedPlayer: PlayerObject, byPlayer: PlayerObject): void; - - onPlayerKicked(kickedPlayer: PlayerObject, reason: string, ban: boolean, byPlayer: PlayerObject): void; - + /** + * Event called when a game starts. + * @param byPlayer - The player who caused the event (can be null if not caused by a player). + */ + onGameStart(byPlayer: PlayerObject | null): void; + + /** + * Event called when a game stops. + * @param byPlayer - The player who caused the event (can be null if not caused by a player). + */ + onGameStop(byPlayer: PlayerObject | null): void; + + /** + * Event called when a player's admin rights are changed. + * @param changedPlayer - The player whose admin rights changed. + * @param byPlayer - The player who caused the event (can be null if not caused by a player). + */ + onPlayerAdminChange(changedPlayer: PlayerObject, byPlayer: PlayerObject | null): void; + + /** + * Event called when a player's team is changed. + * @param changedPlayer - The player who changed teams. + * @param byPlayer - The player who caused the event (can be null if not caused by a player). + */ + onPlayerTeamChange(changedPlayer: PlayerObject, byPlayer: PlayerObject | null): void; + + /** + * Event called when a player has been kicked from the room. + * This is always called after the onPlayerLeave event. + * @param kickedPlayer - The player who was kicked. + * @param reason - The reason for the kick. + * @param ban - Whether the player was banned. + * @param byPlayer - The player who caused the event (can be null if not caused by a player). + */ + onPlayerKicked(kickedPlayer: PlayerObject, reason: string, ban: boolean, byPlayer: PlayerObject | null): void; + + /** + * Event called once for every game tick (60 times per second). + * Useful for monitoring player and ball positions without missing any ticks. + * @note This event is not called if the game is paused or stopped. + */ onGameTick(): void; + /** + * Event called when the game is paused. + * @param byPlayer - The player who paused the game. + */ onGamePause(byPlayer: PlayerObject): void; + /** + * Event called when the game is unpaused. + * After this event there's a timer before the game is fully unpaused. + * Listen for the first onGameTick event after this to detect when the game has really resumed. + * @param byPlayer - The player who unpaused the game. + */ onGameUnpause(byPlayer: PlayerObject): void; + /** + * Event called when the players and ball positions are reset after a goal. + */ onPositionsReset(): void; + /** + * Event called when a player gives signs of activity (e.g., pressing a key). + * Useful for detecting inactive players. + * @param player - The player who showed activity. + */ onPlayerActivity(player: PlayerObject): void; + /** + * Event called when the stadium is changed. + * @param newStadiumName - The name of the new stadium. + * @param byPlayer - The player who changed the stadium. + */ onStadiumChange(newStadiumName: string, byPlayer: PlayerObject): void; + /** + * Event called when the room link is obtained. + * @param url - The room URL. + */ onRoomLink(url: string): void; + /** + * Event called when the kick rate limit is set. + * @param min - The minimum frames between kicks. + * @param rate - The rate parameter. + * @param burst - The burst parameter. + * @param byPlayer - The player who changed the setting. + */ onKickRateLimitSet(min: number, rate: number, burst: number, byPlayer: PlayerObject): void; } -declare class PlayerObject { +/** + * Holds information about a player. + */ +interface PlayerObject { + /** The unique id of the player. Each player gets a unique id that will never change. */ id: number; + /** The name of the player. */ name: string; + /** The team of the player (0 = Spectators, 1 = Red, 2 = Blue). */ team: TeamID; + /** Whether the player has admin rights. */ admin: boolean; - position: { "x": number; "y": number }; - auth: string; + /** The player's position in the field, or null if the player is not in the field. */ + position: { x: number; y: number } | null; +} + +interface PlayerJoinObject extends PlayerObject { + /** + * The player's public ID. Players can view their own ID at https://www.haxball.com/playerauth + * Useful for validating a player is who they claim to be, but not for verifying they aren't someone else. + * Good for user accounts, not suitable for banning systems. + * Can be null if ID validation fails. Only set in the onPlayerJoin event. + */ + auth: string | null; + /** + * A string that uniquely identifies the player's connection. + * If two players join using the same network, this string will be equal. + * Only set in the onPlayerJoin event. + */ conn: string; } -declare class ScoresObject { +/** + * Holds information relevant to the current game scores. + */ +interface ScoresObject { + /** The number of goals scored by the red team. */ red: number; + /** The number of goals scored by the blue team. */ blue: number; + /** The number of seconds elapsed (doesn't advance while the game is paused). */ time: number; + /** The score limit for the game. */ scoreLimit: number; + /** The time limit for the game. */ timeLimit: number; } +/** + * Team identifiers. + * - 0 = Spectators + * - 1 = Red Team + * - 2 = Blue Team + */ type TeamID = 0 | 1 | 2; -declare class DiscPropertiesObject { +/** + * Holds information about a game physics disc. + */ +interface DiscPropertiesObject { + /** The x coordinate of the disc's position. */ x: number; + /** The y coordinate of the disc's position. */ y: number; + /** The x coordinate of the disc's speed vector. */ xspeed: number; + /** The y coordinate of the disc's speed vector. */ yspeed: number; + /** The x coordinate of the disc's gravity vector. */ xgravity: number; + /** The y coordinate of the disc's gravity vector. */ ygravity: number; + /** The disc's radius. */ radius: number; + /** The disc's bouncing coefficient. */ bCoeff: number; + /** The inverse of the disc's mass. */ invMass: number; + /** The disc's damping factor. */ damping: number; + /** The disc's color as an integer (0xFF0000 = red, 0x00FF00 = green, 0x0000FF = blue, -1 = transparent). */ color: number; + /** The disc's collision mask (represents what groups the disc can collide with). */ cMask: number; + /** The disc's collision groups. */ cGroup: number; } +/** + * Contains flag constants used as helpers for reading and writing collision flags. + * Collision flags determine which objects collide and which objects ignore each other. + * + * Object A and B will collide if and only if: + * (A.cGroup & B.cMask != 0) && (B.cGroup & A.cMask != 0) + * + * @see https://github.com/haxball/haxball-issues/wiki/Collision-Flags + */ interface CollisionFlagsObject { - "ball": number; - "red": number; - "blue": number; - "redKO": number; - "blueKO": number; - "wall": number; - "all": number; - "kick": number; - "score": number; - "c0": number; - "c1": number; - "c2": number; - "c3": number; + /** Default collision group of the ball. */ + ball: number; + /** Automatically added to players of the red team. */ + red: number; + /** Automatically added to players of the blue team. */ + blue: number; + /** Kickoff barriers active during kickoff for the red team. */ + redKO: number; + /** Kickoff barriers active during kickoff for the blue team. */ + blueKO: number; + /** Default collision group for vertexes, segments, and planes. */ + wall: number; + /** Represents a set including ball, red, blue, redKO, blueKO, and wall. */ + all: number; + /** Objects with this flag in their cGroup become kickable by players. */ + kick: number; + /** Objects with this flag in their cGroup will score goals if they cross a goal line. */ + score: number; + /** Custom collision flag with no special meaning, can be used for any purpose. */ + c0: number; + /** Custom collision flag with no special meaning, can be used for any purpose. */ + c1: number; + /** Custom collision flag with no special meaning, can be used for any purpose. */ + c2: number; + /** Custom collision flag with no special meaning, can be used for any purpose. */ + c3: number; } +/** + * Root object of a stadium file (.hbs). + * A HaxBall stadium file is a text file with JSON5 format containing a single StadiumObject. + */ interface StadiumObject { + /** The name of the stadium. */ name?: string; + /** Width of the rectangle centered at <0,0> in which the camera will be contained. */ width?: number; + /** Height of the rectangle centered at <0,0> in which the camera will be contained. */ height?: number; + /** + * Maximum allowed viewable width for the level. + * If the player screen is wide enough to see more than maxViewWidth, the game will zoom in. + * Setting to 0 disables this feature. Default: 0 + */ maxViewWidth?: number; + /** + * Changes camera following behavior. + * "player" = follow player only, ignore ball + * "ball" = follow average position between player and ball, prioritize player if too far apart + * Default: "ball" + */ cameraFollow?: string; + /** + * Distance from <0,0> at which teams spawn during kickoff. + * Ignored if redSpawnPoints or blueSpawnPoints are not empty. + */ spawnDistance?: number; + /** Whether this stadium can be stored with the /store command. Default: true */ canBeStored?: boolean; + /** + * "partial" = only ball and player discs reset for kickoff + * "full" = all discs reset for kickoff + * Default: "partial" + */ kickOffReset?: string; + /** Object describing the background for the stadium. */ bg: BackgroundObject; + /** + * Map of named traits. TraitValues define default values for any object that references that trait. + * Useful for avoiding repetition when manually writing stadium files. + */ traits?: Record; + /** List of vertexes (collision points). */ vertexes?: Vertex[]; + /** List of segments (lines connecting vertexes). */ segments?: Segment[]; + /** List of goals. */ goals?: Goal[]; + /** List of discs (circular physical objects). */ discs?: Disc[]; + /** List of planes (infinite collision lines). */ planes?: Plane[]; + /** List of joints (physical connections between discs). */ joints?: Joint[]; + /** + * List of spawn points for red team kickoff. + * If empty, default spawn behavior is used. + * When a player joins a started game, they're positioned at the last point. + * Default: [] + */ redSpawnPoints?: number[][]; + /** + * List of spawn points for blue team kickoff. + * If empty, default spawn behavior is used. + * Default: [] + */ blueSpawnPoints?: number[][]; + /** Object describing player physics. If omitted, default player physics will be used. */ playerPhysics?: PlayerPhysics; - ballPhysics?: Disc; + /** + * Disc used to create the ball. Collision flags "kick" and "score" are automatically added. + * Setting to "disc0" uses the first disc as the ball (cGroup left unmodified). + * If omitted, default ball physics will be used. + */ + ballPhysics?: Disc | "disc0"; } +/** + * Describes the background for the stadium. + */ interface BackgroundObject { + /** Type of background: "grass", "hockey", or "none". Default: "none" */ type?: "grass" | "hockey" | "none"; + /** Width of the background rectangle. Default: 0 */ width?: number; + /** Height of the background rectangle. Default: 0 */ height?: number; + /** Radius of the kickoff circle. Default: 0 */ kickOffRadius?: number; + /** Radius of the corners (creates rounded corners if > 0). Default: 0 */ cornerRadius?: number; + /** Horizontal distance to goals from <0,0>, used by "hockey" background only. Default: 0 */ goalLine?: number; + /** Background color for the stadium. Default: "718C5A" */ color?: string | number[]; } +/** + * A vertex is a point which can collide with discs but cannot move and is not visible. + */ interface Vertex { + /** The x position for the vertex. */ x?: number; + /** The y position for the vertex. */ y?: number; + /** The bouncing coefficient. */ bCoef?: number; + /** List of flags representing this object's collision mask. */ cMask?: string[]; + /** List of flags representing this object's collision group. */ cGroup?: string[]; + /** A trait to use as default values for this object. See StadiumObject traits property for more info. */ + trait?: string; } +/** + * A segment is a line (curved or straight) that connects two vertexes. + * Discs can collide with segments and they can also be used as decoration. + */ interface Segment { + /** Index of a vertex in the stadium vertex list to be used as first point of the segment. */ v0?: number; + /** Index of a vertex in the stadium vertex list to be used as the second point of the segment. */ v1?: number; + /** The bouncing coefficient. */ bCoef?: number; + /** The angle in degrees with which the segment will curve forming an arc. 0 = straight line. Default: 0 */ curve?: number; + /** Alternative representation of curve. If present, curve value is ignored. */ curveF?: number; + /** + * Determines segment thickness and makes it one-way if != 0. + * 0 = collide normally on both sides + * Other values = one-way collision with specified thickness + * Useful for boundaries that prevent fast moving balls from passing through. Default: 0 + */ bias?: number; + /** List of flags representing this object's collision mask. */ cMask?: string[]; + /** List of flags representing this object's collision group. */ cGroup?: string[]; + /** If false, the segment will be invisible. Default: true */ vis?: boolean; + /** The color with which the segment will be drawn. Default: "000000" (black) */ color?: string | number[]; + /** A trait to use as default values for this object. See StadiumObject traits property for more info. */ + trait?: string; } +/** + * Goals are lines belonging to a team. When the ball crosses this line, the opposite team scores. + */ interface Goal { + /** The coordinates of the first point of the line in array form [x, y]. */ p0?: number[]; + /** The coordinates of the second point of the line in array form [x, y]. */ p1?: number[]; + /** The team the goal belongs to: "red" or "blue". */ team?: "red" | "blue"; + /** A trait to use as default values for this object. See StadiumObject traits property for more info. */ + trait?: string; } +/** + * Planes are collision objects that divide the map in two by an infinite line. + * Useful for creating the boundaries of the stadium. + */ interface Plane { + /** The direction vector of the plane in array form [x, y]. */ normal?: number[]; + /** The distance from coordinates [0,0] (in direction of the normal) where the plane is located. */ dist?: number; + /** The bouncing coefficient. */ bCoef?: number; + /** List of flags representing this object's collision mask. */ cMask?: string[]; + /** List of flags representing this object's collision group. */ cGroup?: string[]; + /** A trait to use as default values for this object. See StadiumObject traits property for more info. */ + trait?: string; } +/** + * Discs are circular physical objects placed in the stadium. They can move and collide with other discs. + */ interface Disc { + /** The starting position of the object in array form [x, y]. */ pos?: number[]; + /** The starting speed of the object in array form [x, y]. */ speed?: number[]; + /** The gravity vector of the object in array form [x, y]. */ gravity?: number[]; + /** The radius of the disc. */ radius?: number; + /** The inverse of the disc's mass. */ invMass?: number; + /** The damping factor of the disc. */ damping?: number; + /** The disc fill color. Supports "transparent". Default: "FFFFFF" */ color?: string | number[]; + /** The bouncing coefficient. */ bCoef?: number; + /** List of flags representing this object's collision mask. */ cMask?: string[]; + /** List of flags representing this object's collision group. */ cGroup?: string[]; + /** A trait to use as default values for this object. See StadiumObject traits property for more info. */ + trait?: string; } +/** + * Describes physical constants affecting the players. + */ interface PlayerPhysics { + /** The gravity vector affecting players. */ gravity?: number[]; + /** The radius of the player disc. */ radius?: number; + /** The inverse of the player's mass. */ invMass?: number; + /** The bouncing coefficient. */ bCoef?: number; + /** The damping factor. */ damping?: number; + /** The collision groups the player belongs to. */ cGroup?: string[]; + /** How fast a player accelerates when moving with keys. */ acceleration?: number; + /** Replaces acceleration when the player is holding the kick button. */ kickingAcceleration?: number; + /** Replaces damping when the player is holding the kick button. */ kickingDamping?: number; + /** How much force the player applies to the ball when kicking. */ kickStrength?: number; + /** Like kickStrength but applied to the kicking player instead. */ kickback?: number; } +/** + * Joints are physical connections between two discs. + */ interface Joint { + /** + * Index of one of the two discs connected by the joint. + * Note: Index 0 is used by the ball disc if StadiumObject.ballPhysics is not set to "disc0". + */ d0?: number; + /** + * Index of one of the two discs connected by the joint. + * Note: Index 0 is used by the ball disc if StadiumObject.ballPhysics is not set to "disc0". + */ d1?: number; + /** + * The length of the joint. + * - null = automatically computed to match the distance between the two discs + * - float = use that value as length + * - [min, max] = joint has min and max length, applies no forces if distance is in range + * Default: null + */ length?: number | [number, number] | null; + /** + * The strength of the joint. + * - "rigid" = joint acts like a solid + * - float = joint acts like a spring + * Default: "rigid" + */ strength?: number | "rigid"; + /** The color of the joint. Supports "transparent". Default: "000000" (black) */ color?: string | number[]; + /** A trait to use as default values for this object. See StadiumObject traits property for more info. */ + trait?: string; } diff --git a/types/haxball-headless-browser/package.json b/types/haxball-headless-browser/package.json index 9ee7996b7e6d90..5e1e7eb48d1132 100644 --- a/types/haxball-headless-browser/package.json +++ b/types/haxball-headless-browser/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/haxball-headless-browser", - "version": "0.4.9999", + "version": "0.5.9999", "nonNpm": true, "nonNpmDescription": "haxball-headless-browser", "projects": [