docx
    Preparing search index...

    Type Alias IShapeConnectorOptions

    A connector between two shapes in a ShapeGroupRun or ShapeCanvasRun.

    The connector is drawn from one shape to the other, so it doesn't need a size or position. On a ShapeCanvasRun, Word keeps it attached when either shape is moved.

    When several connectors with arrowheads meet at the same point of a shape with straight sides, such as a rectangle, or several connectors join the same two shapes, their ends are spread out along the side so they don't overlap.

    type IShapeConnectorOptions = {
        altText?: DocPropertiesOptions;
        from: ConnectorEnd;
        label?: string | ConnectorLabel;
        line?: ShapeLine;
        margin?: number;
        route?: ConnectorRoute;
        to: ConnectorEnd;
        type: "connector";
    }
    Index
    altText? from label? line? margin? route? to type
    altText?: DocPropertiesOptions

    Name, description and title used by screen readers

    from: ConnectorEnd

    Where the connector starts

    label?: string | ConnectorLabel

    Text on the connector, such as "Yes", in a box centred on the route. The box is a separate shape, so Word doesn't move it when the connector moves

    line?: ShapeLine

    The connector's line, including any arrowheads. startArrow is at from and endArrow at to. Default is a solid black line 1pt wide

    margin?: number

    How far, in pixels, an elbow or curved connector goes past a shape before it turns. Default is 24 (a quarter of an inch)

    route?: ConnectorRoute

    A straight line, right-angled bends, or curves. Default is "straight", or "elbow" when a straight line would go through another shape

    to: ConnectorEnd

    Where the connector ends

    type: "connector"

    Settings
    Member Visibility

    On This Page
    Properties