Stream

public struct Stream : Encodable

Note

Used by Scatter<XData, YData>.stream, Bar<XData, YData>.stream, Box<YData, XData, QData>.stream, Heatmap<ZData, XYData>.stream, Histogram<XData, YData>.stream, Histogram2D<XData, YData, ZData>.stream, Histogram2DContour<XData, YData, ZData>.stream, Contour<ZData, XData, YData>.stream, ScatterTernary<AData, BData, CData>.stream, Violin<YData, XData>.stream, Funnel<XData, YData>.stream, Waterfall<XData, YData>.stream, Image<ZData>.stream, Pie<LabelsData, ValuesData>.stream, Sunburst<ValuesData>.stream, Treemap<ValuesData>.stream, FunnelArea<LabelsData, ValuesData>.stream, Scatter3D<XData, YData, ZData>.stream, Surface<ZSurfaceData, XYData>.stream, Isosurface<XData, YData, ZData, ValueData>.stream, Volume<XYZData, ValueData>.stream, Mesh3D<XData, YData, ZData, IntensityData, VertexcolorData, FacecolorData>.stream, Cone<XYZData, UVWData>.stream, StreamTube<XYZData, UVWData>.stream, ScatterGeo<CoordinateData, LocationsData>.stream, Choropleth<LocationsData, ZData>.stream, ScatterGL<XData, YData>.stream, ScatterPlotMatrix.stream, PointCloud<XYData>.stream, HeatmapGL<ZData, XYData>.stream, ParallelCoordinates.stream, ParallelCategories.stream, ScatterMapbox<CoordinateData>.stream, ChoroplethMapbox<LocationsData, ZData>.stream, DensityMapbox<CoordinateData, ZData>.stream, Sankey.stream, Indicator.stream, Table<CellData>.stream, Carpet<XData, YData, AData, BData>.stream, ScatterCarpet<AData, BData>.stream, ContourCarpet<ZData, AData, BData>.stream, OHLC<XData, OHLCData>.stream, Candlestick<XData, OHLCData>.stream, ScatterPolar<RData, ThetaData>.stream, ScatterPolarGL<RData, ThetaData>.stream, BarPolar<RData, ThetaData>.stream.

  • The stream id number links a data trace on a plot with a stream.

    See https://chart-studio.plotly.com/settings for more details.

    Declaration

    Swift

    public var token: String?

  • Sets the maximum number of points to keep on the plots from an incoming stream.

    If maxpoints is set to 50, only the newest 50 points will be displayed on the plot.

    Declaration

    Swift

    public var maxPoints: Double?

  • Creates Stream object with specified properties.

    Declaration

    Swift

    public init(token: String? = nil, maxPoints: Double? = nil)

    Parameters

    token

    The stream id number links a data trace on a plot with a stream.
    maxPoints

    Sets the maximum number of points to keep on the plots from an incoming stream.