Header menu logo Plotly.NET

ChartExtensions Module

Extensions methods from Plotly.NET.ImageExport for the Chart module, supporting the fluent pipeline style

Type extensions

Type extension Description

Chart.saveJPG (path, ?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.saveJPG (path, ?EngineType, ?Width, ?Height, ?Scale)

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
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> unit

Returns a function that saves a GenericChart as JPG image

Extended Type: Chart

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

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> unit

Chart.saveJPGAsync (path, ?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.saveJPGAsync (path, ?EngineType, ?Width, ?Height, ?Scale)

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
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<unit>

Returns an async function that saves a GenericChart as JPG image

Extended Type: Chart

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

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<unit>

Chart.savePNG (path, ?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.savePNG (path, ?EngineType, ?Width, ?Height, ?Scale)

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
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> unit

Returns a function that saves a GenericChart as PNG image

Extended Type: Chart

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

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> unit

Chart.savePNGAsync (path, ?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.savePNGAsync (path, ?EngineType, ?Width, ?Height, ?Scale)

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
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<unit>

Returns an async function that saves a GenericChart as PNG image

Extended Type: Chart

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

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<unit>

Chart.saveSVG (path, ?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.saveSVG (path, ?EngineType, ?Width, ?Height, ?Scale)

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
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> unit

Returns a function that saves a GenericChart as SVG image

Extended Type: Chart

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

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> unit

Chart.saveSVGAsync (path, ?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.saveSVGAsync (path, ?EngineType, ?Width, ?Height, ?Scale)

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
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<unit>

Returns an async function that saves a GenericChart as SVG image

Extended Type: Chart

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

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<unit>

Chart.toBase64JPGString (?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.toBase64JPGString (?EngineType, ?Width, ?Height, ?Scale)

Parameters:
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> string

Returns a function that converts a GenericChart to a base64 encoded JPG string

Extended Type: Chart

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> string

Chart.toBase64JPGStringAsync (?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.toBase64JPGStringAsync (?EngineType, ?Width, ?Height, ?Scale)

Parameters:
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<string>

Returns an async function that converts a GenericChart to a base64 encoded JPG string

Extended Type: Chart

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<string>

Chart.toBase64PNGString (?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.toBase64PNGString (?EngineType, ?Width, ?Height, ?Scale)

Parameters:
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> string

Returns a function that converts a GenericChart to a base64 encoded PNG string

Extended Type: Chart

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> string

Chart.toBase64PNGStringAsync (?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.toBase64PNGStringAsync (?EngineType, ?Width, ?Height, ?Scale)

Parameters:
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<string>

Returns an async function that converts a GenericChart to a base64 encoded PNG string

Extended Type: Chart

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<string>

Chart.toSVGString (?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.toSVGString (?EngineType, ?Width, ?Height, ?Scale)

Parameters:
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> string

Returns a function that converts a GenericChart to a SVG string

Extended Type: Chart

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> string

Chart.toSVGStringAsync (?EngineType, ?Width, ?Height, ?Scale)

Full Usage: Chart.toSVGStringAsync (?EngineType, ?Width, ?Height, ?Scale)

Parameters:
    ?EngineType : ExportEngine - The Render engine to use
    ?Width : int - width of the resulting image
    ?Height : int - height of the resulting image
    ?Scale : float - scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<string>

Returns an async function that converts a GenericChart to a SVG string

Extended Type: Chart

?EngineType : ExportEngine

The Render engine to use

?Width : int

width of the resulting image

?Height : int

height of the resulting image

?Scale : float

scale the resulting image by this factor. The DPI will stay the same, but the resolution will be scaled.

Returns: GenericChart -> Task<string>

Type something to start searching.