GenericChartExtensions Module

Extension methods for providing a Plotly.NET.ImageExport fluent interface pattern for C#

Type extensions

Type extension Description

this.SaveJPG

Full Usage: this.SaveJPG

Parameters:
    path : string - The path (without extension) where the image will be saved
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image

Saves the GenericChart as JPG image

Extended Type: GenericChart

path : string

The path (without extension) where the image will be saved

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

this.SaveJPGAsync

Full Usage: this.SaveJPGAsync

Parameters:
    path : string - The path (without extension) where the image will be saved
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image

Returns: Task<unit>

Saves the GenericChart as JPG image (async)

Extended Type: GenericChart

path : string

The path (without extension) where the image will be saved

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

Returns: Task<unit>

this.SavePNG

Full Usage: this.SavePNG

Parameters:
    path : string - The path (without extension) where the image will be saved
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image

Saves the GenericChart as PNG image

Extended Type: GenericChart

path : string

The path (without extension) where the image will be saved

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

this.SavePNGAsync

Full Usage: this.SavePNGAsync

Parameters:
    path : string - The path (without extension) where the image will be saved
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image

Returns: Task<unit>

Saves the GenericChart as PNG image (async)

Extended Type: GenericChart

path : string

The path (without extension) where the image will be saved

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

Returns: Task<unit>

this.SaveSVG

Full Usage: this.SaveSVG

Parameters:
    path : string - The path (without extension) where the image will be saved
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image

Saves the GenericChart as SVG image

Extended Type: GenericChart

path : string

The path (without extension) where the image will be saved

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

this.SaveSVGAsync

Full Usage: this.SaveSVGAsync

Parameters:
    path : string - The path (without extension) where the image will be saved
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image

Returns: Task<unit>

Saves the GenericChart as SVG image (async)

Extended Type: GenericChart

path : string

The path (without extension) where the image will be saved

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

Returns: Task<unit>

this.ToBase64JPGString

Full Usage: this.ToBase64JPGString

Parameters:
    ?EngineType : ExportEngine -
    ?Width : int -
    ?Height : int -

Returns: string

Converts the GenericChart to a base64 encoded JPG string

Extended Type: GenericChart

?EngineType : ExportEngine

?Width : int

?Height : int

Returns: string

this.ToBase64JPGStringAsync

Full Usage: this.ToBase64JPGStringAsync

Parameters:
    ?EngineType : ExportEngine -
    ?Width : int -
    ?Height : int -

Returns: Task<string>

Converts the GenericChart to a base64 encoded JPG string (async)

Extended Type: GenericChart

?EngineType : ExportEngine

?Width : int

?Height : int

Returns: Task<string>

this.ToBase64PNGString

Full Usage: this.ToBase64PNGString

Parameters:
    ?EngineType : ExportEngine -
    ?Width : int -
    ?Height : int -

Returns: string

Converts the GenericChart to a base64 encoded PNG string

Extended Type: GenericChart

?EngineType : ExportEngine

?Width : int

?Height : int

Returns: string

this.ToBase64PNGStringAsync

Full Usage: this.ToBase64PNGStringAsync

Parameters:
    ?EngineType : ExportEngine -
    ?Width : int -
    ?Height : int -

Returns: Task<string>

Converts the GenericChart to a base64 encoded PNG string (async)

Extended Type: GenericChart

?EngineType : ExportEngine

?Width : int

?Height : int

Returns: Task<string>

this.ToSVGString

Full Usage: this.ToSVGString

Parameters:
    ?EngineType : ExportEngine -
    ?Width : int -
    ?Height : int -

Returns: string

Converts the GenericChart to a SVG string

Extended Type: GenericChart

?EngineType : ExportEngine

?Width : int

?Height : int

Returns: string

this.ToSVGStringAsync

Full Usage: this.ToSVGStringAsync

Parameters:
    ?EngineType : ExportEngine -
    ?Width : int -
    ?Height : int -

Returns: Task<string>

Converts the GenericChart to a SVG string (async)

Extended Type: GenericChart

?EngineType : ExportEngine

?Width : int

?Height : int

Returns: Task<string>