GenericChartExtensions Module

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

Type extensions

Type extension Description

this.SaveHtml

Full Usage: this.SaveHtml

Parameters:
    path : string
    ?OpenInBrowser : bool

Save chart as html single page

Extended Type: GenericChart

path : string
?OpenInBrowser : bool

this.Show

Full Usage: this.Show

Parameters:
    () : unit

Show chart in browser

Extended Type: GenericChart

() : unit

this.WithAdditionalHeadTags

Full Usage: this.WithAdditionalHeadTags

Parameters:
    additionalHeadTags : XmlNode list

Returns: GenericChart

Adds the given additional script tags on the chart's DisplayOptions. They will be included in the document's

Extended Type: GenericChart

additionalHeadTags : XmlNode list
Returns: GenericChart

this.WithAngularAxis

Full Usage: this.WithAngularAxis

Parameters:
Returns: GenericChart

Sets the angular axis of the polar object with the given id on the chart layout

Extended Type: GenericChart

angularAxis : AngularAxis
?Id : int
Returns: GenericChart

this.WithAnnotation

Full Usage: this.WithAnnotation

Parameters:
Returns: GenericChart

Extended Type: GenericChart

annotation : Annotation
?Append : bool
Returns: GenericChart

this.WithAnnotations

Full Usage: this.WithAnnotations

Parameters:
Returns: GenericChart

Extended Type: GenericChart

annotations : seq<Annotation>
?Append : bool
Returns: GenericChart

this.WithAxisAnchor

Full Usage: this.WithAxisAnchor

Parameters:
    ?X : int
    ?Y : int

Returns: GenericChart

Set the axis anchor id the trace is belonging to

Extended Type: GenericChart

?X : int
?Y : int
Returns: GenericChart

this.WithColorAxis

Full Usage: this.WithColorAxis

Parameters:
Returns: GenericChart

Sets the color axis of the color axis with the given id on the chart layout

Extended Type: GenericChart

colorAxis : ColorAxis
?Id : SubPlotId
Returns: GenericChart

this.WithColorBarStyle

Full Usage: this.WithColorBarStyle

Parameters:
Returns: GenericChart

Extended Type: GenericChart

title : Title
?Length : float
?OutlineColor : Color
?BorderColor : Color
?BGColor : Color
Returns: GenericChart

this.WithConfig

Full Usage: this.WithConfig

Parameters:
Returns: GenericChart

Extended Type: GenericChart

config : Config
Returns: GenericChart

this.WithDescription

Full Usage: this.WithDescription

Parameters:
Returns: GenericChart

Show chart in browser

Extended Type: GenericChart

description : XmlNode list
Returns: GenericChart

this.WithGeo

Full Usage: this.WithGeo

Parameters:
    geo : Geo
    ?Id : int

Returns: GenericChart

Sets a map for the given chart (will only work with traces supporting geo, e.g. choropleth, scattergeo)

Extended Type: GenericChart

geo : Geo
?Id : int
Returns: GenericChart

this.WithGeoStyle

Full Usage: this.WithGeoStyle

Parameters:
    ?Id : SubPlotId
    ?FitBounds : GeoFitBounds
    ?Resolution : GeoResolution
    ?Scope : GeoScope
    ?Projection : GeoProjection
    ?Center : float * float
    ?Visible : bool
    ?Domain : Domain
    ?ShowCoastLines : bool
    ?CoastLineColor : Color
    ?CoastLineWidth : float
    ?ShowLand : bool
    ?LandColor : Color
    ?ShowOcean : bool
    ?OceanColor : Color
    ?ShowLakes : bool
    ?LakeColor : Color
    ?ShowRivers : bool
    ?RiverColor : Color
    ?RiverWidth : float
    ?ShowCountries : bool
    ?CountryColor : Color
    ?CountryWidth : float
    ?ShowSubunits : bool
    ?SubunitColor : Color
    ?SubunitWidth : float
    ?ShowFrame : bool
    ?FrameColor : Color
    ?FrameWidth : float
    ?BgColor : Color
    ?LatAxis : LinearAxis
    ?LonAxis : LinearAxis

Returns: GenericChart

Sets the map style for the given chart (will only work with traces supporting geo, e.g. choropleth, scattergeo) Parameters : FitBounds : Determines if and how this subplot's view settings are auto-computed to fit trace data Resolution : Sets the resolution of the base layers Scope : Set the scope of the map. Projection : Determines the type of projection used to display the map Center : Sets the (lon,lat) coordinates of the map's center. By default, the map's longitude center lies at the middle of the longitude range for scoped projection and above `projection.rotation.lon` otherwise. For all projection types, the map's latitude center lies at the middle of the latitude range by default. Visible : Whether or not the base layers are visible Domain : The domain of this geo subplot ShowCoastLine : Sets whether or not the coastlines are drawn. CoastLineColor : Sets the coastline color. CoastLineWidth : Sets the coastline stroke width (in px). ShowLand : Sets whether or not land masses are filled in color. LandColor : Sets the land mass color. ShowOcean : Sets whether or not oceans are filled in color. OceanColor : Sets the ocean color ShowLakes : Sets whether or not lakes are drawn. LakeColor : Sets the color of the lakes. ShowRivers : Sets whether or not rivers are drawn. RiverColor : Sets color of the rivers. RiverWidth : Sets the stroke width (in px) of the rivers. ShowCountries : Sets whether or not country boundaries are drawn. CountryColor : Sets line color of the country boundaries. CountryWidth : Sets line width (in px) of the country boundaries. ShowSubunits : Sets whether or not boundaries of subunits within countries (e.g. states, provinces) are drawn. SubunitColor : Sets the color of the subunits boundaries. SubunitWidth : Sets the stroke width (in px) of the subunits boundaries. ShowFrame : Sets whether or not a frame is drawn around the map. FrameColor : Sets the color the frame. FrameWidth : Sets the stroke width (in px) of the frame. BgColor : Set the background color of the map LatAxis : Sets the latitudinal axis for this geo trace LonAxis : Sets the longitudinal axis for this geo trace

Extended Type: GenericChart

?Id : SubPlotId
?FitBounds : GeoFitBounds
?Resolution : GeoResolution
?Scope : GeoScope
?Projection : GeoProjection
?Center : float * float
?Visible : bool
?Domain : Domain
?ShowCoastLines : bool
?CoastLineColor : Color
?CoastLineWidth : float
?ShowLand : bool
?LandColor : Color
?ShowOcean : bool
?OceanColor : Color
?ShowLakes : bool
?LakeColor : Color
?ShowRivers : bool
?RiverColor : Color
?RiverWidth : float
?ShowCountries : bool
?CountryColor : Color
?CountryWidth : float
?ShowSubunits : bool
?SubunitColor : Color
?SubunitWidth : float
?ShowFrame : bool
?FrameColor : Color
?FrameWidth : float
?BgColor : Color
?LatAxis : LinearAxis
?LonAxis : LinearAxis
Returns: GenericChart

this.WithHeadTags

Full Usage: this.WithHeadTags

Parameters:
Returns: GenericChart

Sets the given additional script tags on the chart's DisplayOptions. They will be included in the document's

Extended Type: GenericChart

headTags : XmlNode list
Returns: GenericChart

this.WithLayout

Full Usage: this.WithLayout

Parameters:
Returns: GenericChart

Extended Type: GenericChart

layout : Layout
Returns: GenericChart

this.WithLayoutGrid

Full Usage: this.WithLayoutGrid

Parameters:
Returns: GenericChart

Extended Type: GenericChart

layoutGrid : LayoutGrid
Returns: GenericChart

this.WithLayoutGridStyle

Full Usage: this.WithLayoutGridStyle

Parameters:
Returns: GenericChart

Extended Type: GenericChart

?SubPlots : (LinearAxisId * LinearAxisId)[][]
?XAxes : LinearAxisId[]
?YAxes : LinearAxisId[]
?Rows : int
?Columns : int
?RowOrder : LayoutGridRowOrder
?Pattern : LayoutGridPattern
?XGap : float
?YGap : float
?Domain : Domain
?XSide : LayoutGridXSide
?YSide : LayoutGridYSide
Returns: GenericChart

this.WithLayoutImage

Full Usage: this.WithLayoutImage

Parameters:
Returns: GenericChart

Extended Type: GenericChart

image : LayoutImage
?Append : bool
Returns: GenericChart

this.WithLayoutImages

Full Usage: this.WithLayoutImages

Parameters:
Returns: GenericChart

Extended Type: GenericChart

images : seq<LayoutImage>
?Append : bool
Returns: GenericChart

this.WithLayoutStyle

Full Usage: this.WithLayoutStyle

Parameters:
Returns: GenericChart

Extended Type: GenericChart

?Title : Title
?ShowLegend : bool
?Legend : Legend
?Margin : Margin
?AutoSize : bool
?Width : int
?Height : int
?Font : Font
?UniformText : UniformText
?Separators : string
?PaperBGColor : Color
?PlotBGColor : Color
?AutoTypeNumbers : AutoTypeNumbers
?Colorscale : DefaultColorScales
?Colorway : Color
?ModeBar : ModeBar
?HoverMode : HoverMode
?ClickMode : ClickMode
?DragMode : DragMode
?SelectDirection : SelectDirection
?HoverDistance : int
?SpikeDistance : int
?Hoverlabel : Hoverlabel
?Transition : Transition
?DataRevision : string
?UIRevision : string
?EditRevision : string
?SelectRevision : string
?Template : DynamicObj
?Meta : string
?Computed : string
?Grid : LayoutGrid
?Calendar : Calendar
?NewShape : NewShape
?ActiveShape : ActiveShape
?HideSources : bool
?BarGap : float
?BarGroupGap : float
?BarMode : BarMode
?BarNorm : BarNorm
?ExtendPieColors : bool
?HiddenLabels : seq<'a>
?PieColorWay : Color
?BoxGap : float
?BoxGroupGap : float
?BoxMode : BoxMode
?ViolinGap : float
?ViolinGroupGap : float
?ViolinMode : ViolinMode
?WaterfallGap : float
?WaterfallGroupGap : float
?WaterfallMode : WaterfallMode
?FunnelGap : float
?FunnelGroupGap : float
?FunnelMode : FunnelMode
?ExtendFunnelAreaColors : bool
?FunnelAreaColorWay : Color
?ExtendSunBurstColors : bool
?SunBurstColorWay : Color
?ExtendTreeMapColors : bool
?TreeMapColorWay : Color
?ExtendIcicleColors : bool
?IcicleColorWay : Color
?Annotations : seq<Annotation>
?Shapes : seq<Shape>
?Images : seq<LayoutImage>
?Sliders : seq<Slider>
?UpdateMenus : seq<UpdateMenu>
Returns: GenericChart

this.WithLegend

Full Usage: this.WithLegend

Parameters:
Returns: GenericChart

Extended Type: GenericChart

legend : Legend
Returns: GenericChart

this.WithLegend

Full Usage: this.WithLegend

Parameters:
    showlegend : bool

Returns: GenericChart

Extended Type: GenericChart

showlegend : bool
Returns: GenericChart

this.WithLine

Full Usage: this.WithLine

Parameters:
Returns: GenericChart

Apply styling to the Line(s) of the chart as Object.

Extended Type: GenericChart

line : Line
Returns: GenericChart

this.WithLineStyle

Full Usage: this.WithLineStyle

Parameters:
    ?AutoColorScale : bool
    ?CAuto : bool
    ?CMax : float
    ?CMid : float
    ?CMin : float
    ?Color : Color
    ?ColorAxis : SubPlotId
    ?Colorscale : Colorscale
    ?ReverseScale : bool
    ?ShowScale : bool
    ?ColorBar : ColorBar
    ?Dash : DrawingStyle
    ?Shape : Shape
    ?Simplify : bool
    ?Smoothing : float
    ?Width : float
    ?MultiWidth : seq<float>
    ?OutlierColor : Color
    ?OutlierWidth : float

Returns: GenericChart

Apply styling to the Line(s) of the chart.

Extended Type: GenericChart

?AutoColorScale : bool
?CAuto : bool
?CMax : float
?CMid : float
?CMin : float
?Color : Color
?ColorAxis : SubPlotId
?Colorscale : Colorscale
?ReverseScale : bool
?ShowScale : bool
?ColorBar : ColorBar
?Dash : DrawingStyle
?Shape : Shape
?Simplify : bool
?Smoothing : float
?Width : float
?MultiWidth : seq<float>
?OutlierColor : Color
?OutlierWidth : float
Returns: GenericChart

this.WithMapProjection

Full Usage: this.WithMapProjection

Parameters:
Returns: GenericChart

Extended Type: GenericChart

projectionType : GeoProjectionType
?Rotation : GeoProjectionRotation
?Parallels : float * float
?Scale : float
?Id : 'a
Returns: GenericChart

this.WithMargin

Full Usage: this.WithMargin

Parameters:
Returns: GenericChart

Extended Type: GenericChart

margin : Margin
Returns: GenericChart

this.WithMarginSize

Full Usage: this.WithMarginSize

Parameters:
    ?Left : 'a
    ?Right : 'b
    ?Top : 'c
    ?Bottom : 'd
    ?Pad : 'e
    ?Autoexpand : 'f

Returns: GenericChart

Extended Type: GenericChart

?Left : 'a
?Right : 'b
?Top : 'c
?Bottom : 'd
?Pad : 'e
?Autoexpand : 'f
Returns: GenericChart

this.WithMarker

Full Usage: this.WithMarker

Parameters:
Returns: GenericChart

Apply styling to the Marker(s) of the chart as Object.

Extended Type: GenericChart

marker : Marker
Returns: GenericChart

this.WithMarkerStyle

Full Usage: this.WithMarkerStyle

Parameters:
Returns: GenericChart

Apply styling to the Marker(s) of the chart.

Extended Type: GenericChart

?AutoColorScale : bool
?CAuto : bool
?CMax : float
?CMid : float
?CMin : float
?Color : Color
?Colors : seq<Color>
?ColorAxis : SubPlotId
?ColorBar : ColorBar
?Colorscale : Colorscale
?Gradient : Gradient
?Outline : Line
?MaxDisplayed : int
?Opacity : float
?MultiOpacity : seq<float>
?Pattern : Pattern
?ReverseScale : bool
?ShowScale : bool
?Size : int
?MultiSize : seq<int>
?SizeMin : int
?SizeMode : MarkerSizeMode
?SizeRef : int
?Symbol : MarkerSymbol
?MultiSymbol : seq<MarkerSymbol>
?Symbol3D : MarkerSymbol3D
?MultiSymbol3D : seq<MarkerSymbol3D>
?OutlierColor : Color
?OutlierWidth : int
Returns: GenericChart

this.WithMathTex

Full Usage: this.WithMathTex

Parameters:
    ?AppendTags : bool
    ?MathJaxVersion : int

Returns: GenericChart

Adds the necessary script tags to render tex strings to the chart's DisplayOptions

Extended Type: GenericChart

?AppendTags : bool
?MathJaxVersion : int
Returns: GenericChart

this.WithPolar

Full Usage: this.WithPolar

Parameters:
    polar : Polar
    ?Id : int

Returns: GenericChart

Sets the polar object with the given id on the chart layout

Extended Type: GenericChart

polar : Polar
?Id : int
Returns: GenericChart

this.WithRadialAxis

Full Usage: this.WithRadialAxis

Parameters:
Returns: GenericChart

Sets the radial axis of the polar object with the given id on the chart layout

Extended Type: GenericChart

radialAxis : RadialAxis
?Id : int
Returns: GenericChart

this.WithScene

Full Usage: this.WithScene

Parameters:
    scene : Scene
    ?Id : int

Returns: GenericChart

Sets the scene object with the given id on the chart layout

Extended Type: GenericChart

scene : Scene
?Id : int
Returns: GenericChart

this.WithShape

Full Usage: this.WithShape

Parameters:
    shape : Shape
    ?Append : bool

Returns: GenericChart

Extended Type: GenericChart

shape : Shape
?Append : bool
Returns: GenericChart

this.WithShapes

Full Usage: this.WithShapes

Parameters:
    shapes : seq<Shape>
    ?Append : bool

Returns: GenericChart

Extended Type: GenericChart

shapes : seq<Shape>
?Append : bool
Returns: GenericChart

this.WithSize

Full Usage: this.WithSize

Parameters:
    width : int
    height : int

Returns: GenericChart

Extended Type: GenericChart

width : int
height : int
Returns: GenericChart

this.WithSlider

Full Usage: this.WithSlider

Parameters:
Returns: GenericChart

Extended Type: GenericChart

slider : Slider
Returns: GenericChart

this.WithSliders

Full Usage: this.WithSliders

Parameters:
Returns: GenericChart

Extended Type: GenericChart

sliders : seq<Slider>
Returns: GenericChart

this.WithTemplate

Full Usage: this.WithTemplate

Parameters:
Returns: GenericChart

Extended Type: GenericChart

template : Template
Returns: GenericChart

this.WithTernary

Full Usage: this.WithTernary

Parameters:
Returns: GenericChart

Sets the scene object with the given id on the chart layout

Extended Type: GenericChart

ternary : Ternary
?Id : int
Returns: GenericChart

this.WithTitle

Full Usage: this.WithTitle

Parameters:
    title : string
    ?TitleFont : Font

Returns: GenericChart

Extended Type: GenericChart

title : string
?TitleFont : Font
Returns: GenericChart

this.WithTraceInfo

Full Usage: this.WithTraceInfo

Parameters:
    ?Name : string
    ?Visible : Visible
    ?ShowLegend : bool
    ?LegendRank : int
    ?LegendGroup : string
    ?LegendGroupTitle : Title

Returns: GenericChart

Extended Type: GenericChart

?Name : string
?Visible : Visible
?ShowLegend : bool
?LegendRank : int
?LegendGroup : string
?LegendGroupTitle : Title
Returns: GenericChart

this.WithUpdateMenu

Full Usage: this.WithUpdateMenu

Parameters:
Returns: GenericChart

Extended Type: GenericChart

updateMenu : UpdateMenu
?Append : bool
Returns: GenericChart

this.WithUpdateMenus

Full Usage: this.WithUpdateMenus

Parameters:
Returns: GenericChart

Extended Type: GenericChart

updateMenus : seq<UpdateMenu>
?Append : bool
Returns: GenericChart

this.WithXAxis

Full Usage: this.WithXAxis

Parameters:
Returns: GenericChart

Extended Type: GenericChart

xAxis : LinearAxis
?Id : SubPlotId
Returns: GenericChart

this.WithXAxisRangeSlider

Full Usage: this.WithXAxisRangeSlider

Parameters:
Returns: GenericChart

Sets the range slider for the xAxis

Extended Type: GenericChart

rangeSlider : RangeSlider
?Id : SubPlotId
Returns: GenericChart

this.WithXAxisStyle

Full Usage: this.WithXAxisStyle

Parameters:
Returns: GenericChart

Extended Type: GenericChart

title : Title
?MinMax : IConvertible * IConvertible
?ShowGrid : bool
?ShowLine : bool
?Side : Side
?Overlaying : LinearAxisId
?Id : SubPlotId
?Domain : IConvertible * IConvertible
?Position : float
?ZeroLine : bool
?Anchor : LinearAxisId
Returns: GenericChart

this.WithXError

Full Usage: this.WithXError

Parameters:
Returns: GenericChart

Apply styling to the xError(s) of the chart as Object

Extended Type: GenericChart

xError : Error
Returns: GenericChart

this.WithXErrorStyle

Full Usage: this.WithXErrorStyle

Parameters:
    ?Array : seq<'a>
    ?Arrayminus : seq<'b>
    ?Symmetric : bool
    ?Color : Color
    ?Thickness : float
    ?Width : float

Returns: GenericChart

Apply styling to the xError(s) of the chart as Object

Extended Type: GenericChart

?Array : seq<'a>
?Arrayminus : seq<'b>
?Symmetric : bool
?Color : Color
?Thickness : float
?Width : float
Returns: GenericChart

this.WithYAxis

Full Usage: this.WithYAxis

Parameters:
Returns: GenericChart

Extended Type: GenericChart

yAxis : LinearAxis
?Id : SubPlotId
Returns: GenericChart

this.WithYAxisStyle

Full Usage: this.WithYAxisStyle

Parameters:
Returns: GenericChart

Extended Type: GenericChart

title : Title
?MinMax : IConvertible * IConvertible
?ShowGrid : bool
?ShowLine : bool
?Side : Side
?Overlaying : LinearAxisId
?Id : SubPlotId
?Domain : IConvertible * IConvertible
?Position : float
?ZeroLine : bool
?Anchor : LinearAxisId
Returns: GenericChart

this.WithYError

Full Usage: this.WithYError

Parameters:
Returns: GenericChart

Apply styling to the yError(s) of the chart as Object

Extended Type: GenericChart

yError : Error
Returns: GenericChart

this.WithYErrorStyle

Full Usage: this.WithYErrorStyle

Parameters:
    ?Array : seq<'a>
    ?Arrayminus : seq<'b>
    ?Symmetric : bool
    ?Color : Color
    ?Thickness : float
    ?Width : float

Returns: GenericChart

Apply styling to the yError(s) of the chart as Object

Extended Type: GenericChart

?Array : seq<'a>
?Arrayminus : seq<'b>
?Symmetric : bool
?Color : Color
?Thickness : float
?Width : float
Returns: GenericChart

this.WithZAxis

Full Usage: this.WithZAxis

Parameters:
Returns: GenericChart

Extended Type: GenericChart

zAxis : LinearAxis
?Id : int
Returns: GenericChart

this.WithZAxisStyle

Full Usage: this.WithZAxisStyle

Parameters:
Returns: GenericChart

Extended Type: GenericChart

title : Title
?MinMax : IConvertible * IConvertible
?ShowGrid : bool
?ShowLine : bool
?Domain : IConvertible * IConvertible
?Anchor : LinearAxisId
Returns: GenericChart

this.WithZError

Full Usage: this.WithZError

Parameters:
Returns: GenericChart

Apply styling to the zError(s) of the chart as Object

Extended Type: GenericChart

zError : Error
Returns: GenericChart

this.WithZErrorStyle

Full Usage: this.WithZErrorStyle

Parameters:
    ?Array : seq<'a>
    ?Arrayminus : seq<'b>
    ?Symmetric : bool
    ?Color : Color
    ?Thickness : float
    ?Width : float

Returns: GenericChart

Apply styling to the zError(s) of the chart as Object

Extended Type: GenericChart

?Array : seq<'a>
?Arrayminus : seq<'b>
?Symmetric : bool
?Color : Color
?Thickness : float
?Width : float
Returns: GenericChart

this.withColorBar colorbar

Full Usage: this.withColorBar colorbar

Parameters:
Returns: GenericChart

Extended Type: GenericChart

colorbar : ColorBar
Returns: GenericChart

this.withMapbox (mapBox, ?Id)

Full Usage: this.withMapbox (mapBox, ?Id)

Parameters:
Returns: GenericChart

Sets a mapbox for the given chart (will only work with traces supporting mapboxes, e.g. choroplethmapbox, scattermapbox)

Extended Type: GenericChart

mapBox : Mapbox
?Id : int
Returns: GenericChart