ScottPlot.xml 252 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>ScottPlot</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ScottPlot.Control.ControlBackEnd">
  8. <summary>
  9. The control back end module contains all the logic required to manage a mouse-interactive
  10. plot to display in a user control. However, this module contains no control-specific dependencies.
  11. User controls can instantiate this object, pass mouse and resize event information in, and have
  12. renders triggered using events.
  13. </summary>
  14. </member>
  15. <member name="E:ScottPlot.Control.ControlBackEnd.BitmapUpdated">
  16. <summary>
  17. This event is invoked when an existing Bitmap is redrawn.
  18. e.g., after rendering following a click-drag-pan mouse event.
  19. </summary>
  20. </member>
  21. <member name="E:ScottPlot.Control.ControlBackEnd.BitmapChanged">
  22. <summary>
  23. This event is invoked after a new Bitmap was created.
  24. e.g., after resizing the control, requiring a new Bitmap of a different size
  25. </summary>
  26. </member>
  27. <member name="E:ScottPlot.Control.ControlBackEnd.CursorChanged">
  28. <summary>
  29. This event is invoked when the cursor is supposed to change.
  30. Cursor changes may be required when hovering over draggable plottable objects.
  31. </summary>
  32. </member>
  33. <member name="E:ScottPlot.Control.ControlBackEnd.AxesChanged">
  34. <summary>
  35. This event is invoked when the axis limts change.
  36. This is typically the result of a pan or zoom operation.
  37. </summary>
  38. </member>
  39. <member name="E:ScottPlot.Control.ControlBackEnd.RightClicked">
  40. <summary>
  41. This event is invoked when the user right-clicks the control with the mouse.
  42. It is typically used to deploy a context menu.
  43. </summary>
  44. </member>
  45. <member name="E:ScottPlot.Control.ControlBackEnd.PlottableDragged">
  46. <summary>
  47. This event is invoked after the mouse moves while dragging a draggable plottable.
  48. </summary>
  49. </member>
  50. <member name="E:ScottPlot.Control.ControlBackEnd.PlottableDropped">
  51. <summary>
  52. This event is invoked after the mouse moves while dragging a draggable plottable.
  53. </summary>
  54. </member>
  55. <member name="F:ScottPlot.Control.ControlBackEnd.Configuration">
  56. <summary>
  57. The control configuration object stores advanced customization and behavior settings
  58. for mouse-interactive plots.
  59. </summary>
  60. </member>
  61. <member name="F:ScottPlot.Control.ControlBackEnd.IsMiddleDown">
  62. <summary>
  63. True if the middle mouse button is pressed
  64. </summary>
  65. </member>
  66. <member name="F:ScottPlot.Control.ControlBackEnd.IsRightDown">
  67. <summary>
  68. True if the right mouse button is pressed
  69. </summary>
  70. </member>
  71. <member name="F:ScottPlot.Control.ControlBackEnd.IsLeftDown">
  72. <summary>
  73. True if the left mouse button is pressed
  74. </summary>
  75. </member>
  76. <member name="F:ScottPlot.Control.ControlBackEnd.MouseLocationX">
  77. <summary>
  78. Current position of the mouse in pixels
  79. </summary>
  80. </member>
  81. <member name="F:ScottPlot.Control.ControlBackEnd.MouseLocationY">
  82. <summary>
  83. Current position of the mouse in pixels
  84. </summary>
  85. </member>
  86. <member name="F:ScottPlot.Control.ControlBackEnd.PlottableBeingDragged">
  87. <summary>
  88. Holds the plottable actively being dragged with the mouse.
  89. Contains null if no plottable is being dragged.
  90. </summary>
  91. </member>
  92. <member name="F:ScottPlot.Control.ControlBackEnd.IsZoomingRectangle">
  93. <summary>
  94. True when a zoom rectangle is being drawn and the mouse button is still down
  95. </summary>
  96. </member>
  97. <member name="F:ScottPlot.Control.ControlBackEnd.IsZoomingWithAlt">
  98. <summary>
  99. True if a zoom rectangle is being actively drawn using ALT + left click
  100. </summary>
  101. </member>
  102. <member name="P:ScottPlot.Control.ControlBackEnd.Plot">
  103. <summary>
  104. The plot underlying this control.
  105. </summary>
  106. </member>
  107. <member name="F:ScottPlot.Control.ControlBackEnd.Settings">
  108. <summary>
  109. The settings object underlying the plot.
  110. </summary>
  111. </member>
  112. <member name="F:ScottPlot.Control.ControlBackEnd.Bmp">
  113. <summary>
  114. The latest render is stored in this bitmap.
  115. New renders may be performed on this existing bitmap.
  116. When a new bitmap is created, this bitmap will be stored in OldBitmaps and eventually disposed.
  117. </summary>
  118. </member>
  119. <member name="F:ScottPlot.Control.ControlBackEnd.OldBitmaps">
  120. <summary>
  121. Bitmaps that are created are stored here so they can be kept track of and
  122. disposed properly when new bitmaps are created.
  123. </summary>
  124. </member>
  125. <member name="F:ScottPlot.Control.ControlBackEnd.LimitsOnLastRender">
  126. <summary>
  127. Store last render limits so new renders can know whether the axis limits
  128. have changed and decide whether to invoke the AxesChanged event or not.
  129. </summary>
  130. </member>
  131. <member name="F:ScottPlot.Control.ControlBackEnd.PlottablesIdentifierAtLastRender">
  132. <summary>
  133. Unique identifier of the plottables list that was last rendered.
  134. This value is used to determine if the plottables list was modified (requiring a re-render).
  135. </summary>
  136. </member>
  137. <member name="F:ScottPlot.Control.ControlBackEnd.currentlyRendering">
  138. <summary>
  139. This is set to True while the render loop is running.
  140. This prevents multiple renders from occurring at the same time.
  141. </summary>
  142. </member>
  143. <member name="P:ScottPlot.Control.ControlBackEnd.Cursor">
  144. <summary>
  145. The style of cursor the control should display
  146. </summary>
  147. </member>
  148. <member name="F:ScottPlot.Control.ControlBackEnd.EventsProcessor">
  149. <summary>
  150. The events processor invokes renders in response to custom events
  151. </summary>
  152. </member>
  153. <member name="F:ScottPlot.Control.ControlBackEnd.EventFactory">
  154. <summary>
  155. The event factor creates event objects to be handled by the event processor
  156. </summary>
  157. </member>
  158. <member name="F:ScottPlot.Control.ControlBackEnd.BitmapRenderCount">
  159. <summary>
  160. Number of times the current bitmap has been rendered on.
  161. </summary>
  162. </member>
  163. <member name="P:ScottPlot.Control.ControlBackEnd.RenderCount">
  164. <summary>
  165. Total number of renders performed.
  166. Note that at least one render occurs before the first request to measure the layout and calculate data area.
  167. This means the first render increments this number twice.
  168. </summary>
  169. </member>
  170. <member name="F:ScottPlot.Control.ControlBackEnd.MouseDownTravelDistance">
  171. <summary>
  172. Tracks the total distance the mouse was click-dragged (rectangular pixel units)
  173. </summary>
  174. </member>
  175. <member name="P:ScottPlot.Control.ControlBackEnd.MouseDownDragged">
  176. <summary>
  177. True if the mouse was dragged (with a button down) long enough to quality as a drag instead of a click
  178. </summary>
  179. </member>
  180. <member name="F:ScottPlot.Control.ControlBackEnd.WasManuallyRendered">
  181. <summary>
  182. Indicates whether Render() has been explicitly called by the user.
  183. Renders requested by resize events do not count.
  184. </summary>
  185. </member>
  186. <member name="F:ScottPlot.Control.ControlBackEnd.ControlName">
  187. <summary>
  188. Variable name for the user control tied to this backend.
  189. </summary>
  190. </member>
  191. <member name="M:ScottPlot.Control.ControlBackEnd.#ctor(System.Single,System.Single,System.String)">
  192. <summary>
  193. Create a back-end for a user control
  194. </summary>
  195. <param name="width">initial bitmap size (pixels)</param>
  196. <param name="height">initial bitmap size (pixels)</param>
  197. <param name="name">variable name of the user control using this backend</param>
  198. </member>
  199. <member name="M:ScottPlot.Control.ControlBackEnd.StartProcessingEvents">
  200. <summary>
  201. The host control may instantiate the back-end and start sending it events
  202. before it has fully connected its event handlers. To prevent processing events before
  203. the host is control is ready, the processor will be stopped until is called by the host control.
  204. </summary>
  205. </member>
  206. <member name="M:ScottPlot.Control.ControlBackEnd.Reset(System.Single,System.Single)">
  207. <summary>
  208. Reset the back-end by creating an entirely new plot of the given dimensions
  209. </summary>
  210. </member>
  211. <member name="M:ScottPlot.Control.ControlBackEnd.Reset(System.Single,System.Single,ScottPlot.Plot)">
  212. <summary>
  213. Reset the back-end by replacing the existing plot with one that has already been created
  214. </summary>
  215. </member>
  216. <member name="M:ScottPlot.Control.ControlBackEnd.GetDraggables">
  217. <summary>
  218. Return a copy of the list of draggable plottables
  219. </summary>
  220. </member>
  221. <member name="M:ScottPlot.Control.ControlBackEnd.GetDraggableUnderMouse(System.Double,System.Double,System.Int32)">
  222. <summary>
  223. Return the draggable plottable under the mouse cursor (or null if there isn't one)
  224. </summary>
  225. </member>
  226. <member name="M:ScottPlot.Control.ControlBackEnd.GetHelpMessage">
  227. <summary>
  228. Return a multi-line string describing the default mouse interactions.
  229. This can be useful for displaying a help message in a user control.
  230. </summary>
  231. </member>
  232. <member name="M:ScottPlot.Control.ControlBackEnd.GetLatestBitmap">
  233. <summary>
  234. Return the most recently rendered Bitmap.
  235. This method also disposes old Bitmaps if they exist.
  236. </summary>
  237. </member>
  238. <member name="M:ScottPlot.Control.ControlBackEnd.Render(System.Boolean,System.Boolean)">
  239. <summary>
  240. Render onto the existing Bitmap.
  241. Quality describes whether anti-aliasing will be used.
  242. </summary>
  243. </member>
  244. <member name="M:ScottPlot.Control.ControlBackEnd.AddErrorMessage(System.Drawing.Bitmap,System.String)">
  245. <summary>
  246. Add error text on top of the rendered plot
  247. </summary>
  248. </member>
  249. <member name="M:ScottPlot.Control.ControlBackEnd.RenderRequest(ScottPlot.RenderType)">
  250. <summary>
  251. Request a render using the render queue.
  252. This method does not block the calling thread.
  253. </summary>
  254. </member>
  255. <member name="M:ScottPlot.Control.ControlBackEnd.RenderIfPlottableListChanged">
  256. <summary>
  257. Check if the number of plottibles has changed and if so request a render.
  258. This is typically called by a continuously running timer in the user control.
  259. </summary>
  260. </member>
  261. <member name="M:ScottPlot.Control.ControlBackEnd.Resize(System.Single,System.Single,System.Boolean)">
  262. <summary>
  263. Resize the control (creates a new Bitmap and requests a render)
  264. </summary>
  265. <param name="width">new width (pixels)</param>
  266. <param name="height">new height (pixels)</param>
  267. <param name="useDelayedRendering">Render using the queue (best for mouse events), otherwise render immediately.</param>
  268. </member>
  269. <member name="M:ScottPlot.Control.ControlBackEnd.MouseDown(ScottPlot.Control.InputState)">
  270. <summary>
  271. Indicate a mouse button has just been pressed
  272. </summary>
  273. </member>
  274. <member name="M:ScottPlot.Control.ControlBackEnd.GetMouseCoordinates">
  275. <summary>
  276. Return the mouse position on the plot (in coordinate space) for the latest X and Y coordinates
  277. </summary>
  278. </member>
  279. <member name="M:ScottPlot.Control.ControlBackEnd.GetMousePixel">
  280. <summary>
  281. Return the mouse position (in pixel space) for the last observed mouse position
  282. </summary>
  283. </member>
  284. <member name="M:ScottPlot.Control.ControlBackEnd.MouseMove(ScottPlot.Control.InputState)">
  285. <summary>
  286. Indicate the mouse has moved to a new position
  287. </summary>
  288. </member>
  289. <member name="M:ScottPlot.Control.ControlBackEnd.ProcessEvent(ScottPlot.Control.EventProcess.IUIEvent)">
  290. <summary>
  291. Process an event using the render queue (non-blocking) or traditional rendering (blocking)
  292. based on the UseRenderQueue flag in the Configuration module.
  293. </summary>
  294. </member>
  295. <member name="M:ScottPlot.Control.ControlBackEnd.MouseMovedWithoutInteraction(ScottPlot.Control.InputState)">
  296. <summary>
  297. Call this when the mouse moves without any buttons being down.
  298. It will only update the cursor based on what's beneath the cursor.
  299. </summary>
  300. </member>
  301. <member name="M:ScottPlot.Control.ControlBackEnd.UpdateCursor(ScottPlot.Control.InputState)">
  302. <summary>
  303. Set the cursor based on whether a draggable is engaged or not,
  304. then invoke the CursorChanged event.
  305. </summary>
  306. </member>
  307. <member name="M:ScottPlot.Control.ControlBackEnd.MouseUp(ScottPlot.Control.InputState)">
  308. <summary>
  309. Indicate a mouse button has been released.
  310. This may initiate a render (and/or a delayed render).
  311. </summary>
  312. <param name="input"></param>
  313. </member>
  314. <member name="M:ScottPlot.Control.ControlBackEnd.DoubleClick">
  315. <summary>
  316. Indicate the left mouse button has been double-clicked.
  317. The default action of a double-click is to toggle the benchmark.
  318. </summary>
  319. </member>
  320. <member name="M:ScottPlot.Control.ControlBackEnd.MouseWheel(ScottPlot.Control.InputState)">
  321. <summary>
  322. Apply a scroll wheel action, perform a low quality render, and later re-render in high quality.
  323. </summary>
  324. </member>
  325. <member name="P:ScottPlot.Control.Configuration.Pan">
  326. <summary>
  327. Control whether panning is enabled
  328. </summary>
  329. </member>
  330. <member name="P:ScottPlot.Control.Configuration.Zoom">
  331. <summary>
  332. Control whether zooming is enabled (via left-click-drag, middle-click-drag, and scrollwheel)
  333. </summary>
  334. </member>
  335. <member name="F:ScottPlot.Control.Configuration.Quality">
  336. <summary>
  337. Manual override to set anti-aliasing (high quality) behavior for all renders.
  338. Refer to the QualityConfiguration field for more control over quality in response to specific interactions.
  339. </summary>
  340. </member>
  341. <member name="F:ScottPlot.Control.Configuration.QualityConfiguration">
  342. <summary>
  343. This module customizes anti-aliasing (high quality) behavior in response to interactive events.
  344. </summary>
  345. </member>
  346. <member name="F:ScottPlot.Control.Configuration.LeftClickDragPan">
  347. <summary>
  348. Control whether left-click-drag panning is enabled
  349. </summary>
  350. </member>
  351. <member name="F:ScottPlot.Control.Configuration.RightClickDragZoom">
  352. <summary>
  353. Control whether right-click-drag zooming is enabled
  354. </summary>
  355. </member>
  356. <member name="F:ScottPlot.Control.Configuration.ScrollWheelZoom">
  357. <summary>
  358. Control whether scroll wheel zooming is enabled
  359. </summary>
  360. </member>
  361. <member name="P:ScottPlot.Control.Configuration.ScrollWheelZoomFraction">
  362. <summary>
  363. Fractional amount to zoom in or out when the mouse wheel is scrolled.
  364. Value must be between 0 and 1 (default is 0.15).
  365. </summary>
  366. </member>
  367. <member name="F:ScottPlot.Control.Configuration.ScrollWheelZoomHighQualityDelay">
  368. <summary>
  369. Number of milliseconds after low quality scroll wheel zoom to re-render using high quality
  370. </summary>
  371. </member>
  372. <member name="F:ScottPlot.Control.Configuration.MiddleClickDragZoom">
  373. <summary>
  374. Control whether middle-click-drag zooming to a rectangle is enabled
  375. </summary>
  376. </member>
  377. <member name="F:ScottPlot.Control.Configuration.MiddleClickAutoAxis">
  378. <summary>
  379. Control whether middle-click can be used to reset axis limits
  380. </summary>
  381. </member>
  382. <member name="F:ScottPlot.Control.Configuration.MiddleClickAutoAxisMarginX">
  383. <summary>
  384. Horizontal margin between the edge of the data and the edge of the plot when middle-click AutoAxis is called
  385. </summary>
  386. </member>
  387. <member name="F:ScottPlot.Control.Configuration.MiddleClickAutoAxisMarginY">
  388. <summary>
  389. Vertical margin between the edge of the data and the edge of the plot when middle-click AutoAxis is called
  390. </summary>
  391. </member>
  392. <member name="F:ScottPlot.Control.Configuration.DoubleClickBenchmark">
  393. <summary>
  394. If enabled, double-clicking the plot will toggle benchmark visibility
  395. </summary>
  396. </member>
  397. <member name="F:ScottPlot.Control.Configuration.LockVerticalAxis">
  398. <summary>
  399. If enabled, the vertical axis limits cannot be modified by mouse actions
  400. </summary>
  401. </member>
  402. <member name="F:ScottPlot.Control.Configuration.LockHorizontalAxis">
  403. <summary>
  404. If enabled, the horizontal axis limits cannot be modified by mouse actions
  405. </summary>
  406. </member>
  407. <member name="F:ScottPlot.Control.Configuration.RenderIfPlottableListChanges">
  408. <summary>
  409. If enabled the control will automatically re-render as plottables are added and removed
  410. </summary>
  411. </member>
  412. <member name="F:ScottPlot.Control.Configuration.AxesChangedEventEnabled">
  413. <summary>
  414. Controls whether or not a render event will be triggered if a change in the axis limits is detected
  415. </summary>
  416. </member>
  417. <member name="F:ScottPlot.Control.Configuration.AllowDroppedFramesWhileDragging">
  418. <summary>
  419. Permitting dropped frames makes interactive mouse manipulation feel faster
  420. </summary>
  421. </member>
  422. <member name="F:ScottPlot.Control.Configuration.UseRenderQueue">
  423. <summary>
  424. If true, control interactions will be non-blocking and renders will occur after interactions.
  425. If false, control interactions will be blocking while renders are drawn.
  426. </summary>
  427. </member>
  428. <member name="F:ScottPlot.Control.Configuration.IgnoreMouseDragDistance">
  429. <summary>
  430. Distance (in pixels) the mouse can travel with a button held-down for it to be treated as a click (not a drag).
  431. A number slightly above zero allows middle-click to call AxisAuto() even if it was draged a few pixels by accident.
  432. </summary>
  433. </member>
  434. <member name="P:ScottPlot.Control.Configuration.WarnIfRenderNotCalledManually">
  435. <summary>
  436. Now that the timer-based auto-render functionality has been removed users must manually call Render() at least once.
  437. This option controls whether a warning message is shown if the user did not call Render() manually.
  438. </summary>
  439. </member>
  440. <member name="P:ScottPlot.Control.Configuration.DpiStretch">
  441. <summary>
  442. Control whether the plot should be stretched when DPI scaling is in use.
  443. Enabling stretching may result in blurry plots.
  444. Disabling stretching may results in plots with text that is too small.
  445. </summary>
  446. </member>
  447. <member name="P:ScottPlot.Control.Configuration.DpiStretchRatio">
  448. <summary>
  449. DPI scaling ratio to use for plot size and mouse tracking.
  450. Will return 1.0 if <see cref="P:ScottPlot.Control.Configuration.DpiStretch"/> is enabled.
  451. </summary>
  452. </member>
  453. <member name="E:ScottPlot.Control.Configuration.ScaleChanged">
  454. <summary>
  455. This event is invoked whenever the display scale is changed.
  456. </summary>
  457. </member>
  458. <member name="M:ScottPlot.Control.Configuration.DpiMeasure">
  459. <summary>
  460. Set the DpiStretchRatio to that of the active display.
  461. Call this if you suspect DPI scaling has changed.
  462. </summary>
  463. </member>
  464. <member name="T:ScottPlot.Control.DisplayScale">
  465. <summary>
  466. This class detects and stores display scale.
  467. The scale ratio is used to calculate plot size and
  468. translate mouse coordinates to real pixel coordinates.
  469. </summary>
  470. </member>
  471. <member name="P:ScottPlot.Control.DisplayScale.SystemScaleRatio">
  472. <summary>
  473. Scale ratio in use by the active display.
  474. This ratio is used when scaling is enabled.
  475. </summary>
  476. </member>
  477. <member name="P:ScottPlot.Control.DisplayScale.ManualScaleRatio">
  478. <summary>
  479. Scale ratio to use if scaling is disabled.
  480. </summary>
  481. </member>
  482. <member name="P:ScottPlot.Control.DisplayScale.Enabled">
  483. <summary>
  484. Control whether the plot bitmap should be stretched if display scaling is active.
  485. When enabled text will be large but may be blurry.
  486. When disabled text will be sharp but may be too small to read on high-resolution displays.
  487. </summary>
  488. </member>
  489. <member name="P:ScottPlot.Control.DisplayScale.ScaleRatio">
  490. <summary>
  491. Current display scale ratio.
  492. </summary>
  493. </member>
  494. <member name="E:ScottPlot.Control.DisplayScale.ScaleChanged">
  495. <summary>
  496. This event is invoked whenever the display scale is changed.
  497. </summary>
  498. </member>
  499. <member name="M:ScottPlot.Control.DisplayScale.Measure">
  500. <summary>
  501. Update the scale ratio using that of the active display.
  502. Call this method if you expect the display scale has changed.
  503. </summary>
  504. </member>
  505. <member name="T:ScottPlot.Control.EventProcess.UIEventFactory">
  506. <summary>
  507. This class takes details about interactions and builds them into event objects which can
  508. be passed into the event processor for processing/rendering when the render queue is free.
  509. </summary>
  510. </member>
  511. <member name="T:ScottPlot.Control.EventProcess.EventsProcessor">
  512. <summary>
  513. This event processor process incoming events and invokes renders as needed.
  514. This class contains logic to optionally display a fast preview render and a delayed high quality render.
  515. </summary>
  516. </member>
  517. <member name="F:ScottPlot.Control.EventProcess.EventsProcessor.Queue">
  518. <summary>
  519. List of events that have not yet been processed
  520. </summary>
  521. </member>
  522. <member name="F:ScottPlot.Control.EventProcess.EventsProcessor.Enable">
  523. <summary>
  524. The event processor loop will hang infinitely until this is set to True
  525. </summary>
  526. </member>
  527. <member name="F:ScottPlot.Control.EventProcess.EventsProcessor.RenderDelayTimer">
  528. <summary>
  529. This timer is used for delayed rendering.
  530. It is restarted whenever an event is processed which requests a delayed render.
  531. </summary>
  532. </member>
  533. <member name="F:ScottPlot.Control.EventProcess.EventsProcessor.QueueProcessorIsRunning">
  534. <summary>
  535. This is true while the processor is processing events and/or waiting for a delayed render.
  536. </summary>
  537. </member>
  538. <member name="P:ScottPlot.Control.EventProcess.EventsProcessor.RenderDelayMilliseconds">
  539. <summary>
  540. Time to wait after a low-quality render to invoke a high quality render
  541. </summary>
  542. </member>
  543. <member name="P:ScottPlot.Control.EventProcess.EventsProcessor.RenderAction">
  544. <summary>
  545. When a render is required this Action will be invoked.
  546. Its argument indicates whether low quality should be used.
  547. </summary>
  548. </member>
  549. <member name="M:ScottPlot.Control.EventProcess.EventsProcessor.#ctor(System.Action{System.Boolean},System.Int32)">
  550. <summary>
  551. Create a processor to invoke renders in response to incoming events
  552. </summary>
  553. <param name="renderAction">Action to invoke to perform a render. Bool argument is LowQuality.</param>
  554. <param name="renderDelay">Milliseconds after low-quality render to re-render using high quality.</param>
  555. </member>
  556. <member name="M:ScottPlot.Control.EventProcess.EventsProcessor.RenderHighQuality">
  557. <summary>
  558. Perform a high quality render.
  559. Call this instead of the action itself because this has better-documented arguments.
  560. </summary>
  561. </member>
  562. <member name="M:ScottPlot.Control.EventProcess.EventsProcessor.RenderLowQuality">
  563. <summary>
  564. Perform a low quality render.
  565. Call this instead of the action itself because this has better-documented arguments.
  566. </summary>
  567. </member>
  568. <member name="M:ScottPlot.Control.EventProcess.EventsProcessor.ProcessAsync(ScottPlot.Control.EventProcess.IUIEvent)">
  569. <summary>
  570. Add an event to the queue and process it when it is ready.
  571. After all events are processed a render will be called automatically by the queue processor.
  572. </summary>
  573. </member>
  574. <member name="M:ScottPlot.Control.EventProcess.EventsProcessor.RenderPreview(ScottPlot.RenderType)">
  575. <summary>
  576. Perform a low quality preview render if the render type allows it
  577. </summary>
  578. </member>
  579. <member name="M:ScottPlot.Control.EventProcess.EventsProcessor.RenderFinal(ScottPlot.RenderType)">
  580. <summary>
  581. Perform a final high quality render if the render type allows it.
  582. </summary>
  583. <returns>Return False if the final render needs to happen later</returns>
  584. </member>
  585. <member name="M:ScottPlot.Control.EventProcess.EventsProcessor.RunQueueProcessor">
  586. <summary>
  587. Process every event in the queue.
  588. A render will be executed after each event is processed.
  589. A slight delay will be added between queue checks.
  590. </summary>
  591. </member>
  592. <member name="T:ScottPlot.Control.EventProcess.Events.ApplyZoomRectangleEvent">
  593. <summary>
  594. This event describes what happens when the mouse button is lifted after
  595. middle-click-dragging a rectangle to zoom into. The coordinates of that rectangle
  596. are calculated, and the plot's axis limits are adjusted accordingly.
  597. </summary>
  598. </member>
  599. <member name="T:ScottPlot.Control.EventProcess.Events.BenchmarkToggleEvent">
  600. <summary>
  601. This event toggles visibility of the benchmark.
  602. This event is typically called after double-clicking the plot.
  603. </summary>
  604. </member>
  605. <member name="T:ScottPlot.Control.EventProcess.Events.MouseAxisAutoEvent">
  606. <summary>
  607. This event calls AxisAuto() on all axes.
  608. This is typically called after middle-clicking.
  609. </summary>
  610. </member>
  611. <member name="T:ScottPlot.Control.EventProcess.Events.MouseMovedToZoomRectangle">
  612. <summary>
  613. This event occurs when the user is actively middle-click-dragging to zoom.
  614. A zoom window is drawn on the screen, but axis limits have not yet been changed.
  615. </summary>
  616. </member>
  617. <member name="T:ScottPlot.Control.EventProcess.Events.MousePanEvent">
  618. <summary>
  619. This event describes represents interactive panning.
  620. It is assume the plot has already been reset to the pre-mouse-interaction state,
  621. and processing of this event pans the plot on the axes according to the distance
  622. the mouse has moved.
  623. This is typically called on MouseMove events when the left button is held down.
  624. </summary>
  625. </member>
  626. <member name="T:ScottPlot.Control.EventProcess.Events.MouseScrollEvent">
  627. <summary>
  628. This event describes a zoom operation performed by scrolling the mouse wheel.
  629. </summary>
  630. </member>
  631. <member name="T:ScottPlot.Control.EventProcess.Events.MouseUpClearRenderEvent">
  632. <summary>
  633. This event is called after the mouse button is lifted (typically following panning and zooming).
  634. It assumes all the axis manipulation (panning/zooming) has already been performed,
  635. and the purpose of this event is only to request an immediate high quality render.
  636. </summary>
  637. </member>
  638. <member name="T:ScottPlot.Control.EventProcess.Events.MouseZoomEvent">
  639. <summary>
  640. This event describes represents interactive zooming.
  641. It is assume the plot has already been reset to the pre-mouse-interaction state,
  642. and processing of this event zooms the plot on the axes according to the distance
  643. the mouse has moved.
  644. This is typically called on MouseMove events when the right button is held down.
  645. </summary>
  646. </member>
  647. <member name="T:ScottPlot.Control.EventProcess.Events.PlottableDragEvent">
  648. <summary>
  649. This event describes what happens when a draggable plottable (like an axis line)
  650. has been moved from its initial position. This event places the plottable of interest
  651. at the current mouse position.
  652. This is typically called on MouseMove events while left-click-dragging a draggable plottable.
  653. </summary>
  654. </member>
  655. <member name="T:ScottPlot.Control.QualityConfiguration">
  656. <summary>
  657. This class defines the quality to use for renders after different interactive events occur.
  658. Programmatically-triggered events typically use high quality mode (anti-aliasing enabled).
  659. Real-time mouse-interactive events like zooming and panning typically use low quality mode.
  660. It is possible to automatically render using high quality after a period of inactivity.
  661. </summary>
  662. </member>
  663. <member name="F:ScottPlot.Control.QualityMode.Low">
  664. <summary>
  665. Anti-aliasing always off
  666. </summary>
  667. </member>
  668. <member name="F:ScottPlot.Control.QualityMode.LowWhileDragging">
  669. <summary>
  670. Anti-aliasing off while dragging (more responsive) but on otherwise
  671. </summary>
  672. </member>
  673. <member name="F:ScottPlot.Control.QualityMode.High">
  674. <summary>
  675. Anti-aliasing always on
  676. </summary>
  677. </member>
  678. <member name="T:ScottPlot.Coordinate">
  679. <summary>
  680. Describes an X/Y position in coordinate space
  681. </summary>
  682. </member>
  683. <member name="M:ScottPlot.Coordinate.IsFinite">
  684. <summary>
  685. True as lone as neither coordinate is NaN or Infinity
  686. </summary>
  687. </member>
  688. <member name="M:ScottPlot.Coordinate.Distance(ScottPlot.Coordinate)">
  689. <summary>
  690. Return the distance to another coordinate (in coordinate units)
  691. </summary>
  692. </member>
  693. <member name="M:ScottPlot.DataGen.Consecutive(System.Int32,System.Double,System.Double)">
  694. <summary>
  695. Generates an array of numbers with constant spacing.
  696. </summary>
  697. <param name="pointCount">The number of points</param>
  698. <param name="spacing">The space between points. Default 1.</param>
  699. <param name="offset">The first point. Default 0</param>
  700. <returns>An array of numbers with constant spacing.</returns>
  701. </member>
  702. <member name="M:ScottPlot.DataGen.Sin(System.Double[],System.Double)">
  703. <summary>
  704. Generates an array of sine values of an input array.
  705. </summary>
  706. <param name="xs">The arguments to the sine function.</param>
  707. <param name="mult">A number to multiply the output by. Default 1.</param>
  708. <returns>An array of sine values</returns>
  709. </member>
  710. <member name="M:ScottPlot.DataGen.Sin(System.Int32,System.Double,System.Double,System.Double,System.Double)">
  711. <summary>
  712. Generates an array of sine values.
  713. </summary>
  714. <param name="pointCount">The number of values to generate.</param>
  715. <param name="oscillations">The number of periods. Default 1.</param>
  716. <param name="offset">The number to increment the output by. Default 0.</param>
  717. <param name="mult">The number to multiply the output by. Default 1.</param>
  718. <param name="phase">The fraction of a period to offset by. Default 0.</param>
  719. <returns>An array of sine values</returns>
  720. </member>
  721. <member name="M:ScottPlot.DataGen.SinSweep(System.Int32,System.Double)">
  722. <summary>
  723. Return data for a sine wave that increases frequency toward the end of an array.
  724. This function may be useful for inspecting rendering artifacts when data is displayed at different densities.
  725. </summary>
  726. <param name="pointCount">The number of values to generate.</param>
  727. <param name="density">Increasing this value increases maximum frequency.</param>
  728. <returns>An array of values</returns>
  729. </member>
  730. <member name="M:ScottPlot.DataGen.Cos(System.Double[],System.Double)">
  731. <summary>
  732. Generates an array of cosine values of an input array.
  733. </summary>
  734. <param name="xs">The arguments to the cosine function.</param>
  735. <param name="mult">A number to multiply the output by. Default 1.</param>
  736. <returns>An array of cosine values</returns>
  737. </member>
  738. <member name="M:ScottPlot.DataGen.Cos(System.Int32,System.Double,System.Double,System.Double,System.Double)">
  739. <summary>
  740. Generates an array of cosine values.
  741. </summary>
  742. <param name="pointCount">The number of values to generate.</param>
  743. <param name="oscillations">The number of periods. Default 1.</param>
  744. <param name="offset">The number to increment the output by. Default 0.</param>
  745. <param name="mult">The number to multiply the output by. Default 1.</param>
  746. <param name="phase">The fraction of a period to offset by. Default 0.</param>
  747. <returns>An array of cosine values</returns>
  748. </member>
  749. <member name="M:ScottPlot.DataGen.Tan(System.Double[],System.Double)">
  750. <summary>
  751. Generates an array of tangent values of an input array.
  752. </summary>
  753. <param name="xs">The arguments to the tangent function.</param>
  754. <param name="mult">A number to multiply the output by. Default 1.</param>
  755. <returns>An array of tangent values</returns>
  756. </member>
  757. <member name="M:ScottPlot.DataGen.Random(System.Random,System.Int32,System.Double,System.Double)">
  758. <summary>
  759. Generates an array of random numbers following a uniform distribution on the interval [offset, multiplier].
  760. </summary>
  761. <param name="rand">The Random object to use.</param>
  762. <param name="pointCount">The number of random points to generate.</param>
  763. <param name="multiplier">The maximum number above offset that may be generated.</param>
  764. <param name="offset">The minimum number that may be generated.</param>
  765. <returns>An array of random numbers.</returns>
  766. </member>
  767. <member name="M:ScottPlot.DataGen.Random2D(System.Random,System.Int32,System.Int32,System.Double,System.Double)">
  768. <summary>
  769. Generates a 2D array of random numbers between 0 and 1 (uniform distribution)
  770. </summary>
  771. <param name="rand">The Random object to use.</param>
  772. <param name="rows">number of rows (dimension 0)</param>
  773. <param name="columns">number of columns (dimension 1)</param>
  774. <param name="multiplier">Multiply values by this number after generation</param>
  775. <param name="offset">Add to values after multiplication</param>
  776. <returns>2D array filled with random numbers</returns>
  777. </member>
  778. <member name="M:ScottPlot.DataGen.RandomInts(System.Random,System.Int32,System.Double,System.Double)">
  779. <summary>
  780. Generates an array of random numbers following a uniform distribution on the interval [offset, multiplier].
  781. </summary>
  782. <param name="rand">The Random object to use.</param>
  783. <param name="pointCount">The number of random points to generate.</param>
  784. <param name="multiplier">The maximum number above offset that may be generated.</param>
  785. <param name="offset">The minimum number that may be generated.</param>
  786. <returns>An array of random numbers.</returns>
  787. </member>
  788. <member name="M:ScottPlot.DataGen.RandomNormalValue(System.Random,System.Double,System.Double,System.Double)">
  789. <summary>
  790. Generates a single value from a normal distribution.
  791. </summary>
  792. <param name="rand">The Random object to use.</param>
  793. <param name="mean">The mean of the distribution.</param>
  794. <param name="stdDev">The standard deviation of the distribution.</param>
  795. <param name="maxSdMultiple">The maximum distance from the mean to generate, given as a multiple of the standard deviation.</param>
  796. <returns>A single value from a normal distribution.</returns>
  797. </member>
  798. <member name="M:ScottPlot.DataGen.RandomNormal(System.Int32,System.Int32,System.Double,System.Double,System.Double)">
  799. <summary>
  800. Generates an array of values from a normal distribution.
  801. </summary>
  802. <param name="seed">The number to seed the random number generator with.</param>
  803. <param name="pointCount">The number of points to generate.</param>
  804. <param name="mean">The mean of the distribution.</param>
  805. <param name="stdDev">The standard deviation of the distribution.</param>
  806. <param name="maxSdMultiple">The maximum distance from the mean to generate, given as a multiple of the standard deviation.</param>
  807. <returns>An array of values from a normal distribution.</returns>
  808. </member>
  809. <member name="M:ScottPlot.DataGen.RandomNormal(System.Random,System.Int32,System.Double,System.Double,System.Double)">
  810. <summary>
  811. Generates an array of values from a normal distribution.
  812. </summary>
  813. <param name="rand">The Random object to use.</param>
  814. <param name="pointCount">The number of points to generate.</param>
  815. <param name="mean">The mean of the distribution.</param>
  816. <param name="stdDev">The standard deviation of the distribution.</param>
  817. <param name="maxSdMultiple">The maximum distance from the mean to generate, given as a multiple of the standard deviation.</param>
  818. <returns>An array of values from a normal distribution.</returns>
  819. </member>
  820. <member name="M:ScottPlot.DataGen.NoisyLinear(System.Random,System.Int32,System.Double,System.Double,System.Double)">
  821. <summary>
  822. Generates an array of data with normally distributed residuals about a line.
  823. </summary>
  824. <param name="rand">The Random object to use.</param>
  825. <param name="pointCount">The number of points to generate. Default 100.</param>
  826. <param name="slope">The slope of the line. Default 1.</param>
  827. <param name="offset">The y-intercept of the line. Default 0.</param>
  828. <param name="noise">The standard deviation of the residuals. Default 0.1</param>
  829. <returns>An array of approximately linear data.</returns>
  830. </member>
  831. <member name="M:ScottPlot.DataGen.NoisySin(System.Random,System.Int32,System.Double,System.Double,System.Double)">
  832. <summary>
  833. Generates an array of data with uniformally distributed residuals about a sinusoidal curve.
  834. </summary>
  835. <param name="rand">The Random object to use.</param>
  836. <param name="pointCount">The number of points to generate.</param>
  837. <param name="oscillations">The number of periods. Default 1.</param>
  838. <param name="noiseLevel">Twice the maximum residual, in units of mult. Default 0.5</param>
  839. <param name="mult">The number to multiply the residuals by. Default 1.</param>
  840. <returns>An array of approximately sinusoidal data.</returns>
  841. </member>
  842. <member name="M:ScottPlot.DataGen.RandomColor(System.Random,System.Int32,System.Int32)">
  843. <summary>
  844. Generates a random color.
  845. </summary>
  846. <param name="rand">The Random object to use.</param>
  847. <param name="min">The min of each component. Default 0.</param>
  848. <param name="max">The max of each component. Default 255.</param>
  849. <returns>A random color.</returns>
  850. </member>
  851. <member name="M:ScottPlot.DataGen.RandomWalk(System.Int32,System.Double,System.Double)">
  852. <summary>
  853. Return the cumulative sum of a random set of numbers using a fixed seed
  854. </summary>
  855. <param name="pointCount">The number of points to generate.</param>
  856. <param name="mult">The max difference between points in the walk. Default 1.</param>
  857. <param name="offset">The first point in the walk. Default 0.</param>
  858. <returns>The cumulative sum of a random set of numbers.</returns>
  859. </member>
  860. <member name="M:ScottPlot.DataGen.RandomWalk(System.Random,System.Int32,System.Double,System.Double)">
  861. <summary>
  862. Return the cumulative sum of a random set of numbers.
  863. </summary>
  864. <param name="rand">The random object to use.</param>
  865. <param name="pointCount">The number of points to generate.</param>
  866. <param name="mult">The max difference between points in the walk. Default 1.</param>
  867. <param name="offset">The first point in the walk. Default 0.</param>
  868. <returns>The cumulative sum of a random set of numbers.</returns>
  869. </member>
  870. <member name="M:ScottPlot.DataGen.RandomWalk2D(System.Random,System.Int32)">
  871. <summary>
  872. Generate unevenly-spaced X/Y points.
  873. X values walk upward (by values from 0 to 1)
  874. Y values walk randomly (by values from -1 to 1)
  875. </summary>
  876. </member>
  877. <member name="M:ScottPlot.DataGen.RandomStockPrices(System.Random,System.Int32,System.TimeSpan,System.Double,System.Double)">
  878. <summary>
  879. Return OHLC array with random prices X positions as DateTime.ToOATime() values using the given time delta
  880. </summary>
  881. <param name="rand">The random object to use.</param>
  882. <param name="pointCount">The number of prices to generate.</param>
  883. <param name="delta">The difference in time between prices.</param>
  884. <param name="mult">The max difference between base prices around which that day's prices independently vary. Default 10.</param>
  885. <param name="startingPrice">The initial base price. Default 123.45</param>
  886. <returns>OHLC array with random prices</returns>
  887. </member>
  888. <member name="M:ScottPlot.DataGen.RandomStockPrices(System.Random,System.Int32,System.Double,System.Double)">
  889. <summary>
  890. Return OHLC array with random prices X positions as sequential numbers (0, 1, 2, etc.)
  891. </summary>
  892. <param name="rand">The random object to use.</param>
  893. <param name="pointCount">The number of prices to generate.</param>
  894. <param name="mult">The max difference between base prices around which that day's prices independently vary. Default 10.</param>
  895. <param name="startingPrice">The initial base price. Default 123.45</param>
  896. <returns>OHLC array with random prices</returns>
  897. </member>
  898. <member name="M:ScottPlot.DataGen.RandomStockPrices(System.Random,System.Int32,System.Double,System.Double,System.Int32,System.Int32,System.Boolean)">
  899. <summary>
  900. Return OHLC array with random prices X positions as sequential numbers (0, 1, 2, etc.)
  901. </summary>
  902. <param name="rand">The random object to use.</param>
  903. <param name="pointCount">The number of prices to generate.</param>
  904. <param name="mult">The max difference between base prices around which that day's prices independently vary. Default 10.</param>
  905. <param name="startingPrice">The initial base price. Default 123.45</param>
  906. <param name="deltaMinutes">The minutes between prices. Cumulative with deltaDays. Default 0.</param>
  907. <param name="deltaDays">The days between prices. Cumulative with deltaMinutes. Default 1.</param>
  908. <param name="sequential">Whether to use TimeSpan or integer x axis.</param>
  909. <returns>OHLC array with random prices</returns>
  910. </member>
  911. <member name="M:ScottPlot.DataGen.RandomSpan(System.Random,System.Double,System.Double,System.Double)">
  912. <summary>
  913. Generates a random span.
  914. </summary>
  915. <param name="rand">The random object to use.</param>
  916. <param name="low">The minimum of the span. Default 0.</param>
  917. <param name="high">Tge naximum of the span. Default 100.</param>
  918. <param name="minimumSpacing">The minimum length of the span. Default 10.</param>
  919. <returns>A random span.</returns>
  920. </member>
  921. <member name="M:ScottPlot.DataGen.Range(System.Int32)">
  922. <summary>
  923. Generates a range of values starting at 0 and separated by 1.
  924. </summary>
  925. <param name="stop">The end of the range.</param>
  926. <returns>A range of values.</returns>
  927. </member>
  928. <member name="M:ScottPlot.DataGen.Range(System.Int32,System.Int32)">
  929. <summary>
  930. Generates a range of values separated by 1.
  931. </summary>
  932. <param name="start">The start of the range.</param>
  933. <param name="stop">The end of the range.</param>
  934. <returns>A range of values.</returns>
  935. </member>
  936. <member name="M:ScottPlot.DataGen.Range(System.Double,System.Double,System.Double,System.Boolean)">
  937. <summary>
  938. Generates a range of values.
  939. </summary>
  940. <param name="start">The start of the range.</param>
  941. <param name="stop">The end of the range.</param>
  942. <param name="step">The space between values.</param>
  943. <param name="includeStop">Indicates whether to include the stop point in the range. Default false.</param>
  944. <returns>A range of values.</returns>
  945. </member>
  946. <member name="M:ScottPlot.DataGen.Zeros(System.Int32)">
  947. <summary>
  948. Generates an array of zeros
  949. </summary>
  950. <param name="pointCount">The number of zeroes to generate</param>
  951. <returns>An array of zeros</returns>
  952. </member>
  953. <member name="M:ScottPlot.DataGen.Ones(System.Int32)">
  954. <summary>
  955. Generates an array of ones
  956. </summary>
  957. <param name="pointCount">The number of ones to generate</param>
  958. <returns>An array of ones</returns>
  959. </member>
  960. <member name="M:ScottPlot.DataGen.BitmapFrom2dArray(System.Double[0:,0:],ScottPlot.Drawing.Colormap)">
  961. <summary>
  962. Generates a Bitmap from data on the range [0, 255]
  963. </summary>
  964. <param name="data">The data to use.</param>
  965. <param name="cmap">The colormap to use.</param>
  966. <returns>A Bitmap</returns>
  967. </member>
  968. <member name="M:ScottPlot.DataGen.SampleImage">
  969. <summary>
  970. Generates a sample Bitmap.
  971. </summary>
  972. <returns>A sample Bitmap</returns>
  973. </member>
  974. <member name="M:ScottPlot.DataGen.SampleImageData">
  975. <summary>
  976. Returns a sample 2D array of grayscale values.
  977. </summary>
  978. <returns>2D array of grayscale values.</returns>
  979. </member>
  980. <member name="M:ScottPlot.DataGen.ActionPotential">
  981. <summary>
  982. Recording of a neuronal action potential (100 ms, 20 kHz sample rate, mV units)
  983. </summary>
  984. <returns>Recording of a neuronal action potential</returns>
  985. </member>
  986. <member name="P:ScottPlot.Drawing.Colormap.Name">
  987. <summary>
  988. Name of this colormap
  989. </summary>
  990. </member>
  991. <member name="M:ScottPlot.Drawing.Colormap.GetColormaps">
  992. <summary>
  993. Create new instances of every colormap and return them as an array.
  994. </summary>
  995. <returns></returns>
  996. </member>
  997. <member name="M:ScottPlot.Drawing.Colormap.GetColormapNames">
  998. <summary>
  999. Return the names of all available colormaps.
  1000. </summary>
  1001. <returns></returns>
  1002. </member>
  1003. <member name="M:ScottPlot.Drawing.Colormap.GetColormapByName(System.String,System.Boolean)">
  1004. <summary>
  1005. Create a new colormap by its name.
  1006. </summary>
  1007. <param name="name">colormap name</param>
  1008. <param name="throwIfNotFound">if false the default colormap (Viridis) will be returned</param>
  1009. <returns></returns>
  1010. </member>
  1011. <member name="M:ScottPlot.Drawing.Colormap.Colorbar(ScottPlot.Drawing.Colormap,System.Int32,System.Int32,System.Boolean,System.Double,System.Double)">
  1012. <summary>
  1013. Return a bitmap showing the gradient of colors in a colormap.
  1014. Defining min/max will create an image containing only part of the colormap.
  1015. </summary>
  1016. </member>
  1017. <member name="M:ScottPlot.Drawing.GDI.GetScaleRatio">
  1018. <summary>
  1019. Return the display scale ratio being used.
  1020. A scaling ratio of 1.0 means scaling is not active.
  1021. </summary>
  1022. </member>
  1023. <member name="M:ScottPlot.Drawing.GDI.TranslateString(System.String,ScottPlot.Drawing.Font)">
  1024. <summary>
  1025. Return the X and Y distance (pixels) necessary to translate the canvas for the given text/font/alignment
  1026. </summary>
  1027. </member>
  1028. <member name="M:ScottPlot.Drawing.InstalledFont.ValidFontName(System.String)">
  1029. <summary>
  1030. Returns a font name guaranteed to be installed on the system
  1031. </summary>
  1032. </member>
  1033. <member name="M:ScottPlot.Drawing.InstalledFont.ValidFontName(System.String[])">
  1034. <summary>
  1035. Returns a font name guaranteed to be installed on the system
  1036. </summary>
  1037. </member>
  1038. <member name="M:ScottPlot.Drawing.Tools.PolyAboveAndBelow(System.Double[],System.Double[],System.Double)">
  1039. <summary>
  1040. Return Xs and Ys for 2 polygons representing the input data above and below the given baseline
  1041. </summary>
  1042. </member>
  1043. <member name="T:ScottPlot.Alignment">
  1044. <summary>
  1045. Vertical (upper/middle/lower) and Horizontal (left/center/right) alignment
  1046. </summary>
  1047. </member>
  1048. <member name="F:ScottPlot.ArrowAnchor.Base">
  1049. <summary>
  1050. X/Y coordinates define the base of the arrow
  1051. </summary>
  1052. </member>
  1053. <member name="F:ScottPlot.ArrowAnchor.Center">
  1054. <summary>
  1055. X/Y coordinates define the center of the arrow
  1056. </summary>
  1057. </member>
  1058. <member name="F:ScottPlot.ArrowAnchor.Tip">
  1059. <summary>
  1060. X/Y coordinates define the tip of the arrow
  1061. </summary>
  1062. </member>
  1063. <member name="T:ScottPlot.EqualScaleMode">
  1064. <summary>
  1065. Defines if/how axis scales (units per pixel) are matched between horizontal and vertical axes.
  1066. </summary>
  1067. </member>
  1068. <member name="F:ScottPlot.EqualScaleMode.Disabled">
  1069. <summary>
  1070. Horizontal and vertical axes can be scaled independently.
  1071. Squares and circles may stretch to rectangles and ovals.
  1072. </summary>
  1073. </member>
  1074. <member name="F:ScottPlot.EqualScaleMode.PreserveY">
  1075. <summary>
  1076. Axis scales are locked so geometry of squares and circles is preserved.
  1077. After axes are set, the vertical scale (units per pixel) is applied to the horizontal axis.
  1078. </summary>
  1079. </member>
  1080. <member name="F:ScottPlot.EqualScaleMode.PreserveX">
  1081. <summary>
  1082. Axis scales are locked so geometry of squares and circles is preserved.
  1083. After axes are set, the horizontal scale (units per pixel) is applied to the vertical axis.
  1084. </summary>
  1085. </member>
  1086. <member name="F:ScottPlot.EqualScaleMode.ZoomOut">
  1087. <summary>
  1088. Axis scales are locked so geometry of squares and circles is preserved.
  1089. After axes are set, the largest scale (most units per pixel) is applied to both axes.
  1090. Apply the most zoomed-out scale to both axes.
  1091. </summary>
  1092. </member>
  1093. <member name="F:ScottPlot.EqualScaleMode.PreserveLargest">
  1094. <summary>
  1095. Apply the scale of the larger axis to both axes.
  1096. </summary>
  1097. </member>
  1098. <member name="F:ScottPlot.EqualScaleMode.PreserveSmallest">
  1099. <summary>
  1100. Apply the scale of the smaller axis to both axes.
  1101. </summary>
  1102. </member>
  1103. <member name="T:ScottPlot.ImagePlacement">
  1104. <summary>
  1105. Defines how an image will be placed in Radar and CoxComb charts
  1106. </summary>
  1107. </member>
  1108. <member name="F:ScottPlot.ImagePlacement.Outside">
  1109. <summary>
  1110. Images will be aligned at the arms of the chart
  1111. </summary>
  1112. </member>
  1113. <member name="F:ScottPlot.ImagePlacement.Inside">
  1114. <summary>
  1115. Images will be aligned halfway in the space between arms of the chart
  1116. </summary>
  1117. </member>
  1118. <member name="F:ScottPlot.RadialGaugeMode.Stacked">
  1119. <summary>
  1120. Successive gauges start outward from the center but start at the same angle
  1121. </summary>
  1122. </member>
  1123. <member name="F:ScottPlot.RadialGaugeMode.Sequential">
  1124. <summary>
  1125. Successive gauges start outward from the center and start at sequential angles
  1126. </summary>
  1127. </member>
  1128. <member name="F:ScottPlot.RadialGaugeMode.SingleGauge">
  1129. <summary>
  1130. Gauges are all the same distance from the center but start at sequential angles
  1131. </summary>
  1132. </member>
  1133. <member name="T:ScottPlot.RenderType">
  1134. <summary>
  1135. Describes how a render should be performed with respect to quality.
  1136. High quality enables anti-aliasing but is slower.
  1137. Some options describe multiple renders, with or without a delay between them.
  1138. </summary>
  1139. </member>
  1140. <member name="F:ScottPlot.RenderType.LowQuality">
  1141. <summary>
  1142. Only render using low quality (anti-aliasing off)
  1143. </summary>
  1144. </member>
  1145. <member name="F:ScottPlot.RenderType.HighQuality">
  1146. <summary>
  1147. Only render using high quality (anti-aliasing on)
  1148. </summary>
  1149. </member>
  1150. <member name="F:ScottPlot.RenderType.HighQualityDelayed">
  1151. <summary>
  1152. Perform a high quality render after a delay.
  1153. This is the best render type to use when resizing windows.
  1154. </summary>
  1155. </member>
  1156. <member name="F:ScottPlot.RenderType.LowQualityThenHighQuality">
  1157. <summary>
  1158. Render low quality and display it, then if no new render requests
  1159. have been received immediately render a high quality version and display it.
  1160. This is the best render option to use when requesting renders programmatically
  1161. </summary>
  1162. </member>
  1163. <member name="F:ScottPlot.RenderType.LowQualityThenHighQualityDelayed">
  1164. <summary>
  1165. Render low quality and display it, wait a small period of time for new render requests to arrive,
  1166. and if no new requests have been received render a high quality version and display it.
  1167. This is the best render option to use for mouse interaction.
  1168. </summary>
  1169. </member>
  1170. <member name="F:ScottPlot.RenderType.ProcessMouseEventsOnly">
  1171. <summary>
  1172. Process mouse events only (pan, zoom, etc) and do not render graphics on a Bitmap,
  1173. then if no new requests have been received render using the last-used render type.
  1174. </summary>
  1175. </member>
  1176. <member name="M:ScottPlot.Palette.FromHtmlColors(System.String[])">
  1177. <summary>
  1178. Create a new color palette from an array of HTML colors
  1179. </summary>
  1180. </member>
  1181. <member name="M:ScottPlot.Palette.GetPalettes">
  1182. <summary>
  1183. Return an array containing every available style
  1184. </summary>
  1185. </member>
  1186. <member name="T:ScottPlot.Pixel">
  1187. <summary>
  1188. Describes an X/Y position in pixel space
  1189. </summary>
  1190. </member>
  1191. <member name="M:ScottPlot.Pixel.IsFinite">
  1192. <summary>
  1193. True as lone as neither coordinate is NaN or Infinity
  1194. </summary>
  1195. </member>
  1196. <member name="M:ScottPlot.Pixel.Distance(ScottPlot.Pixel)">
  1197. <summary>
  1198. Return the distance to another pixel (in pixel units)
  1199. </summary>
  1200. </member>
  1201. <member name="M:ScottPlot.Pixel.Translate(System.Single,System.Single)">
  1202. <summary>
  1203. Shift the pixel location by the given deltas
  1204. </summary>
  1205. </member>
  1206. <member name="T:ScottPlot.PlotDimensions">
  1207. <summary>
  1208. PlotDimensions supplies figure dimensions and pixel/coordinate lookup methods for a single 2D plane
  1209. </summary>
  1210. </member>
  1211. <member name="T:ScottPlot.Plottable.Annotation">
  1212. <summary>
  1213. Text placed at a location relative to the data area that does not move when the axis limits change
  1214. </summary>
  1215. </member>
  1216. <member name="F:ScottPlot.Plottable.Annotation.X">
  1217. <summary>
  1218. Horizontal location (in pixel units) relative to the data area
  1219. </summary>
  1220. </member>
  1221. <member name="F:ScottPlot.Plottable.Annotation.Y">
  1222. <summary>
  1223. Vertical position (in pixel units) relative to the data area
  1224. </summary>
  1225. </member>
  1226. <member name="F:ScottPlot.Plottable.Annotation.Label">
  1227. <summary>
  1228. Text displayed in the annotation
  1229. </summary>
  1230. </member>
  1231. <member name="T:ScottPlot.Plottable.ArrowCoordinated">
  1232. <summary>
  1233. An arrow with X/Y coordinates for the base and the tip
  1234. </summary>
  1235. </member>
  1236. <member name="F:ScottPlot.Plottable.ArrowCoordinated.Base">
  1237. <summary>
  1238. Location of the arrow base in coordinate space
  1239. </summary>
  1240. </member>
  1241. <member name="F:ScottPlot.Plottable.ArrowCoordinated.Tip">
  1242. <summary>
  1243. Location of the arrow base in coordinate space
  1244. </summary>
  1245. </member>
  1246. <member name="F:ScottPlot.Plottable.ArrowCoordinated.Color">
  1247. <summary>
  1248. Color of the arrow and arrowhead
  1249. </summary>
  1250. </member>
  1251. <member name="F:ScottPlot.Plottable.ArrowCoordinated.LineWidth">
  1252. <summary>
  1253. Thickness of the arrow line
  1254. </summary>
  1255. </member>
  1256. <member name="F:ScottPlot.Plottable.ArrowCoordinated.LineStyle">
  1257. <summary>
  1258. Style of the arrow line
  1259. </summary>
  1260. </member>
  1261. <member name="F:ScottPlot.Plottable.ArrowCoordinated.Label">
  1262. <summary>
  1263. Label to appear in the legend
  1264. </summary>
  1265. </member>
  1266. <member name="F:ScottPlot.Plottable.ArrowCoordinated.ArrowheadWidth">
  1267. <summary>
  1268. Width of the arrowhead (pixels)
  1269. </summary>
  1270. </member>
  1271. <member name="F:ScottPlot.Plottable.ArrowCoordinated.ArrowheadLength">
  1272. <summary>
  1273. Height of the arrowhead (pixels)
  1274. </summary>
  1275. </member>
  1276. <member name="F:ScottPlot.Plottable.ArrowCoordinated.MinimumLengthPixels">
  1277. <summary>
  1278. The arrow will be lengthened to ensure it is at least this size on the screen
  1279. </summary>
  1280. </member>
  1281. <member name="F:ScottPlot.Plottable.ArrowCoordinated.MarkerShape">
  1282. <summary>
  1283. Marker to be drawn at the base (if MarkerSize > 0)
  1284. </summary>
  1285. </member>
  1286. <member name="F:ScottPlot.Plottable.ArrowCoordinated.MarkerSize">
  1287. <summary>
  1288. Size of marker (in pixels) to draw at the base
  1289. </summary>
  1290. </member>
  1291. <member name="F:ScottPlot.Plottable.AxisLine.Position">
  1292. <summary>
  1293. Location of the line (Y position if horizontal line, X position if vertical line)
  1294. </summary>
  1295. </member>
  1296. <member name="F:ScottPlot.Plottable.AxisLine.PositionLabel">
  1297. <summary>
  1298. If True, the position will be labeled on the axis using the PositionFormatter
  1299. </summary>
  1300. </member>
  1301. <member name="F:ScottPlot.Plottable.AxisLine.PositionLabelFont">
  1302. <summary>
  1303. Font to use for position labels (labels drawn over the axis)
  1304. </summary>
  1305. </member>
  1306. <member name="F:ScottPlot.Plottable.AxisLine.PositionLabelBackground">
  1307. <summary>
  1308. Color to use behind the position labels
  1309. </summary>
  1310. </member>
  1311. <member name="F:ScottPlot.Plottable.AxisLine.PositionLabelOppositeAxis">
  1312. <summary>
  1313. If true the position label will be drawn on the right or top of the data area.
  1314. </summary>
  1315. </member>
  1316. <member name="F:ScottPlot.Plottable.AxisLine.PositionFormatter">
  1317. <summary>
  1318. This method generates the position label text for numeric (non-DateTime) axes.
  1319. For DateTime axes assign your own format string that uses DateTime.FromOADate(position).
  1320. </summary>
  1321. </member>
  1322. <member name="P:ScottPlot.Plottable.AxisLine.DateTime">
  1323. <summary>
  1324. Position of the axis line in DateTime (OADate) units.
  1325. </summary>
  1326. </member>
  1327. <member name="F:ScottPlot.Plottable.AxisLine.IsHorizontal">
  1328. <summary>
  1329. Indicates whether the line is horizontal (position in Y units) or vertical (position in X units)
  1330. </summary>
  1331. </member>
  1332. <member name="F:ScottPlot.Plottable.AxisLine.IgnoreAxisAuto">
  1333. <summary>
  1334. If true, AxisAuto() will ignore the position of this line when determining axis limits
  1335. </summary>
  1336. </member>
  1337. <member name="F:ScottPlot.Plottable.AxisLine.Label">
  1338. <summary>
  1339. Text that appears in the legend
  1340. </summary>
  1341. </member>
  1342. <member name="P:ScottPlot.Plottable.AxisLine.DragEnabled">
  1343. <summary>
  1344. Indicates whether this line is draggable in user controls.
  1345. </summary>
  1346. </member>
  1347. <member name="P:ScottPlot.Plottable.AxisLine.DragCursor">
  1348. <summary>
  1349. Cursor to display while hovering over this line if dragging is enabled.
  1350. </summary>
  1351. </member>
  1352. <member name="F:ScottPlot.Plottable.AxisLine.DragLimitMin">
  1353. <summary>
  1354. If dragging is enabled the line cannot be dragged more negative than this position
  1355. </summary>
  1356. </member>
  1357. <member name="F:ScottPlot.Plottable.AxisLine.DragLimitMax">
  1358. <summary>
  1359. If dragging is enabled the line cannot be dragged more positive than this position
  1360. </summary>
  1361. </member>
  1362. <member name="E:ScottPlot.Plottable.AxisLine.Dragged">
  1363. <summary>
  1364. This event is invoked after the line is dragged
  1365. </summary>
  1366. </member>
  1367. <member name="F:ScottPlot.Plottable.AxisLine.Min">
  1368. <summary>
  1369. The lower bound of the axis line.
  1370. </summary>
  1371. </member>
  1372. <member name="F:ScottPlot.Plottable.AxisLine.Max">
  1373. <summary>
  1374. The upper bound of the axis line.
  1375. </summary>
  1376. </member>
  1377. <member name="M:ScottPlot.Plottable.AxisLine.DragTo(System.Double,System.Double,System.Boolean)">
  1378. <summary>
  1379. Move the line to a new coordinate in plot space.
  1380. </summary>
  1381. <param name="coordinateX">new X position</param>
  1382. <param name="coordinateY">new Y position</param>
  1383. <param name="fixedSize">This argument is ignored</param>
  1384. </member>
  1385. <member name="M:ScottPlot.Plottable.AxisLine.IsUnderMouse(System.Double,System.Double,System.Double,System.Double)">
  1386. <summary>
  1387. Return True if the line is within a certain number of pixels (snap) to the mouse
  1388. </summary>
  1389. <param name="coordinateX">mouse position (coordinate space)</param>
  1390. <param name="coordinateY">mouse position (coordinate space)</param>
  1391. <param name="snapX">snap distance (pixels)</param>
  1392. <param name="snapY">snap distance (pixels)</param>
  1393. <returns></returns>
  1394. </member>
  1395. <member name="T:ScottPlot.Plottable.HSpan">
  1396. <summary>
  1397. Shaded horizontal region between two X values
  1398. </summary>
  1399. </member>
  1400. <member name="T:ScottPlot.Plottable.VSpan">
  1401. <summary>
  1402. Shade the region between two Y values
  1403. </summary>
  1404. </member>
  1405. <member name="F:ScottPlot.Plottable.AxisSpan.IgnoreAxisAuto">
  1406. <summary>
  1407. If true, AxisAuto() will ignore the position of this span when determining axis limits
  1408. </summary>
  1409. </member>
  1410. <member name="E:ScottPlot.Plottable.AxisSpan.Dragged">
  1411. <summary>
  1412. This event is invoked after the line is dragged
  1413. </summary>
  1414. </member>
  1415. <member name="M:ScottPlot.Plottable.AxisSpan.IsUnderMouse(System.Double,System.Double,System.Double,System.Double)">
  1416. <summary>
  1417. Return True if either span edge is within a certain number of pixels (snap) to the mouse
  1418. </summary>
  1419. <param name="coordinateX">mouse position (coordinate space)</param>
  1420. <param name="coordinateY">mouse position (coordinate space)</param>
  1421. <param name="snapX">snap distance (pixels)</param>
  1422. <param name="snapY">snap distance (pixels)</param>
  1423. <returns></returns>
  1424. </member>
  1425. <member name="M:ScottPlot.Plottable.AxisSpan.DragTo(System.Double,System.Double,System.Boolean)">
  1426. <summary>
  1427. Move the span to a new coordinate in plot space.
  1428. </summary>
  1429. <param name="coordinateX">new X position</param>
  1430. <param name="coordinateY">new Y position</param>
  1431. <param name="fixedSize">if True, both edges will be moved to maintain the size of the span</param>
  1432. </member>
  1433. <member name="T:ScottPlot.Plottable.BarPlot">
  1434. <summary>
  1435. Bar plots display a series of bars.
  1436. Positions are defined by Xs.
  1437. Heights are defined by Ys (relative to BaseValue and YOffsets).
  1438. </summary>
  1439. </member>
  1440. <member name="F:ScottPlot.Plottable.BarPlotBase.Orientation">
  1441. <summary>
  1442. Orientation of the bars.
  1443. Default behavior is vertical so values are on the Y axis and positions are on the X axis.
  1444. </summary>
  1445. </member>
  1446. <member name="P:ScottPlot.Plottable.BarPlotBase.PositionOffset">
  1447. <summary>
  1448. The position of each bar defines where the left edge of the bar should be.
  1449. To center the bar at each position, adjust this value to be negative one-half of the BarWidth.
  1450. </summary>
  1451. </member>
  1452. <member name="P:ScottPlot.Plottable.BarPlotBase.Values">
  1453. <summary>
  1454. Size of each bar (along the axis defined by Orientation) relative to ValueBase
  1455. </summary>
  1456. </member>
  1457. <member name="P:ScottPlot.Plottable.BarPlotBase.Positions">
  1458. <summary>
  1459. Location of the left edge of each bar.
  1460. To center bars on these positions, adjust PositionOffset to be negative one-half of the BarWidth.
  1461. </summary>
  1462. </member>
  1463. <member name="P:ScottPlot.Plottable.BarPlotBase.ValueOffsets">
  1464. <summary>
  1465. This array defines the base of each bar.
  1466. Unless the user specifically defines it, this will be an array of zeros.
  1467. </summary>
  1468. </member>
  1469. <member name="P:ScottPlot.Plottable.BarPlotBase.ValueErrors">
  1470. <summary>
  1471. If populated, this array describes the height of errorbars for each bar
  1472. </summary>
  1473. </member>
  1474. <member name="P:ScottPlot.Plottable.BarPlotBase.ShowValuesAboveBars">
  1475. <summary>
  1476. If true, errorbars will be drawn according to the values in the YErrors array
  1477. </summary>
  1478. </member>
  1479. <member name="P:ScottPlot.Plottable.BarPlotBase.ValueBase">
  1480. <summary>
  1481. Bars are drawn from this level and extend according to the sizes defined in Values[]
  1482. </summary>
  1483. </member>
  1484. <member name="F:ScottPlot.Plottable.BarPlotBase.BarWidth">
  1485. <summary>
  1486. Width of bars defined in axis units.
  1487. If bars are evenly spaced, consider setting this to a fraction of the distance between the first two Positions.
  1488. </summary>
  1489. </member>
  1490. <member name="F:ScottPlot.Plottable.BarPlotBase.ErrorCapSize">
  1491. <summary>
  1492. Width of the errorbar caps defined in axis units.
  1493. </summary>
  1494. </member>
  1495. <member name="F:ScottPlot.Plottable.BarPlotBase.ErrorLineWidth">
  1496. <summary>
  1497. Thickness of the errorbar lines (pixel units)
  1498. </summary>
  1499. </member>
  1500. <member name="F:ScottPlot.Plottable.BarPlotBase.BorderColor">
  1501. <summary>
  1502. Outline each bar with this color.
  1503. Set this to transparent to disable outlines.
  1504. </summary>
  1505. </member>
  1506. <member name="F:ScottPlot.Plottable.BarPlotBase.ErrorColor">
  1507. <summary>
  1508. Color of errorbar lines.
  1509. </summary>
  1510. </member>
  1511. <member name="F:ScottPlot.Plottable.BarPlotBase.Font">
  1512. <summary>
  1513. Font settings for labels drawn above the bars
  1514. </summary>
  1515. </member>
  1516. <member name="T:ScottPlot.Plottable.BubblePlot">
  1517. <summary>
  1518. Display circles of user-defined sizes and colors at specific X/Y positions
  1519. </summary>
  1520. </member>
  1521. <member name="M:ScottPlot.Plottable.BubblePlot.Clear">
  1522. <summary>
  1523. Clear all bubbles
  1524. </summary>
  1525. </member>
  1526. <member name="M:ScottPlot.Plottable.BubblePlot.Add(System.Double,System.Double,System.Double,System.Drawing.Color,System.Double,System.Drawing.Color)">
  1527. <summary>
  1528. Add a single bubble
  1529. </summary>
  1530. <param name="x">horizontal position (in coordinate space)</param>
  1531. <param name="y">horizontal vertical (in coordinate space)</param>
  1532. <param name="radius">size of the bubble (in pixels)</param>
  1533. <param name="fillColor"></param>
  1534. <param name="edgeWidth">size of the outline (in pixels)</param>
  1535. <param name="edgeColor"></param>
  1536. </member>
  1537. <member name="M:ScottPlot.Plottable.BubblePlot.Add(System.Double[],System.Double[],System.Double,System.Drawing.Color,System.Double,System.Drawing.Color)">
  1538. <summary>
  1539. Add many bubbles with the same size and style
  1540. </summary>
  1541. </member>
  1542. <member name="T:ScottPlot.Plottable.ClevelandDotPlot">
  1543. <summary>
  1544. Cleveland Dot plots display a series of paired p[oints.
  1545. Positions are defined by Xs.
  1546. Heights are defined by Ys1 and Ys2 (internally done with Ys and YOffsets).
  1547. </summary>
  1548. </member>
  1549. <member name="F:ScottPlot.Plottable.ClevelandDotPlot.StemColor">
  1550. <summary>
  1551. Color for the line
  1552. </summary>
  1553. </member>
  1554. <member name="P:ScottPlot.Plottable.ClevelandDotPlot.DotRadius">
  1555. <summary>
  1556. Size of the markers at the ends of each line
  1557. </summary>
  1558. </member>
  1559. <member name="F:ScottPlot.Plottable.ClevelandDotPlot.Label1">
  1560. <summary>
  1561. Text to display in the legend associated with the series 1 data
  1562. </summary>
  1563. </member>
  1564. <member name="F:ScottPlot.Plottable.ClevelandDotPlot.Color1">
  1565. <summary>
  1566. Color for one of the markers
  1567. </summary>
  1568. </member>
  1569. <member name="F:ScottPlot.Plottable.ClevelandDotPlot.MarkerShape1">
  1570. <summary>
  1571. Marker to use for the series 1 data
  1572. </summary>
  1573. </member>
  1574. <member name="F:ScottPlot.Plottable.ClevelandDotPlot.Label2">
  1575. <summary>
  1576. Text to display in the legend associated with the series 2 data
  1577. </summary>
  1578. </member>
  1579. <member name="F:ScottPlot.Plottable.ClevelandDotPlot.Color2">
  1580. <summary>
  1581. Color for one of the markers
  1582. </summary>
  1583. </member>
  1584. <member name="F:ScottPlot.Plottable.ClevelandDotPlot.MarkerShape2">
  1585. <summary>
  1586. Marker to use for the series 2 data
  1587. </summary>
  1588. </member>
  1589. <member name="M:ScottPlot.Plottable.ClevelandDotPlot.SetPoint1Style(System.Nullable{System.Drawing.Color},System.Nullable{ScottPlot.MarkerShape},System.String)">
  1590. <summary>
  1591. Allows customizing the first point (set by ys1)
  1592. </summary>
  1593. <param name="color">The color of the dot, null for no change.</param>
  1594. <param name="markerShape">The shape of the dot, null for no change.</param>
  1595. <param name="label">The label of the dot in the legend, null for no change</param>
  1596. </member>
  1597. <member name="M:ScottPlot.Plottable.ClevelandDotPlot.SetPoint2Style(System.Nullable{System.Drawing.Color},System.Nullable{ScottPlot.MarkerShape},System.String)">
  1598. <summary>
  1599. Allows customizing the second point (set by ys2)
  1600. </summary>
  1601. <param name="color">The color of the dot, null for no change.</param>
  1602. <param name="markerShape">The shape of the dot, null for no change.</param>
  1603. <param name="label">The label of the dot in the legend, null for no change</param>
  1604. </member>
  1605. <member name="T:ScottPlot.Plottable.Colorbar">
  1606. <summary>
  1607. A colorbar translates numeric intensity values to colors.
  1608. The Colorbar plot type displays a Colorbar along an edge of the plot.
  1609. </summary>
  1610. </member>
  1611. <member name="F:ScottPlot.Plottable.Colorbar.Width">
  1612. <summary>
  1613. Width of the colorbar rectangle
  1614. </summary>
  1615. </member>
  1616. <member name="F:ScottPlot.Plottable.Colorbar.Plottable">
  1617. <summary>
  1618. If populated, this object holds the plottable containing the heatmap and value data this colorbar represents
  1619. </summary>
  1620. </member>
  1621. <member name="M:ScottPlot.Plottable.Colorbar.AutomaticTicks(System.Boolean,System.Nullable{System.Int32},System.Func{System.Double,System.String})">
  1622. <summary>
  1623. Configure ticks that are automatically generated in the absense of manually-added ticks
  1624. </summary>
  1625. <param name="enable"></param>
  1626. <param name="minimumSpacing">Minimum number of vertical pixels between tick positions</param>
  1627. <param name="formatter">Optional custom string formatter to translate tick positions to labels</param>
  1628. </member>
  1629. <member name="M:ScottPlot.Plottable.Colorbar.ClearTicks">
  1630. <summary>
  1631. Clear the list of manually-defined ticks.
  1632. To enable automatic tick placement call
  1633. </summary>
  1634. </member>
  1635. <member name="M:ScottPlot.Plottable.Colorbar.AddTick(System.Double,System.String)">
  1636. <summary>
  1637. Add a tick to the list of manually-defined ticks (disabling automatic tick placement)
  1638. </summary>
  1639. <param name="fraction">from 0 (darkest) to 1 (brightest)</param>
  1640. <param name="label">string displayed beside the tick</param>
  1641. </member>
  1642. <member name="M:ScottPlot.Plottable.Colorbar.AddTicks(System.Double[],System.String[])">
  1643. <summary>
  1644. Manually define ticks (disabling automatic tick placement)
  1645. </summary>
  1646. <param name="fractions">from 0 (darkest) to 1 (brightest)</param>
  1647. <param name="labels">strings displayed beside the ticks</param>
  1648. </member>
  1649. <member name="M:ScottPlot.Plottable.Colorbar.SetTicks(System.Double[],System.String[])">
  1650. <summary>
  1651. Manually define ticks (disabling automatic tick placement)
  1652. </summary>
  1653. <param name="fractions">from 0 (darkest) to 1 (brightest)</param>
  1654. <param name="labels">strings displayed beside the ticks</param>
  1655. </member>
  1656. <member name="M:ScottPlot.Plottable.Colorbar.UpdateColormap(ScottPlot.Drawing.Colormap)">
  1657. <summary>
  1658. Re-Render the colorbar using a new colormap
  1659. </summary>
  1660. </member>
  1661. <member name="M:ScottPlot.Plottable.Colorbar.GetBitmap">
  1662. <summary>
  1663. Return a Bitmap of just the color portion of the colorbar.
  1664. The width is defined by the Width field
  1665. The height will be 256
  1666. </summary>
  1667. <returns></returns>
  1668. </member>
  1669. <member name="M:ScottPlot.Plottable.Colorbar.GetBitmap(System.Int32,System.Int32,System.Boolean)">
  1670. <summary>
  1671. Return a Bitmap of just the color portion of the colorbar
  1672. </summary>
  1673. <param name="width">width of the Bitmap</param>
  1674. <param name="height">height of the Bitmap</param>
  1675. <param name="vertical">if true, colormap will be vertically oriented (tall and skinny)</param>
  1676. <returns></returns>
  1677. </member>
  1678. <member name="M:ScottPlot.Plottable.Colorbar.GetEvenlySpacedTicks(System.Single,System.Double)">
  1679. <summary>
  1680. Return a list of ticks evenly spaced between the min and max values.
  1681. </summary>
  1682. <param name="height">height of the vertical colorbar</param>
  1683. <param name="tickSpacing">minimum pixel distance between adjacent ticks</param>
  1684. <returns></returns>
  1685. </member>
  1686. <member name="T:ScottPlot.Plottable.CoxcombPlot">
  1687. <summary>
  1688. A Pie chart where the angle of slices is constant but the radii are not.
  1689. </summary>
  1690. </member>
  1691. <member name="P:ScottPlot.Plottable.CoxcombPlot.Values">
  1692. <summary>
  1693. The data to be plotted
  1694. </summary>
  1695. </member>
  1696. <member name="P:ScottPlot.Plottable.CoxcombPlot.FillColors">
  1697. <summary>
  1698. The colors of each slice
  1699. </summary>
  1700. </member>
  1701. <member name="P:ScottPlot.Plottable.CoxcombPlot.WebColor">
  1702. <summary>
  1703. The color to draw the axis in
  1704. </summary>
  1705. </member>
  1706. <member name="P:ScottPlot.Plottable.CoxcombPlot.AxisType">
  1707. <summary>
  1708. Controls rendering style of the concentric circles (ticks) of the web
  1709. </summary>
  1710. </member>
  1711. <member name="P:ScottPlot.Plottable.CoxcombPlot.ShowAxisValues">
  1712. <summary>
  1713. If true, each value will be written in text on the plot.
  1714. </summary>
  1715. </member>
  1716. <member name="F:ScottPlot.Plottable.CoxcombPlot.SliceLabels">
  1717. <summary>
  1718. Labels for each category.
  1719. Length must be equal to the number of columns (categories) in the original data.
  1720. </summary>
  1721. </member>
  1722. <member name="P:ScottPlot.Plottable.CoxcombPlot.CategoryImages">
  1723. <summary>
  1724. Icons for each category.
  1725. Length must be equal to the number of columns (categories) in the original data.
  1726. </summary>
  1727. </member>
  1728. <member name="T:ScottPlot.Plottable.Crosshair">
  1729. <summary>
  1730. The Crosshair plot type draws a vertical and horizontal line to label a point
  1731. on the plot and displays the coordinates of that point in labels that overlap
  1732. the axis tick labels.
  1733. This plot type is typically used in combination with
  1734. MouseMove events to track the location of the mouse and/or with plot types that
  1735. have GetPointNearest() methods.
  1736. </summary>
  1737. </member>
  1738. <member name="P:ScottPlot.Plottable.Crosshair.X">
  1739. <summary>
  1740. X position (axis units) of the vertical line
  1741. </summary>
  1742. </member>
  1743. <member name="P:ScottPlot.Plottable.Crosshair.Y">
  1744. <summary>
  1745. X position (axis units) of the horizontal line
  1746. </summary>
  1747. </member>
  1748. <member name="P:ScottPlot.Plottable.Crosshair.LineStyle">
  1749. <summary>
  1750. Sets style for horizontal and vertical lines
  1751. </summary>
  1752. </member>
  1753. <member name="P:ScottPlot.Plottable.Crosshair.LineWidth">
  1754. <summary>
  1755. Sets the line width for vertical and horizontal lines
  1756. </summary>
  1757. </member>
  1758. <member name="P:ScottPlot.Plottable.Crosshair.LabelFont">
  1759. <summary>
  1760. Sets font of the position labels for horizontal and vertical lines
  1761. </summary>
  1762. </member>
  1763. <member name="P:ScottPlot.Plottable.Crosshair.LabelBackgroundColor">
  1764. <summary>
  1765. Sets background color of the position labels for horizontal and vertical lines
  1766. </summary>
  1767. </member>
  1768. <member name="P:ScottPlot.Plottable.Crosshair.PositionLabel">
  1769. <summary>
  1770. Sets visibility of the text labels for each line drawn over the axis
  1771. </summary>
  1772. </member>
  1773. <member name="P:ScottPlot.Plottable.Crosshair.Color">
  1774. <summary>
  1775. Sets color for horizontal and vertical lines and their position label backgrounds
  1776. </summary>
  1777. </member>
  1778. <member name="T:ScottPlot.Plottable.FinancePlot">
  1779. <summary>
  1780. Finance plots display open/high/low/close (OHLC) data
  1781. </summary>
  1782. </member>
  1783. <member name="M:ScottPlot.Plottable.FinancePlot.Last">
  1784. <summary>
  1785. Returns the last element of OHLCs so users can modify FinancePlots in real time.
  1786. </summary>
  1787. </member>
  1788. <member name="F:ScottPlot.Plottable.FinancePlot.Candle">
  1789. <summary>
  1790. Display prices as filled candlesticks (otherwise display as OHLC lines)
  1791. </summary>
  1792. </member>
  1793. <member name="F:ScottPlot.Plottable.FinancePlot.Sequential">
  1794. <summary>
  1795. If True, OHLC timestamps are ignored and candles are placed at consecutive integers and all given a width of 1
  1796. </summary>
  1797. </member>
  1798. <member name="F:ScottPlot.Plottable.FinancePlot.ColorUp">
  1799. <summary>
  1800. Color of the candle if it closes at or above its open value
  1801. </summary>
  1802. </member>
  1803. <member name="F:ScottPlot.Plottable.FinancePlot.ColorDown">
  1804. <summary>
  1805. Color of the candle if it closes below its open value
  1806. </summary>
  1807. </member>
  1808. <member name="F:ScottPlot.Plottable.FinancePlot.WickColor">
  1809. <summary>
  1810. This field controls the color of the wick and rectangular candle border.
  1811. If null, the wick is the same color as the candle and no border is applied.
  1812. </summary>
  1813. </member>
  1814. <member name="M:ScottPlot.Plottable.FinancePlot.#ctor">
  1815. <summary>
  1816. Create an empty finance plot.
  1817. Call Add() and AddRange() to add data.
  1818. </summary>
  1819. </member>
  1820. <member name="M:ScottPlot.Plottable.FinancePlot.#ctor(ScottPlot.OHLC[])">
  1821. <summary>
  1822. Create a finance plot from existing OHLC data.
  1823. </summary>
  1824. <param name="ohlcs"></param>
  1825. </member>
  1826. <member name="M:ScottPlot.Plottable.FinancePlot.Add(System.Double,System.Double,System.Double,System.Double,System.DateTime,System.TimeSpan)">
  1827. <summary>
  1828. Add a single candle representing a defined time span
  1829. </summary>
  1830. <param name="open"></param>
  1831. <param name="high"></param>
  1832. <param name="low"></param>
  1833. <param name="close"></param>
  1834. <param name="timeStart"></param>
  1835. <param name="timeSpan"></param>
  1836. </member>
  1837. <member name="M:ScottPlot.Plottable.FinancePlot.Add(System.Double,System.Double,System.Double,System.Double)">
  1838. <summary>
  1839. Add a single candle to the end of the list assuming each candle is spaced 1 horizontal unit apart
  1840. </summary>
  1841. <param name="open"></param>
  1842. <param name="high"></param>
  1843. <param name="low"></param>
  1844. <param name="close"></param>
  1845. </member>
  1846. <member name="M:ScottPlot.Plottable.FinancePlot.Add(ScottPlot.OHLC)">
  1847. <summary>
  1848. Add a single OHLC to the plot
  1849. </summary>
  1850. <param name="ohlc"></param>
  1851. </member>
  1852. <member name="M:ScottPlot.Plottable.FinancePlot.AddRange(ScottPlot.OHLC[])">
  1853. <summary>
  1854. Add multiple OHLCs to the plot
  1855. </summary>
  1856. <param name="ohlcs"></param>
  1857. </member>
  1858. <member name="M:ScottPlot.Plottable.FinancePlot.Clear">
  1859. <summary>
  1860. Clear all OHLCs
  1861. </summary>
  1862. </member>
  1863. <member name="M:ScottPlot.Plottable.FinancePlot.GetSMA(System.Int32)">
  1864. <summary>
  1865. Return the simple moving average (SMA) of the OHLC closing prices.
  1866. The returned ys are SMA where each point is the average of N points.
  1867. The returned xs are times in OATime units.
  1868. The returned xs and ys arrays will be the length of the OHLC data minus N.
  1869. </summary>
  1870. <param name="N">each returned value represents the average of N points</param>
  1871. <returns>times and averages of the OHLC closing prices</returns>
  1872. </member>
  1873. <member name="M:ScottPlot.Plottable.FinancePlot.GetBollingerBands(System.Int32)">
  1874. <summary>
  1875. Return Bollinger bands (mean +/- 2*SD) for the OHLC closing prices.
  1876. The returned xs are times in OATime units.
  1877. The returned xs and ys arrays will be the length of the OHLC data minus N (points).
  1878. </summary>
  1879. <param name="N">each returned value represents the average of N points</param>
  1880. <returns>times, averages, and both Bollinger bands for the OHLC closing prices</returns>
  1881. </member>
  1882. <member name="T:ScottPlot.Plottable.FunctionPlot">
  1883. <summary>
  1884. A function plot displays a curve using a function (Y as a function of X)
  1885. </summary>
  1886. </member>
  1887. <member name="F:ScottPlot.Plottable.FunctionPlot.Function">
  1888. <summary>
  1889. The function to translate an X to a Y (or null if undefined)
  1890. </summary>
  1891. </member>
  1892. <member name="T:ScottPlot.Plottable.Heatmap">
  1893. <summary>
  1894. A heatmap displays a 2D array of intensities as small rectangles on the plot
  1895. colored according to their intensity value according to a colormap.
  1896. </summary>
  1897. </member>
  1898. <member name="F:ScottPlot.Plottable.Heatmap.Min">
  1899. <summary>
  1900. Minimum heatmap value
  1901. </summary>
  1902. </member>
  1903. <member name="F:ScottPlot.Plottable.Heatmap.Max">
  1904. <summary>
  1905. Maximum heatmap value
  1906. </summary>
  1907. </member>
  1908. <member name="F:ScottPlot.Plottable.Heatmap.DataWidth">
  1909. <summary>
  1910. Number of columns in the heatmap data
  1911. </summary>
  1912. </member>
  1913. <member name="F:ScottPlot.Plottable.Heatmap.DataHeight">
  1914. <summary>
  1915. Number of rows in the heatmap data
  1916. </summary>
  1917. </member>
  1918. <member name="F:ScottPlot.Plottable.Heatmap.BmpHeatmap">
  1919. <summary>
  1920. Pre-rendered heatmap image
  1921. </summary>
  1922. </member>
  1923. <member name="F:ScottPlot.Plottable.Heatmap.OffsetX">
  1924. <summary>
  1925. Horizontal location of the lower-left cell
  1926. </summary>
  1927. </member>
  1928. <member name="F:ScottPlot.Plottable.Heatmap.OffsetY">
  1929. <summary>
  1930. Vertical location of the lower-left cell
  1931. </summary>
  1932. </member>
  1933. <member name="F:ScottPlot.Plottable.Heatmap.CellWidth">
  1934. <summary>
  1935. Width of each cell composing the heatmap
  1936. </summary>
  1937. </member>
  1938. <member name="F:ScottPlot.Plottable.Heatmap.CellHeight">
  1939. <summary>
  1940. Width of each cell composing the heatmap
  1941. </summary>
  1942. </member>
  1943. <member name="P:ScottPlot.Plottable.Heatmap.XMin">
  1944. <summary>
  1945. Position of the left edge of the heatmap
  1946. </summary>
  1947. </member>
  1948. <member name="P:ScottPlot.Plottable.Heatmap.XMax">
  1949. <summary>
  1950. Position of the right edge of the heatmap
  1951. </summary>
  1952. </member>
  1953. <member name="P:ScottPlot.Plottable.Heatmap.Label">
  1954. <summary>
  1955. Text to appear in the legend
  1956. </summary>
  1957. </member>
  1958. <member name="P:ScottPlot.Plottable.Heatmap.Colormap">
  1959. <summary>
  1960. Colormap used to translate heatmap values to colors
  1961. </summary>
  1962. </member>
  1963. <member name="P:ScottPlot.Plottable.Heatmap.ScaleMin">
  1964. <summary>
  1965. If defined, colors will be "clipped" to this value such that lower values (lower colors) will not be shown
  1966. </summary>
  1967. </member>
  1968. <member name="P:ScottPlot.Plottable.Heatmap.ScaleMax">
  1969. <summary>
  1970. If defined, colors will be "clipped" to this value such that greater values (higher colors) will not be shown
  1971. </summary>
  1972. </member>
  1973. <member name="P:ScottPlot.Plottable.Heatmap.TransparencyThreshold">
  1974. <summary>
  1975. Heatmap values below this number (if defined) will be made transparent
  1976. </summary>
  1977. </member>
  1978. <member name="P:ScottPlot.Plottable.Heatmap.ColormapMin">
  1979. <summary>
  1980. Value of the the lower edge of the colormap
  1981. </summary>
  1982. </member>
  1983. <member name="P:ScottPlot.Plottable.Heatmap.ColormapMax">
  1984. <summary>
  1985. Value of the the upper edge of the colormap
  1986. </summary>
  1987. </member>
  1988. <member name="P:ScottPlot.Plottable.Heatmap.ColormapMinIsClipped">
  1989. <summary>
  1990. Indicates whether values extend beyond the lower edge of the colormap
  1991. </summary>
  1992. </member>
  1993. <member name="P:ScottPlot.Plottable.Heatmap.ColormapMaxIsClipped">
  1994. <summary>
  1995. Indicates whether values extend beyond the upper edge of the colormap
  1996. </summary>
  1997. </member>
  1998. <member name="P:ScottPlot.Plottable.Heatmap.Smooth">
  1999. <summary>
  2000. If true, heatmap squares will be smoothed using high quality bicubic interpolation.
  2001. If false, heatmap squares will look like sharp rectangles (nearest neighbor interpolation).
  2002. </summary>
  2003. </member>
  2004. <member name="P:ScottPlot.Plottable.Heatmap.Interpolation">
  2005. <summary>
  2006. Controls which interpolation mode is used when zooming into the heatmap.
  2007. </summary>
  2008. </member>
  2009. <member name="M:ScottPlot.Plottable.Heatmap.Update(System.Nullable{System.Double}[0:,0:],ScottPlot.Drawing.Colormap,System.Nullable{System.Double},System.Nullable{System.Double})">
  2010. <summary>
  2011. This method analyzes the intensities and colormap to create a bitmap
  2012. with a single pixel for every intensity value. The bitmap is stored
  2013. and displayed (without anti-alias interpolation) when Render() is called.
  2014. </summary>
  2015. <param name="intensities">2D array of data for the heatmap (null values are not shown)</param>
  2016. <param name="colormap">update the Colormap to use this colormap</param>
  2017. <param name="min">minimum intensity (according to the colormap)</param>
  2018. <param name="max">maximum intensity (according to the colormap)</param>
  2019. </member>
  2020. <member name="M:ScottPlot.Plottable.Heatmap.Update(System.Double[0:,0:],ScottPlot.Drawing.Colormap,System.Nullable{System.Double},System.Nullable{System.Double})">
  2021. <summary>
  2022. This method analyzes the intensities and colormap to create a bitmap
  2023. with a single pixel for every intensity value. The bitmap is stored
  2024. and displayed (without anti-alias interpolation) when Render() is called.
  2025. </summary>
  2026. <param name="intensities">2D array of data for the heatmap (all values are shown)</param>
  2027. <param name="colormap">update the Colormap to use this colormap</param>
  2028. <param name="min">minimum intensity (according to the colormap)</param>
  2029. <param name="max">maximum intensity (according to the colormap)</param>
  2030. </member>
  2031. <member name="T:ScottPlot.Plottable.HLine">
  2032. <summary>
  2033. Horizontal line at a Y position
  2034. </summary>
  2035. </member>
  2036. <member name="P:ScottPlot.Plottable.HLine.Y">
  2037. <summary>
  2038. Y position to render the line
  2039. </summary>
  2040. </member>
  2041. <member name="P:ScottPlot.Plottable.IHasPixelOffset.PixelOffsetX">
  2042. <summary>
  2043. Render the object this number of pixels right of its coordinate location
  2044. </summary>
  2045. </member>
  2046. <member name="P:ScottPlot.Plottable.IHasPixelOffset.PixelOffsetY">
  2047. <summary>
  2048. Render the object this number of pixels above its coordinate location
  2049. </summary>
  2050. </member>
  2051. <member name="T:ScottPlot.Plottable.IHasPoints">
  2052. <summary>
  2053. Indicates a plottable has data distributed along both axes
  2054. and can return the X/Y location of the point nearest a given X/Y location.
  2055. </summary>
  2056. </member>
  2057. <member name="T:ScottPlot.Plottable.IHasPointsGenericX`2">
  2058. <summary>
  2059. Indicates a plottable has data distributed along the horizontal axis
  2060. and can return the X/Y location of the point nearest a given X value.
  2061. </summary>
  2062. </member>
  2063. <member name="T:ScottPlot.Plottable.IHasPointsGenericY`2">
  2064. <summary>
  2065. Indicates a plottable has data distributed along the vertical axis
  2066. and can return the X/Y location of the point nearest a given Y value.
  2067. </summary>
  2068. </member>
  2069. <member name="T:ScottPlot.Plottable.IHasPointsGeneric`2">
  2070. <summary>
  2071. Indicates a plottable has data distributed along both axes
  2072. and can return the X/Y location of the point nearest a given X/Y location.
  2073. </summary>
  2074. </member>
  2075. <member name="T:ScottPlot.Plottable.Image">
  2076. <summary>
  2077. Display a Bitmap at X/Y coordinates in unit space
  2078. </summary>
  2079. </member>
  2080. <member name="F:ScottPlot.Plottable.Image.X">
  2081. <summary>
  2082. Position of the primary corner (based on Alginment)
  2083. </summary>
  2084. </member>
  2085. <member name="F:ScottPlot.Plottable.Image.Y">
  2086. <summary>
  2087. Position of the primary corner (based on Alginment)
  2088. </summary>
  2089. </member>
  2090. <member name="F:ScottPlot.Plottable.Image.Scale">
  2091. <summary>
  2092. Multiply the size of the image (in pixel units) by this scale factor.
  2093. The primary corner (based on Alginment) will remain anchored.
  2094. </summary>
  2095. </member>
  2096. <member name="F:ScottPlot.Plottable.Image.Rotation">
  2097. <summary>
  2098. Rotate the image clockwise around its primary corner (defined by Alignment) by this number of degrees
  2099. </summary>
  2100. </member>
  2101. <member name="F:ScottPlot.Plottable.Image.Bitmap">
  2102. <summary>
  2103. Image to display
  2104. </summary>
  2105. </member>
  2106. <member name="F:ScottPlot.Plottable.Image.Alignment">
  2107. <summary>
  2108. Indicates which corner of the Bitmap is described by X and Y.
  2109. This corner will be the axis of Rotation, and the center of Scale.
  2110. </summary>
  2111. </member>
  2112. <member name="M:ScottPlot.Plottable.IPlottable.GetLegendItems">
  2113. <summary>
  2114. Returns items to show in the legend. Most plottables return a single item. in this array will appear in the legend.
  2115. Plottables which never appear in the legend can return null.
  2116. </summary>
  2117. </member>
  2118. <member name="M:ScottPlot.Plottable.IPlottable.GetAxisLimits">
  2119. <summary>
  2120. Return min and max of the horizontal and vertical data contained in this plottable.
  2121. Double.NaN is used for axes not containing data.
  2122. </summary>
  2123. <returns></returns>
  2124. </member>
  2125. <member name="M:ScottPlot.Plottable.IPlottable.ValidateData(System.Boolean)">
  2126. <summary>
  2127. Throw InvalidOperationException if ciritical variables are null or have incorrect sizes.
  2128. Deep validation is slower but also checks every value for NaN and Infinity.
  2129. </summary>
  2130. </member>
  2131. <member name="T:ScottPlot.Plottable.IStylable">
  2132. <summary>
  2133. This interface is for plottable objects that could be styled using the plot's style.
  2134. Typically this is for things like frames, tick marks, and text labels.
  2135. </summary>
  2136. </member>
  2137. <member name="T:ScottPlot.Plottable.LegendItem">
  2138. <summary>
  2139. This class describes a single item that appears in the figure legend.
  2140. </summary>
  2141. </member>
  2142. <member name="T:ScottPlot.Plottable.LollipopPlot">
  2143. <summary>
  2144. Lollipop plots display a series of "Lollipops" in place of bars.
  2145. Positions are defined by Xs.
  2146. Heights are defined by Ys (relative to BaseValue and YOffsets).
  2147. </summary>
  2148. </member>
  2149. <member name="P:ScottPlot.Plottable.LollipopPlot.Label">
  2150. <summary>
  2151. Name for this series of values that will appear in the legend
  2152. </summary>
  2153. </member>
  2154. <member name="P:ScottPlot.Plottable.LollipopPlot.LollipopColor">
  2155. <summary>
  2156. Color of all lollipop components (the stick and the circle)
  2157. </summary>
  2158. </member>
  2159. <member name="P:ScottPlot.Plottable.LollipopPlot.LollipopRadius">
  2160. <summary>
  2161. Size of the circle at the end of each lollipop
  2162. </summary>
  2163. </member>
  2164. <member name="M:ScottPlot.Plottable.LollipopPlot.#ctor(System.Double[],System.Double[])">
  2165. <summary>
  2166. Create a lollipop plot from arrays of positions and sizes
  2167. </summary>
  2168. <param name="positions">position of each lollipop</param>
  2169. <param name="values">height of each lollipop</param>
  2170. </member>
  2171. <member name="P:ScottPlot.Plottable.MarkerPlot.X">
  2172. <summary>
  2173. Horizontal position in coordinate space
  2174. </summary>
  2175. </member>
  2176. <member name="P:ScottPlot.Plottable.MarkerPlot.Y">
  2177. <summary>
  2178. Vertical position in coordinate space
  2179. </summary>
  2180. </member>
  2181. <member name="P:ScottPlot.Plottable.MarkerPlot.MarkerShape">
  2182. <summary>
  2183. Marker to draw at this point
  2184. </summary>
  2185. </member>
  2186. <member name="P:ScottPlot.Plottable.MarkerPlot.MarkerSize">
  2187. <summary>
  2188. Size of the marker in pixel units
  2189. </summary>
  2190. </member>
  2191. <member name="P:ScottPlot.Plottable.MarkerPlot.Color">
  2192. <summary>
  2193. Color of the marker to display at this point
  2194. </summary>
  2195. </member>
  2196. <member name="P:ScottPlot.Plottable.MarkerPlot.Label">
  2197. <summary>
  2198. Text to appear in the legend (if populated)
  2199. </summary>
  2200. </member>
  2201. <member name="T:ScottPlot.Plottable.PiePlot">
  2202. <summary>
  2203. A pie plot displays a collection of values as a circle.
  2204. Pie plots with a hollow center are donut plots.
  2205. </summary>
  2206. </member>
  2207. <member name="T:ScottPlot.Plottable.Polygon">
  2208. <summary>
  2209. A polygon is a collection of X/Y points that are all connected to form a closed shape.
  2210. Polygons can be optionally filled with a color or a gradient.
  2211. </summary>
  2212. </member>
  2213. <member name="T:ScottPlot.Plottable.Polygons">
  2214. <summary>
  2215. Polygons are multiple Polygon objects.
  2216. This plot type is faster alternative for rendering a large number of polygons
  2217. compared to adding a bunch of individual Polygon objects to the plot.
  2218. </summary>
  2219. </member>
  2220. <member name="T:ScottPlot.Plottable.PopulationPlot">
  2221. <summary>
  2222. Population plots are designed to show collections of data.
  2223. A Population is a 1D array of values, and statistics are calculated automatically.
  2224. Populations can be displayed as bar plots, box plots, or scatter plots.
  2225. Public methods, fields, and properties allow extensive customization.
  2226. This plottable supports higher-order grouping (groups of groups).
  2227. </summary>
  2228. </member>
  2229. <member name="T:ScottPlot.Plottable.RadarPlot">
  2230. <summary>
  2231. A radar chart is a graphical method of displaying multivariate data in the form of
  2232. a two-dimensional chart of three or more quantitative variables represented on axes
  2233. starting from the same point.
  2234. Data is managed using 2D arrays where groups (colored shapes) are rows and categories (arms of the web) are columns.
  2235. </summary>
  2236. </member>
  2237. <member name="F:ScottPlot.Plottable.RadarPlot.Norm">
  2238. <summary>
  2239. Values for every group (rows) and category (columns) normalized from 0 to 1.
  2240. </summary>
  2241. </member>
  2242. <member name="F:ScottPlot.Plottable.RadarPlot.NormMax">
  2243. <summary>
  2244. Single value to normalize all values against for all groups/categories.
  2245. </summary>
  2246. </member>
  2247. <member name="F:ScottPlot.Plottable.RadarPlot.NormMaxes">
  2248. <summary>
  2249. Individual values (one per category) to use for normalization.
  2250. Length must be equal to the number of columns (categories) in the original data.
  2251. </summary>
  2252. </member>
  2253. <member name="F:ScottPlot.Plottable.RadarPlot.CategoryLabels">
  2254. <summary>
  2255. Labels for each category.
  2256. Length must be equal to the number of columns (categories) in the original data.
  2257. </summary>
  2258. <remarks>
  2259. If showing icons, labels will be ignored.
  2260. </remarks>
  2261. </member>
  2262. <member name="F:ScottPlot.Plottable.RadarPlot.CategoryImages">
  2263. <summary>
  2264. Icons for each category.
  2265. Length must be equal to the number of columns (categories) in the original data.
  2266. </summary>
  2267. <remarks>
  2268. If showing icons, labels will be ignored.
  2269. </remarks>
  2270. </member>
  2271. <member name="F:ScottPlot.Plottable.RadarPlot.GroupLabels">
  2272. <summary>
  2273. Labels for each group.
  2274. Length must be equal to the number of rows (groups) in the original data.
  2275. </summary>
  2276. </member>
  2277. <member name="F:ScottPlot.Plottable.RadarPlot.FillColors">
  2278. <summary>
  2279. Colors (typically semi-transparent) to shade the inner area of each group.
  2280. Length must be equal to the number of rows (groups) in the original data.
  2281. </summary>
  2282. </member>
  2283. <member name="F:ScottPlot.Plottable.RadarPlot.LineColors">
  2284. <summary>
  2285. Colors to outline the shape for each group.
  2286. Length must be equal to the number of rows (groups) in the original data.
  2287. </summary>
  2288. </member>
  2289. <member name="F:ScottPlot.Plottable.RadarPlot.WebColor">
  2290. <summary>
  2291. Color of the axis lines and concentric circles representing ticks
  2292. </summary>
  2293. </member>
  2294. <member name="F:ScottPlot.Plottable.RadarPlot.IndependentAxes">
  2295. <summary>
  2296. Controls if values along each category axis are scaled independently or uniformly across all axes.
  2297. </summary>
  2298. </member>
  2299. <member name="F:ScottPlot.Plottable.RadarPlot.Font">
  2300. <summary>
  2301. Font used for labeling values on the plot
  2302. </summary>
  2303. </member>
  2304. <member name="P:ScottPlot.Plottable.RadarPlot.ShowAxisValues">
  2305. <summary>
  2306. If true, each value will be written in text on the plot.
  2307. </summary>
  2308. </member>
  2309. <member name="P:ScottPlot.Plottable.RadarPlot.ShowCategoryLabels">
  2310. <summary>
  2311. If true, each category name will be written in text at every corner of the radar
  2312. </summary>
  2313. </member>
  2314. <member name="P:ScottPlot.Plottable.RadarPlot.AxisType">
  2315. <summary>
  2316. Controls rendering style of the concentric circles (ticks) of the web
  2317. </summary>
  2318. </member>
  2319. <member name="P:ScottPlot.Plottable.RadarPlot.LineWidth">
  2320. <summary>
  2321. Determines the width of each spoke and the axis lines.
  2322. </summary>
  2323. </member>
  2324. <member name="P:ScottPlot.Plottable.RadarPlot.OutlineWidth">
  2325. <summary>
  2326. Determines the width of the line at the edge of each area polygon.
  2327. </summary>
  2328. </member>
  2329. <member name="M:ScottPlot.Plottable.RadarPlot.Update(System.Double[0:,0:],System.Boolean,System.Double[])">
  2330. <summary>
  2331. Replace the data values with new ones.
  2332. </summary>
  2333. <param name="values">2D array of groups (rows) of values for each category (columns)</param>
  2334. <param name="independentAxes">Controls if values along each category axis are scaled independently or uniformly across all axes</param>
  2335. <param name="maxValues">If provided, these values will be used to normalize each category (columns)</param>
  2336. </member>
  2337. <member name="M:ScottPlot.Plottable.RadarPlot.NormalizeInPlace(System.Double[0:,0:],System.Double[])">
  2338. <summary>
  2339. Normalize a 2D array by dividing all values by the maximum value.
  2340. </summary>
  2341. <returns>maximum value in the array before normalization</returns>
  2342. </member>
  2343. <member name="M:ScottPlot.Plottable.RadarPlot.NormalizeSeveralInPlace(System.Double[0:,0:],System.Double[])">
  2344. <summary>
  2345. Normalize each row of a 2D array independently by dividing all values by the maximum value.
  2346. </summary>
  2347. <returns>maximum value in each row of the array before normalization</returns>
  2348. </member>
  2349. <member name="T:ScottPlot.Plottable.RadialGauge">
  2350. <summary>
  2351. This class represents a single radial gauge.
  2352. It has level and styling options and can be rendered onto an existing bitmap using any radius.
  2353. </summary>
  2354. </member>
  2355. <member name="F:ScottPlot.Plottable.RadialGauge.StartAngle">
  2356. <summary>
  2357. Location of the base of the gauge (degrees)
  2358. </summary>
  2359. </member>
  2360. <member name="F:ScottPlot.Plottable.RadialGauge.SweepAngle">
  2361. <summary>
  2362. Current level of this gauge (degrees)
  2363. </summary>
  2364. </member>
  2365. <member name="F:ScottPlot.Plottable.RadialGauge.MaximumSizeAngle">
  2366. <summary>
  2367. Maximum angular size of the gauge (swept degrees)
  2368. </summary>
  2369. </member>
  2370. <member name="F:ScottPlot.Plottable.RadialGauge.BackStartAngle">
  2371. <summary>
  2372. Angle where the background starts (degrees)
  2373. </summary>
  2374. </member>
  2375. <member name="F:ScottPlot.Plottable.RadialGauge.Clockwise">
  2376. <summary>
  2377. If true angles end clockwise relative to their base
  2378. </summary>
  2379. </member>
  2380. <member name="P:ScottPlot.Plottable.RadialGauge.BackAngleSweep">
  2381. <summary>
  2382. Used internally to get the angle swept by the gauge background. It's equal to 360 degrees if CircularBackground is set to true. Also, returns a positive value is the gauge is drawn clockwise and a negative one otherwise
  2383. </summary>
  2384. </member>
  2385. <member name="F:ScottPlot.Plottable.RadialGauge.CircularBackground">
  2386. <summary>
  2387. If true the background will always be drawn as a complete circle regardless of MaximumSizeAngle
  2388. </summary>
  2389. </member>
  2390. <member name="F:ScottPlot.Plottable.RadialGauge.Font">
  2391. <summary>
  2392. Font used to render values at the tip of the gauge
  2393. </summary>
  2394. </member>
  2395. <member name="F:ScottPlot.Plottable.RadialGauge.FontSizeFraction">
  2396. <summary>
  2397. Size of the font relative to the line thickness
  2398. </summary>
  2399. </member>
  2400. <member name="F:ScottPlot.Plottable.RadialGauge.Label">
  2401. <summary>
  2402. Text to display on top of the label
  2403. </summary>
  2404. </member>
  2405. <member name="F:ScottPlot.Plottable.RadialGauge.LabelPositionFraction">
  2406. <summary>
  2407. Location of the label text along the length of the gauge.
  2408. Low values place the label near the base and high values place the label at its tip.
  2409. </summary>
  2410. </member>
  2411. <member name="F:ScottPlot.Plottable.RadialGauge.Width">
  2412. <summary>
  2413. Size of the gauge (pixels)
  2414. </summary>
  2415. </member>
  2416. <member name="F:ScottPlot.Plottable.RadialGauge.Color">
  2417. <summary>
  2418. Color of the gauge foreground
  2419. </summary>
  2420. </member>
  2421. <member name="F:ScottPlot.Plottable.RadialGauge.BackgroundColor">
  2422. <summary>
  2423. Color of the gauge background
  2424. </summary>
  2425. </member>
  2426. <member name="F:ScottPlot.Plottable.RadialGauge.StartCap">
  2427. <summary>
  2428. Style of the base of the gauge
  2429. </summary>
  2430. </member>
  2431. <member name="F:ScottPlot.Plottable.RadialGauge.EndCap">
  2432. <summary>
  2433. Style of the tip of the gauge
  2434. </summary>
  2435. </member>
  2436. <member name="F:ScottPlot.Plottable.RadialGauge.Mode">
  2437. <summary>
  2438. Defines the location of each gauge relative to the start angle and distance from the center
  2439. </summary>
  2440. </member>
  2441. <member name="F:ScottPlot.Plottable.RadialGauge.ShowLabels">
  2442. <summary>
  2443. Indicates whether or not labels will be rendered as text
  2444. </summary>
  2445. </member>
  2446. <member name="M:ScottPlot.Plottable.RadialGauge.Render(System.Drawing.Graphics,ScottPlot.PlotDimensions,System.Drawing.PointF,System.Single)">
  2447. <summary>
  2448. Render the gauge onto an existing Bitmap
  2449. </summary>
  2450. <param name="gfx">active graphics object</param>
  2451. <param name="dims">plot dimensions (used to determine pixel scaling)</param>
  2452. <param name="centerPixel">pixel location on the bitmap to center the gauge on</param>
  2453. <param name="radius">distance from the center (pixel units) to render the gauge</param>
  2454. </member>
  2455. <member name="M:ScottPlot.Plottable.RadialGauge.MeasureCharacters(System.Drawing.Graphics,System.Drawing.Font,System.String,System.Int32,System.Int32)">
  2456. <summary>
  2457. Return an array indicating the size of each character in a string.
  2458. Specifiy the maximum expected size to avoid issues associated with text wrapping.
  2459. </summary>
  2460. </member>
  2461. <member name="M:ScottPlot.Plottable.RadialGauge.ReduceAngle(System.Double)">
  2462. <summary>
  2463. Reduces an angle into the range [0°-360°].
  2464. Angles greater than 360 will roll-over (370º becomes 10º).
  2465. Angles less than 0 will roll-under (-10º becomes 350º).
  2466. </summary>
  2467. <param name="angle">Angle value</param>
  2468. <returns>Angle whithin [0°-360°]</returns>
  2469. </member>
  2470. <member name="T:ScottPlot.Plottable.RadialGaugePlot">
  2471. <summary>
  2472. A radial gauge chart is a graphical method of displaying scalar data in the form of
  2473. a chart made of circular gauges so that each scalar is represented by each gauge.
  2474. </summary>
  2475. </member>
  2476. <member name="P:ScottPlot.Plottable.RadialGaugePlot.Levels">
  2477. <summary>
  2478. This array holds the original levels passed-in by the user.
  2479. These levels are used to calculate radial gauge positions on every render.
  2480. </summary>
  2481. </member>
  2482. <member name="P:ScottPlot.Plottable.RadialGaugePlot.GaugeCount">
  2483. <summary>
  2484. Number of gauges.
  2485. </summary>
  2486. </member>
  2487. <member name="F:ScottPlot.Plottable.RadialGaugePlot.MaximumAngle">
  2488. <summary>
  2489. Maximum size (degrees) for the gauge.
  2490. 180 is a semicircle and 360 is a full circle.
  2491. </summary>
  2492. </member>
  2493. <member name="F:ScottPlot.Plottable.RadialGaugePlot.CircularBackground">
  2494. <summary>
  2495. Controls whether the backgrounds of the gauges are full circles or stop at the maximum angle.
  2496. </summary>
  2497. </member>
  2498. <member name="F:ScottPlot.Plottable.RadialGaugePlot.Labels">
  2499. <summary>
  2500. Labels that appear in the legend for each gauge.
  2501. Number of labels must equal number of gauges.
  2502. May be null if gauges are not to appear in the legend.
  2503. </summary>
  2504. </member>
  2505. <member name="F:ScottPlot.Plottable.RadialGaugePlot.Colors">
  2506. <summary>
  2507. Colors for each gauge.
  2508. Number of colors must equal number of gauges.
  2509. </summary>
  2510. </member>
  2511. <member name="F:ScottPlot.Plottable.RadialGaugePlot.BackgroundTransparencyFraction">
  2512. <summary>
  2513. Describes how transparent the unfilled background of each gauge is (0 to 1).
  2514. The larger the number the darker the background becomes.
  2515. </summary>
  2516. </member>
  2517. <member name="F:ScottPlot.Plottable.RadialGaugePlot.Clockwise">
  2518. <summary>
  2519. Indicates whether gauges fill clockwise as levels increase.
  2520. If false, gauges will fill counter-clockwise (anti-clockwise).
  2521. </summary>
  2522. </member>
  2523. <member name="F:ScottPlot.Plottable.RadialGaugePlot.GaugeMode">
  2524. <summary>
  2525. Determines whether the gauges are drawn stacked (dafault value), sequentially, or as a single gauge (ressembling a pie plot).
  2526. </summary>
  2527. </member>
  2528. <member name="F:ScottPlot.Plottable.RadialGaugePlot.OrderInsideOut">
  2529. <summary>
  2530. Controls whether gauges will be dwan inside-out (true) or outside-in (false)
  2531. </summary>
  2532. </member>
  2533. <member name="F:ScottPlot.Plottable.RadialGaugePlot.LabelPositionFraction">
  2534. <summary>
  2535. Defines where the gauge label is written on the gage as a fraction of its length.
  2536. Low values place the label near the base and high values place the label at its tip.
  2537. </summary>
  2538. </member>
  2539. <member name="F:ScottPlot.Plottable.RadialGaugePlot.StartingAngle">
  2540. <summary>
  2541. Angle (degrees) at which the gauges start.
  2542. 270° for North (default value), 0° for East, 90° for South, 180° for West, etc.
  2543. Expected values in the range [0°-360°], otherwise unexpected side-effects might happen.
  2544. </summary>
  2545. </member>
  2546. <member name="F:ScottPlot.Plottable.RadialGaugePlot.SpaceFraction">
  2547. <summary>
  2548. The empty space between gauges as a fraction of the gauge width.
  2549. </summary>
  2550. </member>
  2551. <member name="F:ScottPlot.Plottable.RadialGaugePlot.FontSizeFraction">
  2552. <summary>
  2553. Size of the gague label text as a fraction of the gauge width.
  2554. </summary>
  2555. </member>
  2556. <member name="F:ScottPlot.Plottable.RadialGaugePlot.Font">
  2557. <summary>
  2558. Describes labels drawn on each gauge.
  2559. </summary>
  2560. </member>
  2561. <member name="P:ScottPlot.Plottable.RadialGaugePlot.ShowLevels">
  2562. <summary>
  2563. Controls if value labels are shown inside the gauges.
  2564. </summary>
  2565. </member>
  2566. <member name="F:ScottPlot.Plottable.RadialGaugePlot.LevelTextFormat">
  2567. <summary>
  2568. String formatter to use for converting gauge levels to text
  2569. </summary>
  2570. </member>
  2571. <member name="P:ScottPlot.Plottable.RadialGaugePlot.EndCap">
  2572. <summary>
  2573. Style of the tip of the gauge
  2574. </summary>
  2575. </member>
  2576. <member name="P:ScottPlot.Plottable.RadialGaugePlot.StartCap">
  2577. <summary>
  2578. Style of the base of the gauge
  2579. </summary>
  2580. </member>
  2581. <member name="M:ScottPlot.Plottable.RadialGaugePlot.Update(System.Double[],System.Drawing.Color[])">
  2582. <summary>
  2583. Replace gauge levels with new ones.
  2584. </summary>
  2585. </member>
  2586. <member name="M:ScottPlot.Plottable.RadialGaugePlot.GetGaugeAngles(System.Double[],System.Double,System.Double,System.Boolean,ScottPlot.RadialGaugeMode)">
  2587. <summary>
  2588. Calculate the rotational angles for each gauge from the original data values
  2589. </summary>
  2590. </member>
  2591. <member name="T:ScottPlot.Plottable.ScaleBar">
  2592. <summary>
  2593. An L-shaped scalebar rendered in the corner of the data area
  2594. </summary>
  2595. </member>
  2596. <member name="F:ScottPlot.Plottable.ScaleBar.Width">
  2597. <summary>
  2598. Width of the scalebar in cooridinate units
  2599. </summary>
  2600. </member>
  2601. <member name="F:ScottPlot.Plottable.ScaleBar.Height">
  2602. <summary>
  2603. Height of the scalebar in cooridinate units
  2604. </summary>
  2605. </member>
  2606. <member name="F:ScottPlot.Plottable.ScaleBar.Padding">
  2607. <summary>
  2608. Distance in pixels from the edge of the data area
  2609. </summary>
  2610. </member>
  2611. <member name="T:ScottPlot.Plottable.ScatterPlot">
  2612. <summary>
  2613. The scatter plot renders X/Y pairs as points and/or connected lines.
  2614. Scatter plots can be extremely slow for large datasets, so use Signal plots in these situations.
  2615. </summary>
  2616. </member>
  2617. <member name="P:ScottPlot.Plottable.ScatterPlot.OffsetX">
  2618. <summary>
  2619. Add this value to each X value before plotting (axis units)
  2620. </summary>
  2621. </member>
  2622. <member name="P:ScottPlot.Plottable.ScatterPlot.OffsetY">
  2623. <summary>
  2624. Add this value to each Y value before plotting (axis units)
  2625. </summary>
  2626. </member>
  2627. <member name="M:ScottPlot.Plottable.ScatterPlot.UpdateX(System.Double[])">
  2628. <summary>
  2629. Replace the Xs array with a new one
  2630. </summary>
  2631. </member>
  2632. <member name="M:ScottPlot.Plottable.ScatterPlot.UpdateY(System.Double[])">
  2633. <summary>
  2634. Replace the Ys array with a new one
  2635. </summary>
  2636. </member>
  2637. <member name="M:ScottPlot.Plottable.ScatterPlot.Update(System.Double[],System.Double[])">
  2638. <summary>
  2639. Replace Xs and Ys arrays with new ones
  2640. </summary>
  2641. </member>
  2642. <member name="M:ScottPlot.Plottable.ScatterPlot.GetPointNearestX(System.Double)">
  2643. <summary>
  2644. Return the X/Y coordinates of the point nearest the X position
  2645. </summary>
  2646. <param name="x">X position in plot space</param>
  2647. <returns></returns>
  2648. </member>
  2649. <member name="M:ScottPlot.Plottable.ScatterPlot.GetPointNearestY(System.Double)">
  2650. <summary>
  2651. Return the X/Y coordinates of the point nearest the Y position
  2652. </summary>
  2653. <param name="y">Y position in plot space</param>
  2654. <returns></returns>
  2655. </member>
  2656. <member name="M:ScottPlot.Plottable.ScatterPlot.GetPointNearest(System.Double,System.Double,System.Double)">
  2657. <summary>
  2658. Return the position and index of the data point nearest the given coordinate
  2659. </summary>
  2660. <param name="x">location in coordinate space</param>
  2661. <param name="y">location in coordinate space</param>
  2662. <param name="xyRatio">Ratio of pixels per unit (X/Y) when rendered</param>
  2663. </member>
  2664. <member name="T:ScottPlot.Plottable.ScatterPlotList">
  2665. <summary>
  2666. A collection of X/Y coordinates that can be displayed as markers and/or connected lines.
  2667. Unlike the regular ScatterPlot, this plot type has Add() methods to easily add data.
  2668. </summary>
  2669. </member>
  2670. <member name="M:ScottPlot.Plottable.ScatterPlotList.Clear">
  2671. <summary>
  2672. Clear the list of points
  2673. </summary>
  2674. </member>
  2675. <member name="M:ScottPlot.Plottable.ScatterPlotList.Add(System.Double,System.Double)">
  2676. <summary>
  2677. Add a single point to the list
  2678. </summary>
  2679. </member>
  2680. <member name="M:ScottPlot.Plottable.ScatterPlotList.AddRange(System.Double[],System.Double[])">
  2681. <summary>
  2682. Add multiple points to the list
  2683. </summary>
  2684. </member>
  2685. <member name="T:ScottPlot.Plottable.SignalPlot">
  2686. <summary>
  2687. A signal plot displays evenly-spaced data.
  2688. Instead of X/Y pairs, signal plots take Y values and a sample rate.
  2689. Optional X and Y offsets can further customize the data.
  2690. </summary>
  2691. </member>
  2692. <member name="P:ScottPlot.Plottable.SignalPlotBase`1.UseParallel">
  2693. <summary>
  2694. If enabled, parallel processing will be used to calculate pixel positions for high density datasets.
  2695. </summary>
  2696. </member>
  2697. <member name="P:ScottPlot.Plottable.SignalPlotBase`1.BaselineY">
  2698. <summary>
  2699. If fill above and/or below is enabled, this defines the baseline level.
  2700. </summary>
  2701. </member>
  2702. <member name="P:ScottPlot.Plottable.SignalPlotBase`1.BaselineColor">
  2703. <summary>
  2704. If fill is enabled, a baseline will be drawn using this color.
  2705. </summary>
  2706. </member>
  2707. <member name="P:ScottPlot.Plottable.SignalPlotBase`1.BaselineWidth">
  2708. <summary>
  2709. If fill is enabled, a baseline will be drawn using this width.
  2710. </summary>
  2711. </member>
  2712. <member name="P:ScottPlot.Plottable.SignalPlotBase`1.GradientFillColor1">
  2713. <summary>
  2714. If fill is enabled, this color will be used to fill the area below the curve above BaselineY.
  2715. </summary>
  2716. </member>
  2717. <member name="P:ScottPlot.Plottable.SignalPlotBase`1.GradientFillColor2">
  2718. <summary>
  2719. If fill is enabled, this color will be used to fill the area above the curve below BaselineY.
  2720. </summary>
  2721. </member>
  2722. <member name="P:ScottPlot.Plottable.SignalPlotBase`1.ShowMarkersInLegend">
  2723. <summary>
  2724. When markers are visible on the line (low density mode) this is True
  2725. </summary>
  2726. </member>
  2727. <member name="F:ScottPlot.Plottable.SignalPlotBase`1.AddYsGenericExpression">
  2728. <summary>
  2729. This expression adds two parameters of the generic type used by this signal plot.
  2730. </summary>
  2731. </member>
  2732. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.AddYs(`0,`0)">
  2733. <summary>
  2734. Add two Y values (of the generic type used by this signal plot) and return the result as a double
  2735. </summary>
  2736. </member>
  2737. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.AddYsGeneric(`0,`0)">
  2738. <summary>
  2739. Add two Y values (of the generic type used by this signal plot) and return the result as a the same type
  2740. </summary>
  2741. </member>
  2742. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.Update(System.Int32,`0)">
  2743. <summary>
  2744. Replace a single Y value
  2745. </summary>
  2746. <param name="index">array index to replace</param>
  2747. <param name="newValue">new value</param>
  2748. </member>
  2749. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.Update(System.Int32,System.Int32,`0[],System.Int32)">
  2750. <summary>
  2751. Replace a range of Y values
  2752. </summary>
  2753. <param name="firstIndex">index to begin replacing</param>
  2754. <param name="lastIndex">last index to replace</param>
  2755. <param name="newData">source for new data</param>
  2756. <param name="fromData">source data offset</param>
  2757. </member>
  2758. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.Update(System.Int32,`0[])">
  2759. <summary>
  2760. Replace all Y values from the given index through the end of the array
  2761. </summary>
  2762. <param name="firstIndex">first index to begin replacing</param>
  2763. <param name="newData">new values</param>
  2764. </member>
  2765. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.Update(`0[])">
  2766. <summary>
  2767. Replace all Y values with new ones
  2768. </summary>
  2769. <param name="newData">new Y values</param>
  2770. </member>
  2771. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.RenderSingleLine(ScottPlot.PlotDimensions,System.Drawing.Graphics,System.Drawing.Pen)">
  2772. <summary>
  2773. Render when the data is zoomed out so much that it just looks like a vertical line.
  2774. </summary>
  2775. </member>
  2776. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.RenderLowDensity(ScottPlot.PlotDimensions,System.Drawing.Graphics,System.Int32,System.Int32,System.Drawing.Brush,System.Drawing.Pen,System.Drawing.Pen)">
  2777. <summary>
  2778. Render when the data is zoomed in such that there is more than 1 column per data point.
  2779. Rendering is accomplished by drawing a straight line from point to point.
  2780. </summary>
  2781. </member>
  2782. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.GetStepPoints(System.Drawing.PointF[])">
  2783. <summary>
  2784. Convert scatter plot points (connected by diagnal lines) to step plot points (connected by right angles)
  2785. by inserting an extra point between each of the original data points.
  2786. </summary>
  2787. </member>
  2788. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.RenderHighDensity(ScottPlot.PlotDimensions,System.Drawing.Graphics,System.Double,System.Double,System.Drawing.Pen)">
  2789. <summary>
  2790. Render the data when there is more than one data point per pixel column.
  2791. Each pixel column therefore represents multiple data points.
  2792. Rendering is optimized by determining the min/max for each pixel column, then a single line is drawn connecting those values.
  2793. </summary>
  2794. </member>
  2795. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.FillToInfinity(ScottPlot.PlotDimensions,System.Drawing.Graphics,System.Single,System.Single,System.Drawing.PointF[],System.Boolean)">
  2796. <summary>
  2797. Shade the region abvove or below the curve (to infinity) by drawing a polygon to the edge of the visible plot area.
  2798. </summary>
  2799. </member>
  2800. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.FillToBaseline(ScottPlot.PlotDimensions,System.Drawing.Graphics,System.Single,System.Single,System.Drawing.PointF[],System.Double)">
  2801. <summary>
  2802. Shade the region abvove and below the curve (to the baseline level) by drawing two polygons
  2803. </summary>
  2804. </member>
  2805. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.RenderHighDensityDistributionParallel(ScottPlot.PlotDimensions,System.Drawing.Graphics,System.Double,System.Double)">
  2806. <summary>
  2807. Render similar to high density mode except use multiple colors to represent density distributions.
  2808. </summary>
  2809. </member>
  2810. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.GetPointNearestX(System.Double)">
  2811. <summary>
  2812. Return the X/Y coordinates of the point nearest the X position
  2813. </summary>
  2814. <param name="x">X position in plot space</param>
  2815. <returns></returns>
  2816. </member>
  2817. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.FillDisable">
  2818. <summary>
  2819. Configure the signal plot to only show the curve with no filled area above or below it
  2820. </summary>
  2821. </member>
  2822. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.FillBelow(System.Nullable{System.Drawing.Color},System.Double)">
  2823. <summary>
  2824. Show a solid color beneath the curve
  2825. </summary>
  2826. </member>
  2827. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.FillBelow(System.Drawing.Color,System.Drawing.Color,System.Double)">
  2828. <summary>
  2829. Show a two-color gradient beneath the curve
  2830. </summary>
  2831. </member>
  2832. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.FillAbove(System.Nullable{System.Drawing.Color},System.Double)">
  2833. <summary>
  2834. Show a solid color above the curve
  2835. </summary>
  2836. </member>
  2837. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.FillAbove(System.Drawing.Color,System.Drawing.Color,System.Double)">
  2838. <summary>
  2839. Show a two-color gradient above the curve
  2840. </summary>
  2841. </member>
  2842. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.FillAboveAndBelow(System.Drawing.Color,System.Drawing.Color,System.Double)">
  2843. <summary>
  2844. Fill the area between the curve and the <see cref="P:ScottPlot.Plottable.SignalPlotBase`1.BaselineY"/> value
  2845. </summary>
  2846. </member>
  2847. <member name="M:ScottPlot.Plottable.SignalPlotBase`1.FillAboveAndBelow(System.Drawing.Color,System.Drawing.Color,System.Drawing.Color,System.Drawing.Color,System.Double)">
  2848. <summary>
  2849. Fill the area between the curve and the edge of the display area using two gradients
  2850. </summary>
  2851. <param name="above1">Color above the line next to the curve</param>
  2852. <param name="above2">Color above the line next to the upper edge of the plot area</param>
  2853. <param name="below1">Color below the line next to the curve</param>
  2854. <param name="below2">Color below the line next to the lower edge of the plot area</param>
  2855. <param name="alpha">Apply this opacity to all colors</param>
  2856. </member>
  2857. <member name="T:ScottPlot.Plottable.SignalPlotConst`1">
  2858. <summary>
  2859. This plot type is a potentially faster version of the SignalPlot.
  2860. It pre-calculates min/max values for various segments of data, greatly speeding-up rendering
  2861. for extremely large datasets (10s of millions of points).
  2862. Note that these pre-calculations require more memory and an up-front calculation delay.
  2863. If the underlying data is updated, you must call Update() methods to recalculate the min/max values.
  2864. </summary>
  2865. <typeparam name="T"></typeparam>
  2866. </member>
  2867. <member name="T:ScottPlot.Plottable.SignalPlotXY">
  2868. <summary>
  2869. A variation of the SignalPlot optimized for unevenly-spaced ascending X values.
  2870. </summary>
  2871. </member>
  2872. <member name="T:ScottPlot.Plottable.SignalPlotXYConst`2">
  2873. <summary>
  2874. A variation of the SignalPlotConst optimized for unevenly-spaced ascending X values.
  2875. </summary>
  2876. <typeparam name="TX"></typeparam>
  2877. <typeparam name="TY"></typeparam>
  2878. </member>
  2879. <member name="T:ScottPlot.Plottable.SignalPlotXYGeneric`2">
  2880. <summary>
  2881. A variation of the SignalPlotConst optimized for unevenly-spaced ascending X values.
  2882. </summary>
  2883. <typeparam name="TX"></typeparam>
  2884. <typeparam name="TY"></typeparam>
  2885. </member>
  2886. <member name="M:ScottPlot.Plottable.SignalPlotXYGeneric`2.ProcessInterval(System.Int32,System.Int32,System.Int32,ScottPlot.PlotDimensions)">
  2887. <summary>
  2888. TODO: document this
  2889. </summary>
  2890. <param name="x"></param>
  2891. <param name="from"></param>
  2892. <param name="length"></param>
  2893. <param name="dims"></param>
  2894. <returns></returns>
  2895. </member>
  2896. <member name="M:ScottPlot.Plottable.SignalPlotXYGeneric`2.GetPointNearestX(`0)">
  2897. <summary>
  2898. Return the X/Y coordinates of the point nearest the X position
  2899. </summary>
  2900. <param name="x">X position in plot space</param>
  2901. <returns></returns>
  2902. </member>
  2903. <member name="M:ScottPlot.Plottable.SignalPlotXYGeneric`2.GetPointNearestX(System.Double)">
  2904. <summary>
  2905. This method to pass test only
  2906. </summary>
  2907. <param name="x">X position in plot space</param>
  2908. <returns></returns>
  2909. </member>
  2910. <member name="T:ScottPlot.Plottable.Text">
  2911. <summary>
  2912. Display a text label at an X/Y position in coordinate space
  2913. </summary>
  2914. </member>
  2915. <member name="T:ScottPlot.Plottable.Tooltip">
  2916. <summary>
  2917. A tooltip displays a text bubble pointing to a specific location in X/Y space.
  2918. The position of the bubble moves according to the axis limits to best display the text in the data area.
  2919. </summary>
  2920. </member>
  2921. <member name="F:ScottPlot.Plottable.Tooltip.X">
  2922. <summary>
  2923. Tooltip position in coordinate space
  2924. </summary>
  2925. </member>
  2926. <member name="F:ScottPlot.Plottable.Tooltip.Y">
  2927. <summary>
  2928. Tooltip position in coordinate space
  2929. </summary>
  2930. </member>
  2931. <member name="T:ScottPlot.Plottable.VectorField">
  2932. <summary>
  2933. The VectorField displays arrows representing a 2D array of 2D vectors
  2934. </summary>
  2935. </member>
  2936. <member name="P:ScottPlot.Plottable.VectorField.Anchor">
  2937. <summary>
  2938. Describes which part of the vector line will be placed at the data coordinates.
  2939. </summary>
  2940. </member>
  2941. <member name="P:ScottPlot.Plottable.VectorField.ScaledArrowheads">
  2942. <summary>
  2943. If enabled arrowheads will be drawn as lines scaled to each vector's magnitude.
  2944. </summary>
  2945. </member>
  2946. <member name="P:ScottPlot.Plottable.VectorField.ScaledArrowheadWidth">
  2947. <summary>
  2948. When using scaled arrowheads this defines the width of the arrow relative to the vector line's length.
  2949. </summary>
  2950. </member>
  2951. <member name="P:ScottPlot.Plottable.VectorField.ScaledArrowheadLength">
  2952. <summary>
  2953. When using scaled arrowheads this defines length of the arrowhead relative to the vector line's length.
  2954. </summary>
  2955. </member>
  2956. <member name="P:ScottPlot.Plottable.VectorField.MarkerShape">
  2957. <summary>
  2958. Marker drawn at each coordinate
  2959. </summary>
  2960. </member>
  2961. <member name="P:ScottPlot.Plottable.VectorField.MarkerSize">
  2962. <summary>
  2963. Size of markers to be drawn at each coordinate
  2964. </summary>
  2965. </member>
  2966. <member name="T:ScottPlot.Plottable.VLine">
  2967. <summary>
  2968. Vertical line at an X position
  2969. </summary>
  2970. </member>
  2971. <member name="P:ScottPlot.Plottable.VLine.X">
  2972. <summary>
  2973. X position to render the line
  2974. </summary>
  2975. </member>
  2976. <member name="T:ScottPlot.DataSet">
  2977. <summary>
  2978. Represents a series of data values with a common name. Values from several DataSets can be grouped (by value index).
  2979. </summary>
  2980. </member>
  2981. <member name="T:ScottPlot.OHLC">
  2982. <summary>
  2983. This class holds open/high/low/close (OHLC) price data over a time range.
  2984. </summary>
  2985. </member>
  2986. <member name="M:ScottPlot.OHLC.#ctor(System.Double,System.Double,System.Double,System.Double,System.DateTime,System.TimeSpan)">
  2987. <summary>
  2988. OHLC price over a specific period of time
  2989. </summary>
  2990. <param name="open">opening price</param>
  2991. <param name="high">maximum price</param>
  2992. <param name="low">minimum price</param>
  2993. <param name="close">closing price</param>
  2994. <param name="timeStart">open time</param>
  2995. <param name="timeSpan">width of the OHLC</param>
  2996. </member>
  2997. <member name="M:ScottPlot.OHLC.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
  2998. <summary>
  2999. OHLC price over a specific period of time
  3000. </summary>
  3001. <param name="open">opening price</param>
  3002. <param name="high">maximum price</param>
  3003. <param name="low">minimum price</param>
  3004. <param name="close">closing price</param>
  3005. <param name="timeStart">open time (DateTime.ToOADate() units)</param>
  3006. <param name="timeSpan">width of the OHLC in days</param>
  3007. </member>
  3008. <member name="M:ScottPlot.Plot.AddAnnotation(System.String,System.Double,System.Double)">
  3009. <summary>
  3010. Display text in the data area at a pixel location (not a X/Y coordinates)
  3011. </summary>
  3012. </member>
  3013. <member name="M:ScottPlot.Plot.AddArrow(System.Double,System.Double,System.Double,System.Double,System.Single,System.Nullable{System.Drawing.Color})">
  3014. <summary>
  3015. Display an arrow pointing to a spot in coordinate space
  3016. </summary>
  3017. </member>
  3018. <member name="M:ScottPlot.Plot.AddClevelandDot(System.Double[],System.Double[])">
  3019. <summary>
  3020. Add a Cleveland Dot plot for the given values. Cleveland Dots will be placed at X positions 0, 1, 2, etc.
  3021. </summary>
  3022. </member>
  3023. <member name="M:ScottPlot.Plot.AddClevelandDot(System.Double[],System.Double[],System.Double[])">
  3024. <summary>
  3025. Add a Cleveland Dot plot for the given values using defined dot positions.
  3026. </summary>
  3027. </member>
  3028. <member name="M:ScottPlot.Plot.AddLollipop(System.Double[],System.Nullable{System.Drawing.Color})">
  3029. <summary>
  3030. Add a Lollipop plot for the given values. Lollipops will be placed at X positions 0, 1, 2, etc.
  3031. </summary>
  3032. </member>
  3033. <member name="M:ScottPlot.Plot.AddLollipop(System.Double[],System.Double[],System.Nullable{System.Drawing.Color})">
  3034. <summary>
  3035. Add a lollipop plot for the given values using defined lollipop positions
  3036. </summary>
  3037. </member>
  3038. <member name="M:ScottPlot.Plot.AddBar(System.Double[],System.Nullable{System.Drawing.Color})">
  3039. <summary>
  3040. Add a bar plot for the given values. Bars will be placed at X positions 0, 1, 2, etc.
  3041. </summary>
  3042. </member>
  3043. <member name="M:ScottPlot.Plot.AddBar(System.Double[],System.Double[],System.Nullable{System.Drawing.Color})">
  3044. <summary>
  3045. Add a bar plot for the given values using defined bar positions
  3046. </summary>
  3047. </member>
  3048. <member name="M:ScottPlot.Plot.AddBar(System.Double[],System.Double[],System.Double[],System.Nullable{System.Drawing.Color})">
  3049. <summary>
  3050. Add a bar plot (values +/- errors) using defined positions
  3051. </summary>
  3052. </member>
  3053. <member name="M:ScottPlot.Plot.AddBarGroups(System.String[],System.String[],System.Double[][],System.Double[][])">
  3054. <summary>
  3055. Create a series of bar plots and customize the ticks and legend
  3056. </summary>
  3057. </member>
  3058. <member name="M:ScottPlot.Plot.AddBubblePlot">
  3059. <summary>
  3060. Add an empty bubble plot. Call it's Add() method to add bubbles with custom position and styling.
  3061. </summary>
  3062. </member>
  3063. <member name="M:ScottPlot.Plot.AddBubblePlot(System.Double[],System.Double[],System.Double,System.Nullable{System.Drawing.Color},System.Double,System.Nullable{System.Drawing.Color})">
  3064. <summary>
  3065. Add a bubble plot with multiple bubbles at the given positions all styled the same.
  3066. Call the Add() method to add bubbles manually, allowing further customization of size and style.
  3067. </summary>
  3068. </member>
  3069. <member name="M:ScottPlot.Plot.AddCandlesticks(ScottPlot.OHLC[])">
  3070. <summary>
  3071. Add candlesticks to the chart from OHLC (open, high, low, close) data
  3072. </summary>
  3073. </member>
  3074. <member name="M:ScottPlot.Plot.AddColorbar(ScottPlot.Drawing.Colormap,System.Int32)">
  3075. <summary>
  3076. Add a colorbar to display a colormap beside the data area
  3077. </summary>
  3078. <param name="colormap">Colormap to display in this colorbar</param>
  3079. <param name="space">The size of the right axis will be set to this number of pixels to make room for the colorbar</param>
  3080. <returns>the colorbar that was just created</returns>
  3081. </member>
  3082. <member name="M:ScottPlot.Plot.AddColorbar(ScottPlot.Plottable.IHasColormap,System.Int32)">
  3083. <summary>
  3084. Add a colorbar initialized with settings from a heatmap
  3085. </summary>
  3086. <param name="heatmap">A heatmap-containing plottable to connect with this colorbar</param>
  3087. <param name="space">The size of the right axis will be set to this number of pixels to make room for the colorbar</param>
  3088. <returns>the colorbar that was just created</returns>
  3089. </member>
  3090. <member name="M:ScottPlot.Plot.AddCrosshair(System.Double,System.Double)">
  3091. <summary>
  3092. Add a crosshair to the plot
  3093. </summary>
  3094. <param name="x">position of vertical line (axis units)</param>
  3095. <param name="y">position of horizontal line (axis units)</param>
  3096. <returns>the crosshair that was just created</returns>
  3097. </member>
  3098. <member name="M:ScottPlot.Plot.AddFill(System.Double[],System.Double[],System.Double,System.Nullable{System.Drawing.Color})">
  3099. <summary>
  3100. Create a polygon to fill the area between Y values and a baseline.
  3101. </summary>
  3102. </member>
  3103. <member name="M:ScottPlot.Plot.AddFill(System.Double[],System.Double[],System.Double[],System.Nullable{System.Drawing.Color})">
  3104. <summary>
  3105. Create a polygon to fill the area between two Y curves that share the same X positions.
  3106. </summary>
  3107. </member>
  3108. <member name="M:ScottPlot.Plot.AddFill(System.Double[],System.Double[],System.Double[],System.Double[],System.Nullable{System.Drawing.Color})">
  3109. <summary>
  3110. Create a polygon to fill the area between Y values of two curves.
  3111. </summary>
  3112. </member>
  3113. <member name="M:ScottPlot.Plot.AddFillAboveAndBelow(System.Double[],System.Double[],System.Double,System.Nullable{System.Drawing.Color},System.Nullable{System.Drawing.Color})">
  3114. <summary>
  3115. Create a polygon to fill the area between Y values and a baseline
  3116. that uses two different colors for area above and area below the baseline.
  3117. </summary>
  3118. </member>
  3119. <member name="M:ScottPlot.Plot.AddFunction(System.Func{System.Double,System.Nullable{System.Double}},System.Nullable{System.Drawing.Color},System.Double,ScottPlot.LineStyle)">
  3120. <summary>
  3121. Add a line plot that uses a function (rather than X/Y points) to place the curve
  3122. </summary>
  3123. </member>
  3124. <member name="M:ScottPlot.Plot.AddHeatmap(System.Nullable{System.Double}[0:,0:],ScottPlot.Drawing.Colormap,System.Boolean)">
  3125. <summary>
  3126. Add a heatmap to the plot automatically-sized so each cell is 1x1.
  3127. </summary>
  3128. <param name="intensities">2D array of intensities.
  3129. WARNING: Rendering artifacts may appear for arrays larger than Bitmap can support (~10M total values).</param>
  3130. <param name="colormap"></param>
  3131. <param name="lockScales">If true, AxisScaleLock() will be called to ensure heatmap cells will be square.</param>
  3132. <returns>
  3133. Returns the heatmap that was added to the plot.
  3134. Act on its public fields and methods to customize it or update its data.
  3135. </returns>
  3136. </member>
  3137. <member name="M:ScottPlot.Plot.AddHeatmap(System.Double[0:,0:],ScottPlot.Drawing.Colormap,System.Boolean)">
  3138. <summary>
  3139. Add a heatmap to the plot automatically-sized so each cell is 1x1.
  3140. </summary>
  3141. <param name="intensities">2D array of intensities.
  3142. WARNING: Rendering artifacts may appear for arrays larger than Bitmap can support (~10M total values).</param>
  3143. <param name="colormap"></param>
  3144. <param name="lockScales">If true, AxisScaleLock() will be called to ensure heatmap cells will be square.</param>
  3145. <returns>
  3146. Returns the heatmap that was added to the plot.
  3147. Act on its public fields and methods to customize it or update its data.
  3148. </returns>
  3149. </member>
  3150. <member name="M:ScottPlot.Plot.AddHeatmapCoordinated(System.Nullable{System.Double}[0:,0:],System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},ScottPlot.Drawing.Colormap)">
  3151. <summary>
  3152. Add heatmap to the plot stretched to fit the given dimensions.
  3153. Unlike the regular heatmap which gives each cell a size of 1x1 and starts at the axis origin,
  3154. this heatmap stretches the array so that it covers the defined X and Y spans.
  3155. </summary>
  3156. <param name="intensities">2D array of intensities.
  3157. WARNING: Rendering artifacts may appear for arrays larger than Bitmap can support (~10M total values).</param>
  3158. <param name="xMin">position of the left edge of the far left column</param>
  3159. <param name="xMax">position of the left edge of the far right column</param>
  3160. <param name="yMin">position of the upper edge of the bottom row</param>
  3161. <param name="yMax">position of the upper edge of the top row</param>
  3162. <param name="colormap"></param>
  3163. <returns>
  3164. Returns the heatmap that was added to the plot.
  3165. Act on its public fields and methods to customize it or update its data.
  3166. </returns>
  3167. </member>
  3168. <member name="M:ScottPlot.Plot.AddHeatmapCoordinated(System.Double[0:,0:],System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},ScottPlot.Drawing.Colormap)">
  3169. <summary>
  3170. Add heatmap to the plot stretched to fit the given dimensions.
  3171. Unlike the regular heatmap which gives each cell a size of 1x1 and starts at the axis origin,
  3172. this heatmap stretches the array so that it covers the defined X and Y spans.
  3173. </summary>
  3174. <param name="intensities">2D array of intensities.
  3175. WARNING: Rendering artifacts may appear for arrays larger than Bitmap can support (~10M total values).</param>
  3176. <param name="xMin">position of the left edge of the far left column</param>
  3177. <param name="xMax">position of the left edge of the far right column</param>
  3178. <param name="yMin">position of the upper edge of the bottom row</param>
  3179. <param name="yMax">position of the upper edge of the top row</param>
  3180. <param name="colormap"></param>
  3181. <returns>
  3182. Returns the heatmap that was added to the plot.
  3183. Act on its public fields and methods to customize it or update its data.
  3184. </returns>
  3185. </member>
  3186. <member name="M:ScottPlot.Plot.AddHorizontalLine(System.Double,System.Nullable{System.Drawing.Color},System.Single,ScottPlot.LineStyle,System.String)">
  3187. <summary>
  3188. Add a horizontal axis line at a specific Y position
  3189. </summary>
  3190. </member>
  3191. <member name="M:ScottPlot.Plot.AddHorizontalSpan(System.Double,System.Double,System.Nullable{System.Drawing.Color},System.String)">
  3192. <summary>
  3193. Add a horizontal span (shades the region between two X positions)
  3194. </summary>
  3195. </member>
  3196. <member name="M:ScottPlot.Plot.AddImage(System.Drawing.Bitmap,System.Double,System.Double)">
  3197. <summary>
  3198. Display an image at a specific coordinate
  3199. </summary>
  3200. </member>
  3201. <member name="M:ScottPlot.Plot.AddLine(System.Double,System.Double,System.Double,System.Double,System.Nullable{System.Drawing.Color},System.Single)">
  3202. <summary>
  3203. Add a line (a scatter plot with two points) to the plot
  3204. </summary>
  3205. </member>
  3206. <member name="M:ScottPlot.Plot.AddLine(System.Double,System.Double,System.ValueTuple{System.Double,System.Double},System.Nullable{System.Drawing.Color},System.Single)">
  3207. <summary>
  3208. Add a line (a scatter plot with two points) to the plot
  3209. </summary>
  3210. </member>
  3211. <member name="M:ScottPlot.Plot.AddMarker(System.Double,System.Double,ScottPlot.MarkerShape,System.Double,System.Nullable{System.Drawing.Color},System.String)">
  3212. <summary>
  3213. Add a marker at a specific X/Y position.
  3214. This method really creates a scatter plot with a single point.
  3215. </summary>
  3216. </member>
  3217. <member name="M:ScottPlot.Plot.AddOHLCs(ScottPlot.OHLC[])">
  3218. <summary>
  3219. Add OHLC (open, high, low, close) data to the plot
  3220. </summary>
  3221. </member>
  3222. <member name="M:ScottPlot.Plot.AddPie(System.Double[],System.Boolean)">
  3223. <summary>
  3224. Add a pie chart to the plot
  3225. </summary>
  3226. </member>
  3227. <member name="M:ScottPlot.Plot.AddPoint(System.Double,System.Double,System.Nullable{System.Drawing.Color},System.Single,ScottPlot.MarkerShape,System.String)">
  3228. <summary>
  3229. Add a point (a scatter plot with a single marker)
  3230. </summary>
  3231. <param name="x"></param>
  3232. <param name="y"></param>
  3233. <param name="color">color of the marker</param>
  3234. <param name="size">size of the marker</param>
  3235. <param name="shape">maker shape</param>
  3236. <param name="label">text to appear in the legend</param>
  3237. <returns>
  3238. The scatter plot that was created and added to the plot.
  3239. Interact with its public fields and methods to customize style and update data.
  3240. </returns>
  3241. </member>
  3242. <member name="M:ScottPlot.Plot.AddPolygon(System.Double[],System.Double[],System.Nullable{System.Drawing.Color},System.Double,System.Nullable{System.Drawing.Color})">
  3243. <summary>
  3244. Add a polygon to the plot
  3245. </summary>
  3246. </member>
  3247. <member name="M:ScottPlot.Plot.AddPolygons(System.Collections.Generic.List{System.Collections.Generic.List{System.ValueTuple{System.Double,System.Double}}},System.Nullable{System.Drawing.Color},System.Double,System.Nullable{System.Drawing.Color})">
  3248. <summary>
  3249. Add many polygons using an optimized rendering method
  3250. </summary>
  3251. </member>
  3252. <member name="M:ScottPlot.Plot.AddPopulation(ScottPlot.Statistics.Population,System.String)">
  3253. <summary>
  3254. Add a population to the plot
  3255. </summary>
  3256. </member>
  3257. <member name="M:ScottPlot.Plot.AddPopulations(ScottPlot.Statistics.Population[],System.String)">
  3258. <summary>
  3259. Add multiple populations to the plot as a single series
  3260. </summary>
  3261. </member>
  3262. <member name="M:ScottPlot.Plot.AddPopulations(ScottPlot.Statistics.PopulationMultiSeries)">
  3263. <summary>
  3264. Add multiple populations to the plot as a single series
  3265. </summary>
  3266. </member>
  3267. <member name="M:ScottPlot.Plot.AddRadar(System.Double[0:,0:],System.Boolean,System.Double[],System.Boolean)">
  3268. <summary>
  3269. Add a radar plot (a two-dimensional chart of three or more quantitative variables represented on axes starting from the same point)
  3270. </summary>
  3271. <param name="values">2D array containing categories (columns) and groups (rows)</param>
  3272. <param name="independentAxes">if true, axis (category) values are scaled independently</param>
  3273. <param name="maxValues">if provided, each category (column) is normalized to these values</param>
  3274. <param name="disableFrameAndGrid">also make the plot frameless and disable its grid</param>
  3275. <returns>the radar plot that was just created and added to the plot</returns>
  3276. </member>
  3277. <member name="M:ScottPlot.Plot.AddRadialGauge(System.Double[],System.Boolean)">
  3278. <summary>
  3279. Add a radial gauge plot (a chart where data is represented by concentric circular gauges)
  3280. </summary>
  3281. <param name="values">Array of gauge values</param>
  3282. <param name="disableFrameAndGrid">Also make the plot frameless and disable its grid</param>
  3283. <returns>The radial gaugle plot that was just created and added to the plot</returns>
  3284. </member>
  3285. <member name="M:ScottPlot.Plot.AddCoxcomb(System.Double[],System.Boolean)">
  3286. <summary>
  3287. A Pie chart where the angle of slices is constant but the radii are not.
  3288. </summary>
  3289. <param name="values">The data to plot</param>
  3290. <param name="hideGridAndFrame">Whether to make the plot frameless and disable the grid</param>
  3291. </member>
  3292. <member name="M:ScottPlot.Plot.AddScaleBar(System.Double,System.Double,System.String,System.String)">
  3293. <summary>
  3294. Add an L-shaped scalebar to the corner of the plot
  3295. </summary>
  3296. </member>
  3297. <member name="M:ScottPlot.Plot.AddScatter(System.Double[],System.Double[],System.Nullable{System.Drawing.Color},System.Single,System.Single,ScottPlot.MarkerShape,ScottPlot.LineStyle,System.String)">
  3298. <summary>
  3299. Add a scatter plot from X/Y pairs.
  3300. Lines and markers are shown by default.
  3301. Scatter plots are slower than Signal plots.
  3302. </summary>
  3303. </member>
  3304. <member name="M:ScottPlot.Plot.AddScatterLines(System.Double[],System.Double[],System.Nullable{System.Drawing.Color},System.Single,ScottPlot.LineStyle,System.String)">
  3305. <summary>
  3306. Add a scatter plot from X/Y pairs connected by lines (no markers).
  3307. Scatter plots are slower than Signal plots.
  3308. </summary>
  3309. </member>
  3310. <member name="M:ScottPlot.Plot.AddScatterPoints(System.Double[],System.Double[],System.Nullable{System.Drawing.Color},System.Single,ScottPlot.MarkerShape,System.String)">
  3311. <summary>
  3312. Add a scatter plot from X/Y pairs using markers at points (no lines).
  3313. Scatter plots are slower than Signal plots.
  3314. </summary>
  3315. </member>
  3316. <member name="M:ScottPlot.Plot.AddScatterStep(System.Double[],System.Double[],System.Nullable{System.Drawing.Color},System.Single,System.String)">
  3317. <summary>
  3318. Add a step plot is a type of line plot where points are connected with right angles instead of straight lines.
  3319. </summary>
  3320. </member>
  3321. <member name="M:ScottPlot.Plot.AddScatterList(System.Nullable{System.Drawing.Color},System.Single,System.Single,System.String,ScottPlot.MarkerShape,ScottPlot.LineStyle)">
  3322. <summary>
  3323. Scatter plot with Add() and Clear() methods for updating data
  3324. </summary>
  3325. </member>
  3326. <member name="M:ScottPlot.Plot.AddSignal(System.Double[],System.Double,System.Nullable{System.Drawing.Color},System.String)">
  3327. <summary>
  3328. Signal plots have evenly-spaced X points and render very fast.
  3329. </summary>
  3330. </member>
  3331. <member name="M:ScottPlot.Plot.AddSignalConst``1(``0[],System.Double,System.Nullable{System.Drawing.Color},System.String)">
  3332. <summary>
  3333. SignalConts plots have evenly-spaced X points and render faster than Signal plots
  3334. but data in source arrays cannot be changed after it is loaded.
  3335. Methods can be used to update all or portions of the data.
  3336. </summary>
  3337. </member>
  3338. <member name="M:ScottPlot.Plot.AddSignalXY(System.Double[],System.Double[],System.Nullable{System.Drawing.Color},System.String)">
  3339. <summary>
  3340. Speed-optimized plot for Ys with unevenly-spaced ascending Xs
  3341. </summary>
  3342. </member>
  3343. <member name="M:ScottPlot.Plot.AddSignalXYConst``2(``0[],``1[],System.Nullable{System.Drawing.Color},System.String)">
  3344. <summary>
  3345. Speed-optimized plot for Ys with unevenly-spaced ascending Xs.
  3346. Faster than SignalXY but values cannot be modified after loading.
  3347. </summary>
  3348. </member>
  3349. <member name="M:ScottPlot.Plot.AddText(System.String,System.Double,System.Double,System.Single,System.Nullable{System.Drawing.Color})">
  3350. <summary>
  3351. Display text at specific X/Y coordinates
  3352. </summary>
  3353. </member>
  3354. <member name="M:ScottPlot.Plot.AddText(System.String,System.Double,System.Double,ScottPlot.Drawing.Font)">
  3355. <summary>
  3356. Display text at specific X/Y coordinates
  3357. </summary>
  3358. </member>
  3359. <member name="M:ScottPlot.Plot.AddTooltip(System.String,System.Double,System.Double)">
  3360. <summary>
  3361. Display a text bubble that points to an X/Y location on the plot
  3362. </summary>
  3363. </member>
  3364. <member name="M:ScottPlot.Plot.AddVectorField(ScottPlot.Statistics.Vector2[0:,0:],System.Double[],System.Double[],System.String,System.Nullable{System.Drawing.Color},ScottPlot.Drawing.Colormap,System.Double)">
  3365. <summary>
  3366. Add a 2D vector field to the plot
  3367. </summary>
  3368. </member>
  3369. <member name="M:ScottPlot.Plot.AddVerticalLine(System.Double,System.Nullable{System.Drawing.Color},System.Single,ScottPlot.LineStyle,System.String)">
  3370. <summary>
  3371. Add a vertical axis line at a specific Y position
  3372. </summary>
  3373. </member>
  3374. <member name="M:ScottPlot.Plot.AddVerticalSpan(System.Double,System.Double,System.Nullable{System.Drawing.Color},System.String)">
  3375. <summary>
  3376. Add a horizontal span (shades the region between two X positions)
  3377. </summary>
  3378. </member>
  3379. <member name="P:ScottPlot.Plot.XAxis">
  3380. <summary>
  3381. Axis on the bottom edge of the plot
  3382. </summary>
  3383. </member>
  3384. <member name="P:ScottPlot.Plot.XAxis2">
  3385. <summary>
  3386. Axis on the top edge of the plot
  3387. </summary>
  3388. </member>
  3389. <member name="P:ScottPlot.Plot.YAxis">
  3390. <summary>
  3391. Axis on the left edge of the plot
  3392. </summary>
  3393. </member>
  3394. <member name="P:ScottPlot.Plot.YAxis2">
  3395. <summary>
  3396. Axis on the right edge of the plot
  3397. </summary>
  3398. </member>
  3399. <member name="M:ScottPlot.Plot.XLabel(System.String)">
  3400. <summary>
  3401. Set the label for the vertical axis to the right of the plot (XAxis)
  3402. </summary>
  3403. <param name="label">new text</param>
  3404. </member>
  3405. <member name="M:ScottPlot.Plot.YLabel(System.String)">
  3406. <summary>
  3407. Set the label for the vertical axis to the right of the plot (YAxis2)
  3408. </summary>
  3409. <param name="label">new text</param>
  3410. </member>
  3411. <member name="M:ScottPlot.Plot.Title(System.String,System.Boolean)">
  3412. <summary>
  3413. Set the label for the horizontal axis above the plot (XAxis2)
  3414. </summary>
  3415. <param name="label">new text</param>
  3416. <param name="bold">controls font weight</param>
  3417. </member>
  3418. <member name="M:ScottPlot.Plot.Frame(System.Nullable{System.Boolean},System.Nullable{System.Drawing.Color},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
  3419. <summary>
  3420. Configure color and visibility of the frame that outlines the data area.
  3421. Note that the axis lines of all 4 primary axes touch each other,
  3422. giving the appearance of a rectangle framing the data area.
  3423. This method allows the user to customize these lines as a group or individually.
  3424. </summary>
  3425. <param name="visible">visibility of the frames for the 4 primary axes</param>
  3426. <param name="color">color for the 4 primary axis lines</param>
  3427. <param name="left">visibility of the left axis (YAxis) line</param>
  3428. <param name="right">visibility of the right axis (YAxis2) line</param>
  3429. <param name="bottom">visibility of the bottom axis (XAxis) line</param>
  3430. <param name="top">visibility of the top axis (XAxis2) line</param>
  3431. </member>
  3432. <member name="M:ScottPlot.Plot.Frameless(System.Boolean)">
  3433. <summary>
  3434. Give the plot a frameless appearance by hiding all axes.
  3435. Axes are hidden by making them invisible and setting their size to zero.
  3436. This causes the data area to go right up to the edge of the plot.
  3437. </summary>
  3438. </member>
  3439. <member name="M:ScottPlot.Plot.Frame(System.Boolean)">
  3440. <summary>
  3441. Control visibility of axes.
  3442. </summary>
  3443. </member>
  3444. <member name="M:ScottPlot.Plot.Grid(System.Nullable{System.Boolean},System.Nullable{System.Drawing.Color},System.Nullable{ScottPlot.LineStyle})">
  3445. <summary>
  3446. Customize basic options for the primary X and Y axes.
  3447. Call XAxis.Grid() and YAxis.Grid() to further customize grid settings.
  3448. </summary>
  3449. <param name="enable">sets visibility of X and Y grid lines</param>
  3450. <param name="color">sets color of of X and Y grid lines</param>
  3451. <param name="lineStyle">defines the style for X and Y grid lines</param>
  3452. </member>
  3453. <member name="M:ScottPlot.Plot.Layout(System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Single})">
  3454. <summary>
  3455. Set padding around the data area by defining the minimum size and padding for all axes
  3456. </summary>
  3457. <param name="left">YAxis size (in pixels) that defines the area to the left of the plot</param>
  3458. <param name="right">YAxis2 size (in pixels) that defines the area to the right of the plot</param>
  3459. <param name="bottom">XAxis size (in pixels) that defines the area to the bottom of the plot</param>
  3460. <param name="top">XAxis2 size (in pixels) that defines the area to the top of the plot</param>
  3461. <param name="padding">Customize the default padding between axes and the edge of the plot</param>
  3462. </member>
  3463. <member name="M:ScottPlot.Plot.MatchLayout(ScottPlot.Plot,System.Boolean,System.Boolean)">
  3464. <summary>
  3465. Adjust this axis layout based on the layout of a source plot
  3466. </summary>
  3467. <param name="sourcePlot">plot to use for layout reference</param>
  3468. <param name="horizontal">if true, horizontal layout will be matched</param>
  3469. <param name="vertical">if true, vertical layout will be matched</param>
  3470. </member>
  3471. <member name="M:ScottPlot.Plot.MatchAxis(ScottPlot.Plot,System.Boolean,System.Boolean)">
  3472. <summary>
  3473. Get the axis limits for the given plot and apply them to this plot
  3474. </summary>
  3475. </member>
  3476. <member name="M:ScottPlot.Plot.XTicks(System.String[])">
  3477. <summary>
  3478. Manually define X axis tick labels using consecutive integer positions (0, 1, 2, etc.)
  3479. </summary>
  3480. <param name="labels">new tick labels for the X axis</param>
  3481. </member>
  3482. <member name="M:ScottPlot.Plot.XTicks(System.Double[],System.String[])">
  3483. <summary>
  3484. Manually define X axis tick positions and labels
  3485. </summary>
  3486. <param name="positions">positions on the X axis</param>
  3487. <param name="labels">new tick labels for the X axis</param>
  3488. </member>
  3489. <member name="M:ScottPlot.Plot.YTicks(System.String[])">
  3490. <summary>
  3491. Manually define Y axis tick labels using consecutive integer positions (0, 1, 2, etc.)
  3492. </summary>
  3493. <param name="labels">new tick labels for the Y axis</param>
  3494. </member>
  3495. <member name="M:ScottPlot.Plot.YTicks(System.Double[],System.String[])">
  3496. <summary>
  3497. Manually define Y axis tick positions and labels
  3498. </summary>
  3499. <param name="positions">positions on the Y axis</param>
  3500. <param name="labels">new tick labels for the Y axis</param>
  3501. </member>
  3502. <member name="M:ScottPlot.Plot.SetCulture(System.Globalization.CultureInfo)">
  3503. <summary>
  3504. Set the culture to use for number-to-string converstion for tick labels of all axes.
  3505. </summary>
  3506. <param name="culture">standard culture</param>
  3507. </member>
  3508. <member name="M:ScottPlot.Plot.SetCulture(System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Int32[])">
  3509. <summary>
  3510. Set the culture to use for number-to-string converstion for tick labels of all axes.
  3511. This overload allows you to manually define every format string,
  3512. allowing extensive customization of number and date formatting.
  3513. </summary>
  3514. <param name="shortDatePattern"></param>
  3515. <param name="decimalSeparator">Separates the decimal digits</param>
  3516. <param name="numberGroupSeparator">Separates large numbers ito groups of digits for readability</param>
  3517. <param name="decimalDigits">Number of digits after the numberDecimalSeparator</param>
  3518. <param name="numberNegativePattern">Appearance of negative numbers</param>
  3519. <param name="numberGroupSizes">Sizes of decimal groups which are separated by the numberGroupSeparator</param>
  3520. </member>
  3521. <member name="M:ScottPlot.Plot.AddAxis(ScottPlot.Renderable.Edge,System.Int32,System.String,System.Nullable{System.Drawing.Color})">
  3522. <summary>
  3523. Create and return an additional axis
  3524. </summary>
  3525. <param name="edge">Edge of the plot the new axis will belong to</param>
  3526. <param name="axisIndex">Only plottables with the same axis index will use this axis</param>
  3527. <param name="title">defualt label to use for the axis</param>
  3528. <param name="color">defualt color to use for the axis</param>
  3529. <returns>The axis that was just created and added to the plot. You can further customize it by interacting with it.</returns>
  3530. </member>
  3531. <member name="M:ScottPlot.Plot.RemoveAxis(ScottPlot.Renderable.Axis)">
  3532. <summary>
  3533. Remove the a specific axis from the plot
  3534. </summary>
  3535. </member>
  3536. <member name="M:ScottPlot.Plot.GetCoordinate(System.Single,System.Single)">
  3537. <summary>
  3538. Return the coordinate (in coordinate space) for the given pixel
  3539. </summary>
  3540. <param name="xPixel">horizontal pixel location</param>
  3541. <param name="yPixel">vertical pixel location</param>
  3542. <returns>point in coordinate space</returns>
  3543. </member>
  3544. <member name="M:ScottPlot.Plot.GetCoordinateX(System.Single)">
  3545. <summary>
  3546. Return the X position (in coordinate space) for the given pixel column
  3547. </summary>
  3548. <param name="xPixel">horizontal pixel location</param>
  3549. <returns>horizontal position in coordinate space</returns>
  3550. </member>
  3551. <member name="M:ScottPlot.Plot.GetCoordinateY(System.Single)">
  3552. <summary>
  3553. Return the Y position (in coordinate space) for the given pixel row
  3554. </summary>
  3555. <param name="yPixel">vertical pixel location</param>
  3556. <returns>vertical position in coordinate space</returns>
  3557. </member>
  3558. <member name="M:ScottPlot.Plot.GetPixel(System.Double,System.Double)">
  3559. <summary>
  3560. Return the pixel for the given point in coordinate space
  3561. </summary>
  3562. <param name="x">horizontal coordinate</param>
  3563. <param name="y">vertical coordinate</param>
  3564. <returns>pixel location</returns>
  3565. </member>
  3566. <member name="M:ScottPlot.Plot.GetPixelX(System.Double)">
  3567. <summary>
  3568. Return the horizontal pixel location given position in coordinate space
  3569. </summary>
  3570. <param name="x">horizontal coordinate</param>
  3571. <returns>horizontal pixel position</returns>
  3572. </member>
  3573. <member name="M:ScottPlot.Plot.GetPixelY(System.Double)">
  3574. <summary>
  3575. Return the vertical pixel location given position in coordinate space
  3576. </summary>
  3577. <param name="y">vertical coordinate</param>
  3578. <returns>vertical pixel position</returns>
  3579. </member>
  3580. <member name="M:ScottPlot.Plot.GetDataLimits(System.Int32,System.Int32)">
  3581. <summary>
  3582. Return the limits of the data contained by this plot (regardless of the axis limits).
  3583. WARNING: This method iterates all data points in the plot and may be slow for large datasets.
  3584. </summary>
  3585. </member>
  3586. <member name="M:ScottPlot.Plot.GetAxisLimits(System.Int32,System.Int32)">
  3587. <summary>
  3588. Returns the current limits for a given pair of axes.
  3589. </summary>
  3590. <param name="xAxisIndex">which axis index to reference</param>
  3591. <param name="yAxisIndex">which axis index to reference</param>
  3592. <returns>current limits</returns>
  3593. </member>
  3594. <member name="M:ScottPlot.Plot.SetAxisLimits(System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.Int32,System.Int32)">
  3595. <summary>
  3596. Set limits for the a given pair of axes
  3597. </summary>
  3598. <param name="xMin">lower limit of the horizontal axis</param>
  3599. <param name="xMax">upper limit of the horizontal axis</param>
  3600. <param name="yMin">lower limit of the vertical axis</param>
  3601. <param name="yMax">upper limit of the vertical axis</param>
  3602. <param name="xAxisIndex">index of the axis the horizontal limits apply to</param>
  3603. <param name="yAxisIndex">index of the axis the vertical limits apply to</param>
  3604. </member>
  3605. <member name="M:ScottPlot.Plot.SetAxisLimitsX(System.Double,System.Double)">
  3606. <summary>
  3607. Set limits for the primary X axis
  3608. </summary>
  3609. <param name="xMin">lower limit of the horizontal axis</param>
  3610. <param name="xMax">upper limit of the horizontal axis</param>
  3611. </member>
  3612. <member name="M:ScottPlot.Plot.SetAxisLimitsY(System.Double,System.Double)">
  3613. <summary>
  3614. Set limits for the primary Y axis
  3615. </summary>
  3616. <param name="yMin">lower limit of the vertical axis</param>
  3617. <param name="yMax">upper limit of the vertical axis</param>
  3618. </member>
  3619. <member name="M:ScottPlot.Plot.SetAxisLimits(ScottPlot.AxisLimits,System.Int32,System.Int32)">
  3620. <summary>
  3621. Set limits for a pair of axes
  3622. </summary>
  3623. <param name="limits">new limits</param>
  3624. <param name="xAxisIndex">index of the axis the horizontal limits apply to</param>
  3625. <param name="yAxisIndex">index of the axis the vertical limits apply to</param>
  3626. </member>
  3627. <member name="M:ScottPlot.Plot.SetViewLimits(System.Double,System.Double,System.Double,System.Double)">
  3628. <summary>
  3629. Set maximum outer limits beyond which the plot cannot be zoomed-out or panned.
  3630. </summary>
  3631. </member>
  3632. <member name="M:ScottPlot.Plot.SetOuterViewLimits(System.Double,System.Double,System.Double,System.Double,System.Int32,System.Int32)">
  3633. <summary>
  3634. Set maximum outer limits beyond which the plot cannot be zoomed-out or panned.
  3635. </summary>
  3636. </member>
  3637. <member name="M:ScottPlot.Plot.SetInnerViewLimits(System.Double,System.Double,System.Double,System.Double,System.Int32,System.Int32)">
  3638. <summary>
  3639. Set minimum innter limits which will always be visible on the plot.
  3640. </summary>
  3641. </member>
  3642. <member name="M:ScottPlot.Plot.Margins(System.Nullable{System.Double},System.Nullable{System.Double})">
  3643. <summary>
  3644. Auto-scale the axis limits to fit the data. This function is an alias for AxisAuto().
  3645. </summary>
  3646. <param name="x">horizontal margin in the range [0, 1]</param>
  3647. <param name="y">vertical margin in the range [0, 1]</param>
  3648. <returns>Current default margins for automatic axis scaling</returns>
  3649. </member>
  3650. <member name="M:ScottPlot.Plot.Margins(System.Nullable{System.Double},System.Nullable{System.Double},System.Int32,System.Int32)">
  3651. <summary>
  3652. Auto-scale the axis limits to fit the data. This function is an alias for AxisAuto().
  3653. This overload is for multi-axis plots (plots with multiple X and Y axes) and will only adjust the specified axes.
  3654. </summary>
  3655. <param name="x">horizontal margin in the range [0, 1]</param>
  3656. <param name="y">vertical margin in the range [0, 1]</param>
  3657. <param name="xAxisIndex">Only adjust the specified axis (for plots with multiple X axes)</param>
  3658. <param name="yAxisIndex">Only adjust the specified axis (for plots with multiple Y axes)</param>
  3659. <returns>Current default margins for automatic axis scaling</returns>
  3660. </member>
  3661. <member name="M:ScottPlot.Plot.AxisAuto(System.Nullable{System.Double},System.Nullable{System.Double})">
  3662. <summary>
  3663. Automatically set axis limits to fit the data.
  3664. </summary>
  3665. <param name="horizontalMargin">Extra space (fraction) to add to the left and right of the limits of the data (typically 0.05)</param>
  3666. <param name="verticalMargin">Extra space (fraction) to add above and below the limits of the data (typically 0.1)</param>
  3667. </member>
  3668. <member name="M:ScottPlot.Plot.AxisAuto(System.Nullable{System.Double},System.Nullable{System.Double},System.Int32,System.Int32)">
  3669. <summary>
  3670. Automatically set axis limits to fit the data.
  3671. This overload is designed for multi-axis plots (with multiple X axes or multiple Y axes).
  3672. </summary>
  3673. <param name="horizontalMargin">Extra space (fraction) to add to the left and right of the limits of the data (typically 0.05)</param>
  3674. <param name="verticalMargin">Extra space (fraction) to add above and below the limits of the data (typically 0.1)</param>
  3675. <param name="xAxisIndex">Only adjust the specified axis (for plots with multiple X axes)</param>
  3676. <param name="yAxisIndex">Only adjust the specified axis (for plots with multiple Y axes)</param>
  3677. </member>
  3678. <member name="M:ScottPlot.Plot.AxisAutoX(System.Nullable{System.Double},System.Int32)">
  3679. <summary>
  3680. Automatically adjust axis limits to fit the data
  3681. </summary>
  3682. <param name="margin">amount of space to the left and right of the data (typically 0.05)</param>
  3683. <param name="xAxisIndex">Only adjust the specified axis (for plots with multiple X axes)</param>
  3684. </member>
  3685. <member name="M:ScottPlot.Plot.AxisAutoY(System.Nullable{System.Double},System.Int32)">
  3686. <summary>
  3687. Automatically adjust axis limits to fit the data (with a little extra margin)
  3688. </summary>
  3689. <param name="margin">amount of space above and below the data (as a fraction of its height)</param>
  3690. <param name="yAxisIndex">Only adjust the specified axis (for plots with multiple Y axes)</param>
  3691. </member>
  3692. <member name="M:ScottPlot.Plot.AxisScale(System.Nullable{System.Double},System.Nullable{System.Double})">
  3693. <summary>
  3694. Adjust axis limits to achieve a certain pixel scale (units per pixel)
  3695. </summary>
  3696. <param name="unitsPerPixelX">zoom so 1 pixel equals this many horizontal units in coordinate space</param>
  3697. <param name="unitsPerPixelY">zoom so 1 pixel equals this many vertical units in coordinate space</param>
  3698. </member>
  3699. <member name="M:ScottPlot.Plot.AxisScaleLock(System.Boolean,ScottPlot.EqualScaleMode)">
  3700. <summary>
  3701. Lock X and Y axis scales (units per pixel) together to protect symmetry of circles and squares
  3702. </summary>
  3703. <param name="enable">if true, scales are locked such that zooming one zooms the other</param>
  3704. <param name="scaleMode">defines behavior for how to adjust axis limits to achieve equal scales</param>
  3705. </member>
  3706. <member name="M:ScottPlot.Plot.AxisZoom(System.Double,System.Double,System.Nullable{System.Double},System.Nullable{System.Double},System.Int32,System.Int32)">
  3707. <summary>
  3708. Zoom in or out. The amount of zoom is defined as a fraction of the current axis span.
  3709. </summary>
  3710. <param name="xFrac">horizontal zoom (>1 means zoom in)</param>
  3711. <param name="yFrac">vertical zoom (>1 means zoom in)</param>
  3712. <param name="zoomToX">if defined, zoom will be centered at this point</param>
  3713. <param name="zoomToY">if defined, zoom will be centered at this point</param>
  3714. <param name="xAxisIndex">index of the axis to zoom</param>
  3715. <param name="yAxisIndex">index of the axis to zoom</param>
  3716. </member>
  3717. <member name="M:ScottPlot.Plot.AxisPan(System.Double,System.Double)">
  3718. <summary>
  3719. Pan the primary X and Y axis without affecting zoom
  3720. </summary>
  3721. <param name="dx">horizontal distance to pan (in coordinate units)</param>
  3722. <param name="dy">vertical distance to pan (in coordinate units)</param>
  3723. </member>
  3724. <member name="F:ScottPlot.Plot.settings">
  3725. <summary>
  3726. The settings object stores all state (configuration and data) for a plot
  3727. </summary>
  3728. </member>
  3729. <member name="P:ScottPlot.Plot.Width">
  3730. <summary>
  3731. Plot image width (pixels)
  3732. </summary>
  3733. </member>
  3734. <member name="P:ScottPlot.Plot.Height">
  3735. <summary>
  3736. Plot image height (pixels)
  3737. </summary>
  3738. </member>
  3739. <member name="M:ScottPlot.Plot.#ctor(System.Int32,System.Int32)">
  3740. <summary>
  3741. A ScottPlot stores data in plottable objects and draws it on a bitmap when Render() is called
  3742. </summary>
  3743. <param name="width">default width (pixels) to use when rendering</param>
  3744. <param name="height">default height (pixels) to use when rendering</param>
  3745. </member>
  3746. <member name="M:ScottPlot.Plot.ToString">
  3747. <summary>
  3748. Brief description of this plot
  3749. </summary>
  3750. <returns>plot description</returns>
  3751. </member>
  3752. <member name="P:ScottPlot.Plot.Version">
  3753. <summary>
  3754. ScottPlot version in the format "1.2.3" (or "1.2.3-beta" for pre-releases)
  3755. </summary>
  3756. </member>
  3757. <member name="M:ScottPlot.Plot.Add(ScottPlot.Plottable.IPlottable)">
  3758. <summary>
  3759. Add a plottable to the plot
  3760. </summary>
  3761. <param name="plottable">a plottable the user created</param>
  3762. </member>
  3763. <member name="M:ScottPlot.Plot.Clear">
  3764. <summary>
  3765. Clear all plottables
  3766. </summary>
  3767. </member>
  3768. <member name="M:ScottPlot.Plot.Clear(System.Type)">
  3769. <summary>
  3770. Remove all plottables of the given type
  3771. </summary>
  3772. <param name="plottableType">all plottables of this type will be removed</param>
  3773. </member>
  3774. <member name="M:ScottPlot.Plot.Remove(ScottPlot.Plottable.IPlottable)">
  3775. <summary>
  3776. Remove a specific plottable
  3777. </summary>
  3778. <param name="plottable">The plottable to remove</param>
  3779. </member>
  3780. <member name="M:ScottPlot.Plot.RemoveAt(System.Int32)">
  3781. <summary>
  3782. Remove the plottable at the specified index of the list
  3783. </summary>
  3784. <param name="index">The zero-based index of the element to remove</param>
  3785. </member>
  3786. <member name="M:ScottPlot.Plot.Move(System.Int32,System.Int32)">
  3787. <summary>
  3788. Move a plottable in the list. Plottables near the end are rendered last (on top).
  3789. </summary>
  3790. </member>
  3791. <member name="M:ScottPlot.Plot.MoveFirst(ScottPlot.Plottable.IPlottable)">
  3792. <summary>
  3793. Move a plottable to the front so it is rendered first and appears beneath all others.
  3794. </summary>
  3795. </member>
  3796. <member name="M:ScottPlot.Plot.MoveLast(ScottPlot.Plottable.IPlottable)">
  3797. <summary>
  3798. Move a plottable to the end so it is rendered last and appears above all others.
  3799. </summary>
  3800. </member>
  3801. <member name="M:ScottPlot.Plot.GetPlottables">
  3802. <summary>
  3803. Return a copy of the list of plottables
  3804. </summary>
  3805. <returns>list of plottables</returns>
  3806. </member>
  3807. <member name="M:ScottPlot.Plot.Validate(System.Boolean)">
  3808. <summary>
  3809. Throw an exception if any plottable contains an invalid state.
  3810. </summary>
  3811. <param name="deep">Check every individual value for validity. This is more thorough, but slower.</param>
  3812. </member>
  3813. <member name="M:ScottPlot.Plot.GetSettings(System.Boolean)">
  3814. <summary>
  3815. The Settings module stores manages plot state and advanced configuration.
  3816. Its class structure changes frequently, and users are highly advised not to interact with it directly.
  3817. This method returns the settings module for advanced users and developers to interact with.
  3818. </summary>
  3819. <param name="showWarning">Show a warning message indicating this method is only intended for developers</param>
  3820. <returns>Settings used by the plot</returns>
  3821. </member>
  3822. <member name="M:ScottPlot.Plot.Resize(System.Single,System.Single)">
  3823. <summary>
  3824. Update the default size for new renders
  3825. </summary>
  3826. <param name="width">width (pixels) for future renders</param>
  3827. <param name="height">height (pixels) for future renders</param>
  3828. </member>
  3829. <member name="M:ScottPlot.Plot.GetNextColor(System.Double)">
  3830. <summary>
  3831. Return a new color from the Pallette based on the number of plottables already in the plot.
  3832. Use this to ensure every plottable gets a unique color.
  3833. </summary>
  3834. <param name="alpha">value from 0 (transparent) to 1 (opaque)</param>
  3835. <returns>new color</returns>
  3836. </member>
  3837. <member name="P:ScottPlot.Plot.Palette">
  3838. <summary>
  3839. The palette defines default colors to use for new plottables.
  3840. </summary>
  3841. </member>
  3842. <member name="M:ScottPlot.Plot.Style(ScottPlot.Styles.IStyle)">
  3843. <summary>
  3844. Set the colors and fonts of many plot components at once using a predefined theme
  3845. </summary>
  3846. </member>
  3847. <member name="M:ScottPlot.Plot.Style(System.Nullable{System.Drawing.Color},System.Nullable{System.Drawing.Color},System.Nullable{System.Drawing.Color},System.Nullable{System.Drawing.Color},System.Nullable{System.Drawing.Color},System.Nullable{System.Drawing.Color})">
  3848. <summary>
  3849. Set the color of specific plot components
  3850. </summary>
  3851. <param name="figureBackground">Color for area beneath the axis ticks and labels and around the data area</param>
  3852. <param name="dataBackground">Color for area inside the data frame but beneath the grid and plottables</param>
  3853. <param name="grid">Color for grid lines</param>
  3854. <param name="tick">Color for axis tick marks and frame lines</param>
  3855. <param name="axisLabel">Color for axis labels and tick labels</param>
  3856. <param name="titleLabel">Color for the top axis label (XAxis2's title)</param>
  3857. </member>
  3858. <member name="M:ScottPlot.Plot.Benchmark(System.Nullable{System.Boolean})">
  3859. <summary>
  3860. If enabled, the benchmark displays render information in the corner of the plot.
  3861. </summary>
  3862. <param name="enable">True/false defines whether benchmark is enabled. Null will not change the benchmark.</param>
  3863. <returns>true if the benchmark is enabled</returns>
  3864. </member>
  3865. <member name="M:ScottPlot.Plot.BenchmarkTimes">
  3866. <summary>
  3867. Return an array of times for the last several renders.
  3868. The last element of the array is the most recently rendered frame time.
  3869. </summary>
  3870. </member>
  3871. <member name="M:ScottPlot.Plot.Legend(System.Boolean,ScottPlot.Alignment)">
  3872. <summary>
  3873. Configure legend visibility and location.
  3874. Optionally you can further customize the legend by interacting with the object it returns.
  3875. </summary>
  3876. <param name="enable">whether or not the legend is visible</param>
  3877. <param name="location">position of the legend relative to the data area</param>
  3878. <returns>The legend itself. Use public fields to further customize its appearance and behavior.</returns>
  3879. </member>
  3880. <member name="M:ScottPlot.Plot.Copy">
  3881. <summary>
  3882. Return a new Plot with all the same Plottables (and some of the styles) of this one.
  3883. </summary>
  3884. <returns>A new plot similar to this one.</returns>
  3885. </member>
  3886. <member name="F:ScottPlot.Plot.Guid">
  3887. <summary>
  3888. The GUID helps identify individual plots
  3889. </summary>
  3890. </member>
  3891. <member name="M:ScottPlot.Plot.GetGuid">
  3892. <summary>
  3893. Every plot has a globally unique ID (GUID) that can help differentiate it from other plots
  3894. </summary>
  3895. <returns>A string representing the GUID</returns>
  3896. </member>
  3897. <member name="M:ScottPlot.Plot.Equals(System.Object)">
  3898. <summary>
  3899. Returns true if the given plot is the exact same plot as this one
  3900. </summary>
  3901. <param name="obj">the plot to compare this one to</param>
  3902. <returns>true if the two plots have the same GUID</returns>
  3903. </member>
  3904. <member name="M:ScottPlot.Plot.GetHashCode">
  3905. <summary>
  3906. Returns an integer unique to this instance (based on the GUID)
  3907. </summary>
  3908. <returns>An integer representing the GUID</returns>
  3909. </member>
  3910. <member name="M:ScottPlot.Plot.PlotBarGroups(System.String[],System.String[],System.Double[][],System.Double[][],System.Double,System.Double,System.Double,System.Boolean)">
  3911. <summary>
  3912. Create a series of bar plots given a 2D dataset
  3913. </summary>
  3914. </member>
  3915. <member name="M:ScottPlot.Plot.Render(System.Drawing.Bitmap,System.Boolean,System.Double)">
  3916. <summary>
  3917. Render the plot onto an existing bitmap
  3918. </summary>
  3919. <param name="bmp">an existing bitmap to render onto</param>
  3920. <param name="lowQuality"></param>
  3921. <param name="scale">scale the size of the output image by this fraction (without resizing the plot)</param>
  3922. <returns>the same bitmap that was passed in (but was rendered onto)</returns>
  3923. </member>
  3924. <member name="M:ScottPlot.Plot.RenderLock">
  3925. <summary>
  3926. Wait for the current render to finish, then prevent future renders until RenderUnlock() is called.
  3927. Locking rendering is required if you intend to modify plottables while rendering is occurring in another thread.
  3928. </summary>
  3929. </member>
  3930. <member name="M:ScottPlot.Plot.RenderUnlock">
  3931. <summary>
  3932. Release the render lock, allowing renders to proceed.
  3933. </summary>
  3934. </member>
  3935. <member name="M:ScottPlot.Plot.Render(System.Boolean)">
  3936. <summary>
  3937. Render the plot onto a new Bitmap (using the size given when the plot was created or resized)
  3938. </summary>
  3939. <param name="lowQuality">if true, anti-aliasing will be disabled for this render</param>
  3940. <returns>the Bitmap that was created</returns>
  3941. </member>
  3942. <member name="M:ScottPlot.Plot.Render(System.Int32,System.Int32,System.Boolean,System.Double)">
  3943. <summary>
  3944. Render the plot onto a new Bitmap of the given dimensions
  3945. </summary>
  3946. <param name="width">resize the plot to this width (pixels) before rendering</param>
  3947. <param name="height">resize the plot to this height (pixels) before rendering</param>
  3948. <param name="lowQuality">if true, anti-aliasing will be disabled for this render</param>
  3949. <param name="scale">scale the size of the output image by this fraction (without resizing the plot)</param>
  3950. <returns>the Bitmap that was created</returns>
  3951. </member>
  3952. <member name="M:ScottPlot.Plot.GetBitmap(System.Boolean,System.Double)">
  3953. <summary>
  3954. Create a new Bitmap, render the plot onto it, and return it
  3955. </summary>
  3956. </member>
  3957. <member name="M:ScottPlot.Plot.GetImageBytes(System.Boolean,System.Double)">
  3958. <summary>
  3959. Render the plot and return the bytes for a PNG file.
  3960. This method is useful for rendering in stateless cloud environments that do not use a traditional filesystem.
  3961. </summary>
  3962. <returns></returns>
  3963. </member>
  3964. <member name="M:ScottPlot.Plot.RenderLegend(System.Boolean,System.Double)">
  3965. <summary>
  3966. Return a new Bitmap containing only the legend
  3967. </summary>
  3968. <returns>new bitmap containing the legend</returns>
  3969. </member>
  3970. <member name="M:ScottPlot.Plot.SaveFig(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Double)">
  3971. <summary>
  3972. Save the plot as an image
  3973. </summary>
  3974. <param name="filePath">file path for the images (existing files will be overwritten)</param>
  3975. <param name="width">resize the plot to this width (pixels) before rendering</param>
  3976. <param name="height">resize the plot to this height (pixels) before rendering</param>
  3977. <param name="lowQuality">if true, anti-aliasing will be disabled for this render. Default false</param>
  3978. <param name="scale">scale the size of the output image by this fraction (without resizing the plot)</param>
  3979. <returns>Full path for the image that was saved</returns>
  3980. </member>
  3981. <member name="F:ScottPlot.Renderable.ArrowStyle.Anchor">
  3982. <summary>
  3983. Describes which part of the vector line will be placed at the data coordinates.
  3984. </summary>
  3985. </member>
  3986. <member name="F:ScottPlot.Renderable.ArrowStyle.ScaledArrowheads">
  3987. <summary>
  3988. If enabled arrowheads will be drawn as lines scaled to each vector's magnitude.
  3989. </summary>
  3990. </member>
  3991. <member name="F:ScottPlot.Renderable.ArrowStyle.ScaledArrowheadWidth">
  3992. <summary>
  3993. When using scaled arrowheads this defines the width of the arrow relative to the vector line's length.
  3994. </summary>
  3995. </member>
  3996. <member name="F:ScottPlot.Renderable.ArrowStyle.ScaledArrowheadLength">
  3997. <summary>
  3998. When using scaled arrowheads this defines length of the arrowhead relative to the vector line's length.
  3999. </summary>
  4000. </member>
  4001. <member name="F:ScottPlot.Renderable.ArrowStyle.NonScaledArrowheadWidth">
  4002. <summary>
  4003. Size of the arrowhead if custom/scaled arrowheads are not in use
  4004. </summary>
  4005. </member>
  4006. <member name="F:ScottPlot.Renderable.ArrowStyle.NonScaledArrowheadLength">
  4007. <summary>
  4008. Size of the arrowhead if custom/scaled arrowheads are not in use
  4009. </summary>
  4010. </member>
  4011. <member name="F:ScottPlot.Renderable.ArrowStyle.MarkerShape">
  4012. <summary>
  4013. Marker drawn at each coordinate
  4014. </summary>
  4015. </member>
  4016. <member name="F:ScottPlot.Renderable.ArrowStyle.MarkerSize">
  4017. <summary>
  4018. Size of markers to be drawn at each coordinate
  4019. </summary>
  4020. </member>
  4021. <member name="M:ScottPlot.Renderable.ArrowStyle.Render(ScottPlot.PlotDimensions,System.Drawing.Graphics,System.Double[],System.Double[],ScottPlot.Statistics.Vector2[0:,0:],System.Drawing.Color[])">
  4022. <summary>
  4023. Render an evenly-spaced 2D vector field.
  4024. </summary>
  4025. </member>
  4026. <member name="T:ScottPlot.Renderable.Axis">
  4027. <summary>
  4028. An Axis stores dimensions (axis limits and pixel/unit conversion methods) and can render
  4029. itself including axis label, tick marks, tick labels, and grid lines
  4030. </summary>
  4031. </member>
  4032. <member name="F:ScottPlot.Renderable.Axis.Dims">
  4033. <summary>
  4034. Axis dimensions and methods for pixel/unit conversions
  4035. </summary>
  4036. </member>
  4037. <member name="F:ScottPlot.Renderable.Axis.AxisIndex">
  4038. <summary>
  4039. Plottables with this axis index will use pixel/unit conversions from this axis
  4040. </summary>
  4041. </member>
  4042. <member name="M:ScottPlot.Renderable.Axis.GetSettings(System.Boolean)">
  4043. <summary>
  4044. Return configuration objects to allow deep customization of axis settings.
  4045. WARNING: This API may not be stable across future versions.
  4046. </summary>
  4047. </member>
  4048. <member name="M:ScottPlot.Renderable.Axis.SetSizeLimit(System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Single})">
  4049. <summary>
  4050. Define the minimum and maximum limits for the pixel size of this axis
  4051. </summary>
  4052. </member>
  4053. <member name="M:ScottPlot.Renderable.Axis.SetSizeLimit(System.Single)">
  4054. <summary>
  4055. Size this axis to an exact number of pixels
  4056. </summary>
  4057. </member>
  4058. <member name="M:ScottPlot.Renderable.Axis.SetOffset(System.Single)">
  4059. <summary>
  4060. Define how many pixels away from the data area this axis will be.
  4061. TightenLayout() populates this value (based on other PixelSize values) to stack axes beside each other.
  4062. </summary>
  4063. </member>
  4064. <member name="M:ScottPlot.Renderable.Axis.GetSize">
  4065. <summary>
  4066. Returns the number of pixels occupied by this axis
  4067. </summary>
  4068. </member>
  4069. <member name="M:ScottPlot.Renderable.Axis.RecalculateTickPositions(ScottPlot.PlotDimensions)">
  4070. <summary>
  4071. Use the latest configuration (size, font settings, axis limits) to determine tick mark positions
  4072. </summary>
  4073. </member>
  4074. <member name="M:ScottPlot.Renderable.Axis.Render(ScottPlot.PlotDimensions,System.Drawing.Bitmap,System.Boolean)">
  4075. <summary>
  4076. Render all components of this axis onto the given Bitmap
  4077. </summary>
  4078. </member>
  4079. <member name="M:ScottPlot.Renderable.Axis.DateTimeFormat(System.Boolean)">
  4080. <summary>
  4081. DateTime format assumes axis represents DateTime.ToOATime() units and displays tick labels accordingly.
  4082. </summary>
  4083. </member>
  4084. <member name="M:ScottPlot.Renderable.Axis.Label(System.String,System.Nullable{System.Drawing.Color},System.Nullable{System.Single},System.Nullable{System.Boolean},System.String)">
  4085. <summary>
  4086. Configure the label of this axis
  4087. </summary>
  4088. </member>
  4089. <member name="M:ScottPlot.Renderable.Axis.ImageLabel(System.Drawing.Bitmap,System.Single,System.Single)">
  4090. <summary>
  4091. Display a custom image as the axis label instead of text
  4092. </summary>
  4093. <param name="img">The image to display where the label should go</param>
  4094. <param name="padInside">pixels of padding between the inner image edge and the data area</param>
  4095. <param name="padOutside">pixels of padding between the outer image edge and the figure edge</param>
  4096. </member>
  4097. <member name="M:ScottPlot.Renderable.Axis.Color(System.Drawing.Color)">
  4098. <summary>
  4099. Set color of every component of this axis (label, line, tick marks, and tick labels)
  4100. </summary>
  4101. </member>
  4102. <member name="M:ScottPlot.Renderable.Axis.TickLabelFormat(System.Func{System.Double,System.String})">
  4103. <summary>
  4104. Use a custom function to generate tick label strings
  4105. </summary>
  4106. </member>
  4107. <member name="M:ScottPlot.Renderable.Axis.TickLabelFormat(System.String,System.Boolean)">
  4108. <summary>
  4109. Manually define the string format to use for translating tick positions to tick labels
  4110. </summary>
  4111. </member>
  4112. <member name="M:ScottPlot.Renderable.Axis.TickLabelNotation(System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.String)">
  4113. <summary>
  4114. Customize string settings for the tick labels
  4115. </summary>
  4116. </member>
  4117. <member name="M:ScottPlot.Renderable.Axis.ManualTickSpacing(System.Double)">
  4118. <summary>
  4119. Define a manual spacing between major ticks (and major grid lines)
  4120. </summary>
  4121. </member>
  4122. <member name="M:ScottPlot.Renderable.Axis.ManualTickSpacing(System.Double,ScottPlot.Ticks.DateTimeUnit)">
  4123. <summary>
  4124. Define a manual spacing between major ticks (and major grid lines) for axes configured to display using DateTime format
  4125. </summary>
  4126. </member>
  4127. <member name="M:ScottPlot.Renderable.Axis.ManualTickPositions(System.Double[],System.String[])">
  4128. <summary>
  4129. Manually define major tick (and grid) positions and labels
  4130. </summary>
  4131. </member>
  4132. <member name="M:ScottPlot.Renderable.Axis.RulerMode(System.Boolean)">
  4133. <summary>
  4134. Ruler mode draws long tick marks and offsets tick labels for a ruler appearance
  4135. </summary>
  4136. </member>
  4137. <member name="M:ScottPlot.Renderable.Axis.PixelSnap(System.Boolean)">
  4138. <summary>
  4139. Enable this to snap major ticks (and grid lines) to the nearest pixel to avoid anti-aliasing artifacts
  4140. </summary>
  4141. <param name="enable"></param>
  4142. </member>
  4143. <member name="M:ScottPlot.Renderable.Axis.TickMarkColor(System.Drawing.Color)">
  4144. <summary>
  4145. Apply the same color to major and minor tick marks
  4146. </summary>
  4147. </member>
  4148. <member name="M:ScottPlot.Renderable.Axis.TickMarkColor(System.Drawing.Color,System.Drawing.Color)">
  4149. <summary>
  4150. Set colors for major and minor tick marks
  4151. </summary>
  4152. </member>
  4153. <member name="M:ScottPlot.Renderable.Axis.TickMarkDirection(System.Boolean)">
  4154. <summary>
  4155. Control whether tick marks point outward or inward
  4156. </summary>
  4157. </member>
  4158. <member name="M:ScottPlot.Renderable.Axis.SetCulture(System.Globalization.CultureInfo)">
  4159. <summary>
  4160. Set the culture to use for unit-to-string tick mark conversion
  4161. </summary>
  4162. </member>
  4163. <member name="M:ScottPlot.Renderable.Axis.SetCulture(System.String,System.String,System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Int32[])">
  4164. <summary>
  4165. Manually define culture to use for unit-to-string tick mark conversion
  4166. </summary>
  4167. </member>
  4168. <member name="M:ScottPlot.Renderable.Axis.TickLabelStyle(System.Nullable{System.Drawing.Color},System.String,System.Nullable{System.Single},System.Nullable{System.Boolean},System.Nullable{System.Single})">
  4169. <summary>
  4170. Customize styling of the tick labels
  4171. </summary>
  4172. </member>
  4173. <member name="M:ScottPlot.Renderable.Axis.LabelStyle(System.Nullable{System.Drawing.Color},System.String,System.Nullable{System.Single})">
  4174. <summary>
  4175. Customize styling of the label (without changing its content)
  4176. </summary>
  4177. </member>
  4178. <member name="M:ScottPlot.Renderable.Axis.Ticks(System.Boolean)">
  4179. <summary>
  4180. Set visibility of all ticks
  4181. </summary>
  4182. </member>
  4183. <member name="M:ScottPlot.Renderable.Axis.Ticks(System.Boolean,System.Boolean,System.Boolean)">
  4184. <summary>
  4185. Set visibility of individual tick components
  4186. </summary>
  4187. </member>
  4188. <member name="M:ScottPlot.Renderable.Axis.TickDensity(System.Double)">
  4189. <summary>
  4190. This value defines the packing density of tick labels.
  4191. A density of 1.0 means labels fit tightly based on measured maximum label size.
  4192. Higher densities place more ticks but tick labels may oberlap.
  4193. </summary>
  4194. </member>
  4195. <member name="M:ScottPlot.Renderable.Axis.MinimumTickSpacing(System.Double)">
  4196. <summary>
  4197. Define the smallest distance between major ticks, grid lines, and tick labels in coordinate units.
  4198. This only works for numeric tick systems (DateTime ticks are not supported).
  4199. </summary>
  4200. </member>
  4201. <member name="M:ScottPlot.Renderable.Axis.MinorLogScale(System.Boolean,System.Boolean)">
  4202. <summary>
  4203. Sets whether minor ticks are evenly spaced or log-distributed between major tick positions
  4204. </summary>
  4205. </member>
  4206. <member name="M:ScottPlot.Renderable.Axis.Line(System.Nullable{System.Boolean},System.Nullable{System.Drawing.Color},System.Nullable{System.Single})">
  4207. <summary>
  4208. Configure the line drawn along the edge of the axis
  4209. </summary>
  4210. </member>
  4211. <member name="M:ScottPlot.Renderable.Axis.Layout(System.Nullable{System.Single},System.Nullable{System.Single},System.Nullable{System.Single})">
  4212. <summary>
  4213. Set the minimum size and padding of the axis
  4214. </summary>
  4215. </member>
  4216. <member name="M:ScottPlot.Renderable.Axis.MajorGrid(System.Nullable{System.Boolean},System.Nullable{System.Drawing.Color},System.Nullable{System.Single},System.Nullable{ScottPlot.LineStyle})">
  4217. <summary>
  4218. Configure visibility and styling of the major grid
  4219. </summary>
  4220. </member>
  4221. <member name="M:ScottPlot.Renderable.Axis.MinorGrid(System.Nullable{System.Boolean},System.Nullable{System.Drawing.Color},System.Nullable{System.Single},System.Nullable{ScottPlot.LineStyle},System.Nullable{System.Boolean})">
  4222. <summary>
  4223. Configure visibility and styling of the minor grid
  4224. </summary>
  4225. </member>
  4226. <member name="M:ScottPlot.Renderable.Axis.Hide(System.Boolean)">
  4227. <summary>
  4228. Hide this axis by forcing its size to always be zero.
  4229. </summary>
  4230. </member>
  4231. <member name="M:ScottPlot.Renderable.Axis.Grid(System.Boolean)">
  4232. <summary>
  4233. Set visibility for major tick grid lines
  4234. </summary>
  4235. </member>
  4236. <member name="M:ScottPlot.Renderable.Axis.RecalculateAxisSize">
  4237. <summary>
  4238. Set pixel size based on the latest axis label, tick marks, and tick label
  4239. </summary>
  4240. </member>
  4241. <member name="M:ScottPlot.Renderable.Axis.LockLimits(System.Boolean)">
  4242. <summary>
  4243. Lock min/max limits so it cannot be changed (until it's unlocked)
  4244. </summary>
  4245. </member>
  4246. <member name="M:ScottPlot.Renderable.Axis.GetTicks">
  4247. <summary>
  4248. Return the ticks displayed in the previous render
  4249. </summary>
  4250. </member>
  4251. <member name="T:ScottPlot.Renderable.AxisDimensions">
  4252. <summary>
  4253. This class stores MUTABLE axis limits and pixel size information for a SINGLE AXIS.
  4254. Unlike PlotDimensions(immutable objects created just before rendering),
  4255. values in this class are intended for long term storage.
  4256. </summary>
  4257. </member>
  4258. <member name="P:ScottPlot.Renderable.AxisDimensions.FigureSizePx">
  4259. <summary>
  4260. Size of the entire figure (in pixels) if it were to be exported as an image
  4261. </summary>
  4262. </member>
  4263. <member name="P:ScottPlot.Renderable.AxisDimensions.DataSizePx">
  4264. <summary>
  4265. Side of just the data area (in pixels).
  4266. The data area is the inner rectangle that displays plots.
  4267. </summary>
  4268. </member>
  4269. <member name="P:ScottPlot.Renderable.AxisDimensions.DataOffsetPx">
  4270. <summary>
  4271. Offset of the data area (in pixels) relative to the left or top edge of the figure.
  4272. </summary>
  4273. </member>
  4274. <member name="F:ScottPlot.Renderable.AxisDimensions.IsInverted">
  4275. <summary>
  4276. Indicates whether pixel values ascend in the same direciton as axis unit values.
  4277. Horizontal axes are not inverted (both ascend from left to right).
  4278. Vertical axes are inverted (units ascend from bottom to top but pixel positions ascend from top to bottom).
  4279. </summary>
  4280. </member>
  4281. <member name="P:ScottPlot.Renderable.AxisDimensions.Min">
  4282. <summary>
  4283. Lower edge of the data area (axis units).
  4284. </summary>
  4285. </member>
  4286. <member name="P:ScottPlot.Renderable.AxisDimensions.Max">
  4287. <summary>
  4288. Upper edge of the data area (axis units).
  4289. </summary>
  4290. </member>
  4291. <member name="P:ScottPlot.Renderable.AxisDimensions.OuterBoundaryMin">
  4292. <summary>
  4293. Limit beyond which the plot cannot be zoomed in
  4294. </summary>
  4295. </member>
  4296. <member name="P:ScottPlot.Renderable.AxisDimensions.OuterBoundaryMax">
  4297. <summary>
  4298. Limit beyond which the plot cannot be zoomed in
  4299. </summary>
  4300. </member>
  4301. <member name="P:ScottPlot.Renderable.AxisDimensions.InnerBoundaryMin">
  4302. <summary>
  4303. Limit which will always be visible on the data area
  4304. </summary>
  4305. </member>
  4306. <member name="P:ScottPlot.Renderable.AxisDimensions.InnerBoundaryMax">
  4307. <summary>
  4308. Limit which will always be visible on the data area
  4309. </summary>
  4310. </member>
  4311. <member name="P:ScottPlot.Renderable.AxisDimensions.SpanBound">
  4312. <summary>
  4313. Size of the view boundaries.
  4314. This should always be greater or equal to the Span.
  4315. </summary>
  4316. </member>
  4317. <member name="P:ScottPlot.Renderable.AxisDimensions.HasBeenSet">
  4318. <summary>
  4319. False until axes are intentionally set.
  4320. Unset axes default to NaN min/max limits.
  4321. </summary>
  4322. </member>
  4323. <member name="P:ScottPlot.Renderable.AxisDimensions.IsNan">
  4324. <summary>
  4325. True if min or max is NaN.
  4326. </summary>
  4327. </member>
  4328. <member name="P:ScottPlot.Renderable.AxisDimensions.Span">
  4329. <summary>
  4330. Size of the data area (axis units)
  4331. </summary>
  4332. </member>
  4333. <member name="P:ScottPlot.Renderable.AxisDimensions.Center">
  4334. <summary>
  4335. Center of the data area (axis units)
  4336. </summary>
  4337. </member>
  4338. <member name="P:ScottPlot.Renderable.AxisDimensions.PxPerUnit">
  4339. <summary>
  4340. Number of pixels for each axis unit
  4341. </summary>
  4342. </member>
  4343. <member name="P:ScottPlot.Renderable.AxisDimensions.UnitsPerPx">
  4344. <summary>
  4345. Size of 1 screen pixel in axis units
  4346. </summary>
  4347. </member>
  4348. <member name="F:ScottPlot.Renderable.AxisDimensions.MinRemembered">
  4349. <summary>
  4350. Limit remember/recall is used while mouse dragging
  4351. </summary>
  4352. </member>
  4353. <member name="F:ScottPlot.Renderable.AxisDimensions.MaxRemembered">
  4354. <summary>
  4355. Limit remember/recall is used while mouse dragging
  4356. </summary>
  4357. </member>
  4358. <member name="F:ScottPlot.Renderable.AxisDimensions.LockedLimits">
  4359. <summary>
  4360. If true, min/max cannot bet set.
  4361. </summary>
  4362. </member>
  4363. <member name="M:ScottPlot.Renderable.AxisDimensions.Remember">
  4364. <summary>
  4365. Limit remember/recall is used while mouse dragging
  4366. </summary>
  4367. </member>
  4368. <member name="M:ScottPlot.Renderable.AxisDimensions.Recall">
  4369. <summary>
  4370. Limit remember/recall is used while mouse dragging
  4371. </summary>
  4372. </member>
  4373. <member name="M:ScottPlot.Renderable.AxisDimensions.RationalLimits">
  4374. <summary>
  4375. Return limits that contain no NaNs.
  4376. NaNs will be replaced with +/- 10.
  4377. </summary>
  4378. <returns></returns>
  4379. </member>
  4380. <member name="M:ScottPlot.Renderable.AxisDimensions.ResetLimits">
  4381. <summary>
  4382. Reset the axis as if it were never set.
  4383. </summary>
  4384. </member>
  4385. <member name="M:ScottPlot.Renderable.AxisDimensions.Resize(System.Single,System.Nullable{System.Single},System.Nullable{System.Single})">
  4386. <summary>
  4387. Resize/reposition this axis according to the given pixel units
  4388. </summary>
  4389. </member>
  4390. <member name="M:ScottPlot.Renderable.AxisDimensions.SetPadding(System.Single,System.Single)">
  4391. <summary>
  4392. Set data size and offset based on desired padding between the edge of the figure and data area
  4393. </summary>
  4394. </member>
  4395. <member name="M:ScottPlot.Renderable.AxisDimensions.SetBoundsOuter(System.Double,System.Double)">
  4396. <summary>
  4397. Set boundaries beyond which this axis cannot be panned or zoomed
  4398. </summary>
  4399. </member>
  4400. <member name="M:ScottPlot.Renderable.AxisDimensions.SetBoundsInner(System.Double,System.Double)">
  4401. <summary>
  4402. Set boundaries beyond which this axis cannot be panned or zoomed
  4403. </summary>
  4404. </member>
  4405. <member name="M:ScottPlot.Renderable.AxisDimensions.ApplyBounds">
  4406. <summary>
  4407. Modify axis limits such that none extend beyond the boundaries.
  4408. </summary>
  4409. </member>
  4410. <member name="M:ScottPlot.Renderable.AxisDimensions.SetAxis(System.Nullable{System.Double},System.Nullable{System.Double})">
  4411. <summary>
  4412. Set axis limits
  4413. </summary>
  4414. </member>
  4415. <member name="M:ScottPlot.Renderable.AxisDimensions.Pan(System.Double)">
  4416. <summary>
  4417. Shift min and max by the given number of units
  4418. </summary>
  4419. </member>
  4420. <member name="M:ScottPlot.Renderable.AxisDimensions.PanPx(System.Single)">
  4421. <summary>
  4422. Shift min and max by the given number of pixels
  4423. </summary>
  4424. </member>
  4425. <member name="M:ScottPlot.Renderable.AxisDimensions.Zoom(System.Double,System.Nullable{System.Double})">
  4426. <summary>
  4427. Zoom by simultaneously adjusting Min and Max
  4428. </summary>
  4429. <param name="frac">1 for no change, 2 zooms in, .5 zooms out.</param>
  4430. <param name="zoomTo">If given, zoom toward/from this alternative center point.</param>
  4431. </member>
  4432. <member name="M:ScottPlot.Renderable.AxisDimensions.GetPixel(System.Double)">
  4433. <summary>
  4434. Get the pixel location on the figure for a given position in axis units
  4435. </summary>
  4436. </member>
  4437. <member name="M:ScottPlot.Renderable.AxisDimensions.GetUnit(System.Single)">
  4438. <summary>
  4439. Get the axis unit position for the given pixel location on the figure
  4440. </summary>
  4441. </member>
  4442. <member name="M:ScottPlot.Renderable.AxisDimensions.LockLimits(System.Boolean)">
  4443. <summary>
  4444. Sets a flag indicating whether axis limits are mutable.
  4445. </summary>
  4446. </member>
  4447. <member name="P:ScottPlot.Renderable.AxisLabel.IsVisible">
  4448. <summary>
  4449. Controls whether this axis occupies space and is displayed
  4450. </summary>
  4451. </member>
  4452. <member name="F:ScottPlot.Renderable.AxisLabel.Edge">
  4453. <summary>
  4454. Edge of the data area this axis represents
  4455. </summary>
  4456. </member>
  4457. <member name="F:ScottPlot.Renderable.AxisLabel.Label">
  4458. <summary>
  4459. Axis title
  4460. </summary>
  4461. </member>
  4462. <member name="F:ScottPlot.Renderable.AxisLabel.Font">
  4463. <summary>
  4464. Font options for the axis title
  4465. </summary>
  4466. </member>
  4467. <member name="F:ScottPlot.Renderable.AxisLabel.ImageLabel">
  4468. <summary>
  4469. Set this field to display a bitmap instead of a text axis label
  4470. </summary>
  4471. </member>
  4472. <member name="F:ScottPlot.Renderable.AxisLabel.ImagePaddingToDataArea">
  4473. <summary>
  4474. Padding (in pixels) between the image and the edge of the data area
  4475. </summary>
  4476. </member>
  4477. <member name="F:ScottPlot.Renderable.AxisLabel.ImagePaddingToFigureEdge">
  4478. <summary>
  4479. Padding (in pixels) between the image and the edge of the figure
  4480. </summary>
  4481. </member>
  4482. <member name="P:ScottPlot.Renderable.AxisLabel.ImagePadding">
  4483. <summary>
  4484. Total amount (in pixels) to pad the image when measuring axis size
  4485. </summary>
  4486. </member>
  4487. <member name="F:ScottPlot.Renderable.AxisLabel.PixelSizePadding">
  4488. <summary>
  4489. Amount of padding (in pixels) to surround the contents of this axis
  4490. </summary>
  4491. </member>
  4492. <member name="F:ScottPlot.Renderable.AxisLabel.PixelOffset">
  4493. <summary>
  4494. Distance to offset this axis to account for multiple axes
  4495. </summary>
  4496. </member>
  4497. <member name="F:ScottPlot.Renderable.AxisLabel.PixelSize">
  4498. <summary>
  4499. Exact size (in pixels) of the contents of this this axis
  4500. </summary>
  4501. </member>
  4502. <member name="M:ScottPlot.Renderable.AxisLabel.Measure">
  4503. <summary>
  4504. Return the size of the contents of this axis.
  4505. Returned dimensions are screen-accurate (even if this axis is rotated).
  4506. </summary>
  4507. <returns></returns>
  4508. </member>
  4509. <member name="M:ScottPlot.Renderable.AxisLabel.GetAxisCenter(ScottPlot.PlotDimensions)">
  4510. <summary>
  4511. Return the point and rotation representing the center of the base of this axis
  4512. </summary>
  4513. </member>
  4514. <member name="T:ScottPlot.Renderable.IRenderable">
  4515. <summary>
  4516. A "renderable" is any object which can be drawn on the figure.
  4517. </summary>
  4518. </member>
  4519. <member name="M:ScottPlot.Renderable.BenchmarkMessage.GetRenderTimes">
  4520. <summary>
  4521. Returns an array of render times (in milliseconds) of the last several renders.
  4522. The most recent renders are at the end of the array.
  4523. </summary>
  4524. </member>
  4525. <member name="T:ScottPlot.Settings">
  4526. <summary>
  4527. This module holds state for figure dimensions, axis limits, plot contents, and styling options.
  4528. A plot can be duplicated by copying the full state of this settings module.
  4529. </summary>
  4530. </member>
  4531. <member name="F:ScottPlot.Settings.Plottables">
  4532. <summary>
  4533. This List contains all plottables managed by this Plot.
  4534. Render order is from lowest (first) to highest (last).
  4535. </summary>
  4536. </member>
  4537. <member name="P:ScottPlot.Settings.PlottablesIdentifier">
  4538. <summary>
  4539. Unique value that changes any time the list of plottables is modified.
  4540. </summary>
  4541. </member>
  4542. <member name="M:ScottPlot.Settings.GetNextColor">
  4543. <summary>
  4544. Return the next color from PlottablePalette based on the current number of plottables
  4545. </summary>
  4546. </member>
  4547. <member name="F:ScottPlot.Settings.Axes">
  4548. <summary>
  4549. List of all axes used in this plot.
  4550. Axes can be added, but existing ones should not be removed.
  4551. </summary>
  4552. </member>
  4553. <member name="P:ScottPlot.Settings.HorizontalAxes">
  4554. <summary>
  4555. Get an array containing just horizontal axes
  4556. </summary>
  4557. </member>
  4558. <member name="P:ScottPlot.Settings.VerticalAxes">
  4559. <summary>
  4560. Get an array containing just vertical axes
  4561. </summary>
  4562. </member>
  4563. <member name="M:ScottPlot.Settings.GetXAxis(System.Int32)">
  4564. <summary>
  4565. Return the first horizontal axis with the given axis index
  4566. </summary>
  4567. </member>
  4568. <member name="M:ScottPlot.Settings.GetYAxis(System.Int32)">
  4569. <summary>
  4570. Return the first vertical axis with the given axis index
  4571. </summary>
  4572. </member>
  4573. <member name="P:ScottPlot.Settings.AllAxesHaveBeenSet">
  4574. <summary>
  4575. Indicates whether unset axes are present.
  4576. If true, the user may want to call AxisAuto() or SetAxisLimits().
  4577. </summary>
  4578. </member>
  4579. <member name="P:ScottPlot.Settings.EqualScaleMode">
  4580. <summary>
  4581. Controls relationship between X and Y axis scales.
  4582. See documentation for enumeration members.
  4583. </summary>
  4584. </member>
  4585. <member name="P:ScottPlot.Settings.YAxis">
  4586. <summary>
  4587. Primary vertical axis (on the left of the plot)
  4588. </summary>
  4589. </member>
  4590. <member name="P:ScottPlot.Settings.YAxis2">
  4591. <summary>
  4592. Secondary vertical axis (on the right of the plot)
  4593. </summary>
  4594. </member>
  4595. <member name="P:ScottPlot.Settings.XAxis">
  4596. <summary>
  4597. Primary horizontal axis (on the bottom of the plot)
  4598. </summary>
  4599. </member>
  4600. <member name="P:ScottPlot.Settings.XAxis2">
  4601. <summary>
  4602. Secondary horizontal axis (on the top of the plot)
  4603. </summary>
  4604. </member>
  4605. <member name="P:ScottPlot.Settings.Width">
  4606. <summary>
  4607. Width of the figure (in pixels)
  4608. </summary>
  4609. </member>
  4610. <member name="P:ScottPlot.Settings.Height">
  4611. <summary>
  4612. Height of the figure (in pixels)
  4613. </summary>
  4614. </member>
  4615. <member name="F:ScottPlot.Settings.MarginsX">
  4616. <summary>
  4617. Default padding to use when AxisAuto() or Margins() is called without a specified margin
  4618. </summary>
  4619. </member>
  4620. <member name="F:ScottPlot.Settings.MarginsY">
  4621. <summary>
  4622. Default padding to use when AxisAuto() or Margins() is called without a specified margin
  4623. </summary>
  4624. </member>
  4625. <member name="M:ScottPlot.Settings.GetPlotDimensions(System.Int32,System.Int32,System.Double)">
  4626. <summary>
  4627. Return figure dimensions for the specified X and Y axes
  4628. </summary>
  4629. </member>
  4630. <member name="M:ScottPlot.Settings.Resize(System.Single,System.Single)">
  4631. <summary>
  4632. Set the default size for rendering images
  4633. </summary>
  4634. </member>
  4635. <member name="M:ScottPlot.Settings.ResetAxisLimits">
  4636. <summary>
  4637. Reset axis limits to their defauts
  4638. </summary>
  4639. </member>
  4640. <member name="M:ScottPlot.Settings.AxisSet(System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.Int32,System.Int32)">
  4641. <summary>
  4642. Define axis limits for a particuar axis
  4643. </summary>
  4644. </member>
  4645. <member name="M:ScottPlot.Settings.AxisSet(ScottPlot.AxisLimits,System.Int32,System.Int32)">
  4646. <summary>
  4647. Define axis limits for a particuar axis
  4648. </summary>
  4649. </member>
  4650. <member name="M:ScottPlot.Settings.AxisLimits(System.Int32,System.Int32)">
  4651. <summary>
  4652. Return X and Y axis limits
  4653. </summary>
  4654. </member>
  4655. <member name="M:ScottPlot.Settings.AxesPanPx(System.Single,System.Single)">
  4656. <summary>
  4657. Pan all axes by the given pixel distance
  4658. </summary>
  4659. </member>
  4660. <member name="M:ScottPlot.Settings.AxesZoomPx(System.Single,System.Single,System.Boolean)">
  4661. <summary>
  4662. Zoom all axes by the given pixel distance
  4663. </summary>
  4664. </member>
  4665. <member name="M:ScottPlot.Settings.AxesZoomTo(System.Double,System.Double,System.Single,System.Single)">
  4666. <summary>
  4667. Zoom all axes by the given fraction
  4668. </summary>
  4669. </member>
  4670. <member name="M:ScottPlot.Settings.AxisAutoAll(System.Nullable{System.Double},System.Nullable{System.Double})">
  4671. <summary>
  4672. Automatically adjust X and Y axis limits of all axes to fit the data
  4673. </summary>
  4674. </member>
  4675. <member name="M:ScottPlot.Settings.AxisAutoUnsetAxes(System.Nullable{System.Double},System.Nullable{System.Double})">
  4676. <summary>
  4677. Automatically adjust axis limits for all axes which have not yet been set
  4678. </summary>
  4679. </member>
  4680. <member name="M:ScottPlot.Settings.EnforceEqualAxisScales">
  4681. <summary>
  4682. If a scale lock mode is in use, modify the axis limits accordingly
  4683. </summary>
  4684. </member>
  4685. <member name="M:ScottPlot.Settings.AxisAutoAllX(System.Nullable{System.Double})">
  4686. <summary>
  4687. Automatically adjust X axis limits to fit the data
  4688. </summary>
  4689. </member>
  4690. <member name="M:ScottPlot.Settings.AxisAutoAllY(System.Nullable{System.Double})">
  4691. <summary>
  4692. Automatically adjust Y axis limits to fit the data
  4693. </summary>
  4694. </member>
  4695. <member name="M:ScottPlot.Settings.RememberAxisLimits">
  4696. <summary>
  4697. Store axis limits (useful for storing state upon a MouseDown event)
  4698. </summary>
  4699. </member>
  4700. <member name="M:ScottPlot.Settings.RecallAxisLimits">
  4701. <summary>
  4702. Recall axis limits (useful for recalling state from a previous MouseDown event)
  4703. </summary>
  4704. </member>
  4705. <member name="M:ScottPlot.Settings.MouseDown(System.Single,System.Single)">
  4706. <summary>
  4707. Remember mouse position (do this before calling MousePan or MouseZoom)
  4708. </summary>
  4709. </member>
  4710. <member name="M:ScottPlot.Settings.MousePan(System.Single,System.Single)">
  4711. <summary>
  4712. Pan all axes based on the mouse position now vs that last given to MouseDown()
  4713. </summary>
  4714. </member>
  4715. <member name="M:ScottPlot.Settings.MouseZoom(System.Single,System.Single)">
  4716. <summary>
  4717. Zoom all axes based on the mouse position now vs that last given to MouseDown()
  4718. </summary>
  4719. </member>
  4720. <member name="M:ScottPlot.Settings.CopyPrimaryLayoutToAllAxes">
  4721. <summary>
  4722. Ensure all axes have the same size and offset as the primary X and Y axis
  4723. </summary>
  4724. </member>
  4725. <member name="M:ScottPlot.Settings.LayoutAuto">
  4726. <summary>
  4727. Automatically adjust the layout for every axis
  4728. </summary>
  4729. </member>
  4730. <member name="P:ScottPlot.StarAxis.Ticks">
  4731. <summary>
  4732. The ticks for each spoke.
  4733. </summary>
  4734. </member>
  4735. <member name="P:ScottPlot.StarAxis.NumberOfSpokes">
  4736. <summary>
  4737. The number of spokes to draw.
  4738. </summary>
  4739. </member>
  4740. <member name="F:ScottPlot.StarAxis.CategoryLabels">
  4741. <summary>
  4742. Labels for each category.
  4743. Length must be equal to the number of columns (categories) in the original data.
  4744. </summary>
  4745. </member>
  4746. <member name="F:ScottPlot.StarAxis.CategoryImages">
  4747. <summary>
  4748. Icons for each category.
  4749. Length must be equal to the number of columns (categories) in the original data.
  4750. </summary>
  4751. </member>
  4752. <member name="P:ScottPlot.StarAxis.AxisType">
  4753. <summary>
  4754. Controls rendering style of the concentric circles (ticks) of the web
  4755. </summary>
  4756. </member>
  4757. <member name="P:ScottPlot.StarAxis.ImagePlacement">
  4758. <summary>
  4759. Indicates the type of axis chart to render
  4760. </summary>
  4761. </member>
  4762. <member name="P:ScottPlot.StarAxis.WebColor">
  4763. <summary>
  4764. Color of the axis lines and concentric circles representing ticks
  4765. </summary>
  4766. </member>
  4767. <member name="P:ScottPlot.StarAxis.ShowAxisValues">
  4768. <summary>
  4769. If true, each value will be written in text on the plot.
  4770. </summary>
  4771. </member>
  4772. <member name="P:ScottPlot.StarAxis.ShowCategoryLabels">
  4773. <summary>
  4774. If true, category labels will be written in text on the plot (provided they exist)
  4775. </summary>
  4776. </member>
  4777. <member name="P:ScottPlot.StarAxis.LabelEachSpoke">
  4778. <summary>
  4779. Determines whether each spoke should be labeled, or just the first
  4780. </summary>
  4781. </member>
  4782. <member name="P:ScottPlot.StarAxis.Graphics">
  4783. <summary>
  4784. The drawing surface to use.
  4785. </summary>
  4786. </member>
  4787. <member name="F:ScottPlot.StarAxis.Font">
  4788. <summary>
  4789. Font used for labeling values on the plot
  4790. </summary>
  4791. </member>
  4792. <member name="P:ScottPlot.StarAxis.LineWidth">
  4793. <summary>
  4794. Determines the width of each spoke and the axis lines.
  4795. </summary>
  4796. </member>
  4797. <member name="M:ScottPlot.Statistics.Common.MinMaxSum(System.Double[])">
  4798. <summary>
  4799. Return the minimum, and maximum, and sum of a given array.
  4800. </summary>
  4801. </member>
  4802. <member name="M:ScottPlot.Statistics.Common.StDev(System.Double[])">
  4803. <summary>
  4804. Return the standard deviation of the given values.
  4805. </summary>
  4806. </member>
  4807. <member name="M:ScottPlot.Statistics.Common.StDev(System.Double[],System.Double)">
  4808. <summary>
  4809. Return the standard deviation of the given values.
  4810. This overload is faster because the mean of the values is provided.
  4811. </summary>
  4812. </member>
  4813. <member name="M:ScottPlot.Statistics.Common.StdErr(System.Double[])">
  4814. <summary>
  4815. Return the standard error of the given values
  4816. </summary>
  4817. </member>
  4818. <member name="M:ScottPlot.Statistics.Common.Mean(System.Double[])">
  4819. <summary>
  4820. Return the mean of the given values
  4821. </summary>
  4822. </member>
  4823. <member name="M:ScottPlot.Statistics.Common.NthOrderStatistic(System.Double[],System.Int32)">
  4824. <summary>
  4825. Return the Nth smallest value in the given array.
  4826. </summary>
  4827. </member>
  4828. <member name="M:ScottPlot.Statistics.Common.Quantile(System.Double[],System.Int32,System.Int32)">
  4829. <summary>
  4830. Return the value of the Nth quantile.
  4831. </summary>
  4832. </member>
  4833. <member name="M:ScottPlot.Statistics.Common.Quartile(System.Double[],System.Int32)">
  4834. <summary>
  4835. Return the value of the Nth quartile
  4836. </summary>
  4837. <param name="values"></param>
  4838. <param name="quartile">quartile 1, 2, or 3</param>
  4839. </member>
  4840. <member name="M:ScottPlot.Statistics.Common.Percentile(System.Double[],System.Int32)">
  4841. <summary>
  4842. Return the percentile of the given array
  4843. </summary>
  4844. <param name="values"></param>
  4845. <param name="percentile">number from 0 to 100</param>
  4846. <returns></returns>
  4847. </member>
  4848. <member name="M:ScottPlot.Statistics.Common.Percentile(System.Double[],System.Double)">
  4849. <summary>
  4850. Return the percentile of the given array
  4851. </summary>
  4852. <param name="values"></param>
  4853. <param name="percentile">number from 0 to 100</param>
  4854. </member>
  4855. <member name="M:ScottPlot.Statistics.Common.Median(System.Double[])">
  4856. <summary>
  4857. Return the median of the given array.
  4858. If the length of the array is even, this value is the mean of the upper and lower medians.
  4859. </summary>
  4860. </member>
  4861. <member name="M:ScottPlot.Statistics.Common.QuickSelect(System.Double[],System.Int32,System.Int32,System.Int32)">
  4862. <summary>
  4863. Return the kth smallest value from a range of the given array.
  4864. WARNING: values will be mutated.
  4865. </summary>
  4866. <param name="values"></param>
  4867. <param name="leftIndex">inclusive lower bound</param>
  4868. <param name="rightIndex">inclusive upper bound</param>
  4869. <param name="k">number starting at 0</param>
  4870. <returns></returns>
  4871. </member>
  4872. <member name="M:ScottPlot.Statistics.Common.GetRandomInt(System.Int32,System.Int32)">
  4873. <summary>
  4874. Return a random integer from within the given range
  4875. </summary>
  4876. <param name="min">inclusive lower bound</param>
  4877. <param name="max">exclusive upper bound</param>
  4878. <returns></returns>
  4879. </member>
  4880. <member name="M:ScottPlot.Statistics.Common.Partition(System.Double[],System.Int32,System.Int32)">
  4881. <summary>
  4882. Partition the array between the defined bounds according to elements above and below a randomly chosen pivot value
  4883. </summary>
  4884. <param name="values"></param>
  4885. <param name="leftIndex"></param>
  4886. <param name="rightIndex"></param>
  4887. <returns>index of the pivot used</returns>
  4888. </member>
  4889. <member name="M:ScottPlot.Statistics.Common.ProbabilityDensityFunction(System.Double[])">
  4890. <summary>
  4891. Given a dataset of values return the probability density function.
  4892. The returned function is a Gaussian curve from 0 to 1 (not normalized)
  4893. </summary>
  4894. <param name="values">original dataset</param>
  4895. <returns>Function to return Y for a given X</returns>
  4896. </member>
  4897. <member name="M:ScottPlot.Statistics.Common.ProbabilityDensity(System.Double[],System.Double[],System.Boolean)">
  4898. <summary>
  4899. Given a dataset of values return the probability density function at specific X positions.
  4900. Returned values will be normalized such that their integral is 1.
  4901. </summary>
  4902. <param name="values">original dataset</param>
  4903. <param name="xs">Positions (Xs) for which probabilities (Ys) will be returned</param>
  4904. <param name="percent">if True, output will be multiplied by 100</param>
  4905. <returns>Densities (Ys) for each of the given Xs</returns>
  4906. </member>
  4907. <member name="M:ScottPlot.Statistics.Common.CumulativeSum(System.Double[])">
  4908. <summary>
  4909. Return the cumulative sum of the given data
  4910. </summary>
  4911. <param name="values"></param>
  4912. <returns></returns>
  4913. </member>
  4914. <member name="M:ScottPlot.Statistics.Common.Histogram(System.Double[],System.Double,System.Double,System.Double,System.Boolean)">
  4915. <summary>
  4916. Compute the histogram of a dataset.
  4917. </summary>
  4918. <param name="values">Input data</param>
  4919. <param name="min">Lower edge of the first bin (inclusive). If NaN, minimum of input values will be used.</param>
  4920. <param name="max">High edge of the largest bin (inclusive). If NaN, maximum of input values will be used.</param>
  4921. <param name="binSize">Width of each bin.</param>
  4922. <param name="density">If False, the result will contain the number of samples in each bin. If True, the result is the value of the probability density function at the bin (the sum of all values will be 1 if the bin size is 1).</param>
  4923. </member>
  4924. <member name="M:ScottPlot.Statistics.Common.Histogram(System.Double[],System.Int32,System.Boolean,System.Double,System.Double)">
  4925. <summary>
  4926. Compute the histogram of a dataset.
  4927. </summary>
  4928. <param name="values">Input data</param>
  4929. <param name="binCount">Number of equal-width bins</param>
  4930. <param name="density">If False, the result will contain the number of samples in each bin. If True, the result is the value of the probability density function at the bin (the sum of all values will be 1 if the bin size is 1).</param>
  4931. <param name="min">Lower edge of the first bin (inclusive). If NaN, minimum of input values will be used.</param>
  4932. <param name="max">High edge of the largest bin (inclusive). If NaN, maximum of input values will be used.</param>
  4933. <returns></returns>
  4934. </member>
  4935. <member name="M:ScottPlot.Statistics.Finance.SMA(System.Double[],System.Int32,System.Boolean)">
  4936. <summary>
  4937. Simple moving average
  4938. </summary>
  4939. <param name="values">number of values to use for each calculation</param>
  4940. <param name="period">number of values to use for each calculation</param>
  4941. <param name="trimNan">only return data where values are present for the whole period</param>
  4942. </member>
  4943. <member name="M:ScottPlot.Statistics.Finance.SMStDev(System.Double[],System.Int32)">
  4944. <summary>
  4945. Simple moving standard deviation
  4946. </summary>
  4947. <param name="values"></param>
  4948. <param name="period">number of values to use for each calculation</param>
  4949. </member>
  4950. <member name="M:ScottPlot.Statistics.Finance.SMA(ScottPlot.OHLC[],System.Int32)">
  4951. <summary>
  4952. Return the simple moving average (SMA) of the OHLC closing prices.
  4953. The returned data will be shorter than the input data by N points.
  4954. </summary>
  4955. <param name="ohlcs">price data to analyze</param>
  4956. <param name="N">each returned price represents the average of N prices</param>
  4957. </member>
  4958. <member name="M:ScottPlot.Statistics.Finance.Bollinger(System.Double[],System.Int32,System.Double)">
  4959. <summary>
  4960. Return the SMA and upper/lower Bollinger bands for the given price data.
  4961. The returned data will NOT be shorter than the input data. It will contain NaN values at the front.
  4962. </summary>
  4963. <param name="prices">price data to use for analysis</param>
  4964. <param name="N">each returned price represents the average of N prices</param>
  4965. <param name="sdCoeff">number of standard deviations from the mean to use for the Bollinger bands</param>
  4966. </member>
  4967. <member name="M:ScottPlot.Statistics.Finance.Bollinger(ScottPlot.OHLC[],System.Int32,System.Double)">
  4968. <summary>
  4969. Return the SMA and upper/lower Bollinger bands for the closing price of the given OHLCs.
  4970. The returned data will be shorter than the input data by N values.
  4971. </summary>
  4972. <param name="ohlcs">price data to use for analysis</param>
  4973. <param name="N">each returned price represents the average of N prices</param>
  4974. <param name="sdCoeff">number of standard deviations from the mean to use for the Bollinger bands</param>
  4975. </member>
  4976. <member name="F:ScottPlot.Statistics.Histogram.bins">
  4977. <summary>
  4978. Lower edges of bins used to create the histogram
  4979. </summary>
  4980. </member>
  4981. <member name="F:ScottPlot.Statistics.Histogram.counts">
  4982. <summary>
  4983. Total number of values in each bin.
  4984. </summary>
  4985. </member>
  4986. <member name="F:ScottPlot.Statistics.Histogram.countsFrac">
  4987. <summary>
  4988. Fractional number of values in each bin.
  4989. The total of all values in this array is 1.0.
  4990. </summary>
  4991. </member>
  4992. <member name="F:ScottPlot.Statistics.Histogram.cumulativeCounts">
  4993. <summary>
  4994. Cumulative total number of values in each bin.
  4995. The returned array will start near 0.0 and end near 1.0.
  4996. </summary>
  4997. </member>
  4998. <member name="F:ScottPlot.Statistics.Histogram.probability">
  4999. <summary>
  5000. Probability density (fraction) for each bin based on the mean and standard deviation of the population.
  5001. The sum of all these values is 1.0
  5002. </summary>
  5003. </member>
  5004. <member name="F:ScottPlot.Statistics.Histogram.countsFracCurve">
  5005. <summary>
  5006. This is the probability density curve normalized to its peak, so its maximum value is 1.0
  5007. </summary>
  5008. </member>
  5009. <member name="F:ScottPlot.Statistics.Histogram.cumulativeFrac">
  5010. <summary>
  5011. Cumulative probability density fraction for each bin
  5012. </summary>
  5013. </member>
  5014. <member name="F:ScottPlot.Statistics.Histogram.binSize">
  5015. <summary>
  5016. Distance between each bin
  5017. </summary>
  5018. </member>
  5019. <member name="F:ScottPlot.Statistics.Histogram.mean">
  5020. <summary>
  5021. Population mean
  5022. </summary>
  5023. </member>
  5024. <member name="F:ScottPlot.Statistics.Histogram.stdev">
  5025. <summary>
  5026. Population standard deviation
  5027. </summary>
  5028. </member>
  5029. <member name="M:ScottPlot.Statistics.Histogram.#ctor(System.Double[],System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.Nullable{System.Double},System.Boolean)">
  5030. <summary>
  5031. Compute the histogram of a set of data.
  5032. Bins are identically sized and evenly spaced.
  5033. </summary>
  5034. <param name="values">input data</param>
  5035. <param name="min">manually-defined lower edge of first bin</param>
  5036. <param name="max">manually-defined upper edge of last bin</param>
  5037. <param name="binSize">manually-defined width of each bin</param>
  5038. <param name="binCount">resize bins as needed so this number of bins is achieved</param>
  5039. <param name="ignoreOutOfBounds">if True, values below min or above max will be ignored</param>
  5040. </member>
  5041. <member name="T:ScottPlot.Statistics.Interpolation.EndSlopeSpline">
  5042. <summary>
  5043. The End Slope Spline is a Natural Spline whose first and last point slopes can be defined
  5044. </summary>
  5045. </member>
  5046. <member name="T:ScottPlot.Statistics.Interpolation.NaturalSpline">
  5047. <summary>
  5048. Natural Spline data interpolator
  5049. </summary>
  5050. </member>
  5051. <member name="T:ScottPlot.Statistics.Interpolation.PeriodicSpline">
  5052. <summary>
  5053. The Periodic Spline is a Natural Spline whose first and last point slopes are equal
  5054. </summary>
  5055. </member>
  5056. <member name="T:ScottPlot.Statistics.Population">
  5057. <summary>
  5058. This module holds an array of values and provides popultation statistics (mean, median, standard deviation, etc)
  5059. </summary>
  5060. </member>
  5061. <member name="M:ScottPlot.Statistics.Population.#ctor(System.Random,System.Int32,System.Double,System.Double)">
  5062. <summary>
  5063. Generate random values with a normal distribution
  5064. </summary>
  5065. </member>
  5066. <member name="M:ScottPlot.Statistics.Population.#ctor(System.Double[])">
  5067. <summary>
  5068. Calculate population stats from the given array of values
  5069. </summary>
  5070. </member>
  5071. <member name="T:ScottPlot.Statistics.PopulationSeries">
  5072. <summary>
  5073. A population series is a collection of similar PopulationStats objects.
  5074. </summary>
  5075. </member>
  5076. <member name="M:ScottPlot.Style.GetStyles">
  5077. <summary>
  5078. Return an array containing every available style
  5079. </summary>
  5080. </member>
  5081. <member name="T:ScottPlot.Styles.IStyle">
  5082. <summary>
  5083. A theme describes a collection of colors and fonts that can be used to style a plot
  5084. </summary>
  5085. </member>
  5086. <member name="P:ScottPlot.Ticks.TickCollection.CornerLabel">
  5087. <summary>
  5088. Label to show in the corner when using multiplier or offset notation
  5089. </summary>
  5090. </member>
  5091. <member name="P:ScottPlot.Ticks.TickCollection.LargestLabelWidth">
  5092. <summary>
  5093. Measured size of the largest tick label
  5094. </summary>
  5095. </member>
  5096. <member name="P:ScottPlot.Ticks.TickCollection.LargestLabelHeight">
  5097. <summary>
  5098. Measured size of the largest tick label
  5099. </summary>
  5100. </member>
  5101. <member name="F:ScottPlot.Ticks.TickCollection.LabelFormat">
  5102. <summary>
  5103. Controls how to translate positions to strings
  5104. </summary>
  5105. </member>
  5106. <member name="F:ScottPlot.Ticks.TickCollection.Orientation">
  5107. <summary>
  5108. If True, these ticks are placed along a vertical (Y) axis.
  5109. This is used to determine whether tick density should be based on tick label width or height.
  5110. </summary>
  5111. </member>
  5112. <member name="F:ScottPlot.Ticks.TickCollection.LabelUsingInvertedSign">
  5113. <summary>
  5114. If True, the sign of numeric tick labels will be inverted.
  5115. This is used to give the appearance of descending ticks.
  5116. </summary>
  5117. </member>
  5118. <member name="F:ScottPlot.Ticks.TickCollection.MinorTickDistribution">
  5119. <summary>
  5120. Define how minor ticks are distributed (evenly vs. log scale)
  5121. </summary>
  5122. </member>
  5123. <member name="F:ScottPlot.Ticks.TickCollection.ManualTickFormatter">
  5124. <summary>
  5125. If defined, this function will be used to generate tick labels from positions
  5126. </summary>
  5127. </member>
  5128. <member name="F:ScottPlot.Ticks.TickCollection.TickDensity">
  5129. <summary>
  5130. Optimally packed tick labels have a density 1.0 and lower densities space ticks farther apart.
  5131. </summary>
  5132. </member>
  5133. <member name="F:ScottPlot.Ticks.TickCollection.MinimumTickSpacing">
  5134. <summary>
  5135. Defines the minimum distance (in coordinate units) for major ticks.
  5136. </summary>
  5137. </member>
  5138. <member name="F:ScottPlot.Ticks.TickCollection.IntegerPositionsOnly">
  5139. <summary>
  5140. If True, non-integer tick positions will not be used.
  5141. This may be desired for log10-scaled axes so tick marks are even powers of 10.
  5142. </summary>
  5143. </member>
  5144. <member name="M:ScottPlot.Ticks.TickCollection.MinorFromMajorLog(System.Double[],System.Double,System.Double,System.Int32)">
  5145. <summary>
  5146. Return an array of log-spaced minor tick marks for the given range
  5147. </summary>
  5148. <param name="majorTickPositions">Locations of visible major ticks. Must be evenly spaced.</param>
  5149. <param name="min">Do not include minor ticks less than this value.</param>
  5150. <param name="max">Do not include minor ticks greater than this value.</param>
  5151. <param name="divisions">Number of minor ranges to divide each major range into. (A range is the space between tick marks)</param>
  5152. <returns>Array of minor tick positions (empty at positions occupied by major ticks)</returns>
  5153. </member>
  5154. <member name="M:ScottPlot.Tools.Pad(System.Double[],System.Int32,System.Double,System.Double,System.Boolean)">
  5155. <summary>
  5156. return a copy of the given array padded with the given value at both sidees
  5157. </summary>
  5158. </member>
  5159. <member name="M:ScottPlot.Validate.AssertIsReal(System.String,System.Double)">
  5160. <summary>
  5161. Throw an exception if the value is NaN or infinity
  5162. </summary>
  5163. </member>
  5164. <member name="M:ScottPlot.Validate.AssertAllReal(System.String,System.Double[])">
  5165. <summary>
  5166. Throw an exception if the array is null or contains NaN or infinity
  5167. </summary>
  5168. </member>
  5169. <member name="M:ScottPlot.Validate.AssertAllReal``1(System.String,``0[])">
  5170. <summary>
  5171. Throw an exception if the array is null or contains NaN or infinity
  5172. </summary>
  5173. </member>
  5174. <member name="M:ScottPlot.Validate.AssertAscending(System.String,System.Double[])">
  5175. <summary>
  5176. Throw an exception if one elemnt is equal to or less than the previous element
  5177. </summary>
  5178. </member>
  5179. <member name="M:ScottPlot.Validate.AssertAscending``1(System.String,``0[])">
  5180. <summary>
  5181. Throw an exception if one elemnt is equal to or less than the previous element
  5182. </summary>
  5183. </member>
  5184. <member name="M:ScottPlot.Validate.AssertHasElements(System.String,System.Double[])">
  5185. <summary>
  5186. Throw an exception if the array does not contain at least one element
  5187. </summary>
  5188. </member>
  5189. <member name="M:ScottPlot.Validate.AssertHasElements``1(System.String,``0[])">
  5190. <summary>
  5191. Throw an exception if the array does not contain at least one element
  5192. </summary>
  5193. </member>
  5194. <member name="M:ScottPlot.Validate.AssertHasElements(System.String,System.Drawing.Color[])">
  5195. <summary>
  5196. Throw an exception if the array does not contain at least one element
  5197. </summary>
  5198. </member>
  5199. <member name="M:ScottPlot.Validate.AssertHasElements(System.String,System.String[])">
  5200. <summary>
  5201. Throw an exception if the array does not contain at least one element
  5202. </summary>
  5203. </member>
  5204. <member name="M:ScottPlot.Validate.AssertEqualLength(System.String,System.Double[],System.Double[],System.Double[],System.Double[],System.Double[],System.Double[])">
  5205. <summary>
  5206. Throw an exception if non-null arrays have different lengths
  5207. </summary>
  5208. </member>
  5209. <member name="M:ScottPlot.Validate.AssertEqualLength``2(System.String,``0[],``1[])">
  5210. <summary>
  5211. Throw an exception if non-null arrays have different lengths
  5212. </summary>
  5213. </member>
  5214. <member name="M:ScottPlot.Validate.IsEqualLength(System.Double[],System.Double[],System.Double[],System.Double[],System.Double[],System.Double[])">
  5215. <summary>
  5216. Returns true if all non-null arguments have equal length
  5217. </summary>
  5218. </member>
  5219. <member name="M:ScottPlot.Validate.AssertHasText(System.String,System.String)">
  5220. <summary>
  5221. Throws an exception if the string is null, empty, or only contains whitespace
  5222. </summary>
  5223. </member>
  5224. </members>
  5225. </doc>