12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807 |
- // jshint unused: false
- var kendo = {
- ui: {},
- mobile: {ui: {}},
- dataviz: {ui: {}},
- data: {}
- };
- if (!kendo.kendo) {
- kendo.kendo = {};
- }
- kendo.Class = function() { };
- kendo.Class.prototype = {
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoClass = function() {
- /// <summary>
- /// Returns a reference to the kendo.Class widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.Class">The kendo.Class instance (if present).</returns>
- };
- $.fn.kendoClass = function(options) {
- /// <summary>
- /// Instantiates a kendo.Class widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.Color = function() { };
- kendo.Color.prototype = {
- diff: function() {
- /// <summary>
- /// Computes the relative luminance between two colors.
- /// </summary>
- /// <returns type="Number">The relative luminance.</returns>
- },
- equals: function() {
- /// <summary>
- /// Compares two color objects for equality.
- /// </summary>
- /// <returns type="Boolean">returns true if the two colors are the same. Otherwise, false</returns>
- },
- toHSV: function() {
- /// <summary>
- /// Returns the color in HSV representation. As HSV object, it has the following properties: h -- hue, an integer between 0 and 360; s -- saturation, floating point between 0 and 1; v -- value, floating point between 0 and 1 or a -- alpha, floating point between 0 and 1. This does not modify the current object, it creates a new one instead.
- /// </summary>
- /// <returns type="Object">An object with h, s, v and a fields.</returns>
- },
- toRGB: function() {
- /// <summary>
- /// Returns the color in RGB representation. The result has the following properties: r -- red component as floating point between 0 and 1; g -- green component; b -- blue component or a -- alpha. This does not modify the current object, it creates a new one instead.
- /// </summary>
- /// <returns type="Object">An object with r, g, b and a fields.</returns>
- },
- toBytes: function() {
- /// <summary>
- /// Returns the color in "Bytes" representation. It has the same properties as RGB, but r, g and b are integers between 0 and 255 instead of floats.This does not modify the current object, it creates a new one instead.
- /// </summary>
- /// <returns type="Object">An object with r, g and b fields.</returns>
- },
- toHex: function() {
- /// <summary>
- /// Returns a string in "FF0000" form (without a leading #).
- /// </summary>
- /// <returns type="String">The color in hex notation.</returns>
- },
- toCss: function() {
- /// <summary>
- /// Like toHex, but includes a leading #.
- /// </summary>
- /// <returns type="String">The color in CSS notation.</returns>
- },
- toCssRgba: function() {
- /// <summary>
- /// Returns the color in RGBA notation (includes the opacity).
- /// </summary>
- /// <returns type="String">The color in RGBA notation.</returns>
- },
- toDisplay: function() {
- /// <summary>
- /// Returns the color in the best notation supported by the current browser. In IE < 9 this returns the #FF0000 form; in all other browsers it returns the RGBA form.
- /// </summary>
- /// <returns type="String">The color in the best notation supported by the current browser.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoColor = function() {
- /// <summary>
- /// Returns a reference to the kendo.Color widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.Color">The kendo.Color instance (if present).</returns>
- };
- $.fn.kendoColor = function(options) {
- /// <summary>
- /// Instantiates a kendo.Color widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.Layout = function() { };
- kendo.Layout.prototype = {
- showIn: function(container,view,transitionClass) {
- /// <summary>
- /// Renders the View element in the element specified by the selector
- /// </summary>
- /// <param name="container" type="String" >The selector of the container in which the view element will be appended.</param>
- /// <param name="view" type="kendo.View" >The view instance that will be rendered.</param>
- /// <param name="transitionClass" type="string" >Optional. If provided, the new view will replace the current one with a replace effect.</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoLayout = function() {
- /// <summary>
- /// Returns a reference to the kendo.Layout widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.Layout">The kendo.Layout instance (if present).</returns>
- };
- $.fn.kendoLayout = function(options) {
- /// <summary>
- /// Instantiates a kendo.Layout widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.Observable = function() { };
- kendo.Observable.prototype = {
- bind: function(eventName,handler) {
- /// <summary>
- /// Attaches a handler to an event.
- /// </summary>
- /// <param name="eventName" type="String" >The name of the event.</param>
- /// <param name="handler" type="Function" >A function to execute each time the event is triggered. That function should have a single parameter which will contain any event specific data.</param>
- },
- one: function(eventName,handler) {
- /// <summary>
- /// Attaches a handler to an event. The handler is executed only once.
- /// </summary>
- /// <param name="eventName" type="String" >The name of the event.</param>
- /// <param name="handler" type="Function" >A function to execute each time the event is triggered. That function should have a single parameter which will contain any event specific data.</param>
- },
- trigger: function(eventName,eventData) {
- /// <summary>
- /// Executes all handlers attached to the given event.
- /// </summary>
- /// <param name="eventName" type="String" >The name of the event to trigger.</param>
- /// <param name="eventData" type="Object" >Optional event data which will be passed as an argument to the event handlers.</param>
- },
- unbind: function(eventName,handler) {
- /// <summary>
- /// Remove a previously attached event handler.
- /// </summary>
- /// <param name="eventName" type="String" >The name of the event. If not specified all handlers of all events will be removed.</param>
- /// <param name="handler" type="Function" >The handler which should no longer be executed. If not specified all handlers listening to that event will be removed.</param>
- },
- self: null
- };
- $.fn.getKendoObservable = function() {
- /// <summary>
- /// Returns a reference to the kendo.Observable widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.Observable">The kendo.Observable instance (if present).</returns>
- };
- $.fn.kendoObservable = function(options) {
- /// <summary>
- /// Instantiates a kendo.Observable widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.Router = function() { };
- kendo.Router.prototype = {
- start: function() {
- /// <summary>
- /// Activates the router binding to the URL changes.
- /// </summary>
- },
- route: function(route,callback) {
- /// <summary>
- ///
- /// </summary>
- /// <param name="route" type="String" >The route definition.</param>
- /// <param name="callback" type="Function" >The callback to be executed when the route is matched.</param>
- },
- navigate: function(route,silent) {
- /// <summary>
- /// Navigates to the given route.
- /// </summary>
- /// <param name="route" type="String" >The route to navigate to.</param>
- /// <param name="silent" type="Boolean" >If set to true, the router callbacks will not be called.</param>
- },
- replace: function(route,silent) {
- /// <summary>
- /// Navigates to the given route, replacing the current view in the history stack (like window.history.replaceState or location.replace work).
- /// </summary>
- /// <param name="route" type="String" >The route to navigate to.</param>
- /// <param name="silent" type="Boolean" >If set to true, the router callbacks will not be called.</param>
- },
- destroy: function() {
- /// <summary>
- /// Unbinds the router instance listeners from the URL fragment part changes.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoRouter = function() {
- /// <summary>
- /// Returns a reference to the kendo.Router widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.Router">The kendo.Router instance (if present).</returns>
- };
- $.fn.kendoRouter = function(options) {
- /// <summary>
- /// Instantiates a kendo.Router widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// ignoreCase - Boolean (default: true)
- /// Introduced with Q3 2014. If set to false, the router instance will perform case sensitive match of the url against the defined routes.
- ///
- /// pushState - Boolean (default: false)
- /// If set to true, the router will use the history pushState API.
- ///
- /// root - String (default: "/")
- /// Applicable if pushState is used and the application is deployed to a path different than /. If the application start page is hosted on http://foo.com/myapp/, the root option should be set to /myapp/.
- ///
- /// hashBang - Boolean (default: false)
- /// Introduced in the 2014 Q1 Service Pack 1 release. If set to true, the hash based navigation will parse and prefix the fragment value with !, which should be SEO friendly, and allows non-prefixed anchor links to work as expected.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.View = function() { };
- kendo.View.prototype = {
- destroy: function() {
- /// <summary>
- /// Removes the View element from the DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
- /// </summary>
- },
- render: function(container) {
- /// <summary>
- /// Renders the view contents. Accepts a jQuery selector (or jQuery object) to which the contents will be appended. Alternatively, the render method can be called without parameters in order to retrieve the View element for manual insertion/further manipulation.
- /// </summary>
- /// <param name="container" type="jQuery" >(optional) the element in which the view element will be appended.</param>
- /// <returns type="jQuery">the view element.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoView = function() {
- /// <summary>
- /// Returns a reference to the kendo.View widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.View">The kendo.View instance (if present).</returns>
- };
- $.fn.kendoView = function(options) {
- /// <summary>
- /// Instantiates a kendo.View widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// evalTemplate - Boolean (default: false)
- /// If set to true, the view template will be treated as kendo template and evaluated against the provided model instance.
- ///
- /// tagName - String (default: "div")
- /// The tag used for the root element of the view.
- ///
- /// wrap - Boolean (default: true)
- /// If set to false, the view will not wrap its contents in a root element. In that case, the view element will point to the root element in the template. If false, the view template should have a single root element.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.Binder = function() { };
- kendo.data.Binder.prototype = {
- refresh: function() {
- /// <summary>
- /// Invoked by the Kendo UI MVVM framework when the bound view-model value is changed. The Binder should update the UI (the HTML element or the Kendo UI widget) to reflect the view-model change.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoBinder = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.Binder widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.Binder">The kendo.data.Binder instance (if present).</returns>
- };
- $.fn.kendoBinder = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.Binder widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.DataSource = function() { };
- kendo.data.DataSource.prototype = {
- add: function(model) {
- /// <summary>
- /// Appends a data item to the data source.
- /// </summary>
- /// <param name="model" type="Object" >Either a kendo.data.Model instance or JavaScript object containing the data item field values.</param>
- /// <returns type="kendo.data.Model">—The data item which is inserted.</returns>
- },
- aggregate: function(value) {
- /// <summary>
- /// Gets or sets the aggregate configuration.
- /// </summary>
- /// <param name="value" type="Object" >The aggregate configuration. Accepts the same values as the aggregate option.</param>
- /// <returns type="Array">—The current aggregate configuration.</returns>
- },
- aggregates: function() {
- /// <summary>
- /// Returns the aggregate results.
- /// </summary>
- /// <returns type="Object">—The aggregate results. There is a key for every aggregated field.</returns>
- },
- at: function(index) {
- /// <summary>
- /// Returns the data item at the specified index. The index is zero-based.
- /// </summary>
- /// <param name="index" type="Number" >The zero-based index of the data item.</param>
- /// <returns type="kendo.data.ObservableObject">—The data item at the specified index. Returns undefined if a data item is not found at the specified index. Returns a kendo.data.Model instance if the schema.model option is set.</returns>
- },
- cancelChanges: function(model) {
- /// <summary>
- /// Cancels any pending changes in the data source. Deleted data items are restored, new data items are removed, and updated data items are restored to their initial state. Every data item uid will be reset.
- /// </summary>
- /// <param name="model" type="kendo.data.Model" >The optional data item (model). If specified, only the changes of this data item will be discarded. If omitted, all changes will be discarded.</param>
- },
- data: function(value) {
- /// <summary>
- /// Gets or sets the data items of the data source.If the data source is bound to a remote service (via the transport option), the data method will return the service response. Every item from the response is wrapped in a kendo.data.ObservableObject or kendo.data.Model (if the schema.model option is set).If the data source is bound to a JavaScript array (via the data option), the data method will return the items of that array. Every item from the array is wrapped in a kendo.data.ObservableObject or kendo.data.Model (if the schema.model option is set).If the data source is grouped (via the group option or the group method) and the serverGrouping is set to true, the data method will return the group items.Compare with the view method, which will return the data items that correspond to the current page, filter, sort and group configuration.
- /// </summary>
- /// <param name="value" type="Object" >The data items which will replace the current ones in the data source. If omitted the current data items will be returned.</param>
- /// <returns type="kendo.data.ObservableArray">—The data items of the data source. Returns an empty array if the data source was not populated with data items via the read, fetch, or query methods.</returns>
- },
- fetch: function(callback) {
- /// <summary>
- /// Reads the data items from a remote service (if the transport option is set) or from a JavaScript array (if the data option is set).
- /// </summary>
- /// <param name="callback" type="Function" >The optional function which is executed when the remote request is finished. The function context (available via the this keyword) will be set to the data source instance.</param>
- /// <returns type="Promise">—A promise that will be resolved when the data has been loaded, or rejected if an HTTP error occurs.</returns>
- },
- filter: function(value) {
- /// <summary>
- /// Gets or sets the filter configuration.
- /// </summary>
- /// <param name="value" type="Object" >The filter configuration. Accepts the same values as the filter option (check there for more examples).</param>
- /// <returns type="Object">—The current filter configuration. Returns null if no filter criteria are currently applied. Returns undefined if the DataSource instance has not performed filtering so far.</returns>
- },
- get: function(id) {
- /// <summary>
- /// Gets the data item (model) with the specified id.
- /// </summary>
- /// <param name="id" type="Object" >The id of the model to look for.</param>
- /// <returns type="kendo.data.Model">—The model instance. Returns undefined if a model with the specified id is not found.</returns>
- },
- getByUid: function(uid) {
- /// <summary>
- /// Gets the data item (model) with the specified uid.
- /// </summary>
- /// <param name="uid" type="String" >The uid of the model to look for.</param>
- /// <returns type="kendo.data.ObservableObject">—The model instance. Returns undefined if a model with the specified uid is not found.</returns>
- },
- group: function(value) {
- /// <summary>
- /// Gets or sets the grouping configuration.
- /// </summary>
- /// <param name="value" type="Object" >The grouping configuration. Accepts the same values as the group option.</param>
- /// <returns type="Array">—The current grouping configuration.</returns>
- },
- hasChanges: function() {
- /// <summary>
- /// Checks if the data items have changed.
- /// </summary>
- /// <returns type="Boolean">—Returns true if the data items have changed. Otherwise, returns false.</returns>
- },
- indexOf: function(dataItem) {
- /// <summary>
- /// Gets the index of the specified data item.
- /// </summary>
- /// <param name="dataItem" type="kendo.data.ObservableObject" >The target data item.</param>
- /// <returns type="Number">—The index of the specified data item. Returns -1 if the data item is not found.</returns>
- },
- insert: function(index,model) {
- /// <summary>
- /// Inserts a data item in the data source at the specified index.
- /// </summary>
- /// <param name="index" type="Number" >The zero-based index at which the data item will be inserted.</param>
- /// <param name="model" type="Object" >Either a kendo.data.Model instance or a JavaScript object containing the field values.</param>
- /// <returns type="kendo.data.Model">—The data item which is inserted.</returns>
- },
- online: function(value) {
- /// <summary>
- /// Gets or sets the online state of the data source.
- /// </summary>
- /// <param name="value" type="Boolean" >The online state - true for online, false for offline.</param>
- /// <returns type="Boolean">—The current online state - true if online. Otherwise, false.</returns>
- },
- offlineData: function(data) {
- /// <summary>
- /// Gets or sets the offline state of the data source.
- /// </summary>
- /// <param name="data" type="Array" >The array of data items that replace the current offline state of the data source.</param>
- /// <returns type="Array">—An array of JavaScript objects that represent the data items. Changed data items have a __state__ field attached. That field indicates the type of change: "create", "update", or "destroy". Unmodified data items do not have a __state__ field.</returns>
- },
- page: function(page) {
- /// <summary>
- /// Gets or sets the current page.
- /// </summary>
- /// <param name="page" type="Number" >The new page.</param>
- /// <returns type="Number">—The current page.</returns>
- },
- pageSize: function(size) {
- /// <summary>
- /// Gets or sets the current page size.
- /// </summary>
- /// <param name="size" type="Number" >The new page size.</param>
- /// <returns type="Number">—The current page size.</returns>
- },
- pushCreate: function(items) {
- /// <summary>
- /// Appends the specified data items to the data source without marking them as "new". The data source will not sync data items appended via pushCreate.
- /// </summary>
- /// <param name="items" type="Object" >The data item or data items to append to the data source.</param>
- },
- pushDestroy: function(items) {
- /// <summary>
- /// Removes the specified data items from the data source without marking them as "removed". The data source will not sync data items appended via pushDestroy.
- /// </summary>
- /// <param name="items" type="Object" >The data item or data items to remove from the data source.</param>
- },
- pushInsert: function(index,items) {
- /// <summary>
- /// Appends the specified data items to the data source without marking them as "new". The data source will not sync data items appended via pushInsert.
- /// </summary>
- /// <param name="index" type="Number" >The zero-based index at which the data item will be inserted.</param>
- /// <param name="items" type="Object" >The data item or data items to append to the data source.</param>
- },
- pushUpdate: function(items) {
- /// <summary>
- /// Updates the specified data items without marking them as "dirty". The data source will not sync data items appended via pushUpdate. If the data items are not found (using schema.model.id), they will be appended.
- /// </summary>
- /// <param name="items" type="Object" >The data item or data items to update.</param>
- },
- query: function(options) {
- /// <summary>
- /// Executes the specified query over the data items. Makes an HTTP request if bound to a remote service.This method is useful when you need to modify several parameters of the data request at the same time (e.g. filtering and sorting). If you execute filter() and then sort(), the DataSource will make two separate requests. With query(), it will make one request.
- /// </summary>
- /// <param name="options" type="" >The query options which should be applied.</param>
- /// <returns type="Promise">—A promise that will be resolved when the data has been loaded or rejected if an HTTP error occurs.</returns>
- },
- read: function(data) {
- /// <summary>
- /// Reads data items from a remote/custom transport (if the transport option is set) or from a JavaScript array (if the data option is set).
- /// </summary>
- /// <param name="data" type="Object" >Optional data to pass to the remote service. If you need to filter, it is better to use the filter() method or the query() method with a filter parameter.</param>
- /// <returns type="Promise">—A promise that will be resolved when the data has been loaded or rejected if an HTTP error occurs.</returns>
- },
- remove: function(model) {
- /// <summary>
- /// Removes the specified data item from the data source.
- /// </summary>
- /// <param name="model" type="kendo.data.Model" >The data item which should be removed.</param>
- },
- skip: function() {
- /// <summary>
- /// Gets the current skip parameter of the dataSource. The skip parameter indicates the number of data items that should be skipped when a new page is formed.
- /// </summary>
- /// <returns type="Number">—The current skip parameter.</returns>
- },
- sort: function(value) {
- /// <summary>
- /// Gets or sets the sort order which will be applied over the data items.
- /// </summary>
- /// <param name="value" type="Object" >The sort configuration. Accepts the same values as the sort option.</param>
- /// <returns type="Array">—The current sort configuration. Returns undefined instead of an empty array if the DataSource instance has not performed any sorting so far.</returns>
- },
- sync: function() {
- /// <summary>
- /// Saves any data item changes.The sync method will request the remote service if: The transport.create option is set and the data source contains new data items.; The transport.destroy option is set and data items have been removed from the data source. or The transport.update option is set and the data source contains updated data items..
- /// </summary>
- /// <returns type="Promise">—A promise that will be resolved when all sync requests have finished successfully, or rejected if any single request fails.</returns>
- },
- total: function() {
- /// <summary>
- /// Gets the total number of data items. Uses schema.total if the transport.read option is set.
- /// </summary>
- /// <returns type="Number">—The total number of data items. Returns the length of the array returned by the data method if schema.total or transport.read are not set. Returns 0 if the data source was not populated with data items via the read, fetch, or query methods.</returns>
- },
- totalPages: function() {
- /// <summary>
- /// Gets the number of available pages.
- /// </summary>
- /// <returns type="Number">—The available pages.</returns>
- },
- view: function() {
- /// <summary>
- /// Returns the data items which correspond to the current page, filter, sort, and group configuration. Compare with the data method, which will return data items from all pages, if local data binding and paging are used.To ensure that data is available this method should be used within the change event handler or the fetch method.
- /// </summary>
- /// <returns type="kendo.data.ObservableArray">—The data items. Returns groups if the data items are grouped (via the group option or the group method).</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoDataSource = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.DataSource widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.DataSource">The kendo.data.DataSource instance (if present).</returns>
- };
- $.fn.kendoDataSource = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.DataSource widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// accentFoldingFiltering - String
- /// It allows the filtering operation to be performed considering the diacritic characters for specific language.Introduced in the Kendo UI 2019 R1 SP1 (2019.1.220) release.
- ///
- /// aggregate - Array
- /// The aggregates which are calculated when the data source populates with data.The supported aggregates are: "average" - Only for Number.; "count" - String, Number and Date.; "max" - Number and Date.; "min" - Number and Date. or "sum" - Only for Number..
- ///
- /// autoSync - Boolean (default: false)
- /// If set to true, the data source would automatically save any changed data items by calling the sync method. By default, changes are not automatically saved.
- ///
- /// batch - Boolean (default: false)
- /// If set to true, the data source will batch CRUD operation requests. For example, updating two data items would cause one HTTP request instead of two. By default, the data source makes an HTTP request for every CRUD operation.
- ///
- /// data - Array|String
- /// The array of data items which the data source contains. The data source will wrap those items as kendo.data.ObservableObject or kendo.data.Model (if schema.model is set).Can be set to a string value if the schema.type option is set to "xml".
- ///
- /// filter - Array|Object
- /// The filters which are applied over the data items. By default, no filter is applied.
- ///
- /// group - Array|Object
- /// The grouping configuration of the data source. If set, the data items will be grouped when the data source is populated. By default, grouping is not applied.
- ///
- /// inPlaceSort - Boolean (default: false)
- /// If set to true, the original Array used as data will be sorted when sorting operation is performed. This setting supported only with local data, bound to a JavaScript array via the data option.
- ///
- /// offlineStorage - String|Object
- /// The offline storage key or custom offline storage implementation.
- ///
- /// page - Number
- /// The page of data which the data source will return when the view method is invoked or request from the remote service.
- ///
- /// pageSize - Number
- /// The number of data items per page. The property has no default value. Therefore, to use paging, make sure some pageSize value is set.
- ///
- /// schema - Object
- /// The configuration used to parse the remote service response.
- ///
- /// serverAggregates - Boolean (default: false)
- /// If set to true, the data source will leave the aggregate calculation to the remote service. By default, the data source calculates aggregates client-side.For more information and tips about client and server data operations, refer to the introductory article on the DataSource.
- ///
- /// serverFiltering - Boolean (default: false)
- /// If set to true, the data source will leave the filtering implementation to the remote service. By default, the data source performs filtering client-side.By default, the filter is sent to the server following jQuery conventions.For example, the filter { logic: "and", filters: [ { field: "name", operator: "startswith", value: "Jane" } ] } is sent as: filter[logic]: and; filter[filters][0][field]: name; filter[filters][0][operator]: startswith or filter[filters][0][value]: Jane. Use the parameterMap option to send the filter option in a different format.For more information and tips about client and server data operations, refer to the introductory article on the DataSource.
- ///
- /// serverGrouping - Boolean (default: false)
- /// If set to true, the data source will leave the grouping implementation to the remote service. By default, the data source performs grouping client-side.By default, the group is sent to the server following jQuery conventions.For example, the group { field: "category", dir: "desc" } is sent as: group[0][field]: category or group[0][dir]: desc. Use the parameterMap option to send the group option in a different format.For more information and tips about client and server data operations, refer to the introductory article on the DataSource.
- ///
- /// serverPaging - Boolean (default: false)
- /// If set to true, the data source will leave the data item paging implementation to the remote service. By default, the data source performs paging client-side.The following options are sent to the server when server paging is enabled: page - The page of data item to return (1 means the first page).; pageSize - The number of items to return.; skip - The number of data items to skip. or take - The number of data items to return (the same as pageSize).. Use the parameterMap option to send the paging options in a different format.For more information and tips about client and server data operations, refer to the introductory article on the DataSource.
- ///
- /// serverSorting - Boolean (default: false)
- /// If set to true, the data source will leave the data item sorting implementation to the remote service. By default, the data source performs sorting client-side.By default, the sort is sent to the server following jQuery conventions.For example, the sort { field: "age", dir: "desc" } is sent as: sort[0][field]: age or sort[0][dir]: desc. Use the parameterMap option to send the paging options in a different format.For more information and tips about client and server data operations, refer to the introductory article on the DataSource.
- ///
- /// sort - Array|Object
- /// The sort order which will be applied over the data items. By default, the data items are not sorted.
- ///
- /// transport - Object
- /// The configuration used to load and save the data items. A data source is remote or local based on the way it retrieves data items.Remote data sources load and save data items from and to a remote end-point (also known as remote service or server). The transport option describes the remote service configuration - URL, HTTP verb, HTTP headers, and others. The transport option can also be used to implement custom data loading and saving.Local data sources are bound to a JavaScript array via the data option.
- ///
- /// type - String
- /// If set, the data source will use a predefined transport and/or schema.The supported values are: "odata" which supports the OData v.2 protocol; "odata-v4" which partially supports odata version 4 or "signalr".
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.GanttDataSource = function() { };
- kendo.data.GanttDataSource.prototype = {
- taskAllChildren: function(task) {
- /// <summary>
- /// Returns a list of all child tasks. The search is recursive.
- /// </summary>
- /// <param name="task" type="kendo.data.GanttTask" >The parent task. If this parameter is not specified, all Gantt tasks will be returned.</param>
- /// <returns type="Array">—The list of all child tasks.</returns>
- },
- taskChildren: function(task) {
- /// <summary>
- /// Returns a list of all direct child tasks.
- /// </summary>
- /// <param name="task" type="kendo.data.GanttTask" >The parent task. If this parameter is not specified, all root-level tasks will be returned.</param>
- /// <returns type="Array">—The list of all direct child tasks.</returns>
- },
- taskLevel: function(task) {
- /// <summary>
- /// Returns the level of the task in the hierarchy. 0 for root-level tasks.
- /// </summary>
- /// <param name="task" type="kendo.data.GanttTask" >The reference task.</param>
- /// <returns type="Number">—The level of the task in the hierarchy.</returns>
- },
- taskParent: function(task) {
- /// <summary>
- /// Returns the parent task of a certain task.
- /// </summary>
- /// <param name="task" type="kendo.data.GanttTask" >The reference task.</param>
- /// <returns type="kendo.data.GanttTask">—The parent task.</returns>
- },
- taskSiblings: function(task) {
- /// <summary>
- /// Returns a list of all tasks that have the same parent.
- /// </summary>
- /// <param name="task" type="kendo.data.GanttTask" >The reference task.</param>
- /// <returns type="Array">—The list of all tasks with the same parent as the parameter task. If the parameter task is a root-level task, all root-level tasks are returned.</returns>
- },
- taskTree: function(task) {
- /// <summary>
- /// Returns a list of all child Gantt tasks, ordered by their hierarchical index (Depth-First). a parent is collapsed, it's children are not returned.
- /// </summary>
- /// <param name="task" type="kendo.data.GanttTask" >The reference task. If this parameter is specified, the result will be all child tasks of this task, ordered by their hierarchical index.</param>
- /// <returns type="Array">—The list of all child Gantt tasks, ordered by their hierarchical index (Depth-First).</returns>
- },
- update: function(task,taskInfo) {
- /// <summary>
- /// Updates a Gantt task.
- /// </summary>
- /// <param name="task" type="kendo.data.GanttTask" >The task to be updated.</param>
- /// <param name="taskInfo" type="Object" >The new values which will be used to update the task.</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoGanttDataSource = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.GanttDataSource widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.GanttDataSource">The kendo.data.GanttDataSource instance (if present).</returns>
- };
- $.fn.kendoGanttDataSource = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.GanttDataSource widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// schema - Object
- /// The schema configuration of the GanttDataSource.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.GanttDependency = function() { };
- kendo.data.GanttDependency.prototype = {
- define: function(options) {
- /// <summary>
- /// Defines a new GanttDependency type using the provided options.
- /// </summary>
- /// <param name="options" type="" >Describes the configuration options of the new Gantt dependency class.</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoGanttDependency = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.GanttDependency widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.GanttDependency">The kendo.data.GanttDependency instance (if present).</returns>
- };
- $.fn.kendoGanttDependency = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.GanttDependency widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// id - String|Number|Object
- /// The mandatory unique identifier of the dependency.
- ///
- /// predecessorId - String|Number|Object
- /// The mandatory id of the predecessor task.
- ///
- /// successorId - String|Number|Object
- /// The mandatory id of the successor task.
- ///
- /// type - String|Number|Object
- /// The type of the dependency. The type is a value between 0 and 3, representing the four different dependency types: 0 - Finish-Finish; 1 - Finish-Start; 2 - Start-Finish or 3 - Start-Start.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.GanttDependencyDataSource = function() { };
- kendo.data.GanttDependencyDataSource.prototype = {
- dependencies: function(id) {
- /// <summary>
- /// Returns a list of all dependencies for a certain task.
- /// </summary>
- /// <param name="id" type="Object" >The id of the Gantt task based on which the dependencies are filtered.</param>
- /// <returns type="Array">—The list of all task dependencies.</returns>
- },
- predecessors: function(id) {
- /// <summary>
- /// Returns a list of all predecessor dependencies for a certain task.
- /// </summary>
- /// <param name="id" type="Object" >The id of the Gantt task based on which the dependencies are filtered.</param>
- /// <returns type="Array">—The list of all task predecessors.</returns>
- },
- successors: function(id) {
- /// <summary>
- /// Returns a list of all successor dependencies for a certain task.
- /// </summary>
- /// <param name="id" type="Object" >The id of the Gantt task, based on which the dependencies are filtered.</param>
- /// <returns type="Array">—The list of all task successors.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoGanttDependencyDataSource = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.GanttDependencyDataSource widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.GanttDependencyDataSource">The kendo.data.GanttDependencyDataSource instance (if present).</returns>
- };
- $.fn.kendoGanttDependencyDataSource = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.GanttDependencyDataSource widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// schema - Object
- /// The schema configuration of the GanttDependencyDataSource.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.GanttTask = function() { };
- kendo.data.GanttTask.prototype = {
- define: function(options) {
- /// <summary>
- /// Defines a new GanttTask type using the provided options.
- /// </summary>
- /// <param name="options" type="" >Describes the configuration options of the new Gantt task class.</param>
- },
- duration: function() {
- /// <summary>
- /// Returns the Gantt task length in milliseconds.
- /// </summary>
- /// <returns type="Number">—The length of the task.</returns>
- },
- isMilestone: function() {
- /// <summary>
- /// Checks whether the event has zero duration.
- /// </summary>
- /// <returns type="Boolean">—Returns true if the task start is equal to the task end.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoGanttTask = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.GanttTask widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.GanttTask">The kendo.data.GanttTask instance (if present).</returns>
- };
- $.fn.kendoGanttTask = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.GanttTask widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// end - Date
- /// The date at which the Gantt task ends. The end date is mandatory.
- ///
- /// expanded - Boolean (default: true)
- /// If set to true, the task is expanded and the tasks of its child are visible.
- ///
- /// id - String|Number|Object
- /// The mandatory unique identifier of the task.
- ///
- /// orderId - String|Number|Object (default: 0)
- /// The position of the task relative to its sibling tasks.
- ///
- /// parentId - String|Number|Object (default: null)
- /// The id of the parent task. Required for child tasks.
- ///
- /// percentComplete - String|Number|Object (default: 0)
- /// The completion percentage of the task. A value between 0 and 1 representing how much of a task is completed.
- ///
- /// start - Date
- /// The date at which the Gantt task starts. The start date is mandatory.
- ///
- /// summary - Boolean (default: true)
- /// If set to true, the task has child tasks.
- ///
- /// title - String (default: "")
- /// The title of the task which is displayed by the Gantt widget.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.HierarchicalDataSource = function() { };
- kendo.data.HierarchicalDataSource.prototype = {
- filter: function(value) {
- /// <summary>
- /// Gets or sets the filter configuration. It applies the filter to all loaded nodes and creates views from the nodes that match the filter and their parent nodes up to the root of the hierarchy. Currently, nodes that are not loaded are not filtered.
- /// </summary>
- /// <param name="value" type="Object" >The filter configuration. Accepts the same values as the filter option.</param>
- /// <returns type="Object">—The current filter configuration. Returns undefined if the DataSource instance has not performed filtering so far.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoHierarchicalDataSource = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.HierarchicalDataSource widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.HierarchicalDataSource">The kendo.data.HierarchicalDataSource instance (if present).</returns>
- };
- $.fn.kendoHierarchicalDataSource = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.HierarchicalDataSource widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// filter - Array|Object
- /// The filters which are applied over the data items. It applies the filter to all loaded nodes and creates views from the nodes that match the filter and their parent nodes up to the root of the hierarchy. Currently, nodes that are not loaded are not filtered. By default, no filter is applied.
- ///
- /// schema - Object
- /// The schema configuration. See the DataSource.schema configuration for all available options.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.Model = function() { };
- kendo.data.Model.prototype = {
- bind: function() {
- /// <summary>
- /// Attaches a handler to an event. For more information and examples, refer to the bind API reference.
- /// </summary>
- },
- define: function(options) {
- /// <summary>
- /// Defines a new Model type by using the provided options. The returned value inherits from the kendo.data.Model class.
- /// </summary>
- /// <param name="options" type="" >Describes the configuration options of the new model type.</param>
- },
- editable: function(field) {
- /// <summary>
- /// Determines if the specified field is editable or not.
- /// </summary>
- /// <param name="field" type="String" >The field that will be checked.</param>
- /// <returns type="Boolean">—Returns true if the field is editable. Otherwise, returns false.</returns>
- },
- get: function() {
- /// <summary>
- /// Gets the value of the specified field. Inherited from kendo.data.ObservableObject. For more information and examples, refer to the get API reference.
- /// </summary>
- },
- isNew: function() {
- /// <summary>
- /// Checks if the Model is new or not. The id field is used to determine if a model instance is new or existing. If the value of the specified field is equal to the default value that is specified through the fields configuration, the model is considered new.
- /// </summary>
- /// <returns type="Boolean">—Returns true if the field is editable. Otherwise, returns false.</returns>
- },
- set: function() {
- /// <summary>
- /// Sets the value of the specified field. Inherited from kendo.data.ObservableObject. For more information and examples, refer to the set API reference.
- /// </summary>
- },
- toJSON: function() {
- /// <summary>
- /// Creates a plain JavaScript object which contains all fields of the Model. Inherited from kendo.data.ObservableObject. For more information and examples, refer to the toJSON API reference.
- /// </summary>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoModel = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.Model widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.Model">The kendo.data.Model instance (if present).</returns>
- };
- $.fn.kendoModel = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.Model widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.Node = function() { };
- kendo.data.Node.prototype = {
- append: function(model) {
- /// <summary>
- /// Appends a new item to the children data source and initializes it if necessary.
- /// </summary>
- /// <param name="model" type="Object" >The data for the new item.</param>
- },
- level: function() {
- /// <summary>
- /// Gets the current nesting level of the node within the data source.
- /// </summary>
- /// <returns type="Number">—The zero-based level of the node.</returns>
- },
- load: function() {
- /// <summary>
- /// Loads the child nodes in the child data source and supplies the id of the Node to the request.
- /// </summary>
- },
- loaded: function() {
- /// <summary>
- /// Gets or sets the loaded flag of the Node. Setting the loaded flag to false allows the reloading of child items.
- /// </summary>
- },
- parentNode: function() {
- /// <summary>
- /// Gets the parent node.
- /// </summary>
- /// <returns type="kendo.data.Node">—The parent of the node. Returns null if the node is a root node or does not have a parent.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoNode = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.Node widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.Node">The kendo.data.Node instance (if present).</returns>
- };
- $.fn.kendoNode = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.Node widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.ObservableArray = function() { };
- kendo.data.ObservableArray.prototype = {
- bind: function(eventName,handler) {
- /// <summary>
- /// Attaches an event handler for the specified event.
- /// </summary>
- /// <param name="eventName" type="String" >The name of the event.</param>
- /// <param name="handler" type="Function" >The function which will be invoked when the event is fired.</param>
- },
- join: function(separator) {
- /// <summary>
- /// Joins all items of an ObservableArray into a string. An equivalent of Array.prototype.join.
- /// </summary>
- /// <param name="separator" type="String" >Specifies the string to separate each item of the array. If omitted, the array items are separated with a comma (,).</param>
- },
- parent: function() {
- /// <summary>
- /// Gets the parent of the array if such a parent exists.
- /// </summary>
- /// <returns type="kendo.data.ObservableObject">—The parent of the array. Returns undefined if the array is not nested and does not have a parent.</returns>
- },
- pop: function() {
- /// <summary>
- /// Removes the last item from an array and returns that item. An equivalent of Array.prototype.pop.
- /// </summary>
- /// <returns type="Object">—The item which was removed.</returns>
- },
- push: function() {
- /// <summary>
- /// Appends the given items to the array and returns the new length of the array. An equivalent of Array.prototype.push. The new items are wrapped as an ObservableObject if they are complex objects.
- /// </summary>
- /// <returns type="Number">—The new length of the array.</returns>
- },
- slice: function(begin,end) {
- /// <summary>
- /// Returns a single-level deep copy of a portion of an array. An equivalent of Array.prototype.slice. The result of the slice method is not an instance of ObvservableArray—it is a regular JavaScript Array object.
- /// </summary>
- /// <param name="begin" type="Number" >A zero-based index at which the extraction will start.</param>
- /// <param name="end" type="Number" >A zero-based index at which the extraction will end. If end is omitted, slice extracts to the end of the sequence.</param>
- },
- splice: function(index,howMany) {
- /// <summary>
- /// Changes an ObservableArray by adding new items while removing old items. An equivalent of Array.prototype.splice.
- /// </summary>
- /// <param name="index" type="Number" >An index at which the changing of the array will start.</param>
- /// <param name="howMany" type="Number" >An integer which indicates the number of the items for removal. If set to 0, no items will be removed. In this case, you have to specify at least one new item.</param>
- /// <returns type="Array">—Contains the removed items. The result of the splice method is not an instance of ObvservableArray.</returns>
- },
- shift: function() {
- /// <summary>
- /// Removes the first item from an ObvservableArray and returns that item. An equivalent of Array.prototype.shift.
- /// </summary>
- /// <returns type="Object">—The item which was removed.</returns>
- },
- toJSON: function() {
- /// <summary>
- /// Returns a JavaScript Array object which represents the contents of the ObservableArray.
- /// </summary>
- },
- unshift: function() {
- /// <summary>
- /// Adds one or more items to the beginning of an ObservableArray and returns the new length. An equivalent of Array.prototype.unshift.
- /// </summary>
- /// <returns type="Number">—The new length of the array.</returns>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoObservableArray = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.ObservableArray widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.ObservableArray">The kendo.data.ObservableArray instance (if present).</returns>
- };
- $.fn.kendoObservableArray = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.ObservableArray widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.ObservableObject = function() { };
- kendo.data.ObservableObject.prototype = {
- bind: function() {
- /// <summary>
- /// Attaches a handler to an event. For more information and examples, refer to the bind API reference.
- /// </summary>
- },
- get: function(name) {
- /// <summary>
- /// Gets the value of the specified field.
- /// </summary>
- /// <param name="name" type="String" >The name of the field whose value will be returned.</param>
- /// <returns type="Object">—The value of the specified field.</returns>
- },
- parent: function() {
- /// <summary>
- /// Gets the parent of the object if such a parent exists.
- /// </summary>
- /// <returns type="kendo.data.ObservableObject">—The parent of the object. Returns undefined if the object is not nested and does not have a parent.</returns>
- },
- set: function(name,value) {
- /// <summary>
- /// Sets the value of the specified field.
- /// </summary>
- /// <param name="name" type="String" >The name of the field whose value will be returned.</param>
- /// <param name="value" type="Object" >The new value of the field.</param>
- },
- toJSON: function() {
- /// <summary>
- /// Creates a plain JavaScript object which contains all fields of the ObservableObject.
- /// </summary>
- /// <returns type="Object">—Contains only the fields of the ObservableObject.</returns>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoObservableObject = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.ObservableObject widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.ObservableObject">The kendo.data.ObservableObject instance (if present).</returns>
- };
- $.fn.kendoObservableObject = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.ObservableObject widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.PivotDataSource = function() { };
- kendo.data.PivotDataSource.prototype = {
- axes: function() {
- /// <summary>
- /// Gets the parsed axes data.
- /// </summary>
- /// <returns type="Object">—The parsed axes data.</returns>
- },
- catalog: function(name) {
- /// <summary>
- /// Gets or sets the current catalog name.
- /// </summary>
- /// <param name="name" type="String" >The name of the catalog.</param>
- /// <returns type="String">—The current catalog name.</returns>
- },
- columns: function(val) {
- /// <summary>
- /// Gets or sets the columns configuration.
- /// </summary>
- /// <param name="val" type="Array" >The columns configuration. Accepts the same values as the columns option.</param>
- /// <returns type="Array">—The current columns configuration.</returns>
- },
- cube: function(name) {
- /// <summary>
- /// Gets or sets the current cube name.
- /// </summary>
- /// <param name="name" type="String" >The name of the cube.</param>
- /// <returns type="String">—The current cube name.</returns>
- },
- discover: function(options) {
- /// <summary>
- /// Starts the discover request with the specified options.
- /// </summary>
- /// <param name="options" type="String" >The options of the discover request.</param>
- /// <returns type="Object">—The deferred object.</returns>
- },
- expandColumn: function(path) {
- /// <summary>
- /// Expands a column tuple member that has children.
- /// </summary>
- /// <param name="path" type="Array" >The path that uniquely specifies the tuple member that needs to be expanded.</param>
- },
- expandRow: function(path) {
- /// <summary>
- /// Expands a row tuple member that has children.
- /// </summary>
- /// <param name="path" type="Array" >The path which uniquely specifies the tuple member that needs to be expanded.</param>
- },
- measures: function(val) {
- /// <summary>
- /// Gets or sets the measures configuration.
- /// </summary>
- /// <param name="val" type="Array" >The measures configuration. Accepts the same values as the measures option.</param>
- /// <returns type="Array">—The current measures configuration.</returns>
- },
- measuresAxis: function() {
- /// <summary>
- /// Gets the name of the axis on which the measures are displayed.
- /// </summary>
- /// <returns type="String">—The axis name.</returns>
- },
- rows: function(val) {
- /// <summary>
- /// Gets or sets the rows configuration.
- /// </summary>
- /// <param name="val" type="Array" >The rows configuration. Accepts the same values as the row option.</param>
- /// <returns type="Array">—The current rows configuration.</returns>
- },
- schemaCatalogs: function() {
- /// <summary>
- /// Requests the catalogs information.
- /// </summary>
- /// <returns type="Object">—The deferred object.</returns>
- },
- schemaCubes: function() {
- /// <summary>
- /// Requests the cubes schema information.
- /// </summary>
- /// <returns type="Object">—The deferred object.</returns>
- },
- schemaDimensions: function() {
- /// <summary>
- /// Requests the dimensions schema information.
- /// </summary>
- /// <returns type="Object">—The deferred object.</returns>
- },
- schemaHierarchies: function(dimensionName) {
- /// <summary>
- /// Requests the hierarchies schema information.
- /// </summary>
- /// <param name="dimensionName" type="String" >The name of the dimensions which is the "owner" of the hierarchy.</param>
- /// <returns type="Object">—The deferred object.</returns>
- },
- schemaLevels: function(hierarchyName) {
- /// <summary>
- /// Requests the levels schema information.
- /// </summary>
- /// <param name="hierarchyName" type="String" >The name of the hierarchy which is the "owner" of the level.</param>
- /// <returns type="Object">—The deferred object.</returns>
- },
- schemaMeasures: function() {
- /// <summary>
- /// Requests the measures schema information.
- /// </summary>
- /// <returns type="Object">—The deferred object.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoPivotDataSource = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.PivotDataSource widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.PivotDataSource">The kendo.data.PivotDataSource instance (if present).</returns>
- };
- $.fn.kendoPivotDataSource = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.PivotDataSource widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// columns - Array
- /// The configuration of the column axis members. An array of JavaScript objects or strings. A JavaScript objects are interpreted as column descriptors. Strings are interpreted as the hierarchical name of the member.
- ///
- /// measures - Array|Object
- /// The configuration of measures. A string array whose values are interpreted as the name of the measures that will be loaded. Measures can be defined as a list of objects with the name and type fields.
- ///
- /// rows - Array
- /// The configuration of the row axis members. An array of JavaScript objects or strings. A JavaScript objects are interpreted as rows descriptors. Strings are interpreted as the hierarchical name of the member.
- ///
- /// transport - Object
- /// The configuration used to load data items and discover schema information.
- ///
- /// schema - Object
- /// The schema configuration of the PivotDataSource.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.Query = function() { };
- kendo.data.Query.prototype = {
- toArray: function() {
- /// <summary>
- /// Returns the internal data collection
- /// </summary>
- /// <returns type="Array">Returns plain JavaScript array which represents the internal data collection</returns>
- },
- skip: function(count) {
- /// <summary>
- /// Skip a given amount it items
- /// </summary>
- /// <param name="count" type="Number" >The number of items that should be skipped</param>
- /// <returns type="kendo.data.Query">Returns a new instance of kendo.data.Query with the first count elements of the list skipped</returns>
- },
- take: function(count) {
- /// <summary>
- /// Take a given amount it items
- /// </summary>
- /// <param name="count" type="Number" >The number of items that should be taken</param>
- /// <returns type="kendo.data.Query">Returns a new instance of kendo.data.Query containing only the first count elements of the list</returns>
- },
- select: function(selector) {
- /// <summary>
- /// Maps over the data items
- /// </summary>
- /// <param name="selector" type="Function" >A function that is applied to each of the items</param>
- /// <returns type="kendo.data.Query">Returns a new instance of kendo.data.Query containing the mapped collection</returns>
- },
- order: function(selector) {
- /// <summary>
- /// Returns a copy of the list sorted according to the direction
- /// </summary>
- /// <param name="selector" type="" >The current sort configuration.</param>
- /// <returns type="kendo.data.Query">Returns a new instance of kendo.data.Query containing the sorted collection</returns>
- },
- filter: function(expression) {
- /// <summary>
- /// Returns a copy of the list filtered according to the expression
- /// </summary>
- /// <param name="expression" type="Object" >The filter configuration. Accepts the same values as the filter option (check there for more examples).</param>
- /// <returns type="kendo.data.Query">Returns a new instance of kendo.data.Query containing the filtered collection</returns>
- },
- groupBy: function(descriptor) {
- /// <summary>
- /// Returns a copy of the list grouped according to the descriptor
- /// </summary>
- /// <param name="descriptor" type="Object" >The grouping configuration. Accepts the same values as the group option.</param>
- /// <returns type="kendo.data.Query">Returns a new instance of kendo.data.Query containing the grouped collection</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoQuery = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.Query widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.Query">The kendo.data.Query instance (if present).</returns>
- };
- $.fn.kendoQuery = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.Query widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.SchedulerDataSource = function() { };
- kendo.data.SchedulerDataSource.prototype = {
- expand: function(start,end) {
- /// <summary>
- /// Expands all recurring events in the data and returns a list of events for a specific period.
- /// </summary>
- /// <param name="start" type="Date" >The start date of the period.</param>
- /// <param name="end" type="Date" >The end date of the period.</param>
- /// <returns type="Array">the expanded list of scheduler events filtered by the specified start/end period.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoSchedulerDataSource = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.SchedulerDataSource widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.SchedulerDataSource">The kendo.data.SchedulerDataSource instance (if present).</returns>
- };
- $.fn.kendoSchedulerDataSource = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.SchedulerDataSource widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// schema - Object
- /// The schema configuration of the SchedulerDataSource.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.SchedulerEvent = function() { };
- kendo.data.SchedulerEvent.prototype = {
- define: function(options) {
- /// <summary>
- /// Defines a new SchedulerEvent type using the provided options.
- /// </summary>
- /// <param name="options" type="" >Describes the configuration options of the new scheduler event class.</param>
- },
- clone: function(options,updateUid) {
- /// <summary>
- /// Clones the scheduler event.
- /// </summary>
- /// <param name="options" type="Object" >Additional options passed to the SchedulerEvent constructor.</param>
- /// <param name="updateUid" type="Boolean" >If you pass true the uid of the event will be updated.</param>
- /// <returns type="kendo.data.SchedulerEvent">the cloned scheduler event.</returns>
- },
- duration: function() {
- /// <summary>
- /// Returns the scheduler event length in milliseconds.
- /// </summary>
- /// <returns type="Number">the length of the event.</returns>
- },
- expand: function(start,end,timeZoneId) {
- /// <summary>
- /// Expands the event for a specific period based on the recurrenceRule option.
- /// </summary>
- /// <param name="start" type="Date" >The start date of the occurrence period.</param>
- /// <param name="end" type="Date" >The end date of the occurrence period.</param>
- /// <param name="timeZoneId" type="String" >The time zone ID used to convert the recurrence rule dates.</param>
- /// <returns type="Array">list of occurrences.</returns>
- },
- update: function(eventInfo) {
- /// <summary>
- /// Updates the scheduler event.
- /// </summary>
- /// <param name="eventInfo" type="Object" >The new values, which will be used to update the event.</param>
- },
- isMultiDay: function() {
- /// <summary>
- /// Checks whether the event is equal to or longer then twenty four hours.
- /// </summary>
- /// <returns type="Boolean">return true if event is equal to or longer then 24 hours.</returns>
- },
- isException: function() {
- /// <summary>
- /// Checks whether the event is a recurrence exception.
- /// </summary>
- /// <returns type="Boolean">return true if event is a recurrence exception.</returns>
- },
- isOccurrence: function() {
- /// <summary>
- /// Checks whether the event is an occurrence part of a recurring series.
- /// </summary>
- /// <returns type="Boolean">return true if event is an occurrence.</returns>
- },
- isRecurring: function() {
- /// <summary>
- /// Checks whether the event is part of a recurring series.
- /// </summary>
- /// <returns type="Boolean">return true if event is recurring.</returns>
- },
- isRecurrenceHead: function() {
- /// <summary>
- /// Checks whether the event is the head of a recurring series.
- /// </summary>
- /// <returns type="Boolean">return true if event is a recurrence head.</returns>
- },
- toOccurrence: function(options) {
- /// <summary>
- /// Converts the scheduler event to a event occurrence. Method will remove recurrenceRule, recurrenceException options, will add a recurrenceId field and will set id to the default one.
- /// </summary>
- /// <param name="options" type="Object" >Additional options passed to the SchedulerEvent constructor.</param>
- /// <returns type="kendo.data.SchedulerEvent">the occurrence.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoSchedulerEvent = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.SchedulerEvent widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.SchedulerEvent">The kendo.data.SchedulerEvent instance (if present).</returns>
- };
- $.fn.kendoSchedulerEvent = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.SchedulerEvent widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// description - String (default: "")
- /// The optional event description.
- ///
- /// end - Date
- /// The date at which the scheduler event ends. The end date is mandatory.
- ///
- /// endTimezone - String (default: undefined)
- /// The timezone of the end date. If not specified the timezone will be used.The complete list of the supported timezones is available in the List of IANA time zones Wikipedia page.
- ///
- /// id - String|Number|Object
- /// The mandatory unique identifier of the event.
- ///
- /// isAllDay - Boolean (default: false)
- /// If set to true the event is "all day". By default events are not all day.
- ///
- /// recurrenceException - String (default: undefined)
- /// The recurrence exceptions. A list of comma separated dates formatted using the yyyyMMddTHHmmssZ format string.
- ///
- /// recurrenceId - String|Number|Object (default: undefined)
- /// The id of the recurrence parent event. Required for events that are recurrence exceptions.
- ///
- /// recurrenceRule - String (default: undefined)
- /// The recurrence rule describing the recurring pattern of the event. The format follows the iCal specification.
- ///
- /// start - Date
- /// The date at which the scheduler event starts. The start date is mandatory.
- ///
- /// startTimezone - String (default: undefined)
- /// The timezone of the start date. If not specified the timezone will be used.The complete list of the supported timezones is available in the List of IANA time zones Wikipedia page.
- ///
- /// title - String (default: "")
- /// The title of the event which is displayed by the scheduler widget.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.TreeListDataSource = function() { };
- kendo.data.TreeListDataSource.prototype = {
- load: function(model) {
- /// <summary>
- /// Loads the child nodes of a model.
- /// </summary>
- /// <param name="model" type="kendo.data.TreeListModel" >The model that must be loaded.</param>
- /// <returns type="Promise">A promise that will be resolved when the child nodes have been loaded, or rejected if an HTTP error occurs.</returns>
- },
- childNodes: function(model) {
- /// <summary>
- /// Child nodes for model.
- /// </summary>
- /// <param name="model" type="kendo.data.TreeListModel" >The model whose children must be returned.</param>
- /// <returns type="Array">of the child items.</returns>
- },
- rootNodes: function() {
- /// <summary>
- /// Return all root nodes.
- /// </summary>
- /// <returns type="Array">of the root items.</returns>
- },
- parentNode: function(model) {
- /// <summary>
- /// The parent of given node.
- /// </summary>
- /// <param name="model" type="kendo.data.TreeListModel" >The model whose parent must be returned.</param>
- /// <returns type="kendo.data.TreeListModel">parent of the node.</returns>
- },
- level: function(model) {
- /// <summary>
- /// The hierarchical level of the node.
- /// </summary>
- /// <param name="model" type="kendo.data.TreeListModel" >The model whose level must be calculated.</param>
- /// <returns type="Number">the hierarchy level of the node.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoTreeListDataSource = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.TreeListDataSource widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.TreeListDataSource">The kendo.data.TreeListDataSource instance (if present).</returns>
- };
- $.fn.kendoTreeListDataSource = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.TreeListDataSource widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// schema - Object
- /// The schema configuration of the TreeListDataSource.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.data.TreeListModel = function() { };
- kendo.data.TreeListModel.prototype = {
- loaded: function() {
- /// <summary>
- /// Gets or sets the loaded flag of the TreeList. Setting the loaded flag to false allows reloading of child items.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoTreeListModel = function() {
- /// <summary>
- /// Returns a reference to the kendo.data.TreeListModel widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.data.TreeListModel">The kendo.data.TreeListModel instance (if present).</returns>
- };
- $.fn.kendoTreeListModel = function(options) {
- /// <summary>
- /// Instantiates a kendo.data.TreeListModel widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ChartAxis = function() { };
- kendo.dataviz.ChartAxis.prototype = {
- range: function() {
- /// <summary>
- /// Returns an object with the axis minimum and maximum values.
- /// </summary>
- /// <returns type="Object">the object with the min and max values.</returns>
- },
- slot: function(from,to,limit) {
- /// <summary>
- /// Returns a slot based on the specified from and to values.
- /// </summary>
- /// <param name="from" type="Object" >The slot from value.</param>
- /// <param name="to" type="Object" >The slot to value. If a to value is not specified, then the from value will be used.</param>
- /// <param name="limit" type="Boolean" >A boolean value indicating whether the slot should be limited to the current range. By default the range is limited.</param>
- /// <returns type="kendo.geometry.Rect|kendo.geometry.Arc">a rectangle or arc(for radar category and polar x axis) representing the slot.</returns>
- },
- value: function(point) {
- /// <summary>
- /// Returns the value corresponding to the passed surface point.
- /// </summary>
- /// <param name="point" type="kendo.geometry.Point" >The surface point for which the value should be found.</param>
- },
- valueRange: function() {
- /// <summary>
- /// Returns an object with the minimum and maximum point value associated with the axis.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoChartAxis = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ChartAxis widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ChartAxis">The kendo.dataviz.ChartAxis instance (if present).</returns>
- };
- $.fn.kendoChartAxis = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ChartAxis widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ChartPane = function() { };
- kendo.dataviz.ChartPane.prototype = {
- findAxisByName: function(name) {
- /// <summary>
- /// Returns an axis from the pane with the specified name.
- /// </summary>
- /// <param name="name" type="String" >The axis name.</param>
- /// <returns type="kendo.dataviz.ChartAxis">The chart axis.</returns>
- },
- series: function() {
- /// <summary>
- /// Returns an array with the pane series.
- /// </summary>
- /// <returns type="Array">the array holding the pane series.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoChartPane = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ChartPane widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ChartPane">The kendo.dataviz.ChartPane instance (if present).</returns>
- };
- $.fn.kendoChartPane = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ChartPane widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ChartPlotArea = function() { };
- kendo.dataviz.ChartPlotArea.prototype = {
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoChartPlotArea = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ChartPlotArea widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ChartPlotArea">The kendo.dataviz.ChartPlotArea instance (if present).</returns>
- };
- $.fn.kendoChartPlotArea = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ChartPlotArea widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ChartPoint = function() { };
- kendo.dataviz.ChartPoint.prototype = {
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoChartPoint = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ChartPoint widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ChartPoint">The kendo.dataviz.ChartPoint instance (if present).</returns>
- };
- $.fn.kendoChartPoint = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ChartPoint widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ChartSeries = function() { };
- kendo.dataviz.ChartSeries.prototype = {
- data: function(data) {
- /// <summary>
- /// Gets or sets the series data.
- /// </summary>
- /// <param name="data" type="Array" >The series data to be set.</param>
- /// <returns type="Array">the current series data.</returns>
- },
- findPoint: function(callback) {
- /// <summary>
- /// Finds a series point. The method accepts a function which will be called for each point until the function returns true.
- /// </summary>
- /// <param name="callback" type="Function" >The function that will be called with the series points.</param>
- /// <returns type="kendo.dataviz.ChartPoint">the found point.</returns>
- },
- points: function(filter) {
- /// <summary>
- /// Gets or sets the series data.
- /// </summary>
- /// <param name="filter" type="Function" >An optional function that can be used to filter the points.</param>
- /// <returns type="Array">the series points.</returns>
- },
- toggleHighlight: function(show,filter) {
- /// <summary>
- /// Toggles the highlight for the entire series or for specific point(s).
- /// </summary>
- /// <param name="show" type="Boolean" >A value indicating whether the highlight should be shown or hidden.</param>
- /// <param name="filter" type="Object" >A function that will is used to filter the highlighted points or an Array holding the point(s) that should be highlighted.</param>
- },
- toggleVisibility: function(show,filter) {
- /// <summary>
- /// Toggles the visibility for the entire series or for specific point(s).
- /// </summary>
- /// <param name="show" type="Boolean" >A value indicating whether the series or the points should be shown or hidden.</param>
- /// <param name="filter" type="Function" >An optional function that is used to filter the points that should be shown or hidden. The function is passed the point dataItem as argument.</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoChartSeries = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ChartSeries widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ChartSeries">The kendo.dataviz.ChartSeries instance (if present).</returns>
- };
- $.fn.kendoChartSeries = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ChartSeries widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.Navigator = function() { };
- kendo.dataviz.Navigator.prototype = {
- select: function() {
- /// <summary>
- /// Gets or sets the Navigator selected date range.
- /// </summary>
- /// <returns type="Object">An object with two date fields - from and to.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoNavigator = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.Navigator widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.Navigator">The kendo.dataviz.Navigator instance (if present).</returns>
- };
- $.fn.kendoNavigator = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.Navigator widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Circle = function() { };
- kendo.dataviz.diagram.Circle.prototype = {
- position: function(offset) {
- /// <summary>
- /// Get or sets the element position.
- /// </summary>
- /// <param name="offset" type="kendo.dataviz.diagram.Point" >The offset of the element.</param>
- },
- rotate: function(angle,center) {
- /// <summary>
- /// Rotates the element with the specified parameters.
- /// </summary>
- /// <param name="angle" type="Number" >The angle of rotation in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.</param>
- /// <param name="center" type="kendo.dataviz.diagram.Point" >The center of rotation.</param>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the current element.
- /// </summary>
- /// <param name="visible" type="Boolean" >The new visibility state.</param>
- /// <returns type="Boolean">True if the element is visible, false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoCircle = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Circle widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Circle">The kendo.dataviz.diagram.Circle instance (if present).</returns>
- };
- $.fn.kendoCircle = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Circle widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// center - Object
- /// The center of the circle.
- ///
- /// fill - String
- /// Defines the fill options of the circle.
- ///
- /// fill - Object
- /// Defines the fill options of the circle.
- ///
- /// radius - Number
- /// The radius of the circle.
- ///
- /// stroke - Object
- /// Defines the stroke configuration.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Connection = function() { };
- kendo.dataviz.diagram.Connection.prototype = {
- source: function(source) {
- /// <summary>
- /// Gets or sets the current source of the connection.This object can be a Point for a floating endpoint (i.e. not attached to a shape), a Shape or a Connector of a Shape. You can use the Shape.getConnector() method to fetch a Connector on the basis of its name. If a Shape is specified the Connection will attach to the "Auto" connector.
- /// </summary>
- /// <param name="source" type="Object" >Point: any Point on the canvas. This creates an unattached floating endpoint.; Shape: will bind the endpoint to the"Auto" Connector which will switch between the other connectors to minimize the length of the connection. or Connector: the connection's endpoint will remain fixed attached to the specified Connector.. If no source is specified the method will return the current object to which the Connection's endpoint is attached.</param>
- /// <returns type="Object">the connection source.</returns>
- },
- sourcePoint: function() {
- /// <summary>
- /// Gets the global coordinate of the connection's start (initial endpoint). The method returns a Point independently of the object to which the source is attached.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Point">the coordinates of the connection source.</returns>
- },
- target: function(target) {
- /// <summary>
- /// Gets or set the target of the Connection.This object can be a Point for a floating endpoint (i.e. not attached to a shape), a Shape or a Connector of a Shape. You can use the Shape.getConnector() method to fetch a Connector on the basis of its name. If a Shape is specified the Connection will attach to the "Auto" connector.
- /// </summary>
- /// <param name="target" type="Object" >Point: any Point on the canvas. This creates an unattached floating endpoint.; Shape: will bind the endpoint to the"Auto" Connector which will switch between the other connectors to minimize the length of the connection. or Connector: the connection's endpoint will remain fixed attached to the specified Connector.. If no source is specified the method will return the current object to which the Connection's endpoint is attached.</param>
- /// <returns type="Object">the connection target.</returns>
- },
- targetPoint: function() {
- /// <summary>
- /// Similar to the sourcePoint, this gets the coordinates of the target of the Connection independently of its endpoint attachment.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Point">the coordinates of the connection target.</returns>
- },
- select: function(value) {
- /// <summary>
- /// Select or deselects the Connection.
- /// </summary>
- /// <param name="value" type="Boolean" >True to select the Connection and false to deselect it.</param>
- },
- type: function(value) {
- /// <summary>
- /// Gets or sets the (sub-) type of the Connection which defines the way it routes.The routing of a connection is the way that intermediate points of a Connection defines a route. A route is usually defined on the basis of constraints or behaviors. Currently the framework defines a default polyline route (which simply connects the given intermediate points) and a simple rectangular (aka cascading) route. The cascading type is useful when using tree layout and hierarchies; the routed Connection will in this case enhance the representation of the hierarchy and thus reproduce a classic organization diagram.
- /// </summary>
- /// <param name="value" type="String" >"Polyline" - connects the defined intermediate points. See the points() method. or "Cascading" - discards given points and defines a cascading path between the endpoints..</param>
- },
- points: function() {
- /// <summary>
- /// Gets the intermediate points of the connection.
- /// </summary>
- /// <returns type="Array">the intermediate points of the connection.</returns>
- },
- allPoints: function() {
- /// <summary>
- /// Gets all points of the Connection. This is the union of the endpoints and the intermediate points.
- /// </summary>
- /// <returns type="Array">all points of the connection.</returns>
- },
- redraw: function(options) {
- /// <summary>
- /// Redraws the Connection with the given options.
- /// </summary>
- /// <param name="options" type="Object" >The new options for the connection. This object should follow the configuration structure.</param>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the connection visible state.
- /// </summary>
- /// <param name="visible" type="Boolean" >Indicates whether the connection should be visible in the Diagram. If skipped, the method will return the current visible state of the connection.</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoConnection = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Connection widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Connection">The kendo.dataviz.diagram.Connection instance (if present).</returns>
- };
- $.fn.kendoConnection = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Connection widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// content - Object
- /// Defines the label displayed on the connection path.
- ///
- /// fromConnector - String (default: "Auto")
- /// Specifies the name of the source shape connector that should be used by default.
- ///
- /// fromX - Number
- /// The absolute point (X-coordinate), if any, that the connection is originating from.
- ///
- /// fromY - Number
- /// The absolute point (Y-coordinate), if any, that the connection is originating from.
- ///
- /// stroke - Object
- /// Defines the stroke configuration.
- ///
- /// hover - Object
- /// Defines the hover configuration.
- ///
- /// startCap - String
- /// The connection start cap configuration or type name.
- ///
- /// startCap - Object
- /// The connection start cap configuration or type name.
- ///
- /// endCap - String
- /// The connection end cap configuration or type name.
- ///
- /// endCap - Object
- /// The connection end cap configuration or type name.
- ///
- /// points - Array
- /// Sets the intermediate points (in global coordinates) of the connection.
- ///
- /// selectable - Boolean (default: true)
- /// Specifies if the connection can be selected.
- ///
- /// toConnector - String (default: "Auto")
- /// Specifies the name of the target shape connector that should be used by default.
- ///
- /// toX - Number
- /// The absolute point (X-coordinate), if any, that the connection is pointing to.
- ///
- /// toY - Number
- /// The absolute point (Y-coordinate), if any, that the connection is pointing to.
- ///
- /// type - String
- /// Specifies the connection type. The supported values are "polyline" and "cascading".
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Connector = function() { };
- kendo.dataviz.diagram.Connector.prototype = {
- position: function() {
- /// <summary>
- /// Gets the position of the Connector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Point">the current position of the connector.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoConnector = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Connector widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Connector">The kendo.dataviz.diagram.Connector instance (if present).</returns>
- };
- $.fn.kendoConnector = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Connector widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// width - Number (default: 8)
- /// Defines the width of the connector.
- ///
- /// height - Number (default: 8)
- /// Defines the height of the connector.
- ///
- /// hover - Object
- /// Defines the hover configuration.
- ///
- /// fill - String
- /// Defines the fill options of the connector.
- ///
- /// fill - Object
- /// Defines the fill options of the connector.
- ///
- /// stroke - String
- /// Defines the stroke options of the connector.
- ///
- /// stroke - Object
- /// Defines the stroke options of the connector.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Group = function() { };
- kendo.dataviz.diagram.Group.prototype = {
- append: function(element) {
- /// <summary>
- /// Appends the given element to the group
- /// </summary>
- /// <param name="element" type="Object" >The element to append.</param>
- },
- clear: function() {
- /// <summary>
- /// Removes all elements from the group.
- /// </summary>
- },
- remove: function(element) {
- /// <summary>
- /// Removes the given element from the group
- /// </summary>
- /// <param name="element" type="Object" >The element to remove.</param>
- },
- position: function(offset) {
- /// <summary>
- /// Get or sets the element position.
- /// </summary>
- /// <param name="offset" type="kendo.dataviz.diagram.Point" >The origin of the element.</param>
- },
- rotate: function(angle,center) {
- /// <summary>
- /// Rotates the element with the specified parameters.
- /// </summary>
- /// <param name="angle" type="Number" >The angle of rotation in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.</param>
- /// <param name="center" type="kendo.dataviz.diagram.Point" >The center of rotation.</param>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the current element.
- /// </summary>
- /// <param name="visible" type="Boolean" >The new visibility state.</param>
- /// <returns type="Boolean">True if the element is visible, false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoGroup = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Group widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Group">The kendo.dataviz.diagram.Group instance (if present).</returns>
- };
- $.fn.kendoGroup = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Group widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// x - Number
- /// The X position of the top-left corner of the group.
- ///
- /// y - Number
- /// The Y position of the top-left corner of the group.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Image = function() { };
- kendo.dataviz.diagram.Image.prototype = {
- position: function(offset) {
- /// <summary>
- /// Get or sets the element position.
- /// </summary>
- /// <param name="offset" type="kendo.dataviz.diagram.Point" >The origin of the element.</param>
- },
- rotate: function(angle,center) {
- /// <summary>
- /// Rotates the element with the specified parameters.
- /// </summary>
- /// <param name="angle" type="Number" >The angle of rotation in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.</param>
- /// <param name="center" type="kendo.dataviz.diagram.Point" >The center of rotation.</param>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the current element.
- /// </summary>
- /// <param name="visible" type="Boolean" >The new visibility state.</param>
- /// <returns type="Boolean">True if the element is visible, false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoImage = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Image widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Image">The kendo.dataviz.diagram.Image instance (if present).</returns>
- };
- $.fn.kendoImage = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Image widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// height - Number
- /// The height of the image.
- ///
- /// width - Number
- /// The width of the image.
- ///
- /// x - Number
- /// The X position of the top-left corner of the element.
- ///
- /// y - Number
- /// The Y position of the top-left corner of the element.
- ///
- /// source - String
- /// The source URL of the image.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Layout = function() { };
- kendo.dataviz.diagram.Layout.prototype = {
- append: function(element) {
- /// <summary>
- /// Appends the given element to the group
- /// </summary>
- /// <param name="element" type="Object" >The element to append.</param>
- },
- clear: function() {
- /// <summary>
- /// Removes all elements from the group.
- /// </summary>
- },
- rect: function(rect) {
- /// <summary>
- /// Gets or sets the layout rectangle.
- /// </summary>
- /// <param name="rect" type="kendo.dataviz.diagram.Rect" >The layout rectangle.</param>
- /// <returns type="kendo.dataviz.diagram.Rect">The current rectangle.</returns>
- },
- reflow: function() {
- /// <summary>
- /// Arranges the elements based on the current options.
- /// </summary>
- },
- remove: function(element) {
- /// <summary>
- /// Removes the given element from the group
- /// </summary>
- /// <param name="element" type="Object" >The element to remove.</param>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the current element.
- /// </summary>
- /// <param name="visible" type="Boolean" >The new visibility state.</param>
- /// <returns type="Boolean">True if the element is visible, false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoLayout = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Layout widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Layout">The kendo.dataviz.diagram.Layout instance (if present).</returns>
- };
- $.fn.kendoLayout = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Layout widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// alignContent - String (default: "start")
- /// Specifies the alignment of the content.Possible values are: "start"; "center" or "end".
- ///
- /// alignItems - String (default: "start")
- /// Specifies the alignment of the items based on each other.Possible values are: "start"; "center" or "end".
- ///
- /// justifyContent - String (default: "start")
- /// Specifies how should the content be justified.Possible values are: "start"; "center" or "end".
- ///
- /// lineSpacing - Number (default: 0)
- /// Specifies the distance between the lines for wrapped layout.
- ///
- /// spacing - Number (default: 0)
- /// Specifies the distance between the elements.
- ///
- /// orientation - String (default: "horizontal")
- /// Specifies the layout orientation. The supported values are: "horizontal" - the elements are arranged horizontally or "vertical" - the elements are arranged vertically.
- ///
- /// wrap - Boolean (default: true)
- /// Specifies the behavior when the elements size exceeds the rectangle size. If set to true, the elements will be moved to the next "line". If set to false, the layout will be scaled so that the elements fit in the rectangle.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Line = function() { };
- kendo.dataviz.diagram.Line.prototype = {
- position: function(offset) {
- /// <summary>
- /// Get or sets the element position.
- /// </summary>
- /// <param name="offset" type="kendo.dataviz.diagram.Point" >The origin of the element.</param>
- },
- rotate: function(angle,center) {
- /// <summary>
- /// Rotates the element with the specified parameters.
- /// </summary>
- /// <param name="angle" type="Number" >The angle of rotation in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.</param>
- /// <param name="center" type="kendo.dataviz.diagram.Point" >The center of rotation.</param>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the current element.
- /// </summary>
- /// <param name="visible" type="Boolean" >The new visibility state.</param>
- /// <returns type="Boolean">True if the element is visible, false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoLine = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Line widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Line">The kendo.dataviz.diagram.Line instance (if present).</returns>
- };
- $.fn.kendoLine = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Line widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// stroke - Object
- /// Defines the stroke configuration.
- ///
- /// from - Object
- /// The first point of the line.
- ///
- /// to - Object
- /// The second point of the line.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Path = function() { };
- kendo.dataviz.diagram.Path.prototype = {
- data: function(path) {
- /// <summary>
- /// Gets or sets the SVG Path data.
- /// </summary>
- /// <param name="path" type="String" >The new SVG path.</param>
- /// <returns type="String">The current SVG path.</returns>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the current element.
- /// </summary>
- /// <param name="visible" type="Boolean" >The new visibility state.</param>
- /// <returns type="Boolean">True if the element is visible, false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoPath = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Path widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Path">The kendo.dataviz.diagram.Path instance (if present).</returns>
- };
- $.fn.kendoPath = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Path widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// data - String
- /// The SVG Path data. The format follows the standard SVG format.
- ///
- /// endCap - String
- /// The end cap configuration or type name.
- ///
- /// endCap - Object
- /// The end cap configuration or type name.
- ///
- /// fill - String
- /// Defines the fill options of the path.
- ///
- /// fill - Object
- /// Defines the fill options of the path.
- ///
- /// height - Number
- /// Sets the height of the path.
- ///
- /// startCap - String
- /// The start cap configuration or type name.
- ///
- /// startCap - Object
- /// The start cap configuration or type name.
- ///
- /// stroke - Object
- /// Defines the stroke configuration.
- ///
- /// width - Number
- /// Sets the width of the path.
- ///
- /// x - Number
- /// The X position of the top-left corner of the path.
- ///
- /// y - Number
- /// The Y position of the top-left corner of the path.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Point = function() { };
- kendo.dataviz.diagram.Point.prototype = {
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoPoint = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Point widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Point">The kendo.dataviz.diagram.Point instance (if present).</returns>
- };
- $.fn.kendoPoint = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Point widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Polyline = function() { };
- kendo.dataviz.diagram.Polyline.prototype = {
- points: function(points) {
- /// <summary>
- /// Gets or sets the polyline points.
- /// </summary>
- /// <param name="points" type="Array" >The new points.</param>
- /// <returns type="Array">The current points.</returns>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the current element.
- /// </summary>
- /// <param name="visible" type="Boolean" >The new visibility state.</param>
- /// <returns type="Boolean">True if the element is visible, false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoPolyline = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Polyline widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Polyline">The kendo.dataviz.diagram.Polyline instance (if present).</returns>
- };
- $.fn.kendoPolyline = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Polyline widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// endCap - String
- /// The end cap configuration or type name.
- ///
- /// endCap - Object
- /// The end cap configuration or type name.
- ///
- /// fill - String
- /// Defines the fill options of the polyline.
- ///
- /// fill - Object
- /// Defines the fill options of the polyline.
- ///
- /// startCap - String
- /// The start cap configuration or type name.
- ///
- /// startCap - Object
- /// The start cap configuration or type name.
- ///
- /// stroke - Object
- /// Defines the stroke configuration.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Rect = function() { };
- kendo.dataviz.diagram.Rect.prototype = {
- position: function(offset) {
- /// <summary>
- /// Get or sets the element position.
- /// </summary>
- /// <param name="offset" type="kendo.dataviz.diagram.Point" >The origin of the element.</param>
- },
- rotate: function(angle,center) {
- /// <summary>
- /// Rotates the element with the specified parameters.
- /// </summary>
- /// <param name="angle" type="Number" >The angle of rotation in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.</param>
- /// <param name="center" type="kendo.dataviz.diagram.Point" >The center of rotation.</param>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the current element.
- /// </summary>
- /// <param name="visible" type="Boolean" >The new visibility state.</param>
- /// <returns type="Boolean">True if the element is visible, false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoRect = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Rect widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Rect">The kendo.dataviz.diagram.Rect instance (if present).</returns>
- };
- $.fn.kendoRect = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Rect widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// height - Number
- /// Sets the height of the rectangle.
- ///
- /// width - Number
- /// Sets the width of the rectangle.
- ///
- /// x - Number
- /// The x-coordinate of the top-left corner of the rectangle.
- ///
- /// y - Number
- /// The y-coordinate of the top-left corner of the rectangle.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Rectangle = function() { };
- kendo.dataviz.diagram.Rectangle.prototype = {
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the current element.
- /// </summary>
- /// <param name="visible" type="Boolean" >The new visibility state.</param>
- /// <returns type="Boolean">True if the element is visible, false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoRectangle = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Rectangle widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Rectangle">The kendo.dataviz.diagram.Rectangle instance (if present).</returns>
- };
- $.fn.kendoRectangle = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Rectangle widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// fill - String
- /// Defines the fill options of the rectangle.
- ///
- /// fill - Object
- /// Defines the fill options of the rectangle.
- ///
- /// height - Number
- /// Sets the height of the rectangle.
- ///
- /// stroke - Object
- /// Defines the stroke configuration.
- ///
- /// width - Number
- /// Sets the width of the rectangle.
- ///
- /// x - Number
- /// The X position of the top-left corner of the rectangle.
- ///
- /// y - Number
- /// The Y position of the top-left corner of the rectangle.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.Shape = function() { };
- kendo.dataviz.diagram.Shape.prototype = {
- position: function(point) {
- /// <summary>
- /// Get or set method returning the current global position or sets the position specified.
- /// </summary>
- /// <param name="point" type="kendo.dataviz.diagram.Point" >Either the location to set or if no parameter given returns the current location.</param>
- },
- clone: function() {
- /// <summary>
- /// Returns a clone (with a different id) of the shape.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Shape">A clone of the current shape.</returns>
- },
- connections: function(type) {
- /// <summary>
- /// Returns the connections attached to the shape. You can optionally specify to return only the incoming or outgoing connections.
- /// </summary>
- /// <param name="type" type="String" >If not parameter specified all connections are returned, if "in" then only the incoming (i.e. towards the shape) are returned, if "out" the only the outgoing (i.e. away from the shape) are returned.</param>
- },
- getConnector: function(name) {
- /// <summary>
- /// Fetches a (default or custom) Connector defined on the Shape by its name.
- /// </summary>
- /// <param name="name" type="String" >The name of the connector to get from the shape.</param>
- },
- getPosition: function(side) {
- /// <summary>
- /// Returns the middle positions of the sides of the bounds or the center of the shape's bounds. This method is useful when defining custom connectors where a position function relative to the shape's coordinate system is required.
- /// </summary>
- /// <param name="side" type="String" >One of the four sides of a bound; "left", "right", "top", "bottom". If none specified the center of the shape's bounds will be returned.</param>
- },
- redraw: function(options) {
- /// <summary>
- /// Renders the shape with the given options. It redefines the options and redraws the shape accordingly.
- /// </summary>
- /// <param name="options" type="Object" >The object containing a subset of options to change. Follows the same structure as the configuration.</param>
- },
- redrawVisual: function() {
- /// <summary>
- /// Redraws the shape visual element and its content
- /// </summary>
- },
- select: function(value) {
- /// <summary>
- /// Selects or deselects the shape.
- /// </summary>
- /// <param name="value" type="Boolean" >Use 'true' to select the shape or 'false' to deselect it.</param>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the shape visible state.
- /// </summary>
- /// <param name="visible" type="Boolean" >Indicates whether the shape should be visible in the Diagram. If skipped, the method will return the current visible state of the shape.</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoShape = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.Shape widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Shape">The kendo.dataviz.diagram.Shape instance (if present).</returns>
- };
- $.fn.kendoShape = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.Shape widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// id - String
- /// The unique identifier for a Shape.
- ///
- /// editable - Boolean (default: true)
- /// Defines the shape editable options.
- ///
- /// editable - Object (default: true)
- /// Defines the shape editable options.
- ///
- /// path - String
- /// The path option of a Shape is a description of a custom geometry. The format follows the standard SVG format (http://www.w3.org/TR/SVG/paths.html#PathData "SVG Path data.").
- ///
- /// stroke - Object
- /// Defines the stroke configuration.
- ///
- /// type - String (default: "rectangle")
- /// Specifies the type of the Shape using any of the built-in shape type. "rectangle": this is the default option, representing a SVG Rectangle or "circle" : a SVG circle/ellipse.
- ///
- /// x - Number (default: 0)
- /// Defines the x-coordinate of the shape when added to the diagram.
- ///
- /// y - Number (default: 0)
- /// Defines the y-coordinate of the shape when added to the diagram.
- ///
- /// minWidth - Number (default: 20)
- /// Defines the minimum width the shape should have, i.e. it cannot be resized to a value smaller than the given one.
- ///
- /// minHeight - Number (default: 20)
- /// Defines the minimum height the shape should have, i.e. it cannot be resized to a value smaller than the given one.
- ///
- /// width - Number (default: 100)
- /// Defines the width of the shape when added to the diagram.
- ///
- /// height - Number (default: 100)
- /// Defines the height of the shape when added to the diagram.
- ///
- /// fill - String
- /// Defines the fill options of the shape.
- ///
- /// fill - Object
- /// Defines the fill options of the shape.
- ///
- /// hover - Object
- /// Defines the hover configuration.
- ///
- /// connectors - Array
- /// Defines the connectors the shape owns.
- ///
- /// rotation - Object
- /// The shape rotation settings.
- ///
- /// content - Object
- /// Defines the shapes content settings.
- ///
- /// selectable - Boolean (default: true)
- /// Specifies if the shape can be selected.
- ///
- /// visual - Function
- /// A function returning a visual element to render for this shape.
- ///
- /// connectorDefaults - Object
- /// Defines default options for the shape connectors.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.diagram.TextBlock = function() { };
- kendo.dataviz.diagram.TextBlock.prototype = {
- content: function(content) {
- /// <summary>
- /// Gets or sets the text block content.
- /// </summary>
- /// <param name="content" type="String" >The new text content.</param>
- /// <returns type="String">the current text content.</returns>
- },
- position: function(offset) {
- /// <summary>
- /// Get or sets the element position.
- /// </summary>
- /// <param name="offset" type="kendo.dataviz.diagram.Point" >The origin of the element.</param>
- },
- rotate: function(angle,center) {
- /// <summary>
- /// Rotates the element with the specified parameters.
- /// </summary>
- /// <param name="angle" type="Number" >The angle of rotation in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.</param>
- /// <param name="center" type="kendo.dataviz.diagram.Point" >The center of rotation.</param>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the current element.
- /// </summary>
- /// <param name="visible" type="Boolean" >The new visibility state.</param>
- /// <returns type="Boolean">True if the element is visible, false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoTextBlock = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.diagram.TextBlock widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.TextBlock">The kendo.dataviz.diagram.TextBlock instance (if present).</returns>
- };
- $.fn.kendoTextBlock = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.diagram.TextBlock widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// color - String
- /// The text color of the text block.
- ///
- /// fontFamily - String
- /// The font family of the text block.
- ///
- /// fontSize - Number
- /// The font size of the text block.
- ///
- /// fontStyle - String
- /// The font style of the text block.
- ///
- /// fontWeight - String
- /// The font weight of the text block.
- ///
- /// height - Number
- /// The height of the text block.
- ///
- /// text - String
- /// The content of the text block.
- ///
- /// width - Number
- /// The width of the text block.
- ///
- /// x - Number
- /// The X position of the top-left corner of the text block.
- ///
- /// y - Number
- /// The Y position of the top-left corner of the text block.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.map.BingLayer = function() { };
- kendo.dataviz.map.BingLayer.prototype = {
- show: function() {
- /// <summary>
- /// Shows the layer, if not visible.
- /// </summary>
- },
- hide: function() {
- /// <summary>
- /// Hides the layer, if visible.
- /// </summary>
- },
- imagerySet: function() {
- /// <summary>
- /// Sets the preferred imagery set for the map.Available imagery sets: * "aerial" - Aerial imagery. * "aerialWithLabels" - Aerial imagery with a road overlay. * "road" - Roads without additional imagery.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoBingLayer = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.map.BingLayer widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.map.BingLayer">The kendo.dataviz.map.BingLayer instance (if present).</returns>
- };
- $.fn.kendoBingLayer = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.map.BingLayer widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// baseUrl - String (default: "//dev.virtualearth.net/REST/v1/Imagery/Metadata/")
- /// The Bing API end-point.
- ///
- /// imagerySet - String (default: "road")
- /// The default imagery set of the map.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.map.Extent = function() { };
- kendo.dataviz.map.Extent.prototype = {
- contains: function(location) {
- /// <summary>
- /// Tests if a location is contained within the extent.
- /// </summary>
- /// <param name="location" type="kendo.dataviz.map.Location" >The location to test for.</param>
- /// <returns type="Boolean">true if the extent contains the location, false otherwise.</returns>
- },
- containsAny: function(locations) {
- /// <summary>
- /// Tests if any of the locations is contained within the extent.
- /// </summary>
- /// <param name="locations" type="Array" >An array of locations to test for.</param>
- /// <returns type="Boolean">true if the extent contains any of the locations, false otherwise.</returns>
- },
- center: function() {
- /// <summary>
- /// Returns the center of the extent.
- /// </summary>
- /// <returns type="kendo.dataviz.map.Location">The extent center location.</returns>
- },
- include: function(location) {
- /// <summary>
- /// Grows the extent, if required, to contain the specified location.
- /// </summary>
- /// <param name="location" type="kendo.dataviz.map.Location" >The location to include in the extent.</param>
- },
- includeAll: function(locations) {
- /// <summary>
- /// Grows the extent, if required, to contain all specified locations.
- /// </summary>
- /// <param name="locations" type="Array" >The locations to include in the extent.</param>
- },
- edges: function() {
- /// <summary>
- /// Returns the four extreme locations of the extent.
- /// </summary>
- /// <returns type="Object">An object with nw, ne, se and sw locations.</returns>
- },
- toArray: function() {
- /// <summary>
- /// Returns the four extreme locations of the extent as an array.
- /// </summary>
- /// <returns type="Array">An array with [NW, NE, SE, SW] locations.</returns>
- },
- overlaps: function(extent) {
- /// <summary>
- /// Tests if the given extent overlaps with this instance.
- /// </summary>
- /// <param name="extent" type="kendo.dataviz.map.Extent" >The extent to test with.</param>
- /// <returns type="Boolean">true if the extents overlap, false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoExtent = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.map.Extent widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.map.Extent">The kendo.dataviz.map.Extent instance (if present).</returns>
- };
- $.fn.kendoExtent = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.map.Extent widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.map.Layer = function() { };
- kendo.dataviz.map.Layer.prototype = {
- show: function() {
- /// <summary>
- /// Shows the layer, if not visible.
- /// </summary>
- },
- hide: function() {
- /// <summary>
- /// Hides the layer, if visible.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoLayer = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.map.Layer widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.map.Layer">The kendo.dataviz.map.Layer instance (if present).</returns>
- };
- $.fn.kendoLayer = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.map.Layer widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.map.Location = function() { };
- kendo.dataviz.map.Location.prototype = {
- clone: function() {
- /// <summary>
- /// Creates a new instance with the same coordinates.
- /// </summary>
- /// <returns type="kendo.dataviz.map.Location">The new Location instance.</returns>
- },
- destination: function(destination,bearing) {
- /// <summary>
- /// Calculates the great-circle distance to the given destination in meters.
- /// </summary>
- /// <param name="destination" type="kendo.dataviz.map.Location" >The destination location.</param>
- /// <param name="bearing" type="Number" >The bearing to the destination in decimal degrees.</param>
- /// <returns type="Number">The distance to the specified location in meters.</returns>
- },
- distanceTo: function(distance,bearing) {
- /// <summary>
- /// Finds a destination at the given distance and bearing from this location.
- /// </summary>
- /// <param name="distance" type="Number" >The distance to the destination in meters.</param>
- /// <param name="bearing" type="Number" >The initial bearing to the destination in decimal degrees.</param>
- /// <returns type="kendo.dataviz.map.Location">The destination at the given distance and bearing.</returns>
- },
- equals: function(location) {
- /// <summary>
- /// Compares this location with another instance.
- /// </summary>
- /// <param name="location" type="kendo.dataviz.map.Location" >The location to compare with.</param>
- /// <returns type="Boolean">true if the location coordinates match; false otherwise.</returns>
- },
- round: function(digits) {
- /// <summary>
- /// Rounds the location coordinates to the specified number of fractional digits.
- /// </summary>
- /// <param name="digits" type="Number" >Number of fractional digits.</param>
- /// <returns type="kendo.dataviz.map.Location">The current Location instance.</returns>
- },
- toArray: function() {
- /// <summary>
- /// Returns the location coordinates as an [lat, lng] array.
- /// </summary>
- /// <returns type="Array">An array representation of the location, e.g. [39, -179]</returns>
- },
- toString: function() {
- /// <summary>
- /// Returns the location coordinates formatted as '{lat},{lng}'.
- /// </summary>
- /// <returns type="String">A string representation of the location, e.g. "39,-179"</returns>
- },
- wrap: function() {
- /// <summary>
- /// Wraps the latitude and longitude to fit into the [0, 90] and [0, 180] range.
- /// </summary>
- /// <returns type="kendo.dataviz.map.Location">The current Location instance.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoLocation = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.map.Location widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.map.Location">The kendo.dataviz.map.Location instance (if present).</returns>
- };
- $.fn.kendoLocation = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.map.Location widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.map.Marker = function() { };
- kendo.dataviz.map.Marker.prototype = {
- location: function(location) {
- /// <summary>
- /// Gets or sets the Marker location.
- /// </summary>
- /// <param name="location" type="Object" >The marker location on the map. Coordinates are listed as [Latitude, Longitude].</param>
- /// <returns type="kendo.dataviz.map.Location">The current location of the Marker</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoMarker = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.map.Marker widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.map.Marker">The kendo.dataviz.map.Marker instance (if present).</returns>
- };
- $.fn.kendoMarker = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.map.Marker widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// location - Array|kendo.dataviz.map.Location
- /// The marker location on the map. Coordinates are listed as [Latitude, Longitude].
- ///
- /// shape - String (default: "pinTarget")
- /// The marker shape. The following pre-defined marker shapes are available: pinTarget or pin. Marker shapes are implemented as CSS classes on the marker element (span.k-marker). For example "pinTarget" is rendered as "k-i-marker-pin-target".
- ///
- /// title - String (default: "pinTarget")
- /// The marker title. Displayed as browser tooltip.
- ///
- /// tooltip - Object
- /// Kendo UI Tooltip options for this marker.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.map.MarkerLayer = function() { };
- kendo.dataviz.map.MarkerLayer.prototype = {
- add: function(marker) {
- /// <summary>
- /// Adds a Marker to the layer.
- /// </summary>
- /// <param name="marker" type="kendo.dataviz.map.Marker" >The Marker instance to add.</param>
- },
- clear: function() {
- /// <summary>
- /// Clears all Markers from the layer.
- /// </summary>
- },
- hide: function() {
- /// <summary>
- /// Hides the layer, if visible.
- /// </summary>
- },
- remove: function(marker) {
- /// <summary>
- /// Removes a Marker from the layer.
- /// </summary>
- /// <param name="marker" type="kendo.dataviz.map.Marker" >The Marker instance to remove.</param>
- },
- setDataSource: function(dataSource) {
- /// <summary>
- /// Sets the data source of this layer.
- /// </summary>
- /// <param name="dataSource" type="Object" >A live DataSource instance or its configuration object.</param>
- },
- show: function() {
- /// <summary>
- /// Shows the layer, if not visible.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoMarkerLayer = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.map.MarkerLayer widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.map.MarkerLayer">The kendo.dataviz.map.MarkerLayer instance (if present).</returns>
- };
- $.fn.kendoMarkerLayer = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.map.MarkerLayer widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.map.ShapeLayer = function() { };
- kendo.dataviz.map.ShapeLayer.prototype = {
- show: function() {
- /// <summary>
- /// Shows the layer, if not visible.
- /// </summary>
- },
- hide: function() {
- /// <summary>
- /// Hides the layer, if visible.
- /// </summary>
- },
- setDataSource: function() {
- /// <summary>
- /// Sets the data source of this layer.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoShapeLayer = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.map.ShapeLayer widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.map.ShapeLayer">The kendo.dataviz.map.ShapeLayer instance (if present).</returns>
- };
- $.fn.kendoShapeLayer = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.map.ShapeLayer widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.map.TileLayer = function() { };
- kendo.dataviz.map.TileLayer.prototype = {
- show: function() {
- /// <summary>
- /// Shows the layer, if not visible.
- /// </summary>
- },
- hide: function() {
- /// <summary>
- /// Hides the layer, if visible.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoTileLayer = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.map.TileLayer widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.map.TileLayer">The kendo.dataviz.map.TileLayer instance (if present).</returns>
- };
- $.fn.kendoTileLayer = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.map.TileLayer widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// urlTemplate - String
- /// The URL template for tile layer. Template variables: x - X coordinate of the tile; y - Y coordinate of the tile; zoom - zoom level or subdomain - Subdomain for this tile.
- ///
- /// subdomains - Array
- /// A list of sub-domains to use for loading tiles. Alternating between different subdomains allows more requests to be executed in parallel.
- ///
- /// tileSize - Number (default: 256)
- /// The tile size in pixels.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ui.ArcGauge = function() { };
- kendo.dataviz.ui.ArcGauge.prototype = {
- destroy: function() {
- /// <summary>
- /// Prepares the Gauge for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
- /// </summary>
- },
- exportImage: function(options) {
- /// <summary>
- /// Exports the Gauge as an image. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PNG image encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Parameters for the exported image.</param>
- /// <returns type="Promise">A promise that will be resolved with a PNG image encoded as a Data URI.</returns>
- },
- exportPDF: function(options) {
- /// <summary>
- /// Exports the Gauge as a PDF file. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PDF file encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="kendo.drawing.PDFOptions" >Parameters for the exported PDF file.</param>
- /// <returns type="Promise">A promise that will be resolved with a PDF file encoded as a Data URI.</returns>
- },
- exportSVG: function(options) {
- /// <summary>
- /// Exports the Gauge as an SVG document. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a SVG document encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Export options.</param>
- /// <returns type="Promise">A promise that will be resolved with a SVG document encoded as a Data URI.</returns>
- },
- redraw: function() {
- /// <summary>
- /// Redraws the gauge.
- /// </summary>
- },
- resize: function(force) {
- /// <summary>
- /// Adjusts the widget layout to match the size of the container.
- /// </summary>
- /// <param name="force" type="Boolean" >Defines whether the widget should proceed with resizing even if the element dimensions have not changed.</param>
- },
- setOptions: function(options) {
- /// <summary>
- /// Sets the current gauge options.
- /// </summary>
- /// <param name="options" type="Object" >The gauge settings to update.</param>
- },
- svg: function() {
- /// <summary>
- /// Returns the SVG representation of the gauge. The returned string is a self-contained SVG document that can be used as is or converted to other formats using tools like Inkscape andImageMagick. Both programs provide command-line interface suitable for server-side processing.
- /// </summary>
- },
- imageDataURL: function() {
- /// <summary>
- /// Returns a PNG image of the gauge encoded as a Data URL.
- /// </summary>
- /// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
- },
- value: function() {
- /// <summary>
- /// Gets or sets the value of the gauge.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoArcGauge = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ui.ArcGauge widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ui.ArcGauge">The kendo.dataviz.ui.ArcGauge instance (if present).</returns>
- };
- $.fn.kendoArcGauge = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ui.ArcGauge widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// centerTemplate - String|Function
- /// The label template. Template variables: * value - the value
- ///
- /// color - String
- /// The color of the value pointer. Accepts a valid CSS color string, including hex and rgb.
- ///
- /// colors - Array
- /// The color ranges of the value pointer. The pointer color will be set to the color from the range that contains the current value.
- ///
- /// gaugeArea - Object
- /// The gauge area configuration options. This is the entire visible area of the gauge.
- ///
- /// opacity - Number
- /// The opacity of the value pointer.
- ///
- /// renderAs - String
- /// Sets the preferred rendering engine. If it is not supported by the browser, the Gauge will switch to the first available mode.The supported values are: "svg" - renders the widget as inline SVG document, if available or "canvas" - renders the widget as a Canvas element, if available..
- ///
- /// scale - Object
- /// Configures the scale.
- ///
- /// theme - String
- /// The gauge theme. This can be either a built-in theme or "sass". When set to "sass" the gauge will read the variables from the Sass-based themes.The supported values are: "sass" - special value, see notes; "black"; "blueopal"; "bootstrap"; "default"; "highcontrast"; "metro"; "metroblack"; "moonlight"; "silver" or "uniform".
- ///
- /// transitions - Boolean (default: true)
- /// A value indicating if transition animations should be played.
- ///
- /// value - Number
- /// The gauge value.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ui.Barcode = function() { };
- kendo.dataviz.ui.Barcode.prototype = {
- exportImage: function(options) {
- /// <summary>
- /// Exports the barcode as an image. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PNG image encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Parameters for the exported image.</param>
- /// <returns type="Promise">A promise that will be resolved with a PNG image encoded as a Data URI.</returns>
- },
- exportPDF: function(options) {
- /// <summary>
- /// Exports the barcode as a PDF file. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PDF file encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="kendo.drawing.PDFOptions" >Parameters for the exported PDF file.</param>
- /// <returns type="Promise">A promise that will be resolved with a PDF file encoded as a Data URI.</returns>
- },
- exportSVG: function(options) {
- /// <summary>
- /// Exports the barcode as an SVG document. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a SVG document encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Export options.</param>
- /// <returns type="Promise">A promise that will be resolved with a SVG document encoded as a Data URI.</returns>
- },
- imageDataURL: function() {
- /// <summary>
- /// Returns a PNG image of the barcode encoded as a Data URL.
- /// </summary>
- /// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
- },
- redraw: function() {
- /// <summary>
- /// Redraws the barcode.
- /// </summary>
- },
- resize: function(force) {
- /// <summary>
- /// Adjusts the widget layout to match the size of the container.
- /// </summary>
- /// <param name="force" type="Boolean" >Defines whether the widget should proceed with resizing even if the element dimensions have not changed.</param>
- },
- svg: function() {
- /// <summary>
- /// Returns the SVG representation of the barcode. The returned string is a self-contained SVG document that can be used as is or converted to other formats using tools like Inkscape andImageMagick. Both programs provide command-line interface suitable for server-side processing.
- /// </summary>
- /// <returns type="String">the SVG representation of the barcode.</returns>
- },
- value: function(value) {
- /// <summary>
- /// Gets/Sets the value of the barcode.
- /// </summary>
- /// <param name="value" type="Object" >The value to set.</param>
- /// <returns type="String">The value of the barcode.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoBarcode = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ui.Barcode widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ui.Barcode">The kendo.dataviz.ui.Barcode instance (if present).</returns>
- };
- $.fn.kendoBarcode = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ui.Barcode widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// renderAs - String (default: "svg")
- /// Sets the preferred rendering engine. If it is not supported by the browser, the Barcode will switch to the first available mode.The supported values are: "canvas" - renders the widget as a Canvas element, if available. or "svg" - renders the widget as inline SVG document, if available.
- ///
- /// background - String (default: "white")
- /// The background of the barcode area. Any valid CSS color string will work here, including hex and rgb.
- ///
- /// border - Object
- /// The border of the barcode area.
- ///
- /// checksum - Boolean (default: false)
- /// If set to true, the Barcode will display the checksum digit next to the value in the text area.
- ///
- /// color - String (default: "black")
- /// The color of the bar elements. Any valid CSS color string will work here, including hex and rgb.
- ///
- /// height - Number (default: 100)
- /// The height of the barcode in pixels. By default the height is 100.
- ///
- /// padding - Object
- /// The padding of the barcode.
- ///
- /// text - Object
- /// Can be set to a JavaScript object which represents the text configuration.
- ///
- /// type - String (default: "code39")
- /// The symbology (encoding) the barcode will use.The supported values are: EAN8; EAN13; UPCE; UPCA; Code11; Code39; Code39Extended; Code93; Code93Extended; Code128; Code128A; Code128B; Code128C; GS1-128; MSImod10; MSImod11; MSImod1010; MSImod1110 or POSTNET.
- ///
- /// value - String
- /// The initial value of the Barcode
- ///
- /// width - Number (default: 300)
- /// The width of the barcode in pixels. By default the width is 300.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ui.Chart = function() { };
- kendo.dataviz.ui.Chart.prototype = {
- destroy: function() {
- /// <summary>
- /// Prepares the widget for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
- /// </summary>
- },
- exportImage: function(options) {
- /// <summary>
- /// Exports the chart as an image. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PNG image encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Parameters for the exported image.</param>
- /// <returns type="Promise">A promise that will be resolved with a PNG image encoded as a Data URI.</returns>
- },
- exportPDF: function(options) {
- /// <summary>
- /// Exports the chart as a PDF file. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PDF file encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="kendo.drawing.PDFOptions" >Parameters for the exported PDF file.</param>
- /// <returns type="Promise">A promise that will be resolved with a PDF file encoded as a Data URI.</returns>
- },
- exportSVG: function(options) {
- /// <summary>
- /// Exports the chart as an SVG document. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a SVG document encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Export options.</param>
- /// <returns type="Promise">A promise that will be resolved with a SVG document encoded as a Data URI.</returns>
- },
- findAxisByName: function(name) {
- /// <summary>
- /// An alias for the existing getAxis method.
- /// </summary>
- /// <param name="name" type="String" >The axis name.</param>
- /// <returns type="kendo.dataviz.ChartAxis">The chart axis.</returns>
- },
- findPaneByIndex: function(index) {
- /// <summary>
- /// Returns a pane with specific index.
- /// </summary>
- /// <param name="index" type="Number" >The pane index.</param>
- /// <returns type="kendo.dataviz.ChartPane">The chart pane.</returns>
- },
- findPaneByName: function(name) {
- /// <summary>
- /// Returns a pane with specific name.
- /// </summary>
- /// <param name="name" type="String" >The pane name.</param>
- /// <returns type="kendo.dataviz.ChartPane">The chart pane.</returns>
- },
- findSeries: function(callback) {
- /// <summary>
- /// Returns a series determined from the passed function. The function is called with the options of each series until it returns true.
- /// </summary>
- /// <param name="callback" type="Function" >The function that will be called for each series.</param>
- /// <returns type="kendo.dataviz.ChartSeries">The chart series.</returns>
- },
- findSeriesByIndex: function(index) {
- /// <summary>
- /// Returns a series with specific index.
- /// </summary>
- /// <param name="index" type="Number" >The series index.</param>
- /// <returns type="kendo.dataviz.ChartSeries">The chart series.</returns>
- },
- findSeriesByName: function(name) {
- /// <summary>
- /// Returns a series with specific name.
- /// </summary>
- /// <param name="name" type="String" >The series name.</param>
- /// <returns type="kendo.dataviz.ChartSeries">The chart series.</returns>
- },
- getAxis: function(name) {
- /// <summary>
- /// Returns an axis with specific name.
- /// </summary>
- /// <param name="name" type="String" >The axis name.</param>
- /// <returns type="kendo.dataviz.ChartAxis">The chart axis.</returns>
- },
- hideTooltip: function() {
- /// <summary>
- /// Hides the chart tooltip.
- /// </summary>
- },
- plotArea: function() {
- /// <summary>
- /// Returns the chart plotArea.
- /// </summary>
- /// <returns type="kendo.dataviz.ChartPlotArea">The chart plot area.</returns>
- },
- redraw: function() {
- /// <summary>
- /// Repaints the chart using the currently loaded data.
- /// </summary>
- },
- refresh: function() {
- /// <summary>
- /// Reloads the data and renders the chart.
- /// </summary>
- },
- resize: function(force) {
- /// <summary>
- /// Adjusts the chart layout to match the size of the container.
- /// </summary>
- /// <param name="force" type="Boolean" >Defines whether the widget should proceed with resizing even if the element dimensions have not changed.</param>
- },
- saveAsPDF: function() {
- /// <summary>
- /// Saves the Chart as a PDF file using the options specified in options.pdf.
- /// </summary>
- },
- setDataSource: function(dataSource) {
- /// <summary>
- /// Sets the data source of the widget.
- /// </summary>
- /// <param name="dataSource" type="kendo.data.DataSource" >The data source to which the widget should be bound.</param>
- },
- setOptions: function(options) {
- /// <summary>
- /// Sets the widget options. Changes are cumulative.
- /// </summary>
- /// <param name="options" type="Object" >The chart settings to update.</param>
- },
- showTooltip: function(filter) {
- /// <summary>
- /// Shows the chart tooltip for specific point or the shared tooltip for specific category. The method accepts a function which will be called for each point until the function returns true.
- /// </summary>
- /// <param name="filter" type="Object" >The callback function which will be called for the points or the category value for a shared tooltip.</param>
- },
- svg: function() {
- /// <summary>
- /// Returns the SVG representation of the chart. The returned string is a self-contained SVG document that can be used as is or converted to other formats using tools like Inkscape andImageMagick. Both programs provide command-line interface suitable for server-side processing.
- /// </summary>
- /// <returns type="String">the SVG representation of the chart.</returns>
- },
- imageDataURL: function() {
- /// <summary>
- /// Returns a PNG image of the chart encoded as a Data URL.
- /// </summary>
- /// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
- },
- toggleHighlight: function(show,options) {
- /// <summary>
- /// Toggles the highlight of the series points or a segment for pie, donut and funnel charts.
- /// </summary>
- /// <param name="show" type="Boolean" >A boolean value that specifies if the highlight should be shown or hidden.</param>
- /// <param name="options" type="Object" >A string representing the series name or the category name or an object with the series and category names or a function which will be called for each point. The fields available in the function argument are: category - the point category.; dataItem - the point dataItem.; value - the point value.; series - the point series.; percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.; runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series. or total - the sum of all previous series values. Available for waterfall series..</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoChart = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ui.Chart widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ui.Chart">The kendo.dataviz.ui.Chart instance (if present).</returns>
- };
- $.fn.kendoChart = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ui.Chart widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// autoBind - Boolean (default: true)
- /// If set to false the widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the data source is fired. By default the widget will bind to the data source specified in the configuration.
- ///
- /// axisDefaults - Object
- /// The default options for all chart axes. Accepts the options supported by categoryAxis, valueAxis, xAxis and yAxis.
- ///
- /// categoryAxis - Array|Object
- /// The category axis configuration options.
- ///
- /// chartArea - Object
- /// The chart area configuration options. Represents the entire visible area of the chart.
- ///
- /// dataSource - Object|Array|kendo.data.DataSource
- /// The data source of the chart which is used to display the series. Can be a JavaScript object which represents a valid data source configuration, a JavaScript array or an existing kendo.data.DataSource instance.If the dataSource option is set to a JavaScript object or array the widget will initialize a new kendo.data.DataSource instance using that value as data source configuration.If the dataSource option is an existing kendo.data.DataSource instance the widget will use that instance and will not initialize a new one.
- ///
- /// legend - Object
- /// The chart legend configuration options.
- ///
- /// panes - Array
- /// The chart panes configuration.Panes are used to split the chart in two or more parts. The panes are ordered from top to bottom.Each axis can be associated with a pane by setting its pane option to the name of the desired pane. Axis that don't have specified pane are placed in the top (default) pane.Series are moved to the desired pane by associating them with an axis.
- ///
- /// pannable - Boolean (default: false)
- /// Specifies if the chart can be panned.
- ///
- /// pannable - Object (default: false)
- /// Specifies if the chart can be panned.
- ///
- /// pdf - Object
- /// Configures the export settings for the saveAsPDF method.
- ///
- /// persistSeriesVisibility - Boolean (default: false)
- /// Specifies if the series visible option should be persisted when changing the dataSource data.
- ///
- /// plotArea - Object
- /// The plot area configuration options. The plot area is the area which displays the series.
- ///
- /// renderAs - String
- /// Sets the preferred rendering engine. If it is not supported by the browser, the Chart will switch to the first available mode.The supported values are: "svg" - renders the widget as inline SVG document, if available or "canvas" - renders the widget as a Canvas element, if available..
- ///
- /// series - Array
- /// The configuration of the chart series.The series type is determined by the value of the type field. If a type value is missing, the type is assumed to be the one specified in seriesDefaults.
- ///
- /// seriesColors - Array
- /// The default colors for the chart's series. When all colors are used, new colors are pulled from the start again.
- ///
- /// seriesDefaults - Object
- /// The default options for all series.
- ///
- /// theme - String
- /// The chart theme. This can be either a built-in theme or "sass". When set to "sass" the chart will read the variables from the Sass-based themes.The supported values are: "sass" - special value, see notes; "black"; "blueopal"; "bootstrap"; "default"; "highcontrast"; "metro"; "metroblack"; "moonlight"; "silver" or "uniform".
- ///
- /// title - String
- /// The chart title configuration options or text.
- ///
- /// title - Object
- /// The chart title configuration options or text.
- ///
- /// tooltip - Object
- /// The chart series tooltip configuration options.
- ///
- /// transitions - Boolean (default: true)
- /// If set to true the chart will play animations when displaying the series. By default animations are enabled.
- ///
- /// valueAxis - Array|Object
- /// The value axis configuration options.
- ///
- /// xAxis - Array
- /// The X-axis configuration options of the scatter chart X-axis. Supports all valueAxis options.
- ///
- /// yAxis - Array
- /// The y axis configuration options of the scatter chart. Supports all valueAxis options.
- ///
- /// zoomable - Boolean (default: false)
- /// Specifies if the chart can be zoomed.
- ///
- /// zoomable - Object (default: false)
- /// Specifies if the chart can be zoomed.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ui.Diagram = function() { };
- kendo.dataviz.ui.Diagram.prototype = {
- addConnection: function(connection,undoable) {
- /// <summary>
- /// Adds the given Connection to the diagram.
- /// </summary>
- /// <param name="connection" type="Object" >The Connection instance to be added to the diagram.</param>
- /// <param name="undoable" type="Boolean" >Whether the addition should be recorded in the undo-redo stack.</param>
- },
- addShape: function(obj,undoable) {
- /// <summary>
- /// Adds a new shape to the diagram.
- /// </summary>
- /// <param name="obj" type="Object" >A Shape instance or a Point where the default shape type will be added.</param>
- /// <param name="undoable" type="Boolean" >Whether the addition should be recorded in the undo-redo stack.</param>
- /// <returns type="kendo.dataviz.diagram.Shape">The newly created diagram shape.</returns>
- },
- alignShapes: function(direction) {
- /// <summary>
- /// Aligns the edges (as defined by the bounding box) of the selected shapes.
- /// </summary>
- /// <param name="direction" type="String" >This can be one of the four supported directions: "left"; "right"; "top" or "bottom".</param>
- },
- boundingBox: function(items) {
- /// <summary>
- ///
- /// </summary>
- /// <param name="items" type="Array" >The items (shapes and connections) to include in the bounding box. Defaults to all items if not specified.</param>
- /// <returns type="kendo.dataviz.diagram.Rect">The bounding rectangle of the specified items. If nothing is specified the bounding box of the all diagram will be returned.</returns>
- },
- bringIntoView: function(obj,options) {
- /// <summary>
- /// Brings one or more items into the view in function of various criteria.
- /// </summary>
- /// <param name="obj" type="Object" >a diagram item; an array of items or a rectangle: this defines a window which the view should contain.</param>
- /// <param name="options" type="Object" >animate or align.</param>
- },
- cancelEdit: function() {
- /// <summary>
- /// Cancels edit and close the popup form.
- /// </summary>
- },
- clear: function() {
- /// <summary>
- /// Clears the content of the diagram.
- /// </summary>
- },
- connect: function(source,target,options) {
- /// <summary>
- /// Creates a connection which can be either attached on both ends to a shape, half attached or floating (not attached to any shape). When a connection is (half) attached to a shape it happens through the intermediate Connector object. Connectors are part of a Shape's definition and you can specify the binding of a connection to a shape directly via the shape or via one of its connectors. If you specify a Shape as a connection's endpoint the Auto-connector will be used. This means that the endpoint of the connection will switch to the most convenient (in the sense of shortest path) connector automatically. If you specify a shape's connector as an endpoint for a connection the endpoint will remain attached to that given Connector instance. Finally, if you wish to have a (half) floating connection endpoint you should specify a Point as parameter for the floating end.
- /// </summary>
- /// <param name="source" type="Object" >The source definition of the connection. This can be a Shape, a Connector or a Point.</param>
- /// <param name="target" type="Object" >The target definition of the connection. This can be a Shape, a Connector or a Point.</param>
- /// <param name="options" type="Object" >The options of the new connection. See connections options.</param>
- },
- connected: function(source,target) {
- /// <summary>
- /// Returns whether the two given shapes are connected through a connection.
- /// </summary>
- /// <param name="source" type="Object" >A Shape in the diagram.</param>
- /// <param name="target" type="Object" >A Shape in the diagram.</param>
- },
- copy: function() {
- /// <summary>
- /// Puts a copy of the currently selected diagram to an internal clipboard.
- /// </summary>
- },
- createConnection: function() {
- /// <summary>
- /// Adds an empty connection data item and a popup window will be displayed.
- /// </summary>
- },
- createShape: function() {
- /// <summary>
- /// Adds an empty shape data item and a popup window will be displayed.
- /// </summary>
- },
- cut: function() {
- /// <summary>
- /// Cuts the currently selected diagram items to an internal clipboard.
- /// </summary>
- },
- destroy: function() {
- /// <summary>
- /// Prepares the widget for safe removal from the DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
- /// </summary>
- },
- documentToModel: function(point) {
- /// <summary>
- /// Transforms a point from Page document coordinates to Model coordinates. Shortcut for viewToModel(documentToView(point)). This method is useful when you want to transform coordinates of a drag operation on top of the Diagram.
- /// </summary>
- /// <param name="point" type="Object" >The point in Page document coordinates.</param>
- /// <returns type="Object">the transformed point</returns>
- },
- documentToView: function(point) {
- /// <summary>
- /// Transforms a point from Page document coordinates to View coordinates. View coordinates are relative to the currently visible portion of the Diagram.
- /// </summary>
- /// <param name="point" type="Object" >The point in Page document coordinates.</param>
- /// <returns type="Object">the transformed point</returns>
- },
- edit: function(item) {
- /// <summary>
- /// Edit diagram connection/shape.
- /// </summary>
- /// <param name="item" type="Object" >A diagram item to edit.</param>
- },
- exportImage: function(options) {
- /// <summary>
- /// Exports the diagram content as an image. The result can be saved using kendo.saveAs.The full content of the diagram will be exported in 1:1 scale. If exporting the current view is desired then the kendo.drawing.drawDOM method should be called on a container element.The export operation is asynchronous and returns a promise. The promise will be resolved with a PNG image encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Parameters for the exported image.</param>
- /// <returns type="Promise">A promise that will be resolved with a PNG image encoded as a Data URI.</returns>
- },
- exportPDF: function(options) {
- /// <summary>
- /// Exports the diagram content as a PDF file. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PDF file encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="kendo.drawing.PDFOptions" >Parameters for the exported PDF file.</param>
- /// <returns type="Promise">A promise that will be resolved with a PDF file encoded as a Data URI.</returns>
- },
- exportSVG: function(options) {
- /// <summary>
- /// Exports the diagram content as an SVG document. The result can be saved using kendo.saveAs.The full content of the diagram will be exported in 1:1 scale. If exporting the current view is desired then the kendo.drawing.drawDOM method should be called on a container element.The export operation is asynchronous and returns a promise. The promise will be resolved with a SVG document encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Export options.</param>
- /// <returns type="Promise">A promise that will be resolved with a SVG document encoded as a Data URI.</returns>
- },
- focus: function() {
- /// <summary>
- /// Sets the focus on the diagram.
- /// </summary>
- },
- getConnectionByModelId: function(id) {
- /// <summary>
- /// Returns the connection corresponding to the model with the specified id value.
- /// </summary>
- /// <param name="id" type="Object" >The model id value.</param>
- /// <returns type="kendo.dataviz.diagram.Connection">the connection corresponding to the model.</returns>
- },
- getConnectionByModelUid: function(uid) {
- /// <summary>
- /// Returns the connection corresponding to the model with the specified uid value.
- /// </summary>
- /// <param name="uid" type="String" >The model uid value.</param>
- /// <returns type="kendo.dataviz.diagram.Connection">the connection corresponding to the model.</returns>
- },
- getShapeById: function(id) {
- /// <summary>
- /// Returns the shape or connection with the specified identifier.
- /// </summary>
- /// <param name="id" type="String" >The unique identifier of the Shape or Connection</param>
- /// <returns type="Object">the item that has the provided ID.</returns>
- },
- getShapeByModelId: function(id) {
- /// <summary>
- /// Returns the shape corresponding to the model with the specified id value.
- /// </summary>
- /// <param name="id" type="Object" >The model id value.</param>
- /// <returns type="kendo.dataviz.diagram.Shape">the shape corresponding to the model.</returns>
- },
- getShapeByModelUid: function(uid) {
- /// <summary>
- /// Returns the shape corresponding to the model with the specified uid value.
- /// </summary>
- /// <param name="uid" type="String" >The model uid value.</param>
- /// <returns type="kendo.dataviz.diagram.Shape">the shape corresponding to the model.</returns>
- },
- layerToModel: function(point) {
- /// <summary>
- /// Transforms a point from Layer coordinates to Model coordinates. Layer coordinates are relative to the drawable surface.
- /// </summary>
- /// <param name="point" type="Object" >The point in layer coordinates.</param>
- /// <returns type="Object">the transformed point</returns>
- },
- layout: function(options) {
- /// <summary>
- /// Applies a layout algorithm on the current diagram.A more detailed overview of layout and graph analysis can be found below.
- /// </summary>
- /// <param name="options" type="Object" >The layout options. See options.layout for a full reference.</param>
- },
- load: function(json) {
- /// <summary>
- /// Loads a saved diagram.
- /// </summary>
- /// <param name="json" type="Object" >The serialized Diagram options to load.</param>
- },
- modelToDocument: function(point) {
- /// <summary>
- /// Transforms a point from Model coordinates to Page document coordinates. Shortcut for viewToDocument(modelToView(point)).
- /// </summary>
- /// <param name="point" type="Object" >The point in Model coordinates.</param>
- /// <returns type="Object">the transformed point</returns>
- },
- modelToLayer: function(point) {
- /// <summary>
- /// Transforms a point from Model coordinates to Layer coordinates. Layer coordinates are relative to the drawing surface.
- /// </summary>
- /// <param name="point" type="Object" >The point in Model coordinates.</param>
- /// <returns type="Object">the transformed point</returns>
- },
- modelToView: function(point) {
- /// <summary>
- /// Transforms a point from Model coordinates to View coordinates. Model coordinates are independent coordinates to define Shape bounds. View coordinates are relative to the currently visible part of the drawing surface.
- /// </summary>
- /// <param name="point" type="Object" >The point in Model coordinates.</param>
- /// <returns type="Object">the transformed point</returns>
- },
- pan: function(pan) {
- /// <summary>
- /// Pans the diagram with a specified delta (represented as a Point).
- /// </summary>
- /// <param name="pan" type="Object" >The translation delta to apply to the diagram or the Point to pan to.</param>
- },
- paste: function() {
- /// <summary>
- /// Pastes the content of the internal diagram clipboard.
- /// </summary>
- },
- redo: function() {
- /// <summary>
- /// Executes again the previously undone action.
- /// </summary>
- },
- remove: function(items,undoable) {
- /// <summary>
- /// Removes one or more items from the diagram
- /// </summary>
- /// <param name="items" type="Object" >A diagram item or an array of diagram items to remove.</param>
- /// <param name="undoable" type="Boolean" >Whether the removal should be recorded in the undo-redo stack.</param>
- },
- resize: function() {
- /// <summary>
- /// Adjusts the diagram size to match the size of the container.
- /// </summary>
- },
- save: function() {
- /// <summary>
- /// Returns the complete Diagram configuration in JSON format.
- /// </summary>
- /// <returns type="Object">An options object containing the complete Diagram configuration.</returns>
- },
- saveAsPDF: function() {
- /// <summary>
- /// Saves the diagram content as PDF document.
- /// </summary>
- /// <returns type="Promise">A promise that will be resolved when the export completes.</returns>
- },
- saveEdit: function() {
- /// <summary>
- /// Saves any changes made by the user.
- /// </summary>
- },
- select: function(elements,options) {
- /// <summary>
- /// Gets or sets the selected elements.
- /// </summary>
- /// <param name="elements" type="Object" >The diagram element(s) that should be selected.</param>
- /// <param name="options" type="" ></param>
- /// <returns type="Array">The selected diagram elements.</returns>
- },
- selectAll: function() {
- /// <summary>
- /// Selects all shapes and the connections between them (without the point-to-point connections).
- /// </summary>
- },
- selectArea: function(rect) {
- /// <summary>
- /// Selects all diagram elements within the given rectangle.
- /// </summary>
- /// <param name="rect" type="kendo.dataviz.diagram.Rect" >The rectangle that determines which elements should be selected.</param>
- },
- setConnectionsDataSource: function(dataSource) {
- /// <summary>
- /// Sets the connections data source of the diagram.
- /// </summary>
- /// <param name="dataSource" type="kendo.data.DataSource" >The data source to which the widget should be bound.</param>
- },
- setDataSource: function(dataSource) {
- /// <summary>
- /// Sets the data source of the diagram.
- /// </summary>
- /// <param name="dataSource" type="kendo.data.DataSource" >The data source to which the widget should be bound.</param>
- },
- toBack: function(items,undoable) {
- /// <summary>
- /// Sends the specified items to the back, i.e. it's reordering items to ensure they are underneath the complementary items.
- /// </summary>
- /// <param name="items" type="Array" >An array of diagram items.</param>
- /// <param name="undoable" type="Boolean" >Whether the change should be recorded in the undo-redo stack.</param>
- },
- toFront: function(items,undoable) {
- /// <summary>
- /// Brings the specified items in front, i.e. it's reordering items to ensure they are on top of the complementary items.
- /// </summary>
- /// <param name="items" type="Array" >An array of diagram items.</param>
- /// <param name="undoable" type="Boolean" >Whether the change should be recorded in the undo-redo stack.</param>
- },
- undo: function() {
- /// <summary>
- /// Undoes the previous action.
- /// </summary>
- },
- viewToDocument: function(point) {
- /// <summary>
- /// Transforms a point from View coordinates to Page document coordinates. View origin is the diagram container.
- /// </summary>
- /// <param name="point" type="kendo.dataviz.diagram.Point" >The point in Page document coordinates.</param>
- /// <returns type="kendo.dataviz.diagram.Point">the transformed point</returns>
- },
- viewToModel: function(point) {
- /// <summary>
- /// Transforms a point from View coordinates to Model coordinates. Model coordinates are independent coordinates to define Shape bounds.
- /// </summary>
- /// <param name="point" type="kendo.dataviz.diagram.Point" >The point in View coordinates.</param>
- /// <returns type="kendo.dataviz.diagram.Point">the transformed point</returns>
- },
- viewport: function() {
- /// <summary>
- /// The bounds of the diagramming canvas.
- /// </summary>
- /// <returns type="kendo.dataviz.diagram.Rect">as viewport bounds</returns>
- },
- zoom: function(zoom,point) {
- /// <summary>
- /// Gets or sets the current zoom level of the diagram.
- /// </summary>
- /// <param name="zoom" type="Number" >The zoom factor.</param>
- /// <param name="point" type="kendo.dataviz.diagram.Point" >The point to zoom into or out of.</param>
- /// <returns type="Number">The current zoom level</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoDiagram = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ui.Diagram widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ui.Diagram">The kendo.dataviz.ui.Diagram instance (if present).</returns>
- };
- $.fn.kendoDiagram = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ui.Diagram widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// autoBind - Boolean (default: true)
- /// If set to false the widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the data source is fired. By default the widget will bind to the data source specified in the configuration.
- ///
- /// connectionDefaults - Object
- /// Defines the defaults of the connections. Whenever a connection is created, the specified connectionDefaults will be used and merged with the (optional) configuration passed through the connection creation method.
- ///
- /// connections - Array
- /// Defines the connections configuration.
- ///
- /// connectionsDataSource - Object|Array|kendo.data.DataSource
- /// Defines the data source of the connections.
- ///
- /// dataSource - Object|Array|kendo.data.DataSource
- /// Defines the data source of the diagram.
- ///
- /// editable - Boolean (default: true)
- /// A set of settings to configure the Diagram behavior when the user attempts to: edit, delete or create shapes and connections.; drag shapes.; resize shapes. or rotate shapes..
- ///
- /// editable - Object (default: true)
- /// A set of settings to configure the Diagram behavior when the user attempts to: edit, delete or create shapes and connections.; drag shapes.; resize shapes. or rotate shapes..
- ///
- /// layout - Object
- /// The layout of a diagram consists in arranging the shapes (sometimes also the connections) in some fashion in order to achieve an aesthetically pleasing experience to the user. It aims at giving a more direct insight in the information contained within the diagram and its relational structure.On a technical level, layout consists of a multitude of algorithms and optimizations: analysis of the relational structure (loops, multi-edge occurrence...); connectedness of the diagram and the splitting into disconnected components; crossings of connections or bends and length of links. and various ad-hoc calculations which depend on the type of layout. The criteria on which an algorithm is based vary but the common denominator is: a clean separation of connected components (subgraphs); an orderly organization of the shapes in such a way that siblings are close to another, i.e. a tight packing of shapes which belong together (parent of child relationship) or a minimum of connection crossings. Kendo diagram includes three of the most used layout algorithms which should cover most of your layout needs - tree layout, force-directed layout and layered layout. Please, check the type property for more details regarding each type.The generic way to apply a layout is by calling the layout() method on the diagram. The method has a single parameter options. It is an object, which can contain parameters which are specific to the layout as well as parameters customizing the global grid layout. Parameters which apply to other layout algorithms can be included but are overlooked if not applicable to the chose layout type. This means that you can define a set of parameters which cover all possible layout types and simply pass it in the method whatever the layout define in the first parameter.
- ///
- /// pannable - Boolean (default: true)
- /// Defines the pannable options. Use this setting to disable Diagram pan or change the key that activates the pan behavior.
- ///
- /// pannable - Object (default: true)
- /// Defines the pannable options. Use this setting to disable Diagram pan or change the key that activates the pan behavior.
- ///
- /// pdf - Object
- /// Configures the export settings for the saveAsPDF method.
- ///
- /// selectable - Boolean (default: true)
- /// Defines the Diagram selection options.By default, you can select shapes in the Diagram in one of two ways: Clicking a single shape to select it and deselect any previously selected shapes. or Holding the Ctrl key while clicking multiple shapes to select them and any other shapes between them.. Using the selectable configuration, you can enable single selection only, enable selection by drawing a rectangular area with the mouse around shapes in the canvas, or disable selection altogether.
- ///
- /// selectable - Object (default: true)
- /// Defines the Diagram selection options.By default, you can select shapes in the Diagram in one of two ways: Clicking a single shape to select it and deselect any previously selected shapes. or Holding the Ctrl key while clicking multiple shapes to select them and any other shapes between them.. Using the selectable configuration, you can enable single selection only, enable selection by drawing a rectangular area with the mouse around shapes in the canvas, or disable selection altogether.
- ///
- /// shapeDefaults - Object
- /// Defines the default options that will be applied to all shapes in the Diagram.
- ///
- /// shapes - Array
- /// Defines the shape options.
- ///
- /// template - String|Function (default: "")
- /// The template which renders the content of the shape when bound to a dataSource. The names you can use in the template correspond to the properties used in the dataSource. For an example, refer to the dataSource topic below.
- ///
- /// theme - String
- /// The diagram theme. This can be either a built-in theme or "sass". When set to "sass" the diagram will read the variables from a Sass-based theme.The supported values are: * "sass" - works only when a custom Sass theme is loaded in the page * "black" * "blueopal" * "bootstrap" * "bootstrap-v4" - works only with the Bootstrap-v4 Sass theme loaded in the page * "default" * "default-v2" - works only with the Default-v2 Sass theme loaded in the page * "fiori" * "flat" * "highcontrast" * "material" * "materialBlack" * "metro" * "metroblack" * "moonlight" * "nova" * "office365" * "silver" * "uniform"
- ///
- /// zoom - Number (default: 1)
- /// The default zoom level of the Diagram in percentages.
- ///
- /// zoomMax - Number (default: 2)
- /// The maximum zoom level in percentages. The user will not be allowed to zoom in past this level.
- ///
- /// zoomMin - Number (default: 0.1)
- /// The minimum zoom level in percentages. The user will not be allowed to zoom out past this level. You can see an example in zoomMax.
- ///
- /// zoomRate - Number (default: 0.1)
- /// The zoom step when using the mouse-wheel to zoom in or out.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ui.LinearGauge = function() { };
- kendo.dataviz.ui.LinearGauge.prototype = {
- allValues: function(values) {
- /// <summary>
- /// Allows setting or getting multiple Gauge values at once.
- /// </summary>
- /// <param name="values" type="Array" >An array of values to be set.</param>
- /// <returns type="Array">An array of the Gauge pointer values will be returned if no parameter is passed.</returns>
- },
- destroy: function() {
- /// <summary>
- /// Prepares the Gauge for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
- /// </summary>
- },
- exportImage: function(options) {
- /// <summary>
- /// Exports the Gauge as an image. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PNG image encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Parameters for the exported image.</param>
- /// <returns type="Promise">A promise that will be resolved with a PNG image encoded as a Data URI.</returns>
- },
- exportPDF: function(options) {
- /// <summary>
- /// Exports the Gauge as a PDF file. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PDF file encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="kendo.drawing.PDFOptions" >Parameters for the exported PDF file.</param>
- /// <returns type="Promise">A promise that will be resolved with a PDF file encoded as a Data URI.</returns>
- },
- exportSVG: function(options) {
- /// <summary>
- /// Exports the Gauge as an SVG document. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a SVG document encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Export options.</param>
- /// <returns type="Promise">A promise that will be resolved with a SVG document encoded as a Data URI.</returns>
- },
- redraw: function() {
- /// <summary>
- /// Redraws the gauge.
- /// </summary>
- },
- resize: function(force) {
- /// <summary>
- /// Adjusts the widget layout to match the size of the container.
- /// </summary>
- /// <param name="force" type="Boolean" >Defines whether the widget should proceed with resizing even if the element dimensions have not changed.</param>
- },
- setOptions: function(options) {
- /// <summary>
- /// Sets the current gauge options.
- /// </summary>
- /// <param name="options" type="Object" >The gauge settings to update.</param>
- },
- svg: function() {
- /// <summary>
- /// Returns the SVG representation of the gauge. The returned string is a self-contained SVG document that can be used as is or converted to other formats using tools like Inkscape andImageMagick. Both programs provide command-line interface suitable for server-side processing.
- /// </summary>
- },
- imageDataURL: function() {
- /// <summary>
- /// Returns a PNG image of the gauge encoded as a Data URL.
- /// </summary>
- /// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
- },
- value: function() {
- /// <summary>
- /// Change the value of the gauge.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoLinearGauge = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ui.LinearGauge widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ui.LinearGauge">The kendo.dataviz.ui.LinearGauge instance (if present).</returns>
- };
- $.fn.kendoLinearGauge = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ui.LinearGauge widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// gaugeArea - Object
- /// The gauge area configuration options. This is the entire visible area of the gauge.
- ///
- /// pointer - Array
- /// The pointer configuration options. It accepts an Array of pointers, each with it's own configuration options.
- ///
- /// renderAs - String
- /// Sets the preferred rendering engine. If it is not supported by the browser, the Gauge will switch to the first available mode.The supported values are: "svg" - renders the widget as inline SVG document, if available or "canvas" - renders the widget as a Canvas element, if available..
- ///
- /// scale - Object
- /// Configures the scale.
- ///
- /// theme - String
- /// The gauge theme. This can be either a built-in theme or "sass". When set to "sass" the chart will read the variables from the Sass-based themes.The supported values are: "sass" - special value, see notes; "black"; "blueopal"; "bootstrap"; "default"; "highcontrast"; "metro"; "metroblack"; "moonlight"; "silver" or "uniform".
- ///
- /// transitions - Boolean (default: true)
- /// A value indicating if transition animations should be played.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ui.Map = function() { };
- kendo.dataviz.ui.Map.prototype = {
- center: function(center) {
- /// <summary>
- /// Gets or sets the map center. The setter is chainable, i.e. returns the map instance.
- /// </summary>
- /// <param name="center" type="Object" >The location of the new map center. An array argument is assumed to be in [Latitude, Longitude] order.</param>
- /// <returns type="kendo.dataviz.map.Location">The current map center.</returns>
- },
- destroy: function() {
- /// <summary>
- /// Prepares the widget for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
- /// </summary>
- },
- eventOffset: function(e) {
- /// <summary>
- /// Returns the event coordinates relative to the map element. Offset coordinates are not synchronized to a particular location on the map.
- /// </summary>
- /// <param name="e" type="Object" >The DOM or jQuery mouse event.</param>
- /// <returns type="kendo.geometry.Point">The event coordinates relative to the map element.</returns>
- },
- eventToLayer: function(e) {
- /// <summary>
- /// Retrieves projected (layer) coordinates that correspond to this mouse event. Layer coordinates are absolute and change only when the zoom level is changed.
- /// </summary>
- /// <param name="e" type="Object" >The DOM or jQuery mouse event.</param>
- /// <returns type="kendo.geometry.Point">The projected (layer) coordinates that correspond to this mouse event.</returns>
- },
- eventToLocation: function(e) {
- /// <summary>
- /// Retrieves the geographic location that correspond to this mouse event.
- /// </summary>
- /// <param name="e" type="Object" >The DOM or jQuery mouse event.</param>
- /// <returns type="kendo.geometry.Point">The geographic location that correspond to this mouse event.</returns>
- },
- eventToView: function(e) {
- /// <summary>
- /// Retrieves relative (view) coordinates that correspond to this mouse event. Layer elements positioned on these coordinates will appear under the mouse cursor.View coordinates are no longer valid after a map reset.
- /// </summary>
- /// <param name="e" type="Object" >The DOM or jQuery mouse event.</param>
- /// <returns type="kendo.geometry.Point">The relative (view) coordinates that correspond to this mouse event.</returns>
- },
- extent: function(extent) {
- /// <summary>
- /// Gets or sets the map extent or visible area. The setter is chainable, i.e. returns the map instance.
- /// </summary>
- /// <param name="extent" type="kendo.dataviz.map.Extent" >The new extent of the map.</param>
- /// <returns type="kendo.dataviz.map.Extent">The current map extent.</returns>
- },
- layerToLocation: function(point,zoom) {
- /// <summary>
- /// Transforms layer (projected) coordinates to geographical location.
- /// </summary>
- /// <param name="point" type="Object" >The layer (projected) coordinates. An array argument is assumed to be in x, y order.</param>
- /// <param name="zoom" type="Number" >Optional. Assumed zoom level. Defaults to the current zoom level.</param>
- /// <returns type="kendo.dataviz.map.Location">The geographic location that corresponds to the layer coordinates.</returns>
- },
- locationToLayer: function(location,zoom) {
- /// <summary>
- /// Returns the layer (projected) coordinates that correspond to a geographical location.
- /// </summary>
- /// <param name="location" type="Object" >The geographic location. An array argument is assumed to be in [Latitude, Longitude] order.</param>
- /// <param name="zoom" type="Number" >Optional. Assumed zoom level. Defaults to the current zoom level.</param>
- /// <returns type="kendo.geometry.Point">The layer (projected) coordinates.</returns>
- },
- locationToView: function(location) {
- /// <summary>
- /// Returns the view (relative) coordinates that correspond to a geographical location.
- /// </summary>
- /// <param name="location" type="Object" >The geographic location. An array argument is assumed to be in [Latitude, Longitude] order.</param>
- /// <returns type="kendo.geometry.Point">The view coordinates that correspond to a geographical location.</returns>
- },
- resize: function(force) {
- /// <summary>
- /// Adjusts the widget layout to match the size of the container.
- /// </summary>
- /// <param name="force" type="Boolean" >Defines whether the widget should proceed with resizing even if the element dimensions have not changed.</param>
- },
- setOptions: function(options) {
- /// <summary>
- /// Resets the map and applies new options over the current state.
- /// </summary>
- /// <param name="options" type="Object" >The new options to be applied.</param>
- },
- viewSize: function() {
- /// <summary>
- /// Retrieves the size of the visible portion of the map.
- /// </summary>
- /// <returns type="Object">The size (width and height) of the visible portion of the map.</returns>
- },
- viewToLocation: function(point,zoom) {
- /// <summary>
- /// Returns the geographical location that correspond to the view (relative) coordinates.
- /// </summary>
- /// <param name="point" type="Object" >The view coordinates. An array argument is assumed to be in x, y order.</param>
- /// <param name="zoom" type="Number" >Optional. Assumed zoom level. Defaults to the current zoom level.</param>
- /// <returns type="kendo.dataviz.map.Location">The geographic location that corresponds to the view coordinates.</returns>
- },
- zoom: function(level) {
- /// <summary>
- /// Gets or sets the map zoom level. The setter is chainable, i.e. returns the map instance.
- /// </summary>
- /// <param name="level" type="Number" >The new zoom level. The value is clamped to the [minZoom, maxZoom] interval.</param>
- /// <returns type="Number">The current zoom level.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoMap = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ui.Map widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ui.Map">The kendo.dataviz.ui.Map instance (if present).</returns>
- };
- $.fn.kendoMap = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ui.Map widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// center - Array|kendo.dataviz.map.Location
- /// The map center. Coordinates are listed as [Latitude, Longitude].
- ///
- /// controls - Object
- /// The configuration of built-in map controls.
- ///
- /// layerDefaults - Object
- /// The default configuration for map layers by type.
- ///
- /// layers - Array
- /// The configuration of the map layers. The layer type is determined by the value of the type field.
- ///
- /// markerDefaults - Object
- /// The default options for all markers.
- ///
- /// markers - Array
- /// Static markers to display on the map.
- ///
- /// minZoom - Number (default: 1)
- /// The minimum zoom level. Typical web maps use zoom levels from 0 (whole world) to 19 (sub-meter features).
- ///
- /// maxZoom - Number (default: 19)
- /// The maximum zoom level. Typical web maps use zoom levels from 0 (whole world) to 19 (sub-meter features).
- ///
- /// minSize - Number (default: 256)
- /// The size of the map in pixels at zoom level 0.
- ///
- /// pannable - Boolean (default: true)
- /// Controls whether the user can pan the map.
- ///
- /// wraparound - Boolean (default: true)
- /// Specifies whether the map should wrap around the east-west edges.
- ///
- /// zoom - Number (default: 3)
- /// The initial zoom level.Typical web maps use zoom levels from 0 (whole world) to 19 (sub-meter features).The map size is derived from the zoom level and minScale options: size = (2 ^ zoom) * minSize
- ///
- /// zoomable - Boolean (default: true)
- /// Controls whether the map zoom level can be changed by the user.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ui.QRCode = function() { };
- kendo.dataviz.ui.QRCode.prototype = {
- destroy: function() {
- /// <summary>
- /// Prepares the QRCode for safe removal from the DOM.Removes data entries in order to avoid memory leaks.
- /// </summary>
- },
- exportImage: function(options) {
- /// <summary>
- /// Exports the QRCode as an image. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PNG image encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Parameters for the exported image.</param>
- /// <returns type="Promise">A promise that will be resolved with a PNG image encoded as a Data URI.</returns>
- },
- exportPDF: function(options) {
- /// <summary>
- /// Exports the QRCode as a PDF file. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PDF file encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="kendo.drawing.PDFOptions" >Parameters for the exported PDF file.</param>
- /// <returns type="Promise">A promise that will be resolved with a PDF file encoded as a Data URI.</returns>
- },
- exportSVG: function(options) {
- /// <summary>
- /// Exports the QRCode as an SVG document. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a SVG document encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Export options.</param>
- /// <returns type="Promise">A promise that will be resolved with a SVG document encoded as a Data URI.</returns>
- },
- imageDataURL: function() {
- /// <summary>
- /// Returns a PNG image of the qrcode encoded as a Data URL.
- /// </summary>
- /// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
- },
- redraw: function() {
- /// <summary>
- /// Redraws the QR code using the current value and options.
- /// </summary>
- },
- resize: function(force) {
- /// <summary>
- /// Adjusts the widget layout to match the size of the container.
- /// </summary>
- /// <param name="force" type="Boolean" >Defines whether the widget should proceed with resizing even if the element dimensions have not changed.</param>
- },
- setOptions: function(options) {
- /// <summary>
- /// Sets new options to the QRCode and redraws it.
- /// </summary>
- /// <param name="options" type="Object" >An object with the new options. All configuration options can be set.</param>
- },
- svg: function() {
- /// <summary>
- /// Returns the SVG representation of the qrcode. The returned string is a self-contained SVG document that can be used as is or converted to other formats using tools like Inkscape andImageMagick. Both programs provide command-line interface suitable for server-side processing.
- /// </summary>
- /// <returns type="String">the SVG representation of the qrcode.</returns>
- },
- value: function(options) {
- /// <summary>
- /// Change the value of the QR code.
- /// </summary>
- /// <param name="options" type="Object" >The new value to be set.</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoQRCode = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ui.QRCode widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ui.QRCode">The kendo.dataviz.ui.QRCode instance (if present).</returns>
- };
- $.fn.kendoQRCode = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ui.QRCode widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// background - String (default: "#fff")
- /// The background color of the QR code. Accepts a valid CSS color string, including hex and rgb.
- ///
- /// border - Object
- /// The border of the QR code.
- ///
- /// color - String (default: "#000")
- /// The color of the QR code. Accepts a valid CSS color string, including hex and rgb.
- ///
- /// encoding - String (default: "ISO_8859_1")
- /// The encoding mode used to encode the value.The possible values are: "ISO_8859_1" - supports all characters from the ISO/IEC 8859-1 character set. or "UTF_8" - supports all Unicode characters..
- ///
- /// errorCorrection - String (default: "L")
- /// The error correction level used to encode the value.The possible values are: "L" - approximately 7% of the codewords can be restored.; "M" - approximately 15% of the codewords can be restored.; "Q" - approximately 25% of the codewords can be restored. or "H" - approximately 30% of the codewords can be restored..
- ///
- /// padding - Number (default: 0)
- /// Sets the minimum distance in pixels that should be left between the border and the QR modules.
- ///
- /// renderAs - String (default: "svg")
- /// Sets the preferred rendering engine. If it is not supported by the browser, the QRCode will switch to the first available mode.The supported values are: "canvas" - renders the widget as a Canvas element, if available. or "svg" - renders the widget as inline SVG document, if available.
- ///
- /// size - Number|String
- /// Specifies the size of a QR code in pixels (i.e. "200px"). Numeric values are treated as pixels. If no size is specified, it will be determined from the element width and height. In case the element has width or height of zero, a default value of 200 pixels will be used.
- ///
- /// value - Number|String
- /// The value of the QRCode.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ui.RadialGauge = function() { };
- kendo.dataviz.ui.RadialGauge.prototype = {
- allValues: function(values) {
- /// <summary>
- /// Allows setting or getting multiple Gauge values at once.
- /// </summary>
- /// <param name="values" type="Array" >An array of values to be set.</param>
- /// <returns type="Array">An array of the Gauge pointer values will be returned if no parameter is passed.</returns>
- },
- destroy: function() {
- /// <summary>
- /// Prepares the Gauge for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
- /// </summary>
- },
- exportImage: function(options) {
- /// <summary>
- /// Exports the Gauge as an image. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PNG image encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Parameters for the exported image.</param>
- /// <returns type="Promise">A promise that will be resolved with a PNG image encoded as a Data URI.</returns>
- },
- exportPDF: function(options) {
- /// <summary>
- /// Exports the Gauge as a PDF file. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a PDF file encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="kendo.drawing.PDFOptions" >Parameters for the exported PDF file.</param>
- /// <returns type="Promise">A promise that will be resolved with a PDF file encoded as a Data URI.</returns>
- },
- exportSVG: function(options) {
- /// <summary>
- /// Exports the Gauge as an SVG document. The result can be saved using kendo.saveAs.The export operation is asynchronous and returns a promise. The promise will be resolved with a SVG document encoded as a Data URI.
- /// </summary>
- /// <param name="options" type="" >Export options.</param>
- /// <returns type="Promise">A promise that will be resolved with a SVG document encoded as a Data URI.</returns>
- },
- redraw: function() {
- /// <summary>
- /// Redraws the gauge.
- /// </summary>
- },
- resize: function(force) {
- /// <summary>
- /// Adjusts the widget layout to match the size of the container.
- /// </summary>
- /// <param name="force" type="Boolean" >Defines whether the widget should proceed with resizing even if the element dimensions have not changed.</param>
- },
- setOptions: function(options) {
- /// <summary>
- /// Sets the current gauge options.
- /// </summary>
- /// <param name="options" type="Object" >The gauge settings to update.</param>
- },
- svg: function() {
- /// <summary>
- /// Returns the SVG representation of the gauge. The returned string is a self-contained SVG document that can be used as is or converted to other formats using tools like Inkscape andImageMagick. Both programs provide command-line interface suitable for server-side processing.
- /// </summary>
- },
- imageDataURL: function() {
- /// <summary>
- /// Returns a PNG image of the gauge encoded as a Data URL.
- /// </summary>
- /// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
- },
- value: function() {
- /// <summary>
- /// Change the value of the gauge.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoRadialGauge = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ui.RadialGauge widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ui.RadialGauge">The kendo.dataviz.ui.RadialGauge instance (if present).</returns>
- };
- $.fn.kendoRadialGauge = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ui.RadialGauge widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// gaugeArea - Object
- /// The gauge area configuration options. This is the entire visible area of the gauge.
- ///
- /// pointer - Array
- /// The pointer configuration options. It accepts an Array of pointers, each with it's own configuration options.
- ///
- /// renderAs - String
- /// Sets the preferred rendering engine. If it is not supported by the browser, the Gauge will switch to the first available mode.The supported values are: "svg" - renders the widget as inline SVG document, if available or "canvas" - renders the widget as a Canvas element, if available..
- ///
- /// scale - Object
- /// Configures the scale.
- ///
- /// theme - String
- /// The gauge theme. This can be either a built-in theme or "sass". When set to "sass" the chart will read the variables from the Sass-based themes.The supported values are: "sass" - special value, see notes; "black"; "blueopal"; "bootstrap"; "default"; "highcontrast"; "metro"; "metroblack"; "moonlight"; "silver" or "uniform".
- ///
- /// transitions - Boolean (default: true)
- /// A value indicating if transition animations should be played.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ui.Sparkline = function() { };
- kendo.dataviz.ui.Sparkline.prototype = {
- destroy: function() {
- /// <summary>
- /// Prepares the Sparkline for safe removal from the DOM.Detaches event handlers and removes data entries in order to avoid memory leaks.
- /// </summary>
- },
- exportImage: function(options) {
- /// <summary>
- /// Exports the chart as an image.Inherited from Chart.exportImage
- /// </summary>
- /// <param name="options" type="" >Parameters for the exported image.</param>
- /// <returns type="Promise">A promise that will be resolved with a PNG image encoded as a Data URI.</returns>
- },
- exportPDF: function(options) {
- /// <summary>
- /// Exports the chart as a PDF file.Inherited from Chart.exportPDF
- /// </summary>
- /// <param name="options" type="kendo.drawing.PDFOptions" >Parameters for the exported PDF file.</param>
- /// <returns type="Promise">A promise that will be resolved with a PDF file encoded as a Data URI.</returns>
- },
- exportSVG: function(options) {
- /// <summary>
- /// Exports the chart as an SVG document.Inherited from Chart.exportSVG
- /// </summary>
- /// <param name="options" type="" >Export options.</param>
- /// <returns type="Promise">A promise that will be resolved with a SVG document encoded as a Data URI.</returns>
- },
- refresh: function() {
- /// <summary>
- /// Reloads the data and repaints the chart.
- /// </summary>
- },
- setDataSource: function(dataSource) {
- /// <summary>
- /// Sets the dataSource of an existing Chart and rebinds it.
- /// </summary>
- /// <param name="dataSource" type="kendo.data.DataSource" ></param>
- },
- setOptions: function(options) {
- /// <summary>
- /// Sets the widget options. Changes are cumulative.
- /// </summary>
- /// <param name="options" type="Object" >The chart settings to update.</param>
- },
- svg: function() {
- /// <summary>
- /// Returns the SVG representation of the chart. The returned string is a self-contained SVG document that can be used as is or converted to other formats using tools like Inkscape andImageMagick. Both programs provide command-line interface suitable for server-side processing.
- /// </summary>
- /// <returns type="String">the SVG representation of the sparkline.</returns>
- },
- imageDataURL: function() {
- /// <summary>
- /// Returns a PNG image of the sparkline encoded as a Data URL.
- /// </summary>
- /// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoSparkline = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ui.Sparkline widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ui.Sparkline">The kendo.dataviz.ui.Sparkline instance (if present).</returns>
- };
- $.fn.kendoSparkline = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ui.Sparkline widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// axisDefaults - Object
- /// Default options for all chart axes.
- ///
- /// categoryAxis - Array
- /// The category axis configuration options.
- ///
- /// chartArea - Object
- /// The chart area configuration options. This is the entire visible area of the chart.
- ///
- /// data - Array
- /// The data for the default sparkline series.Will be discarded if series are supplied.
- ///
- /// dataSource - Object
- /// DataSource configuration or instance.
- ///
- /// autoBind - Boolean (default: true)
- /// Indicates whether the chart will call read on the data source initially.
- ///
- /// plotArea - Object
- /// The plot area configuration options. This is the area containing the plotted series.
- ///
- /// pointWidth - Number (default: 5)
- /// The width to allocate for each data point.
- ///
- /// renderAs - String
- /// Sets the preferred rendering engine. If it is not supported by the browser, the Sparkline will switch to the first available mode.The supported values are: "svg" - renders the widget as inline SVG document, if available or "canvas" - renders the widget as a Canvas element, if available..
- ///
- /// series - Array
- /// Array of series definitions.The series type is determined by the value of the type field. If a type value is missing, the type is assumed to be the one specified in seriesDefaults.Each series type has a different set of options.
- ///
- /// seriesColors - Array
- /// The default colors for the chart's series. When all colors are used, new colors are pulled from the start again.
- ///
- /// seriesDefaults - Object
- /// Default values for each series.
- ///
- /// theme - String
- /// The sparkline theme. This can be either a built-in theme or "sass". When set to "sass" the sparkline will read the variables from the Sass-based themes.The supported values are: "sass" - special value, see notes; "black"; "blueopal"; "bootstrap"; "default"; "highcontrast"; "metro"; "metroblack"; "moonlight"; "silver" or "uniform".
- ///
- /// tooltip - Object
- /// The data point tooltip configuration options.
- ///
- /// transitions - Boolean (default: false)
- /// A value indicating if transition animations should be played.
- ///
- /// type - String (default: "line")
- /// The default series type.
- ///
- /// valueAxis - Array
- /// The value axis configuration options.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ui.StockChart = function() { };
- kendo.dataviz.ui.StockChart.prototype = {
- destroy: function() {
- /// <summary>
- /// Prepares the widget for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets.
- /// </summary>
- },
- exportImage: function(options) {
- /// <summary>
- /// Exports the chart as an image.Inherited from Chart.exportImage
- /// </summary>
- /// <param name="options" type="" >Parameters for the exported image.</param>
- /// <returns type="Promise">A promise that will be resolved with a PNG image encoded as a Data URI.</returns>
- },
- exportPDF: function(options) {
- /// <summary>
- /// Exports the chart as a PDF file.Inherited from Chart.exportPDF
- /// </summary>
- /// <param name="options" type="kendo.drawing.PDFOptions" >Parameters for the exported PDF file.</param>
- /// <returns type="Promise">A promise that will be resolved with a PDF file encoded as a Data URI.</returns>
- },
- exportSVG: function(options) {
- /// <summary>
- /// Exports the chart as an SVG document.Inherited from Chart.exportSVG
- /// </summary>
- /// <param name="options" type="" >Export options.</param>
- /// <returns type="Promise">A promise that will be resolved with a SVG document encoded as a Data URI.</returns>
- },
- redraw: function() {
- /// <summary>
- /// Repaints the chart using the currently loaded data.
- /// </summary>
- },
- refresh: function() {
- /// <summary>
- /// Reloads the data and renders the chart.
- /// </summary>
- },
- resize: function(force) {
- /// <summary>
- /// Adjusts the chart layout to match the size of the container.
- /// </summary>
- /// <param name="force" type="Boolean" >Defines whether the widget should proceed with resizing even if the element dimensions have not changed.</param>
- },
- setDataSource: function(dataSource) {
- /// <summary>
- /// Sets the data source of the widget.
- /// </summary>
- /// <param name="dataSource" type="kendo.data.DataSource" >The data source to which the widget should be bound.</param>
- },
- setOptions: function(options) {
- /// <summary>
- /// Sets the widget options. Changes are cumulative.
- /// </summary>
- /// <param name="options" type="Object" >The chart settings to update.</param>
- },
- svg: function() {
- /// <summary>
- /// Returns the SVG representation of the chart. The returned string is a self-contained SVG document that can be used as is or converted to other formats using tools like Inkscape andImageMagick. Both programs provide command-line interface suitable for server-side processing.
- /// </summary>
- /// <returns type="String">the SVG representation of the chart.</returns>
- },
- imageDataURL: function() {
- /// <summary>
- /// Returns a PNG image of the chart encoded as a Data URL.
- /// </summary>
- /// <returns type="String">A data URL with image/png MIME type. Will be null if the browser does not support the canvas element.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoStockChart = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ui.StockChart widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ui.StockChart">The kendo.dataviz.ui.StockChart instance (if present).</returns>
- };
- $.fn.kendoStockChart = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ui.StockChart widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// dateField - String (default: "date")
- /// The field containing the point date. It is used as a default categoryField for all series.The data item field value must be either: Date instance; String parsable by new Date([field value]) or String in ASP.NET JSON format, i.e. "\/Date(1320825600000-0800)\/".
- ///
- /// navigator - Object
- /// The data navigator configuration options.
- ///
- /// axisDefaults - Object
- /// Default options for all chart axes.
- ///
- /// categoryAxis - Array
- /// The category axis configuration options.
- ///
- /// chartArea - Object
- /// The chart area configuration options. This is the entire visible area of the chart.
- ///
- /// dataSource - Object
- /// DataSource configuration or instance.
- ///
- /// autoBind - Boolean (default: true)
- /// Indicates whether the chart will call read on the data source initially.
- ///
- /// legend - Object
- /// The chart legend configuration options.
- ///
- /// panes - Array
- /// The chart panes configuration.Panes are used to split the chart in two or more parts. The panes are ordered from top to bottom.Each axis can be associated with a pane by setting its pane option to the name of the desired pane. Axis that don't have specified pane are placed in the top (default) pane.Series are moved to the desired pane by associating them with an axis.
- ///
- /// pdf - Object
- /// Configures the export settings for the saveAsPDF method.
- ///
- /// persistSeriesVisibility - Boolean (default: true)
- /// Specifies if the series visible option should be persisted when changing the dataSource data.
- ///
- /// plotArea - Object
- /// The plot area configuration options. This is the area containing the plotted series.
- ///
- /// renderAs - String
- /// Sets the preferred rendering engine. If it is not supported by the browser, the Chart will switch to the first available mode.The supported values are: "svg" - renders the widget as inline SVG document, if available or "canvas" - renders the widget as a Canvas element, if available..
- ///
- /// series - Array
- /// Array of series definitions.The series type is determined by the value of the type field. If a type value is missing, the type is assumed to be the one specified in seriesDefaults.Each series type has a different set of options.
- ///
- /// seriesColors - Array
- /// The default colors for the chart's series. When all colors are used, new colors are pulled from the start again.
- ///
- /// seriesDefaults - Object
- /// Default values for each series.
- ///
- /// theme - String
- /// The chart theme. This can be either a built-in theme or "sass". When set to "sass" the chart will read the variables from the Sass-based themes.The supported values are: "sass" - special value, see notes; "black"; "blueopal"; "bootstrap"; "default"; "highcontrast"; "metro"; "metroblack"; "moonlight"; "silver" or "uniform".
- ///
- /// title - Object
- /// The chart title configuration options or text.
- ///
- /// tooltip - Object
- /// The data point tooltip configuration options.
- ///
- /// transitions - Boolean (default: true)
- /// A value indicating if transition animations should be played.
- ///
- /// valueAxis - Array
- /// The value axis configuration options.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.dataviz.ui.TreeMap = function() { };
- kendo.dataviz.ui.TreeMap.prototype = {
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoTreeMap = function() {
- /// <summary>
- /// Returns a reference to the kendo.dataviz.ui.TreeMap widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.dataviz.ui.TreeMap">The kendo.dataviz.ui.TreeMap instance (if present).</returns>
- };
- $.fn.kendoTreeMap = function(options) {
- /// <summary>
- /// Instantiates a kendo.dataviz.ui.TreeMap widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// dataSource - Object|Array|kendo.data.HierarchicalDataSource
- /// The data source of the treeMap which is used to display the tiles and titles. Can be a JavaScript object which represents a valid data source configuration, a JavaScript array or an existing kendo.data.HierarchicalDataSource instance.If the HierarchicalDataSource option is set to a JavaScript object or array the widget will initialize a new kendo.data.HierarchicalDataSource instance using that value as data source configuration.If the HierarchicalDataSource option is an existing kendo.data.HierarchicalDataSource instance the widget will use that instance and will not initialize a new one.
- ///
- /// autoBind - Boolean (default: true)
- /// If set to false the widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the data source is fired. By default the widget will bind to the data source specified in the configuration.
- ///
- /// type - String (default: "squarified")
- /// The layout type for the TreeMap.The Supported values are: squarified; horizontal or vertical.
- ///
- /// theme - String (default: "default")
- /// The theme of the TreeMap.
- ///
- /// valueField - String (default: "value")
- /// The data item field which contains the tile value.
- ///
- /// colorField - String (default: "color")
- /// The data item field which contains the tile color.
- ///
- /// textField - String (default: "text")
- /// The data item field which contains the tile title.
- ///
- /// template - String|Function
- /// The template which renders the treeMap tile content.The fields which can be used in the template are: dataItem - the original data item used to construct the point. or text - the original tile text..
- ///
- /// colors - Array
- /// The default colors for the TreeMap items (tiles). Can be set to array of specific colors or array of color ranges. For more information on the widget behavior, see the Colors section on the TreeMap Overview page.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- if (!kendo.date) {
- kendo.date = {};
- }
- if (!kendo.drawing) {
- kendo.drawing = {};
- }
- kendo.drawing.Arc = function() { };
- kendo.drawing.Arc.prototype = {
- bbox: function() {
- /// <summary>
- /// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with transformations applied.</returns>
- },
- clip: function(clip) {
- /// <summary>
- /// Gets or sets the element clipping path. Inherited from Element.clip
- /// </summary>
- /// <param name="clip" type="kendo.drawing.Path" >The element clipping path.</param>
- /// <returns type="kendo.drawing.Path">The current element clipping path.</returns>
- },
- clippedBBox: function() {
- /// <summary>
- /// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with clipping transformations applied.</returns>
- },
- containsPoint: function(point) {
- /// <summary>
- /// Returns true if the shape contains the specified point.
- /// </summary>
- /// <param name="point" type="kendo.geometry.Point" >The point that should be checked.</param>
- /// <returns type="Boolean">value indicating if the shape contains the point.</returns>
- },
- geometry: function(value) {
- /// <summary>
- /// Gets or sets the arc geometry.
- /// </summary>
- /// <param name="value" type="kendo.geometry.Arc" >The new geometry to use.</param>
- /// <returns type="kendo.geometry.Arc">The current arc geometry.</returns>
- },
- fill: function(color,opacity) {
- /// <summary>
- /// Sets the shape fill.
- /// </summary>
- /// <param name="color" type="String" >The fill color to set.</param>
- /// <param name="opacity" type="Number" >The fill opacity to set.</param>
- /// <returns type="kendo.drawing.Arc">The current instance to allow chaining.</returns>
- },
- opacity: function(opacity) {
- /// <summary>
- /// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
- /// </summary>
- /// <param name="opacity" type="Number" >The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).</param>
- /// <returns type="Number">The current element opacity.</returns>
- },
- stroke: function(color,width,opacity) {
- /// <summary>
- /// Sets the shape stroke.
- /// </summary>
- /// <param name="color" type="String" >The stroke color to set.</param>
- /// <param name="width" type="Number" >The stroke width to set.</param>
- /// <param name="opacity" type="Number" >The stroke opacity to set.</param>
- /// <returns type="kendo.drawing.Arc">The current instance to allow chaining.</returns>
- },
- transform: function(transform) {
- /// <summary>
- /// Gets or sets the transformation of the element. Inherited from Element.transform
- /// </summary>
- /// <param name="transform" type="kendo.geometry.Transformation" >The transformation to apply to the element.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation on the element.</returns>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the element. Inherited from Element.visible
- /// </summary>
- /// <param name="visible" type="Boolean" >A flag indicating if the element should be visible.</param>
- /// <returns type="Boolean">true if the element is visible; false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoArc = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Arc widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Arc">The kendo.drawing.Arc instance (if present).</returns>
- };
- $.fn.kendoArc = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Arc widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// clip - kendo.drawing.Path
- /// The element clipping path. Inherited from Element.clip
- ///
- /// cursor - String
- /// The element cursor. Inherited from Element.cursor
- ///
- /// fill - kendo.drawing.FillOptions
- /// The fill options of the shape.
- ///
- /// opacity - Number
- /// The element opacity. Inherited from Element.opacity
- ///
- /// stroke - kendo.drawing.StrokeOptions
- /// The stroke options of the shape.
- ///
- /// tooltip - kendo.drawing.TooltipOptions
- /// The tooltip options of the shape.
- ///
- /// transform - kendo.geometry.Transformation
- /// The transformation to apply to this element. Inherited from Element.transform
- ///
- /// visible - Boolean
- /// A flag, indicating if the element is visible. Inherited from Element.visible
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.Circle = function() { };
- kendo.drawing.Circle.prototype = {
- bbox: function() {
- /// <summary>
- /// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with transformations applied.</returns>
- },
- clip: function(clip) {
- /// <summary>
- /// Gets or sets the element clipping path. Inherited from Element.clip
- /// </summary>
- /// <param name="clip" type="kendo.drawing.Path" >The element clipping path.</param>
- /// <returns type="kendo.drawing.Path">The current element clipping path.</returns>
- },
- clippedBBox: function() {
- /// <summary>
- /// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with clipping transformations applied.</returns>
- },
- containsPoint: function(point) {
- /// <summary>
- /// Returns true if the shape contains the specified point.
- /// </summary>
- /// <param name="point" type="kendo.geometry.Point" >The point that should be checked.</param>
- /// <returns type="Boolean">value indicating if the shape contains the point.</returns>
- },
- geometry: function(value) {
- /// <summary>
- /// Gets or sets the circle geometry.
- /// </summary>
- /// <param name="value" type="kendo.geometry.Circle" >The new geometry to use.</param>
- /// <returns type="kendo.geometry.Circle">The current circle geometry.</returns>
- },
- fill: function(color,opacity) {
- /// <summary>
- /// Sets the shape fill.
- /// </summary>
- /// <param name="color" type="String" >The fill color to set.</param>
- /// <param name="opacity" type="Number" >The fill opacity to set.</param>
- /// <returns type="kendo.drawing.Circle">The current instance to allow chaining.</returns>
- },
- opacity: function(opacity) {
- /// <summary>
- /// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
- /// </summary>
- /// <param name="opacity" type="Number" >The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).</param>
- /// <returns type="Number">The current element opacity.</returns>
- },
- stroke: function(color,width,opacity) {
- /// <summary>
- /// Sets the shape stroke.
- /// </summary>
- /// <param name="color" type="String" >The stroke color to set.</param>
- /// <param name="width" type="Number" >The stroke width to set.</param>
- /// <param name="opacity" type="Number" >The stroke opacity to set.</param>
- /// <returns type="kendo.drawing.Circle">The current instance to allow chaining.</returns>
- },
- transform: function(transform) {
- /// <summary>
- /// Gets or sets the transformation of the element. Inherited from Element.transform
- /// </summary>
- /// <param name="transform" type="kendo.geometry.Transformation" >The transformation to apply to the element.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation on the element.</returns>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the element. Inherited from Element.visible
- /// </summary>
- /// <param name="visible" type="Boolean" >A flag indicating if the element should be visible.</param>
- /// <returns type="Boolean">true if the element is visible; false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoCircle = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Circle widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Circle">The kendo.drawing.Circle instance (if present).</returns>
- };
- $.fn.kendoCircle = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Circle widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// clip - kendo.drawing.Path
- /// The element clipping path. Inherited from Element.clip
- ///
- /// cursor - String
- /// The element cursor. Inherited from Element.cursor
- ///
- /// fill - kendo.drawing.FillOptions
- /// The fill options of the shape.
- ///
- /// opacity - Number
- /// The element opacity. Inherited from Element.opacity
- ///
- /// stroke - kendo.drawing.StrokeOptions
- /// The stroke options of the shape.
- ///
- /// tooltip - kendo.drawing.TooltipOptions
- /// The tooltip options of the shape.
- ///
- /// transform - kendo.geometry.Transformation
- /// The transformation to apply to this element. Inherited from Element.transform
- ///
- /// visible - Boolean
- /// A flag, indicating if the element is visible. Inherited from Element.visible
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.Element = function() { };
- kendo.drawing.Element.prototype = {
- bbox: function() {
- /// <summary>
- /// Returns the bounding box of the element with transformations applied.
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with transformations applied.</returns>
- },
- clip: function(clip) {
- /// <summary>
- /// Gets or sets the element clipping path.
- /// </summary>
- /// <param name="clip" type="kendo.drawing.Path" >The element clipping path.</param>
- /// <returns type="kendo.drawing.Path">The current element clipping path.</returns>
- },
- clippedBBox: function() {
- /// <summary>
- /// Returns the bounding box of the element with clipping and transformations applied.This is the rectangle that will fit around the actual rendered element.
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with clipping and transformations applied.</returns>
- },
- containsPoint: function(point) {
- /// <summary>
- /// Returns true if the shape contains the specified point.
- /// </summary>
- /// <param name="point" type="kendo.geometry.Point" >The point that should be checked.</param>
- /// <returns type="Boolean">value indicating if the shape contains the point.</returns>
- },
- opacity: function(opacity) {
- /// <summary>
- /// Gets or sets the element opacity.
- /// </summary>
- /// <param name="opacity" type="Number" >The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).</param>
- /// <returns type="Number">The current element opacity.</returns>
- },
- transform: function(transform) {
- /// <summary>
- /// Gets or sets the transformation of the element.
- /// </summary>
- /// <param name="transform" type="kendo.geometry.Transformation" >The transformation to apply to the element.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation on the element.</returns>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the element.
- /// </summary>
- /// <param name="visible" type="Boolean" >A flag indicating if the element should be visible.</param>
- /// <returns type="Boolean">true if the element is visible; false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoElement = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Element widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Element">The kendo.drawing.Element instance (if present).</returns>
- };
- $.fn.kendoElement = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Element widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// clip - kendo.drawing.Path
- /// The clipping path for this element.The path instance will be monitored for changes. It can be replaced by calling the clip method.
- ///
- /// cursor - String
- /// The element CSS cursor.Applicable to an SVG output.
- ///
- /// opacity - Number
- /// The element opacity.
- ///
- /// transform - kendo.geometry.Transformation
- /// The transformation to apply to this element.
- ///
- /// visible - Boolean
- /// A flag, indicating if the element is visible.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.FillOptions = function() { };
- kendo.drawing.FillOptions.prototype = {
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoFillOptions = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.FillOptions widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.FillOptions">The kendo.drawing.FillOptions instance (if present).</returns>
- };
- $.fn.kendoFillOptions = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.FillOptions widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.Gradient = function() { };
- kendo.drawing.Gradient.prototype = {
- addStop: function(offset,color,opacity) {
- /// <summary>
- /// Adds a color stop to the gradient.
- /// </summary>
- /// <param name="offset" type="Number" >The stop offset from the start of the element. Ranges from 0 (start of gradient) to 1 (end of gradient).</param>
- /// <param name="color" type="String" >The color in any of the following formats.| Format | Description | --- | --- | --- | red | Basic or Extended CSS Color name | #ff0000 | Hex RGB value | rgb(255, 0, 0) | RGB valueSpecifying 'none', 'transparent' or '' (empty string) will clear the fill.</param>
- /// <param name="opacity" type="Number" >The fill opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).</param>
- /// <returns type="kendo.drawing.GradientStop">The new gradient color stop.</returns>
- },
- removeStop: function(stop) {
- /// <summary>
- /// Removes a color stop from the gradient.
- /// </summary>
- /// <param name="stop" type="kendo.drawing.GradientStop" >The gradient color stop to remove.</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoGradient = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Gradient widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Gradient">The kendo.drawing.Gradient instance (if present).</returns>
- };
- $.fn.kendoGradient = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Gradient widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// stops - Array
- /// The color stops of the gradient. Can contain either plain objects or GradientStop instances.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.GradientStop = function() { };
- kendo.drawing.GradientStop.prototype = {
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoGradientStop = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.GradientStop widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.GradientStop">The kendo.drawing.GradientStop instance (if present).</returns>
- };
- $.fn.kendoGradientStop = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.GradientStop widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// offset - Number
- /// The stop offset from the start of the element. Ranges from 0 (start of gradient) to 1 (end of gradient).
- ///
- /// color - String
- /// The color in any of the following formats.| Format | Description | --- | --- | --- | red | Basic or Extended CSS Color name | #ff0000 | Hex RGB value | rgb(255, 0, 0) | RGB valueSpecifying 'none', 'transparent' or '' (empty string) will clear the fill.
- ///
- /// opacity - Number
- /// The fill opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.Group = function() { };
- kendo.drawing.Group.prototype = {
- append: function(element) {
- /// <summary>
- /// Appends the specified element as a last child of the group.
- /// </summary>
- /// <param name="element" type="kendo.drawing.Element" >The element to append. Multiple parameters are accepted.</param>
- },
- clear: function() {
- /// <summary>
- /// Removes all child elements from the group.
- /// </summary>
- },
- clip: function(clip) {
- /// <summary>
- /// Gets or sets the group clipping path. Inherited from Element.clip
- /// </summary>
- /// <param name="clip" type="kendo.drawing.Path" >The group clipping path.</param>
- /// <returns type="kendo.drawing.Path">The current group clipping path.</returns>
- },
- clippedBBox: function() {
- /// <summary>
- /// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with clipping transformations applied.</returns>
- },
- containsPoint: function(point) {
- /// <summary>
- /// Returns true if the shape contains the specified point.
- /// </summary>
- /// <param name="point" type="kendo.geometry.Point" >The point that should be checked.</param>
- /// <returns type="Boolean">value indicating if the shape contains the point.</returns>
- },
- insert: function(position,element) {
- /// <summary>
- /// Inserts an element at the specified position.
- /// </summary>
- /// <param name="position" type="Number" >The position to insert the element at. Existing children beyond this position will be shifted right.</param>
- /// <param name="element" type="kendo.drawing.Element" >The element to insert.</param>
- },
- opacity: function(opacity) {
- /// <summary>
- /// Gets or sets the group opacity. Inherited from Element.opacityThe opacity of any child groups and elements will be multiplied by this value.
- /// </summary>
- /// <param name="opacity" type="Number" >The group opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).</param>
- /// <returns type="Number">The current group opacity.</returns>
- },
- remove: function(element) {
- /// <summary>
- /// Removes the specified element from the group.
- /// </summary>
- /// <param name="element" type="kendo.drawing.Element" >The element to remove.</param>
- },
- removeAt: function(index) {
- /// <summary>
- /// Removes the child element at the specified position.
- /// </summary>
- /// <param name="index" type="Number" >The index at which the element currently resides.</param>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the element.
- /// </summary>
- /// <param name="visible" type="Boolean" >A flag indicating if the element should be visible.</param>
- /// <returns type="Boolean">true if the element is visible; false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoGroup = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Group widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Group">The kendo.drawing.Group instance (if present).</returns>
- };
- $.fn.kendoGroup = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Group widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// clip - kendo.drawing.Path
- /// The group clipping path. Inherited from Element.clip
- ///
- /// cursor - String
- /// The group cursor. Inherited from Element.cursor
- ///
- /// opacity - Number
- /// The group opacity. Inherited from Element.opacityThe opacity of any child groups and elements will be multiplied by this value.
- ///
- /// pdf - kendo.drawing.PDFOptions
- /// Page options to apply during PDF export.
- ///
- /// tooltip - kendo.drawing.TooltipOptions
- /// The tooltip options of the shape.
- ///
- /// transform - kendo.geometry.Transformation
- /// The transformation to apply to this group and its children. Inherited from Element.transform
- ///
- /// visible - Boolean
- /// A flag, indicating if the group and its children are visible. Inherited from Element.visible
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.Image = function() { };
- kendo.drawing.Image.prototype = {
- bbox: function() {
- /// <summary>
- /// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with transformations applied.</returns>
- },
- clip: function(clip) {
- /// <summary>
- /// Gets or sets the element clipping path. Inherited from Element.clip
- /// </summary>
- /// <param name="clip" type="kendo.drawing.Path" >The element clipping path.</param>
- /// <returns type="kendo.drawing.Path">The current element clipping path.</returns>
- },
- clippedBBox: function() {
- /// <summary>
- /// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with clipping transformations applied.</returns>
- },
- containsPoint: function(point) {
- /// <summary>
- /// Returns true if the shape contains the specified point.
- /// </summary>
- /// <param name="point" type="kendo.geometry.Point" >The point that should be checked.</param>
- /// <returns type="Boolean">value indicating if the shape contains the point.</returns>
- },
- opacity: function(opacity) {
- /// <summary>
- /// Gets or sets the element opacity. Inherited from Element.opacity
- /// </summary>
- /// <param name="opacity" type="Number" >The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).</param>
- /// <returns type="Number">The current element opacity.</returns>
- },
- src: function(value) {
- /// <summary>
- /// Gets or sets the image source URL.
- /// </summary>
- /// <param name="value" type="String" >The new source URL.</param>
- /// <returns type="String">The current image source URL.</returns>
- },
- rect: function(value) {
- /// <summary>
- /// Gets or sets the rectangle defines the image position and size.
- /// </summary>
- /// <param name="value" type="kendo.geometry.Rect" >The new image rectangle.</param>
- /// <returns type="kendo.geometry.Rect">The current image rectangle.</returns>
- },
- transform: function(transform) {
- /// <summary>
- /// Gets or sets the transformation of the element. Inherited from Element.transform
- /// </summary>
- /// <param name="transform" type="kendo.geometry.Transformation" >The transformation to apply to the element.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation on the element.</returns>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the element. Inherited from Element.visible
- /// </summary>
- /// <param name="visible" type="Boolean" >A flag indicating if the element should be visible.</param>
- /// <returns type="Boolean">true if the element is visible; false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoImage = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Image widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Image">The kendo.drawing.Image instance (if present).</returns>
- };
- $.fn.kendoImage = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Image widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// clip - kendo.drawing.Path
- /// The element clipping path. Inherited from Element.clip
- ///
- /// cursor - String
- /// The element cursor. Inherited from Element.cursor
- ///
- /// opacity - Number
- /// The element opacity. Inherited from Element.opacity
- ///
- /// tooltip - kendo.drawing.TooltipOptions
- /// The tooltip options of the shape.
- ///
- /// transform - kendo.geometry.Transformation
- /// The transformation to apply to this element. Inherited from Element.transform
- ///
- /// visible - Boolean
- /// A flag, indicating if the element is visible. Inherited from Element.visible
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.Layout = function() { };
- kendo.drawing.Layout.prototype = {
- rect: function(rect) {
- /// <summary>
- /// Gets or sets the layout rectangle.
- /// </summary>
- /// <param name="rect" type="kendo.geometry.Rect" >The layout rectangle.</param>
- /// <returns type="kendo.geometry.Rect">The current rectangle.</returns>
- },
- reflow: function() {
- /// <summary>
- /// Arranges the elements based on the current options.
- /// </summary>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoLayout = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Layout widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Layout">The kendo.drawing.Layout instance (if present).</returns>
- };
- $.fn.kendoLayout = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Layout widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// alignContent - String (default: "start")
- /// Specifies the alignment of the content. The supported values are: "start" - aligns the content to the rectangle origin.; "center" - aligns the content to the rectangle center. or "end" - aligns the content to the rectangle end..
- ///
- /// alignItems - String (default: "start")
- /// Specifies the alignment of the items based on the largest one. The supported values are: "start" - aligns the items to the start of the largest element.; "center" - aligns the items to the center of the largest element. or "end" - aligns the items to the end of the largest element..
- ///
- /// justifyContent - String (default: "start")
- /// Specifies how should the content be justified. The supported values are: "start" - aligns the items to the rectangle origin.; "center" - aligns the items to the rectangle center. or "end" - aligns the items to the rectangle end..
- ///
- /// lineSpacing - Number (default: 0)
- /// Specifies the distance between the lines for wrapped layout.
- ///
- /// spacing - Number (default: 0)
- /// Specifies the distance between the elements.
- ///
- /// orientation - String (default: "horizontal")
- /// Specifies layout orientation. The supported values are: "horizontal" - the elements are arranged horizontally. or "vertical" - the elements are arranged vertically..
- ///
- /// wrap - Boolean (default: true)
- /// Specifies the behavior when the elements size exceeds the rectangle size. If set to true, the elements will be moved to the next "line". If set to false, the layout will be scaled so that the elements fit in the rectangle.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.LinearGradient = function() { };
- kendo.drawing.LinearGradient.prototype = {
- addStop: function(offset,color,opacity) {
- /// <summary>
- /// Adds a color stop to the gradient. Inherited from Gradient.addStop
- /// </summary>
- /// <param name="offset" type="Number" ></param>
- /// <param name="color" type="String" >The color of the stop.</param>
- /// <param name="opacity" type="Number" >The fill opacity.</param>
- /// <returns type="kendo.drawing.GradientStop">The new gradient color stop.</returns>
- },
- end: function(end) {
- /// <summary>
- /// Gets or sets the end point of the gradient.
- /// </summary>
- /// <param name="end" type="Object" >The end point of the gradient.Coordinates are relative to the shape bounding box. For example [0, 0] is top left and [1, 1] is bottom right.</param>
- /// <returns type="kendo.geometry.Point">The current end point of the gradient.</returns>
- },
- start: function(start) {
- /// <summary>
- /// Gets or sets the start point of the gradient.
- /// </summary>
- /// <param name="start" type="Object" >The start point of the gradient.Coordinates are relative to the shape bounding box. For example [0, 0] is top left and [1, 1] is bottom right.</param>
- /// <returns type="kendo.geometry.Point">The current start point of the gradient.</returns>
- },
- removeStop: function(stop) {
- /// <summary>
- /// Removes a color stop from the gradient. Inherited from Gradient.removeStop
- /// </summary>
- /// <param name="stop" type="kendo.drawing.GradientStop" >The gradient color stop to remove.</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoLinearGradient = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.LinearGradient widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.LinearGradient">The kendo.drawing.LinearGradient instance (if present).</returns>
- };
- $.fn.kendoLinearGradient = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.LinearGradient widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// stops - Array
- /// The color stops of the gradient. Can contain either plain objects or GradientStop instances.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.MultiPath = function() { };
- kendo.drawing.MultiPath.prototype = {
- bbox: function() {
- /// <summary>
- /// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with transformations applied.</returns>
- },
- clip: function(clip) {
- /// <summary>
- /// Gets or sets the element clipping path. Inherited from Element.clip
- /// </summary>
- /// <param name="clip" type="kendo.drawing.Path" >The element clipping path.</param>
- /// <returns type="kendo.drawing.Path">The current element clipping path.</returns>
- },
- clippedBBox: function() {
- /// <summary>
- /// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with clipping transformations applied.</returns>
- },
- close: function() {
- /// <summary>
- /// Closes the current sub-path by linking its current end point with its start point.
- /// </summary>
- /// <returns type="kendo.drawing.MultiPath">The current instance to allow chaining.</returns>
- },
- containsPoint: function(point) {
- /// <summary>
- /// Returns true if the shape contains the specified point.
- /// </summary>
- /// <param name="point" type="kendo.geometry.Point" >The point that should be checked.</param>
- /// <returns type="Boolean">value indicating if the shape contains the point.</returns>
- },
- curveTo: function(controlOut,controlIn,endPoint) {
- /// <summary>
- /// Draws a cubic Bézier curve (with two control points).A quadratic Bézier curve (with one control point) can be plotted by making the control point equal.
- /// </summary>
- /// <param name="controlOut" type="Object" >The first control point for the curve.</param>
- /// <param name="controlIn" type="Object" >The second control point for the curve.</param>
- /// <param name="endPoint" type="Object" >The curve end point.</param>
- /// <returns type="kendo.drawing.MultiPath">The current instance to allow chaining.</returns>
- },
- fill: function(color,opacity) {
- /// <summary>
- /// Sets the shape fill.
- /// </summary>
- /// <param name="color" type="String" >The fill color to set.</param>
- /// <param name="opacity" type="Number" >The fill opacity to set.</param>
- /// <returns type="kendo.drawing.MultiPath">The current instance to allow chaining.</returns>
- },
- lineTo: function(x,y) {
- /// <summary>
- /// Draws a straight line to the specified absolute coordinates.
- /// </summary>
- /// <param name="x" type="Object" >The line end X coordinate or a Point/Array with X and Y coordinates.</param>
- /// <param name="y" type="Number" >The line end Y coordinate.Optional if the first parameter is a Point/Array.</param>
- /// <returns type="kendo.drawing.MultiPath">The current instance to allow chaining.</returns>
- },
- moveTo: function(x,y) {
- /// <summary>
- /// Creates a new sub-path or clears all segments and moves the starting point to the specified absolute coordinates.
- /// </summary>
- /// <param name="x" type="Object" >The starting X coordinate or a Point/Array with X and Y coordinates.</param>
- /// <param name="y" type="Number" >The starting Y coordinate.Optional if the first parameter is a Point/Array.</param>
- /// <returns type="kendo.drawing.MultiPath">The current instance to allow chaining.</returns>
- },
- opacity: function(opacity) {
- /// <summary>
- /// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
- /// </summary>
- /// <param name="opacity" type="Number" >The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).</param>
- /// <returns type="Number">The current element opacity.</returns>
- },
- stroke: function(color,width,opacity) {
- /// <summary>
- /// Sets the shape stroke.
- /// </summary>
- /// <param name="color" type="String" >The stroke color to set.</param>
- /// <param name="width" type="Number" >The stroke width to set.</param>
- /// <param name="opacity" type="Number" >The stroke opacity to set.</param>
- /// <returns type="kendo.drawing.MultiPath">The current instance to allow chaining.</returns>
- },
- transform: function(transform) {
- /// <summary>
- /// Gets or sets the transformation of the element. Inherited from Element.transform
- /// </summary>
- /// <param name="transform" type="kendo.geometry.Transformation" >The transformation to apply to the element.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation on the element.</returns>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the element. Inherited from Element.visible
- /// </summary>
- /// <param name="visible" type="Boolean" >A flag indicating if the element should be visible.</param>
- /// <returns type="Boolean">true if the element is visible; false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoMultiPath = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.MultiPath widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.MultiPath">The kendo.drawing.MultiPath instance (if present).</returns>
- };
- $.fn.kendoMultiPath = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.MultiPath widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// clip - kendo.drawing.Path
- /// The element clipping path. Inherited from Element.clip
- ///
- /// cursor - String
- /// The element cursor. Inherited from Element.cursor
- ///
- /// fill - kendo.drawing.FillOptions
- /// The fill options of the shape.
- ///
- /// opacity - Number
- /// The element opacity. Inherited from Element.opacity
- ///
- /// stroke - kendo.drawing.StrokeOptions
- /// The stroke options of the shape.
- ///
- /// tooltip - kendo.drawing.TooltipOptions
- /// The tooltip options of the shape.
- ///
- /// transform - kendo.geometry.Transformation
- /// The transformation to apply to this element. Inherited from Element.transform
- ///
- /// visible - Boolean
- /// A flag, indicating if the element is visible. Inherited from Element.visible
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.OptionsStore = function() { };
- kendo.drawing.OptionsStore.prototype = {
- get: function(field) {
- /// <summary>
- /// Gets the value of the specified option.
- /// </summary>
- /// <param name="field" type="String" >The field name to retrieve. Must be a fully qualified name (e.g. "foo.bar") for nested options.</param>
- /// <returns type="Object">The current option value.</returns>
- },
- set: function(field,value) {
- /// <summary>
- /// Sets the value of the specified option.
- /// </summary>
- /// <param name="field" type="String" >The name of the option to set. Must be a fully qualified name (e.g. "foo.bar") for nested options.</param>
- /// <param name="value" type="Object" >The new option value.If the new value is exactly the same as the new value the operation will not trigger options change on the observer (if any).</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoOptionsStore = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.OptionsStore widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.OptionsStore">The kendo.drawing.OptionsStore instance (if present).</returns>
- };
- $.fn.kendoOptionsStore = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.OptionsStore widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.PDFOptions = function() { };
- kendo.drawing.PDFOptions.prototype = {
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoPDFOptions = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.PDFOptions widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.PDFOptions">The kendo.drawing.PDFOptions instance (if present).</returns>
- };
- $.fn.kendoPDFOptions = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.PDFOptions widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.Path = function() { };
- kendo.drawing.Path.prototype = {
- bbox: function() {
- /// <summary>
- /// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with transformations applied.</returns>
- },
- clip: function(clip) {
- /// <summary>
- /// Gets or sets the element clipping path. Inherited from Element.clip
- /// </summary>
- /// <param name="clip" type="kendo.drawing.Path" >The element clipping path.</param>
- /// <returns type="kendo.drawing.Path">The current element clipping path.</returns>
- },
- clippedBBox: function() {
- /// <summary>
- /// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with clipping transformations applied.</returns>
- },
- close: function() {
- /// <summary>
- /// Closes the path by linking the current end point with the start point.
- /// </summary>
- /// <returns type="kendo.drawing.Path">The current instance to allow chaining.</returns>
- },
- containsPoint: function(point) {
- /// <summary>
- /// Returns true if the shape contains the specified point.
- /// </summary>
- /// <param name="point" type="kendo.geometry.Point" >The point that should be checked.</param>
- /// <returns type="Boolean">value indicating if the shape contains the point.</returns>
- },
- curveTo: function(controlOut,controlIn,endPoint) {
- /// <summary>
- /// Draws a cubic Bézier curve (with two control points).A quadratic Bézier curve (with one control point) can be plotted by making the control point equal.
- /// </summary>
- /// <param name="controlOut" type="Object" >The first control point for the curve.</param>
- /// <param name="controlIn" type="Object" >The second control point for the curve.</param>
- /// <param name="endPoint" type="Object" >The curve end point.</param>
- /// <returns type="kendo.drawing.Path">The current instance to allow chaining.</returns>
- },
- fill: function(color,opacity) {
- /// <summary>
- /// Sets the shape fill.
- /// </summary>
- /// <param name="color" type="String" >The fill color to set.</param>
- /// <param name="opacity" type="Number" >The fill opacity to set.</param>
- /// <returns type="kendo.drawing.Path">The current instance to allow chaining.</returns>
- },
- lineTo: function(x,y) {
- /// <summary>
- /// Draws a straight line to the specified absolute coordinates.
- /// </summary>
- /// <param name="x" type="Object" >The line end X coordinate or a Point/Array with X and Y coordinates.</param>
- /// <param name="y" type="Number" >The line end Y coordinate.Optional if the first parameter is a Point/Array.</param>
- /// <returns type="kendo.drawing.Path">The current instance to allow chaining.</returns>
- },
- moveTo: function(x,y) {
- /// <summary>
- /// Clears all existing segments and moves the starting point to the specified absolute coordinates.
- /// </summary>
- /// <param name="x" type="Object" >The starting X coordinate or a Point/Array with X and Y coordinates.</param>
- /// <param name="y" type="Number" >The starting Y coordinate.Optional if the first parameter is a Point/Array.</param>
- /// <returns type="kendo.drawing.Path">The current instance to allow chaining.</returns>
- },
- opacity: function(opacity) {
- /// <summary>
- /// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
- /// </summary>
- /// <param name="opacity" type="Number" >The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).</param>
- /// <returns type="Number">The current element opacity.</returns>
- },
- stroke: function(color,width,opacity) {
- /// <summary>
- /// Sets the shape stroke.
- /// </summary>
- /// <param name="color" type="String" >The stroke color to set.</param>
- /// <param name="width" type="Number" >The stroke width to set.</param>
- /// <param name="opacity" type="Number" >The stroke opacity to set.</param>
- /// <returns type="kendo.drawing.Path">The current instance to allow chaining.</returns>
- },
- transform: function(transform) {
- /// <summary>
- /// Gets or sets the transformation of the element. Inherited from Element.transform
- /// </summary>
- /// <param name="transform" type="kendo.geometry.Transformation" >The transformation to apply to the element.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation on the element.</returns>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the element. Inherited from Element.visible
- /// </summary>
- /// <param name="visible" type="Boolean" >A flag indicating if the element should be visible.</param>
- /// <returns type="Boolean">true if the element is visible; false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoPath = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Path widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Path">The kendo.drawing.Path instance (if present).</returns>
- };
- $.fn.kendoPath = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Path widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// clip - kendo.drawing.Path
- /// The element clipping path. Inherited from Element.clip
- ///
- /// cursor - String
- /// The element cursor. Inherited from Element.cursor
- ///
- /// fill - kendo.drawing.FillOptions
- /// The fill options of the shape.
- ///
- /// opacity - Number
- /// The element opacity. Inherited from Element.opacity
- ///
- /// stroke - kendo.drawing.StrokeOptions
- /// The stroke options of the shape.
- ///
- /// tooltip - kendo.drawing.TooltipOptions
- /// The tooltip options of the shape.
- ///
- /// transform - kendo.geometry.Transformation
- /// The transformation to apply to this element. Inherited from Element.transform
- ///
- /// visible - Boolean
- /// A flag, indicating if the element is visible. Inherited from Element.visible
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.RadialGradient = function() { };
- kendo.drawing.RadialGradient.prototype = {
- addStop: function(offset,color,opacity) {
- /// <summary>
- /// Adds a color stop to the gradient. Inherited from Gradient.addStop
- /// </summary>
- /// <param name="offset" type="Number" ></param>
- /// <param name="color" type="String" >The color of the stop.</param>
- /// <param name="opacity" type="Number" >The fill opacity.</param>
- /// <returns type="kendo.drawing.GradientStop">The new gradient color stop.</returns>
- },
- center: function(center) {
- /// <summary>
- /// Gets or sets the center point of the gradient.
- /// </summary>
- /// <param name="center" type="Object" >The center point of the gradient.Coordinates are relative to the shape bounding box. For example [0, 0] is top left and [1, 1] is bottom right.</param>
- /// <returns type="kendo.geometry.Point">The current radius of the gradient.</returns>
- },
- radius: function(value) {
- /// <summary>
- /// Gets or sets the radius of the gradient.
- /// </summary>
- /// <param name="value" type="Number" >The new radius of the gradient.</param>
- /// <returns type="Number">The current radius of the gradient.</returns>
- },
- removeStop: function(stop) {
- /// <summary>
- /// Removes a color stop from the gradient. Inherited from Gradient.removeStop
- /// </summary>
- /// <param name="stop" type="kendo.drawing.GradientStop" >The gradient color stop to remove.</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoRadialGradient = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.RadialGradient widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.RadialGradient">The kendo.drawing.RadialGradient instance (if present).</returns>
- };
- $.fn.kendoRadialGradient = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.RadialGradient widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// center - Array|kendo.geometry.Point
- /// The center of the gradient.Coordinates are relative to the shape bounding box. For example [0, 0] is top left and [1, 1] is bottom right.
- ///
- /// radius - Number (default: 1)
- /// The radius of the radial gradient relative to the shape bounding box.
- ///
- /// stops - Array
- /// The color stops of the gradient. Can contain either plain objects or GradientStop instances.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.Rect = function() { };
- kendo.drawing.Rect.prototype = {
- bbox: function() {
- /// <summary>
- /// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with transformations applied.</returns>
- },
- clip: function(clip) {
- /// <summary>
- /// Gets or sets the element clipping path. Inherited from Element.clip
- /// </summary>
- /// <param name="clip" type="kendo.drawing.Path" >The element clipping path.</param>
- /// <returns type="kendo.drawing.Path">The current element clipping path.</returns>
- },
- clippedBBox: function() {
- /// <summary>
- /// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with clipping transformations applied.</returns>
- },
- containsPoint: function(point) {
- /// <summary>
- /// Returns true if the shape contains the specified point.
- /// </summary>
- /// <param name="point" type="kendo.geometry.Point" >The point that should be checked.</param>
- /// <returns type="Boolean">value indicating if the shape contains the point.</returns>
- },
- geometry: function(value) {
- /// <summary>
- /// Gets or sets the rectangle geometry.
- /// </summary>
- /// <param name="value" type="kendo.geometry.Rect" >The new geometry to use.</param>
- /// <returns type="kendo.geometry.Rect">The current rectangle geometry.</returns>
- },
- fill: function(color,opacity) {
- /// <summary>
- /// Sets the shape fill.
- /// </summary>
- /// <param name="color" type="String" >The fill color to set.</param>
- /// <param name="opacity" type="Number" >The fill opacity to set.</param>
- /// <returns type="kendo.drawing.Rect">The current instance to allow chaining.</returns>
- },
- opacity: function(opacity) {
- /// <summary>
- /// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
- /// </summary>
- /// <param name="opacity" type="Number" >The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).</param>
- /// <returns type="Number">The current element opacity.</returns>
- },
- stroke: function(color,width,opacity) {
- /// <summary>
- /// Sets the shape stroke.
- /// </summary>
- /// <param name="color" type="String" >The stroke color to set.</param>
- /// <param name="width" type="Number" >The stroke width to set.</param>
- /// <param name="opacity" type="Number" >The stroke opacity to set.</param>
- /// <returns type="kendo.drawing.Rect">The current instance to allow chaining.</returns>
- },
- transform: function(transform) {
- /// <summary>
- /// Gets or sets the transformation of the element. Inherited from Element.transform
- /// </summary>
- /// <param name="transform" type="kendo.geometry.Transformation" >The transformation to apply to the element.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation on the element.</returns>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the element. Inherited from Element.visible
- /// </summary>
- /// <param name="visible" type="Boolean" >A flag indicating if the element should be visible.</param>
- /// <returns type="Boolean">true if the element is visible; false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoRect = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Rect widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Rect">The kendo.drawing.Rect instance (if present).</returns>
- };
- $.fn.kendoRect = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Rect widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// clip - kendo.drawing.Path
- /// The element clipping path. Inherited from Element.clip
- ///
- /// cursor - String
- /// The element cursor. Inherited from Element.cursor
- ///
- /// fill - kendo.drawing.FillOptions
- /// The fill options of the shape.
- ///
- /// opacity - Number
- /// The element opacity. Inherited from Element.opacity
- ///
- /// stroke - kendo.drawing.StrokeOptions
- /// The stroke options of the shape.
- ///
- /// tooltip - kendo.drawing.TooltipOptions
- /// The tooltip options of the shape.
- ///
- /// transform - kendo.geometry.Transformation
- /// The transformation to apply to this element. Inherited from Element.transform
- ///
- /// visible - Boolean
- /// A flag, indicating if the element is visible. Inherited from Element.visible
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.Segment = function() { };
- kendo.drawing.Segment.prototype = {
- anchor: function(value) {
- /// <summary>
- /// Gets or sets the segment anchor point.The setter returns the current Segment to allow chaining.
- /// </summary>
- /// <param name="value" type="kendo.geometry.Point" >The new anchor point.</param>
- /// <returns type="kendo.geometry.Point">The current anchor point.</returns>
- },
- controlIn: function(value) {
- /// <summary>
- /// Gets or sets the first curve control point of this segment.The setter returns the current Segment to allow chaining.
- /// </summary>
- /// <param name="value" type="kendo.geometry.Point" >The new control point.</param>
- /// <returns type="kendo.geometry.Point">The current control point.</returns>
- },
- controlOut: function(value) {
- /// <summary>
- /// Gets or sets the second curve control point of this segment.The setter returns the current Segment to allow chaining.
- /// </summary>
- /// <param name="value" type="kendo.geometry.Point" >The new control point.</param>
- /// <returns type="kendo.geometry.Point">The current control point.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoSegment = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Segment widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Segment">The kendo.drawing.Segment instance (if present).</returns>
- };
- $.fn.kendoSegment = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Segment widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.StrokeOptions = function() { };
- kendo.drawing.StrokeOptions.prototype = {
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoStrokeOptions = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.StrokeOptions widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.StrokeOptions">The kendo.drawing.StrokeOptions instance (if present).</returns>
- };
- $.fn.kendoStrokeOptions = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.StrokeOptions widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.Surface = function() { };
- kendo.drawing.Surface.prototype = {
- clear: function() {
- /// <summary>
- /// Clears the drawing surface.
- /// </summary>
- },
- draw: function(element) {
- /// <summary>
- /// Draws the element and its children on the surface. Existing elements will remain visible.
- /// </summary>
- /// <param name="element" type="kendo.drawing.Element" >The element to draw.</param>
- },
- eventTarget: function(e) {
- /// <summary>
- /// Returns the target drawing element of a DOM event.
- /// </summary>
- /// <param name="e" type="Object" >The original DOM or jQuery event object.</param>
- /// <returns type="kendo.drawing.Element">The target drawing element, if any.</returns>
- },
- hideTooltip: function() {
- /// <summary>
- /// Hides the surface tooltip.
- /// </summary>
- },
- resize: function(force) {
- /// <summary>
- /// Resizes the surface to match the size of the container.
- /// </summary>
- /// <param name="force" type="Boolean" >Whether to proceed with resizing even if the container dimensions have not changed.</param>
- },
- showTooltip: function(element,options) {
- /// <summary>
- /// Shows the surface tooltip for the passed shape.
- /// </summary>
- /// <param name="element" type="kendo.drawing.Element" >The element for which the tooltip should be shown.</param>
- /// <param name="options" type="Object" >Options for the tooltip.</param>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoSurface = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Surface widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Surface">The kendo.drawing.Surface instance (if present).</returns>
- };
- $.fn.kendoSurface = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Surface widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// type - String
- /// The preferred type of surface to create. Supported types (case insensitive): - svg - canvasThis option will be ignored if not supported by the browser. See Supported Browsers.
- ///
- /// height - String (default: "100%")
- /// The height of the surface element. By default the surface will expand to fill the height of the first positioned container.
- ///
- /// width - String (default: "100%")
- /// The width of the surface element. By default the surface will expand to fill the width of the first positioned container.
- ///
- /// tooltip - Object
- /// Specifies general options for the shapes tooltip.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.Text = function() { };
- kendo.drawing.Text.prototype = {
- bbox: function() {
- /// <summary>
- /// Returns the bounding box of the element with transformations applied. Inherited from Element.bbox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with transformations applied.</returns>
- },
- clip: function(clip) {
- /// <summary>
- /// Gets or sets the element clipping path. Inherited from Element.clip
- /// </summary>
- /// <param name="clip" type="kendo.drawing.Path" >The element clipping path.</param>
- /// <returns type="kendo.drawing.Path">The current element clipping path.</returns>
- },
- clippedBBox: function() {
- /// <summary>
- /// Returns the bounding box of the element with clipping and transformations applied. Inherited from Element.clippedBBox
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The bounding box of the element with clipping transformations applied.</returns>
- },
- containsPoint: function(point) {
- /// <summary>
- /// Returns true if the shape contains the specified point.
- /// </summary>
- /// <param name="point" type="kendo.geometry.Point" >The point that should be checked.</param>
- /// <returns type="Boolean">value indicating if the shape contains the point.</returns>
- },
- content: function(value) {
- /// <summary>
- /// Gets or sets the text content.
- /// </summary>
- /// <param name="value" type="String" >The new text content to set.</param>
- /// <returns type="String">The current content of the text.</returns>
- },
- fill: function(color,opacity) {
- /// <summary>
- /// Sets the text fill.
- /// </summary>
- /// <param name="color" type="String" >The fill color to set.</param>
- /// <param name="opacity" type="Number" >The fill opacity to set.</param>
- /// <returns type="kendo.drawing.Text">The current instance to allow chaining.</returns>
- },
- opacity: function(opacity) {
- /// <summary>
- /// Gets or sets the element opacity. Inherited from Element.opacityIf set, the stroke and fill opacity will be multiplied by the element opacity.
- /// </summary>
- /// <param name="opacity" type="Number" >The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).</param>
- /// <returns type="Number">The current element opacity.</returns>
- },
- position: function(value) {
- /// <summary>
- /// Gets or sets the position of the text upper left corner.
- /// </summary>
- /// <param name="value" type="kendo.geometry.Point" >The new position of the text upper left corner.</param>
- /// <returns type="kendo.geometry.Point">The current position of the text upper left corner.</returns>
- },
- stroke: function(color,width,opacity) {
- /// <summary>
- /// Sets the text stroke.
- /// </summary>
- /// <param name="color" type="String" >The stroke color to set.</param>
- /// <param name="width" type="Number" >The stroke width to set.</param>
- /// <param name="opacity" type="Number" >The stroke opacity to set.</param>
- /// <returns type="kendo.drawing.Text">The current instance to allow chaining.</returns>
- },
- transform: function(transform) {
- /// <summary>
- /// Gets or sets the transformation of the element. Inherited from Element.transform
- /// </summary>
- /// <param name="transform" type="kendo.geometry.Transformation" >The transformation to apply to the element.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation on the element.</returns>
- },
- visible: function(visible) {
- /// <summary>
- /// Gets or sets the visibility of the element. Inherited from Element.visible
- /// </summary>
- /// <param name="visible" type="Boolean" >A flag indicating if the element should be visible.</param>
- /// <returns type="Boolean">true if the element is visible; false otherwise.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoText = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.Text widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.Text">The kendo.drawing.Text instance (if present).</returns>
- };
- $.fn.kendoText = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.Text widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// clip - kendo.drawing.Path
- /// The element clipping path. Inherited from Element.clip
- ///
- /// cursor - String
- /// The element cursor. Inherited from Element.cursor
- ///
- /// fill - kendo.drawing.FillOptions
- /// The fill options of the text.
- ///
- /// font - String
- /// The font to use for rendering the text. Accepts the standard CSS font syntax.Examples of valid font values: * Size and family: "2em 'Open Sans', sans-serif" * Style, size and family: "italic 2em 'Open Sans', sans-serif"
- ///
- /// opacity - Number
- /// The element opacity. Inherited from Element.opacity
- ///
- /// stroke - kendo.drawing.StrokeOptions
- /// The stroke options of the text.
- ///
- /// tooltip - kendo.drawing.TooltipOptions
- /// The tooltip options of the shape.
- ///
- /// transform - kendo.geometry.Transformation
- /// The transformation to apply to this element. Inherited from Element.transform
- ///
- /// visible - Boolean
- /// A flag, indicating if the element is visible. Inherited from Element.visible
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.drawing.TooltipOptions = function() { };
- kendo.drawing.TooltipOptions.prototype = {
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoTooltipOptions = function() {
- /// <summary>
- /// Returns a reference to the kendo.drawing.TooltipOptions widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.drawing.TooltipOptions">The kendo.drawing.TooltipOptions instance (if present).</returns>
- };
- $.fn.kendoTooltipOptions = function(options) {
- /// <summary>
- /// Instantiates a kendo.drawing.TooltipOptions widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- if (!kendo.effects) {
- kendo.effects = {};
- }
- kendo.geometry.Arc = function() { };
- kendo.geometry.Arc.prototype = {
- bbox: function(matrix) {
- /// <summary>
- /// Returns the bounding box of this arc after applying the specified transformation matrix.
- /// </summary>
- /// <param name="matrix" type="kendo.geometry.Matrix" >Transformation matrix to apply.</param>
- /// <returns type="kendo.geometry.Rect">The bounding box after applying the transformation matrix.</returns>
- },
- getAnticlockwise: function() {
- /// <summary>
- /// Gets the arc anticlockwise flag.
- /// </summary>
- /// <returns type="Boolean">The anticlockwise flag of the arc.</returns>
- },
- getCenter: function() {
- /// <summary>
- /// Gets the arc center location.
- /// </summary>
- /// <returns type="kendo.geometry.Point">The location of the arc center.</returns>
- },
- getEndAngle: function() {
- /// <summary>
- /// Gets the end angle of the arc in decimal degrees. Measured in clockwise direction with 0 pointing "right".
- /// </summary>
- /// <returns type="Number">The end angle of the arc.</returns>
- },
- getRadiusX: function() {
- /// <summary>
- /// Gets the x radius of the arc.
- /// </summary>
- /// <returns type="Number">The x radius of the arc.</returns>
- },
- getRadiusY: function() {
- /// <summary>
- /// Gets the y radius of the arc.
- /// </summary>
- /// <returns type="Number">The y radius of the arc.</returns>
- },
- getStartAngle: function() {
- /// <summary>
- /// Gets the start angle of the arc in decimal degrees. Measured in clockwise direction with 0 pointing "right".
- /// </summary>
- /// <returns type="Number">The start angle of the arc.</returns>
- },
- pointAt: function(angle) {
- /// <summary>
- /// Gets the location of a point on the arc's circumference at a given angle.
- /// </summary>
- /// <param name="angle" type="Number" >Angle in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.</param>
- /// <returns type="kendo.geometry.Point">The point on the arc's circumference.</returns>
- },
- setAnticlockwise: function(value) {
- /// <summary>
- /// Sets the arc anticlockwise flag.
- /// </summary>
- /// <param name="value" type="Boolean" >The new anticlockwise value.</param>
- /// <returns type="kendo.geometry.Arc">The current arc instance.</returns>
- },
- setCenter: function(value) {
- /// <summary>
- /// Sets the arc center location.
- /// </summary>
- /// <param name="value" type="kendo.geometry.Point" >The new arc center.</param>
- /// <returns type="kendo.geometry.Arc">The current arc instance.</returns>
- },
- setEndAngle: function(value) {
- /// <summary>
- /// Sets the end angle of the arc in decimal degrees. Measured in clockwise direction with 0 pointing "right".
- /// </summary>
- /// <param name="value" type="Number" >The new arc end angle.</param>
- /// <returns type="kendo.geometry.Arc">The current arc instance.</returns>
- },
- setRadiusX: function(value) {
- /// <summary>
- /// Sets the x radius of the arc.
- /// </summary>
- /// <param name="value" type="Number" >The new arc x radius.</param>
- /// <returns type="kendo.geometry.Arc">The current arc instance.</returns>
- },
- setRadiusY: function(value) {
- /// <summary>
- /// Sets the y radius of the arc.
- /// </summary>
- /// <param name="value" type="Number" >The new arc y radius.</param>
- /// <returns type="kendo.geometry.Arc">The current arc instance.</returns>
- },
- setStartAngle: function(value) {
- /// <summary>
- /// Sets the start angle of the arc in decimal degrees. Measured in clockwise direction with 0 pointing "right".
- /// </summary>
- /// <param name="value" type="Number" >The new arc start angle.</param>
- /// <returns type="kendo.geometry.Arc">The current arc instance.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoArc = function() {
- /// <summary>
- /// Returns a reference to the kendo.geometry.Arc widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.geometry.Arc">The kendo.geometry.Arc instance (if present).</returns>
- };
- $.fn.kendoArc = function(options) {
- /// <summary>
- /// Instantiates a kendo.geometry.Arc widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.geometry.Circle = function() { };
- kendo.geometry.Circle.prototype = {
- bbox: function(matrix) {
- /// <summary>
- /// Returns the bounding box of this circle after applying the specified transformation matrix.
- /// </summary>
- /// <param name="matrix" type="kendo.geometry.Matrix" >Transformation matrix to apply.</param>
- /// <returns type="kendo.geometry.Rect">The bounding box after applying the transformation matrix.</returns>
- },
- clone: function() {
- /// <summary>
- /// Creates a new instance with the same center and radius.
- /// </summary>
- /// <returns type="kendo.geometry.Circle">A new Circle instance with the same center and radius.</returns>
- },
- equals: function(other) {
- /// <summary>
- /// Compares this circle with another instance.
- /// </summary>
- /// <param name="other" type="kendo.geometry.Circle" >The circle to compare with.</param>
- /// <returns type="Boolean">true if the point coordinates match; false otherwise.</returns>
- },
- getCenter: function() {
- /// <summary>
- /// Gets the circle center location.
- /// </summary>
- /// <returns type="kendo.geometry.Point">The location of the circle center.</returns>
- },
- getRadius: function() {
- /// <summary>
- /// Gets the circle radius.
- /// </summary>
- /// <returns type="Number">The radius of the circle.</returns>
- },
- pointAt: function(angle) {
- /// <summary>
- /// Gets the location of a point on the circle's circumference at a given angle.
- /// </summary>
- /// <param name="angle" type="Number" >Angle in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.</param>
- /// <returns type="kendo.geometry.Point">The point on the circle's circumference.</returns>
- },
- setCenter: function(value) {
- /// <summary>
- /// Sets the location of the circle center.
- /// </summary>
- /// <param name="value" type="Object" >The new center Point or equivalent [x, y] array.</param>
- /// <returns type="kendo.geometry.Point">The location of the circle center.</returns>
- },
- setRadius: function(value) {
- /// <summary>
- /// Sets the circle radius.
- /// </summary>
- /// <param name="value" type="Number" >The new circle radius.</param>
- /// <returns type="kendo.geometry.Circle">The current circle instance.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoCircle = function() {
- /// <summary>
- /// Returns a reference to the kendo.geometry.Circle widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.geometry.Circle">The kendo.geometry.Circle instance (if present).</returns>
- };
- $.fn.kendoCircle = function(options) {
- /// <summary>
- /// Instantiates a kendo.geometry.Circle widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.geometry.Matrix = function() { };
- kendo.geometry.Matrix.prototype = {
- clone: function() {
- /// <summary>
- /// Creates a new instance with the same element values.
- /// </summary>
- /// <returns type="kendo.geometry.Matrix">A new Matrix instance with the same element values.</returns>
- },
- equals: function(other) {
- /// <summary>
- /// Compares this matrix with another instance.
- /// </summary>
- /// <param name="other" type="kendo.geometry.Matrix" >The matrix instance to compare with.</param>
- /// <returns type="Boolean">true if the matrix elements match; false otherwise.</returns>
- },
- round: function(digits) {
- /// <summary>
- /// Rounds the matrix elements to the specified number of fractional digits.
- /// </summary>
- /// <param name="digits" type="Number" >Number of fractional digits.</param>
- /// <returns type="kendo.geometry.Matrix">The current matrix instance.</returns>
- },
- multiplyCopy: function(matrix) {
- /// <summary>
- /// Multiplies the matrix with another one and returns the result as new instance. The current instance elements are not altered.
- /// </summary>
- /// <param name="matrix" type="kendo.geometry.Matrix" >The matrix to multiply by.</param>
- /// <returns type="kendo.geometry.Matrix">The result of the multiplication.</returns>
- },
- toArray: function(digits) {
- /// <summary>
- /// Returns the matrix elements as an [a, b, c, d, e, f] array.
- /// </summary>
- /// <param name="digits" type="Number" >(Optional) Number of fractional digits.</param>
- /// <returns type="Array">An array representation of the matrix.</returns>
- },
- toString: function(digits,separator) {
- /// <summary>
- /// Formats the matrix elements as a string.
- /// </summary>
- /// <param name="digits" type="Number" >(Optional) Number of fractional digits.</param>
- /// <param name="separator" type="String" >The separator to place between elements.</param>
- /// <returns type="String">A string representation of the matrix, e.g. "1, 0, 0, 1, 0, 0".</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoMatrix = function() {
- /// <summary>
- /// Returns a reference to the kendo.geometry.Matrix widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.geometry.Matrix">The kendo.geometry.Matrix instance (if present).</returns>
- };
- $.fn.kendoMatrix = function(options) {
- /// <summary>
- /// Instantiates a kendo.geometry.Matrix widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.geometry.Point = function() { };
- kendo.geometry.Point.prototype = {
- clone: function() {
- /// <summary>
- /// Creates a new instance with the same coordinates.
- /// </summary>
- /// <returns type="kendo.geometry.Point">A new Point instance with the same coordinates.</returns>
- },
- distanceTo: function(point) {
- /// <summary>
- /// Calculates the distance to another point.
- /// </summary>
- /// <param name="point" type="kendo.geometry.Point" >The point to calculate the distance to.</param>
- /// <returns type="Number">The straight line distance to the given point.</returns>
- },
- equals: function(other) {
- /// <summary>
- /// Compares this point with another instance.
- /// </summary>
- /// <param name="other" type="kendo.geometry.Point" >The point to compare with.</param>
- /// <returns type="Boolean">true if the point coordinates match; false otherwise.</returns>
- },
- getX: function() {
- /// <summary>
- /// Gets the x coordinate value.
- /// </summary>
- /// <returns type="Number">The current x coordinate value.</returns>
- },
- getY: function() {
- /// <summary>
- /// Gets the y coordinate value.
- /// </summary>
- /// <returns type="Number">The current y coordinate value.</returns>
- },
- move: function(x,y) {
- /// <summary>
- /// Moves the point to the specified x and y coordinates.
- /// </summary>
- /// <param name="x" type="Number" >The new X coordinate.</param>
- /// <param name="y" type="Number" >The new Y coordinate.</param>
- /// <returns type="kendo.geometry.Point">The current point instance.</returns>
- },
- rotate: function(angle,center) {
- /// <summary>
- /// Rotates the point around the given center.
- /// </summary>
- /// <param name="angle" type="Number" >Angle in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.</param>
- /// <param name="center" type="Object" >The rotation center. Can be a Point instance or an [x, y] array.</param>
- /// <returns type="kendo.geometry.Point">The current Point instance.</returns>
- },
- round: function(digits) {
- /// <summary>
- /// Rounds the point coordinates to the specified number of fractional digits.
- /// </summary>
- /// <param name="digits" type="Number" >Number of fractional digits.</param>
- /// <returns type="kendo.geometry.Point">The current Point instance.</returns>
- },
- scale: function(scaleX,scaleY) {
- /// <summary>
- /// Scales the point coordinates along the x and y axis.
- /// </summary>
- /// <param name="scaleX" type="Number" >The x scale multiplier.</param>
- /// <param name="scaleY" type="Number" >The y scale multiplier.</param>
- /// <returns type="kendo.geometry.Point">The current point instance.</returns>
- },
- scaleCopy: function(scaleX,scaleY) {
- /// <summary>
- /// Scales the point coordinates on a copy of the current point. The callee coordinates will remain unchanged.
- /// </summary>
- /// <param name="scaleX" type="Number" >The x scale multiplier.</param>
- /// <param name="scaleY" type="Number" >The y scale multiplier.</param>
- /// <returns type="kendo.geometry.Point">The new Point instance.</returns>
- },
- setX: function(value) {
- /// <summary>
- /// Sets the x coordinate to a new value.
- /// </summary>
- /// <param name="value" type="Number" >The new x coordinate value.</param>
- /// <returns type="kendo.geometry.Point">The current Point instance.</returns>
- },
- setY: function(value) {
- /// <summary>
- /// Sets the y coordinate to a new value.
- /// </summary>
- /// <param name="value" type="Number" >The new y coordinate value.</param>
- /// <returns type="kendo.geometry.Point">The current Point instance.</returns>
- },
- toArray: function(digits) {
- /// <summary>
- /// Returns the point coordinates as an [x, y] array.
- /// </summary>
- /// <param name="digits" type="Number" >(Optional) Number of fractional digits.</param>
- /// <returns type="Array">An array representation of the point, e.g. [10, 20]</returns>
- },
- toString: function(digits,separator) {
- /// <summary>
- /// Formats the point value to a string.
- /// </summary>
- /// <param name="digits" type="Number" >(Optional) Number of fractional digits.</param>
- /// <param name="separator" type="String" >The separator to place between coordinates.</param>
- /// <returns type="String">A string representation of the point, e.g. "10 20".</returns>
- },
- transform: function(tansformation) {
- /// <summary>
- /// Applies a transformation to the point coordinates. The current coordinates will be overriden.
- /// </summary>
- /// <param name="tansformation" type="kendo.geometry.Transformation" >The transformation to apply.</param>
- /// <returns type="kendo.geometry.Point">The current Point instance.</returns>
- },
- transformCopy: function(tansformation) {
- /// <summary>
- /// Applies a transformation on a copy of the current point. The callee coordinates will remain unchanged.
- /// </summary>
- /// <param name="tansformation" type="kendo.geometry.Transformation" >The transformation to apply.</param>
- /// <returns type="kendo.geometry.Point">The new Point instance.</returns>
- },
- translate: function(dx,dy) {
- /// <summary>
- /// Translates the point along the x and y axis.
- /// </summary>
- /// <param name="dx" type="Number" >The distance to move along the X axis.</param>
- /// <param name="dy" type="Number" >The distance to move along the Y axis.</param>
- /// <returns type="kendo.geometry.Point">The current point instance.</returns>
- },
- translateWith: function(vector) {
- /// <summary>
- /// Translates the point by using a Point instance as a vector of translation.
- /// </summary>
- /// <param name="vector" type="Object" >The vector of translation. Can be either a Point instance or an [x, y] array.</param>
- /// <returns type="kendo.geometry.Point">The current point instance.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoPoint = function() {
- /// <summary>
- /// Returns a reference to the kendo.geometry.Point widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.geometry.Point">The kendo.geometry.Point instance (if present).</returns>
- };
- $.fn.kendoPoint = function(options) {
- /// <summary>
- /// Instantiates a kendo.geometry.Point widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.geometry.Rect = function() { };
- kendo.geometry.Rect.prototype = {
- bbox: function(matrix) {
- /// <summary>
- /// Returns the bounding box of this rectangle after applying the specified transformation matrix.
- /// </summary>
- /// <param name="matrix" type="kendo.geometry.Matrix" >Transformation matrix to apply.</param>
- /// <returns type="kendo.geometry.Rect">The bounding box after applying the transformation matrix.</returns>
- },
- bottomLeft: function() {
- /// <summary>
- /// Gets the position of the bottom-left corner of the rectangle. This is also the rectangle origin
- /// </summary>
- /// <returns type="kendo.geometry.Point">The position of the bottom-left corner.</returns>
- },
- bottomRight: function() {
- /// <summary>
- /// Gets the position of the bottom-right corner of the rectangle.
- /// </summary>
- /// <returns type="kendo.geometry.Point">The position of the bottom-right corner.</returns>
- },
- center: function() {
- /// <summary>
- /// Gets the position of the center of the rectangle.
- /// </summary>
- /// <returns type="kendo.geometry.Point">The position of the center.</returns>
- },
- clone: function() {
- /// <summary>
- /// Creates a new instance with the same origin and size.
- /// </summary>
- /// <returns type="kendo.geometry.Rect">A new Rect instance with the same origin and size.</returns>
- },
- equals: function(other) {
- /// <summary>
- /// Compares this rectangle with another instance.
- /// </summary>
- /// <param name="other" type="kendo.geometry.Rect" >The rectangle to compare with.</param>
- /// <returns type="Boolean">true if the origin and size is the same for both rectangles; false otherwise.</returns>
- },
- getOrigin: function() {
- /// <summary>
- /// Gets the origin (top-left point) of the rectangle.
- /// </summary>
- /// <returns type="kendo.geometry.Point">The origin (top-left point).</returns>
- },
- getSize: function() {
- /// <summary>
- /// Gets the rectangle size.
- /// </summary>
- /// <returns type="kendo.geometry.Size">The current rectangle Size.</returns>
- },
- height: function() {
- /// <summary>
- /// Gets the rectangle height.
- /// </summary>
- /// <returns type="Number">The rectangle height.</returns>
- },
- setOrigin: function(value) {
- /// <summary>
- /// Sets the origin (top-left point) of the rectangle.
- /// </summary>
- /// <param name="value" type="Object" >The new origin Point or equivalent [x, y] array.</param>
- /// <returns type="kendo.geometry.Rect">The current rectangle instance.</returns>
- },
- setSize: function(value) {
- /// <summary>
- /// Sets the rectangle size.
- /// </summary>
- /// <param name="value" type="Object" >The new rectangle Size or equivalent [width, height] array.</param>
- /// <returns type="kendo.geometry.Rect">The current rectangle instance.</returns>
- },
- topLeft: function() {
- /// <summary>
- /// Gets the position of the top-left corner of the rectangle. This is also the rectangle origin
- /// </summary>
- /// <returns type="kendo.geometry.Point">The position of the top-left corner.</returns>
- },
- topRight: function() {
- /// <summary>
- /// Gets the position of the top-right corner of the rectangle.
- /// </summary>
- /// <returns type="kendo.geometry.Point">The position of the top-right corner.</returns>
- },
- width: function() {
- /// <summary>
- /// Gets the rectangle width.
- /// </summary>
- /// <returns type="Number">The rectangle width.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoRect = function() {
- /// <summary>
- /// Returns a reference to the kendo.geometry.Rect widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.geometry.Rect">The kendo.geometry.Rect instance (if present).</returns>
- };
- $.fn.kendoRect = function(options) {
- /// <summary>
- /// Instantiates a kendo.geometry.Rect widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.geometry.Size = function() { };
- kendo.geometry.Size.prototype = {
- clone: function() {
- /// <summary>
- /// Creates a new instance with the same width and height.
- /// </summary>
- /// <returns type="kendo.geometry.Size">A new Size instance with the same dimensions.</returns>
- },
- equals: function(other) {
- /// <summary>
- /// Compares this Size with another instance.
- /// </summary>
- /// <param name="other" type="kendo.geometry.Size" >The Size to compare with.</param>
- /// <returns type="Boolean">true if the size members match; false otherwise.</returns>
- },
- getWidth: function() {
- /// <summary>
- /// Gets the width value.
- /// </summary>
- /// <returns type="Number">The current width value.</returns>
- },
- getHeight: function() {
- /// <summary>
- /// Gets the height value.
- /// </summary>
- /// <returns type="Number">The current height value.</returns>
- },
- setWidth: function(value) {
- /// <summary>
- /// Sets the width to a new value.
- /// </summary>
- /// <param name="value" type="Number" >The new width value.</param>
- /// <returns type="kendo.geometry.Size">The current Size instance.</returns>
- },
- setHeight: function(value) {
- /// <summary>
- /// Sets the height to a new value.
- /// </summary>
- /// <param name="value" type="Number" >The new height value.</param>
- /// <returns type="kendo.geometry.Size">The current Size instance.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoSize = function() {
- /// <summary>
- /// Returns a reference to the kendo.geometry.Size widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.geometry.Size">The kendo.geometry.Size instance (if present).</returns>
- };
- $.fn.kendoSize = function(options) {
- /// <summary>
- /// Instantiates a kendo.geometry.Size widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.geometry.Transformation = function() { };
- kendo.geometry.Transformation.prototype = {
- clone: function() {
- /// <summary>
- /// Creates a new instance with the same transformation matrix.
- /// </summary>
- /// <returns type="kendo.geometry.Transformation">A new Transformation instance with the same matrix.</returns>
- },
- equals: function(other) {
- /// <summary>
- /// Compares this transformation with another instance.
- /// </summary>
- /// <param name="other" type="kendo.geometry.Transformation" >The transformation to compare with.</param>
- /// <returns type="Boolean">true if the transformation matrix is the same; false otherwise.</returns>
- },
- matrix: function() {
- /// <summary>
- /// Gets the current transformation matrix for this transformation.
- /// </summary>
- /// <returns type="kendo.geometry.Matrix">The current transformation matrix.</returns>
- },
- multiply: function(transformation) {
- /// <summary>
- /// Multiplies the transformation with another. The underlying transformation matrix is updated in-place.
- /// </summary>
- /// <param name="transformation" type="kendo.geometry.Transformation" >The transformation to multiply by.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation instance.</returns>
- },
- rotate: function(angle,center) {
- /// <summary>
- /// Sets rotation with the specified parameters.
- /// </summary>
- /// <param name="angle" type="Number" >The angle of rotation in decimal degrees. Measured in clockwise direction with 0 pointing "right". Negative values or values greater than 360 will be normalized.</param>
- /// <param name="center" type="Object" >The center of rotation.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation instance.</returns>
- },
- scale: function(scaleX,scaleY) {
- /// <summary>
- /// Sets scale with the specified parameters.
- /// </summary>
- /// <param name="scaleX" type="Number" >The scale factor on the X axis.</param>
- /// <param name="scaleY" type="Number" >The scale factor on the Y axis.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation instance.</returns>
- },
- translate: function(x,y) {
- /// <summary>
- /// Sets translation with the specified parameters.
- /// </summary>
- /// <param name="x" type="Number" >The distance to translate along the X axis.</param>
- /// <param name="y" type="Number" >The distance to translate along the Y axis.</param>
- /// <returns type="kendo.geometry.Transformation">The current transformation instance.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoTransformation = function() {
- /// <summary>
- /// Returns a reference to the kendo.geometry.Transformation widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.geometry.Transformation">The kendo.geometry.Transformation instance (if present).</returns>
- };
- $.fn.kendoTransformation = function(options) {
- /// <summary>
- /// Instantiates a kendo.geometry.Transformation widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- kendo.ooxml.Workbook = function() { };
- kendo.ooxml.Workbook.prototype = {
- toDataURL: function() {
- /// <summary>
- /// Creates an Excel file that represents the current workbook and returns it as a data URL.
- /// </summary>
- /// <returns type="String">- the Excel file as data URL.</returns>
- },
- toDataURLAsync: function() {
- /// <summary>
- /// Creates an Excel file that represents the current workbook and returns a Promise that is resolved with the data URL.
- /// </summary>
- /// <returns type="Promise">- A promise that will be resolved with the Excel file as data URL.</returns>
- },
- bind: function(event, callback) {
- /// <summary>
- /// Binds to a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be executed when the event is triggered.</param>
- },
- unbind: function(event, callback) {
- /// <summary>
- /// Unbinds a callback from a widget event.
- /// </summary>
- /// <param name="event" type="String">The event name</param>
- /// <param name="callback" type="Function">The callback to be removed.</param>
- }
- };
- $.fn.getKendoWorkbook = function() {
- /// <summary>
- /// Returns a reference to the kendo.ooxml.Workbook widget, instantiated on the selector.
- /// </summary>
- /// <returns type="kendo.ooxml.Workbook">The kendo.ooxml.Workbook instance (if present).</returns>
- };
- $.fn.kendoWorkbook = function(options) {
- /// <summary>
- /// Instantiates a kendo.ooxml.Workbook widget based the DOM elements that match the selector.
- /// Accepts an object with the following configuration options:
- ///
- /// creator - String (default: "Kendo UI")
- /// The creator of the workbook.
- ///
- /// date - Date
- /// The date when the workbook is created. Defaults to new Date().
- ///
- /// rtl - Boolean (default: false)
- /// Sets the direction of the workbook. By default, the direction is left-to-right.
- ///
- /// sheets - Array
- /// The sheets of the workbook. Every sheet represents a page from the final Excel file.
- ///
- /// </summary>
- /// <param name="options" type="Object">
- /// The widget configuration options
- /// </param>
- };
- if (!kendo.pdf) {
- kendo.pdf = {};
- }
- if (!kendo.timezone) {
- kendo.timezone = {};
- }
|