Show / Hide Table of Contents

    Class PLStream

    A PLplot stream.

    Inheritance
    System.Object
    PLStream
    Namespace: PLplot
    Assembly: PLplotNet.dll
    Syntax
    public class PLStream : IDisposable
    Remarks

    A new PLplot stream is created when this class is instantiated. The PLplot stream is ended when the instance is disposed. An instance is thread-safe, however all calls from all instances are serialized.

    Constructors

    Name Description
    PLStream()

    Creates a new PLplot stream.

    Properties

    Name Description
    Id

    The stream id of this stream as returned by plgstrm().

    Methods

    Name Description
    adv(Int32)

    pladv: Advance the (sub-)page

    arc(Double, Double, Double, Double, Double, Double, Double, Boolean)

    plarc: Draw a circular or elliptical arc

    axes(Double, Double, String, Double, Int32, String, Double, Int32)

    plaxes: Draw a box with axes, etc. with arbitrary origin

    bin(Double[], Double[], Bin)

    plbin: Plot a histogram from binned data

    bop()

    plbop: Begin a new page

    box(String, Double, Int32, String, Double, Int32)

    plbox: Draw a box with axes, etc

    box3(String, String, Double, Int32, String, String, Double, Int32, String, String, Double, Int32)

    plbox3: Draw a box with axes, etc, in 3-d

    btime(out Int32, out Int32, out Int32, out Int32, out Int32, out Double, Double)

    plbtime: Calculate broken-down time from continuous time for the current stream

    calc_world(Double, Double, out Double, out Double, out Int32)

    plcalc_world: Calculate world coordinates and corresponding window index from relative device coordinates

    clear()

    plclear: Clear current (sub)page

    cmd(Int32, IntPtr)

    Front-end to driver escape function.

    col0(Int32)

    plcol0: Set color, cmap0

    col1(Double)

    plcol1: Set color, cmap1

    colorbar(out Double, out Double, Colorbar, Position, Double, Double, Double, Double, Int32, Int32, Int32, Double, Double, Int32, Double, ColorbarLabel[], String[], String[], Double[], Int32[], Double[,])

    plcolorbar: Plot color bar for image, shade or gradient plots

    configtime(Double, Double, Double, Int32, Boolean, Int32, Int32, Int32, Int32, Int32, Double)

    plconfigtime: Configure the transformation between continuous and broken-down time for the current stream

    cont(Double[,], Int32, Int32, Int32, Int32, Double[], TransformFunc)

    plcont: Contour plot

    cpstrm(PLStream, Boolean)

    plcpstrm: Copy state parameters from the reference stream to the current stream

    ctime(Int32, Int32, Int32, Int32, Int32, Double, out Double)

    plctime: Calculate continuous time from broken-down time for the current stream

    did2pc(out Double, out Double, out Double, out Double)

    Converts input values from relative device coordinates to relative plot coordinates.

    dip2dc(out Double, out Double, out Double, out Double)

    Converts input values from relative plot coordinates to relative device coordinates.

    env(Double, Double, Double, Double, AxesScale, AxisBox)

    plenv: Set up standard window and draw box

    env0(Double, Double, Double, Double, AxesScale, AxisBox)

    plenv0: Same as plenv but if in multiplot mode does not advance the subpage, instead clears it

    eop()

    pleop: Eject current page

    errx(Double[], Double[], Double[])

    plerrx: Draw error bars in x direction

    erry(Double[], Double[], Double[])

    plerry: Draw error bars in the y direction

    famadv()

    plfamadv: Advance to the next family file on the next new page

    fill(Double[], Double[])

    plfill: Draw filled polygon

    fill3(Double[], Double[], Double[])

    plfill3: Draw filled polygon in 3D

    Finalize()

    Ends the PLplot stream.

    flush()

    plflush: Flushes the output stream

    font(FontFlag)

    plfont: Set font

    fontld(Int32)

    plfontld: Load Hershey fonts

    gchr(out Double, out Double)

    plgchr: Get character default height and current (scaled) height

    gcmap1_range(out Double, out Double)

    plgcmap1_range: Get the cmap1 argument range for continuous color plots

    gcol0(Int32, out Int32, out Int32, out Int32)

    plgcol0: Returns 8-bit RGB values for given color index from cmap0

    gcol0a(Int32, out Int32, out Int32, out Int32, out Double)

    plgcol0a: Returns 8-bit RGB values and PLFLT alpha transparency value for given color index from cmap0

    gcolbg(out Int32, out Int32, out Int32)

    plgcolbg: Returns the background color (cmap0[0]) by 8-bit RGB value

    gcolbga(out Int32, out Int32, out Int32, out Double)

    plgcolbga: Returns the background color (cmap0[0]) by 8-bit RGB value and PLFLT alpha transparency value

    gcompression(out Int32)

    plgcompression: Get the current device-compression setting

    gdev(out String)

    plgdev: Get the current device (keyword) name

    gDevs(out String[], out String[])

    Returns a list of all device names and their menu strings

    gdidev(out Double, out Double, out Double, out Double)

    plgdidev: Get parameters that define current device-space window

    gdiori(out Double)

    plgdiori: Get plot orientation

    gdiplt(out Double, out Double, out Double, out Double)

    plgdiplt: Get parameters that define current plot-space window

    gdrawmode()

    plgdrawmode: Get drawing mode (depends on device support!)

    gesc(out Char)

    Get the escape character for text strings.

    GetCursor(out GraphicsIn)

    plGetCursor: Wait for graphics input event and translate to world coordinates.

    gfam(out Int32, out Int32, out Int32)

    plgfam: Get family file parameters

    gfci(out FCI)

    plgfci: Get FCI (font characterization integer)

    gFileDevs(out String[], out String[])

    Returns a list of file-oriented device names and their menu strings

    gfnam(out String)

    plgfnam: Get output file name

    gfont(out FontFamily, out FontStyle, out FontWeight)

    plgfont: Get family, style and weight of the current font

    glevel(out RunLevel)

    plglevel: Get the (current) run level

    gpage(out Double, out Double, out Int32, out Int32, out Int32, out Int32)

    plgpage: Get page parameters

    gra()

    plgra: Switch to graphics screen

    gradient(Double[], Double[], Double)

    plgradient: Draw linear gradient inside polygon

    griddata(Double[], Double[], Double[], Double[], Double[], Double[,], Grid, Double)

    plgriddata: Grid data from irregularly sampled data

    gspa(out Double, out Double, out Double, out Double)

    plgspa: Get current subpage parameters

    gstrm(out Int32)

    plgstrm: Get current stream number

    gver(out String)

    plgver: Get the current library version number

    gvpd(out Double, out Double, out Double, out Double)

    plgvpd: Get viewport limits in normalized device coordinates

    gvpw(out Double, out Double, out Double, out Double)

    plgvpw: Get viewport limits in world coordinates

    gxax(out Int32, out Int32)

    plgxax: Get x axis parameters

    gyax(out Int32, out Int32)

    plgyax: Get y axis parameters

    gzax(out Int32, out Int32)

    plgzax: Get z axis parameters

    hist(Double[], Double, Double, Int32, Hist)

    plhist: Plot a histogram from unbinned data

    hlsrgb(Double, Double, Double, out Double, out Double, out Double)

    plhlsrgb: Convert HLS color to RGB

    image(Double[,], Double, Double, Double, Double, Double, Double, Double, Double, Double, Double)

    plimage: Plot a 2D matrix using cmap1 with automatic color adjustment

    imagefr(Double[,], Double, Double, Double, Double, Double, Double, Double, Double, TransformFunc)

    plimagefr: Plot a 2D matrix using cmap1

    init()

    plinit: Initialize PLplot

    join(Double, Double, Double, Double)

    pljoin: Draw a line between two points

    lab(String, String, String)

    pllab: Simple routine to write labels

    legend(out Double, out Double, Legend, Position, Double, Double, Double, Int32, Int32, LineStyle, Int32, Int32, LegendEntry[], Double, Double, Double, Double, Int32[], String[], Int32[], Pattern[], Double[], Double[], Int32[], LineStyle[], Double[], Int32[], Double[], Int32[], String[])

    pllegend: Plot legend using discretely annotated filled boxes, lines, and/or lines of symbols

    lightsource(Double, Double, Double)

    pllightsource: Sets the 3D position of the light source

    line(Double[], Double[])

    plline: Draw a line

    line3(Double[], Double[], Double[])

    plline3: Draw a line in 3 space

    lsty(LineStyle)

    pllsty: Select line style

    map(MapFunc, String, Double, Double, Double, Double)

    plmap: Plot continental outline or shapefile data in world coordinates

    mapfill(MapFunc, String, Double, Double, Double, Double, Int32[])

    plmapfill: Plot all or a subset of Shapefile data, filling the polygons

    mapline(MapFunc, String, Double, Double, Double, Double, Int32[])

    plmapline: Plot all or a subset of Shapefile data using lines in world coordinates

    mapstring(MapFunc, String, String, Double, Double, Double, Double, Int32[])

    plmapstring: Plot all or a subset of Shapefile data using strings or points in world coordinates

    maptex(MapFunc, String, Double, Double, Double, String, Double, Double, Double, Double, Int32)

    plmaptex: Draw text at points defined by Shapefile data in world coordinates

    meridians(MapFunc, Double, Double, Double, Double, Double, Double)

    plmeridians: Plot latitude and longitude lines

    mesh(Double[], Double[], Double[,], Mesh)

    plmesh: Plot surface mesh

    meshc(Double[], Double[], Double[,], MeshContour, Double[])

    plmeshc: Magnitude colored plot surface mesh with contour

    mtex(String, Double, Double, Double, String)

    plmtex: Write text relative to viewport boundaries

    mtex3(String, Double, Double, Double, String)

    plmtex3: Write text relative to viewport boundaries in 3D plots

    OptUsage()

    plOptUsage: Print usage and syntax message.

    parseopts(ref String[], ParseOpts)

    plparseopts: Parse command-line arguments

    pat(Int32[], Int32[])

    plpat: Set area line fill pattern

    path(Int32, Double, Double, Double, Double)

    plpath: Draw a line between two points, accounting for coordinate transforms

    plot3d(Double[], Double[], Double[,], Mesh, Boolean)

    plot3d: Plot 3-d surface plot

    plot3dc(Double[], Double[], Double[,], MeshContour, Double[])

    plot3dc: Magnitude colored plot surface with contour

    plot3dcl(Double[], Double[], Double[,], MeshContour, Double[], Int32, Int32[], Int32[])

    plot3dcl: Magnitude colored plot surface with contour for z[x][y] with y index limits

    poin(Double[], Double[], Char)

    plpoin: Plot a glyph at the specified points

    poin3(Double[], Double[], Double[], Char)

    plpoin3: Plot a glyph at the specified 3D points

    poly3(Double[], Double[], Double[], Boolean[], Boolean)

    plpoly3: Draw a polygon in 3 space

    prec(Int32, Int32)

    plprec: Set precision in numeric labels

    psty(Pattern)

    plpsty: Select area fill pattern

    ptex(Double, Double, Double, Double, Double, String)

    plptex: Write text inside the viewport

    ptex3(Double, Double, Double, Double, Double, Double, Double, Double, Double, Double, String)

    plptex3: Write text inside the viewport of a 3D plot

    randd()

    plrandd: Random number generator returning a real random number in the range [0,1]

    replot()

    plreplot: Replays contents of plot buffer to current device/file

    rgbhls(Double, Double, Double, out Double, out Double, out Double)

    plrgbhls: Convert RGB color to HLS

    sabort(AbortHandler)

    plsabort: Set abort handler

    sbopH(BopHandler, IntPtr)

    Sets an optional user bop handler

    sButtonEH(ButtonHandler, IntPtr)

    Set the function pointer for the (mouse) button event handler

    schr(Double, Double)

    plschr: Set character size

    scmap0(Int32[], Int32[], Int32[])

    plscmap0: Set cmap0 colors by 8-bit RGB values

    scmap0a(Int32[], Int32[], Int32[], Double[])

    plscmap0a: Set cmap0 colors by 8-bit RGB values and PLFLT alpha transparency value

    scmap0n(Int32)

    plscmap0n: Set number of colors in cmap0

    scmap1(Int32[], Int32[], Int32[])

    plscmap1: Set opaque RGB cmap1 colors values

    scmap1_range(Double, Double)

    plscmap1_range: Set the cmap1 argument range for continuous color plots

    scmap1a(Int32[], Int32[], Int32[], Double[])

    plscmap1a: Set semitransparent cmap1 RGBA colors.

    scmap1l(ColorSpace, Double[], Double[], Double[], Double[], Boolean[])

    plscmap1l: Set cmap1 colors using a piece-wise linear relationship

    scmap1la(ColorSpace, Double[], Double[], Double[], Double[], Double[], Boolean[])

    plscmap1la: Set cmap1 colors and alpha transparency using a piece-wise linear relationship

    scmap1n(Int32)

    plscmap1n: Set number of colors in cmap1

    scol0(Int32, Int32, Int32, Int32)

    plscol0: Set 8-bit RGB values for given cmap0 color index

    scol0a(Int32, Int32, Int32, Int32, Double)

    plscol0a: Set 8-bit RGB values and PLFLT alpha transparency value for given cmap0 color index

    scolbg(Int32, Int32, Int32)

    plscolbg: Set the background color by 8-bit RGB value

    scolbga(Int32, Int32, Int32, Double)

    plscolbga: Set the background color by 8-bit RGB value and PLFLT alpha transparency value.

    scolor(Int32)

    plscolor: Used to globally turn color output on/off

    scompression(Int32)

    plscompression: Set device-compression level

    sdev(String)

    plsdev: Set the device (keyword) name

    sdevdata(IntPtr)

    Set the pointer to the data used in driver initialisation

    sdidev(Double, Double, Double, Double)

    plsdidev: Set parameters that define current device-space window

    sdimap(Int32, Int32, Int32, Int32, Double, Double)

    plsdimap: Set up transformation from metafile coordinates

    sdiori(Double)

    plsdiori: Set plot orientation

    sdiplt(Double, Double, Double, Double)

    plsdiplt: Set parameters that define current plot-space window

    sdiplz(Double, Double, Double, Double)

    plsdiplz: Set parameters incrementally (zoom mode) that define current plot-space window

    sdrawmode(DrawMode)

    plsdrawmode: Set drawing mode (depends on device support!)

    seed(UInt32)

    plseed: Set seed for internal random number generator.

    seopH(EopHandler, IntPtr)

    Sets an optional user eop handler

    sesc(Char)

    plsesc: Set the escape character for text strings

    setcontlabelformat(Int32, Int32)

    pl_setcontlabelformat: Set format of numerical label for contours

    setcontlabelparam(Double, Double, Double, Int32)

    pl_setcontlabelparam: Set parameters of contour labelling other than format of numerical label

    setopt(String, String)

    plsetopt: Set any command-line option

    sexit(ExitHandler)

    plsexit: Set exit handler

    sfam(Int32, Int32, Int32)

    plsfam: Set family file parameters

    sfci(FCI)

    plsfci: Set FCI (font characterization integer)

    sfnam(String)

    plsfnam: Set output file name

    sfont(FontFamily, FontStyle, FontWeight)

    plsfont: Set family, style and weight of the current font

    shade(Double[,], DefinedFunc, Double, Double, Double, Double, Double, Double, Int32, Double, Double, Int32, Double, Int32, Double, Boolean, TransformFunc)

    plshade: Shade individual region on the basis of value

    shades(Double[,], DefinedFunc, Double, Double, Double, Double, Double[], Double, Int32, Double, Boolean, TransformFunc)

    plshades: Shade regions on the basis of value

    sKeyEH(KeyHandler, IntPtr)

    Set the function pointer for the keyboard event handler

    slabelfunc(LabelFunc, IntPtr)

    plslabelfunc: Assign a function to use for generating custom axis labels

    smaj(Double, Double)

    plsmaj: Set length of major ticks

    smem(Int32, Int32, IntPtr)

    plsmem: Set the memory area to be plotted (RGB)

    smema(Int32, Int32, IntPtr)

    plsmema: Set the memory area to be plotted (RGBA)

    smin(Double, Double)

    plsmin: Set length of minor ticks

    sori(Orientation)

    plsori: Set orientation

    spage(Double, Double, Int32, Int32, Int32, Int32)

    plspage: Set page parameters

    spal0(String)

    plspal0: Set the cmap0 palette using the specified cmap0*.pal format file

    spal1(String, Boolean)

    plspal1: Set the cmap1 palette using the specified cmap1*.pal format file

    spause(Boolean)

    plspause: Set the pause (on end-of-page) status

    ssub(Int32, Int32)

    plssub: Set the number of subpages in x and y

    ssym(Double, Double)

    plssym: Set symbol size

    star(Int32, Int32)

    plstar: Initialization

    start(String, Int32, Int32)

    plstart: Initialization

    stransform(TransformFunc)

    plstransform: Set a global coordinate transform function

    string2(Double[], Double[], String)
    string3(Double[], Double[], Double[], String)

    plstring3: Plot a glyph at the specified 3D points

    stripa(Int32, Pen, Double, Double)

    plstripa: Add a point to a strip chart

    stripc(out Int32, String, String, Double, Double, Double, Double, Double, Double, Double, Boolean, Boolean, Int32, Int32, Int32[], LineStyle[], String[], String, String, String)

    plstripc: Create a 4-pen strip chart

    stripd(Int32)

    plstripd: Deletes and releases memory used by a strip chart

    styl(Int32[], Int32[])

    plstyl: Set line style

    surf3d(Double[], Double[], Double[,], Surf, Double[])

    plsurf3d: Plot shaded 3-d surface plot

    surf3dl(Double[], Double[], Double[,], Surf, Double[], Int32, Int32[], Int32[])

    plsurf3dl: Plot shaded 3-d surface plot for z[x][y] with y index limits

    svect(Double[], Double[], Boolean)

    plsvect: Set arrow style for vector plots

    svpa(Double, Double, Double, Double)

    plsvpa: Specify viewport in absolute coordinates

    sxax(Int32, Int32)

    plsxax: Set x axis parameters

    sxwin(Int32)

    Set inferior X window

    syax(Int32, Int32)

    plsyax: Set y axis parameters

    sym(Double[], Double[], Char)

    plsym: Plot a glyph at the specified points

    szax(Int32, Int32)

    plszax: Set z axis parameters

    text()

    pltext: Switch to text screen

    timefmt(String)

    pltimefmt: Set format for date / time labels

    ToString()
    tr0()

    Make a identity transformation for matrix index to world coordinate mapping.

    tr1(Double[], Double[])

    Make a linear interpolation transformation for matrix index to world coordinate mapping using singly dimensioned coordinate arrays.

    tr2(Double[,], Double[,])

    Make a linear interpolation transformation for grid to world mapping using doubly dimensioned coordinate arrays.

    TranslateCursor(ref GraphicsIn)

    plTranslateCursor: Convert device to world coordinates

    vasp(Double)

    plvasp: Specify viewport using aspect ratio only

    vect(Double[,], Double[,], Double, TransformFunc)

    plvect: Vector plot

    vpas(Double, Double, Double, Double, Double)

    plvpas: Specify viewport using coordinates and aspect ratio

    vpor(Double, Double, Double, Double)

    plvpor: Specify viewport using normalized subpage coordinates

    vsta()

    plvsta: Select standard viewport

    w3d(Double, Double, Double, Double, Double, Double, Double, Double, Double, Double, Double)

    plw3d: Configure the transformations required for projecting a 3D surface on a 2D window

    width(Double)

    plwidth: Set pen width

    wind(Double, Double, Double, Double)

    plwind: Specify window

    xormod(Boolean, out Boolean)

    plxormod: Enter or leave xor mode

    • Improve this Doc
    • View Source
    Back to top Generated by DocFX