Add-OfficeExcelVisual

Aliases: ExcelVisual

Namespace PSWriteOffice

Aliases

ExcelVisual

Inputs

System.Object

Outputs

OfficeIMO.Excel.ExcelImage

Source

Sources/PSWriteOffice/Cmdlets/Excel/AddOfficeExcelVisualCommand.cs:13 Edit on GitHub

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

Remarks

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

Examples

Authored help example

EXAMPLE 1


Add-OfficeExcelVisual -Address 'Value'

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.

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>] [-PointsPerPixel <Double>] [-Row <Int32>] [-SvgPolicy <PreserveVector|RasterizeWhenNeeded|RequireVector>] [-Title <String>] [-Width <Double>] [-Worksheet <ExcelSheet>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

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

Outputs

OfficeIMO.Excel.ExcelImage