Cmdlet

Add-OfficeExcelVisual

Aliases: ExcelVisual

Module: PSWriteOffice
Aliases: ExcelVisual
Inputs: System.Object
Outputs: OfficeIMO.Excel.ExcelImage
Source: AddOfficeExcelVisualCommand.cs:13 Edit on GitHub

Adds a ChartForgeX artifact, portable SVG, or converted Office visual to an Excel worksheet.

Syntax

Add-OfficeExcelVisual
[-Address <String>]
[-AlternativeText <String>]
[-Column <Int32>]
[-Height <Double>]
[-Id <String>]
[-InputObject] <Object>
[-MaximumSvgElements <Int32>]
[-MaximumSvgViewportDimension <Double>]
[-MaximumSvgViewportPixels <Double>]
[-OffsetX <Int32>]
[-OffsetY <Int32>]
[-PassThru]
[-PointsPerPixel <Double>]
[-Row <Int32>]
[-SvgPolicy <PreserveVector|RasterizeWhenNeeded|RequireVector>]
[-Title <String>]
[-Width <Double>]
[-Worksheet <ExcelSheet>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Example 1

Add-OfficeExcelVisual -InputObject 'Value'

Parameters

-Address String optionalaliases: Cell: A1-style target cell address.
-AlternativeText String optional: Optional accessible description for an SVG file input.
-Column Int32 optional: One-based target column.
-Height Double optional: Optional output height in Office points.
-Id String optional: Optional stable identifier for an SVG file input.
-InputObject Object requiredposition: 0pipeline: True (ByValue): ChartForgeX VisualArtifact, OfficeVisualSource, OfficeVisualConversionResult, or SVG file path.
-MaximumSvgElements Int32 optional: Optional OfficeIMO SVG import element limit.
-MaximumSvgViewportDimension Double optional: Optional maximum SVG viewport width or height. Increase the safe default only for trusted input.
-MaximumSvgViewportPixels Double optional: Optional maximum SVG viewport area in pixels. Increase the safe default only for trusted input.
-OffsetX Int32 optional: Horizontal offset in pixels from the cell origin.
-OffsetY Int32 optional: Vertical offset in pixels from the cell origin.
-PassThru SwitchParameter optional: Emit the image added to the worksheet.
-PointsPerPixel Double optional: Conversion factor from ChartForgeX pixels to Office points.
-Row Int32 optional: One-based target row.
-SvgPolicy OfficeVisualSvgPolicy optional: SVG fidelity policy used by OfficeIMO.ChartForgeX.; Possible values: PreserveVector, RasterizeWhenNeeded, RequireVector
-Title String optional: Optional title for an SVG file input.
-Width Double optional: Optional output width in Office points.
-Worksheet ExcelSheet optional: Target worksheet. Inside the Excel DSL, the current worksheet is used by default.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.