ConvertTo-OfficeVisual

Aliases: OfficeVisual

Namespace PSWriteOffice

Aliases

OfficeVisual

Inputs

System.Object

Outputs

OfficeIMO.ChartForgeX.OfficeVisualConversionResult

Source

Sources/PSWriteOffice/Cmdlets/Visuals/ConvertToOfficeVisualCommand.cs:17 Edit on GitHub

Converts a ChartForgeX visual artifact into a reusable OfficeIMO representation.

Remarks

Converts a ChartForgeX visual artifact into a reusable OfficeIMO representation.

Examples

Authored help example

Prepare one chart for multiple Office outputs.

PS>


$officeVisual = $artifact | ConvertTo-OfficeVisual -Width 420 -SvgPolicy RasterizeWhenNeeded

Creates one fidelity report and placement payload that can be reused in Word, Excel, PowerPoint, and PDF.

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

ConvertTo-OfficeVisual [-AlternativeText <String>] [-Height <Double>] [-Id <String>] -InputObject <Object> [-MaximumSvgElements <Int32>] [-MaximumSvgViewportDimension <Double>] [-MaximumSvgViewportPixels <Double>] [-PointsPerPixel <Double>] [-SvgPolicy <PreserveVector|RasterizeWhenNeeded|RequireVector>] [-Title <String>] [-Width <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

AlternativeText String optionalposition: namedpipeline: False: Optional accessible description for an SVG file input.
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, prepared conversion, or portable 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.
PointsPerPixel Double optionalposition: namedpipeline: False: Conversion factor from ChartForgeX pixels to Office points.
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.

Outputs

OfficeIMO.ChartForgeX.OfficeVisualConversionResult