docx
    Preparing search index...

    Type Alias IShapePictureOptions

    IShapePictureOptions: DrawingLinkOptions & {
        altText?: DocPropertiesOptions;
        crop?: ICropOptions;
        effects?: ShapeEffects;
        id?: string;
        image: ImageSource;
        lane?: string;
        line?: ShapeLine;
        transformation: IMediaTransformation;
        type: "picture";
    }

    A picture in a ShapeGroupRun or ShapeCanvasRun. Connectors can attach to the middle of its sides.

    Type Declaration

    • Optional ReadonlyaltText?: DocPropertiesOptions

      Name, description and title used by screen readers

    • Optional Readonlycrop?: ICropOptions

      Crops the picture by a percentage of each side, from 0 to 100

    • Optional Readonlyeffects?: ShapeEffects

      Shadows, glow, soft edges and reflection

    • Optional Readonlyid?: string

      A name that connectors use to attach to this picture. It must be unique within the group or canvas

    • Readonlyimage: ImageSource

      The picture: its format and data, as for an ImageRun, such as { type: "png", data: fs.readFileSync("logo.png") }

    • Optional Readonlylane?: string

      The lane of the flow the picture goes in, by its name. See ShapeFlowLayout.lanes

    • Optional Readonlyline?: ShapeLine

      An outline around the picture. Default is none

    • Readonlytransformation: IMediaTransformation

      Size in pixels, with optional rotation (degrees) and flip. offset positions the picture, in pixels

    • Readonlytype: "picture"