12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837258382583925840258412584225843258442584525846258472584825849258502585125852258532585425855258562585725858258592586025861258622586325864258652586625867258682586925870258712587225873258742587525876258772587825879258802588125882258832588425885258862588725888258892589025891258922589325894258952589625897258982589925900259012590225903259042590525906259072590825909259102591125912259132591425915259162591725918259192592025921259222592325924259252592625927259282592925930259312593225933259342593525936259372593825939259402594125942259432594425945259462594725948259492595025951259522595325954259552595625957259582595925960259612596225963259642596525966259672596825969259702597125972259732597425975259762597725978259792598025981259822598325984259852598625987259882598925990259912599225993259942599525996259972599825999260002600126002260032600426005260062600726008260092601026011260122601326014260152601626017260182601926020260212602226023260242602526026260272602826029260302603126032260332603426035260362603726038260392604026041260422604326044260452604626047260482604926050260512605226053260542605526056260572605826059260602606126062260632606426065260662606726068260692607026071260722607326074260752607626077260782607926080260812608226083260842608526086260872608826089260902609126092260932609426095260962609726098260992610026101261022610326104261052610626107261082610926110261112611226113261142611526116261172611826119261202612126122261232612426125261262612726128261292613026131261322613326134261352613626137261382613926140261412614226143261442614526146261472614826149261502615126152261532615426155261562615726158261592616026161261622616326164261652616626167261682616926170261712617226173261742617526176261772617826179261802618126182261832618426185261862618726188261892619026191261922619326194261952619626197261982619926200262012620226203262042620526206262072620826209262102621126212262132621426215262162621726218262192622026221262222622326224262252622626227262282622926230262312623226233262342623526236262372623826239262402624126242262432624426245262462624726248262492625026251262522625326254262552625626257262582625926260262612626226263262642626526266262672626826269262702627126272262732627426275262762627726278262792628026281262822628326284262852628626287262882628926290262912629226293262942629526296262972629826299263002630126302263032630426305263062630726308263092631026311263122631326314263152631626317263182631926320263212632226323263242632526326263272632826329263302633126332263332633426335263362633726338263392634026341263422634326344263452634626347263482634926350263512635226353263542635526356263572635826359263602636126362263632636426365263662636726368263692637026371263722637326374263752637626377263782637926380263812638226383263842638526386263872638826389263902639126392263932639426395263962639726398263992640026401264022640326404264052640626407264082640926410264112641226413264142641526416264172641826419264202642126422264232642426425264262642726428264292643026431264322643326434264352643626437264382643926440264412644226443264442644526446264472644826449264502645126452264532645426455264562645726458264592646026461264622646326464264652646626467264682646926470264712647226473264742647526476264772647826479264802648126482264832648426485264862648726488264892649026491264922649326494264952649626497264982649926500265012650226503265042650526506265072650826509265102651126512265132651426515265162651726518265192652026521265222652326524265252652626527265282652926530265312653226533265342653526536265372653826539265402654126542265432654426545265462654726548265492655026551265522655326554265552655626557265582655926560265612656226563265642656526566265672656826569265702657126572265732657426575265762657726578265792658026581265822658326584265852658626587265882658926590265912659226593265942659526596265972659826599266002660126602266032660426605266062660726608266092661026611266122661326614266152661626617266182661926620266212662226623266242662526626266272662826629266302663126632266332663426635266362663726638266392664026641266422664326644266452664626647266482664926650266512665226653266542665526656266572665826659266602666126662266632666426665266662666726668266692667026671266722667326674266752667626677266782667926680266812668226683266842668526686266872668826689266902669126692266932669426695266962669726698266992670026701267022670326704267052670626707267082670926710267112671226713267142671526716267172671826719267202672126722267232672426725267262672726728267292673026731267322673326734267352673626737267382673926740267412674226743267442674526746267472674826749267502675126752267532675426755267562675726758267592676026761267622676326764267652676626767267682676926770267712677226773267742677526776267772677826779267802678126782267832678426785267862678726788267892679026791267922679326794267952679626797267982679926800268012680226803268042680526806268072680826809268102681126812268132681426815268162681726818268192682026821268222682326824268252682626827268282682926830268312683226833268342683526836268372683826839268402684126842268432684426845268462684726848268492685026851268522685326854268552685626857268582685926860268612686226863268642686526866268672686826869268702687126872268732687426875268762687726878268792688026881268822688326884268852688626887268882688926890268912689226893268942689526896268972689826899269002690126902269032690426905269062690726908269092691026911269122691326914269152691626917269182691926920269212692226923269242692526926269272692826929269302693126932269332693426935269362693726938269392694026941269422694326944269452694626947269482694926950269512695226953269542695526956269572695826959269602696126962269632696426965269662696726968269692697026971269722697326974269752697626977269782697926980269812698226983269842698526986269872698826989269902699126992269932699426995269962699726998269992700027001270022700327004270052700627007270082700927010270112701227013270142701527016270172701827019270202702127022270232702427025270262702727028270292703027031270322703327034270352703627037270382703927040270412704227043270442704527046270472704827049270502705127052270532705427055270562705727058270592706027061270622706327064270652706627067270682706927070270712707227073270742707527076270772707827079270802708127082270832708427085270862708727088270892709027091270922709327094270952709627097270982709927100271012710227103271042710527106271072710827109271102711127112271132711427115271162711727118271192712027121271222712327124271252712627127271282712927130271312713227133271342713527136271372713827139271402714127142271432714427145271462714727148271492715027151271522715327154271552715627157271582715927160271612716227163271642716527166271672716827169271702717127172271732717427175271762717727178271792718027181271822718327184271852718627187271882718927190271912719227193271942719527196271972719827199272002720127202272032720427205272062720727208272092721027211272122721327214272152721627217272182721927220272212722227223272242722527226272272722827229272302723127232272332723427235272362723727238272392724027241272422724327244272452724627247272482724927250272512725227253272542725527256272572725827259272602726127262272632726427265272662726727268272692727027271272722727327274272752727627277272782727927280272812728227283272842728527286272872728827289272902729127292272932729427295272962729727298272992730027301273022730327304273052730627307273082730927310273112731227313273142731527316273172731827319273202732127322273232732427325273262732727328273292733027331273322733327334273352733627337273382733927340273412734227343273442734527346273472734827349273502735127352273532735427355273562735727358273592736027361273622736327364273652736627367273682736927370273712737227373273742737527376273772737827379273802738127382273832738427385273862738727388273892739027391273922739327394273952739627397273982739927400274012740227403274042740527406274072740827409274102741127412274132741427415274162741727418274192742027421274222742327424274252742627427274282742927430274312743227433274342743527436274372743827439274402744127442274432744427445274462744727448274492745027451274522745327454274552745627457274582745927460274612746227463274642746527466274672746827469274702747127472274732747427475274762747727478274792748027481274822748327484274852748627487274882748927490274912749227493274942749527496274972749827499275002750127502275032750427505275062750727508275092751027511275122751327514275152751627517275182751927520275212752227523275242752527526275272752827529275302753127532275332753427535275362753727538275392754027541275422754327544275452754627547275482754927550275512755227553275542755527556275572755827559275602756127562275632756427565275662756727568275692757027571275722757327574275752757627577275782757927580275812758227583275842758527586275872758827589275902759127592275932759427595275962759727598275992760027601276022760327604276052760627607276082760927610276112761227613276142761527616276172761827619276202762127622276232762427625276262762727628276292763027631276322763327634276352763627637276382763927640276412764227643276442764527646276472764827649276502765127652276532765427655276562765727658276592766027661276622766327664276652766627667276682766927670276712767227673276742767527676276772767827679276802768127682276832768427685276862768727688276892769027691276922769327694276952769627697276982769927700277012770227703277042770527706277072770827709277102771127712277132771427715277162771727718277192772027721277222772327724277252772627727277282772927730277312773227733277342773527736277372773827739277402774127742277432774427745277462774727748277492775027751277522775327754277552775627757277582775927760277612776227763277642776527766277672776827769277702777127772277732777427775277762777727778277792778027781277822778327784277852778627787277882778927790277912779227793277942779527796277972779827799278002780127802278032780427805278062780727808278092781027811278122781327814278152781627817278182781927820278212782227823278242782527826278272782827829278302783127832278332783427835278362783727838278392784027841278422784327844278452784627847278482784927850278512785227853278542785527856278572785827859278602786127862278632786427865278662786727868278692787027871278722787327874278752787627877278782787927880278812788227883278842788527886278872788827889278902789127892278932789427895278962789727898278992790027901279022790327904279052790627907279082790927910279112791227913279142791527916279172791827919279202792127922279232792427925279262792727928279292793027931279322793327934279352793627937279382793927940279412794227943279442794527946279472794827949279502795127952279532795427955279562795727958279592796027961279622796327964279652796627967279682796927970279712797227973279742797527976279772797827979279802798127982279832798427985279862798727988279892799027991279922799327994279952799627997279982799928000280012800228003280042800528006280072800828009280102801128012280132801428015280162801728018280192802028021280222802328024280252802628027280282802928030280312803228033280342803528036280372803828039280402804128042280432804428045280462804728048280492805028051280522805328054280552805628057280582805928060280612806228063280642806528066280672806828069280702807128072280732807428075280762807728078280792808028081280822808328084280852808628087280882808928090280912809228093280942809528096280972809828099281002810128102281032810428105281062810728108281092811028111281122811328114281152811628117281182811928120281212812228123281242812528126281272812828129281302813128132281332813428135281362813728138281392814028141281422814328144281452814628147281482814928150281512815228153281542815528156281572815828159281602816128162281632816428165281662816728168281692817028171281722817328174281752817628177281782817928180281812818228183281842818528186281872818828189281902819128192281932819428195281962819728198281992820028201282022820328204282052820628207282082820928210282112821228213282142821528216282172821828219282202822128222282232822428225282262822728228282292823028231282322823328234282352823628237282382823928240282412824228243282442824528246282472824828249282502825128252282532825428255282562825728258282592826028261282622826328264282652826628267282682826928270282712827228273282742827528276282772827828279282802828128282282832828428285282862828728288282892829028291282922829328294282952829628297282982829928300283012830228303283042830528306283072830828309283102831128312283132831428315283162831728318283192832028321283222832328324283252832628327283282832928330283312833228333283342833528336283372833828339283402834128342283432834428345283462834728348283492835028351283522835328354283552835628357283582835928360283612836228363283642836528366 |
- // Generated by typings
- // Source: https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/14c74ee373501a19c60253ab4aff0f9e2575516e/dojo/dojo.d.ts
- declare function define(dependencies: String[], factory: Function): any;
- declare function require(config?:Object, dependencies?: String[], callback?: Function): any;
- declare namespace dojox.dtl {
- interface __StringArgs { }
- interface __ObjectArgs { }
- }
- declare namespace dojo {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request.html
- *
- * Send a request using the default transport for the current platform.
- *
- * @param url The URL to request.
- * @param options OptionalOptions for the request.
- */
- interface request { (url: String, options?: dojo.request.__Options): void }
- interface request {
- /**
- * Send an HTTP DELETE request using the default transport for the current platform.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- del(url: String, options?: dojo.request.__BaseOptions): dojo.request.__Promise;
- /**
- * Send an HTTP GET request using the default transport for the current platform.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- get(url: String, options?: dojo.request.__BaseOptions): dojo.request.__Promise;
- /**
- * Send an HTTP POST request using the default transport for the current platform.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- post(url: String, options?: dojo.request.__BaseOptions): any;
- /**
- * Send an HTTP POST request using the default transport for the current platform.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- put(url: String, options?: dojo.request.__BaseOptions): dojo.request.__Promise;
- }
- namespace request {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/handlers.html
- *
- *
- * @param response
- */
- interface handlers { (response: any): void }
- interface handlers {
- /**
- *
- * @param name
- * @param handler
- */
- register(name: any, handler: any): void;
- }
- namespace handlers {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/iframe.html
- *
- * Sends a request using an iframe element with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- interface iframe { (url: String, options?: dojo.request.iframe.__Options): void }
- interface iframe {
- /**
- *
- * @param name
- * @param onloadstr
- * @param uri
- */
- create(name: any, onloadstr: any, uri: any): any;
- /**
- *
- * @param iframeNode
- */
- doc(iframeNode: any): any;
- /**
- * Send an HTTP GET request using an iframe element with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- get(url: String, options?: dojo.request.iframe.__BaseOptions): dojo.request.__Promise;
- /**
- * Send an HTTP POST request using an iframe element with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- post(url: String, options?: dojo.request.iframe.__BaseOptions): dojo.request.__Promise;
- /**
- *
- * @param _iframe
- * @param src
- * @param replace
- */
- setSrc(_iframe: any, src: any, replace: any): void;
- }
- namespace iframe {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/iframe.__MethodOptions.html
- *
- *
- */
- class __MethodOptions {
- constructor();
- /**
- * The HTTP method to use to make the request. Must be
- * uppercase. Only "GET" and "POST" are accepted.
- * Default is "POST".
- *
- */
- "method": string;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/iframe.__BaseOptions.html
- *
- *
- */
- class __BaseOptions {
- constructor();
- /**
- * Data to transfer. When making a GET request, this will
- * be converted to key=value parameters and appended to the
- * URL.
- *
- */
- "data": string;
- /**
- * A form node to use to submit data to the server.
- *
- */
- "form": HTMLElement;
- /**
- * How to handle the response from the server. Default is
- * 'text'. Other values are 'json', 'javascript', and 'xml'.
- *
- */
- "handleAs": string;
- /**
- * Whether to append a cache-busting parameter to the URL.
- *
- */
- "preventCache": boolean;
- /**
- * Query parameters to append to the URL.
- *
- */
- "query": string;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then the promise is rejected.
- *
- */
- "timeout": number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/iframe.__Options.html
- *
- *
- */
- class __Options {
- constructor();
- /**
- * Data to transfer. When making a GET request, this will
- * be converted to key=value parameters and appended to the
- * URL.
- *
- */
- "data": string;
- /**
- * A form node to use to submit data to the server.
- *
- */
- "form": HTMLElement;
- /**
- * How to handle the response from the server. Default is
- * 'text'. Other values are 'json', 'javascript', and 'xml'.
- *
- */
- "handleAs": string;
- /**
- * The HTTP method to use to make the request. Must be
- * uppercase. Only "GET" and "POST" are accepted.
- * Default is "POST".
- *
- */
- "method": string;
- /**
- * Whether to append a cache-busting parameter to the URL.
- *
- */
- "preventCache": boolean;
- /**
- * Query parameters to append to the URL.
- *
- */
- "query": string;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then the promise is rejected.
- *
- */
- "timeout": number;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/notify.html
- *
- * Register a listener to be notified when an event
- * in dojo/request happens.
- *
- * @param type OptionalThe event to listen for. Events emitted: "start", "send","load", "error", "done", "stop".
- * @param listener OptionalA callback to be run when an event happens.
- */
- interface notify { (type?: String, listener?: Function): void }
- interface notify {
- /**
- *
- * @param type
- * @param event
- * @param cancel
- */
- emit(type: any, event: any, cancel: any): void;
- }
- namespace notify {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/registry.html
- *
- *
- * @param url
- * @param options
- */
- interface registry { (url: any, options: any): void }
- interface registry {
- /**
- *
- * @param id
- * @param parentRequire
- * @param loaded
- * @param config
- */
- load(id: any, parentRequire: any, loaded: any, config: any): void;
- /**
- *
- * @param url
- * @param provider
- * @param first
- */
- register(url: any, provider: any, first: any): void;
- }
- namespace registry {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/node.html
- *
- * Sends a request using the included http or https interface from node.js
- * with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- interface node { (url: String, options?: dojo.request.node.__Options): void }
- interface node {
- /**
- * Send an HTTP DELETE request using XMLHttpRequest with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- del(url: String, options?: dojo.request.node.__BaseOptions): dojo.request.__Promise;
- /**
- * Send an HTTP GET request using XMLHttpRequest with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- get(url: String, options?: dojo.request.node.__BaseOptions): dojo.request.__Promise;
- /**
- * Send an HTTP POST request using XMLHttpRequest with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- post(url: String, options?: dojo.request.node.__BaseOptions): dojo.request.__Promise;
- /**
- * Send an HTTP PUT request using XMLHttpRequest with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- put(url: String, options?: dojo.request.node.__BaseOptions): dojo.request.__Promise;
- }
- namespace node {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/node.__MethodOptions.html
- *
- *
- */
- class __MethodOptions {
- constructor();
- /**
- * The HTTP method to use to make the request. Must be
- * uppercase. Default is "GET".
- *
- */
- "method": string;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/node.__Options.html
- *
- *
- */
- class __Options {
- constructor();
- /**
- * Data to transfer. This is ignored for GET and DELETE
- * requests.
- *
- */
- "data": string;
- /**
- * How to handle the response from the server. Default is
- * 'text'. Other values are 'json', 'javascript', and 'xml'.
- *
- */
- "handleAs": string;
- /**
- * Headers to use for the request.
- *
- */
- "headers": Object;
- /**
- * The HTTP method to use to make the request. Must be
- * uppercase. Default is "GET".
- *
- */
- "method": string;
- /**
- * Password to use during the request.
- *
- */
- "password": string;
- /**
- * Whether to append a cache-busting parameter to the URL.
- *
- */
- "preventCache": boolean;
- /**
- * Query parameters to append to the URL.
- *
- */
- "query": string;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then the promise is rejected.
- *
- */
- "timeout": number;
- /**
- * Username to use during the request.
- *
- */
- "user": string;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/node.__BaseOptions.html
- *
- *
- */
- class __BaseOptions {
- constructor();
- /**
- * Data to transfer. This is ignored for GET and DELETE
- * requests.
- *
- */
- "data": string;
- /**
- * How to handle the response from the server. Default is
- * 'text'. Other values are 'json', 'javascript', and 'xml'.
- *
- */
- "handleAs": string;
- /**
- * Headers to use for the request.
- *
- */
- "headers": Object;
- /**
- * Password to use during the request.
- *
- */
- "password": string;
- /**
- * Whether to append a cache-busting parameter to the URL.
- *
- */
- "preventCache": boolean;
- /**
- * Query parameters to append to the URL.
- *
- */
- "query": string;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then the promise is rejected.
- *
- */
- "timeout": number;
- /**
- * Username to use during the request.
- *
- */
- "user": string;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/watch.html
- *
- * Watches the io request represented by dfd to see if it completes.
- *
- * @param dfd The Deferred object to watch.
- */
- interface watch { (dfd: dojo.Deferred): void }
- interface watch {
- /**
- * Function used to check if basic IO call worked. Gets the dfd
- * object as its only argument.
- *
- */
- ioCheck: Function;
- /**
- * Function used to process response. Gets the dfd
- * object as its only argument.
- *
- */
- resHandle: Function;
- /**
- * Function used to check if the IO request is still valid. Gets the dfd
- * object as its only argument.
- *
- */
- validCheck: Function;
- /**
- * Cancels all pending IO requests, regardless of IO type
- *
- */
- cancelAll(): void;
- }
- namespace watch {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/script.html
- *
- * Sends a request using a script element with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- interface script { (url: String, options?: dojo.request.script.__Options): void }
- interface script {
- /**
- * Send an HTTP GET request using a script element with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- get(url: String, options?: dojo.request.script.__BaseOptions): dojo.request.__Promise;
- }
- namespace script {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/script.__MethodOptions.html
- *
- *
- */
- class __MethodOptions {
- constructor();
- /**
- * This option is ignored. All requests using this transport are
- * GET requests.
- *
- */
- "method": string;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/script.__BaseOptions.html
- *
- *
- */
- class __BaseOptions {
- constructor();
- /**
- * A string of JavaScript that when evaluated like so:
- * "typeof(" + checkString + ") != 'undefined'"
- * being true means that the script fetched has been loaded.
- * Do not use this if doing a JSONP type of call (use jsonp instead).
- *
- */
- "checkString": string;
- /**
- * Data to transfer. This is ignored for GET and DELETE
- * requests.
- *
- */
- "data": string;
- /**
- * The Document object of a child iframe. If this is passed in, the script
- * will be attached to that document. This can be helpful in some comet long-polling
- * scenarios with Firefox and Opera.
- *
- */
- "frameDoc": Object;
- /**
- * How to handle the response from the server. Default is
- * 'text'. Other values are 'json', 'javascript', and 'xml'.
- *
- */
- "handleAs": string;
- /**
- * The URL parameter name that indicates the JSONP callback string.
- * For instance, when using Yahoo JSONP calls it is normally,
- * jsonp: "callback". For AOL JSONP calls it is normally
- * jsonp: "c".
- *
- */
- "jsonp": string;
- /**
- * Whether to append a cache-busting parameter to the URL.
- *
- */
- "preventCache": boolean;
- /**
- * Query parameters to append to the URL.
- *
- */
- "query": string;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then the promise is rejected.
- *
- */
- "timeout": number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/script.__Options.html
- *
- *
- */
- class __Options {
- constructor();
- /**
- * A string of JavaScript that when evaluated like so:
- * "typeof(" + checkString + ") != 'undefined'"
- * being true means that the script fetched has been loaded.
- * Do not use this if doing a JSONP type of call (use jsonp instead).
- *
- */
- "checkString": string;
- /**dojo
- * Data to transfer. This is ignored for GET and DELETE
- * requests.
- *
- */
- "data": string;
- /**
- * The Document object of a child iframe. If this is passed in, the script
- * will be attached to that document. This can be helpful in some comet long-polling
- * scenarios with Firefox and Opera.
- *
- */
- "frameDoc": Object;
- /**
- * How to handle the response from the server. Default is
- * 'text'. Other values are 'json', 'javascript', and 'xml'.
- *
- */
- "handleAs": string;
- /**
- * The URL parameter name that indicates the JSONP callback string.
- * For instance, when using Yahoo JSONP calls it is normally,
- * jsonp: "callback". For AOL JSONP calls it is normally
- * jsonp: "c".
- *
- */
- "jsonp": string;
- /**
- * This option is ignored. All requests using this transport are
- * GET requests.
- *
- */
- "method": string;
- /**
- * Whether to append a cache-busting parameter to the URL.
- *
- */
- "preventCache": boolean;
- /**
- * Query parameters to append to the URL.
- *
- */
- "query": string;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then the promise is rejected.
- *
- */
- "timeout": number;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/xhr.html
- *
- * Sends a request using XMLHttpRequest with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- interface xhr { (url: String, options?: dojo.request.xhr.__Options): dojo.request.__Promise }
- interface xhr {
- /**
- * Send an HTTP DELETE request using XMLHttpRequest with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- del(url: String, options?: dojo.request.xhr.__BaseOptions): dojo.request.__Promise;
- /**
- * Send an HTTP GET request using XMLHttpRequest with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- get(url: String, options?: dojo.request.xhr.__BaseOptions): dojo.request.__Promise;
- /**
- * Send an HTTP POST request using XMLHttpRequest with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- post(url: String, options?: dojo.request.xhr.__BaseOptions): dojo.request.__Promise;
- /**
- * Send an HTTP PUT request using XMLHttpRequest with the given URL and options.
- *
- * @param url URL to request
- * @param options OptionalOptions for the request.
- */
- put(url: String, options?: dojo.request.xhr.__BaseOptions): dojo.request.__Promise;
- }
- namespace xhr {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/xhr.__BaseOptions.html
- *
- *
- */
- class __BaseOptions {
- constructor();
- /**
- * Data to transfer. This is ignored for GET and DELETE
- * requests.
- *
- */
- "data": string;
- /**
- * How to handle the response from the server. Default is
- * 'text'. Other values are 'json', 'javascript', and 'xml'.
- *
- */
- "handleAs": string;
- /**
- * Headers to use for the request.
- *
- */
- "headers": Object;
- /**
- * Password to use during the request.
- *
- */
- "password": string;
- /**
- * Whether to append a cache-busting parameter to the URL.
- *
- */
- "preventCache": boolean;
- /**
- * Query parameters to append to the URL.
- *
- */
- "query": string;
- /**
- * Whether to make a synchronous request or not. Default
- * is false (asynchronous).
- *
- */
- "sync": boolean;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then the promise is rejected.
- *
- */
- "timeout": number;
- /**
- * Username to use during the request.
- *
- */
- "user": string;
- /**
- * For cross-site requests, whether to send credentials
- * or not.
- *
- */
- "withCredentials": boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/xhr.__MethodOptions.html
- *
- *
- */
- class __MethodOptions {
- constructor();
- /**
- * The HTTP method to use to make the request. Must be
- * uppercase. Default is "GET".
- *
- */
- "method": string;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/xhr.__Options.html
- *
- *
- */
- class __Options {
- constructor();
- /**
- * Data to transfer. This is ignored for GET and DELETE
- * requests.
- *
- */
- "data": string;
- /**
- * How to handle the response from the server. Default is
- * 'text'. Other values are 'json', 'javascript', and 'xml'.
- *
- */
- "handleAs": string;
- /**
- * Headers to use for the request.
- *
- */
- "headers": Object;
- /**
- * The HTTP method to use to make the request. Must be
- * uppercase. Default is "GET".
- *
- */
- "method": string;
- /**
- * Password to use during the request.
- *
- */
- "password": string;
- /**
- * Whether to append a cache-busting parameter to the URL.
- *
- */
- "preventCache": boolean;
- /**
- * Query parameters to append to the URL.
- *
- */
- "query": string;
- /**
- * Whether to make a synchronous request or not. Default
- * is false (asynchronous).
- *
- */
- "sync": boolean;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then the promise is rejected.
- *
- */
- "timeout": number;
- /**
- * Username to use during the request.
- *
- */
- "user": string;
- /**
- * For cross-site requests, whether to send credentials
- * or not.
- *
- */
- "withCredentials": boolean;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request.__BaseOptions.html
- *
- *
- */
- class __BaseOptions {
- constructor();
- /**
- * Data to transfer. This is ignored for GET and DELETE
- * requests.
- *
- */
- "data": string;
- /**
- * How to handle the response from the server. Default is
- * 'text'. Other values are 'json', 'javascript', and 'xml'.
- *
- */
- "handleAs": string;
- /**
- * Whether to append a cache-busting parameter to the URL.
- *
- */
- "preventCache": boolean;
- /**
- * Query parameters to append to the URL.
- *
- */
- "query": string;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then the promise is rejected.
- *
- */
- "timeout": number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request.__MethodOptions.html
- *
- *
- */
- class __MethodOptions {
- constructor();
- /**
- * The HTTP method to use to make the request. Must be
- * uppercase.
- *
- */
- "method": string;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request.__Options.html
- *
- *
- */
- class __Options {
- constructor();
- /**
- * Data to transfer. This is ignored for GET and DELETE
- * requests.
- *
- */
- "data": string;
- /**
- * How to handle the response from the server. Default is
- * 'text'. Other values are 'json', 'javascript', and 'xml'.
- *
- */
- "handleAs": string;
- /**
- * The HTTP method to use to make the request. Must be
- * uppercase.
- *
- */
- "method": string;
- /**
- * Whether to append a cache-busting parameter to the URL.
- *
- */
- "preventCache": boolean;
- /**
- * Query parameters to append to the URL.
- *
- */
- "query": string;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then the promise is rejected.
- *
- */
- "timeout": number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request.__Promise.html
- *
- *
- */
- class __Promise implements dojo.promise.Promise<any> {
- constructor();
- /**
- * A promise resolving to an object representing
- * the response from the server.
- *
- */
- "response": Object;
- /**
- * Add a callback to be invoked when the promise is resolved
- * or rejected.
- *
- * @param callbackOrErrback OptionalA function that is used both as a callback and errback.
- */
- always(callbackOrErrback: Function): any;
- /**
- * Inform the deferred it may cancel its asynchronous operation.
- * Inform the deferred it may cancel its asynchronous operation.
- * The deferred's (optional) canceler is invoked and the
- * deferred will be left in a rejected state. Can affect other
- * promises that originate with the same deferred.
- *
- * @param reason A message that may be sent to the deferred's canceler,explaining why it's being canceled.
- * @param strict OptionalIf strict, will throw an error if the deferred has alreadybeen fulfilled and consequently cannot be canceled.
- */
- cancel(reason: any, strict?: boolean): any;
- /**
- * Checks whether the promise has been canceled.
- *
- */
- isCanceled(): boolean;
- /**
- * Checks whether the promise has been resolved or rejected.
- *
- */
- isFulfilled(): boolean;
- /**
- * Checks whether the promise has been rejected.
- *
- */
- isRejected(): boolean;
- /**
- * Checks whether the promise has been resolved.
- *
- */
- isResolved(): boolean;
- /**
- * Add new errbacks to the promise.
- *
- * @param errback OptionalCallback to be invoked when the promise is rejected.
- */
- otherwise(errback: Function): any;
- /**
- * Add new callbacks to the promise.
- * Add new callbacks to the deferred. Callbacks can be added
- * before or after the deferred is fulfilled.
- *
- * @param callback OptionalCallback to be invoked when the promise is resolved.Receives the resolution value.
- * @param errback OptionalCallback to be invoked when the promise is rejected.Receives the rejection error.
- * @param progback OptionalCallback to be invoked when the promise emits a progressupdate. Receives the progress update.
- */
- then(callback?: Function, errback?: Function, progback?: Function): dojo.promise.Promise<any>;
- /**
- *
- */
- toString(): String;
- /**
- *
- */
- trace(): dojo.promise.Promise<any>;
- /**
- *
- */
- traceRejected(): dojo.promise.Promise<any>;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/default.html
- *
- *
- */
- interface default_ {
- /**
- *
- */
- getPlatformDefaultId(): void;
- /**
- *
- * @param id
- * @param parentRequire
- * @param loaded
- * @param config
- */
- load(id: any, parentRequire: any, loaded: any, config: any): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/request/util.html
- *
- *
- */
- interface util {
- /**
- *
- * @param provider
- * @param methods
- */
- addCommonMethods(provider: any, methods: any): void;
- /**
- *
- * @param stat
- */
- checkStatus(stat: any): boolean;
- /**
- *
- * @param target
- * @param source
- */
- deepCopy(target: any, source: any): any;
- /**
- *
- * @param source
- * @param properties
- */
- deepCreate(source: any, properties: any): any;
- /**
- *
- * @param response The object used as the value of the request promise.
- * @param cancel
- * @param isValid
- * @param isReady
- * @param handleResponse
- * @param last
- */
- deferred(response: Object, cancel: any, isValid: any, isReady: any, handleResponse: any, last: any): any;
- /**
- * Register a listener to be notified when an event
- * in dojo/request happens.
- *
- * @param type OptionalThe event to listen for. Events emitted: "start", "send","load", "error", "done", "stop".
- * @param listener OptionalA callback to be run when an event happens.
- */
- notify(type?: String, listener?: Function): any;
- /**
- *
- * @param url
- * @param options
- * @param skipData
- */
- parseArgs(url: any, options: any, skipData: any): Object;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/AdapterRegistry.html
- *
- * A registry to make contextual calling/searching easier.
- * Objects of this class keep list of arrays in the form [name, check,
- * wrap, directReturn] that are used to determine what the contextual
- * result of a set of checked arguments is. All check/wrap functions
- * in this registry should be of the same arity.
- *
- * @param returnWrappers Optional
- */
- interface AdapterRegistry { (returnWrappers?: boolean): void }
- interface AdapterRegistry {
- /**
- *
- */
- pairs: any[];
- /**
- *
- */
- returnWrappers: boolean;
- /**
- * Find an adapter for the given arguments. If no suitable adapter
- * is found, throws an exception. match() accepts any number of
- * arguments, all of which are passed to all matching functions
- * from the registered pairs.
- *
- */
- match(): any;
- /**
- * register a check function to determine if the wrap function or
- * object gets selected
- *
- * @param name a way to identify this matcher.
- * @param check a function that arguments are passed to from the adapter'smatch() function. The check function should return true if thegiven arguments are appropriate for the wrap function.
- * @param wrap
- * @param directReturn OptionalIf directReturn is true, the value passed in for wrap will bereturned instead of being called. Alternately, theAdapterRegistry can be set globally to "return not call" usingthe returnWrappers property. Either way, this behavior allowsthe registry to act as a "search" function instead of afunction interception library.
- * @param override OptionalIf override is given and true, the check function will be givenhighest priority. Otherwise, it will be the lowest priorityadapter.
- */
- register(name: String, check: Function, wrap: Function, directReturn?: boolean, override?: boolean): void;
- /**
- * Remove a named adapter from the registry
- *
- * @param name The name of the adapter.
- */
- unregister(name: String): any;
- }
- namespace AdapterRegistry {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/cache.html
- *
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- interface cache { (module: String, url: String, value?: String): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/cache.html
- *
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- interface cache { (module: Object, url: String, value?: String): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/cache.html
- *
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- interface cache { (module: String, url: String, value?: Object): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/cache.html
- *
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- interface cache { (module: Object, url: String, value?: Object): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/cookie.html
- *
- * Get or set a cookie.
- * If one argument is passed, returns the value of the cookie
- * For two or more arguments, acts as a setter.
- *
- * @param name Name of the cookie
- * @param value OptionalValue for the cookie
- * @param props OptionalProperties for the cookie
- */
- interface cookie { (name: String, value?: String, props?: Object): void }
- interface cookie {
- /**
- * Use to determine if the current browser supports cookies or not.
- *
- * Returns true if user allows cookies.
- * Returns false if user doesn't allow cookies.
- *
- */
- isSupported(): void;
- }
- namespace cookie {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/domReady.html
- *
- * Plugin to delay require()/define() callback from firing until the DOM has finished loading.
- *
- * @param callback
- */
- interface domReady { (callback: any): void }
- interface domReady {
- /**
- *
- * @param id
- * @param req
- * @param load
- */
- load(id: any, req: any, load: any): void;
- }
- namespace domReady {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/hash.html
- *
- * Gets or sets the hash string in the browser URL.
- * Handles getting and setting of location.hash.
- *
- * If no arguments are passed, acts as a getter.
- * If a string is passed, acts as a setter.
- *
- * @param hash Optionalthe hash is set - #string.
- * @param replace OptionalIf true, updates the hash value in the current historystate instead of creating a new history state.
- */
- interface hash { (hash?: String, replace?: boolean): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/has.html
- *
- * Return the current value of the named feature.
- * Returns the value of the feature named by name. The feature must have been
- * previously added to the cache by has.add.
- *
- * @param name The name (if a string) or identifier (if an integer) of the feature to test.
- */
- interface has { (name: String): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/has.html
- *
- * Return the current value of the named feature.
- * Returns the value of the feature named by name. The feature must have been
- * previously added to the cache by has.add.
- *
- * @param name The name (if a string) or identifier (if an integer) of the feature to test.
- */
- interface has { (name: number): void }
- interface has {
- /**
- *
- */
- cache: string;
- /**
- * Register a new feature test for some named feature.
- *
- * @param name The name (if a string) or identifier (if an integer) of the feature to test.
- * @param test A test function to register. If a function, queued for testing until actuallyneeded. The test function should return a boolean indicatingthe presence of a feature or bug.
- * @param now OptionalOptional. Omit if test is not a function. Provides a way to immediatelyrun the test and cache the result.
- * @param force OptionalOptional. If the test already exists and force is truthy, then the existingtest will be replaced; otherwise, add does not replace an existing test (thatis, by default, the first test advice wins).
- */
- add(name: String, test: Function, now?: boolean, force?: boolean): any;
- /**
- * Register a new feature test for some named feature.
- *
- * @param name The name (if a string) or identifier (if an integer) of the feature to test.
- * @param test A test function to register. If a function, queued for testing until actuallyneeded. The test function should return a boolean indicatingthe presence of a feature or bug.
- * @param now OptionalOptional. Omit if test is not a function. Provides a way to immediatelyrun the test and cache the result.
- * @param force OptionalOptional. If the test already exists and force is truthy, then the existingtest will be replaced; otherwise, add does not replace an existing test (thatis, by default, the first test advice wins).
- */
- add(name: number, test: Function, now?: boolean, force?: boolean): any;
- /**
- * Deletes the contents of the element passed to test functions.
- *
- * @param element
- */
- clearElement(element: any): void;
- /**
- * Conditional loading of AMD modules based on a has feature test value.
- *
- * @param id Gives the resolved module id to load.
- * @param parentRequire The loader require function with respect to the module that contained the plugin resource in it'sdependency list.
- * @param loaded Callback to loader that consumes result of plugin demand.
- */
- load(id: String, parentRequire: Function, loaded: Function): void;
- /**
- * Resolves id into a module id based on possibly-nested tenary expression that branches on has feature test value(s).
- *
- * @param id
- * @param toAbsMid Resolves a relative module id into an absolute module id
- */
- normalize(id: any, toAbsMid: Function): void;
- }
- namespace has {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/hccss.html
- *
- * Test if computer is in high contrast mode (i.e. if browser is not displaying background images).
- * Defines has("highcontrast") and sets dj_a11y CSS class on <body> if machine is in high contrast mode.
- * Returns has() method;
- *
- */
- interface hccss { (): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/NodeList-data.html
- *
- * Adds data() and removeData() methods to NodeList, and returns NodeList constructor.
- *
- */
- interface NodeList_data { (): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/NodeList-html.html
- *
- * Adds a chainable html method to dojo/query() / NodeList instances for setting/replacing node content
- *
- */
- interface NodeList_html { (): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/NodeList-fx.html
- *
- * Adds dojo.fx animation support to dojo.query() by extending the NodeList class
- * with additional FX functions. NodeList is the array-like object used to hold query results.
- *
- */
- interface NodeList_fx { (): void }
- interface NodeList_fx {
- /**
- * fade all elements of the node list to a specified opacity
- *
- * @param args
- */
- fadeTo(args: any): any;
- /**
- * highlight all elements of the node list.
- * Returns an instance of dojo.Animation
- *
- * @param args
- */
- highlight(args: any): any;
- /**
- * size all elements of this NodeList. Returns an instance of dojo.Animation
- *
- * @param args
- */
- sizeTo(args: any): any;
- /**
- * slide all elements of this NodeList. Returns an instance of dojo.Animation
- *
- * @param args
- */
- slideBy(args: any): any;
- /**
- * Wipe all elements of the NodeList to a specified width: or height:
- *
- * @param args
- */
- wipeTo(args: any): any;
- }
- namespace NodeList_fx {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/NodeList-dom.html
- *
- * Adds DOM related methods to NodeList, and returns NodeList constructor.
- *
- */
- interface NodeList_dom { (): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/NodeList-manipulate.html
- *
- * Adds chainable methods to dojo.query() / NodeList instances for manipulating HTML
- * and DOM nodes and their properties.
- *
- */
- interface NodeList_manipulate { (): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/NodeList-traverse.html
- *
- * Adds chainable methods to dojo/query() / NodeList instances for traversing the DOM
- *
- */
- interface NodeList_traverse { (): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/on.html
- *
- * A function that provides core event listening functionality. With this function
- * you can provide a target, event type, and listener to be notified of
- * future matching events that are fired.
- * To listen for "click" events on a button node, we can do:
- *
- * define(["dojo/on"], function(listen){
- * on(button, "click", clickHandler);
- * ...
- * Evented JavaScript objects can also have their own events.
- *
- * var obj = new Evented;
- * on(obj, "foo", fooHandler);
- * And then we could publish a "foo" event:
- *
- * on.emit(obj, "foo", {key: "value"});
- * We can use extension events as well. For example, you could listen for a tap gesture:
- *
- * define(["dojo/on", "dojo/gesture/tap", function(listen, tap){
- * on(button, tap, tapHandler);
- * ...
- * which would trigger fooHandler. Note that for a simple object this is equivalent to calling:
- *
- * obj.onfoo({key:"value"});
- * If you use on.emit on a DOM node, it will use native event dispatching when possible.
- *
- * @param target This is the target object or DOM element that to receive events from
- * @param type This is the name of the event to listen for or an extension event type.
- * @param listener This is the function that should be called when the event fires.
- * @param dontFix
- */
- interface on { (target: HTMLElement, type: String, listener: Function, dontFix: any): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/on.html
- *
- * A function that provides core event listening functionality. With this function
- * you can provide a target, event type, and listener to be notified of
- * future matching events that are fired.
- * To listen for "click" events on a button node, we can do:
- *
- * define(["dojo/on"], function(listen){
- * on(button, "click", clickHandler);
- * ...
- * Evented JavaScript objects can also have their own events.
- *
- * var obj = new Evented;
- * on(obj, "foo", fooHandler);
- * And then we could publish a "foo" event:
- *
- * on.emit(obj, "foo", {key: "value"});
- * We can use extension events as well. For example, you could listen for a tap gesture:
- *
- * define(["dojo/on", "dojo/gesture/tap", function(listen, tap){
- * on(button, tap, tapHandler);
- * ...
- * which would trigger fooHandler. Note that for a simple object this is equivalent to calling:
- *
- * obj.onfoo({key:"value"});
- * If you use on.emit on a DOM node, it will use native event dispatching when possible.
- *
- * @param target This is the target object or DOM element that to receive events from
- * @param type This is the name of the event to listen for or an extension event type.
- * @param listener This is the function that should be called when the event fires.
- * @param dontFix
- */
- interface on { (target: Object, type: String, listener: Function, dontFix: any): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/on.html
- *
- * A function that provides core event listening functionality. With this function
- * you can provide a target, event type, and listener to be notified of
- * future matching events that are fired.
- * To listen for "click" events on a button node, we can do:
- *
- * define(["dojo/on"], function(listen){
- * on(button, "click", clickHandler);
- * ...
- * Evented JavaScript objects can also have their own events.
- *
- * var obj = new Evented;
- * on(obj, "foo", fooHandler);
- * And then we could publish a "foo" event:
- *
- * on.emit(obj, "foo", {key: "value"});
- * We can use extension events as well. For example, you could listen for a tap gesture:
- *
- * define(["dojo/on", "dojo/gesture/tap", function(listen, tap){
- * on(button, tap, tapHandler);
- * ...
- * which would trigger fooHandler. Note that for a simple object this is equivalent to calling:
- *
- * obj.onfoo({key:"value"});
- * If you use on.emit on a DOM node, it will use native event dispatching when possible.
- *
- * @param target This is the target object or DOM element that to receive events from
- * @param type This is the name of the event to listen for or an extension event type.
- * @param listener This is the function that should be called when the event fires.
- * @param dontFix
- */
- interface on { (target: HTMLElement, type: Function, listener: Function, dontFix: any): void }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/on.html
- *
- * A function that provides core event listening functionality. With this function
- * you can provide a target, event type, and listener to be notified of
- * future matching events that are fired.
- * To listen for "click" events on a button node, we can do:
- *
- * define(["dojo/on"], function(listen){
- * on(button, "click", clickHandler);
- * ...
- * Evented JavaScript objects can also have their own events.
- *
- * var obj = new Evented;
- * on(obj, "foo", fooHandler);
- * And then we could publish a "foo" event:
- *
- * on.emit(obj, "foo", {key: "value"});
- * We can use extension events as well. For example, you could listen for a tap gesture:
- *
- * define(["dojo/on", "dojo/gesture/tap", function(listen, tap){
- * on(button, tap, tapHandler);
- * ...
- * which would trigger fooHandler. Note that for a simple object this is equivalent to calling:
- *
- * obj.onfoo({key:"value"});
- * If you use on.emit on a DOM node, it will use native event dispatching when possible.
- *
- * @param target This is the target object or DOM element that to receive events from
- * @param type This is the name of the event to listen for or an extension event type.
- * @param listener This is the function that should be called when the event fires.
- * @param dontFix
- */
- interface on { (target: Object, type: String, listener: Function, dontFix?: any): { remove: { (): void } } }
- interface on {
- /**
- *
- * @param target
- * @param type
- * @param event
- */
- emit(target: any, type: any, event: any): any;
- /**
- * This function acts the same as on(), but will only call the listener once. The
- * listener will be called for the first
- * event that takes place and then listener will automatically be removed.
- *
- * @param target
- * @param type
- * @param listener
- * @param dontFix
- */
- once(target: any, type: any, listener: any, dontFix?: any): any;
- /**
- *
- * @param target
- * @param type
- * @param listener
- * @param addListener
- * @param dontFix
- * @param matchesTarget
- */
- parse(target: any, type: any, listener: any, addListener: any, dontFix: any, matchesTarget: any): any;
- /**
- * This function acts the same as on(), but with pausable functionality. The
- * returned signal object has pause() and resume() functions. Calling the
- * pause() method will cause the listener to not be called for future events. Calling the
- * resume() method will cause the listener to again be called for future events.
- *
- * @param target
- * @param type
- * @param listener
- * @param dontFix
- */
- pausable(target: any, type: any, listener: any, dontFix: any): any;
- /**
- * Creates a new extension event with event delegation. This is based on
- * the provided event type (can be extension event) that
- * only calls the listener when the CSS selector matches the target of the event.
- *
- * The application must require() an appropriate level of dojo/query to handle the selector.
- *
- * @param selector The CSS selector to use for filter events and determine the |this| of the event listener.
- * @param eventType The event to listen for
- * @param children Indicates if children elements of the selector should be allowed. This defaults to true
- */
- selector(selector: any, eventType: any, children: any): Function;
- }
- namespace on {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/query.html
- *
- * This modules provides DOM querying functionality. The module export is a function
- * that can be used to query for DOM nodes by CSS selector and returns a NodeList
- * representing the matching nodes.
- * dojo/query is responsible for loading the appropriate query engine and wrapping
- * its results with a NodeList. You can use dojo/query with a specific selector engine
- * by using it as a plugin. For example, if you installed the sizzle package, you could
- * use it as the selector engine with:
- *
- * require(["dojo/query!sizzle"], function(query){
- * query("div")...
- * The id after the ! can be a module id of the selector engine or one of the following values:
- *
- * acme: This is the default engine used by Dojo base, and will ensure that the full
- * Acme engine is always loaded.
- * css2: If the browser has a native selector engine, this will be used, otherwise a
- * very minimal lightweight selector engine will be loaded that can do simple CSS2 selectors
- * (by #id, .class, tag, and [name=value] attributes, with standard child or descendant (>)
- * operators) and nothing more.
- * css2.1: If the browser has a native selector engine, this will be used, otherwise the
- * full Acme engine will be loaded.
- * css3: If the browser has a native selector engine with support for CSS3 pseudo
- * selectors (most modern browsers except IE8), this will be used, otherwise the
- * full Acme engine will be loaded.
- * Or the module id of a selector engine can be used to explicitly choose the selector engine
- *
- * For example, if you are using CSS3 pseudo selectors in module, you can specify that
- * you will need support them with:
- *
- * require(["dojo/query!css3"], function(query){
- * query('#t > h3:nth-child(odd)')...
- * You can also choose the selector engine/load configuration by setting the query-selector:
- * For example:
- *
- * <script data-dojo-config="query-selector:'css3'" src="dojo.js"></script>
- *
- * @param selector A CSS selector to search for.
- * @param context OptionalAn optional context to limit the searching scope. Only nodes under context will bescanned.
- */
- interface query{(selector: String, context?: String): NodeList}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/query.html
- *
- * This modules provides DOM querying functionality. The module export is a function
- * that can be used to query for DOM nodes by CSS selector and returns a NodeList
- * representing the matching nodes.
- * dojo/query is responsible for loading the appropriate query engine and wrapping
- * its results with a NodeList. You can use dojo/query with a specific selector engine
- * by using it as a plugin. For example, if you installed the sizzle package, you could
- * use it as the selector engine with:
- *
- * require(["dojo/query!sizzle"], function(query){
- * query("div")...
- * The id after the ! can be a module id of the selector engine or one of the following values:
- *
- * acme: This is the default engine used by Dojo base, and will ensure that the full
- * Acme engine is always loaded.
- * css2: If the browser has a native selector engine, this will be used, otherwise a
- * very minimal lightweight selector engine will be loaded that can do simple CSS2 selectors
- * (by #id, .class, tag, and [name=value] attributes, with standard child or descendant (>)
- * operators) and nothing more.
- * css2.1: If the browser has a native selector engine, this will be used, otherwise the
- * full Acme engine will be loaded.
- * css3: If the browser has a native selector engine with support for CSS3 pseudo
- * selectors (most modern browsers except IE8), this will be used, otherwise the
- * full Acme engine will be loaded.
- * Or the module id of a selector engine can be used to explicitly choose the selector engine
- *
- * For example, if you are using CSS3 pseudo selectors in module, you can specify that
- * you will need support them with:
- *
- * require(["dojo/query!css3"], function(query){
- * query('#t > h3:nth-child(odd)')...
- * You can also choose the selector engine/load configuration by setting the query-selector:
- * For example:
- *
- * <script data-dojo-config="query-selector:'css3'" src="dojo.js"></script>
- *
- * @param selector A CSS selector to search for.
- * @param context OptionalAn optional context to limit the searching scope. Only nodes under context will bescanned.
- */
- interface query{(selector: String, context?: HTMLElement): NodeList}
- interface query {
- /**
- * can be used as AMD plugin to conditionally load new query engine
- *
- * @param id
- * @param parentRequire
- * @param loaded
- */
- load(id: any, parentRequire: any, loaded: any): void;
- /**
- * Array-like object which adds syntactic
- * sugar for chaining, common iteration operations, animation, and
- * node manipulation. NodeLists are most often returned as the
- * result of dojo/query() calls.
- * NodeList instances provide many utilities that reflect
- * core Dojo APIs for Array iteration and manipulation, DOM
- * manipulation, and event handling. Instead of needing to dig up
- * functions in the dojo package, NodeLists generally make the
- * full power of Dojo available for DOM manipulation tasks in a
- * simple, chainable way.
- *
- * @param array
- */
- NodeList(array: any): any[];
- }
- namespace query {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/ready.html
- *
- * Add a function to execute on DOM content loaded and all requested modules have arrived and been evaluated.
- * In most cases, the domReady plug-in should suffice and this method should not be needed.
- *
- * When called in a non-browser environment, just checks that all requested modules have arrived and been
- * evaluated.
- *
- * @param priority OptionalThe order in which to exec this callback relative to other callbacks, defaults to 1000
- * @param context The context in which to run execute callback, or a callback if not using context
- * @param callback OptionalThe function to execute.
- */
- interface ready{(priority?: number, context?: any, callback?: Function): void}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/sniff.html
- *
- * This module sets has() flags based on the current browser.
- * It returns the has() function.
- *
- */
- interface sniff{(): void}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/when.html
- *
- * Transparently applies callbacks to values and/or promises.
- * Accepts promises but also transparently handles non-promises. If no
- * callbacks are provided returns a promise, regardless of the initial
- * value. Foreign promises are converted.
- *
- * If callbacks are provided and the initial value is not a promise,
- * the callback is executed immediately with no error handling. Returns
- * a promise if the initial value is a promise, or the result of the
- * callback otherwise.
- *
- * @param valueOrPromise Either a regular value or an object with a then() method thatfollows the Promises/A specification.
- * @param callback OptionalCallback to be invoked when the promise is resolved, or a non-promiseis received.
- * @param errback OptionalCallback to be invoked when the promise is rejected.
- * @param progback OptionalCallback to be invoked when the promise emits a progress update.
- */
- interface when { <T, U>(value: T|dojo.promise.Promise<T>, callback: dojo.promise.Callback<T, U>, errback?: any, progback?: any): U|dojo.promise.Promise<U> }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/DeferredList.html
- *
- * Deprecated, use dojo/promise/all instead.
- * Provides event handling for a group of Deferred objects.
- * DeferredList takes an array of existing deferreds and returns a new deferred of its own
- * this new deferred will typically have its callback fired when all of the deferreds in
- * the given list have fired their own deferreds. The parameters fireOnOneCallback and
- * fireOnOneErrback, will fire before all the deferreds as appropriate
- *
- */
- class DeferredList {
- constructor();
- /**
- * Gathers the results of the deferreds for packaging
- * as the parameters to the Deferred Lists' callback
- *
- * @param deferredList The deferred list from which this function gathers results.
- */
- gatherResults(deferredList: dojo.DeferredList): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/Deferred.html
- *
- * Creates a new deferred. This API is preferred over
- * dojo/_base/Deferred.
- * Creates a new deferred, as an abstraction over (primarily)
- * asynchronous operations. The deferred is the private interface
- * that should not be returned to calling code. That's what the
- * promise is for. See dojo/promise/Promise.
- *
- * @param canceler OptionalWill be invoked if the deferred is canceled. The cancelerreceives the reason the deferred was canceled as its argument.The deferred is rejected with its return value, or a newdojo/errors/CancelError instance.
- */
- class Deferred {
- constructor(canceler?: Function);
- /**
- *
- */
- "promise": dojo.promise.Promise<any>;
- /**
- * Inform the deferred it may cancel its asynchronous operation.
- * Inform the deferred it may cancel its asynchronous operation.
- * The deferred's (optional) canceler is invoked and the
- * deferred will be left in a rejected state. Can affect other
- * promises that originate with the same deferred.
- *
- * @param reason A message that may be sent to the deferred's canceler,explaining why it's being canceled.
- * @param strict OptionalIf strict, will throw an error if the deferred has alreadybeen fulfilled and consequently cannot be canceled.
- */
- cancel(reason: any, strict?: boolean): any;
- /**
- * Checks whether the deferred has been canceled.
- *
- */
- isCanceled(): boolean;
- /**
- * Checks whether the deferred has been resolved or rejected.
- *
- */
- isFulfilled(): boolean;
- /**
- * Checks whether the deferred has been rejected.
- *
- */
- isRejected(): boolean;
- /**
- * Checks whether the deferred has been resolved.
- *
- */
- isResolved(): boolean;
- /**
- * Emit a progress update on the deferred.
- * Emit a progress update on the deferred. Progress updates
- * can be used to communicate updates about the asynchronous
- * operation before it has finished.
- *
- * @param update The progress update. Passed to progbacks.
- * @param strict OptionalIf strict, will throw an error if the deferred has alreadybeen fulfilled and consequently no progress can be emitted.
- */
- progress(update: any, strict?: boolean): dojo.promise.Promise<any>;
- /**
- * Reject the deferred.
- * Reject the deferred, putting it in an error state.
- *
- * @param error The error result of the deferred. Passed to errbacks.
- * @param strict OptionalIf strict, will throw an error if the deferred has alreadybeen fulfilled and consequently cannot be rejected.
- */
- reject(error: any, strict?: boolean): any;
- /**
- * Resolve the deferred.
- * Resolve the deferred, putting it in a success state.
- *
- * @param value The result of the deferred. Passed to callbacks.
- * @param strict OptionalIf strict, will throw an error if the deferred has alreadybeen fulfilled and consequently cannot be resolved.
- */
- resolve(value: any, strict?: boolean): dojo.promise.Promise<any>;
- /**
- * Add new callbacks to the deferred.
- * Add new callbacks to the deferred. Callbacks can be added
- * before or after the deferred is fulfilled.
- *
- * @param callback OptionalCallback to be invoked when the promise is resolved.Receives the resolution value.
- * @param errback OptionalCallback to be invoked when the promise is rejected.Receives the rejection error.
- * @param progback OptionalCallback to be invoked when the promise emits a progressupdate. Receives the progress update.
- */
- then(callback?: Function, errback?: Function, progback?: Function): dojo.promise.Promise<any>;
- /**
- *
- */
- toString(): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/Evented.html
- *
- * A class that can be used as a mixin or base class,
- * to add on() and emit() methods to a class
- * for listening for events and emitting events:
- *
- */
- class Evented {
- constructor();
- /**
- *
- * @param type
- * @param event
- */
- emit(type: String, data: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: String, listener: {(e:any):void}): {remove: {():void}};
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/NodeList.html
- *
- * Array-like object which adds syntactic
- * sugar for chaining, common iteration operations, animation, and
- * node manipulation. NodeLists are most often returned as the
- * result of dojo/query() calls.
- * NodeList instances provide many utilities that reflect
- * core Dojo APIs for Array iteration and manipulation, DOM
- * manipulation, and event handling. Instead of needing to dig up
- * functions in the dojo package, NodeLists generally make the
- * full power of Dojo available for DOM manipulation tasks in a
- * simple, chainable way.
- *
- * @param array
- */
- class NodeList {
- constructor(array: any);
- /**
- *
- */
- "events": any[];
- /**
- * adds the specified class to every node in the list
- *
- * @param className A String class name to add, or several space-separated class names,or an array of class names.
- */
- addClass(className: String): void;
- /**
- * adds the specified class to every node in the list
- *
- * @param className A String class name to add, or several space-separated class names,or an array of class names.
- */
- addClass(className: any[]): void;
- /**
- * Animate the effects of adding a class to all nodes in this list.
- * see dojox.fx.addClass
- *
- * @param cssClass
- * @param args
- */
- addClassFx(cssClass: any, args: any): {type:Function;value:any};
- /**
- * add a node, NodeList or some HTML as a string to every item in the
- * list. Returns the original list.
- * a copy of the HTML content is added to each item in the
- * list, with an optional position argument. If no position
- * argument is provided, the content is appended to the end of
- * each item.
- *
- * @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
- */
- addContent(content: String, position?: String): Function;
- /**
- * add a node, NodeList or some HTML as a string to every item in the
- * list. Returns the original list.
- * a copy of the HTML content is added to each item in the
- * list, with an optional position argument. If no position
- * argument is provided, the content is appended to the end of
- * each item.
- *
- * @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
- */
- addContent(content: HTMLElement, position?: String): Function;
- /**
- * add a node, NodeList or some HTML as a string to every item in the
- * list. Returns the original list.
- * a copy of the HTML content is added to each item in the
- * list, with an optional position argument. If no position
- * argument is provided, the content is appended to the end of
- * each item.
- *
- * @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
- */
- addContent(content: Object, position?: String): Function;
- /**
- * add a node, NodeList or some HTML as a string to every item in the
- * list. Returns the original list.
- * a copy of the HTML content is added to each item in the
- * list, with an optional position argument. If no position
- * argument is provided, the content is appended to the end of
- * each item.
- *
- * @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
- */
- addContent(content: dojo.NodeList, position?: String): Function;
- /**
- * add a node, NodeList or some HTML as a string to every item in the
- * list. Returns the original list.
- * a copy of the HTML content is added to each item in the
- * list, with an optional position argument. If no position
- * argument is provided, the content is appended to the end of
- * each item.
- *
- * @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
- */
- addContent(content: String, position?: number): Function;
- /**
- * add a node, NodeList or some HTML as a string to every item in the
- * list. Returns the original list.
- * a copy of the HTML content is added to each item in the
- * list, with an optional position argument. If no position
- * argument is provided, the content is appended to the end of
- * each item.
- *
- * @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
- */
- addContent(content: HTMLElement, position?: number): Function;
- /**
- * add a node, NodeList or some HTML as a string to every item in the
- * list. Returns the original list.
- * a copy of the HTML content is added to each item in the
- * list, with an optional position argument. If no position
- * argument is provided, the content is appended to the end of
- * each item.
- *
- * @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
- */
- addContent(content: Object, position?: number): Function;
- /**
- * add a node, NodeList or some HTML as a string to every item in the
- * list. Returns the original list.
- * a copy of the HTML content is added to each item in the
- * list, with an optional position argument. If no position
- * argument is provided, the content is appended to the end of
- * each item.
- *
- * @param content the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param position Optionalcan be one of:"last"||"end" (default)"first||"start""before""after""replace" (replaces nodes in this NodeList with new content)"only" (removes other children of the nodes so new content is the only child)or an offset in the childNodes property
- */
- addContent(content: dojo.NodeList, position?: number): Function;
- /**
- * places any/all elements in queryOrListOrNode at a
- * position relative to the first element in this list.
- * Returns a dojo/NodeList of the adopted elements.
- *
- * @param queryOrListOrNode a DOM node or a query string or a query result.Represents the nodes to be adopted relative to thefirst element of this NodeList.
- * @param position Optionalcan be one of:"last" (default)"first""before""after""only""replace"or an offset in the childNodes property
- */
- adopt(queryOrListOrNode: String, position?: String): any;
- /**
- * places any/all elements in queryOrListOrNode at a
- * position relative to the first element in this list.
- * Returns a dojo/NodeList of the adopted elements.
- *
- * @param queryOrListOrNode a DOM node or a query string or a query result.Represents the nodes to be adopted relative to thefirst element of this NodeList.
- * @param position Optionalcan be one of:"last" (default)"first""before""after""only""replace"or an offset in the childNodes property
- */
- adopt(queryOrListOrNode: any[], position?: String): any;
- /**
- * places any/all elements in queryOrListOrNode at a
- * position relative to the first element in this list.
- * Returns a dojo/NodeList of the adopted elements.
- *
- * @param queryOrListOrNode a DOM node or a query string or a query result.Represents the nodes to be adopted relative to thefirst element of this NodeList.
- * @param position Optionalcan be one of:"last" (default)"first""before""after""only""replace"or an offset in the childNodes property
- */
- adopt(queryOrListOrNode: HTMLElement, position?: String): any;
- /**
- * Places the content after every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- after(content: String): any;
- /**
- * Places the content after every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- after(content: HTMLElement): any;
- /**
- * Places the content after every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- after(content: NodeList): any;
- /**
- * Adds the nodes from the previous dojo/NodeList to the current dojo/NodeList.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- */
- andSelf(): any;
- /**
- * Animate one or more CSS properties for all nodes in this list.
- * The returned animation object will already be playing when it
- * is returned. See the docs for dojo.anim for full details.
- *
- * @param properties the properties to animate. does NOT support the auto parameter like otherNodeList-fx methods.
- * @param duration OptionalOptional. The time to run the animations for
- * @param easing OptionalOptional. The easing function to use.
- * @param onEnd OptionalA function to be called when the animation ends
- * @param delay Optionalhow long to delay playing the returned animation
- */
- anim(properties: Object, duration?: number, easing?: Function, onEnd?: Function, delay?: number): any;
- /**
- * Animate all elements of this NodeList across the properties specified.
- * syntax identical to dojo.animateProperty
- *
- * @param args OptionalAdditional dojo/_base/fx.Animation arguments to mix into this set with the addition ofan auto parameter.
- */
- animateProperty(args?: Object): any;
- /**
- * appends the content to every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- append(content: String): any;
- /**
- * appends the content to every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- append(content: HTMLElement): any;
- /**
- * appends the content to every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- append(content: NodeList): any;
- /**
- * appends nodes in this NodeList to the nodes matched by
- * the query passed to appendTo.
- * The nodes in this NodeList will be cloned if the query
- * matches more than one element. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param query
- */
- appendTo(query: String): any;
- /**
- * Returns a new NodeList comprised of items in this NodeList
- * at the given index or indices.
- *
- * @param index One or more 0-based indices of items in the currentNodeList. A negative index will start at the end of thelist and go backwards.
- */
- at(index: number[]): any;
- /**
- * gets or sets the DOM attribute for every element in the
- * NodeList. See also dojo/dom-attr
- *
- * @param property the attribute to get/set
- * @param value Optionaloptional. The value to set the property to
- */
- attr(property: String, value?: String): any;
- /**
- * Places the content before every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- before(content: String): any;
- /**
- * Places the content before every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- before(content: HTMLElement): any;
- /**
- * Places the content before every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- before(content: NodeList): any;
- /**
- * Returns all immediate child elements for nodes in this dojo/NodeList.
- * Optionally takes a query to filter the child elements.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- * @param query Optionala CSS selector.
- */
- children(query?: String): any;
- /**
- * Clones all the nodes in this NodeList and returns them as a new NodeList.
- * Only the DOM nodes are cloned, not any attached event handlers.
- *
- */
- clone(): any;
- /**
- * Returns closest parent that matches query, including current node in this
- * dojo/NodeList if it matches the query.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- * @param query a CSS selector.
- * @param root OptionalIf specified, query is relative to "root" rather than document body.
- */
- closest(query: String, root?: String): any;
- /**
- * Returns closest parent that matches query, including current node in this
- * dojo/NodeList if it matches the query.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- * @param query a CSS selector.
- * @param root OptionalIf specified, query is relative to "root" rather than document body.
- */
- closest(query: String, root?: HTMLElement): any;
- /**
- * Returns a new NodeList comprised of items in this NodeList
- * as well as items passed in as parameters
- * This method behaves exactly like the Array.concat method
- * with the caveat that it returns a NodeList and not a
- * raw Array. For more details, see the Array.concat
- * docs
- *
- * @param item OptionalAny number of optional parameters may be passed in to bespliced into the NodeList
- */
- concat(item: Object): any;
- /**
- * Attach event handlers to every item of the NodeList. Uses dojo.connect()
- * so event properties are normalized.
- *
- * Application must manually require() "dojo/_base/connect" before using this method.
- *
- * @param methodName the name of the method to attach to. For DOM events, this should bethe lower-case name of the event
- * @param objOrFunc if 2 arguments are passed (methodName, objOrFunc), objOrFunc shouldreference a function or be the name of the function in the globalnamespace to attach. If 3 arguments are provided(methodName, objOrFunc, funcName), objOrFunc must be the scope tolocate the bound function in
- * @param funcName Optionaloptional. A string naming the function in objOrFunc to bind to theevent. May also be a function reference.
- */
- connect(methodName: String, objOrFunc: Object, funcName?: String): void;
- /**
- * Attach event handlers to every item of the NodeList. Uses dojo.connect()
- * so event properties are normalized.
- *
- * Application must manually require() "dojo/_base/connect" before using this method.
- *
- * @param methodName the name of the method to attach to. For DOM events, this should bethe lower-case name of the event
- * @param objOrFunc if 2 arguments are passed (methodName, objOrFunc), objOrFunc shouldreference a function or be the name of the function in the globalnamespace to attach. If 3 arguments are provided(methodName, objOrFunc, funcName), objOrFunc must be the scope tolocate the bound function in
- * @param funcName Optionaloptional. A string naming the function in objOrFunc to bind to theevent. May also be a function reference.
- */
- connect(methodName: String, objOrFunc: Function, funcName?: String): void;
- /**
- * Attach event handlers to every item of the NodeList. Uses dojo.connect()
- * so event properties are normalized.
- *
- * Application must manually require() "dojo/_base/connect" before using this method.
- *
- * @param methodName the name of the method to attach to. For DOM events, this should bethe lower-case name of the event
- * @param objOrFunc if 2 arguments are passed (methodName, objOrFunc), objOrFunc shouldreference a function or be the name of the function in the globalnamespace to attach. If 3 arguments are provided(methodName, objOrFunc, funcName), objOrFunc must be the scope tolocate the bound function in
- * @param funcName Optionaloptional. A string naming the function in objOrFunc to bind to theevent. May also be a function reference.
- */
- connect(methodName: String, objOrFunc: String, funcName?: String): void;
- /**
- * Deprecated: Use position() for border-box x/y/w/h
- * or marginBox() for margin-box w/h/l/t.
- * Returns the box objects of all elements in a node list as
- * an Array (not a NodeList). Acts like domGeom.coords, though assumes
- * the node passed is each node in this list.
- *
- */
- coords(): void;
- /**
- * stash or get some arbitrary data on/from these nodes.
- * Stash or get some arbitrary data on/from these nodes. This private _data function is
- * exposed publicly on dojo/NodeList, eg: as the result of a dojo/query call.
- * DIFFERS from jQuery.data in that when used as a getter, the entire list is ALWAYS
- * returned. EVEN WHEN THE LIST IS length == 1.
- *
- * A single-node version of this function is provided as dojo._nodeData, which follows
- * the same signature, though expects a String ID or DomNode reference in the first
- * position, before key/value arguments.
- *
- * @param key OptionalIf an object, act as a setter and iterate over said object setting data items as defined.If a string, and value present, set the data for defined key to valueIf a string, and value absent, act as a getter, returning the data associated with said key
- * @param value OptionalThe value to set for said key, provided key is a string (and not an object)
- */
- data(key?: Object, value?: any): any;
- /**
- * stash or get some arbitrary data on/from these nodes.
- * Stash or get some arbitrary data on/from these nodes. This private _data function is
- * exposed publicly on dojo/NodeList, eg: as the result of a dojo/query call.
- * DIFFERS from jQuery.data in that when used as a getter, the entire list is ALWAYS
- * returned. EVEN WHEN THE LIST IS length == 1.
- *
- * A single-node version of this function is provided as dojo._nodeData, which follows
- * the same signature, though expects a String ID or DomNode reference in the first
- * position, before key/value arguments.
- *
- * @param key OptionalIf an object, act as a setter and iterate over said object setting data items as defined.If a string, and value present, set the data for defined key to valueIf a string, and value absent, act as a getter, returning the data associated with said key
- * @param value OptionalThe value to set for said key, provided key is a string (and not an object)
- */
- data(key?: String, value?: any): any;
- /**
- * Monitor nodes in this NodeList for [bubbled] events on nodes that match selector.
- * Calls fn(evt) for those events, where (inside of fn()), this == the node
- * that matches the selector.
- * Sets up event handlers that can catch events on any subnodes matching a given selector,
- * including nodes created after delegate() has been called.
- *
- * This allows an app to setup a single event handler on a high level node, rather than many
- * event handlers on subnodes. For example, one onclick handler for a Tree widget, rather than separate
- * handlers for each node in the tree.
- * Since setting up many event handlers is expensive, this can increase performance.
- *
- * Note that delegate() will not work for events that don't bubble, like focus.
- * onmouseenter/onmouseleave also don't currently work.
- *
- * @param selector CSS selector valid to dojo.query, like ".foo" or "div > span". Theselector is relative to the nodes in this NodeList, not the document root.For example myNodeList.delegate("> a", "onclick", ...) will catch events onanchor nodes which are (immediate) children of the nodes in myNodeList.
- * @param eventName Standard event name used as an argument to dojo.connect, like "onclick".
- * @param fn Callback function passed the event object, and where this == the node that matches the selector.That means that for example, after setting up a handler viadojo.query("body").delegate("fieldset", "onclick", ...)clicking on a fieldset or any nodes inside of a fieldset will be reportedas a click on the fieldset itself.
- */
- delegate(selector: String, eventName: String, fn: Function): any;
- /**
- * Renders the specified template in each of the NodeList entries.
- *
- * @param template The template string or location
- * @param context The context object or location
- */
- dtl(template: dojox.dtl.__StringArgs , context: dojox.dtl.__ObjectArgs ): Function;
- /**
- * Renders the specified template in each of the NodeList entries.
- *
- * @param template The template string or location
- * @param context The context object or location
- */
- dtl(template: String, context: dojox.dtl.__ObjectArgs ): Function;
- /**
- * Renders the specified template in each of the NodeList entries.
- *
- * @param template The template string or location
- * @param context The context object or location
- */
- dtl(template: dojox.dtl.__StringArgs , context: Object): Function;
- /**
- * Renders the specified template in each of the NodeList entries.
- *
- * @param template The template string or location
- * @param context The context object or location
- */
- dtl(template: String, context: Object): Function;
- /**
- * clears all content from each node in the list. Effectively
- * equivalent to removing all child nodes from every item in
- * the list.
- *
- */
- empty(): any;
- /**
- * Ends use of the current NodeList by returning the previous NodeList
- * that generated the current NodeList.
- * Returns the NodeList that generated the current NodeList. If there
- * is no parent NodeList, an empty NodeList is returned.
- *
- */
- end(): any;
- /**
- * Returns the even nodes in this dojo/NodeList as a dojo/NodeList.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- */
- even(): any;
- /**
- * see dojo/_base/array.every() and the Array.every
- * docs.
- * Takes the same structure of arguments and returns as
- * dojo/_base/array.every() with the caveat that the passed array is
- * implicitly this NodeList
- *
- * @param callback the callback
- * @param thisObject Optionalthe context
- */
- every(callback: Function, thisObject?: Object): any;
- /**
- * fade in all elements of this NodeList via dojo.fadeIn
- *
- * @param args OptionalAdditional dojo/_base/fx.Animation arguments to mix into this set with the addition ofan auto parameter.
- */
- fadeIn(args?: Object): any;
- /**
- * fade out all elements of this NodeList via dojo.fadeOut
- *
- * @param args OptionalAdditional dojo/_base/fx.Animation arguments to mix into this set with the addition ofan auto parameter.
- */
- fadeOut(args?: Object): any;
- /**
- * "masks" the built-in javascript filter() method (supported
- * in Dojo via dojo.filter) to support passing a simple
- * string filter in addition to supporting filtering function
- * objects.
- *
- * @param filter If a string, a CSS rule like ".thinger" or "div > span".
- */
- filter(filter: String): any;
- /**
- * "masks" the built-in javascript filter() method (supported
- * in Dojo via dojo.filter) to support passing a simple
- * string filter in addition to supporting filtering function
- * objects.
- *
- * @param filter If a string, a CSS rule like ".thinger" or "div > span".
- */
- filter(filter: Function): any;
- /**
- * Returns the first node in this dojo/NodeList as a dojo/NodeList.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- */
- first(): any;
- /**
- * see dojo/_base/array.forEach(). The primary difference is that the acted-on
- * array is implicitly this NodeList. If you want the option to break out
- * of the forEach loop, use every() or some() instead.
- *
- * @param callback
- * @param thisObj
- */
- forEach(callback: any, thisObj: any): Function;
- /**
- * allows setting the innerHTML of each node in the NodeList,
- * if there is a value passed in, otherwise, reads the innerHTML value of the first node.
- * This method is simpler than the dojo/NodeList.html() method provided by
- * dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
- * and it allows for the innerHTML to be read for the first node in the node list.
- * Since dojo/NodeList-html already took the "html" name, this method is called
- * "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
- * module will define an "html" method that can be used instead. Be careful if you
- * are working in an environment where it is possible that dojo/NodeList-html could
- * have been loaded, since its definition of "html" will take precedence.
- * The nodes represented by the value argument will be cloned if more than one
- * node is in this NodeList. The nodes in this NodeList are returned in the "set"
- * usage of this method, not the HTML that was inserted.
- *
- * @param value Optional
- */
- html(value?: String): any;
- /**
- * allows setting the innerHTML of each node in the NodeList,
- * if there is a value passed in, otherwise, reads the innerHTML value of the first node.
- * This method is simpler than the dojo/NodeList.html() method provided by
- * dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
- * and it allows for the innerHTML to be read for the first node in the node list.
- * Since dojo/NodeList-html already took the "html" name, this method is called
- * "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
- * module will define an "html" method that can be used instead. Be careful if you
- * are working in an environment where it is possible that dojo/NodeList-html could
- * have been loaded, since its definition of "html" will take precedence.
- * The nodes represented by the value argument will be cloned if more than one
- * node is in this NodeList. The nodes in this NodeList are returned in the "set"
- * usage of this method, not the HTML that was inserted.
- *
- * @param value Optional
- */
- html(value?: HTMLElement): any;
- /**
- * allows setting the innerHTML of each node in the NodeList,
- * if there is a value passed in, otherwise, reads the innerHTML value of the first node.
- * This method is simpler than the dojo/NodeList.html() method provided by
- * dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
- * and it allows for the innerHTML to be read for the first node in the node list.
- * Since dojo/NodeList-html already took the "html" name, this method is called
- * "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
- * module will define an "html" method that can be used instead. Be careful if you
- * are working in an environment where it is possible that dojo/NodeList-html could
- * have been loaded, since its definition of "html" will take precedence.
- * The nodes represented by the value argument will be cloned if more than one
- * node is in this NodeList. The nodes in this NodeList are returned in the "set"
- * usage of this method, not the HTML that was inserted.
- *
- * @param value Optional
- */
- html(value?: NodeList): any;
- /**
- * see dojo/_base/array.indexOf(). The primary difference is that the acted-on
- * array is implicitly this NodeList
- * For more details on the behavior of indexOf, see Mozilla's
- * indexOf
- * docs
- *
- * @param value The value to search for.
- * @param fromIndex OptionalThe location to start searching from. Optional. Defaults to 0.
- */
- indexOf(value: Object, fromIndex: number): any;
- /**
- * allows setting the innerHTML of each node in the NodeList,
- * if there is a value passed in, otherwise, reads the innerHTML value of the first node.
- * This method is simpler than the dojo/NodeList.html() method provided by
- * dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
- * and it allows for the innerHTML to be read for the first node in the node list.
- * Since dojo/NodeList-html already took the "html" name, this method is called
- * "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
- * module will define an "html" method that can be used instead. Be careful if you
- * are working in an environment where it is possible that dojo/NodeList-html could
- * have been loaded, since its definition of "html" will take precedence.
- * The nodes represented by the value argument will be cloned if more than one
- * node is in this NodeList. The nodes in this NodeList are returned in the "set"
- * usage of this method, not the HTML that was inserted.
- *
- * @param value Optional
- */
- innerHTML(value?: String): any;
- /**
- * allows setting the innerHTML of each node in the NodeList,
- * if there is a value passed in, otherwise, reads the innerHTML value of the first node.
- * This method is simpler than the dojo/NodeList.html() method provided by
- * dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
- * and it allows for the innerHTML to be read for the first node in the node list.
- * Since dojo/NodeList-html already took the "html" name, this method is called
- * "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
- * module will define an "html" method that can be used instead. Be careful if you
- * are working in an environment where it is possible that dojo/NodeList-html could
- * have been loaded, since its definition of "html" will take precedence.
- * The nodes represented by the value argument will be cloned if more than one
- * node is in this NodeList. The nodes in this NodeList are returned in the "set"
- * usage of this method, not the HTML that was inserted.
- *
- * @param value Optional
- */
- innerHTML(value?: HTMLElement): any;
- /**
- * allows setting the innerHTML of each node in the NodeList,
- * if there is a value passed in, otherwise, reads the innerHTML value of the first node.
- * This method is simpler than the dojo/NodeList.html() method provided by
- * dojo/NodeList-html. This method just does proper innerHTML insertion of HTML fragments,
- * and it allows for the innerHTML to be read for the first node in the node list.
- * Since dojo/NodeList-html already took the "html" name, this method is called
- * "innerHTML". However, if dojo/NodeList-html has not been loaded yet, this
- * module will define an "html" method that can be used instead. Be careful if you
- * are working in an environment where it is possible that dojo/NodeList-html could
- * have been loaded, since its definition of "html" will take precedence.
- * The nodes represented by the value argument will be cloned if more than one
- * node is in this NodeList. The nodes in this NodeList are returned in the "set"
- * usage of this method, not the HTML that was inserted.
- *
- * @param value Optional
- */
- innerHTML(value?: NodeList): any;
- /**
- * The nodes in this NodeList will be placed after the nodes
- * matched by the query passed to insertAfter.
- * The nodes in this NodeList will be cloned if the query
- * matches more than one element. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param query
- */
- insertAfter(query: String): any;
- /**
- * The nodes in this NodeList will be placed after the nodes
- * matched by the query passed to insertAfter.
- * The nodes in this NodeList will be cloned if the query
- * matches more than one element. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param query
- */
- insertBefore(query: String): any;
- /**
- * Create a new instance of a specified class, using the
- * specified properties and each node in the NodeList as a
- * srcNodeRef.
- *
- * @param declaredClass
- * @param properties Optional
- */
- instantiate(declaredClass: String, properties?: Object): any;
- /**
- * Create a new instance of a specified class, using the
- * specified properties and each node in the NodeList as a
- * srcNodeRef.
- *
- * @param declaredClass
- * @param properties Optional
- */
- instantiate(declaredClass: Object, properties?: Object): any;
- /**
- * Returns the last node in this dojo/NodeList as a dojo/NodeList.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- */
- last(): any;
- /**
- * see dojo/_base/array.lastIndexOf(). The primary difference is that the
- * acted-on array is implicitly this NodeList
- * For more details on the behavior of lastIndexOf, see
- * Mozilla's lastIndexOf
- * docs
- *
- * @param value The value to search for.
- * @param fromIndex OptionalThe location to start searching from. Optional. Defaults to 0.
- */
- lastIndexOf(value: Object, fromIndex?: number): any;
- /**
- * see dojo/_base/array.map(). The primary difference is that the acted-on
- * array is implicitly this NodeList and the return is a
- * NodeList (a subclass of Array)
- *
- * @param func
- * @param obj Optional
- */
- map(func: Function, obj?: Function): any;
- /**
- * Returns margin-box size of nodes
- *
- */
- marginBox(): void;
- /**
- * Returns the next element for nodes in this dojo/NodeList.
- * Optionally takes a query to filter the next elements.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- * @param query Optionala CSS selector.
- */
- next(query?: String): any;
- /**
- * Returns all sibling elements that come after the nodes in this dojo/NodeList.
- * Optionally takes a query to filter the sibling elements.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- * @param query Optionala CSS selector.
- */
- nextAll(query?: String): any;
- /**
- * Returns the odd nodes in this dojo/NodeList as a dojo/NodeList.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- */
- odd(): any;
- /**
- * Listen for events on the nodes in the NodeList. Basic usage is:
- *
- * @param eventName
- * @param listener
- */
- on(eventName: any, listener: any): any;
- /**
- * removes elements in this list that match the filter
- * from their parents and returns them as a new NodeList.
- *
- * @param filter OptionalCSS selector like ".foo" or "div > span"
- */
- orphan(filter?: String): any;
- /**
- * Returns immediate parent elements for nodes in this dojo/NodeList.
- * Optionally takes a query to filter the parent elements.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- * @param query Optionala CSS selector.
- */
- parent(query?: String): any;
- /**
- * Returns all parent elements for nodes in this dojo/NodeList.
- * Optionally takes a query to filter the child elements.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- * @param query Optionala CSS selector.
- */
- parents(query?: String): any;
- /**
- * places elements of this node list relative to the first element matched
- * by queryOrNode. Returns the original NodeList. See: dojo/dom-construct.place
- *
- * @param queryOrNode may be a string representing any valid CSS3 selector or a DOM node.In the selector case, only the first matching element will be usedfor relative positioning.
- * @param position can be one of:"last" (default)"first""before""after""only""replace"or an offset in the childNodes property
- */
- place(queryOrNode: String, position: String): any;
- /**
- * places elements of this node list relative to the first element matched
- * by queryOrNode. Returns the original NodeList. See: dojo/dom-construct.place
- *
- * @param queryOrNode may be a string representing any valid CSS3 selector or a DOM node.In the selector case, only the first matching element will be usedfor relative positioning.
- * @param position can be one of:"last" (default)"first""before""after""only""replace"or an offset in the childNodes property
- */
- place(queryOrNode: HTMLElement, position: String): any;
- /**
- * Returns border-box objects (x/y/w/h) of all elements in a node list
- * as an Array (not a NodeList). Acts like dojo/dom-geometry-position, though
- * assumes the node passed is each node in this list.
- *
- */
- position(): any;
- /**
- * prepends the content to every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- prepend(content: String): any;
- /**
- * prepends the content to every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- prepend(content: HTMLElement): any;
- /**
- * prepends the content to every node in the NodeList.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- prepend(content: NodeList): any;
- /**
- * prepends nodes in this NodeList to the nodes matched by
- * the query passed to prependTo.
- * The nodes in this NodeList will be cloned if the query
- * matches more than one element. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param query
- */
- prependTo(query: String): any;
- /**
- * Returns the previous element for nodes in this dojo/NodeList.
- * Optionally takes a query to filter the previous elements.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- * @param query Optionala CSS selector.
- */
- prev(query?: String): any;
- /**
- * Returns all sibling elements that come before the nodes in this dojo/NodeList.
- * Optionally takes a query to filter the sibling elements.
- * The returned nodes will be in reverse DOM order -- the first node in the list will
- * be the node closest to the original node/NodeList.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- * @param query Optionala CSS selector.
- */
- prevAll(query?: String): any;
- /**
- * Returns a new list whose members match the passed query,
- * assuming elements of the current NodeList as the root for
- * each search.
- *
- * @param queryStr
- */
- query(queryStr: String): any;
- /**
- * removes elements in this list that match the filter
- * from their parents and returns them as a new NodeList.
- *
- * @param filter OptionalCSS selector like ".foo" or "div > span"
- */
- remove(filter?: String): any;
- /**
- * Removes an attribute from each node in the list.
- *
- * @param name the name of the attribute to remove
- */
- removeAttr(name: String): void;
- /**
- * removes the specified class from every node in the list
- *
- * @param className OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- removeClass(className?: String): any;
- /**
- * removes the specified class from every node in the list
- *
- * @param className OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- removeClass(className: any[]): any;
- /**
- * Animate the effect of removing a class to all nodes in this list.
- * see dojox.fx.removeClass
- *
- * @param cssClass
- * @param args
- */
- removeClassFx(cssClass: any, args: any): {type:Function;value:any};
- /**
- * Remove the data associated with these nodes.
- *
- * @param key OptionalIf omitted, clean all data for this node.If passed, remove the data item found at key
- */
- removeData(key?: String): void;
- /**
- * replaces nodes matched by the query passed to replaceAll with the nodes
- * in this NodeList.
- * The nodes in this NodeList will be cloned if the query
- * matches more than one element. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param query
- */
- replaceAll(query: String): any;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling removeClass() and addClass()
- *
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(addClassStr: String, removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling removeClass() and addClass()
- *
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(addClassStr: any[], removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling removeClass() and addClass()
- *
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(addClassStr: String, removeClassStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling removeClass() and addClass()
- *
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(addClassStr: any[], removeClassStr?: any[]): void;
- /**
- * Replaces each node in ths NodeList with the content passed to replaceWith.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- replaceWith(content: String): any;
- /**
- * Replaces each node in ths NodeList with the content passed to replaceWith.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- replaceWith(content: HTMLElement): any;
- /**
- * Replaces each node in ths NodeList with the content passed to replaceWith.
- * The content will be cloned if the length of NodeList
- * is greater than 1. Only the DOM nodes are cloned, not
- * any attached event handlers.
- *
- * @param content
- */
- replaceWith(content: NodeList): any;
- /**
- * Returns all sibling elements for nodes in this dojo/NodeList.
- * Optionally takes a query to filter the sibling elements.
- * .end() can be used on the returned dojo/NodeList to get back to the
- * original dojo/NodeList.
- *
- * @param query Optionala CSS selector.
- */
- siblings(query?: String): any;
- /**
- * Returns a new NodeList, maintaining this one in place
- * This method behaves exactly like the Array.slice method
- * with the caveat that it returns a dojo/NodeList and not a
- * raw Array. For more details, see Mozilla's slice
- * documentation
- *
- * @param begin Can be a positive or negative integer, with positiveintegers noting the offset to begin at, and negativeintegers denoting an offset from the end (i.e., to the leftof the end)
- * @param end OptionalOptional parameter to describe what position relative tothe NodeList's zero index to end the slice at. Like begin,can be positive or negative.
- */
- slice(begin: number, end?: number): any;
- /**
- * slide all elements of the node list to the specified place via dojo/fx.slideTo()
- *
- * @param args OptionalAdditional dojo/_base/fx.Animation arguments to mix into this set with the addition ofan auto parameter.
- */
- slideTo(args?: Object): any;
- /**
- * Takes the same structure of arguments and returns as
- * dojo/_base/array.some() with the caveat that the passed array is
- * implicitly this NodeList. See dojo/_base/array.some() and Mozilla's
- * Array.some
- * documentation.
- *
- * @param callback the callback
- * @param thisObject Optionalthe context
- */
- some(callback: Function, thisObject?: Object): any;
- /**
- * Returns a new NodeList, manipulating this NodeList based on
- * the arguments passed, potentially splicing in new elements
- * at an offset, optionally deleting elements
- * This method behaves exactly like the Array.splice method
- * with the caveat that it returns a dojo/NodeList and not a
- * raw Array. For more details, see Mozilla's splice
- * documentation
- * For backwards compatibility, calling .end() on the spliced NodeList
- * does not return the original NodeList -- splice alters the NodeList in place.
- *
- * @param index begin can be a positive or negative integer, with positiveintegers noting the offset to begin at, and negativeintegers denoting an offset from the end (i.e., to the leftof the end)
- * @param howmany OptionalOptional parameter to describe what position relative tothe NodeList's zero index to end the slice at. Like begin,can be positive or negative.
- * @param item OptionalAny number of optional parameters may be passed in to bespliced into the NodeList
- */
- splice(index: number, howmany?: number, item?: Object[]): any;
- /**
- * gets or sets the CSS property for every element in the NodeList
- *
- * @param property the CSS property to get/set, in JavaScript notation("lineHieght" instead of "line-height")
- * @param value Optionaloptional. The value to set the property to
- */
- style(property: String, value?: String): any;
- /**
- * allows setting the text value of each node in the NodeList,
- * if there is a value passed in, otherwise, returns the text value for all the
- * nodes in the NodeList in one string.
- *
- * @param value
- */
- text(value: String): any;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- *
- * @param className the CSS class to add
- * @param condition OptionalIf passed, true means to add the class, false means to remove.
- */
- toggleClass(className: String, condition?: boolean): void;
- /**
- * Animate the effect of adding or removing a class to all nodes in this list.
- * see dojox.fx.toggleClass
- *
- * @param cssClass
- * @param force
- * @param args
- */
- toggleClassFx(cssClass: any, force: any, args: any): {type:Function;value:any};
- /**
- *
- */
- toString(): any;
- /**
- * If a value is passed, allows seting the value property of form elements in this
- * NodeList, or properly selecting/checking the right value for radio/checkbox/select
- * elements. If no value is passed, the value of the first node in this NodeList
- * is returned.
- *
- * @param value
- */
- val(value: String): any;
- /**
- * If a value is passed, allows seting the value property of form elements in this
- * NodeList, or properly selecting/checking the right value for radio/checkbox/select
- * elements. If no value is passed, the value of the first node in this NodeList
- * is returned.
- *
- * @param value
- */
- val(value: any[]): any;
- /**
- * wipe in all elements of this NodeList via dojo/fx.wipeIn()
- *
- * @param args OptionalAdditional dojo/_base/fx.Animation arguments to mix into this set with the addition ofan auto parameter.
- */
- wipeIn(args?: Object): any;
- /**
- * wipe out all elements of this NodeList via dojo/fx.wipeOut()
- *
- * @param args OptionalAdditional dojo/_base/fx.Animation arguments to mix into this set with the addition ofan auto parameter.
- */
- wipeOut(args?: Object): any;
- /**
- * Wrap each node in the NodeList with html passed to wrap.
- * html will be cloned if the NodeList has more than one
- * element. Only DOM nodes are cloned, not any attached
- * event handlers.
- *
- * @param html
- */
- wrap(html: String): any;
- /**
- * Wrap each node in the NodeList with html passed to wrap.
- * html will be cloned if the NodeList has more than one
- * element. Only DOM nodes are cloned, not any attached
- * event handlers.
- *
- * @param html
- */
- wrap(html: HTMLElement): any;
- /**
- * Insert html where the first node in this NodeList lives, then place all
- * nodes in this NodeList as the child of the html.
- *
- * @param html
- */
- wrapAll(html: String): any;
- /**
- * Insert html where the first node in this NodeList lives, then place all
- * nodes in this NodeList as the child of the html.
- *
- * @param html
- */
- wrapAll(html: HTMLElement): any;
- /**
- * For each node in the NodeList, wrap all its children with the passed in html.
- * html will be cloned if the NodeList has more than one
- * element. Only DOM nodes are cloned, not any attached
- * event handlers.
- *
- * @param html
- */
- wrapInner(html: String): any;
- /**
- * For each node in the NodeList, wrap all its children with the passed in html.
- * html will be cloned if the NodeList has more than one
- * element. Only DOM nodes are cloned, not any attached
- * event handlers.
- *
- * @param html
- */
- wrapInner(html: HTMLElement): any;
- }
- namespace NodeList {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/NodeList._nodeDataCache.html
- *
- *
- */
- interface _nodeDataCache {
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/Stateful.html
- *
- * Base class for objects that provide named properties with optional getter/setter
- * control and the ability to watch for property changes
- *
- * The class also provides the functionality to auto-magically manage getters
- * and setters for object attributes/properties.
- *
- * Getters and Setters should follow the format of _xxxGetter or _xxxSetter where
- * the xxx is a name of the attribute to handle. So an attribute of "foo"
- * would have a custom getter of _fooGetter and a custom setter of _fooSetter.
- *
- */
- class Stateful {
- constructor();
- inherited: {(args: IArguments): any};
- /**
- * Get a property on a Stateful instance.
- * Get a named property on a Stateful object. The property may
- * potentially be retrieved via a getter method in subclasses. In the base class
- * this just retrieves the object's property.
- *
- * @param name The property to get.
- */
- get(name: String): any;
- /**
- *
- * @param params Optional
- */
- postscript(params?: Object): void;
- /**
- * Set a property on a Stateful instance
- * Sets named properties on a stateful object and notifies any watchers of
- * the property. A programmatic setter may be defined in subclasses.
- *
- * @param name The property to set.
- * @param value The value to set in the property.
- */
- set(name: String, value: Object): any;
- /**
- * Watches a property for changes
- *
- * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched
- * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value.
- */
- watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
- }
- module _base {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/declare.html
- *
- * Create a feature-rich constructor from compact notation.
- * Create a constructor using a compact notation for inheritance and
- * prototype extension.
- *
- * Mixin ancestors provide a type of multiple inheritance.
- * Prototypes of mixin ancestors are copied to the new class:
- * changes to mixin prototypes will not affect classes to which
- * they have been mixed in.
- *
- * Ancestors can be compound classes created by this version of
- * declare(). In complex cases all base classes are going to be
- * linearized according to C3 MRO algorithm
- * (see http://www.python.org/download/releases/2.3/mro/ for more
- * details).
- *
- * "className" is cached in "declaredClass" property of the new class,
- * if it was supplied. The immediate super class will be cached in
- * "superclass" property of the new class.
- *
- * Methods in "props" will be copied and modified: "nom" property
- * (the declared name of the method) will be added to all copied
- * functions to help identify them for the internal machinery. Be
- * very careful, while reusing methods: if you use the same
- * function under different names, it can produce errors in some
- * cases.
- *
- * It is possible to use constructors created "manually" (without
- * declare()) as bases. They will be called as usual during the
- * creation of an instance, their methods will be chained, and even
- * called by "this.inherited()".
- *
- * Special property "-chains-" governs how to chain methods. It is
- * a dictionary, which uses method names as keys, and hint strings
- * as values. If a hint string is "after", this method will be
- * called after methods of its base classes. If a hint string is
- * "before", this method will be called before methods of its base
- * classes.
- *
- * If "constructor" is not mentioned in "-chains-" property, it will
- * be chained using the legacy mode: using "after" chaining,
- * calling preamble() method before each constructor, if available,
- * and calling postscript() after all constructors were executed.
- * If the hint is "after", it is chained as a regular method, but
- * postscript() will be called after the chain of constructors.
- * "constructor" cannot be chained "before", but it allows
- * a special hint string: "manual", which means that constructors
- * are not going to be chained in any way, and programmer will call
- * them manually using this.inherited(). In the latter case
- * postscript() will be called after the construction.
- *
- * All chaining hints are "inherited" from base classes and
- * potentially can be overridden. Be very careful when overriding
- * hints! Make sure that all chained methods can work in a proposed
- * manner of chaining.
- *
- * Once a method was chained, it is impossible to unchain it. The
- * only exception is "constructor". You don't need to define a
- * method in order to supply a chaining hint.
- *
- * If a method is chained, it cannot use this.inherited() because
- * all other methods in the hierarchy will be called automatically.
- *
- * Usually constructors and initializers of any kind are chained
- * using "after" and destructors of any kind are chained as
- * "before". Note that chaining assumes that chained methods do not
- * return any value: any returned value will be discarded.
- *
- * @param className OptionalThe optional name of the constructor (loosely, a "class")stored in the "declaredClass" property in the created prototype.It will be used as a global name for a created constructor.
- * @param superclass May be null, a Function, or an Array of Functions. This argumentspecifies a list of bases (the left-most one is the most deepestbase).
- * @param props An object whose properties are copied to the created prototype.Add an instance-initialization function by making it a propertynamed "constructor".
- */
- interface declare { (className?: String, superclass?: any, props?: Object): any}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/declare.html
- *
- * Create a feature-rich constructor from compact notation.
- * Create a constructor using a compact notation for inheritance and
- * prototype extension.
- *
- * Mixin ancestors provide a type of multiple inheritance.
- * Prototypes of mixin ancestors are copied to the new class:
- * changes to mixin prototypes will not affect classes to which
- * they have been mixed in.
- *
- * Ancestors can be compound classes created by this version of
- * declare(). In complex cases all base classes are going to be
- * linearized according to C3 MRO algorithm
- * (see http://www.python.org/download/releases/2.3/mro/ for more
- * details).
- *
- * "className" is cached in "declaredClass" property of the new class,
- * if it was supplied. The immediate super class will be cached in
- * "superclass" property of the new class.
- *
- * Methods in "props" will be copied and modified: "nom" property
- * (the declared name of the method) will be added to all copied
- * functions to help identify them for the internal machinery. Be
- * very careful, while reusing methods: if you use the same
- * function under different names, it can produce errors in some
- * cases.
- *
- * It is possible to use constructors created "manually" (without
- * declare()) as bases. They will be called as usual during the
- * creation of an instance, their methods will be chained, and even
- * called by "this.inherited()".
- *
- * Special property "-chains-" governs how to chain methods. It is
- * a dictionary, which uses method names as keys, and hint strings
- * as values. If a hint string is "after", this method will be
- * called after methods of its base classes. If a hint string is
- * "before", this method will be called before methods of its base
- * classes.
- *
- * If "constructor" is not mentioned in "-chains-" property, it will
- * be chained using the legacy mode: using "after" chaining,
- * calling preamble() method before each constructor, if available,
- * and calling postscript() after all constructors were executed.
- * If the hint is "after", it is chained as a regular method, but
- * postscript() will be called after the chain of constructors.
- * "constructor" cannot be chained "before", but it allows
- * a special hint string: "manual", which means that constructors
- * are not going to be chained in any way, and programmer will call
- * them manually using this.inherited(). In the latter case
- * postscript() will be called after the construction.
- *
- * All chaining hints are "inherited" from base classes and
- * potentially can be overridden. Be very careful when overriding
- * hints! Make sure that all chained methods can work in a proposed
- * manner of chaining.
- *
- * Once a method was chained, it is impossible to unchain it. The
- * only exception is "constructor". You don't need to define a
- * method in order to supply a chaining hint.
- *
- * If a method is chained, it cannot use this.inherited() because
- * all other methods in the hierarchy will be called automatically.
- *
- * Usually constructors and initializers of any kind are chained
- * using "after" and destructors of any kind are chained as
- * "before". Note that chaining assumes that chained methods do not
- * return any value: any returned value will be discarded.
- *
- * @param className OptionalThe optional name of the constructor (loosely, a "class")stored in the "declaredClass" property in the created prototype.It will be used as a global name for a created constructor.
- * @param superclass May be null, a Function, or an Array of Functions. This argumentspecifies a list of bases (the left-most one is the most deepestbase).
- * @param props An object whose properties are copied to the created prototype.Add an instance-initialization function by making it a propertynamed "constructor".
- */
- interface declare{(className?: String, superclass?: any[], props?: Object): any}
- interface declare {
- /**
- * Mix in properties skipping a constructor and decorating functions
- * like it is done by declare().
- * This function is used to mix in properties like lang.mixin does,
- * but it skips a constructor property and decorates functions like
- * declare() does.
- *
- * It is meant to be used with classes and objects produced with
- * declare. Functions mixed in with dojo.safeMixin can use
- * this.inherited() like normal methods.
- *
- * This function is used to implement extend() method of a constructor
- * produced with declare().
- *
- * @param target Target object to accept new properties.
- * @param source Source object for new properties.
- */
- safeMixin(target: Object, source: Object): Object;
- }
- namespace declare {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/declare.__DeclareCreatedObject.html
- *
- * dojo/_base/declare() returns a constructor C. new C() returns an Object with the following
- * methods, in addition to the methods and properties specified via the arguments passed to declare().
- *
- */
- class __DeclareCreatedObject {
- constructor();
- /**
- * Create a subclass of the declared class from a list of base classes.
- * Create a constructor using a compact notation for inheritance and
- * prototype extension.
- *
- * Mixin ancestors provide a type of multiple inheritance.
- * Prototypes of mixin ancestors are copied to the new class:
- * changes to mixin prototypes will not affect classes to which
- * they have been mixed in.
- *
- * @param mixins Specifies a list of bases (the left-most one is the most deepestbase).
- * @param props OptionalAn optional object whose properties are copied to the created prototype.
- */
- createSubclass(mixins: Function[], props?: Object): dojo._base.declare.__DeclareCreatedObject;
- /**
- * Adds all properties and methods of source to constructor's
- * prototype, making them available to all instances created with
- * constructor. This method is specific to constructors created with
- * declare().
- * Adds source properties to the constructor's prototype. It can
- * override existing properties.
- *
- * This method is similar to dojo.extend function, but it is specific
- * to constructors produced by declare(). It is implemented
- * using dojo.safeMixin, and it skips a constructor property,
- * and properly decorates copied functions.
- *
- * @param source Source object which properties are going to be copied to theconstructor's prototype.
- */
- extend(source: Object): void;
- /**
- * Returns a super method.
- * This method is a convenience method for "this.inherited()".
- * It uses the same algorithm but instead of executing a super
- * method, it returns it, or "undefined" if not found.
- *
- * @param name OptionalThe optional method name. Should be the same as the caller'sname. Usually "name" is specified in complex dynamic cases, whenthe calling method was dynamically added, undecorated bydeclare(), and it cannot be determined.
- * @param args The caller supply this argument, which should be the original"arguments".
- */
- getInherited(name?: String, args?: Object): any;
- /**
- * Calls a super method.
- * This method is used inside method of classes produced with
- * declare() to call a super method (next in the chain). It is
- * used for manually controlled chaining. Consider using the regular
- * chaining, because it is faster. Use "this.inherited()" only in
- * complex cases.
- *
- * This method cannot me called from automatically chained
- * constructors including the case of a special (legacy)
- * constructor chaining. It cannot be called from chained methods.
- *
- * If "this.inherited()" cannot find the next-in-chain method, it
- * does nothing and returns "undefined". The last method in chain
- * can be a default method implemented in Object, which will be
- * called last.
- *
- * If "name" is specified, it is assumed that the method that
- * received "args" is the parent method for this call. It is looked
- * up in the chain list and if it is found the next-in-chain method
- * is called. If it is not found, the first-in-chain method is
- * called.
- *
- * If "name" is not specified, it will be derived from the calling
- * method (using a methoid property "nom").
- *
- * @param name OptionalThe optional method name. Should be the same as the caller'sname. Usually "name" is specified in complex dynamic cases, whenthe calling method was dynamically added, undecorated bydeclare(), and it cannot be determined.
- * @param args The caller supply this argument, which should be the original"arguments".
- * @param newArgs OptionalIf "true", the found function will be returned withoutexecuting it.If Array, it will be used to call a super method. Otherwise"args" will be used.
- */
- inherited(name?: String, args?: Object, newArgs?: Object): any;
- /**
- * Checks the inheritance chain to see if it is inherited from this
- * class.
- * This method is used with instances of classes produced with
- * declare() to determine of they support a certain interface or
- * not. It models "instanceof" operator.
- *
- * @param cls Class constructor.
- */
- isInstanceOf(cls: Function): any;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/Deferred.html
- *
- * Deprecated. This module defines the legacy dojo/_base/Deferred API.
- * New code should use dojo/Deferred instead.
- * The Deferred API is based on the concept of promises that provide a
- * generic interface into the eventual completion of an asynchronous action.
- * The motivation for promises fundamentally is about creating a
- * separation of concerns that allows one to achieve the same type of
- * call patterns and logical data flow in asynchronous code as can be
- * achieved in synchronous code. Promises allows one
- * to be able to call a function purely with arguments needed for
- * execution, without conflating the call with concerns of whether it is
- * sync or async. One shouldn't need to alter a call's arguments if the
- * implementation switches from sync to async (or vice versa). By having
- * async functions return promises, the concerns of making the call are
- * separated from the concerns of asynchronous interaction (which are
- * handled by the promise).
- *
- * The Deferred is a type of promise that provides methods for fulfilling the
- * promise with a successful result or an error. The most important method for
- * working with Dojo's promises is the then() method, which follows the
- * CommonJS proposed promise API. An example of using a Dojo promise:
- *
- * var resultingPromise = someAsyncOperation.then(function(result){
- * ... handle result ...
- * },
- * function(error){
- * ... handle error ...
- * });
- * The .then() call returns a new promise that represents the result of the
- * execution of the callback. The callbacks will never affect the original promises value.
- *
- * The Deferred instances also provide the following functions for backwards compatibility:
- *
- * addCallback(handler)
- * addErrback(handler)
- * callback(result)
- * errback(result)
- * Callbacks are allowed to return promises themselves, so
- * you can build complicated sequences of events with ease.
- *
- * The creator of the Deferred may specify a canceller. The canceller
- * is a function that will be called if Deferred.cancel is called
- * before the Deferred fires. You can use this to implement clean
- * aborting of an XMLHttpRequest, etc. Note that cancel will fire the
- * deferred with a CancelledError (unless your canceller returns
- * another kind of error), so the errbacks should be prepared to
- * handle that error for cancellable Deferreds.
- *
- * @param canceller Optional
- */
- interface Deferred{(canceller?: Function): void}
- interface Deferred {
- /**
- *
- */
- fired: number;
- /**
- *
- */
- promise: Object;
- /**
- * Add handler as both successful callback and error callback for this deferred instance.
- *
- * @param callback
- */
- addBoth(callback: Function): any;
- /**
- * Adds successful callback for this deferred instance.
- *
- * @param callback
- */
- addCallback(callback: Function): any;
- /**
- * Adds callback and error callback for this deferred instance.
- *
- * @param callback OptionalThe callback attached to this deferred object.
- * @param errback OptionalThe error callback attached to this deferred object.
- */
- addCallbacks(callback?: Function, errback?: Function): any;
- /**
- * Adds error callback for this deferred instance.
- *
- * @param errback
- */
- addErrback(errback: Function): any;
- /**
- * Fulfills the Deferred instance successfully with the provide value
- *
- * @param value
- */
- callback(value: any): void;
- /**
- * Cancels the asynchronous operation
- *
- */
- cancel(): void;
- /**
- * Fulfills the Deferred instance as an error with the provided error
- *
- * @param error
- */
- errback(error: any): void;
- /**
- * Checks whether the deferred has been canceled.
- *
- */
- isCanceled(): boolean;
- /**
- * Checks whether the deferred has been resolved or rejected.
- *
- */
- isFulfilled(): boolean;
- /**
- * Checks whether the deferred has been rejected.
- *
- */
- isRejected(): boolean;
- /**
- * Checks whether the deferred has been resolved.
- *
- */
- isResolved(): boolean;
- /**
- * Send progress events to all listeners
- *
- * @param update
- */
- progress(update: any): void;
- /**
- * Fulfills the Deferred instance as an error with the provided error
- *
- * @param error
- */
- reject(error: any): void;
- /**
- * Fulfills the Deferred instance successfully with the provide value
- *
- * @param value
- */
- resolve(value: any): void;
- /**
- * Adds a fulfilledHandler, errorHandler, and progressHandler to be called for
- * completion of a promise. The fulfilledHandler is called when the promise
- * is fulfilled. The errorHandler is called when a promise fails. The
- * progressHandler is called for progress events. All arguments are optional
- * and non-function values are ignored. The progressHandler is not only an
- * optional argument, but progress events are purely optional. Promise
- * providers are not required to ever create progress events.
- *
- * This function will return a new promise that is fulfilled when the given
- * fulfilledHandler or errorHandler callback is finished. This allows promise
- * operations to be chained together. The value returned from the callback
- * handler is the fulfillment value for the returned promise. If the callback
- * throws an error, the returned promise will be moved to failed state.
- *
- * @param resolvedCallback Optional
- * @param errorCallback Optional
- * @param progressCallback Optional
- */
- then(resolvedCallback?: Function, errorCallback?: Function, progressCallback?: Function): any;
- /**
- * Transparently applies callbacks to values and/or promises.
- * Accepts promises but also transparently handles non-promises. If no
- * callbacks are provided returns a promise, regardless of the initial
- * value. Foreign promises are converted.
- *
- * If callbacks are provided and the initial value is not a promise,
- * the callback is executed immediately with no error handling. Returns
- * a promise if the initial value is a promise, or the result of the
- * callback otherwise.
- *
- * @param valueOrPromise Either a regular value or an object with a then() method thatfollows the Promises/A specification.
- * @param callback OptionalCallback to be invoked when the promise is resolved, or a non-promiseis received.
- * @param errback OptionalCallback to be invoked when the promise is rejected.
- * @param progback OptionalCallback to be invoked when the promise emits a progress update.
- */
- when(valueOrPromise?: any, callback?: Function, errback?: Function, progback?: Function): any;
- }
- namespace Deferred {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/url.html
- *
- *
- */
- interface url{(): void}
- interface url {
- /**
- *
- */
- authority: Object;
- /**
- *
- */
- fragment: Object;
- /**
- *
- */
- host: Object;
- /**
- *
- */
- password: Object;
- /**
- *
- */
- path: Object;
- /**
- *
- */
- port: Object;
- /**
- *
- */
- query: Object;
- /**
- *
- */
- scheme: Object;
- /**
- *
- */
- uri: Object;
- /**
- *
- */
- user: Object;
- /**
- *
- */
- toString(): void;
- }
- namespace url {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/url.authority.html
- *
- *
- */
- interface authority {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/url.password.html
- *
- *
- */
- interface password {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/url.port.html
- *
- *
- */
- interface port {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/url.fragment.html
- *
- *
- */
- interface fragment {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/url.query.html
- *
- *
- */
- interface query {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/url.user.html
- *
- *
- */
- interface user {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/url.scheme.html
- *
- *
- */
- interface scheme {
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/xhr.html
- *
- * Deprecated. Use dojo/request instead.
- * Sends an HTTP request with the given method.
- * See also dojo.xhrGet(), xhrPost(), xhrPut() and dojo.xhrDelete() for shortcuts
- * for those HTTP methods. There are also methods for "raw" PUT and POST methods
- * via dojo.rawXhrPut() and dojo.rawXhrPost() respectively.
- *
- * @param method HTTP method to be used, such as GET, POST, PUT, DELETE. Should be uppercase.
- * @param args
- * @param hasBody OptionalIf the request has an HTTP body, then pass true for hasBody.
- */
- interface xhr{(method: String, args: Object, hasBody?: boolean): void}
- interface xhr {
- /**
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls.
- *
- */
- contentHandlers: Object;
- /**
- * Sends an HTTP DELETE request to the server.
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- del(args: Object): any;
- /**
- * Serialize a form field to a JavaScript object.
- * Returns the value encoded in a form field as
- * as a string or an array of strings. Disabled form elements
- * and unchecked radio and checkboxes are skipped. Multi-select
- * elements are returned as an array of string values.
- *
- * @param inputNode
- */
- fieldToObject(inputNode: HTMLElement): any;
- /**
- * Serialize a form field to a JavaScript object.
- * Returns the value encoded in a form field as
- * as a string or an array of strings. Disabled form elements
- * and unchecked radio and checkboxes are skipped. Multi-select
- * elements are returned as an array of string values.
- *
- * @param inputNode
- */
- fieldToObject(inputNode: String): any;
- /**
- * Create a serialized JSON string from a form node or string
- * ID identifying the form to serialize
- *
- * @param formNode
- * @param prettyPrint Optional
- */
- formToJson(formNode: HTMLElement, prettyPrint?: boolean): any;
- /**
- * Create a serialized JSON string from a form node or string
- * ID identifying the form to serialize
- *
- * @param formNode
- * @param prettyPrint Optional
- */
- formToJson(formNode: String, prettyPrint?: boolean): any;
- /**
- * Serialize a form node to a JavaScript object.
- * Returns the values encoded in an HTML form as
- * string properties in an object which it then returns. Disabled form
- * elements, buttons, and other non-value form elements are skipped.
- * Multi-select elements are returned as an array of string values.
- *
- * @param formNode
- */
- formToObject(formNode: HTMLElement): Object;
- /**
- * Serialize a form node to a JavaScript object.
- * Returns the values encoded in an HTML form as
- * string properties in an object which it then returns. Disabled form
- * elements, buttons, and other non-value form elements are skipped.
- * Multi-select elements are returned as an array of string values.
- *
- * @param formNode
- */
- formToObject(formNode: String): Object;
- /**
- * Returns a URL-encoded string representing the form passed as either a
- * node or string ID identifying the form to serialize
- *
- * @param formNode
- */
- formToQuery(formNode: HTMLElement): any;
- /**
- * Returns a URL-encoded string representing the form passed as either a
- * node or string ID identifying the form to serialize
- *
- * @param formNode
- */
- formToQuery(formNode: String): any;
- /**
- * Sends an HTTP GET request to the server.
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- get(args: Object): any;
- /**
- * takes a name/value mapping object and returns a string representing
- * a URL-encoded version of that object.
- *
- * @param map
- */
- objectToQuery(map: Object): any;
- /**
- * Sends an HTTP POST request to the server. In addition to the properties
- * listed for the dojo.__XhrArgs type, the following property is allowed:
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- post(args: Object): any;
- /**
- * Sends an HTTP PUT request to the server. In addition to the properties
- * listed for the dojo.__XhrArgs type, the following property is allowed:
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- put(args: Object): any;
- /**
- * Create an object representing a de-serialized query section of a
- * URL. Query keys with multiple values are returned in an array.
- *
- * @param str
- */
- queryToObject(str: String): Object;
- }
- namespace xhr {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/xhr.contentHandlers.html
- *
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls.
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls. Each contentHandler is
- * called, passing the xhr object for manipulation. The return value
- * from the contentHandler will be passed to the load or handle
- * functions defined in the original xhr call.
- *
- */
- interface contentHandlers {
- /**
- *
- * @param xhr
- */
- auto(xhr: any): void;
- /**
- * A contentHandler which evaluates the response data, expecting it to be valid JavaScript
- *
- * @param xhr
- */
- javascript(xhr: any): any;
- /**
- * A contentHandler which returns a JavaScript object created from the response data
- *
- * @param xhr
- */
- json(xhr: any): any;
- /**
- * A contentHandler which expects comment-filtered JSON.
- * A contentHandler which expects comment-filtered JSON.
- * the json-comment-filtered option was implemented to prevent
- * "JavaScript Hijacking", but it is less secure than standard JSON. Use
- * standard JSON instead. JSON prefixing can be used to subvert hijacking.
- *
- * Will throw a notice suggesting to use application/json mimetype, as
- * json-commenting can introduce security issues. To decrease the chances of hijacking,
- * use the standard json contentHandler, and prefix your "JSON" with: {}&&
- *
- * use djConfig.useCommentedJson = true to turn off the notice
- *
- * @param xhr
- */
- json_comment_filtered(xhr: any): any;
- /**
- * A contentHandler which checks the presence of comment-filtered JSON and
- * alternates between the json and json-comment-filtered contentHandlers.
- *
- * @param xhr
- */
- json_comment_optional(xhr: any): any;
- /**
- *
- * @param xhr
- */
- olson_zoneinfo(xhr: any): void;
- /**
- * A contentHandler which simply returns the plaintext response data
- *
- * @param xhr
- */
- text(xhr: any): any;
- /**
- * A contentHandler returning an XML Document parsed from the response data
- *
- * @param xhr
- */
- xml(xhr: any): any;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/config.html
- *
- * This module defines the user configuration during bootstrap.
- * By defining user configuration as a module value, an entire configuration can be specified in a build,
- * thereby eliminating the need for sniffing and or explicitly setting in the global variable dojoConfig.
- * Also, when multiple instances of dojo exist in a single application, each will necessarily be located
- * at an unique absolute module identifier as given by the package configuration. Implementing configuration
- * as a module allows for specifying unique, per-instance configurations.
- *
- */
- class config {
- constructor();
- /**
- * Adds a callback via dojo/ready. Useful when Dojo is added after
- * the page loads and djConfig.afterOnLoad is true. Supports the same
- * arguments as dojo/ready. When using a function reference, use
- * djConfig.addOnLoad = function(){};. For object with function name use
- * djConfig.addOnLoad = [myObject, "functionName"]; and for object with
- * function reference use
- * djConfig.addOnLoad = [myObject, function(){}];
- *
- */
- "addOnLoad": Function;
- /**
- *
- */
- "afterOnLoad": boolean;
- /**
- *
- */
- "baseUrl": Object;
- /**
- * Defines a callback to be used when dependencies are defined before
- * the loader has been loaded. When provided, they cause the loader to
- * execute require(deps, callback) once it has finished loading.
- * Should be used with deps.
- *
- */
- "callback": Function;
- /**
- *
- */
- "debugContainerId": string;
- /**
- *
- */
- "debugHeight": number;
- /**
- * Default duration, in milliseconds, for wipe and fade animations within dijits.
- * Assigned to dijit.defaultDuration.
- *
- */
- "defaultDuration": number;
- /**
- * Whether deferred instrumentation should be loaded or included
- * in builds.
- *
- */
- "deferredInstrumentation": boolean;
- /**
- * Defines dependencies to be used before the loader has been loaded.
- * When provided, they cause the loader to execute require(deps, callback)
- * once it has finished loading. Should be used with callback.
- *
- */
- "deps": Function;
- /**
- * Used by some modules to configure an empty iframe. Used by dojo/io/iframe and
- * dojo/back, and dijit/popup support in IE where an iframe is needed to make sure native
- * controls do not bleed through the popups. Normally this configuration variable
- * does not need to be set, except when using cross-domain/CDN Dojo builds.
- * Save dojo/resources/blank.html to your domain and set djConfig.dojoBlankHtmlUrl
- * to the path on your domain your copy of blank.html.
- *
- */
- "dojoBlankHtmlUrl": string;
- /**
- * No default value. Specifies additional locales whose
- * resources should also be loaded alongside the default locale when
- * calls to dojo.requireLocalization() are processed.
- *
- */
- "extraLocale": any[];
- /**
- * Set this to true to enable publishing of topics for the different phases of
- * IO operations. Publishing is done via dojo/topic.publish(). See dojo/main.__IoPublish for a list
- * of topics that are published.
- *
- */
- "ioPublish": Object;
- /**
- * Defaults to false. If set to true, ensures that Dojo provides
- * extended debugging feedback via Firebug. If Firebug is not available
- * on your platform, setting isDebug to true will force Dojo to
- * pull in (and display) the version of Firebug Lite which is
- * integrated into the Dojo distribution, thereby always providing a
- * debugging/logging console when isDebug is enabled. Note that
- * Firebug's console.* methods are ALWAYS defined by Dojo. If
- * isDebug is false and you are on a platform without Firebug, these
- * methods will be defined as no-ops.
- *
- */
- "isDebug": boolean;
- /**
- * The locale to assume for loading localized resources in this page,
- * specified according to RFC 3066.
- * Must be specified entirely in lowercase, e.g. en-us and zh-cn.
- * See the documentation for dojo.i18n and dojo.requireLocalization
- * for details on loading localized resources. If no locale is specified,
- * Dojo assumes the locale of the user agent, according to navigator.userLanguage
- * or navigator.language properties.
- *
- */
- "locale": string;
- /**
- * A map of module names to paths relative to dojo.baseUrl. The
- * key/value pairs correspond directly to the arguments which
- * dojo.registerModulePath accepts. Specifying
- * djConfig.modulePaths = { "foo": "../../bar" } is the equivalent
- * of calling dojo.registerModulePath("foo", "../../bar");. Multiple
- * modules may be configured via djConfig.modulePaths.
- *
- */
- "modulePaths": Object;
- /**
- * Run the parser after the page is loaded
- *
- */
- "parseOnLoad": boolean;
- /**
- * An array of module names to be loaded immediately after dojo.js has been included
- * in a page.
- *
- */
- "require": Object;
- /**
- * Array containing the r, g, b components used as transparent color in dojo.Color;
- * if undefined, [255,255,255] (white) will be used.
- *
- */
- "transparentColor": any[];
- /**
- * Used by dojox.analytics.Urchin as the default UA-123456-7 account
- * number used when being created. Alternately, you can pass an acct:""
- * parameter to the constructor a la: new dojox.analytics.Urchin({ acct:"UA-123456-7" });
- *
- */
- "urchin": string;
- /**
- * If set to a value that evaluates to true such as a string or array and
- * isDebug is true and Firebug is not available or running, then it bypasses
- * the creation of Firebug Lite allowing you to define your own console object.
- *
- */
- "useCustomLogger": Object;
- /**
- * Whether the deferred instrumentation should be used.
- *
- * "report-rejections": report each rejection as it occurs.
- * true or 1 or "report-unhandled-rejections": wait 1 second
- * in an attempt to detect unhandled rejections.
- *
- */
- "useDeferredInstrumentation": boolean;
- }
- namespace config {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/config.modulePaths.html
- *
- * A map of module names to paths relative to dojo.baseUrl. The
- * key/value pairs correspond directly to the arguments which
- * dojo.registerModulePath accepts. Specifying
- * djConfig.modulePaths = { "foo": "../../bar" } is the equivalent
- * of calling dojo.registerModulePath("foo", "../../bar");. Multiple
- * modules may be configured via djConfig.modulePaths.
- *
- */
- interface modulePaths {
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/Color.html
- *
- * Takes a named string, hex string, array of rgb or rgba values,
- * an object with r, g, b, and a properties, or another Color object
- * and creates a new Color instance to work from.
- *
- * @param color
- */
- class Color {
- constructor(color: any[]);
- /**
- *
- */
- "a": number;
- /**
- *
- */
- "b": number;
- /**
- *
- */
- "g": number;
- /**
- * Dictionary list of all CSS named colors, by name. Values are 3-item arrays with corresponding RG and B values.
- *
- */
- "named": Object;
- /**
- *
- */
- "r": number;
- /**
- * Blend colors end and start with weight from 0 to 1, 0.5 being a 50/50 blend,
- * can reuse a previously allocated Color object for the result
- *
- * @param start
- * @param end
- * @param weight
- * @param obj Optional
- */
- blendColors(start: dojo._base.Color, end: dojo._base.Color, weight: number, obj?: dojo._base.Color): any;
- /**
- * Builds a Color from a 3 or 4 element array, mapping each
- * element in sequence to the rgb(a) values of the color.
- *
- * @param a
- * @param obj Optional
- */
- fromArray(a: any[], obj?: dojo._base.Color): any;
- /**
- * Converts a hex string with a '#' prefix to a color object.
- * Supports 12-bit #rgb shorthand. Optionally accepts a
- * Color object to update with the parsed value.
- *
- * @param color
- * @param obj Optional
- */
- fromHex(color: String, obj?: dojo._base.Color): any;
- /**
- * get rgb(a) array from css-style color declarations
- * this function can handle all 4 CSS3 Color Module formats: rgb,
- * rgba, hsl, hsla, including rgb(a) with percentage values.
- *
- * @param color
- * @param obj Optional
- */
- fromRgb(color: String, obj?: dojo._base.Color): any;
- /**
- * Parses str for a color value. Accepts hex, rgb, and rgba
- * style color values.
- * Acceptable input values for str may include arrays of any form
- * accepted by dojo.colorFromArray, hex strings such as "#aaaaaa", or
- * rgb or rgba strings such as "rgb(133, 200, 16)" or "rgba(10, 10,
- * 10, 50)"
- *
- * @param str
- * @param obj Optional
- */
- fromString(str: String, obj?: dojo._base.Color): any;
- /**
- * creates a greyscale color with an optional alpha
- *
- * @param g
- * @param a Optional
- */
- makeGrey(g: number, a?: number): void;
- /**
- * makes sure that the object has correct attributes
- *
- */
- sanitize(): void;
- /**
- * Takes a named string, hex string, array of rgb or rgba values,
- * an object with r, g, b, and a properties, or another Color object
- * and sets this color instance to that value.
- *
- * @param color
- */
- setColor(color: any[]): Function;
- /**
- * Takes a named string, hex string, array of rgb or rgba values,
- * an object with r, g, b, and a properties, or another Color object
- * and sets this color instance to that value.
- *
- * @param color
- */
- setColor(color: String): Function;
- /**
- * Takes a named string, hex string, array of rgb or rgba values,
- * an object with r, g, b, and a properties, or another Color object
- * and sets this color instance to that value.
- *
- * @param color
- */
- setColor(color: Object): Function;
- /**
- * Convert this Color to a CMY definition.
- *
- */
- toCmy(): Object;
- /**
- * Convert this Color to a CMYK definition.
- *
- */
- toCmyk(): Object;
- /**
- * Returns a css color string in rgb(a) representation
- *
- * @param includeAlpha Optional
- */
- toCss(includeAlpha?: boolean): String;
- /**
- * Returns a CSS color string in hexadecimal representation
- *
- */
- toHex(): String;
- /**
- * Convert this Color to an HSL definition.
- *
- */
- toHsl(): Object;
- /**
- * Convert this Color to an HSV definition.
- *
- */
- toHsv(): Object;
- /**
- * Returns 3 component array of rgb values
- *
- */
- toRgb(): any[];
- /**
- * Returns a 4 component array of rgba values from the color
- * represented by this object.
- *
- */
- toRgba(): any[];
- /**
- * Returns a visual representation of the color
- *
- */
- toString(): any;
- }
- namespace Color {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/Color.named.html
- *
- * Dictionary list of all CSS named colors, by name. Values are 3-item arrays with corresponding RG and B values.
- *
- */
- interface named {
- /**
- *
- */
- aliceblue: any[];
- /**
- *
- */
- antiquewhite: any[];
- /**
- *
- */
- aqua: any[];
- /**
- *
- */
- aquamarine: any[];
- /**
- *
- */
- azure: any[];
- /**
- *
- */
- beige: any[];
- /**
- *
- */
- bisque: any[];
- /**
- *
- */
- black: any[];
- /**
- *
- */
- blanchedalmond: any[];
- /**
- *
- */
- blue: any[];
- /**
- *
- */
- blueviolet: any[];
- /**
- *
- */
- brown: any[];
- /**
- *
- */
- burlywood: any[];
- /**
- *
- */
- cadetblue: any[];
- /**
- *
- */
- chartreuse: any[];
- /**
- *
- */
- chocolate: any[];
- /**
- *
- */
- coral: any[];
- /**
- *
- */
- cornflowerblue: any[];
- /**
- *
- */
- cornsilk: any[];
- /**
- *
- */
- crimson: any[];
- /**
- *
- */
- cyan: any[];
- /**
- *
- */
- darkblue: any[];
- /**
- *
- */
- darkcyan: any[];
- /**
- *
- */
- darkgoldenrod: any[];
- /**
- *
- */
- darkgray: any[];
- /**
- *
- */
- darkgreen: any[];
- /**
- *
- */
- darkgrey: any[];
- /**
- *
- */
- darkkhaki: any[];
- /**
- *
- */
- darkmagenta: any[];
- /**
- *
- */
- darkolivegreen: any[];
- /**
- *
- */
- darkorange: any[];
- /**
- *
- */
- darkorchid: any[];
- /**
- *
- */
- darkred: any[];
- /**
- *
- */
- darksalmon: any[];
- /**
- *
- */
- darkseagreen: any[];
- /**
- *
- */
- darkslateblue: any[];
- /**
- *
- */
- darkslategray: any[];
- /**
- *
- */
- darkslategrey: any[];
- /**
- *
- */
- darkturquoise: any[];
- /**
- *
- */
- darkviolet: any[];
- /**
- *
- */
- deeppink: any[];
- /**
- *
- */
- deepskyblue: any[];
- /**
- *
- */
- dimgray: any[];
- /**
- *
- */
- dimgrey: any[];
- /**
- *
- */
- dodgerblue: any[];
- /**
- *
- */
- firebrick: any[];
- /**
- *
- */
- floralwhite: any[];
- /**
- *
- */
- forestgreen: any[];
- /**
- *
- */
- fuchsia: any[];
- /**
- *
- */
- gainsboro: any[];
- /**
- *
- */
- ghostwhite: any[];
- /**
- *
- */
- gold: any[];
- /**
- *
- */
- goldenrod: any[];
- /**
- *
- */
- gray: any[];
- /**
- *
- */
- green: any[];
- /**
- *
- */
- greenyellow: any[];
- /**
- *
- */
- grey: any[];
- /**
- *
- */
- honeydew: any[];
- /**
- *
- */
- hotpink: any[];
- /**
- *
- */
- indianred: any[];
- /**
- *
- */
- indigo: any[];
- /**
- *
- */
- ivory: any[];
- /**
- *
- */
- khaki: any[];
- /**
- *
- */
- lavender: any[];
- /**
- *
- */
- lavenderblush: any[];
- /**
- *
- */
- lawngreen: any[];
- /**
- *
- */
- lemonchiffon: any[];
- /**
- *
- */
- lightblue: any[];
- /**
- *
- */
- lightcoral: any[];
- /**
- *
- */
- lightcyan: any[];
- /**
- *
- */
- lightgoldenrodyellow: any[];
- /**
- *
- */
- lightgray: any[];
- /**
- *
- */
- lightgreen: any[];
- /**
- *
- */
- lightgrey: any[];
- /**
- *
- */
- lightpink: any[];
- /**
- *
- */
- lightsalmon: any[];
- /**
- *
- */
- lightseagreen: any[];
- /**
- *
- */
- lightskyblue: any[];
- /**
- *
- */
- lightslategray: any[];
- /**
- *
- */
- lightslategrey: any[];
- /**
- *
- */
- lightsteelblue: any[];
- /**
- *
- */
- lightyellow: any[];
- /**
- *
- */
- lime: any[];
- /**
- *
- */
- limegreen: any[];
- /**
- *
- */
- linen: any[];
- /**
- *
- */
- magenta: any[];
- /**
- *
- */
- maroon: any[];
- /**
- *
- */
- mediumaquamarine: any[];
- /**
- *
- */
- mediumblue: any[];
- /**
- *
- */
- mediumorchid: any[];
- /**
- *
- */
- mediumpurple: any[];
- /**
- *
- */
- mediumseagreen: any[];
- /**
- *
- */
- mediumslateblue: any[];
- /**
- *
- */
- mediumspringgreen: any[];
- /**
- *
- */
- mediumturquoise: any[];
- /**
- *
- */
- mediumvioletred: any[];
- /**
- *
- */
- midnightblue: any[];
- /**
- *
- */
- mintcream: any[];
- /**
- *
- */
- mistyrose: any[];
- /**
- *
- */
- moccasin: any[];
- /**
- *
- */
- navajowhite: any[];
- /**
- *
- */
- navy: any[];
- /**
- *
- */
- oldlace: any[];
- /**
- *
- */
- olive: any[];
- /**
- *
- */
- olivedrab: any[];
- /**
- *
- */
- orange: any[];
- /**
- *
- */
- orangered: any[];
- /**
- *
- */
- orchid: any[];
- /**
- *
- */
- palegoldenrod: any[];
- /**
- *
- */
- palegreen: any[];
- /**
- *
- */
- paleturquoise: any[];
- /**
- *
- */
- palevioletred: any[];
- /**
- *
- */
- papayawhip: any[];
- /**
- *
- */
- peachpuff: any[];
- /**
- *
- */
- peru: any[];
- /**
- *
- */
- pink: any[];
- /**
- *
- */
- plum: any[];
- /**
- *
- */
- powderblue: any[];
- /**
- *
- */
- purple: any[];
- /**
- *
- */
- red: any[];
- /**
- *
- */
- rosybrown: any[];
- /**
- *
- */
- royalblue: any[];
- /**
- *
- */
- saddlebrown: any[];
- /**
- *
- */
- salmon: any[];
- /**
- *
- */
- sandybrown: any[];
- /**
- *
- */
- seagreen: any[];
- /**
- *
- */
- seashell: any[];
- /**
- *
- */
- sienna: any[];
- /**
- *
- */
- silver: any[];
- /**
- *
- */
- skyblue: any[];
- /**
- *
- */
- slateblue: any[];
- /**
- *
- */
- slategray: any[];
- /**
- *
- */
- slategrey: any[];
- /**
- *
- */
- snow: any[];
- /**
- *
- */
- springgreen: any[];
- /**
- *
- */
- steelblue: any[];
- /**
- *
- */
- tan: any[];
- /**
- *
- */
- teal: any[];
- /**
- *
- */
- thistle: any[];
- /**
- *
- */
- tomato: any[];
- /**
- *
- */
- transparent: Object;
- /**
- *
- */
- turquoise: any[];
- /**
- *
- */
- violet: any[];
- /**
- *
- */
- wheat: any[];
- /**
- *
- */
- white: any[];
- /**
- *
- */
- whitesmoke: any[];
- /**
- *
- */
- yellow: any[];
- /**
- *
- */
- yellowgreen: any[];
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/browser.html
- *
- * This module causes the browser-only base modules to be loaded.
- *
- */
- interface browser {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/array.html
- *
- * The Javascript v1.6 array extensions.
- *
- */
- interface array {
- /**
- *
- */
- clearCache(): void;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: any[], callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: String, callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: any[], callback: String, thisObject?: Object): boolean;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: String, callback: String, thisObject?: Object): boolean;
- /**
- * Returns a new Array with those items from arr that match the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.filter() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's filter skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/filter
- *
- * @param arr the array to iterate over.
- * @param callback a function that is invoked with three arguments (item,index, array). The return of this function is expected tobe a boolean which determines whether the passed-in itemwill be included in the returned array.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- filter(arr: any[], callback: Function, thisObject?: Object): any[];
- /**
- * Returns a new Array with those items from arr that match the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.filter() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's filter skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/filter
- *
- * @param arr the array to iterate over.
- * @param callback a function that is invoked with three arguments (item,index, array). The return of this function is expected tobe a boolean which determines whether the passed-in itemwill be included in the returned array.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- filter(arr: any[], callback: String, thisObject?: Object): any[];
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: any[], callback: Function, thisObject?: Object): void;
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: String, callback: Function, thisObject?: Object): void;
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: any[], callback: String, thisObject?: Object): void;
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: String, callback: String, thisObject?: Object): void;
- /**
- * locates the first index of the provided value in the
- * passed array. If the value is not found, -1 is returned.
- * This method corresponds to the JavaScript 1.6 Array.indexOf method, with two differences:
- *
- * when run over sparse arrays, the Dojo function invokes the callback for every index
- * whereas JavaScript 1.6's indexOf skips the holes in the sparse array.
- * uses equality (==) rather than strict equality (===)
- * For details on this method, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/indexOf
- *
- * @param arr
- * @param value
- * @param fromIndex Optional
- * @param findLast OptionalMakes indexOf() work like lastIndexOf(). Used internally; not meant for external usage.
- */
- indexOf(arr: any[], value: Object, fromIndex?: number, findLast?: boolean): number;
- /**
- * locates the last index of the provided value in the passed
- * array. If the value is not found, -1 is returned.
- * This method corresponds to the JavaScript 1.6 Array.lastIndexOf method, with two differences:
- *
- * when run over sparse arrays, the Dojo function invokes the callback for every index
- * whereas JavaScript 1.6's lasIndexOf skips the holes in the sparse array.
- * uses equality (==) rather than strict equality (===)
- * For details on this method, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/lastIndexOf
- *
- * @param arr
- * @param value
- * @param fromIndex Optional
- */
- lastIndexOf(arr: any, value: any, fromIndex?: number): number;
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: any[], callback: Function, thisObject?: Object, Ctr?: any): any[];
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: String, callback: Function, thisObject?: Object, Ctr?: any): any[];
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: any[], callback: String, thisObject?: Object, Ctr?: any): any[];
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: String, callback: String, thisObject?: Object, Ctr?: any): any[];
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: any[], callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: String, callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: any[], callback: String, thisObject?: Object): boolean;
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: String, callback: String, thisObject?: Object): boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/connect.html
- *
- * This module defines the dojo.connect API.
- * This modules also provides keyboard event handling helpers.
- * This module exports an extension event for emulating Firefox's keypress handling.
- * However, this extension event exists primarily for backwards compatibility and
- * is not recommended. WebKit and IE uses an alternate keypress handling (only
- * firing for printable characters, to distinguish from keydown events), and most
- * consider the WebKit/IE behavior more desirable.
- *
- */
- interface connect {
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: Object, method: String, dontFix?: boolean): any;
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: any, method: String, dontFix?: boolean): any;
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: Object, method: Function, dontFix?: boolean): any;
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: any, method: Function, dontFix?: boolean): any;
- /**
- * Ensure that every time obj.event() is called, a message is published
- * on the topic. Returns a handle which can be passed to
- * dojo.disconnect() to disable subsequent automatic publication on
- * the topic.
- *
- * @param topic The name of the topic to publish.
- * @param obj OptionalThe source object for the event function. Defaults to kernel.globalif null.
- * @param event The name of the event function in obj.I.e. identifies a property obj[event].
- */
- connectPublisher(topic: String, obj: Object, event: String): any;
- /**
- * Remove a link created by dojo.connect.
- * Removes the connection between event and the method referenced by handle.
- *
- * @param handle the return value of the dojo.connect call that created the connection.
- */
- disconnect(handle: Object): void;
- /**
- * Checks an event for the copy key (meta on Mac, and ctrl anywhere else)
- *
- * @param e Event object to examine
- */
- isCopyKey(e: Event): any;
- /**
- * Invoke all listener method subscribed to topic.
- *
- * @param topic The name of the topic to publish.
- * @param args OptionalAn array of arguments. The arguments will be appliedto each topic subscriber (as first class parameters, via apply).
- */
- publish(topic: String, args?: any[]): any;
- /**
- * Attach a listener to a named topic. The listener function is invoked whenever the
- * named topic is published (see: dojo.publish).
- * Returns a handle which is needed to unsubscribe this listener.
- *
- * @param topic The topic to which to subscribe.
- * @param context OptionalScope in which method will be invoked, or null for default scope.
- * @param method The name of a function in context, or a function reference. This is the function thatis invoked when topic is published.
- */
- subscribe(topic: String, context?: Object, method?: String): any;
- /**
- * Attach a listener to a named topic. The listener function is invoked whenever the
- * named topic is published (see: dojo.publish).
- * Returns a handle which is needed to unsubscribe this listener.
- *
- * @param topic The topic to which to subscribe.
- * @param context OptionalScope in which method will be invoked, or null for default scope.
- * @param method The name of a function in context, or a function reference. This is the function thatis invoked when topic is published.
- */
- subscribe(topic: String, context?: Object, method?: Function): any;
- /**
- * Remove a topic listener.
- *
- * @param handle The handle returned from a call to subscribe.
- */
- unsubscribe(handle: Object): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/event.html
- *
- * This module defines dojo DOM event API. Usually you should use dojo/on, and evt.stopPropagation() +
- * evt.preventDefault(), rather than this module.
- *
- */
- interface event {
- /**
- * normalizes properties on the event object including event
- * bubbling methods, keystroke normalization, and x/y positions
- *
- * @param evt native event object
- * @param sender node to treat as "currentTarget"
- */
- fix(evt: Event, sender: HTMLElement): Event;
- /**
- * prevents propagation and clobbers the default action of the
- * passed event
- *
- * @param evt The event object. If omitted, window.event is used on IE.
- */
- stop(evt: Event): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/html.html
- *
- * This module is a stub for the core dojo DOM API.
- *
- */
- interface html {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/json.html
- *
- * This module defines the dojo JSON API.
- *
- */
- interface json {
- }
- namespace fx {
- /**
- * A generic animation class that fires callbacks into its handlers
- * object at various states.
- * A generic animation class that fires callbacks into its handlers
- * object at various states. Nearly all dojo animation functions
- * return an instance of this method, usually without calling the
- * .play() method beforehand. Therefore, you will likely need to
- * call .play() on instances of Animation when one is
- * returned.
- *
- * @param args The 'magic argument', mixing all the properties into thisanimation instance.
- */
- interface Animation { }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/fx.html
- *
- * This module defines the base dojo/_base/fx implementation.
- *
- */
- interface fx {
- /**
- * A simpler interface to animateProperty(), also returns
- * an instance of Animation but begins the animation
- * immediately, unlike nearly every other Dojo animation API.
- * Simpler (but somewhat less powerful) version
- * of animateProperty. It uses defaults for many basic properties
- * and allows for positional parameters to be used in place of the
- * packed "property bag" which is used for other Dojo animation
- * methods.
- *
- * The Animation object returned will be already playing, so
- * calling play() on it again is (usually) a no-op.
- *
- * @param node a DOM node or the id of a node to animate CSS properties on
- * @param properties
- * @param duration OptionalThe number of milliseconds over which the animationshould run. Defaults to the global animation default duration(350ms).
- * @param easing OptionalAn easing function over which to calculate accelerationand deceleration of the animation through its duration.A default easing algorithm is provided, but you mayplug in any you wish. A large selection of easing algorithmsare available in dojo/fx/easing.
- * @param onEnd OptionalA function to be called when the animation finishesrunning.
- * @param delay OptionalThe number of milliseconds to delay beginning theanimation by. The default is 0.
- */
- anim (node: HTMLElement, properties: Object, duration?: number, easing?: Function, onEnd?: Function, delay?: number): any ;
- /**
- * A simpler interface to animateProperty(), also returns
- * an instance of Animation but begins the animation
- * immediately, unlike nearly every other Dojo animation API.
- * Simpler (but somewhat less powerful) version
- * of animateProperty. It uses defaults for many basic properties
- * and allows for positional parameters to be used in place of the
- * packed "property bag" which is used for other Dojo animation
- * methods.
- *
- * The Animation object returned will be already playing, so
- * calling play() on it again is (usually) a no-op.
- *
- * @param node a DOM node or the id of a node to animate CSS properties on
- * @param properties
- * @param duration OptionalThe number of milliseconds over which the animationshould run. Defaults to the global animation default duration(350ms).
- * @param easing OptionalAn easing function over which to calculate accelerationand deceleration of the animation through its duration.A default easing algorithm is provided, but you mayplug in any you wish. A large selection of easing algorithmsare available in dojo/fx/easing.
- * @param onEnd OptionalA function to be called when the animation finishesrunning.
- * @param delay OptionalThe number of milliseconds to delay beginning theanimation by. The default is 0.
- */
- anim (node: String, properties: Object, duration?: number, easing?: Function, onEnd?: Function, delay?: number): any ;
- /**
- * Returns an animation that will transition the properties of
- * node defined in args depending how they are defined in
- * args.properties
- * Foundation of most dojo/_base/fx
- * animations. It takes an object of "properties" corresponding to
- * style properties, and animates them in parallel over a set
- * duration.
- *
- * @param args An object with the following properties:properties (Object, optional): A hash map of style properties to Objects describing the transition,such as the properties of _Line with an additional 'units' propertynode (DOMNode|String): The node referenced in the animationduration (Integer, optional): Duration of the animation in milliseconds.easing (Function, optional): An easing function.
- */
- animateProperty (args?: Object): any ;
- /**
- * Returns an animation that will fade node defined in 'args' from
- * its current opacity to fully opaque.
- *
- * @param args An object with the following properties:node (DOMNode|String): The node referenced in the animationduration (Integer, optional): Duration of the animation in milliseconds.easing (Function, optional): An easing function.
- */
- fadeIn (args: Object): any ;
- /**
- * Returns an animation that will fade node defined in 'args'
- * from its current opacity to fully transparent.
- *
- * @param args An object with the following properties:node (DOMNode|String): The node referenced in the animationduration (Integer, optional): Duration of the animation in milliseconds.easing (Function, optional): An easing function.
- */
- fadeOut (args: Object): any ;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/query.html
- *
- * Deprecated. Use dojo/query instead.
- *
- */
- interface query {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/NodeList.html
- *
- * This module extends dojo/NodeList with the legacy connect(), coords(),
- * blur(), focus(), change(), click(), error(), keydown(), keypress(),
- * keyup(), load(), mousedown(), mouseenter(), mouseleave(), mousemove(),
- * mouseout(), mouseover(), mouseup(), and submit() methods.
- *
- */
- interface NodeList {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/sniff.html
- *
- * Deprecated. New code should use dojo/sniff.
- * This module populates the dojo browser version sniffing properties like dojo.isIE.
- *
- */
- interface sniff {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/lang.html
- *
- * This module defines Javascript language extensions.
- *
- */
- interface lang {
- /**
- * Clones objects (including DOM nodes) and all children.
- * Warning: do not clone cyclic structures.
- *
- * @param src The object to clone
- */
- clone(src: any): any;
- /**
- * Returns a new object which "looks" to obj for properties which it
- * does not have a value for. Optionally takes a bag of properties to
- * seed the returned object with initially.
- * This is a small implementation of the Boodman/Crockford delegation
- * pattern in JavaScript. An intermediate object constructor mediates
- * the prototype chain for the returned object, using it to delegate
- * down to obj for property lookup when object-local lookup fails.
- * This can be thought of similarly to ES4's "wrap", save that it does
- * not act on types but rather on pure objects.
- *
- * @param obj The object to delegate to for properties not found directly on thereturn object or in props.
- * @param props an object containing properties to assign to the returned object
- */
- delegate(obj: Object, props: Object[]): any;
- /**
- * determine if an object supports a given method
- * useful for longer api chains where you have to test each object in
- * the chain. Useful for object and method detection.
- *
- * @param name Path to an object, in the form "A.B.C".
- * @param obj OptionalObject to use as root of path. Defaults to'dojo.global'. Null may be passed.
- */
- exists(name: String, obj?: Object): boolean;
- /**
- * Adds all properties and methods of props to constructor's
- * prototype, making them available to all instances created with
- * constructor.
- *
- * @param ctor Target constructor to extend.
- * @param props One or more objects to mix into ctor.prototype
- */
- extend(ctor: Object, props: Object): Object;
- /**
- * Get a property from a dot-separated string, such as "A.B.C"
- * Useful for longer api chains where you have to test each object in
- * the chain, or when you have an object reference in string format.
- *
- * @param name Path to an property, in the form "A.B.C".
- * @param create OptionalOptional. Defaults to false. If true, Objects will becreated at any point along the 'path' that is undefined.
- * @param context OptionalOptional. Object to use as root of path. Defaults to'dojo.global'. Null may be passed.
- */
- getObject(name: String, create?: boolean, context?: Object): any;
- /**
- * Returns a function that will only ever execute in the a given scope.
- * This allows for easy use of object member functions
- * in callbacks and other places in which the "this" keyword may
- * otherwise not reference the expected scope.
- * Any number of default positional arguments may be passed as parameters
- * beyond "method".
- * Each of these values will be used to "placehold" (similar to curry)
- * for the hitched function.
- *
- * @param scope The scope to use when method executes. If method is a string,scope is also the object containing method.
- * @param method A function to be hitched to scope, or the name of the method inscope to be hitched.
- */
- hitch(scope: Object, method: (...args: any[]) => any, ...args: any[]): any;
- /**
- * Returns a function that will only ever execute in the a given scope.
- * This allows for easy use of object member functions
- * in callbacks and other places in which the "this" keyword may
- * otherwise not reference the expected scope.
- * Any number of default positional arguments may be passed as parameters
- * beyond "method".
- * Each of these values will be used to "placehold" (similar to curry)
- * for the hitched function.
- *
- * @param scope The scope to use when method executes. If method is a string,scope is also the object containing method.
- * @param method A function to be hitched to scope, or the name of the method inscope to be hitched.
- */
- hitch(scope: Object, method: string, ...args: any[]): any;
- /**
- * Returns true if it is a built-in function or some other kind of
- * oddball that should report as a function but doesn't
- *
- * @param it
- */
- isAlien(it: any): any;
- /**
- * Return true if it is an Array.
- * Does not work on Arrays created in other windows.
- *
- * @param it Item to test.
- */
- isArray(it: any): any;
- /**
- * similar to isArray() but more permissive
- * Doesn't strongly test for "arrayness". Instead, settles for "isn't
- * a string or number and has a length property". Arguments objects
- * and DOM collections will return true when passed to
- * isArrayLike(), but will return false when passed to
- * isArray().
- *
- * @param it Item to test.
- */
- isArrayLike(it: any): any;
- /**
- * Return true if it is a Function
- *
- * @param it Item to test.
- */
- isFunction(it: any): boolean;
- /**
- * Returns true if it is a JavaScript object (or an Array, a Function
- * or null)
- *
- * @param it Item to test.
- */
- isObject(it: any): boolean;
- /**
- * Return true if it is a String
- *
- * @param it Item to test.
- */
- isString(it: any): boolean;
- /**
- * Copies/adds all properties of one or more sources to dest; returns dest.
- * All properties, including functions (sometimes termed "methods"), excluding any non-standard extensions
- * found in Object.prototype, are copied/added from sources to dest. sources are processed left to right.
- * The Javascript assignment operator is used to copy/add each property; therefore, by default, mixin
- * executes a so-called "shallow copy" and aggregate types are copied/added by reference.
- *
- * @param dest The object to which to copy/add all properties contained in source. If dest is falsy, thena new object is manufactured before copying/adding properties begins.
- * @param sources One of more objects from which to draw all properties to copy into dest. sources are processedleft-to-right and if more than one of these objects contain the same property name, the right-mostvalue "wins".
- */
- mixin<T>(dest: T): T;
- mixin<T, U>(
- dest: T,
- source: U
- ): T & U;
- mixin<T, U, V>(
- dest: T,
- source1: U,
- source2: V
- ): T & U & V;
- mixin<T, U, V, W>(
- dest: T,
- source1: U,
- source2: V,
- source3: W
- ): T & U & V & W;
- mixin<T>(dest: Object, ...sources: Object[]): T;
- /**
- * similar to hitch() except that the scope object is left to be
- * whatever the execution context eventually becomes.
- * Calling lang.partial is the functional equivalent of calling:
- *
- * lang.hitch(null, funcName, ...);
- *
- * @param method The function to "wrap"
- */
- partial(method: Function): any;
- /**
- * similar to hitch() except that the scope object is left to be
- * whatever the execution context eventually becomes.
- * Calling lang.partial is the functional equivalent of calling:
- *
- * lang.hitch(null, funcName, ...);
- *
- * @param method The function to "wrap"
- */
- partial(method: String): any;
- /**
- * Performs parameterized substitutions on a string. Throws an
- * exception if any parameter is unmatched.
- *
- * @param tmpl String to be used as a template.
- * @param map If an object, it is used as a dictionary to look up substitutions.If a function, it is called for every substitution with following parameters:a whole match, a name, an offset, and the whole templatestring (see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String/replacefor more details).
- * @param pattern OptionalOptional regular expression objects that overrides the default pattern.Must be global and match one item. The default is: /{([^}]+)}/g,which matches patterns like that: "{xxx}", where "xxx" is any sequenceof characters, which doesn't include "}".
- */
- replace(tmpl: String, map: Object, pattern?: RegExp): String;
- /**
- * Performs parameterized substitutions on a string. Throws an
- * exception if any parameter is unmatched.
- *
- * @param tmpl String to be used as a template.
- * @param map If an object, it is used as a dictionary to look up substitutions.If a function, it is called for every substitution with following parameters:a whole match, a name, an offset, and the whole templatestring (see https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String/replacefor more details).
- * @param pattern OptionalOptional regular expression objects that overrides the default pattern.Must be global and match one item. The default is: /{([^}]+)}/g,which matches patterns like that: "{xxx}", where "xxx" is any sequenceof characters, which doesn't include "}".
- */
- replace(tmpl: String, map: Function, pattern?: RegExp): String;
- /**
- * Set a property from a dot-separated string, such as "A.B.C"
- * Useful for longer api chains where you have to test each object in
- * the chain, or when you have an object reference in string format.
- * Objects are created as needed along path. Returns the passed
- * value if setting is successful or undefined if not.
- *
- * @param name Path to a property, in the form "A.B.C".
- * @param value value or object to place at location given by name
- * @param context OptionalOptional. Object to use as root of path. Defaults todojo.global.
- */
- setObject(name: String, value: any, context?: Object): any;
- /**
- * Trims whitespace from both sides of the string
- * This version of trim() was selected for inclusion into the base due
- * to its compact size and relatively good performance
- * (see Steven Levithan's blog
- * Uses String.prototype.trim instead, if available.
- * The fastest but longest version of this function is located at
- * lang.string.trim()
- *
- * @param str String to be trimmed
- */
- trim(str: String): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/unload.html
- *
- * This module contains the document and window unload detection API.
- *
- */
- interface unload {
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Object, functionName?: String): void;
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Function, functionName?: String): void;
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Object, functionName?: Function): void;
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Function, functionName?: Function): void;
- /**
- * registers a function to be triggered when window.onunload
- * fires.
- * The first time that addOnWindowUnload is called Dojo
- * will register a page listener to trigger your unload
- * handler with. Note that registering these handlers may
- * destroy "fastback" page caching in browsers that support
- * it. Be careful trying to modify the DOM or access
- * JavaScript properties during this phase of page unloading:
- * they may not always be available. Consider
- * addOnUnload() if you need to modify the DOM or do
- * heavy JavaScript work since it fires at the equivalent of
- * the page's "onbeforeunload" event.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnWindowUnload(obj?: Object, functionName?: String): void;
- /**
- * registers a function to be triggered when window.onunload
- * fires.
- * The first time that addOnWindowUnload is called Dojo
- * will register a page listener to trigger your unload
- * handler with. Note that registering these handlers may
- * destroy "fastback" page caching in browsers that support
- * it. Be careful trying to modify the DOM or access
- * JavaScript properties during this phase of page unloading:
- * they may not always be available. Consider
- * addOnUnload() if you need to modify the DOM or do
- * heavy JavaScript work since it fires at the equivalent of
- * the page's "onbeforeunload" event.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnWindowUnload(obj?: Function, functionName?: String): void;
- /**
- * registers a function to be triggered when window.onunload
- * fires.
- * The first time that addOnWindowUnload is called Dojo
- * will register a page listener to trigger your unload
- * handler with. Note that registering these handlers may
- * destroy "fastback" page caching in browsers that support
- * it. Be careful trying to modify the DOM or access
- * JavaScript properties during this phase of page unloading:
- * they may not always be available. Consider
- * addOnUnload() if you need to modify the DOM or do
- * heavy JavaScript work since it fires at the equivalent of
- * the page's "onbeforeunload" event.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnWindowUnload(obj?: Object, functionName?: Function): void;
- /**
- * registers a function to be triggered when window.onunload
- * fires.
- * The first time that addOnWindowUnload is called Dojo
- * will register a page listener to trigger your unload
- * handler with. Note that registering these handlers may
- * destroy "fastback" page caching in browsers that support
- * it. Be careful trying to modify the DOM or access
- * JavaScript properties during this phase of page unloading:
- * they may not always be available. Consider
- * addOnUnload() if you need to modify the DOM or do
- * heavy JavaScript work since it fires at the equivalent of
- * the page's "onbeforeunload" event.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnWindowUnload(obj?: Function, functionName?: Function): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/window.html
- *
- * API to save/set/restore the global/document scope.
- *
- */
- interface window {
- /**
- * Alias for the current document. 'doc' can be modified
- * for temporary context shifting. See also withDoc().
- *
- */
- doc: Object;
- /**
- * Alias for the current window. 'global' can be modified
- * for temporary context shifting. See also withGlobal().
- *
- */
- global: Object;
- /**
- * Return the body element of the specified document or of dojo/_base/window::doc.
- *
- * @param doc Optional
- */
- body(doc?: HTMLDocument): any;
- /**
- * changes the behavior of many core Dojo functions that deal with
- * namespace and DOM lookup, changing them to work in a new global
- * context (e.g., an iframe). The varibles dojo.global and dojo.doc
- * are modified as a result of calling this function and the result of
- * dojo.body() likewise differs.
- *
- * @param globalObject
- * @param globalDocument
- */
- setContext(globalObject: Object, globalDocument: HTMLDocument): void;
- /**
- * Invoke callback with documentObject as dojo/_base/window::doc.
- * Invoke callback with documentObject as dojo/_base/window::doc. If provided,
- * callback will be executed in the context of object thisObject
- * When callback() returns or throws an error, the dojo/_base/window::doc will
- * be restored to its previous state.
- *
- * @param documentObject
- * @param callback
- * @param thisObject Optional
- * @param cbArguments Optional
- */
- withDoc(documentObject: HTMLDocument, callback: Function, thisObject?: Object, cbArguments?: any[]): any;
- /**
- * Invoke callback with globalObject as dojo.global and
- * globalObject.document as dojo.doc.
- * Invoke callback with globalObject as dojo.global and
- * globalObject.document as dojo.doc. If provided, globalObject
- * will be executed in the context of object thisObject
- * When callback() returns or throws an error, the dojo.global
- * and dojo.doc will be restored to its previous state.
- *
- * @param globalObject
- * @param callback
- * @param thisObject Optional
- * @param cbArguments Optional
- */
- withGlobal(globalObject: Object, callback: Function, thisObject?: Object, cbArguments?: any[]): any;
- }
- namespace window {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/window.doc.html
- *
- * Alias for the current document. 'doc' can be modified
- * for temporary context shifting. See also withDoc().
- * Use this rather than referring to 'window.document' to ensure your code runs
- * correctly in managed contexts.
- *
- */
- interface doc {
- /**
- *
- */
- documentElement: Object;
- /**
- *
- */
- dojoClick: boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/window.global.html
- *
- * Alias for the current window. 'global' can be modified
- * for temporary context shifting. See also withGlobal().
- * Use this rather than referring to 'window' to ensure your code runs
- * correctly in managed contexts.
- *
- */
- interface global {
- /**
- *
- */
- $(): any;
- /**
- *
- * @param start
- * @param data
- * @param responseCode
- * @param errorMsg
- */
- GoogleSearchStoreCallback_undefined_NaN(start: any, data: any, responseCode: any, errorMsg: any): void;
- /**
- *
- */
- jQuery(): any;
- /**
- *
- */
- swfIsInHTML(): void;
- /**
- *
- */
- undefined_onload(): void;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.html
- *
- * This module is the foundational module of the dojo boot sequence; it defines the dojo object.
- *
- */
- interface kernel {
- /**
- * Browser history management resources
- *
- */
- back: Object;
- /**
- *
- */
- baseUrl: string;
- /**
- *
- */
- behavior: Object;
- /**
- *
- */
- cldr: Object;
- /**
- *
- */
- colors: Object;
- /**
- * This module defines the user configuration during bootstrap.
- *
- */
- config: Object;
- /**
- *
- */
- connectPublisher: Object;
- /**
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls.
- *
- */
- contentHandlers: Object;
- /**
- * localized formatting and parsing routines for currencies
- *
- */
- currency: Object;
- /**
- *
- */
- data: Object;
- /**
- *
- */
- date: Object;
- /**
- *
- */
- dijit: Object;
- /**
- *
- */
- dnd: Object;
- /**
- * Alias for the current document. 'doc' can be modified
- * for temporary context shifting. See also withDoc().
- *
- */
- doc: Object;
- /**
- *
- */
- dojox: Object;
- /**
- * Effects library on top of Base animations
- *
- */
- fx: Object;
- /**
- * TODOC
- *
- */
- gears: Object;
- /**
- * Alias for the current window. 'global' can be modified
- * for temporary context shifting. See also withGlobal().
- *
- */
- global: Object;
- /**
- * TODOC
- *
- */
- html: Object;
- /**
- * This module implements the dojo/i18n! plugin and the v1.6- i18n API
- *
- */
- i18n: Object;
- /**
- *
- */
- io: Object;
- /**
- * True if client is Adobe Air
- *
- */
- isAir: boolean;
- /**
- * Version as a Number if client is android browser. undefined otherwise.
- *
- */
- isAndroid: number;
- /**
- *
- */
- isAsync: boolean;
- /**
- *
- */
- isBrowser: boolean;
- /**
- * Version as a Number if client is Chrome browser. undefined otherwise.
- *
- */
- isChrome: number;
- /**
- *
- */
- isCopyKey: Object;
- /**
- *
- */
- isFF: Object;
- /**
- * Version as a Number if client is MSIE(PC). undefined otherwise. Corresponds to
- * major detected IE version (6, 7, 8, etc.)
- *
- */
- isIE: number;
- /**
- * Version as a Number if client is iPhone, iPod, or iPad. undefined otherwise.
- *
- */
- isIos: number;
- /**
- * Version as a Number if client is a KHTML browser. undefined otherwise. Corresponds to major
- * detected version.
- *
- */
- isKhtml: number;
- /**
- * True if the client runs on Mac
- *
- */
- isMac: boolean;
- /**
- *
- */
- isMoz: Object;
- /**
- *
- */
- isMozilla: Object;
- /**
- * Version as a Number if client is Opera. undefined otherwise. Corresponds to
- * major detected version.
- *
- */
- isOpera: number;
- /**
- *
- */
- isQuirks: boolean;
- /**
- * Version as a Number if client is Safari or iPhone. undefined otherwise.
- *
- */
- isSafari: number;
- /**
- *
- */
- isSpidermonkey: boolean;
- /**
- * Version as a Number if client is a WebKit-derived browser (Konqueror,
- * Safari, Chrome, etc.). undefined otherwise.
- *
- */
- isWebKit: number;
- /**
- * True if client is Wii
- *
- */
- isWii: boolean;
- /**
- * Definitions for common key values. Client code should test keyCode against these named constants,
- * as the actual codes can vary by browser.
- *
- */
- keys: Object;
- /**
- *
- */
- locale: Object;
- /**
- *
- */
- mouseButtons: Object;
- /**
- * localized formatting and parsing routines for Number
- *
- */
- number: Object;
- /**
- *
- */
- parser: string;
- /**
- *
- */
- publish: Object;
- /**
- *
- */
- query: Object;
- /**
- * Regular expressions and Builder resources
- *
- */
- regexp: Object;
- /**
- *
- */
- rpc: Object;
- /**
- *
- */
- scopeMap: Object;
- /**
- *
- */
- store: Object;
- /**
- * String utilities for Dojo
- *
- */
- string: Object;
- /**
- *
- */
- subscribe: Object;
- /**
- * D.O.H. Test files for Dojo unit testing.
- *
- */
- tests: Object;
- /**
- *
- */
- toJsonIndentStr: string;
- /**
- * This module provides unified touch event handlers by exporting
- * press, move, release and cancel which can also run well on desktop.
- * Based on http://dvcs.w3.org/hg/webevents/raw-file/tip/touchevents.html
- * Also, if the dojoClick property is set to truthy on a DOM node, dojo/touch generates
- * click events immediately for this node and its descendants (except for descendants that
- * have a dojoClick property set to falsy), to avoid the delay before native browser click events,
- * and regardless of whether evt.preventDefault() was called in a touch.press event listener.
- *
- */
- touch: Object;
- /**
- * Version number of the Dojo Toolkit
- *
- */
- version: Object;
- /**
- * TODOC
- *
- */
- window: Object;
- /**
- * A registry to make contextual calling/searching easier.
- * Objects of this class keep list of arrays in the form [name, check,
- * wrap, directReturn] that are used to determine what the contextual
- * result of a set of checked arguments is. All check/wrap functions
- * in this registry should be of the same arity.
- *
- * @param returnWrappers Optional
- */
- AdapterRegistry(returnWrappers?: boolean): void;
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- addClass(node: String, classStr: String): void;
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- addClass(node: HTMLElement, classStr: String): void;
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- addClass(node: String, classStr: any[]): void;
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- addClass(node: HTMLElement, classStr: any[]): void;
- /**
- * Add a function to execute on DOM content loaded and all requested modules have arrived and been evaluated.
- * In most cases, the domReady plug-in should suffice and this method should not be needed.
- *
- * When called in a non-browser environment, just checks that all requested modules have arrived and been
- * evaluated.
- *
- * @param priority OptionalThe order in which to exec this callback relative to other callbacks, defaults to 1000
- * @param context The context in which to run execute callback, or a callback if not using context
- * @param callback OptionalThe function to execute.
- */
- addOnLoad(priority: number, context: any, callback?: Function): void;
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Object, functionName?: String): void;
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Function, functionName?: String): void;
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Object, functionName?: Function): void;
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Function, functionName?: Function): void;
- /**
- * registers a function to be triggered when window.onunload fires.
- * Be careful trying to modify the DOM or access JavaScript properties
- * during this phase of page unloading: they may not always be available.
- * Consider dojo.addOnUnload() if you need to modify the DOM or do heavy
- * JavaScript work.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnWindowUnload(obj?: Object, functionName?: String): void;
- /**
- * registers a function to be triggered when window.onunload fires.
- * Be careful trying to modify the DOM or access JavaScript properties
- * during this phase of page unloading: they may not always be available.
- * Consider dojo.addOnUnload() if you need to modify the DOM or do heavy
- * JavaScript work.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnWindowUnload(obj: Object, functionName: Function): void;
- /**
- * A simpler interface to animateProperty(), also returns
- * an instance of Animation but begins the animation
- * immediately, unlike nearly every other Dojo animation API.
- * Simpler (but somewhat less powerful) version
- * of animateProperty. It uses defaults for many basic properties
- * and allows for positional parameters to be used in place of the
- * packed "property bag" which is used for other Dojo animation
- * methods.
- *
- * The Animation object returned will be already playing, so
- * calling play() on it again is (usually) a no-op.
- *
- * @param node a DOM node or the id of a node to animate CSS properties on
- * @param properties
- * @param duration OptionalThe number of milliseconds over which the animationshould run. Defaults to the global animation default duration(350ms).
- * @param easing OptionalAn easing function over which to calculate accelerationand deceleration of the animation through its duration.A default easing algorithm is provided, but you mayplug in any you wish. A large selection of easing algorithmsare available in dojo/fx/easing.
- * @param onEnd OptionalA function to be called when the animation finishesrunning.
- * @param delay OptionalThe number of milliseconds to delay beginning theanimation by. The default is 0.
- */
- anim(node: HTMLElement, properties: Object, duration?: number, easing?: Function, onEnd?: Function, delay?: number): any;
- /**
- * A simpler interface to animateProperty(), also returns
- * an instance of Animation but begins the animation
- * immediately, unlike nearly every other Dojo animation API.
- * Simpler (but somewhat less powerful) version
- * of animateProperty. It uses defaults for many basic properties
- * and allows for positional parameters to be used in place of the
- * packed "property bag" which is used for other Dojo animation
- * methods.
- *
- * The Animation object returned will be already playing, so
- * calling play() on it again is (usually) a no-op.
- *
- * @param node a DOM node or the id of a node to animate CSS properties on
- * @param properties
- * @param duration OptionalThe number of milliseconds over which the animationshould run. Defaults to the global animation default duration(350ms).
- * @param easing OptionalAn easing function over which to calculate accelerationand deceleration of the animation through its duration.A default easing algorithm is provided, but you mayplug in any you wish. A large selection of easing algorithmsare available in dojo/fx/easing.
- * @param onEnd OptionalA function to be called when the animation finishesrunning.
- * @param delay OptionalThe number of milliseconds to delay beginning theanimation by. The default is 0.
- */
- anim(node: String, properties: Object, duration?: number, easing?: Function, onEnd?: Function, delay?: number): any;
- /**
- * Returns an animation that will transition the properties of
- * node defined in args depending how they are defined in
- * args.properties
- * Foundation of most dojo/_base/fx
- * animations. It takes an object of "properties" corresponding to
- * style properties, and animates them in parallel over a set
- * duration.
- *
- * @param args An object with the following properties:properties (Object, optional): A hash map of style properties to Objects describing the transition,such as the properties of _Line with an additional 'units' propertynode (DOMNode|String): The node referenced in the animationduration (Integer, optional): Duration of the animation in milliseconds.easing (Function, optional): An easing function.
- */
- animateProperty(args: Object): any;
- /**
- * A generic animation class that fires callbacks into its handlers
- * object at various states.
- * A generic animation class that fires callbacks into its handlers
- * object at various states. Nearly all dojo animation functions
- * return an instance of this method, usually without calling the
- * .play() method beforehand. Therefore, you will likely need to
- * call .play() on instances of Animation when one is
- * returned.
- *
- * @param args The 'magic argument', mixing all the properties into thisanimation instance.
- */
- Animation(args: Object): void;
- /**
- * Gets or sets an attribute on an HTML element.
- * Handles normalized getting and setting of attributes on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the attribute on
- * @param name the name of the attribute to get or set.
- * @param value OptionalThe value to set for the attribute
- */
- attr(node: HTMLElement, name: String, value?: String): any;
- /**
- * Gets or sets an attribute on an HTML element.
- * Handles normalized getting and setting of attributes on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the attribute on
- * @param name the name of the attribute to get or set.
- * @param value OptionalThe value to set for the attribute
- */
- attr(node: String, name: String, value?: String): any;
- /**
- * Gets or sets an attribute on an HTML element.
- * Handles normalized getting and setting of attributes on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the attribute on
- * @param name the name of the attribute to get or set.
- * @param value OptionalThe value to set for the attribute
- */
- attr(node: HTMLElement, name: Object, value?: String): any;
- /**
- * Gets or sets an attribute on an HTML element.
- * Handles normalized getting and setting of attributes on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the attribute on
- * @param name the name of the attribute to get or set.
- * @param value OptionalThe value to set for the attribute
- */
- attr(node: String, name: Object, value?: String): any;
- /**
- * Blend colors end and start with weight from 0 to 1, 0.5 being a 50/50 blend,
- * can reuse a previously allocated Color object for the result
- *
- * @param start
- * @param end
- * @param weight
- * @param obj Optional
- */
- blendColors(start: dojo._base.Color, end: dojo._base.Color, weight: number, obj?: dojo._base.Color): any;
- /**
- * Return the body element of the specified document or of dojo/_base/window::doc.
- *
- * @param doc Optional
- */
- body(doc?: HTMLDocument): any;
- /**
- * Returns DOM node with matching id attribute or falsy value (ex: null or undefined)
- * if not found. If id is a DomNode, this function is a no-op.
- *
- * @param id A string to match an HTML id attribute or a reference to a DOM Node
- * @param doc OptionalDocument to work in. Defaults to the current value ofdojo/_base/window.doc. Can be used to retrievenode references from other documents.
- */
- byId(id: String, doc?: HTMLDocument): any;
- /**
- * Returns DOM node with matching id attribute or falsy value (ex: null or undefined)
- * if not found. If id is a DomNode, this function is a no-op.
- *
- * @param id A string to match an HTML id attribute or a reference to a DOM Node
- * @param doc OptionalDocument to work in. Defaults to the current value ofdojo/_base/window.doc. Can be used to retrievenode references from other documents.
- */
- byId(id: HTMLElement, doc?: HTMLDocument): any;
- /**
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- cache(module: String, url: String, value?: String): any;
- /**
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- cache(module: Object, url: String, value?: String): any;
- /**
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- cache(module: String, url: String, value?: Object): any;
- /**
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- cache(module: Object, url: String, value?: Object): any;
- /**
- *
- */
- clearCache(): void;
- /**
- * Takes a named string, hex string, array of rgb or rgba values,
- * an object with r, g, b, and a properties, or another Color object
- * and creates a new Color instance to work from.
- *
- * @param color
- */
- Color(color: any[]): void;
- /**
- * Takes a named string, hex string, array of rgb or rgba values,
- * an object with r, g, b, and a properties, or another Color object
- * and creates a new Color instance to work from.
- *
- * @param color
- */
- Color(color: String): void;
- /**
- * Takes a named string, hex string, array of rgb or rgba values,
- * an object with r, g, b, and a properties, or another Color object
- * and creates a new Color instance to work from.
- *
- * @param color
- */
- Color(color: Object): void;
- /**
- * Builds a Color from a 3 or 4 element array, mapping each
- * element in sequence to the rgb(a) values of the color.
- *
- * @param a
- * @param obj Optional
- */
- colorFromArray(a: any[], obj?: dojo._base.Color): any;
- /**
- * Converts a hex string with a '#' prefix to a color object.
- * Supports 12-bit #rgb shorthand. Optionally accepts a
- * Color object to update with the parsed value.
- *
- * @param color
- * @param obj Optional
- */
- colorFromHex(color: String, obj?: dojo._base.Color): any;
- /**
- * get rgb(a) array from css-style color declarations
- * this function can handle all 4 CSS3 Color Module formats: rgb,
- * rgba, hsl, hsla, including rgb(a) with percentage values.
- *
- * @param color
- * @param obj Optional
- */
- colorFromRgb(color: String, obj?: dojo._base.Color): any;
- /**
- * Parses str for a color value. Accepts hex, rgb, and rgba
- * style color values.
- * Acceptable input values for str may include arrays of any form
- * accepted by dojo.colorFromArray, hex strings such as "#aaaaaa", or
- * rgb or rgba strings such as "rgb(133, 200, 16)" or "rgba(10, 10,
- * 10, 50)"
- *
- * @param str
- * @param obj Optional
- */
- colorFromString(str: String, obj?: dojo._base.Color): any;
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: Object, method: String, dontFix?: boolean): any;
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: any, method: String, dontFix?: boolean): any;
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: Object, method: Function, dontFix?: boolean): any;
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: any, method: Function, dontFix?: boolean): any;
- /**
- * Getter/setter for the content-box of node.
- * Returns an object in the expected format of box (regardless if box is passed).
- * The object might look like:
- * { l: 50, t: 200, w: 300: h: 150 }
- * for a node offset from its parent 50px to the left, 200px from
- * the top with a content width of 300px and a content-height of
- * 150px. Note that the content box may have a much larger border
- * or margin box, depending on the box model currently in use and
- * CSS values set/inherited for node.
- * While the getter will return top and left values, the
- * setter only accepts setting the width and height.
- *
- * @param node id or reference to DOM Node to get/set box for
- * @param box OptionalIf passed, denotes that dojo.contentBox() shouldupdate/set the content box for node. Box is an object in theabove format, but only w (width) and h (height) are supported.All properties are optional if passed.
- */
- contentBox(node: HTMLElement, box?: Object): any;
- /**
- * Getter/setter for the content-box of node.
- * Returns an object in the expected format of box (regardless if box is passed).
- * The object might look like:
- * { l: 50, t: 200, w: 300: h: 150 }
- * for a node offset from its parent 50px to the left, 200px from
- * the top with a content width of 300px and a content-height of
- * 150px. Note that the content box may have a much larger border
- * or margin box, depending on the box model currently in use and
- * CSS values set/inherited for node.
- * While the getter will return top and left values, the
- * setter only accepts setting the width and height.
- *
- * @param node id or reference to DOM Node to get/set box for
- * @param box OptionalIf passed, denotes that dojo.contentBox() shouldupdate/set the content box for node. Box is an object in theabove format, but only w (width) and h (height) are supported.All properties are optional if passed.
- */
- contentBox(node: String, box?: Object): any;
- /**
- * Get or set a cookie.
- * If one argument is passed, returns the value of the cookie
- * For two or more arguments, acts as a setter.
- *
- * @param name Name of the cookie
- * @param value OptionalValue for the cookie
- * @param props OptionalProperties for the cookie
- */
- cookie(name: String, value?: String, props?: Object): any;
- /**
- * Deprecated: Use position() for border-box x/y/w/h
- * or marginBox() for margin-box w/h/l/t.
- *
- * Returns an object that measures margin-box (w)idth/(h)eight
- * and absolute position x/y of the border-box. Also returned
- * is computed (l)eft and (t)op values in pixels from the
- * node's offsetParent as returned from marginBox().
- * Return value will be in the form:
- *
- * { l: 50, t: 200, w: 300: h: 150, x: 100, y: 300 }
- * Does not act as a setter. If includeScroll is passed, the x and
- *
- * y params are affected as one would expect in dojo.position().
- *
- * @param node
- * @param includeScroll Optional
- */
- coords(node: HTMLElement, includeScroll?: boolean): any;
- /**
- * Deprecated: Use position() for border-box x/y/w/h
- * or marginBox() for margin-box w/h/l/t.
- *
- * Returns an object that measures margin-box (w)idth/(h)eight
- * and absolute position x/y of the border-box. Also returned
- * is computed (l)eft and (t)op values in pixels from the
- * node's offsetParent as returned from marginBox().
- * Return value will be in the form:
- *
- * { l: 50, t: 200, w: 300: h: 150, x: 100, y: 300 }
- * Does not act as a setter. If includeScroll is passed, the x and
- *
- * y params are affected as one would expect in dojo.position().
- *
- * @param node
- * @param includeScroll Optional
- */
- coords(node: String, includeScroll?: boolean): any;
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: HTMLElement, attrs: Object, refNode?: HTMLElement, pos?: String): any;
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: String, attrs: Object, refNode?: HTMLElement, pos?: String): any;
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: HTMLElement, attrs: Object, refNode?: String, pos?: String): any;
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: String, attrs: Object, refNode?: String, pos?: String): any;
- /**
- * Create a feature-rich constructor from compact notation.
- * Create a constructor using a compact notation for inheritance and
- * prototype extension.
- *
- * Mixin ancestors provide a type of multiple inheritance.
- * Prototypes of mixin ancestors are copied to the new class:
- * changes to mixin prototypes will not affect classes to which
- * they have been mixed in.
- *
- * Ancestors can be compound classes created by this version of
- * declare(). In complex cases all base classes are going to be
- * linearized according to C3 MRO algorithm
- * (see http://www.python.org/download/releases/2.3/mro/ for more
- * details).
- *
- * "className" is cached in "declaredClass" property of the new class,
- * if it was supplied. The immediate super class will be cached in
- * "superclass" property of the new class.
- *
- * Methods in "props" will be copied and modified: "nom" property
- * (the declared name of the method) will be added to all copied
- * functions to help identify them for the internal machinery. Be
- * very careful, while reusing methods: if you use the same
- * function under different names, it can produce errors in some
- * cases.
- *
- * It is possible to use constructors created "manually" (without
- * declare()) as bases. They will be called as usual during the
- * creation of an instance, their methods will be chained, and even
- * called by "this.inherited()".
- *
- * Special property "-chains-" governs how to chain methods. It is
- * a dictionary, which uses method names as keys, and hint strings
- * as values. If a hint string is "after", this method will be
- * called after methods of its base classes. If a hint string is
- * "before", this method will be called before methods of its base
- * classes.
- *
- * If "constructor" is not mentioned in "-chains-" property, it will
- * be chained using the legacy mode: using "after" chaining,
- * calling preamble() method before each constructor, if available,
- * and calling postscript() after all constructors were executed.
- * If the hint is "after", it is chained as a regular method, but
- * postscript() will be called after the chain of constructors.
- * "constructor" cannot be chained "before", but it allows
- * a special hint string: "manual", which means that constructors
- * are not going to be chained in any way, and programmer will call
- * them manually using this.inherited(). In the latter case
- * postscript() will be called after the construction.
- *
- * All chaining hints are "inherited" from base classes and
- * potentially can be overridden. Be very careful when overriding
- * hints! Make sure that all chained methods can work in a proposed
- * manner of chaining.
- *
- * Once a method was chained, it is impossible to unchain it. The
- * only exception is "constructor". You don't need to define a
- * method in order to supply a chaining hint.
- *
- * If a method is chained, it cannot use this.inherited() because
- * all other methods in the hierarchy will be called automatically.
- *
- * Usually constructors and initializers of any kind are chained
- * using "after" and destructors of any kind are chained as
- * "before". Note that chaining assumes that chained methods do not
- * return any value: any returned value will be discarded.
- *
- * @param className OptionalThe optional name of the constructor (loosely, a "class")stored in the "declaredClass" property in the created prototype.It will be used as a global name for a created constructor.
- * @param superclass May be null, a Function, or an Array of Functions. This argumentspecifies a list of bases (the left-most one is the most deepestbase).
- * @param props An object whose properties are copied to the created prototype.Add an instance-initialization function by making it a propertynamed "constructor".
- */
- declare(className: String, superclass: Function, props: Object): dojo._base.declare.__DeclareCreatedObject;
- /**
- * Create a feature-rich constructor from compact notation.
- * Create a constructor using a compact notation for inheritance and
- * prototype extension.
- *
- * Mixin ancestors provide a type of multiple inheritance.
- * Prototypes of mixin ancestors are copied to the new class:
- * changes to mixin prototypes will not affect classes to which
- * they have been mixed in.
- *
- * Ancestors can be compound classes created by this version of
- * declare(). In complex cases all base classes are going to be
- * linearized according to C3 MRO algorithm
- * (see http://www.python.org/download/releases/2.3/mro/ for more
- * details).
- *
- * "className" is cached in "declaredClass" property of the new class,
- * if it was supplied. The immediate super class will be cached in
- * "superclass" property of the new class.
- *
- * Methods in "props" will be copied and modified: "nom" property
- * (the declared name of the method) will be added to all copied
- * functions to help identify them for the internal machinery. Be
- * very careful, while reusing methods: if you use the same
- * function under different names, it can produce errors in some
- * cases.
- *
- * It is possible to use constructors created "manually" (without
- * declare()) as bases. They will be called as usual during the
- * creation of an instance, their methods will be chained, and even
- * called by "this.inherited()".
- *
- * Special property "-chains-" governs how to chain methods. It is
- * a dictionary, which uses method names as keys, and hint strings
- * as values. If a hint string is "after", this method will be
- * called after methods of its base classes. If a hint string is
- * "before", this method will be called before methods of its base
- * classes.
- *
- * If "constructor" is not mentioned in "-chains-" property, it will
- * be chained using the legacy mode: using "after" chaining,
- * calling preamble() method before each constructor, if available,
- * and calling postscript() after all constructors were executed.
- * If the hint is "after", it is chained as a regular method, but
- * postscript() will be called after the chain of constructors.
- * "constructor" cannot be chained "before", but it allows
- * a special hint string: "manual", which means that constructors
- * are not going to be chained in any way, and programmer will call
- * them manually using this.inherited(). In the latter case
- * postscript() will be called after the construction.
- *
- * All chaining hints are "inherited" from base classes and
- * potentially can be overridden. Be very careful when overriding
- * hints! Make sure that all chained methods can work in a proposed
- * manner of chaining.
- *
- * Once a method was chained, it is impossible to unchain it. The
- * only exception is "constructor". You don't need to define a
- * method in order to supply a chaining hint.
- *
- * If a method is chained, it cannot use this.inherited() because
- * all other methods in the hierarchy will be called automatically.
- *
- * Usually constructors and initializers of any kind are chained
- * using "after" and destructors of any kind are chained as
- * "before". Note that chaining assumes that chained methods do not
- * return any value: any returned value will be discarded.
- *
- * @param className OptionalThe optional name of the constructor (loosely, a "class")stored in the "declaredClass" property in the created prototype.It will be used as a global name for a created constructor.
- * @param superclass May be null, a Function, or an Array of Functions. This argumentspecifies a list of bases (the left-most one is the most deepestbase).
- * @param props An object whose properties are copied to the created prototype.Add an instance-initialization function by making it a propertynamed "constructor".
- */
- declare(className: String, superclass: Function[], props: Object): dojo._base.declare.__DeclareCreatedObject;
- /**
- * Deprecated. This module defines the legacy dojo/_base/Deferred API.
- * New code should use dojo/Deferred instead.
- * The Deferred API is based on the concept of promises that provide a
- * generic interface into the eventual completion of an asynchronous action.
- * The motivation for promises fundamentally is about creating a
- * separation of concerns that allows one to achieve the same type of
- * call patterns and logical data flow in asynchronous code as can be
- * achieved in synchronous code. Promises allows one
- * to be able to call a function purely with arguments needed for
- * execution, without conflating the call with concerns of whether it is
- * sync or async. One shouldn't need to alter a call's arguments if the
- * implementation switches from sync to async (or vice versa). By having
- * async functions return promises, the concerns of making the call are
- * separated from the concerns of asynchronous interaction (which are
- * handled by the promise).
- *
- * The Deferred is a type of promise that provides methods for fulfilling the
- * promise with a successful result or an error. The most important method for
- * working with Dojo's promises is the then() method, which follows the
- * CommonJS proposed promise API. An example of using a Dojo promise:
- *
- * var resultingPromise = someAsyncOperation.then(function(result){
- * ... handle result ...
- * },
- * function(error){
- * ... handle error ...
- * });
- * The .then() call returns a new promise that represents the result of the
- * execution of the callback. The callbacks will never affect the original promises value.
- *
- * The Deferred instances also provide the following functions for backwards compatibility:
- *
- * addCallback(handler)
- * addErrback(handler)
- * callback(result)
- * errback(result)
- * Callbacks are allowed to return promises themselves, so
- * you can build complicated sequences of events with ease.
- *
- * The creator of the Deferred may specify a canceller. The canceller
- * is a function that will be called if Deferred.cancel is called
- * before the Deferred fires. You can use this to implement clean
- * aborting of an XMLHttpRequest, etc. Note that cancel will fire the
- * deferred with a CancelledError (unless your canceller returns
- * another kind of error), so the errbacks should be prepared to
- * handle that error for cancellable Deferreds.
- *
- * @param canceller Optional
- */
- Deferred(canceller: Function): void;
- /**
- * Deprecated, use dojo/promise/all instead.
- * Provides event handling for a group of Deferred objects.
- * DeferredList takes an array of existing deferreds and returns a new deferred of its own
- * this new deferred will typically have its callback fired when all of the deferreds in
- * the given list have fired their own deferreds. The parameters fireOnOneCallback and
- * fireOnOneErrback, will fire before all the deferreds as appropriate
- *
- * @param list The list of deferreds to be synchronizied with this DeferredList
- * @param fireOnOneCallback OptionalWill cause the DeferredLists callback to be fired as soon as anyof the deferreds in its list have been fired instead of waiting untilthe entire list has finished
- * @param fireOnOneErrback Optional
- * @param consumeErrors Optional
- * @param canceller OptionalA deferred canceller function, see dojo.Deferred
- */
- DeferredList(list: any[], fireOnOneCallback?: boolean, fireOnOneErrback?: boolean, consumeErrors?: boolean, canceller?: Function): void;
- /**
- * Log a debug message to indicate that a behavior has been
- * deprecated.
- *
- * @param behaviour The API or behavior being deprecated. Usually in the formof "myApp.someFunction()".
- * @param extra OptionalText to append to the message. Often provides advice on anew function or facility to achieve the same goal duringthe deprecation period.
- * @param removal OptionalText to indicate when in the future the behavior will beremoved. Usually a version number.
- */
- deprecated(behaviour: String, extra?: String, removal?: String): void;
- /**
- *
- * @param node
- */
- destroy(node: any): void;
- /**
- * Remove a link created by dojo.connect.
- * Removes the connection between event and the method referenced by handle.
- *
- * @param handle the return value of the dojo.connect call that created the connection.
- */
- disconnect(handle: Object): void;
- /**
- * Returns an object with {node, x, y} with corresponding offsets.
- *
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- docScroll(doc?: HTMLDocument): Object;
- /**
- *
- * @param node
- */
- empty(node: any): void;
- /**
- * A legacy method created for use exclusively by internal Dojo methods. Do not use this method
- * directly unless you understand its possibly-different implications on the platforms your are targeting.
- * Makes an attempt to evaluate scriptText in the global scope. The function works correctly for browsers
- * that support indirect eval.
- *
- * As usual, IE does not. On IE, the only way to implement global eval is to
- * use execScript. Unfortunately, execScript does not return a value and breaks some current usages of dojo.eval.
- * This implementation uses the technique of executing eval in the scope of a function that is a single scope
- * frame below the global scope; thereby coming close to the global scope. Note carefully that
- *
- * dojo.eval("var pi = 3.14;");
- *
- * will define global pi in non-IE environments, but define pi only in a temporary local scope for IE. If you want
- * to define a global variable using dojo.eval, write something like
- *
- * dojo.eval("window.pi = 3.14;")
- *
- * @param scriptText The text to evaluation.
- */
- eval(scriptText: any): any;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: any[], callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: String, callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: any[], callback: String, thisObject?: Object): boolean;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: String, callback: String, thisObject?: Object): boolean;
- /**
- *
- * @param exitcode
- */
- exit(exitcode: any): void;
- /**
- * Marks code as experimental.
- * This can be used to mark a function, file, or module as
- * experimental. Experimental code is not ready to be used, and the
- * APIs are subject to change without notice. Experimental code may be
- * completed deleted without going through the normal deprecation
- * process.
- *
- * @param moduleName The name of a module, or the name of a module file or a specificfunction
- * @param extra Optionalsome additional message for the user
- */
- experimental(moduleName: String, extra?: String): void;
- /**
- * Returns an animation that will fade node defined in 'args' from
- * its current opacity to fully opaque.
- *
- * @param args An object with the following properties:node (DOMNode|String): The node referenced in the animationduration (Integer, optional): Duration of the animation in milliseconds.easing (Function, optional): An easing function.
- */
- fadeIn(args: Object): any;
- /**
- * Returns an animation that will fade node defined in 'args'
- * from its current opacity to fully transparent.
- *
- * @param args An object with the following properties:node (DOMNode|String): The node referenced in the animationduration (Integer, optional): Duration of the animation in milliseconds.easing (Function, optional): An easing function.
- */
- fadeOut(args: Object): any;
- /**
- * Serialize a form field to a JavaScript object.
- * Returns the value encoded in a form field as
- * as a string or an array of strings. Disabled form elements
- * and unchecked radio and checkboxes are skipped. Multi-select
- * elements are returned as an array of string values.
- *
- * @param inputNode
- */
- fieldToObject(inputNode: HTMLElement): Object;
- /**
- * Serialize a form field to a JavaScript object.
- * Returns the value encoded in a form field as
- * as a string or an array of strings. Disabled form elements
- * and unchecked radio and checkboxes are skipped. Multi-select
- * elements are returned as an array of string values.
- *
- * @param inputNode
- */
- fieldToObject(inputNode: String): Object;
- /**
- * Returns a new Array with those items from arr that match the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.filter() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's filter skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/filter
- *
- * @param arr the array to iterate over.
- * @param callback a function that is invoked with three arguments (item,index, array). The return of this function is expected tobe a boolean which determines whether the passed-in itemwill be included in the returned array.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- filter(arr: any[], callback: Function, thisObject?: Object): any[];
- /**
- * Returns a new Array with those items from arr that match the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.filter() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's filter skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/filter
- *
- * @param arr the array to iterate over.
- * @param callback a function that is invoked with three arguments (item,index, array). The return of this function is expected tobe a boolean which determines whether the passed-in itemwill be included in the returned array.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- filter(arr: any[], callback: String, thisObject?: Object): any[];
- /**
- * normalizes properties on the event object including event
- * bubbling methods, keystroke normalization, and x/y positions
- *
- * @param evt native event object
- * @param sender node to treat as "currentTarget"
- */
- fixEvent(evt: Event, sender: HTMLElement): Event;
- /**
- * In RTL direction, scrollLeft should be a negative value, but IE
- * returns a positive one. All codes using documentElement.scrollLeft
- * must call this function to fix this error, otherwise the position
- * will offset to right when there is a horizontal scrollbar.
- *
- * @param scrollLeft
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- fixIeBiDiScrollLeft(scrollLeft: number, doc?: HTMLDocument): number;
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: any[], callback: Function, thisObject?: Object): void;
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: String, callback: Function, thisObject?: Object): void;
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: any[], callback: String, thisObject?: Object): void;
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: String, callback: String, thisObject?: Object): void;
- /**
- * Create a serialized JSON string from a form node or string
- * ID identifying the form to serialize
- *
- * @param formNode
- * @param prettyPrint Optional
- */
- formToJson(formNode: HTMLElement, prettyPrint?: boolean): String;
- /**
- * Create a serialized JSON string from a form node or string
- * ID identifying the form to serialize
- *
- * @param formNode
- * @param prettyPrint Optional
- */
- formToJson(formNode: String, prettyPrint?: boolean): String;
- /**
- * Serialize a form node to a JavaScript object.
- * Returns the values encoded in an HTML form as
- * string properties in an object which it then returns. Disabled form
- * elements, buttons, and other non-value form elements are skipped.
- * Multi-select elements are returned as an array of string values.
- *
- * @param formNode
- */
- formToObject(formNode: HTMLElement): Object;
- /**
- * Serialize a form node to a JavaScript object.
- * Returns the values encoded in an HTML form as
- * string properties in an object which it then returns. Disabled form
- * elements, buttons, and other non-value form elements are skipped.
- * Multi-select elements are returned as an array of string values.
- *
- * @param formNode
- */
- formToObject(formNode: String): Object;
- /**
- * Returns a URL-encoded string representing the form passed as either a
- * node or string ID identifying the form to serialize
- *
- * @param formNode
- */
- formToQuery(formNode: HTMLElement): String;
- /**
- * Returns a URL-encoded string representing the form passed as either a
- * node or string ID identifying the form to serialize
- *
- * @param formNode
- */
- formToQuery(formNode: String): String;
- /**
- * Parses a JavaScript expression and returns a JavaScript value.
- * Throws for invalid JavaScript expressions. It does not use a strict JSON parser. It
- * always delegates to eval(). The content passed to this method must therefore come
- * from a trusted source.
- * It is recommend that you use dojo/json's parse function for an
- * implementation uses the (faster) native JSON parse when available.
- *
- * @param js a string literal of a JavaScript expression, for instance:'{ "foo": [ "bar", 1, { "baz": "thud" } ] }'
- */
- fromJson(js: String): any;
- /**
- * Gets an attribute on an HTML element.
- * Handles normalized getting of attributes on DOM Nodes.
- *
- * @param node id or reference to the element to get the attribute on
- * @param name the name of the attribute to get.
- */
- getAttr(node: HTMLElement, name: String): any;
- /**
- * Gets an attribute on an HTML element.
- * Handles normalized getting of attributes on DOM Nodes.
- *
- * @param node id or reference to the element to get the attribute on
- * @param name the name of the attribute to get.
- */
- getAttr(node: String, name: String): any;
- /**
- * returns an object with properties useful for noting the border
- * dimensions.
- * l/t/r/b = the sum of left/top/right/bottom border (respectively)
- * w = the sum of the left and right border
- * h = the sum of the top and bottom border
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getBorderExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * Returns a "computed style" object.
- * Gets a "computed style" object which can be used to gather
- * information about the current state of the rendered node.
- *
- * Note that this may behave differently on different browsers.
- * Values may have different formats and value encodings across
- * browsers.
- *
- * Note also that this method is expensive. Wherever possible,
- * reuse the returned object.
- *
- * Use the dojo/dom-style.get() method for more consistent (pixelized)
- * return values.
- *
- * @param node A reference to a DOM node. Does NOT support taking anID string for speed reasons.
- */
- getComputedStyle(node: HTMLElement): void;
- /**
- * Returns an object that encodes the width, height, left and top
- * positions of the node's content box, irrespective of the
- * current box model.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getContentBox(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns the offset in x and y from the document body to the
- * visual edge of the page for IE
- * The following values in IE contain an offset:
- *
- * event.clientX
- * event.clientY
- * node.getBoundingClientRect().left
- * node.getBoundingClientRect().top
- * But other position related values do not contain this offset,
- *
- * such as node.offsetLeft, node.offsetTop, node.style.left and
- * node.style.top. The offset is always (2, 2) in LTR direction.
- * When the body is in RTL direction, the offset counts the width
- * of left scroll bar's width. This function computes the actual
- * offset.
- *
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- getIeDocumentElementOffset(doc?: HTMLDocument): Object;
- /**
- *
- * @param moduleName
- * @param bundleName
- * @param locale
- */
- getL10nName(moduleName: any, bundleName: any, locale: any): String;
- /**
- * returns an object that encodes the width, height, left and top
- * positions of the node's margin box.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginBox(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns object with properties useful for box fitting with
- * regards to box margins (i.e., the outer-box).
- *
- * l/t = marginLeft, marginTop, respectively
- * w = total width, margin inclusive
- * h = total height, margin inclusive
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns an object that encodes the width and height of
- * the node's margin box
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginSize(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns an object that encodes the width and height of
- * the node's margin box
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginSize(node: String, computedStyle?: Object): Object;
- /**
- * Returns an effective value of a property or an attribute.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute
- */
- getNodeProp(node: HTMLElement, name: String): any;
- /**
- * Returns an effective value of a property or an attribute.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute
- */
- getNodeProp(node: String, name: String): any;
- /**
- * Returns object with properties useful for box fitting with
- * regards to padding.
- * l/t/r/b = the sum of left/top/right/bottom padding and left/top/right/bottom border (respectively)
- * w = the sum of the left and right padding and border
- * h = the sum of the top and bottom padding and border
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getPadBorderExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * Returns object with special values specifically useful for node
- * fitting.
- * Returns an object with w, h, l, t properties:
- *
- * l/t/r/b = left/top/right/bottom padding (respectively)
- * w = the total of the left and right padding
- * h = the total of the top and bottom padding
- * If 'node' has position, l/t forms the origin for child nodes.
- *
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getPadExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * Gets a property on an HTML element.
- * Handles normalized getting of properties on DOM nodes.
- *
- * @param node id or reference to the element to get the property on
- * @param name the name of the property to get.
- */
- getProp(node: HTMLElement, name: String): any;
- /**
- * Gets a property on an HTML element.
- * Handles normalized getting of properties on DOM nodes.
- *
- * @param node id or reference to the element to get the property on
- * @param name the name of the property to get.
- */
- getProp(node: String, name: String): any;
- /**
- * Accesses styles on a node.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo/dom-geometry.getMarginBox(),
- * dojo/dom-geometry.getContentBox() or dojo/dom-geometry.getPosition().
- *
- * @param node id or reference to node to get style for
- * @param name Optionalthe style property to get
- */
- getStyle(node: HTMLElement, name?: String): any;
- /**
- * Accesses styles on a node.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo/dom-geometry.getMarginBox(),
- * dojo/dom-geometry.getContentBox() or dojo/dom-geometry.getPosition().
- *
- * @param node id or reference to node to get style for
- * @param name Optionalthe style property to get
- */
- getStyle(node: String, name?: String): any;
- /**
- * Returns true if the requested attribute is specified on the
- * given element, and false otherwise.
- *
- * @param node id or reference to the element to check
- * @param name the name of the attribute
- */
- hasAttr(node: HTMLElement, name: String): boolean;
- /**
- * Returns true if the requested attribute is specified on the
- * given element, and false otherwise.
- *
- * @param node id or reference to the element to check
- * @param name the name of the attribute
- */
- hasAttr(node: String, name: String): boolean;
- /**
- * Returns whether or not the specified classes are a portion of the
- * class list currently applied to the node.
- *
- * @param node String ID or DomNode reference to check the class for.
- * @param classStr A string class name to look for.
- */
- hasClass(node: String, classStr: String): boolean;
- /**
- * Returns whether or not the specified classes are a portion of the
- * class list currently applied to the node.
- *
- * @param node String ID or DomNode reference to check the class for.
- * @param classStr A string class name to look for.
- */
- hasClass(node: HTMLElement, classStr: String): boolean;
- /**
- * Gets or sets the hash string in the browser URL.
- * Handles getting and setting of location.hash.
- *
- * If no arguments are passed, acts as a getter.
- * If a string is passed, acts as a setter.
- *
- * @param hash Optionalthe hash is set - #string.
- * @param replace OptionalIf true, updates the hash value in the current historystate instead of creating a new history state.
- */
- hash(hash?: String, replace?: boolean): any;
- /**
- * locates the first index of the provided value in the
- * passed array. If the value is not found, -1 is returned.
- * This method corresponds to the JavaScript 1.6 Array.indexOf method, with two differences:
- *
- * when run over sparse arrays, the Dojo function invokes the callback for every index
- * whereas JavaScript 1.6's indexOf skips the holes in the sparse array.
- * uses equality (==) rather than strict equality (===)
- * For details on this method, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/indexOf
- *
- * @param arr
- * @param value
- * @param fromIndex Optional
- * @param findLast OptionalMakes indexOf() work like lastIndexOf(). Used internally; not meant for external usage.
- */
- indexOf(arr: any[], value: Object, fromIndex?: number, findLast?: boolean): number;
- /**
- * Returns true if the current language is left-to-right, and false otherwise.
- *
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- isBodyLtr(doc?: HTMLDocument): boolean;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: HTMLElement, ancestor: HTMLElement): boolean;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: String, ancestor: HTMLElement): boolean;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: HTMLElement, ancestor: String): boolean;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: String, ancestor: String): boolean;
- /**
- * locates the last index of the provided value in the passed
- * array. If the value is not found, -1 is returned.
- * This method corresponds to the JavaScript 1.6 Array.lastIndexOf method, with two differences:
- *
- * when run over sparse arrays, the Dojo function invokes the callback for every index
- * whereas JavaScript 1.6's lasIndexOf skips the holes in the sparse array.
- * uses equality (==) rather than strict equality (===)
- * For details on this method, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/lastIndexOf
- *
- * @param arr
- * @param value
- * @param fromIndex Optional
- */
- lastIndexOf(arr: any, value: any, fromIndex?: number): number;
- /**
- *
- * @param f
- */
- loadInit(f: any): void;
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: any[], callback: Function, thisObject: Object, Ctr: any): any[];
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: String, callback: Function, thisObject: Object, Ctr: any): any[];
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: any[], callback: String, thisObject: Object, Ctr: any): any[];
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: String, callback: String, thisObject: Object, Ctr: any): any[];
- /**
- * Getter/setter for the margin-box of node.
- * Getter/setter for the margin-box of node.
- * Returns an object in the expected format of box (regardless
- * if box is passed). The object might look like:
- * { l: 50, t: 200, w: 300: h: 150 }
- * for a node offset from its parent 50px to the left, 200px from
- * the top with a margin width of 300px and a margin-height of
- * 150px.
- *
- * @param node id or reference to DOM Node to get/set box for
- * @param box OptionalIf passed, denotes that dojo.marginBox() shouldupdate/set the margin box for node. Box is an object in theabove format. All properties are optional if passed.
- */
- marginBox(node: HTMLElement, box?: Object): any;
- /**
- * Getter/setter for the margin-box of node.
- * Getter/setter for the margin-box of node.
- * Returns an object in the expected format of box (regardless
- * if box is passed). The object might look like:
- * { l: 50, t: 200, w: 300: h: 150 }
- * for a node offset from its parent 50px to the left, 200px from
- * the top with a margin width of 300px and a margin-height of
- * 150px.
- *
- * @param node id or reference to DOM Node to get/set box for
- * @param box OptionalIf passed, denotes that dojo.marginBox() shouldupdate/set the margin box for node. Box is an object in theabove format. All properties are optional if passed.
- */
- marginBox(node: String, box?: Object): any;
- /**
- * Returns a URL relative to a module.
- *
- * @param module dojo/dom-class
- * @param url Optional
- */
- moduleUrl(module: String, url?: String): String;
- /**
- * Array-like object which adds syntactic
- * sugar for chaining, common iteration operations, animation, and
- * node manipulation. NodeLists are most often returned as the
- * result of dojo/query() calls.
- * NodeList instances provide many utilities that reflect
- * core Dojo APIs for Array iteration and manipulation, DOM
- * manipulation, and event handling. Instead of needing to dig up
- * functions in the dojo package, NodeLists generally make the
- * full power of Dojo available for DOM manipulation tasks in a
- * simple, chainable way.
- *
- * @param array
- */
- NodeList(array: any): any[];
- /**
- * takes a name/value mapping object and returns a string representing
- * a URL-encoded version of that object.
- *
- * @param map
- */
- objectToQuery(map: Object): any;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: HTMLElement, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: HTMLElement, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: String, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: String, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: HTMLElement, position?: number): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: HTMLElement, position?: number): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: String, position?: number): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: String, position?: number): HTMLElement;
- /**
- * require one or more modules based on which host environment
- * Dojo is currently operating in
- * This method takes a "map" of arrays which one can use to
- * optionally load dojo modules. The map is indexed by the
- * possible dojo.name values, with two additional values:
- * "default" and "common". The items in the "default" array will
- * be loaded if none of the other items have been choosen based on
- * dojo.name, set by your host environment. The items in the
- * "common" array will always be loaded, regardless of which
- * list is chosen.
- *
- * @param modMap
- */
- platformRequire(modMap: Object): void;
- /**
- * If the context stack contains elements, ensure that
- * subsequent code executes in the previous context to the
- * current context. The current context set ([global,
- * document]) is returned.
- *
- */
- popContext(): void;
- /**
- * Gets the position and size of the passed element relative to
- * the viewport (if includeScroll==false), or relative to the
- * document root (if includeScroll==true).
- * Returns an object of the form:
- * { x: 100, y: 300, w: 20, h: 15 }.
- * If includeScroll==true, the x and y values will include any
- * document offsets that may affect the position relative to the
- * viewport.
- * Uses the border-box model (inclusive of border and padding but
- * not margin). Does not act as a setter.
- *
- * @param node
- * @param includeScroll Optional
- */
- position(node: HTMLElement, includeScroll?: boolean): Object;
- /**
- * Gets the position and size of the passed element relative to
- * the viewport (if includeScroll==false), or relative to the
- * document root (if includeScroll==true).
- * Returns an object of the form:
- * { x: 100, y: 300, w: 20, h: 15 }.
- * If includeScroll==true, the x and y values will include any
- * document offsets that may affect the position relative to the
- * viewport.
- * Uses the border-box model (inclusive of border and padding but
- * not margin). Does not act as a setter.
- *
- * @param node
- * @param includeScroll Optional
- */
- position(node: String, includeScroll?: boolean): Object;
- /**
- * Gets or sets a property on an HTML element.
- * Handles normalized getting and setting of properties on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the property on
- * @param name the name of the property to get or set.
- * @param value OptionalThe value to set for the property
- */
- prop(node: HTMLElement, name: String, value?: String): any;
- /**
- * Gets or sets a property on an HTML element.
- * Handles normalized getting and setting of properties on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the property on
- * @param name the name of the property to get or set.
- * @param value OptionalThe value to set for the property
- */
- prop(node: String, name: String, value?: String): any;
- /**
- * Gets or sets a property on an HTML element.
- * Handles normalized getting and setting of properties on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the property on
- * @param name the name of the property to get or set.
- * @param value OptionalThe value to set for the property
- */
- prop(node: HTMLElement, name: Object, value?: String): any;
- /**
- * Gets or sets a property on an HTML element.
- * Handles normalized getting and setting of properties on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the property on
- * @param name the name of the property to get or set.
- * @param value OptionalThe value to set for the property
- */
- prop(node: String, name: Object, value?: String): any;
- /**
- *
- * @param mid
- */
- provide(mid: any): void;
- /**
- * causes subsequent calls to Dojo methods to assume the
- * passed object and, optionally, document as the default
- * scopes to use. A 2-element array of the previous global and
- * document are returned.
- * dojo.pushContext treats contexts as a stack. The
- * auto-detected contexts which are initially provided using
- * dojo.setContext() require authors to keep state in order to
- * "return" to a previous context, whereas the
- * dojo.pushContext and dojo.popContext methods provide a more
- * natural way to augment blocks of code to ensure that they
- * execute in a different window or frame without issue. If
- * called without any arguments, the default context (the
- * context when Dojo is first loaded) is instead pushed into
- * the stack. If only a single string is passed, a node in the
- * intitial context's document is looked up and its
- * contextWindow and contextDocument properties are used as
- * the context to push. This means that iframes can be given
- * an ID and code can be executed in the scope of the iframe's
- * document in subsequent calls easily.
- *
- * @param g OptionalThe global context. If a string, the id of the frame tosearch for a context and document.
- * @param d OptionalThe document element to execute subsequent code with.
- */
- pushContext(g?: Object, d?: HTMLDocument): void;
- /**
- * causes subsequent calls to Dojo methods to assume the
- * passed object and, optionally, document as the default
- * scopes to use. A 2-element array of the previous global and
- * document are returned.
- * dojo.pushContext treats contexts as a stack. The
- * auto-detected contexts which are initially provided using
- * dojo.setContext() require authors to keep state in order to
- * "return" to a previous context, whereas the
- * dojo.pushContext and dojo.popContext methods provide a more
- * natural way to augment blocks of code to ensure that they
- * execute in a different window or frame without issue. If
- * called without any arguments, the default context (the
- * context when Dojo is first loaded) is instead pushed into
- * the stack. If only a single string is passed, a node in the
- * intitial context's document is looked up and its
- * contextWindow and contextDocument properties are used as
- * the context to push. This means that iframes can be given
- * an ID and code can be executed in the scope of the iframe's
- * document in subsequent calls easily.
- *
- * @param g OptionalThe global context. If a string, the id of the frame tosearch for a context and document.
- * @param d OptionalThe document element to execute subsequent code with.
- */
- pushContext(g?: String, d?: HTMLDocument): void;
- /**
- * Create an object representing a de-serialized query section of a
- * URL. Query keys with multiple values are returned in an array.
- *
- * @param str
- */
- queryToObject(str: String): Object;
- /**
- * Sends an HTTP POST request to the server. In addition to the properties
- * listed for the dojo.__XhrArgs type, the following property is allowed:
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- rawXhrPost(args: Object): any;
- /**
- * Sends an HTTP PUT request to the server. In addition to the properties
- * listed for the dojo.__XhrArgs type, the following property is allowed:
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- rawXhrPut(args: Object): any;
- /**
- * Add a function to execute on DOM content loaded and all requested modules have arrived and been evaluated.
- * In most cases, the domReady plug-in should suffice and this method should not be needed.
- *
- * When called in a non-browser environment, just checks that all requested modules have arrived and been
- * evaluated.
- *
- * @param priority OptionalThe order in which to exec this callback relative to other callbacks, defaults to 1000
- * @param context The context in which to run execute callback, or a callback if not using context
- * @param callback OptionalThe function to execute.
- */
- ready(priority: number, context: any, callback?: Function): void;
- /**
- * Maps a module name to a path
- * An unregistered module is given the default path of ../[module],
- * relative to Dojo root. For example, module acme is mapped to
- * ../acme. If you want to use a different module name, use
- * dojo.registerModulePath.
- *
- * @param moduleName
- * @param prefix
- */
- registerModulePath(moduleName: String, prefix: String): void;
- /**
- * Removes an attribute from an HTML element.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute to remove
- */
- removeAttr(node: HTMLElement, name: String): void;
- /**
- * Removes an attribute from an HTML element.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute to remove
- */
- removeAttr(node: String, name: String): void;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- removeClass(node: String, classStr?: String): void;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- removeClass(node: HTMLElement, classStr?: String): void;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- removeClass(node: String, classStr?: any[]): void;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- removeClass(node: HTMLElement, classStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: String, addClassStr: String, removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: HTMLElement, addClassStr: String, removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: String, addClassStr: any[], removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: HTMLElement, addClassStr: any[], removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: String, addClassStr: String, removeClassStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: HTMLElement, addClassStr: String, removeClassStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: String, addClassStr: any[], removeClassStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: HTMLElement, addClassStr: any[], removeClassStr?: any[]): void;
- /**
- * loads a Javascript module from the appropriate URI
- * Modules are loaded via dojo.require by using one of two loaders: the normal loader
- * and the xdomain loader. The xdomain loader is used when dojo was built with a
- * custom build that specified loader=xdomain and the module lives on a modulePath
- * that is a whole URL, with protocol and a domain. The versions of Dojo that are on
- * the Google and AOL CDNs use the xdomain loader.
- *
- * If the module is loaded via the xdomain loader, it is an asynchronous load, since
- * the module is added via a dynamically created script tag. This
- * means that dojo.require() can return before the module has loaded. However, this
- * should only happen in the case where you do dojo.require calls in the top-level
- * HTML page, or if you purposely avoid the loader checking for dojo.require
- * dependencies in your module by using a syntax like dojo["require"] to load the module.
- *
- * Sometimes it is useful to not have the loader detect the dojo.require calls in the
- * module so that you can dynamically load the modules as a result of an action on the
- * page, instead of right at module load time.
- *
- * Also, for script blocks in an HTML page, the loader does not pre-process them, so
- * it does not know to download the modules before the dojo.require calls occur.
- *
- * So, in those two cases, when you want on-the-fly module loading or for script blocks
- * in the HTML page, special care must be taken if the dojo.required code is loaded
- * asynchronously. To make sure you can execute code that depends on the dojo.required
- * modules, be sure to add the code that depends on the modules in a dojo.addOnLoad()
- * callback. dojo.addOnLoad waits for all outstanding modules to finish loading before
- * executing.
- *
- * This type of syntax works with both xdomain and normal loaders, so it is good
- * practice to always use this idiom for on-the-fly code loading and in HTML script
- * blocks. If at some point you change loaders and where the code is loaded from,
- * it will all still work.
- *
- * More on how dojo.require
- * dojo.require("A.B") first checks to see if symbol A.B is
- * defined. If it is, it is simply returned (nothing to do).
- *
- * If it is not defined, it will look for A/B.js in the script root
- * directory.
- *
- * dojo.require throws an exception if it cannot find a file
- * to load, or if the symbol A.B is not defined after loading.
- *
- * It returns the object A.B, but note the caveats above about on-the-fly loading and
- * HTML script blocks when the xdomain loader is loading a module.
- *
- * dojo.require() does nothing about importing symbols into
- * the current namespace. It is presumed that the caller will
- * take care of that.
- *
- * @param moduleName module name to load, using periods for separators, e.g. "dojo.date.locale". Module paths are de-referenced by dojo'sinternal mapping of locations to names and are disambiguated bylongest prefix. See dojo.registerModulePath() for details onregistering new modules.
- * @param omitModuleCheck Optionalif true, omitModuleCheck skips the step of ensuring that theloaded file actually defines the symbol it is referenced by.For example if it called as dojo.require("a.b.c") and thefile located at a/b/c.js does not define an object a.b.c,and exception will be throws whereas no exception is raisedwhen called as dojo.require("a.b.c", true)
- */
- require(moduleName: String, omitModuleCheck: boolean): any;
- /**
- * If the condition is true then call dojo.require() for the specified
- * resource
- *
- * @param condition
- * @param moduleName
- * @param omitModuleCheck Optional
- */
- requireAfterIf(condition: boolean, moduleName: String, omitModuleCheck?: boolean): void;
- /**
- * If the condition is true then call dojo.require() for the specified
- * resource
- *
- * @param condition
- * @param moduleName
- * @param omitModuleCheck Optional
- */
- requireIf(condition: boolean, moduleName: String, omitModuleCheck?: boolean): void;
- /**
- *
- * @param moduleName
- * @param bundleName
- * @param locale Optional
- */
- requireLocalization(moduleName: String, bundleName: String, locale?: String): void;
- /**
- * Mix in properties skipping a constructor and decorating functions
- * like it is done by declare().
- * This function is used to mix in properties like lang.mixin does,
- * but it skips a constructor property and decorates functions like
- * declare() does.
- *
- * It is meant to be used with classes and objects produced with
- * declare. Functions mixed in with dojo.safeMixin can use
- * this.inherited() like normal methods.
- *
- * This function is used to implement extend() method of a constructor
- * produced with declare().
- *
- * @param target Target object to accept new properties.
- * @param source Source object for new properties.
- */
- safeMixin(target: Object, source: Object): Object;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- setAttr(node: HTMLElement, name: String, value?: String): any;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- setAttr(node: String, name: String, value?: String): any;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- setAttr(node: HTMLElement, name: Object, value?: String): any;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- setAttr(node: String, name: Object, value?: String): any;
- /**
- * Sets the size of the node's contents, irrespective of margins,
- * padding, or borders.
- *
- * @param node
- * @param box hash with optional "w", and "h" properties for "width", and "height"respectively. All specified properties should have numeric values in whole pixels.
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- setContentSize(node: HTMLElement, box: Object, computedStyle?: Object): void;
- /**
- * changes the behavior of many core Dojo functions that deal with
- * namespace and DOM lookup, changing them to work in a new global
- * context (e.g., an iframe). The varibles dojo.global and dojo.doc
- * are modified as a result of calling this function and the result of
- * dojo.body() likewise differs.
- *
- * @param globalObject
- * @param globalDocument
- */
- setContext(globalObject: Object, globalDocument: HTMLDocument): void;
- /**
- * sets the size of the node's margin box and placement
- * (left/top), irrespective of box model. Think of it as a
- * passthrough to setBox that handles box-model vagaries for
- * you.
- *
- * @param node
- * @param box hash with optional "l", "t", "w", and "h" properties for "left", "right", "width", and "height"respectively. All specified properties should have numeric values in whole pixels.
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- setMarginBox(node: HTMLElement, box: Object, computedStyle?: Object): void;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- setProp(node: HTMLElement, name: String, value?: String): any;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- setProp(node: String, name: String, value?: String): any;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- setProp(node: HTMLElement, name: Object, value?: String): any;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- setProp(node: String, name: Object, value?: String): any;
- /**
- *
- * @param node
- * @param selectable
- */
- setSelectable(node: any, selectable: any): void;
- /**
- * Sets styles on a node.
- *
- * @param node id or reference to node to set style for
- * @param name the style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- setStyle(node: HTMLElement, name: String, value?: String): String;
- /**
- * Sets styles on a node.
- *
- * @param node id or reference to node to set style for
- * @param name the style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- setStyle(node: String, name: String, value?: String): String;
- /**
- * Sets styles on a node.
- *
- * @param node id or reference to node to set style for
- * @param name the style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- setStyle(node: HTMLElement, name: Object, value?: String): String;
- /**
- * Sets styles on a node.
- *
- * @param node id or reference to node to set style for
- * @param name the style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- setStyle(node: String, name: Object, value?: String): String;
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: any[], callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: String, callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: any[], callback: String, thisObject?: Object): boolean;
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: String, callback: String, thisObject?: Object): boolean;
- /**
- *
- */
- Stateful(): void;
- /**
- * prevents propagation and clobbers the default action of the
- * passed event
- *
- * @param evt The event object. If omitted, window.event is used on IE.
- */
- stopEvent(evt: Event): void;
- /**
- * Accesses styles on a node. If 2 arguments are
- * passed, acts as a getter. If 3 arguments are passed, acts
- * as a setter.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo.marginBox(),
- * dojo.contentBox() or dojo.position().
- *
- * @param node id or reference to node to get/set style for
- * @param name Optionalthe style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- style(node: HTMLElement, name?: String, value?: String): any;
- /**
- * Accesses styles on a node. If 2 arguments are
- * passed, acts as a getter. If 3 arguments are passed, acts
- * as a setter.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo.marginBox(),
- * dojo.contentBox() or dojo.position().
- *
- * @param node id or reference to node to get/set style for
- * @param name Optionalthe style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- style(node: String, name?: String, value?: String): any;
- /**
- * Accesses styles on a node. If 2 arguments are
- * passed, acts as a getter. If 3 arguments are passed, acts
- * as a setter.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo.marginBox(),
- * dojo.contentBox() or dojo.position().
- *
- * @param node id or reference to node to get/set style for
- * @param name Optionalthe style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- style(node: HTMLElement, name?: Object, value?: String): any;
- /**
- * Accesses styles on a node. If 2 arguments are
- * passed, acts as a getter. If 3 arguments are passed, acts
- * as a setter.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo.marginBox(),
- * dojo.contentBox() or dojo.position().
- *
- * @param node id or reference to node to get/set style for
- * @param name Optionalthe style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- style(node: String, name?: Object, value?: String): any;
- /**
- * instantiates an HTML fragment returning the corresponding DOM.
- *
- * @param frag the HTML fragment
- * @param doc Optionaloptional document to use when creating DOM nodes, defaults todojo/_base/window.doc if not specified.
- */
- toDom(frag: String, doc?: HTMLDocument): any;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggleClass(node: String, classStr: String, condition: boolean): boolean;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggleClass(node: HTMLElement, classStr: String, condition: boolean): boolean;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggleClass(node: String, classStr: any[], condition: boolean): boolean;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggleClass(node: HTMLElement, classStr: any[], condition: boolean): boolean;
- /**
- * Returns a JSON serialization of an object.
- * Returns a JSON serialization of an object.
- * Note that this doesn't check for infinite recursion, so don't do that!
- * It is recommend that you use dojo/json's stringify function for an lighter
- * and faster implementation that matches the native JSON API and uses the
- * native JSON serializer when available.
- *
- * @param it an object to be serialized. Objects may define their ownserialization via a special "json" or "json" functionproperty. If a specialized serializer has been defined, it willbe used as a fallback.Note that in 1.6, toJson would serialize undefined, but this no longer supportedsince it is not supported by native JSON serializer.
- * @param prettyPrint Optionalif true, we indent objects and arrays to make the output prettier.The variable dojo.toJsonIndentStr is used as the indent string --to use something other than the default (tab), change that variablebefore calling dojo.toJson().Note that if native JSON support is available, it will be used for serialization,and native implementations vary on the exact spacing used in pretty printing.
- */
- toJson(it: Object, prettyPrint?: boolean): any;
- /**
- * converts style value to pixels on IE or return a numeric value.
- *
- * @param node
- * @param value
- */
- toPixelValue(node: HTMLElement, value: String): number;
- /**
- * Remove a topic listener.
- *
- * @param handle The handle returned from a call to subscribe.
- */
- unsubscribe(handle: Object): void;
- /**
- * Transparently applies callbacks to values and/or promises.
- * Accepts promises but also transparently handles non-promises. If no
- * callbacks are provided returns a promise, regardless of the initial
- * value. Foreign promises are converted.
- *
- * If callbacks are provided and the initial value is not a promise,
- * the callback is executed immediately with no error handling. Returns
- * a promise if the initial value is a promise, or the result of the
- * callback otherwise.
- *
- * @param valueOrPromise Either a regular value or an object with a then() method thatfollows the Promises/A specification.
- * @param callback OptionalCallback to be invoked when the promise is resolved, or a non-promiseis received.
- * @param errback OptionalCallback to be invoked when the promise is rejected.
- * @param progback OptionalCallback to be invoked when the promise emits a progress update.
- */
- when(valueOrPromise: any, callback?: Function, errback?: Function, progback?: Function): dojo.promise.Promise<any>;
- /**
- * signal fired by impending window destruction. You may use
- * dojo.addOnWIndowUnload() or dojo.connect() to this method to perform
- * page/application cleanup methods. See dojo.addOnWindowUnload for more info.
- *
- */
- windowUnloaded(): void;
- /**
- * Invoke callback with documentObject as dojo/_base/window::doc.
- * Invoke callback with documentObject as dojo/_base/window::doc. If provided,
- * callback will be executed in the context of object thisObject
- * When callback() returns or throws an error, the dojo/_base/window::doc will
- * be restored to its previous state.
- *
- * @param documentObject
- * @param callback
- * @param thisObject Optional
- * @param cbArguments Optional
- */
- withDoc(documentObject: HTMLDocument, callback: Function, thisObject?: Object, cbArguments?: any[]): any;
- /**
- * Invoke callback with globalObject as dojo.global and
- * globalObject.document as dojo.doc.
- * Invoke callback with globalObject as dojo.global and
- * globalObject.document as dojo.doc. If provided, globalObject
- * will be executed in the context of object thisObject
- * When callback() returns or throws an error, the dojo.global
- * and dojo.doc will be restored to its previous state.
- *
- * @param globalObject
- * @param callback
- * @param thisObject Optional
- * @param cbArguments Optional
- */
- withGlobal(globalObject: Object, callback: Function, thisObject?: Object, cbArguments?: any[]): any;
- /**
- *
- * @param method
- * @param args
- */
- xhr(method: any, args: any): any;
- /**
- * Sends an HTTP DELETE request to the server.
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- xhrDelete(args: Object): any;
- /**
- * Sends an HTTP GET request to the server.
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- xhrGet(args: Object): any;
- /**
- * Sends an HTTP POST request to the server. In addition to the properties
- * listed for the dojo.__XhrArgs type, the following property is allowed:
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- xhrPost(args: Object): any;
- /**
- * Sends an HTTP PUT request to the server. In addition to the properties
- * listed for the dojo.__XhrArgs type, the following property is allowed:
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- xhrPut(args: Object): any;
- }
- namespace kernel {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.__IoCallbackArgs.html
- *
- *
- */
- class __IoCallbackArgs {
- constructor();
- /**
- * the original object argument to the IO call.
- *
- */
- "args": Object;
- /**
- * For dojo/io/script calls only, indicates
- * whether the script tag that represents the
- * request can be deleted after callbacks have
- * been called. Used internally to know when
- * cleanup can happen on JSONP-type requests.
- *
- */
- "canDelete": boolean;
- /**
- * The final indicator on how the response will be
- * handled.
- *
- */
- "handleAs": string;
- /**
- * For dojo/io/script calls only, the internal
- * script ID used for the request.
- *
- */
- "id": string;
- /**
- * For dojo/io/script calls only: holds the JSON
- * response for JSONP-type requests. Used
- * internally to hold on to the JSON responses.
- * You should not need to access it directly --
- * the same object should be passed to the success
- * callbacks directly.
- *
- */
- "json": Object;
- /**
- * For non-GET requests, the
- * name1=value1&name2=value2 parameters sent up in
- * the request.
- *
- */
- "query": string;
- /**
- * The final URL used for the call. Many times it
- * will be different than the original args.url
- * value.
- *
- */
- "url": string;
- /**
- * For XMLHttpRequest calls only, the
- * XMLHttpRequest object that was used for the
- * request.
- *
- */
- "xhr": Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.__IoPublish.html
- *
- * This is a list of IO topics that can be published
- * if djConfig.ioPublish is set to true. IO topics can be
- * published for any Input/Output, network operation. So,
- * dojo.xhr, dojo.io.script and dojo.io.iframe can all
- * trigger these topics to be published.
- *
- */
- class __IoPublish {
- constructor();
- /**
- * "/dojo/io/done" is sent whenever an IO request has completed,
- * either by loading or by erroring. It passes the error and
- * the dojo.Deferred for the request with the topic.
- *
- */
- "done": string;
- /**
- * "/dojo/io/error" is sent whenever an IO request has errored.
- * It passes the error and the dojo.Deferred
- * for the request with the topic.
- *
- */
- "error": string;
- /**
- * "/dojo/io/load" is sent whenever an IO request has loaded
- * successfully. It passes the response and the dojo.Deferred
- * for the request with the topic.
- *
- */
- "load": string;
- /**
- * "/dojo/io/send" is sent whenever a new IO request is started.
- * It passes the dojo.Deferred for the request with the topic.
- *
- */
- "send": string;
- /**
- * "/dojo/io/start" is sent when there are no outstanding IO
- * requests, and a new IO request is started. No arguments
- * are passed with this topic.
- *
- */
- "start": string;
- /**
- * "/dojo/io/stop" is sent when all outstanding IO requests have
- * finished. No arguments are passed with this topic.
- *
- */
- "stop": string;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.__IoArgs.html
- *
- *
- */
- class __IoArgs {
- constructor();
- /**
- * Contains properties with string values. These
- * properties will be serialized as name1=value2 and
- * passed in the request.
- *
- */
- "content": Object;
- /**
- * DOM node for a form. Used to extract the form values
- * and send to the server.
- *
- */
- "form": HTMLElement;
- /**
- * Acceptable values depend on the type of IO
- * transport (see specific IO calls for more information).
- *
- */
- "handleAs": string;
- /**
- * Set this explicitly to false to prevent publishing of topics related to
- * IO operations. Otherwise, if djConfig.ioPublish is set to true, topics
- * will be published via dojo/topic.publish() for different phases of an IO operation.
- * See dojo/main.__IoPublish for a list of topics that are published.
- *
- */
- "ioPublish": boolean;
- /**
- * Default is false. If true, then a
- * "dojo.preventCache" parameter is sent in the request
- * with a value that changes with each request
- * (timestamp). Useful only with GET-type requests.
- *
- */
- "preventCache": boolean;
- /**
- * Sets the raw body for an HTTP request. If this is used, then the content
- * property is ignored. This is mostly useful for HTTP methods that have
- * a body to their requests, like PUT or POST. This property can be used instead
- * of postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.
- *
- */
- "rawBody": string;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then error callbacks are called.
- *
- */
- "timeout": number;
- /**
- * URL to server endpoint.
- *
- */
- "url": string;
- /**
- * This function will
- * be called when the request fails due to a network or server error, the url
- * is invalid, etc. It will also be called if the load or handle callback throws an
- * exception, unless djConfig.debugAtAllCosts is true. This allows deployed applications
- * to continue to run even when a logic error happens in the callback, while making
- * it easier to troubleshoot while in debug mode.
- *
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- error(response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- /**
- * This function will
- * be called at the end of every request, whether or not an error occurs.
- *
- * @param loadOrError Provides a string that tells you whether this functionwas called because of success (load) or failure (error).
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- handle(loadOrError: String, response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- /**
- * This function will be
- * called on a successful HTTP response code.
- *
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- load(response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.__XhrArgs.html
- *
- * In addition to the properties listed for the dojo._IoArgs type,
- * the following properties are allowed for dojo.xhr* methods.
- *
- */
- class __XhrArgs {
- constructor();
- /**
- * Contains properties with string values. These
- * properties will be serialized as name1=value2 and
- * passed in the request.
- *
- */
- "content": Object;
- /**
- * "application/x-www-form-urlencoded" is default. Set to false to
- * prevent a Content-Type header from being sent, or to a string
- * to send a different Content-Type.
- *
- */
- "contentType": string;
- /**
- * false is default. Indicates whether a request should be
- * allowed to fail (and therefore no console error message in
- * the event of a failure)
- *
- */
- "failOk": boolean;
- /**
- * DOM node for a form. Used to extract the form values
- * and send to the server.
- *
- */
- "form": HTMLElement;
- /**
- * Acceptable values are: text (default), json, json-comment-optional,
- * json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlers
- *
- */
- "handleAs": string;
- /**
- * Additional HTTP headers to send in the request.
- *
- */
- "headers": Object;
- /**
- * Set this explicitly to false to prevent publishing of topics related to
- * IO operations. Otherwise, if djConfig.ioPublish is set to true, topics
- * will be published via dojo/topic.publish() for different phases of an IO operation.
- * See dojo/main.__IoPublish for a list of topics that are published.
- *
- */
- "ioPublish": boolean;
- /**
- * Default is false. If true, then a
- * "dojo.preventCache" parameter is sent in the request
- * with a value that changes with each request
- * (timestamp). Useful only with GET-type requests.
- *
- */
- "preventCache": boolean;
- /**
- * Sets the raw body for an HTTP request. If this is used, then the content
- * property is ignored. This is mostly useful for HTTP methods that have
- * a body to their requests, like PUT or POST. This property can be used instead
- * of postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.
- *
- */
- "rawBody": string;
- /**
- * false is default. Indicates whether the request should
- * be a synchronous (blocking) request.
- *
- */
- "sync": boolean;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then error callbacks are called.
- *
- */
- "timeout": number;
- /**
- * URL to server endpoint.
- *
- */
- "url": string;
- /**
- * This function will
- * be called when the request fails due to a network or server error, the url
- * is invalid, etc. It will also be called if the load or handle callback throws an
- * exception, unless djConfig.debugAtAllCosts is true. This allows deployed applications
- * to continue to run even when a logic error happens in the callback, while making
- * it easier to troubleshoot while in debug mode.
- *
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- error(response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- /**
- * This function will
- * be called at the end of every request, whether or not an error occurs.
- *
- * @param loadOrError Provides a string that tells you whether this functionwas called because of success (load) or failure (error).
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- handle(loadOrError: String, response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- /**
- * This function will be
- * called on a successful HTTP response code.
- *
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- load(response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.Stateful.html
- *
- * Base class for objects that provide named properties with optional getter/setter
- * control and the ability to watch for property changes
- *
- * The class also provides the functionality to auto-magically manage getters
- * and setters for object attributes/properties.
- *
- * Getters and Setters should follow the format of _xxxGetter or _xxxSetter where
- * the xxx is a name of the attribute to handle. So an attribute of "foo"
- * would have a custom getter of _fooGetter and a custom setter of _fooSetter.
- *
- */
- class Stateful {
- constructor();
- /**
- * Get a property on a Stateful instance.
- * Get a named property on a Stateful object. The property may
- * potentially be retrieved via a getter method in subclasses. In the base class
- * this just retrieves the object's property.
- *
- * @param name The property to get.
- */
- get(name: String): any;
- /**
- *
- * @param params Optional
- */
- postscript(params?: Object): void;
- /**
- * Set a property on a Stateful instance
- * Sets named properties on a stateful object and notifies any watchers of
- * the property. A programmatic setter may be defined in subclasses.
- *
- * @param name The property to set.
- * @param value The value to set in the property.
- */
- set(name: String, value: Object): any;
- /**
- * Watches a property for changes
- *
- * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched
- * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value.
- */
- watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel._contentHandlers.html
- *
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls.
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls. Each contentHandler is
- * called, passing the xhr object for manipulation. The return value
- * from the contentHandler will be passed to the load or handle
- * functions defined in the original xhr call.
- *
- */
- interface _contentHandlers {
- /**
- *
- * @param xhr
- */
- auto(xhr: any): void;
- /**
- * A contentHandler which evaluates the response data, expecting it to be valid JavaScript
- *
- * @param xhr
- */
- javascript(xhr: any): any;
- /**
- * A contentHandler which returns a JavaScript object created from the response data
- *
- * @param xhr
- */
- json(xhr: any): any;
- /**
- * A contentHandler which expects comment-filtered JSON.
- * A contentHandler which expects comment-filtered JSON.
- * the json-comment-filtered option was implemented to prevent
- * "JavaScript Hijacking", but it is less secure than standard JSON. Use
- * standard JSON instead. JSON prefixing can be used to subvert hijacking.
- *
- * Will throw a notice suggesting to use application/json mimetype, as
- * json-commenting can introduce security issues. To decrease the chances of hijacking,
- * use the standard json contentHandler, and prefix your "JSON" with: {}&&
- *
- * use djConfig.useCommentedJson = true to turn off the notice
- *
- * @param xhr
- */
- json_comment_filtered(xhr: any): any;
- /**
- * A contentHandler which checks the presence of comment-filtered JSON and
- * alternates between the json and json-comment-filtered contentHandlers.
- *
- * @param xhr
- */
- json_comment_optional(xhr: any): any;
- /**
- *
- * @param xhr
- */
- olson_zoneinfo(xhr: any): void;
- /**
- * A contentHandler which simply returns the plaintext response data
- *
- * @param xhr
- */
- text(xhr: any): any;
- /**
- * A contentHandler returning an XML Document parsed from the response data
- *
- * @param xhr
- */
- xml(xhr: any): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel._hasResource.html
- *
- *
- */
- interface _hasResource {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel._nodeDataCache.html
- *
- *
- */
- interface _nodeDataCache {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.back.html
- *
- * Browser history management resources
- *
- */
- interface back {
- /**
- * adds a state object (args) to the history list.
- * To support getting back button notifications, the object
- * argument should implement a function called either "back",
- * "backButton", or "handle". The string "back" will be passed as
- * the first and only argument to this callback.
- *
- * To support getting forward button notifications, the object
- * argument should implement a function called either "forward",
- * "forwardButton", or "handle". The string "forward" will be
- * passed as the first and only argument to this callback.
- *
- * If you want the browser location string to change, define "changeUrl" on the object. If the
- * value of "changeUrl" is true, then a unique number will be appended to the URL as a fragment
- * identifier (http://some.domain.com/path#uniquenumber). If it is any other value that does
- * not evaluate to false, that value will be used as the fragment identifier. For example,
- * if changeUrl: 'page1', then the URL will look like: http://some.domain.com/path#page1
- *
- * There are problems with using dojo/back with semantically-named fragment identifiers
- * ("hash values" on an URL). In most browsers it will be hard for dojo/back to know
- * distinguish a back from a forward event in those cases. For back/forward support to
- * work best, the fragment ID should always be a unique value (something using new Date().getTime()
- * for example). If you want to detect hash changes using semantic fragment IDs, then
- * consider using dojo/hash instead (in Dojo 1.4+).
- *
- * @param args The state object that will be added to the history list.
- */
- addToHistory(args: Object): void;
- /**
- *
- */
- getHash(): any;
- /**
- * private method. Do not call this directly.
- *
- */
- goBack(): void;
- /**
- * private method. Do not call this directly.
- *
- */
- goForward(): void;
- /**
- * Initializes the undo stack. This must be called from a
- * block that lives inside the <code><body></code> tag to prevent bugs on IE.
- * </p>
- * <p>Only call this method before the page's DOM is finished loading. Otherwise
- * it will not work. Be careful with xdomain loading or djConfig.debugAtAllCosts scenarios,
- * in order for this method to work, dojo/back will need to be part of a build layer.</p>
- * </div>
- * </div>
- * <div class="jsdoc-field extension-module">
- * <div class="jsdoc-title"><a name="1_9dojo__base_kernel_back_setHash"></a><span class="functionIcon">setHash</span><span class="parameters">(h)</span>
- * </div>
- * <div class="jsdoc-inheritance">Defined by <a href="/api/1.9/dojo/back" class="jsdoc-link">dojo/back</a><span title="Must manually require () dojo/back to access" class="jsdoc-extension"></span>
- * </div>
- * <div class="jsdoc-full-summary"></div>
- * <table class="jsdoc-parameters">
- * <tr>
- * <th>Parameter</th>
- * <th>Type</th>
- * <th>Description</th>
- * </tr>
- * <tr>
- * <td class="jsdoc-param-name">h</td>
- * <td class="jsdoc-param-type">undefined</td>
- * <td class="jsdoc-param-description">
- * </td>
- * </tr>
- * </table>
- * </div>
- * <div class="jsdoc-field extension-module">
- * <div class="jsdoc-title"><a name="1_9dojo__base_kernel_back_setInitialState"></a><span class="functionIcon">setInitialState</span><span class="parameters">(args)</span>
- * </div>
- * <div class="jsdoc-inheritance">Defined by <a href="/api/1.9/dojo/back" class="jsdoc-link">dojo/back</a><span title="Must manually require () dojo/back to access" class="jsdoc-extension"></span>
- * </div>
- * <div class="jsdoc-full-summary"><p>Sets the state object and back callback for the very first page
- * that is loaded.
- * </p>
- * <p>It is recommended that you call this method as part of an event
- * listener that is registered via dojo/ready.</p>
- * </div>
- * <table class="jsdoc-parameters">
- * <tr>
- * <th>Parameter</th>
- * <th>Type</th>
- * <th>Description</th>
- * </tr>
- * <tr>
- * <td class="jsdoc-param-name">args</td>
- * <td class="jsdoc-param-type">Object</td>
- * <td class="jsdoc-param-description"><p>See the addToHistory() function for the list of valid args properties.</p>
- *
- * </td>
- * </tr>
- * </table>
- * </div>
- * </div>
- * </div>
- * </div><a href="https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dFlDcHEyaHMwbEd4MFBObkNrX0E1MFE6MQ&entry_0=/api/1.9/dojo/_base/kernel.back" class="feedback">Error in the documentation? Can't find what you are looking for? Let us know!</a>
- */
- init(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.cldr.html
- *
- *
- */
- interface cldr {
- /**
- * TODOC
- *
- */
- monetary: Object;
- /**
- * TODOC
- *
- */
- supplemental: Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.colors.html
- *
- *
- */
- interface colors {
- /**
- * creates a greyscale color with an optional alpha
- *
- * @param g
- * @param a Optional
- */
- makeGrey(g: number, a?: number): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.config.html
- *
- * This module defines the user configuration during bootstrap.
- * By defining user configuration as a module value, an entire configuration can be specified in a build,
- * thereby eliminating the need for sniffing and or explicitly setting in the global variable dojoConfig.
- * Also, when multiple instances of dojo exist in a single application, each will necessarily be located
- * at an unique absolute module identifier as given by the package configuration. Implementing configuration
- * as a module allows for specifying unique, per-instance configurations.
- *
- */
- interface config {
- /**
- * Adds a callback via dojo/ready. Useful when Dojo is added after
- * the page loads and djConfig.afterOnLoad is true. Supports the same
- * arguments as dojo/ready. When using a function reference, use
- * djConfig.addOnLoad = function(){};. For object with function name use
- * djConfig.addOnLoad = [myObject, "functionName"]; and for object with
- * function reference use
- * djConfig.addOnLoad = [myObject, function(){}];
- *
- */
- addOnLoad: Function;
- /**
- *
- */
- afterOnLoad: boolean;
- /**
- *
- */
- baseUrl: Object;
- /**
- * Defines a callback to be used when dependencies are defined before
- * the loader has been loaded. When provided, they cause the loader to
- * execute require(deps, callback) once it has finished loading.
- * Should be used with deps.
- *
- */
- callback: Function;
- /**
- *
- */
- debugContainerId: string;
- /**
- *
- */
- debugHeight: number;
- /**
- * Default duration, in milliseconds, for wipe and fade animations within dijits.
- * Assigned to dijit.defaultDuration.
- *
- */
- defaultDuration: number;
- /**
- * Whether deferred instrumentation should be loaded or included
- * in builds.
- *
- */
- deferredInstrumentation: boolean;
- /**
- * Defines dependencies to be used before the loader has been loaded.
- * When provided, they cause the loader to execute require(deps, callback)
- * once it has finished loading. Should be used with callback.
- *
- */
- deps: Function;
- /**
- * Used by some modules to configure an empty iframe. Used by dojo/io/iframe and
- * dojo/back, and dijit/popup support in IE where an iframe is needed to make sure native
- * controls do not bleed through the popups. Normally this configuration variable
- * does not need to be set, except when using cross-domain/CDN Dojo builds.
- * Save dojo/resources/blank.html to your domain and set djConfig.dojoBlankHtmlUrl
- * to the path on your domain your copy of blank.html.
- *
- */
- dojoBlankHtmlUrl: string;
- /**
- * No default value. Specifies additional locales whose
- * resources should also be loaded alongside the default locale when
- * calls to dojo.requireLocalization() are processed.
- *
- */
- extraLocale: any[];
- /**
- * Set this to true to enable publishing of topics for the different phases of
- * IO operations. Publishing is done via dojo/topic.publish(). See dojo/main.__IoPublish for a list
- * of topics that are published.
- *
- */
- ioPublish: Object;
- /**
- * Defaults to false. If set to true, ensures that Dojo provides
- * extended debugging feedback via Firebug. If Firebug is not available
- * on your platform, setting isDebug to true will force Dojo to
- * pull in (and display) the version of Firebug Lite which is
- * integrated into the Dojo distribution, thereby always providing a
- * debugging/logging console when isDebug is enabled. Note that
- * Firebug's console.* methods are ALWAYS defined by Dojo. If
- * isDebug is false and you are on a platform without Firebug, these
- * methods will be defined as no-ops.
- *
- */
- isDebug: boolean;
- /**
- * The locale to assume for loading localized resources in this page,
- * specified according to RFC 3066.
- * Must be specified entirely in lowercase, e.g. en-us and zh-cn.
- * See the documentation for dojo.i18n and dojo.requireLocalization
- * for details on loading localized resources. If no locale is specified,
- * Dojo assumes the locale of the user agent, according to navigator.userLanguage
- * or navigator.language properties.
- *
- */
- locale: string;
- /**
- * A map of module names to paths relative to dojo.baseUrl. The
- * key/value pairs correspond directly to the arguments which
- * dojo.registerModulePath accepts. Specifying
- * djConfig.modulePaths = { "foo": "../../bar" } is the equivalent
- * of calling dojo.registerModulePath("foo", "../../bar");. Multiple
- * modules may be configured via djConfig.modulePaths.
- *
- */
- modulePaths: Object;
- /**
- * Run the parser after the page is loaded
- *
- */
- parseOnLoad: boolean;
- /**
- * An array of module names to be loaded immediately after dojo.js has been included
- * in a page.
- *
- */
- require: Object;
- /**
- * Array containing the r, g, b components used as transparent color in dojo.Color;
- * if undefined, [255,255,255] (white) will be used.
- *
- */
- transparentColor: any[];
- /**
- * Used by dojox.analytics.Urchin as the default UA-123456-7 account
- * number used when being created. Alternately, you can pass an acct:""
- * parameter to the constructor a la: new dojox.analytics.Urchin({ acct:"UA-123456-7" });
- *
- */
- urchin: string;
- /**
- * If set to a value that evaluates to true such as a string or array and
- * isDebug is true and Firebug is not available or running, then it bypasses
- * the creation of Firebug Lite allowing you to define your own console object.
- *
- */
- useCustomLogger: Object;
- /**
- * Whether the deferred instrumentation should be used.
- *
- * "report-rejections": report each rejection as it occurs.
- * true or 1 or "report-unhandled-rejections": wait 1 second
- * in an attempt to detect unhandled rejections.
- *
- */
- useDeferredInstrumentation: boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.contentHandlers.html
- *
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls.
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls. Each contentHandler is
- * called, passing the xhr object for manipulation. The return value
- * from the contentHandler will be passed to the load or handle
- * functions defined in the original xhr call.
- *
- */
- interface contentHandlers {
- /**
- *
- * @param xhr
- */
- auto(xhr: any): void;
- /**
- * A contentHandler which evaluates the response data, expecting it to be valid JavaScript
- *
- * @param xhr
- */
- javascript(xhr: any): any;
- /**
- * A contentHandler which returns a JavaScript object created from the response data
- *
- * @param xhr
- */
- json(xhr: any): any;
- /**
- * A contentHandler which expects comment-filtered JSON.
- * A contentHandler which expects comment-filtered JSON.
- * the json-comment-filtered option was implemented to prevent
- * "JavaScript Hijacking", but it is less secure than standard JSON. Use
- * standard JSON instead. JSON prefixing can be used to subvert hijacking.
- *
- * Will throw a notice suggesting to use application/json mimetype, as
- * json-commenting can introduce security issues. To decrease the chances of hijacking,
- * use the standard json contentHandler, and prefix your "JSON" with: {}&&
- *
- * use djConfig.useCommentedJson = true to turn off the notice
- *
- * @param xhr
- */
- json_comment_filtered(xhr: any): any;
- /**
- * A contentHandler which checks the presence of comment-filtered JSON and
- * alternates between the json and json-comment-filtered contentHandlers.
- *
- * @param xhr
- */
- json_comment_optional(xhr: any): any;
- /**
- *
- * @param xhr
- */
- olson_zoneinfo(xhr: any): void;
- /**
- * A contentHandler which simply returns the plaintext response data
- *
- * @param xhr
- */
- text(xhr: any): any;
- /**
- * A contentHandler returning an XML Document parsed from the response data
- *
- * @param xhr
- */
- xml(xhr: any): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.dnd.html
- *
- *
- */
- interface dnd {
- /**
- * Used by dojo/dnd/Manager to scroll document or internal node when the user
- * drags near the edge of the viewport or a scrollable node
- *
- */
- autoscroll: Object;
- /**
- *
- */
- move: Object;
- /**
- *
- */
- AutoSource(): void;
- /**
- *
- */
- Avatar(): void;
- /**
- *
- */
- Container(): void;
- /**
- *
- */
- Manager(): void;
- /**
- *
- */
- Moveable(): void;
- /**
- *
- */
- Mover(): void;
- /**
- *
- */
- Selector(): void;
- /**
- *
- */
- Source(): void;
- /**
- *
- */
- Target(): void;
- /**
- *
- */
- TimedMoveable(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.date.html
- *
- *
- */
- interface date {
- /**
- * TODOC
- *
- */
- stamp: Object;
- /**
- * Add to a Date in intervals of different size, from milliseconds to years
- *
- * @param date Date object to start with
- * @param interval A string representing the interval. One of the following:"year", "month", "day", "hour", "minute", "second","millisecond", "quarter", "week", "weekday"
- * @param amount How much to add to the date.
- */
- add(date: Date, interval: String, amount: number): any;
- /**
- * Compare two date objects by date, time, or both.
- * Returns 0 if equal, positive if a > b, else negative.
- *
- * @param date1 Date object
- * @param date2 OptionalDate object. If not specified, the current Date is used.
- * @param portion OptionalA string indicating the "date" or "time" portion of a Date object.Compares both "date" and "time" by default. One of the following:"date", "time", "datetime"
- */
- compare(date1: Date, date2?: Date, portion?: String): number;
- /**
- * Get the difference in a specific unit of time (e.g., number of
- * months, weeks, days, etc.) between two dates, rounded to the
- * nearest integer.
- *
- * @param date1 Date object
- * @param date2 OptionalDate object. If not specified, the current Date is used.
- * @param interval OptionalA string representing the interval. One of the following:"year", "month", "day", "hour", "minute", "second","millisecond", "quarter", "week", "weekday"Defaults to "day".
- */
- difference(date1: Date, date2?: Date, interval?: String): any;
- /**
- * Returns the number of days in the month used by dateObject
- *
- * @param dateObject
- */
- getDaysInMonth(dateObject: Date): number;
- /**
- * Get the user's time zone as provided by the browser
- * Try to get time zone info from toString or toLocaleString method of
- * the Date object -- UTC offset is not a time zone. See
- * http://www.twinsun.com/tz/tz-link.htm Note: results may be
- * inconsistent across browsers.
- *
- * @param dateObject Needed because the timezone may vary with time (daylight savings)
- */
- getTimezoneName(dateObject: Date): any;
- /**
- * Determines if the year of the dateObject is a leap year
- * Leap years are years with an additional day YYYY-02-29, where the
- * year number is a multiple of four with the following exception: If
- * a year is a multiple of 100, then it is only a leap year if it is
- * also a multiple of 400. For example, 1900 was not a leap year, but
- * 2000 is one.
- *
- * @param dateObject
- */
- isLeapYear(dateObject: Date): boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.doc.html
- *
- * Alias for the current document. 'doc' can be modified
- * for temporary context shifting. See also withDoc().
- * Use this rather than referring to 'window.document' to ensure your code runs
- * correctly in managed contexts.
- *
- */
- interface doc {
- /**
- *
- */
- documentElement: Object;
- /**
- *
- */
- dojoClick: boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.data.html
- *
- *
- */
- interface data {
- /**
- *
- */
- api: Object;
- /**
- *
- */
- util: Object;
- /**
- *
- */
- ItemFileReadStore(): void;
- /**
- *
- */
- ItemFileWriteStore(): void;
- /**
- *
- */
- ObjectStore(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.currency.html
- *
- * localized formatting and parsing routines for currencies
- * extends dojo.number to provide culturally-appropriate formatting of values
- * in various world currencies, including use of a currency symbol. The currencies are specified
- * by a three-letter international symbol in all uppercase, and support for the currencies is
- * provided by the data in dojo.cldr. The scripts generating dojo.cldr specify which
- * currency support is included. A fixed number of decimal places is determined based
- * on the currency type and is not determined by the 'pattern' argument. The fractional
- * portion is optional, by default, and variable length decimals are not supported.
- *
- */
- interface currency {
- /**
- * Format a Number as a currency, using locale-specific settings
- * Create a string from a Number using a known, localized pattern.
- * Formatting patterns
- * appropriate to the locale are chosen from the CLDR
- * as well as the appropriate symbols and delimiters and number of decimal places.
- *
- * @param value the number to be formatted.
- * @param options Optional
- */
- format(value: number, options: dojo.currency.__FormatOptions): any;
- /**
- *
- * @param expression
- * @param options OptionalAn object with the following properties:type (String, optional): Should not be set. Value is assumed to be currency.currency (String, optional): an ISO4217 currency code, a three letter sequence like "USD".For use with dojo.currency only.symbol (String, optional): localized currency symbol. The default will be looked up in table of supported currencies in dojo.cldrA ISO4217 currency code will be used if not found.places (Number, optional): fixed number of decimal places to accept. The default is determined based on which currency is used.fractional (Boolean|Array, optional): Whether to include the fractional portion, where the number of decimal places are implied by the currencyor explicit 'places' parameter. The value [true,false] makes the fractional portion optional.By default for currencies, it the fractional portion is optional.pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization. Literal characters in patterns are not supported.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separators
- */
- parse(expression: String, options?: Object): any;
- /**
- *
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separatorsplaces (Number|String, optional): number of decimal places to accept: Infinity, a positive number, ora range "n,m". Defined by pattern or Infinity if pattern not provided.
- */
- regexp(options: Object): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.dijit.html
- *
- *
- */
- interface dijit {
- /**
- *
- */
- form: Object;
- /**
- *
- */
- layout: Object;
- /**
- * W3C range API
- *
- */
- range: Object;
- /**
- *
- */
- registry: Object;
- /**
- *
- */
- tree: Object;
- /**
- *
- * @param id
- */
- byId(id: any): any;
- /**
- *
- */
- Calendar(): void;
- /**
- *
- */
- CalendarLite(): void;
- /**
- *
- */
- CheckedMenuItem(): void;
- /**
- *
- */
- ColorPalette(): void;
- /**
- *
- */
- Declaration(): void;
- /**
- *
- */
- Destroyable(): void;
- /**
- *
- */
- Dialog(): void;
- /**
- *
- */
- DialogUnderlay(): void;
- /**
- *
- */
- DropDownMenu(): void;
- /**
- *
- */
- Dye(): void;
- /**
- *
- */
- Editor(): void;
- /**
- *
- */
- Fieldset(): void;
- /**
- *
- */
- InlineEditBox(): void;
- /**
- *
- */
- Menu(): void;
- /**
- *
- */
- MenuBar(): void;
- /**
- *
- */
- MenuBarItem(): void;
- /**
- *
- */
- MenuItem(): void;
- /**
- *
- */
- MenuSeparator(): void;
- /**
- *
- */
- PopupMenuBarItem(): void;
- /**
- *
- */
- PopupMenuItem(): void;
- /**
- *
- */
- ProgressBar(): void;
- /**
- *
- */
- RadioButtonMenuItem(): void;
- /**
- *
- */
- TitlePane(): void;
- /**
- *
- */
- Toolbar(): void;
- /**
- *
- */
- ToolbarSeparator(): void;
- /**
- *
- */
- Tooltip(): void;
- /**
- *
- */
- TooltipDialog(): void;
- /**
- *
- */
- Tree(): void;
- /**
- *
- */
- WidgetSet(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.global.html
- *
- * Alias for the current window. 'global' can be modified
- * for temporary context shifting. See also withGlobal().
- * Use this rather than referring to 'window' to ensure your code runs
- * correctly in managed contexts.
- *
- */
- interface global {
- /**
- *
- */
- $(): any;
- /**
- *
- * @param start
- * @param data
- * @param responseCode
- * @param errorMsg
- */
- GoogleSearchStoreCallback_undefined_NaN(start: any, data: any, responseCode: any, errorMsg: any): void;
- /**
- *
- */
- jQuery(): any;
- /**
- *
- */
- swfIsInHTML(): void;
- /**
- *
- */
- undefined_onload(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.gears.html
- *
- * TODOC
- *
- */
- interface gears {
- /**
- * True if client is using Google Gears
- *
- */
- available: Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.fx.html
- *
- * Effects library on top of Base animations
- *
- */
- interface fx {
- /**
- * Collection of easing functions to use beyond the default
- * dojo._defaultEasing function.
- *
- */
- easing: Object;
- /**
- * Chain a list of dojo/_base/fx.Animations to run in sequence
- * Return a dojo/_base/fx.Animation which will play all passed
- * dojo/_base/fx.Animation instances in sequence, firing its own
- * synthesized events simulating a single animation. (eg:
- * onEnd of this animation means the end of the chain,
- * not the individual animations within)
- *
- * @param animations
- */
- chain(animations: dojo._base.fx.Animation[]): any;
- /**
- * Combine a list of dojo/_base/fx.Animations to run in parallel
- * Combine an array of dojo/_base/fx.Animations to run in parallel,
- * providing a new dojo/_base/fx.Animation instance encompasing each
- * animation, firing standard animation events.
- *
- * @param animations
- */
- combine(animations: dojo._base.fx.Animation[]): any;
- /**
- * Slide a node to a new top/left position
- * Returns an animation that will slide "node"
- * defined in args Object from its current position to
- * the position defined by (args.left, args.top).
- *
- * @param args A hash-map of standard dojo/_base/fx.Animation constructor properties(such as easing: node: duration: and so on). Special args membersare top and left, which indicate the new position to slide to.
- */
- slideTo(args: Object): any;
- /**
- *
- */
- Toggler(): void;
- /**
- * Expand a node to it's natural height.
- * Returns an animation that will expand the
- * node defined in 'args' object from it's current height to
- * it's natural height (with no scrollbar).
- * Node must have no margin/border/padding.
- *
- * @param args A hash-map of standard dojo/_base/fx.Animation constructor properties(such as easing: node: duration: and so on)
- */
- wipeIn(args: Object): any;
- /**
- * Shrink a node to nothing and hide it.
- * Returns an animation that will shrink node defined in "args"
- * from it's current height to 1px, and then hide it.
- *
- * @param args A hash-map of standard dojo/_base/fx.Animation constructor properties(such as easing: node: duration: and so on)
- */
- wipeOut(args: Object): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.html.html
- *
- * TODOC
- *
- */
- interface html {
- /**
- * inserts (replaces) the given content into the given node. dojo/dom-construct.place(cont, node, "only")
- * may be a better choice for simple HTML insertion.
- * Unless you need to use the params capabilities of this method, you should use
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct..place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct..place does not handle NodeList insertions
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct.place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct.place does not handle NodeList insertions
- * or the other capabilities as defined by the params object for this method.
- *
- * @param node the parent element that will receive the content
- * @param cont the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param params OptionalOptional flags/properties to configure the content-setting. See dojo/html/_ContentSetter
- */
- set(node: HTMLElement, cont: String, params?: Object): any;
- /**
- * inserts (replaces) the given content into the given node. dojo/dom-construct.place(cont, node, "only")
- * may be a better choice for simple HTML insertion.
- * Unless you need to use the params capabilities of this method, you should use
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct..place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct..place does not handle NodeList insertions
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct.place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct.place does not handle NodeList insertions
- * or the other capabilities as defined by the params object for this method.
- *
- * @param node the parent element that will receive the content
- * @param cont the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param params OptionalOptional flags/properties to configure the content-setting. See dojo/html/_ContentSetter
- */
- set(node: HTMLElement, cont: HTMLElement, params?: Object): any;
- /**
- * inserts (replaces) the given content into the given node. dojo/dom-construct.place(cont, node, "only")
- * may be a better choice for simple HTML insertion.
- * Unless you need to use the params capabilities of this method, you should use
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct..place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct..place does not handle NodeList insertions
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct.place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct.place does not handle NodeList insertions
- * or the other capabilities as defined by the params object for this method.
- *
- * @param node the parent element that will receive the content
- * @param cont the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param params OptionalOptional flags/properties to configure the content-setting. See dojo/html/_ContentSetter
- */
- set(node: HTMLElement, cont: NodeList, params?: Object): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.io.html
- *
- *
- */
- interface io {
- /**
- *
- */
- iframe: Object;
- /**
- * TODOC
- *
- */
- script: Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.dojox.html
- *
- *
- */
- interface dojox {
- /**
- *
- */
- analytics: Object;
- /**
- *
- */
- app: Object;
- /**
- *
- */
- atom: Object;
- /**
- *
- */
- av: Object;
- /**
- *
- */
- BidiComplex: Object;
- /**
- *
- */
- calc: Object;
- /**
- *
- */
- calendar: Object;
- /**
- *
- */
- charting: Object;
- /**
- *
- */
- collections: Object;
- /**
- *
- */
- color: Object;
- /**
- *
- */
- css3: Object;
- /**
- *
- */
- data: Object;
- /**
- *
- */
- date: Object;
- /**
- *
- */
- dgauges: Object;
- /**
- *
- */
- dnd: Object;
- /**
- *
- */
- drawing: Object;
- /**
- *
- */
- dtl: Object;
- /**
- *
- */
- editor: Object;
- /**
- *
- */
- embed: Object;
- /**
- *
- */
- encoding: Object;
- /**
- *
- */
- enhanced: Object;
- /**
- * Utilities to embed and communicate with the Flash player from Javascript
- *
- */
- flash: Object;
- /**
- *
- */
- form: Object;
- /**
- *
- */
- fx: Object;
- /**
- *
- */
- gantt: Object;
- /**
- *
- */
- gauges: Object;
- /**
- *
- */
- geo: Object;
- /**
- *
- */
- gesture: Object;
- /**
- *
- */
- gfx: Object;
- /**
- *
- */
- gfx3d: Object;
- /**
- *
- */
- grid: Object;
- /**
- *
- */
- help: Object;
- /**
- *
- */
- highlight: Object;
- /**
- *
- */
- html: Object;
- /**
- *
- */
- image: Object;
- /**
- *
- */
- io: Object;
- /**
- *
- */
- jq: Object;
- /**
- *
- */
- json: Object;
- /**
- *
- */
- jsonPath: Object;
- /**
- *
- */
- lang: Object;
- /**
- *
- */
- layout: Object;
- /**
- *
- */
- math: Object;
- /**
- *
- */
- mdnd: Object;
- /**
- *
- */
- mobile: Object;
- /**
- *
- */
- mvc: Object;
- /**
- *
- */
- openlayers: Object;
- /**
- *
- */
- rails: Object;
- /**
- *
- */
- robot: Object;
- /**
- *
- */
- rpc: Object;
- /**
- *
- */
- secure: Object;
- /**
- *
- */
- sketch: Object;
- /**
- *
- */
- sql: Object;
- /**
- *
- */
- string: Object;
- /**
- *
- */
- testing: Object;
- /**
- *
- */
- timing: Object;
- /**
- *
- */
- treemap: Object;
- /**
- *
- */
- uuid: Object;
- /**
- *
- */
- validate: Object;
- /**
- *
- */
- widget: Object;
- /**
- *
- */
- xml: Object;
- /**
- * Provides a simple socket connection using WebSocket, or alternate
- * communication mechanisms in legacy browsers for comet-style communication. This is based
- * on the WebSocket API and returns an object that implements the WebSocket interface:
- * http://dev.w3.org/html5/websockets/#websocket
- * Provides socket connections. This can be used with virtually any Comet protocol.
- *
- * @param argsOrUrl This uses the same arguments as the other I/O functions in Dojo, or aURL to connect to. The URL should be a relative URL in order to properlywork with WebSockets (it can still be host relative, like //other-site.org/endpoint)
- */
- socket(argsOrUrl: Object): any;
- /**
- *
- * @param format
- * @param filler
- */
- sprintf(format: String, filler: any): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.i18n.html
- *
- * This module implements the dojo/i18n! plugin and the v1.6- i18n API
- * We choose to include our own plugin to leverage functionality already contained in dojo
- * and thereby reduce the size of the plugin compared to various loader implementations. Also, this
- * allows foreign AMD loaders to be used without their plugins.
- *
- */
- interface i18n {
- /**
- *
- */
- cache: Object;
- /**
- *
- */
- dynamic: boolean;
- /**
- *
- */
- unitTests: any[];
- /**
- *
- * @param moduleName
- * @param bundleName
- * @param locale
- */
- getL10nName(moduleName: any, bundleName: any, locale: any): String;
- /**
- *
- * @param moduleName
- * @param bundleName
- * @param locale
- */
- getLocalization(moduleName: any, bundleName: any, locale: any): any;
- /**
- * id is in one of the following formats
- *
- * /nls/
- * => load the bundle, localized to config.locale; load all bundles localized to
- * config.extraLocale (if any); return the loaded bundle localized to config.locale.
- * /nls//
- * => load then return the bundle localized to
- * preload/nls//
- * => for config.locale and all config.extraLocale, load all bundles found
- * in the best-matching bundle rollup. A value of 1 is returned, which
- * is meaningless other than to say the plugin is executing the requested
- * preloads
- *
- * In cases 1 and 2, is always normalized to an absolute module id upon entry; see
- * normalize. In case 3, it is assumed to be absolute; this is arranged by the builder.
- *
- * To load a bundle means to insert the bundle into the plugin's cache and publish the bundle
- * value to the loader. Given , , and a particular , the cache key
- *
- * <path>/nls/<bundle>/<locale>
- * will hold the value. Similarly, then plugin will publish this value to the loader by
- *
- * define("<path>/nls/<bundle>/<locale>", <bundle-value>);
- * Given this algorithm, other machinery can provide fast load paths be preplacing
- * values in the plugin's cache, which is public. When a load is demanded the
- * cache is inspected before starting any loading. Explicitly placing values in the plugin
- * cache is an advanced/experimental feature that should not be needed; use at your own risk.
- *
- * For the normal AMD algorithm, the root bundle is loaded first, which instructs the
- * plugin what additional localized bundles are required for a particular locale. These
- * additional locales are loaded and a mix of the root and each progressively-specific
- * locale is returned. For example:
- *
- * The client demands "dojo/i18n!some/path/nls/someBundle
- * The loader demands load(some/path/nls/someBundle)
- * This plugin require's "some/path/nls/someBundle", which is the root bundle.
- * Assuming config.locale is "ab-cd-ef" and the root bundle indicates that localizations
- * are available for "ab" and "ab-cd-ef" (note the missing "ab-cd", then the plugin
- * requires "some/path/nls/ab/someBundle" and "some/path/nls/ab-cd-ef/someBundle"
- * Upon receiving all required bundles, the plugin constructs the value of the bundle
- * ab-cd-ef as...
- * mixin(mixin(mixin({}, require("some/path/nls/someBundle"),
- * require("some/path/nls/ab/someBundle")),
- * require("some/path/nls/ab-cd-ef/someBundle"));
- *
- * This value is inserted into the cache and published to the loader at the
- * key/module-id some/path/nls/someBundle/ab-cd-ef.
- *
- * The special preload signature (case 3) instructs the plugin to stop servicing all normal requests
- * (further preload requests will be serviced) until all ongoing preloading has completed.
- *
- * The preload signature instructs the plugin that a special rollup module is available that contains
- * one or more flattened, localized bundles. The JSON array of available locales indicates which locales
- * are available. Here is an example:
- *
- * *preload*some/path/nls/someModule*["root", "ab", "ab-cd-ef"]
- * This indicates the following rollup modules are available:
- *
- * some/path/nls/someModule_ROOT
- * some/path/nls/someModule_ab
- * some/path/nls/someModule_ab-cd-ef
- * Each of these modules is a normal AMD module that contains one or more flattened bundles in a hash.
- * For example, assume someModule contained the bundles some/bundle/path/someBundle and
- * some/bundle/path/someOtherBundle, then some/path/nls/someModule_ab would be expressed as follows:
- *
- * define({
- * some/bundle/path/someBundle:<value of someBundle, flattened with respect to locale ab>,
- * some/bundle/path/someOtherBundle:<value of someOtherBundle, flattened with respect to locale ab>,
- * });
- * E.g., given this design, preloading for locale=="ab" can execute the following algorithm:
- *
- * require(["some/path/nls/someModule_ab"], function(rollup){
- * for(var p in rollup){
- * var id = p + "/ab",
- * cache[id] = rollup[p];
- * define(id, rollup[p]);
- * }
- * });
- * Similarly, if "ab-cd" is requested, the algorithm can determine that "ab" is the best available and
- * load accordingly.
- *
- * The builder will write such rollups for every layer if a non-empty localeList profile property is
- * provided. Further, the builder will include the following cache entry in the cache associated with
- * any layer.
- *
- * "*now":function(r){r(['dojo/i18n!*preload*<path>/nls/<module>*<JSON array of available locales>']);}
- * The *now special cache module instructs the loader to apply the provided function to context-require
- * with respect to the particular layer being defined. This causes the plugin to hold all normal service
- * requests until all preloading is complete.
- *
- * Notice that this algorithm is rarely better than the standard AMD load algorithm. Consider the normal case
- * where the target locale has a single segment and a layer depends on a single bundle:
- *
- * Without Preloads:
- *
- * Layer loads root bundle.
- * bundle is demanded; plugin loads single localized bundle.
- * With Preloads:
- *
- * Layer causes preloading of target bundle.
- * bundle is demanded; service is delayed until preloading complete; bundle is returned.
- * In each case a single transaction is required to load the target bundle. In cases where multiple bundles
- * are required and/or the locale has multiple segments, preloads still requires a single transaction whereas
- * the normal path requires an additional transaction for each additional bundle/locale-segment. However all
- * of these additional transactions can be done concurrently. Owing to this analysis, the entire preloading
- * algorithm can be discard during a build by setting the has feature dojo-preload-i18n-Api to false.
- *
- * @param id
- * @param require
- * @param load
- */
- load(id: any, require: any, load: any): void;
- /**
- * id may be relative.
- * preload has form *preload*<path>/nls/<module>*<flattened locales> and
- * therefore never looks like a relative
- *
- * @param id
- * @param toAbsMid
- */
- normalize(id: any, toAbsMid: any): any;
- /**
- *
- * @param locale
- */
- normalizeLocale(locale: any): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.mouseButtons.html
- *
- *
- */
- interface mouseButtons {
- /**
- * Numeric value of the left mouse button for the platform.
- *
- */
- LEFT: number;
- /**
- * Numeric value of the middle mouse button for the platform.
- *
- */
- MIDDLE: number;
- /**
- * Numeric value of the right mouse button for the platform.
- *
- */
- RIGHT: number;
- /**
- * Checks an event object for a pressed button
- *
- * @param e Event object to examine
- * @param button The button value (example: dojo.mouseButton.LEFT)
- */
- isButton(e: Event, button: number): boolean;
- /**
- * Checks an event object for the pressed left button
- *
- * @param e Event object to examine
- */
- isLeft(e: Event): boolean;
- /**
- * Checks an event object for the pressed middle button
- *
- * @param e Event object to examine
- */
- isMiddle(e: Event): boolean;
- /**
- * Checks an event object for the pressed right button
- *
- * @param e Event object to examine
- */
- isRight(e: Event): boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.rpc.html
- *
- *
- */
- interface rpc {
- /**
- *
- */
- JsonpService(): void;
- /**
- *
- */
- JsonService(): void;
- /**
- *
- */
- RpcService(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.regexp.html
- *
- * Regular expressions and Builder resources
- *
- */
- interface regexp {
- /**
- * Builds a regular expression that groups subexpressions
- * A utility function used by some of the RE generators. The
- * subexpressions are constructed by the function, re, in the second
- * parameter. re builds one subexpression for each elem in the array
- * a, in the first parameter. Returns a string for a regular
- * expression that groups all the subexpressions.
- *
- * @param arr A single value or an array of values.
- * @param re A function. Takes one parameter and converts it to a regularexpression.
- * @param nonCapture OptionalIf true, uses non-capturing match, otherwise matches are retainedby regular expression. Defaults to false
- */
- buildGroupRE(arr: Object, re: Function, nonCapture?: boolean): any;
- /**
- * Builds a regular expression that groups subexpressions
- * A utility function used by some of the RE generators. The
- * subexpressions are constructed by the function, re, in the second
- * parameter. re builds one subexpression for each elem in the array
- * a, in the first parameter. Returns a string for a regular
- * expression that groups all the subexpressions.
- *
- * @param arr A single value or an array of values.
- * @param re A function. Takes one parameter and converts it to a regularexpression.
- * @param nonCapture OptionalIf true, uses non-capturing match, otherwise matches are retainedby regular expression. Defaults to false
- */
- buildGroupRE(arr: any[], re: Function, nonCapture?: boolean): any;
- /**
- * Adds escape sequences for special characters in regular expressions
- *
- * @param str
- * @param except Optionala String with special characters to be left unescaped
- */
- escapeString(str: String, except?: String): any;
- /**
- * adds group match to expression
- *
- * @param expression
- * @param nonCapture OptionalIf true, uses non-capturing match, otherwise matches are retainedby regular expression.
- */
- group(expression: String, nonCapture?: boolean): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.number.html
- *
- * localized formatting and parsing routines for Number
- *
- */
- interface number_ {
- /**
- * Format a Number as a String, using locale-specific settings
- * Create a string from a Number using a known localized pattern.
- * Formatting patterns appropriate to the locale are chosen from the
- * Common Locale Data Repository as well as the appropriate symbols and
- * delimiters.
- * If value is Infinity, -Infinity, or is not a valid JavaScript number, return null.
- *
- * @param value the number to be formatted
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization. Literal characters in patterns are not supported.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.places (Number, optional): fixed number of decimal places to show. This overrides anyinformation in the provided pattern.round (Number, optional): 5 rounds to nearest .5; 0 rounds to nearest whole (default). -1means do not round.locale (String, optional): override the locale used to determine formatting rulesfractional (Boolean, optional): If false, show no decimal places, overriding places and pattern settings.
- */
- format(value: number, options?: Object): any;
- /**
- * Convert a properly formatted string to a primitive Number, using
- * locale-specific settings.
- * Create a Number from a string using a known localized pattern.
- * Formatting patterns are chosen appropriate to the locale
- * and follow the syntax described by
- * unicode.org TR35
- * Note that literal characters in patterns are not supported.
- *
- * @param expression A string representation of a Number
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization. Literal characters in patterns are not supported.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separatorsfractional (Boolean|Array, optional): Whether to include the fractional portion, where the number of decimal places are implied by patternor explicit 'places' parameter. The value [true,false] makes the fractional portion optional.
- */
- parse(expression: String, options?: Object): number;
- /**
- * Builds the regular needed to parse a number
- * Returns regular expression with positive and negative match, group
- * and decimal separators
- *
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separatorsplaces (Number|String, optional): number of decimal places to accept: Infinity, a positive number, ora range "n,m". Defined by pattern or Infinity if pattern not provided.
- */
- regexp(options: Object): any;
- /**
- * Rounds to the nearest value with the given number of decimal places, away from zero
- * Rounds to the nearest value with the given number of decimal places, away from zero if equal.
- * Similar to Number.toFixed(), but compensates for browser quirks. Rounding can be done by
- * fractional increments also, such as the nearest quarter.
- * NOTE: Subject to floating point errors. See dojox/math/round for experimental workaround.
- *
- * @param value The number to round
- * @param places OptionalThe number of decimal places where rounding takes place. Defaults to 0 for whole rounding.Must be non-negative.
- * @param increment OptionalRounds next place to nearest value of increment/10. 10 by default.
- */
- round(value: number, places?: number, increment?: number): number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.scopeMap.html
- *
- *
- */
- interface scopeMap {
- /**
- *
- */
- dijit: any[];
- /**
- *
- */
- dojo: any[];
- /**
- *
- */
- dojox: any[];
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.tests.html
- *
- * D.O.H. Test files for Dojo unit testing.
- *
- */
- interface tests {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.keys.html
- *
- * Definitions for common key values. Client code should test keyCode against these named constants,
- * as the actual codes can vary by browser.
- *
- */
- interface keys {
- /**
- *
- */
- ALT: number;
- /**
- *
- */
- BACKSPACE: number;
- /**
- *
- */
- CAPS_LOCK: number;
- /**
- *
- */
- CLEAR: number;
- /**
- *
- */
- copyKey: number;
- /**
- *
- */
- CTRL: number;
- /**
- *
- */
- DELETE: number;
- /**
- *
- */
- DOWN_ARROW: number;
- /**
- *
- */
- DOWN_DPAD: number;
- /**
- *
- */
- END: number;
- /**
- *
- */
- ENTER: number;
- /**
- *
- */
- ESCAPE: number;
- /**
- *
- */
- F1: number;
- /**
- *
- */
- F10: number;
- /**
- *
- */
- F11: number;
- /**
- *
- */
- F12: number;
- /**
- *
- */
- F13: number;
- /**
- *
- */
- F14: number;
- /**
- *
- */
- F15: number;
- /**
- *
- */
- F2: number;
- /**
- *
- */
- F3: number;
- /**
- *
- */
- F4: number;
- /**
- *
- */
- F5: number;
- /**
- *
- */
- F6: number;
- /**
- *
- */
- F7: number;
- /**
- *
- */
- F8: number;
- /**
- *
- */
- F9: number;
- /**
- *
- */
- HELP: number;
- /**
- *
- */
- HOME: number;
- /**
- *
- */
- INSERT: number;
- /**
- *
- */
- LEFT_ARROW: number;
- /**
- *
- */
- LEFT_DPAD: number;
- /**
- *
- */
- LEFT_WINDOW: number;
- /**
- *
- */
- META: number;
- /**
- *
- */
- NUM_LOCK: number;
- /**
- *
- */
- NUMPAD_0: number;
- /**
- *
- */
- NUMPAD_1: number;
- /**
- *
- */
- NUMPAD_2: number;
- /**
- *
- */
- NUMPAD_3: number;
- /**
- *
- */
- NUMPAD_4: number;
- /**
- *
- */
- NUMPAD_5: number;
- /**
- *
- */
- NUMPAD_6: number;
- /**
- *
- */
- NUMPAD_7: number;
- /**
- *
- */
- NUMPAD_8: number;
- /**
- *
- */
- NUMPAD_9: number;
- /**
- *
- */
- NUMPAD_DIVIDE: number;
- /**
- *
- */
- NUMPAD_ENTER: number;
- /**
- *
- */
- NUMPAD_MINUS: number;
- /**
- *
- */
- NUMPAD_MULTIPLY: number;
- /**
- *
- */
- NUMPAD_PERIOD: number;
- /**
- *
- */
- NUMPAD_PLUS: number;
- /**
- *
- */
- PAGE_DOWN: number;
- /**
- *
- */
- PAGE_UP: number;
- /**
- *
- */
- PAUSE: number;
- /**
- *
- */
- RIGHT_ARROW: number;
- /**
- *
- */
- RIGHT_DPAD: number;
- /**
- *
- */
- RIGHT_WINDOW: number;
- /**
- *
- */
- SCROLL_LOCK: number;
- /**
- *
- */
- SELECT: number;
- /**
- *
- */
- SHIFT: number;
- /**
- *
- */
- SPACE: number;
- /**
- *
- */
- TAB: number;
- /**
- *
- */
- UP_ARROW: number;
- /**
- *
- */
- UP_DPAD: number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.store.html
- *
- *
- */
- interface store {
- /**
- *
- */
- util: Object;
- /**
- *
- * @param masterStore
- * @param cachingStore
- * @param options
- */
- Cache(masterStore: any, cachingStore: any, options: any): any;
- /**
- *
- */
- DataStore(): void;
- /**
- *
- */
- JsonRest(): void;
- /**
- *
- */
- Memory(): void;
- /**
- * The Observable store wrapper takes a store and sets an observe method on query()
- * results that can be used to monitor results for changes.
- * Observable wraps an existing store so that notifications can be made when a query
- * is performed.
- *
- * @param store
- */
- Observable(store: dojo.store.api.Store): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.string.html
- *
- * String utilities for Dojo
- *
- */
- interface string_ {
- /**
- * Pad a string to guarantee that it is at least size length by
- * filling with the character ch at either the start or end of the
- * string. Pads at the start, by default.
- *
- * @param text the string to pad
- * @param size length to provide padding
- * @param ch Optionalcharacter to pad, defaults to '0'
- * @param end Optionaladds padding at the end if true, otherwise pads at start
- */
- pad(text: String, size: number, ch?: String, end?: boolean): number;
- /**
- * Efficiently replicate a string n times.
- *
- * @param str the string to replicate
- * @param num number of times to replicate the string
- */
- rep(str: String, num: number): String;
- /**
- * Performs parameterized substitutions on a string. Throws an
- * exception if any parameter is unmatched.
- *
- * @param template a string with expressions in the form ${key} to be replaced or${key:format} which specifies a format function. keys are case-sensitive.
- * @param map hash to search for substitutions
- * @param transform Optionala function to process all parameters before substitution takesplace, e.g. mylib.encodeXML
- * @param thisObject Optionalwhere to look for optional format function; default to the globalnamespace
- */
- substitute(template: String, map: Object, transform?: Function, thisObject?: Object): any;
- /**
- * Performs parameterized substitutions on a string. Throws an
- * exception if any parameter is unmatched.
- *
- * @param template a string with expressions in the form ${key} to be replaced or${key:format} which specifies a format function. keys are case-sensitive.
- * @param map hash to search for substitutions
- * @param transform Optionala function to process all parameters before substitution takesplace, e.g. mylib.encodeXML
- * @param thisObject Optionalwhere to look for optional format function; default to the globalnamespace
- */
- substitute(template: String, map: any[], transform?: Function, thisObject?: Object): any;
- /**
- * Trims whitespace from both sides of the string
- * This version of trim() was taken from Steven Levithan's blog.
- * The short yet performant version of this function is dojo/_base/lang.trim(),
- * which is part of Dojo base. Uses String.prototype.trim instead, if available.
- *
- * @param str String to be trimmed
- */
- trim(str: String): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.version.html
- *
- * Version number of the Dojo Toolkit
- * Hash about the version, including
- *
- * major: Integer: Major version. If total version is "1.2.0beta1", will be 1
- * minor: Integer: Minor version. If total version is "1.2.0beta1", will be 2
- * patch: Integer: Patch version. If total version is "1.2.0beta1", will be 0
- * flag: String: Descriptor flag. If total version is "1.2.0beta1", will be "beta1"
- * revision: Number: The Git rev from which dojo was pulled
- *
- */
- interface version {
- /**
- *
- */
- flag: string;
- /**
- *
- */
- major: number;
- /**
- *
- */
- minor: number;
- /**
- *
- */
- patch: number;
- /**
- *
- */
- revision: number;
- /**
- *
- */
- toString(): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.touch.html
- *
- * This module provides unified touch event handlers by exporting
- * press, move, release and cancel which can also run well on desktop.
- * Based on http://dvcs.w3.org/hg/webevents/raw-file/tip/touchevents.html
- * Also, if the dojoClick property is set to truthy on a DOM node, dojo/touch generates
- * click events immediately for this node and its descendants (except for descendants that
- * have a dojoClick property set to falsy), to avoid the delay before native browser click events,
- * and regardless of whether evt.preventDefault() was called in a touch.press event listener.
- *
- */
- interface touch {
- /**
- * Register a listener to 'touchcancel'|'mouseleave' for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- cancel(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to mouse.enter or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- enter(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to mouse.leave or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- leave(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener that fires when the mouse cursor or a finger is dragged over the given node.
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- move(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to 'mouseout' or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- out(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to 'mouseover' or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- over(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to 'touchstart'|'mousedown' for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- press(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to releasing the mouse button while the cursor is over the given node
- * (i.e. "mouseup") or for removing the finger from the screen while touching the given node.
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- release(node: HTMLElement, listener: Function): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/_base/kernel.window.html
- *
- * TODOC
- *
- */
- interface window {
- /**
- * Get window object associated with document doc.
- *
- * @param doc The document to get the associated window for.
- */
- get(doc: HTMLDocument): any;
- /**
- * Returns the dimensions and scroll position of the viewable area of a browser window
- *
- * @param doc Optional
- */
- getBox(doc?: HTMLDocument): Object;
- /**
- * Scroll the passed node into view using minimal movement, if it is not already.
- *
- * @param node
- * @param pos Optional
- */
- scrollIntoView(node: HTMLElement, pos?: Object): void;
- }
- }
- }
- module _firebug {
- namespace firebug {
- }
- }
- namespace cldr {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/cldr/monetary.html
- *
- * TODOC
- *
- */
- interface monetary {
- /**
- * A mapping of currency code to currency-specific formatting information. Returns a unique object with properties: places, round.
- *
- * @param code an ISO 4217 currency code
- */
- getData(code: String): Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/cldr/supplemental.html
- *
- * TODOC
- *
- */
- interface supplemental {
- /**
- * Returns a zero-based index for first day of the week
- * Returns a zero-based index for first day of the week, as used by the local (Gregorian) calendar.
- * e.g. Sunday (returns 0), or Monday (returns 1)
- *
- * @param locale Optional
- */
- getFirstDayOfWeek(locale?: String): number;
- /**
- * Returns a hash containing the start and end days of the weekend
- * Returns a hash containing the start and end days of the weekend according to local custom using locale,
- * or by default in the user's locale.
- * e.g. {start:6, end:0}
- *
- * @param locale Optional
- */
- getWeekend(locale?: String): Object;
- }
- }
- namespace data {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/ItemFileReadStore.html
- *
- * The ItemFileReadStore implements the dojo/data/api/Read API and reads
- * data from JSON files that have contents in this format --
- *
- * { items: [
- * { name:'Kermit', color:'green', age:12, friends:['Gonzo', {_reference:{name:'Fozzie Bear'}}]},
- * { name:'Fozzie Bear', wears:['hat', 'tie']},
- * { name:'Miss Piggy', pets:'Foo-Foo'}
- * ]}
- * Note that it can also contain an 'identifier' property that specified which attribute on the items
- *
- * in the array of items that acts as the unique identifier for that item.
- *
- * @param keywordParameters {url: String} {data: jsonObject} {typeMap: object}The structure of the typeMap object is as follows:{ type0: function || object, type1: function || object, ... typeN: function || object}Where if it is a function, it is assumed to be an object constructor that takes thevalue of _value as the initialization parameters. If it is an object, then it is assumedto be an object of general form:{ type: function, //constructor. deserialize: function(value) //The function that parses the value and constructs the object defined by type appropriately.}
- */
- class ItemFileReadStore extends dojo.Evented {
- constructor(keywordParameters: Object);
- /**
- * Parameter to allow users to specify if a close call should force a reload or not.
- * By default, it retains the old behavior of not clearing if close is called. But
- * if set true, the store will be reset to default state. Note that by doing this,
- * all item handles will become invalid and a new fetch must be issued.
- *
- */
- "clearOnClose": boolean;
- /**
- *
- */
- "data": Object;
- /**
- * Parameter for specifying that it is OK for the xhrGet call to fail silently.
- *
- */
- "failOk": boolean;
- /**
- * Parameter to indicate to process data from the url as hierarchical
- * (data items can contain other data items in js form). Default is true
- * for backwards compatibility. False means only root items are processed
- * as items, all child objects outside of type-mapped objects and those in
- * specific reference format, are left straight JS data objects.
- *
- */
- "hierarchical": boolean;
- /**
- *
- */
- "typeMap": Object;
- /**
- *
- */
- "url": string;
- /**
- * Parameter to allow specifying if preventCache should be passed to the xhrGet call or not when loading data from a url.
- * Note this does not mean the store calls the server on each fetch, only that the data load has preventCache set as an option.
- * Added for tracker: #6072
- *
- */
- "urlPreventCache": boolean;
- /**
- * See dojo/data/api/Read.close()
- *
- * @param request Optional
- */
- close(request?: dojo.data.api.Request ): void;
- /**
- * See dojo/data/api/Read.close()
- *
- * @param request Optional
- */
- close(request?: Object): void;
- /**
- * See dojo/data/api/Read.containsValue()
- *
- * @param item
- * @param attribute
- * @param value
- */
- containsValue(item: dojo.data.api.Item, attribute: String, value: any): any;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- * The error handler when there is an error fetching items. This function should not be called
- * directly and is used by simpleFetch.fetch().
- *
- * @param errorData
- * @param requestObject
- */
- errorHandler(errorData: Object, requestObject: Object): void;
- /**
- * The simpleFetch mixin is designed to serve as a set of function(s) that can
- * be mixed into other datastore implementations to accelerate their development.
- * The simpleFetch mixin should work well for any datastore that can respond to a _fetchItems()
- * call by returning an array of all the found items that matched the query. The simpleFetch mixin
- * is not designed to work for datastores that respond to a fetch() call by incrementally
- * loading items, or sequentially loading partial batches of the result
- * set. For datastores that mixin simpleFetch, simpleFetch
- * implements a fetch method that automatically handles eight of the fetch()
- * arguments -- onBegin, onItem, onComplete, onError, start, count, sort and scope
- * The class mixing in simpleFetch should not implement fetch(),
- * but should instead implement a _fetchItems() method. The _fetchItems()
- * method takes three arguments, the keywordArgs object that was passed
- * to fetch(), a callback function to be called when the result array is
- * available, and an error callback to be called if something goes wrong.
- * The _fetchItems() method should ignore any keywordArgs parameters for
- * start, count, onBegin, onItem, onComplete, onError, sort, and scope.
- * The _fetchItems() method needs to correctly handle any other keywordArgs
- * parameters, including the query parameter and any optional parameters
- * (such as includeChildren). The _fetchItems() method should create an array of
- * result items and pass it to the fetchHandler along with the original request object --
- * or, the _fetchItems() method may, if it wants to, create an new request object
- * with other specifics about the request that are specific to the datastore and pass
- * that as the request object to the handler.
- *
- * For more information on this specific function, see dojo/data/api/Read.fetch()
- *
- * @param request OptionalThe keywordArgs parameter may either be an instance ofconforming to dojo/data/api/Request or may be a simple anonymous objectthat may contain any of the following:{ query: query-object or query-string, queryOptions: object, onBegin: Function, onItem: Function, onComplete: Function, onError: Function, scope: object, start: int count: int sort: array}All implementations should accept keywordArgs objects with any ofthe 9 standard properties: query, onBegin, onItem, onComplete, onErrorscope, sort, start, and count. Some implementations may accept additionalproperties in the keywordArgs object as valid parameters, such as{includeOutliers:true}.The query parameterThe query may be optional in some data store implementations.The dojo/data/api/Read API does not specify the syntax or semanticsof the query itself -- each different data store implementationmay have its own notion of what a query should look like.However, as of dojo 0.9, 1.0, and 1.1, all the provided datastores in dojo.dataand dojox.data support an object structure query, where the object is a set ofname/value parameters such as { attrFoo: valueBar, attrFoo1: valueBar1}. Most of thedijit widgets, such as ComboBox assume this to be the case when working with a datastorewhen they dynamically update the query. Therefore, for maximum compatibility with dijitwidgets the recommended query parameter is a key/value object. That does not mean that thethe datastore may not take alternative query forms, such as a simple string, a Date, a number,or a mix of such. Ultimately, The dojo/data/api/Read API is agnostic about what the queryformat.Further note: In general for query objects that accept strings as attributevalue matches, the store should also support basic filtering capability, such as (match any character) and ? (match single character). An example query that is a query objectwould be like: { attrFoo: "value"}. Which generally means match all items where they havean attribute named attrFoo, with a value that starts with 'value'.The queryOptions parameterThe queryOptions parameter is an optional parameter used to specify options that may modifythe query in some fashion, such as doing a case insensitive search, or doing a deep searchwhere all items in a hierarchical representation of data are scanned instead of just the rootitems. It currently defines two options that all datastores should attempt to honor if possible:{ ignoreCase: boolean, // Whether or not the query should match case sensitively or not. Default behaviour is false. deep: boolean // Whether or not a fetch should do a deep search of items and all child // items instead of just root-level items in a datastore. Default is false.}The onBegin parameter.function(size, request);If an onBegin callback function is provided, the callback functionwill be called just once, before the first onItem callback is called.The onBegin callback function will be passed two arguments, thethe total number of items identified and the Request object. If the total number isunknown, then size will be -1. Note that size is not necessarily the size of thecollection of items returned from the query, as the request may have specified to return only asubset of the total set of items through the use of the start and count parameters.The onItem parameter.function(item, request);If an onItem callback function is provided, the callback functionwill be called as each item in the result is received. The callbackfunction will be passed two arguments: the item itself, and theRequest object.The onComplete parameter.function(items, request);If an onComplete callback function is provided, the callback functionwill be called just once, after the last onItem callback is called.Note that if the onItem callback is not present, then onComplete will be passedan array containing all items which matched the query and the request object.If the onItem callback is present, then onComplete is called as:onComplete(null, request).The onError parameter.function(errorData, request);If an onError callback function is provided, the callback functionwill be called if there is any sort of error while attempting toexecute the query.The onError callback function will be passed two arguments:an Error object and the Request object.The scope parameter.If a scope object is provided, all of the callback functions (onItem,onComplete, onError, etc) will be invoked in the context of the scopeobject. In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global().For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global(), item, request)The start parameter.If a start parameter is specified, this is a indication to the datastore toonly start returning items once the start number of items have been located andskipped. When this parameter is paired with 'count', the store should be ableto page across queries with millions of hits by only returning subsets of thehits for each queryThe count parameter.If a count parameter is specified, this is a indication to the datastore toonly return up to that many items. This allows a fetch call that may havemillions of item matches to be paired down to something reasonable.The sort parameter.If a sort parameter is specified, this is a indication to the datastore tosort the items in some manner before returning the items. The array is an array ofjavascript objects that must conform to the following format to be applied to thefetching of items:{ attribute: attribute || attribute-name-string, descending: true|false; // Optional. Default is false.}Note that when comparing attributes, if an item contains no value for the attribute(undefined), then it the default ascending sort logic should push it to the bottomof the list. In the descending order case, it such items should appear at the top of the list.
- */
- fetch(request: Object): void;
- /**
- * The handler when items are sucessfully fetched. This function should not be called directly
- * and is used by simpleFetch.fetch().
- *
- * @param items
- * @param requestObject
- */
- fetchHandler(items: any[], requestObject: Object): void;
- /**
- * See dojo/data/api/Identity.fetchItemByIdentity()
- *
- * @param keywordArgs
- */
- fetchItemByIdentity(keywordArgs: Object): void;
- /**
- * This method handles the basic filtering needs for ItemFile* based stores.
- *
- * @param requestArgs
- * @param arrayOfItems
- * @param findCallback
- */
- filter(requestArgs: Object, arrayOfItems: any[], findCallback: Function): void;
- /**
- * See dojo/data/api/Read.getAttributes()
- *
- * @param item
- */
- getAttributes(item: dojo.data.api.Item): any[];
- /**
- * See dojo/data/api/Read.getFeatures()
- *
- */
- getFeatures(): any;
- /**
- * See dojo/data/api/Identity.getIdentity()
- *
- * @param item
- */
- getIdentity(item: dojo.data.api.Item): any;
- /**
- * See dojo/data/api/Identity.getIdentityAttributes()
- *
- * @param item
- */
- getIdentityAttributes(item: dojo.data.api.Item): any;
- /**
- * See dojo/data/api/Read.getLabel()
- *
- * @param item
- */
- getLabel(item: dojo.data.api.Item): any;
- /**
- * See dojo/data/api/Read.getLabelAttributes()
- *
- * @param item
- */
- getLabelAttributes(item: dojo.data.api.Item): any;
- /**
- * See dojo/data/api/Read.getValue()
- *
- * @param item
- * @param attribute
- * @param defaultValue Optional
- */
- getValue(item: dojo.data.api.Item, attribute: String, defaultValue?: any): any;
- /**
- * See dojo/data/api/Read.getValues()
- *
- * @param item
- * @param attribute
- */
- getValues(item: dojo.data.api.Item, attribute: String): any;
- /**
- * See dojo/data/api/Read.hasAttribute()
- *
- * @param item
- * @param attribute
- */
- hasAttribute(item: dojo.data.api.Item, attribute: String): boolean;
- /**
- * See dojo/data/api/Read.isItem()
- *
- * @param something
- */
- isItem(something: any): boolean;
- /**
- * See dojo/data/api/Read.isItemLoaded()
- *
- * @param something
- */
- isItemLoaded(something: any): any;
- /**
- * See dojo/data/api/Read.loadItem()
- *
- * @param keywordArgs
- */
- loadItem(keywordArgs: Object): void;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/ObjectStore.html
- *
- * A Dojo Data implementation that wraps Dojo object stores for backwards
- * compatibility.
- *
- * @param options The configuration information to pass into the data store.options.objectStore:The object store to use as the source provider for this data store
- */
- class ObjectStore extends dojo.Evented {
- constructor(options: any);
- /**
- *
- */
- "labelProperty": string;
- /**
- *
- */
- "objectStore": Object;
- /**
- * adds an object to the list of dirty objects. This object
- * contains a reference to the object itself as well as a
- * cloned and trimmed version of old object for use with
- * revert.
- *
- * @param object Indicates that the given object is changing and should be marked as dirty for the next save
- * @param _deleting
- */
- changing(object: Object, _deleting: boolean): void;
- /**
- * See dojo/data/api/Read.close()
- *
- * @param request
- */
- close(request: any): any;
- /**
- * Checks to see if 'item' has 'value' at 'attribute'
- *
- * @param item The item to check
- * @param attribute The attribute to check
- * @param value The value to look for
- */
- containsValue(item: Object, attribute: String, value: any): boolean;
- /**
- * deletes item and any references to that item from the store.
- *
- * @param item item to delete
- */
- deleteItem(item: any): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- * See dojo/data/api/Read.fetch()
- *
- * @param args
- */
- fetch(args: any): any;
- /**
- * fetch an item by its identity, by looking in our index of what we have loaded
- *
- * @param args
- */
- fetchItemByIdentity(args: any): any;
- /**
- * Gets the available attributes of an item's 'property' and returns
- * it as an array.
- *
- * @param item
- */
- getAttributes(item: Object): any[];
- /**
- * return the store feature set
- *
- */
- getFeatures(): Object;
- /**
- * returns the identity of the given item
- * See dojo/data/api/Read.getIdentity()
- *
- * @param item
- */
- getIdentity(item: any): any;
- /**
- * returns the attributes which are used to make up the
- * identity of an item. Basically returns this.objectStore.idProperty
- * See dojo/data/api/Read.getIdentityAttributes()
- *
- * @param item
- */
- getIdentityAttributes(item: any): any[];
- /**
- * See dojo/data/api/Read.getLabel()
- *
- * @param item
- */
- getLabel(item: dojo.data.api.Item): any;
- /**
- * See dojo/data/api/Read.getLabelAttributes()
- *
- * @param item
- */
- getLabelAttributes(item: dojo.data.api.Item): any[];
- /**
- * Gets the value of an item's 'property'
- *
- * @param item The item to get the value from
- * @param property property to look up value for
- * @param defaultValue Optionalthe default value
- */
- getValue(item: Object, property: String, defaultValue?: any): any;
- /**
- * Gets the value of an item's 'property' and returns
- * it. If this value is an array it is just returned,
- * if not, the value is added to an array and that is returned.
- *
- * @param item
- * @param property property to look up value for
- */
- getValues(item: Object, property: String): any[];
- /**
- * Checks to see if item has attribute
- *
- * @param item The item to check
- * @param attribute The attribute to check
- */
- hasAttribute(item: Object, attribute: String): boolean;
- /**
- * returns true if the item is marked as dirty or true if there are any dirty items
- *
- * @param item The item to check
- */
- isDirty(item: Object): any;
- /**
- * Checks to see if the argument is an item
- *
- * @param item The item to check
- */
- isItem(item: Object): boolean;
- /**
- * Checks to see if the item is loaded.
- *
- * @param item The item to check
- */
- isItemLoaded(item: Object): any;
- /**
- * Loads an item and calls the callback handler. Note, that this will call the callback
- * handler even if the item is loaded. Consequently, you can use loadItem to ensure
- * that an item is loaded is situations when the item may or may not be loaded yet.
- * If you access a value directly through property access, you can use this to load
- * a lazy value as well (doesn't need to be an item).
- *
- * @param args See dojo/data/api/Read.fetch()
- */
- loadItem(args: Object): any;
- /**
- * adds a new item to the store at the specified point.
- * Takes two parameters, data, and options.
- *
- * @param data See dojo/data/api/Write.newItem()
- * @param parentInfo
- */
- newItem(data: Object, parentInfo: any): Object;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * returns any modified data to its original state prior to a save();
- *
- */
- revert(): void;
- /**
- * Saves the dirty data using object store provider. See dojo/data/api/Write for API.
- *
- * @param kwArgs kwArgs.global:This will cause the save to commit the dirty data for allObjectStores as a single transaction.kwArgs.revertOnError:This will cause the changes to be reverted if there is anerror on the save. By default a revert is executed unlessa value of false is provide for this parameter.kwArgs.onError:Called when an error occurs in the commitkwArgs.onComplete:Called when an the save/commit is completed
- */
- save(kwArgs: any): void;
- /**
- * sets 'attribute' on 'item' to 'value'
- * See dojo/data/api/Write.setValue()
- *
- * @param item
- * @param attribute
- * @param value
- */
- setValue(item: any, attribute: any, value: any): void;
- /**
- * sets 'attribute' on 'item' to 'value' value
- * must be an array.
- * See dojo/data/api/Write.setValues()
- *
- * @param item
- * @param attribute
- * @param values
- */
- setValues(item: any, attribute: any, values: any): void;
- /**
- * unsets 'attribute' on 'item'
- * See dojo/data/api/Write.unsetAttribute()
- *
- * @param item
- * @param attribute
- */
- unsetAttribute(item: any, attribute: any): void;
- /**
- * See dojo/data/api/Notification.onDelete()
- *
- */
- onDelete(): void;
- /**
- * Called when a fetch occurs
- *
- * @param results
- */
- onFetch(results: any): void;
- /**
- * See dojo/data/api/Notification.onNew()
- *
- */
- onNew(): void;
- /**
- * See dojo/data/api/Notification.onSet()
- *
- */
- onSet(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/ItemFileWriteStore.html
- *
- * TODOC
- *
- * @param keywordParameters The structure of the typeMap object is as follows:{ type0: function || object, type1: function || object, ... typeN: function || object}Where if it is a function, it is assumed to be an object constructor that takes thevalue of _value as the initialization parameters. It is serialized assuming object.toString()serialization. If it is an object, then it is assumedto be an object of general form:{ type: function, //constructor. deserialize: function(value) //The function that parses the value and constructs the object defined by type appropriately. serialize: function(object) //The function that converts the object back into the proper file format form.}
- */
- class ItemFileWriteStore extends dojo.data.ItemFileReadStore {
- constructor(keywordParameters: Object);
- /**
- * Parameter to allow users to specify if a close call should force a reload or not.
- * By default, it retains the old behavior of not clearing if close is called. But
- * if set true, the store will be reset to default state. Note that by doing this,
- * all item handles will become invalid and a new fetch must be issued.
- *
- */
- "clearOnClose": boolean;
- /**
- *
- */
- "data": Object;
- /**
- * Parameter for specifying that it is OK for the xhrGet call to fail silently.
- *
- */
- "failOk": boolean;
- /**
- * Parameter to indicate to process data from the url as hierarchical
- * (data items can contain other data items in js form). Default is true
- * for backwards compatibility. False means only root items are processed
- * as items, all child objects outside of type-mapped objects and those in
- * specific reference format, are left straight JS data objects.
- *
- */
- "hierarchical": boolean;
- /**
- *
- */
- "referenceIntegrity": boolean;
- /**
- *
- */
- "typeMap": Object;
- /**
- *
- */
- "url": string;
- /**
- * Parameter to allow specifying if preventCache should be passed to the xhrGet call or not when loading data from a url.
- * Note this does not mean the store calls the server on each fetch, only that the data load has preventCache set as an option.
- * Added for tracker: #6072
- *
- */
- "urlPreventCache": boolean;
- /**
- * Over-ride of base close function of ItemFileReadStore to add in check for store state.
- * Over-ride of base close function of ItemFileReadStore to add in check for store state.
- * If the store is still dirty (unsaved changes), then an error will be thrown instead of
- * clearing the internal state for reload from the url.
- *
- * @param request Optional
- */
- close(request?: Object): void;
- /**
- * See dojo/data/api/Read.containsValue()
- *
- * @param item
- * @param attribute
- * @param value
- */
- containsValue(item: dojo.data.api.Item, attribute: String, value: any): any;
- /**
- * See dojo/data/api/Write.deleteItem()
- *
- * @param item
- */
- deleteItem(item: dojo.data.api.Item): boolean;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- * The error handler when there is an error fetching items. This function should not be called
- * directly and is used by simpleFetch.fetch().
- *
- * @param errorData
- * @param requestObject
- */
- errorHandler(errorData: Object, requestObject: Object): void;
- /**
- * The simpleFetch mixin is designed to serve as a set of function(s) that can
- * be mixed into other datastore implementations to accelerate their development.
- * The simpleFetch mixin should work well for any datastore that can respond to a _fetchItems()
- * call by returning an array of all the found items that matched the query. The simpleFetch mixin
- * is not designed to work for datastores that respond to a fetch() call by incrementally
- * loading items, or sequentially loading partial batches of the result
- * set. For datastores that mixin simpleFetch, simpleFetch
- * implements a fetch method that automatically handles eight of the fetch()
- * arguments -- onBegin, onItem, onComplete, onError, start, count, sort and scope
- * The class mixing in simpleFetch should not implement fetch(),
- * but should instead implement a _fetchItems() method. The _fetchItems()
- * method takes three arguments, the keywordArgs object that was passed
- * to fetch(), a callback function to be called when the result array is
- * available, and an error callback to be called if something goes wrong.
- * The _fetchItems() method should ignore any keywordArgs parameters for
- * start, count, onBegin, onItem, onComplete, onError, sort, and scope.
- * The _fetchItems() method needs to correctly handle any other keywordArgs
- * parameters, including the query parameter and any optional parameters
- * (such as includeChildren). The _fetchItems() method should create an array of
- * result items and pass it to the fetchHandler along with the original request object --
- * or, the _fetchItems() method may, if it wants to, create an new request object
- * with other specifics about the request that are specific to the datastore and pass
- * that as the request object to the handler.
- *
- * For more information on this specific function, see dojo/data/api/Read.fetch()
- *
- * @param request OptionalThe keywordArgs parameter may either be an instance ofconforming to dojo/data/api/Request or may be a simple anonymous objectthat may contain any of the following:{ query: query-object or query-string, queryOptions: object, onBegin: Function, onItem: Function, onComplete: Function, onError: Function, scope: object, start: int count: int sort: array}All implementations should accept keywordArgs objects with any ofthe 9 standard properties: query, onBegin, onItem, onComplete, onErrorscope, sort, start, and count. Some implementations may accept additionalproperties in the keywordArgs object as valid parameters, such as{includeOutliers:true}.The query parameterThe query may be optional in some data store implementations.The dojo/data/api/Read API does not specify the syntax or semanticsof the query itself -- each different data store implementationmay have its own notion of what a query should look like.However, as of dojo 0.9, 1.0, and 1.1, all the provided datastores in dojo.dataand dojox.data support an object structure query, where the object is a set ofname/value parameters such as { attrFoo: valueBar, attrFoo1: valueBar1}. Most of thedijit widgets, such as ComboBox assume this to be the case when working with a datastorewhen they dynamically update the query. Therefore, for maximum compatibility with dijitwidgets the recommended query parameter is a key/value object. That does not mean that thethe datastore may not take alternative query forms, such as a simple string, a Date, a number,or a mix of such. Ultimately, The dojo/data/api/Read API is agnostic about what the queryformat.Further note: In general for query objects that accept strings as attributevalue matches, the store should also support basic filtering capability, such as (match any character) and ? (match single character). An example query that is a query objectwould be like: { attrFoo: "value"}. Which generally means match all items where they havean attribute named attrFoo, with a value that starts with 'value'.The queryOptions parameterThe queryOptions parameter is an optional parameter used to specify options that may modifythe query in some fashion, such as doing a case insensitive search, or doing a deep searchwhere all items in a hierarchical representation of data are scanned instead of just the rootitems. It currently defines two options that all datastores should attempt to honor if possible:{ ignoreCase: boolean, // Whether or not the query should match case sensitively or not. Default behaviour is false. deep: boolean // Whether or not a fetch should do a deep search of items and all child // items instead of just root-level items in a datastore. Default is false.}The onBegin parameter.function(size, request);If an onBegin callback function is provided, the callback functionwill be called just once, before the first onItem callback is called.The onBegin callback function will be passed two arguments, thethe total number of items identified and the Request object. If the total number isunknown, then size will be -1. Note that size is not necessarily the size of thecollection of items returned from the query, as the request may have specified to return only asubset of the total set of items through the use of the start and count parameters.The onItem parameter.function(item, request);If an onItem callback function is provided, the callback functionwill be called as each item in the result is received. The callbackfunction will be passed two arguments: the item itself, and theRequest object.The onComplete parameter.function(items, request);If an onComplete callback function is provided, the callback functionwill be called just once, after the last onItem callback is called.Note that if the onItem callback is not present, then onComplete will be passedan array containing all items which matched the query and the request object.If the onItem callback is present, then onComplete is called as:onComplete(null, request).The onError parameter.function(errorData, request);If an onError callback function is provided, the callback functionwill be called if there is any sort of error while attempting toexecute the query.The onError callback function will be passed two arguments:an Error object and the Request object.The scope parameter.If a scope object is provided, all of the callback functions (onItem,onComplete, onError, etc) will be invoked in the context of the scopeobject. In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global().For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global(), item, request)The start parameter.If a start parameter is specified, this is a indication to the datastore toonly start returning items once the start number of items have been located andskipped. When this parameter is paired with 'count', the store should be ableto page across queries with millions of hits by only returning subsets of thehits for each queryThe count parameter.If a count parameter is specified, this is a indication to the datastore toonly return up to that many items. This allows a fetch call that may havemillions of item matches to be paired down to something reasonable.The sort parameter.If a sort parameter is specified, this is a indication to the datastore tosort the items in some manner before returning the items. The array is an array ofjavascript objects that must conform to the following format to be applied to thefetching of items:{ attribute: attribute || attribute-name-string, descending: true|false; // Optional. Default is false.}Note that when comparing attributes, if an item contains no value for the attribute(undefined), then it the default ascending sort logic should push it to the bottomof the list. In the descending order case, it such items should appear at the top of the list.
- */
- fetch(request: Object): void;
- /**
- * The handler when items are sucessfully fetched. This function should not be called directly
- * and is used by simpleFetch.fetch().
- *
- * @param items
- * @param requestObject
- */
- fetchHandler(items: any[], requestObject: Object): void;
- /**
- * See dojo/data/api/Identity.fetchItemByIdentity()
- *
- * @param keywordArgs
- */
- fetchItemByIdentity(keywordArgs: Object): void;
- /**
- * This method handles the basic filtering needs for ItemFile* based stores.
- *
- * @param requestArgs
- * @param arrayOfItems
- * @param findCallback
- */
- filter(requestArgs: Object, arrayOfItems: any[], findCallback: Function): void;
- /**
- * See dojo/data/api/Read.getAttributes()
- *
- * @param item
- */
- getAttributes(item: dojo.data.api.Item): any[];
- /**
- * See dojo/data/api/Read.getFeatures()
- *
- */
- getFeatures(): any;
- /**
- * See dojo/data/api/Identity.getIdentity()
- *
- * @param item
- */
- getIdentity(item: dojo.data.api.Item): any;
- /**
- * See dojo/data/api/Identity.getIdentityAttributes()
- *
- * @param item
- */
- getIdentityAttributes(item: dojo.data.api.Item): any;
- /**
- * See dojo/data/api/Read.getLabel()
- *
- * @param item
- */
- getLabel(item: dojo.data.api.Item): any;
- /**
- * See dojo/data/api/Read.getLabelAttributes()
- *
- * @param item
- */
- getLabelAttributes(item: dojo.data.api.Item): any;
- /**
- * See dojo/data/api/Read.getValue()
- *
- * @param item
- * @param attribute
- * @param defaultValue Optional
- */
- getValue(item: dojo.data.api.Item, attribute: String, defaultValue?: any): any;
- /**
- * See dojo/data/api/Read.getValues()
- *
- * @param item
- * @param attribute
- */
- getValues(item: dojo.data.api.Item, attribute: String): any;
- /**
- * See dojo/data/api/Read.hasAttribute()
- *
- * @param item
- * @param attribute
- */
- hasAttribute(item: dojo.data.api.Item, attribute: String): boolean;
- /**
- * See dojo/data/api/Write.isDirty()
- *
- * @param item Optional
- */
- isDirty(item?: any): any;
- /**
- * See dojo/data/api/Read.isItem()
- *
- * @param something
- */
- isItem(something: any): boolean;
- /**
- * See dojo/data/api/Read.isItemLoaded()
- *
- * @param something
- */
- isItemLoaded(something: any): any;
- /**
- * See dojo/data/api/Read.loadItem()
- *
- * @param keywordArgs
- */
- loadItem(keywordArgs: Object): void;
- /**
- * See dojo/data/api/Write.newItem()
- *
- * @param keywordArgs Optional
- * @param parentInfo Optional
- */
- newItem(keywordArgs?: Object, parentInfo?: Object): Object;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * See dojo/data/api/Write.revert()
- *
- */
- revert(): boolean;
- /**
- * See dojo/data/api/Write.save()
- *
- * @param keywordArgs
- */
- save(keywordArgs: Object): void;
- /**
- * See dojo/data/api/Write.set()
- *
- * @param item
- * @param attribute
- * @param value
- */
- setValue(item: dojo.data.api.Item, attribute: String, value: any): any;
- /**
- * See dojo/data/api/Write.setValues()
- *
- * @param item
- * @param attribute
- * @param values
- */
- setValues(item: dojo.data.api.Item, attribute: String, values: any[]): any;
- /**
- * See dojo/data/api/Write.unsetAttribute()
- *
- * @param item
- * @param attribute
- */
- unsetAttribute(item: dojo.data.api.Item, attribute: String): any;
- /**
- * See dojo/data/api/Notification.onDelete()
- *
- * @param deletedItem
- */
- onDelete(deletedItem: dojo.data.api.Item): void;
- /**
- * See dojo/data/api/Notification.onNew()
- *
- * @param newItem
- * @param parentInfo Optional
- */
- onNew(newItem: dojo.data.api.Item, parentInfo?: Object): void;
- /**
- * See dojo/data/api/Notification.onSet()
- *
- * @param item
- * @param attribute
- * @param oldValue
- * @param newValue
- */
- onSet(item: dojo.data.api.Item, attribute: String, oldValue: Object, newValue: Object): void;
- /**
- * See dojo/data/api/Notification.onSet()
- *
- * @param item
- * @param attribute
- * @param oldValue
- * @param newValue
- */
- onSet(item: dojo.data.api.Item, attribute: String, oldValue: any[], newValue: Object): void;
- /**
- * See dojo/data/api/Notification.onSet()
- *
- * @param item
- * @param attribute
- * @param oldValue
- * @param newValue
- */
- onSet(item: dojo.data.api.Item, attribute: String, oldValue: Object, newValue: any[]): void;
- /**
- * See dojo/data/api/Notification.onSet()
- *
- * @param item
- * @param attribute
- * @param oldValue
- * @param newValue
- */
- onSet(item: dojo.data.api.Item, attribute: String, oldValue: any[], newValue: any[]): void;
- }
- namespace api {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/api/Item.html
- *
- * An item in a dojo/data store
- * Class for documentation purposes only. An item can take any form, so no
- * properties or methods are defined here.
- *
- */
- class Item {
- constructor();
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/api/Identity.html
- *
- * This is an abstract API that data provider implementations conform to.
- * This file defines methods signatures and intentionally leaves all the
- * methods unimplemented.
- *
- */
- class Identity extends dojo.data.api.Read {
- constructor();
- /**
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request.
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request. In general, this API
- * expects to receive as a parameter a request object returned from a fetch.
- * It will then close out anything associated with that request, such as
- * clearing any internal datastore caches and closing any 'open' connections.
- * For some store implementations, this call may be a no-op.
- *
- * @param request OptionalAn instance of a request for the store to use to identify what to close out.If no request is passed, then the store should clear all internal caches (if any)and close out all 'open' connections. It does not render the store unusable fromthere on, it merely cleans out any current data and resets the store to initialstate.
- */
- close(request?: dojo.data.api.Request ): void;
- /**
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request.
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request. In general, this API
- * expects to receive as a parameter a request object returned from a fetch.
- * It will then close out anything associated with that request, such as
- * clearing any internal datastore caches and closing any 'open' connections.
- * For some store implementations, this call may be a no-op.
- *
- * @param request OptionalAn instance of a request for the store to use to identify what to close out.If no request is passed, then the store should clear all internal caches (if any)and close out all 'open' connections. It does not render the store unusable fromthere on, it merely cleans out any current data and resets the store to initialstate.
- */
- close(request?: Object): void;
- /**
- * Returns true if the given value is one of the values that getValues()
- * would return.
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- * @param value The value to match as a value for the attribute.
- */
- containsValue(item: dojo.data.api.Item, attribute: String, value: any): void;
- /**
- * Given a query and set of defined options, such as a start and count of items to return,
- * this method executes the query and makes the results available as data items.
- * The format and expectations of stores is that they operate in a generally asynchronous
- * manner, therefore callbacks are always used to return items located by the fetch parameters.
- * A Request object will always be returned and is returned immediately.
- * The basic request is nothing more than the keyword args passed to fetch and
- * an additional function attached, abort(). The returned request object may then be used
- * to cancel a fetch. All data items returns are passed through the callbacks defined in the
- * fetch parameters and are not present on the 'request' object.
- *
- * This does not mean that custom stores can not add methods and properties to the request object
- * returned, only that the API does not require it. For more info about the Request API,
- * see dojo/data/api/Request
- *
- * @param keywordArgs The keywordArgs parameter may either be an instance ofconforming to dojo/data/api/Request or may be a simple anonymous objectthat may contain any of the following:{ query: query-object or query-string, queryOptions: object, onBegin: Function, onItem: Function, onComplete: Function, onError: Function, scope: object, start: int count: int sort: array}All implementations should accept keywordArgs objects with any ofthe 9 standard properties: query, onBegin, onItem, onComplete, onErrorscope, sort, start, and count. Some implementations may accept additionalproperties in the keywordArgs object as valid parameters, such as{includeOutliers:true}.The query parameterThe query may be optional in some data store implementations.The dojo/data/api/Read API does not specify the syntax or semanticsof the query itself -- each different data store implementationmay have its own notion of what a query should look like.However, as of dojo 0.9, 1.0, and 1.1, all the provided datastores in dojo.dataand dojox.data support an object structure query, where the object is a set ofname/value parameters such as { attrFoo: valueBar, attrFoo1: valueBar1}. Most of thedijit widgets, such as ComboBox assume this to be the case when working with a datastorewhen they dynamically update the query. Therefore, for maximum compatibility with dijitwidgets the recommended query parameter is a key/value object. That does not mean that thethe datastore may not take alternative query forms, such as a simple string, a Date, a number,or a mix of such. Ultimately, The dojo/data/api/Read API is agnostic about what the queryformat.Further note: In general for query objects that accept strings as attributevalue matches, the store should also support basic filtering capability, such as (match any character) and ? (match single character). An example query that is a query objectwould be like: { attrFoo: "value"}. Which generally means match all items where they havean attribute named attrFoo, with a value that starts with 'value'.The queryOptions parameterThe queryOptions parameter is an optional parameter used to specify options that may modifythe query in some fashion, such as doing a case insensitive search, or doing a deep searchwhere all items in a hierarchical representation of data are scanned instead of just the rootitems. It currently defines two options that all datastores should attempt to honor if possible:{ ignoreCase: boolean, // Whether or not the query should match case sensitively or not. Default behaviour is false. deep: boolean // Whether or not a fetch should do a deep search of items and all child // items instead of just root-level items in a datastore. Default is false.}The onBegin parameter.function(size, request);If an onBegin callback function is provided, the callback functionwill be called just once, before the first onItem callback is called.The onBegin callback function will be passed two arguments, thethe total number of items identified and the Request object. If the total number isunknown, then size will be -1. Note that size is not necessarily the size of thecollection of items returned from the query, as the request may have specified to return only asubset of the total set of items through the use of the start and count parameters.The onItem parameter.function(item, request);If an onItem callback function is provided, the callback functionwill be called as each item in the result is received. The callbackfunction will be passed two arguments: the item itself, and theRequest object.The onComplete parameter.function(items, request);If an onComplete callback function is provided, the callback functionwill be called just once, after the last onItem callback is called.Note that if the onItem callback is not present, then onComplete will be passedan array containing all items which matched the query and the request object.If the onItem callback is present, then onComplete is called as:onComplete(null, request).The onError parameter.function(errorData, request);If an onError callback function is provided, the callback functionwill be called if there is any sort of error while attempting toexecute the query.The onError callback function will be passed two arguments:an Error object and the Request object.The scope parameter.If a scope object is provided, all of the callback functions (onItem,onComplete, onError, etc) will be invoked in the context of the scopeobject. In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global().For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global(), item, request)The start parameter.If a start parameter is specified, this is a indication to the datastore toonly start returning items once the start number of items have been located andskipped. When this parameter is paired with 'count', the store should be ableto page across queries with millions of hits by only returning subsets of thehits for each queryThe count parameter.If a count parameter is specified, this is a indication to the datastore toonly return up to that many items. This allows a fetch call that may havemillions of item matches to be paired down to something reasonable.The sort parameter.If a sort parameter is specified, this is a indication to the datastore tosort the items in some manner before returning the items. The array is an array ofjavascript objects that must conform to the following format to be applied to thefetching of items:{ attribute: attribute || attribute-name-string, descending: true|false; // Optional. Default is false.}Note that when comparing attributes, if an item contains no value for the attribute(undefined), then it the default ascending sort logic should push it to the bottomof the list. In the descending order case, it such items should appear at the top of the list.
- */
- fetch(keywordArgs: Object): any;
- /**
- * Given the identity of an item, this method returns the item that has
- * that identity through the onItem callback. Conforming implementations
- * should return null if there is no item with the given identity.
- * Implementations of fetchItemByIdentity() may sometimes return an item
- * from a local cache and may sometimes fetch an item from a remote server,
- *
- * @param keywordArgs An anonymous object that defines the item to locate and callbacks to invoke when theitem has been located and load has completed. The format of the object is as follows:{ identity: string|object, onItem: Function, onError: Function, scope: object}The identity parameterThe identity parameter is the identity of the item you wish to locate and loadThis attribute is required. It should be a string or an object that toString()can be called on.The onItem parameterFunction(item)The onItem parameter is the callback to invoke when the item has been loaded. It takes only oneparameter, the item located, or null if none found.The onError parameterFunction(error)The onError parameter is the callback to invoke when the item load encountered an error. It takes only oneparameter, the error objectThe scope parameterIf a scope object is provided, all of the callback functions (onItem,onError, etc) will be invoked in the context of the scope object.In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global.For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global, item, request)
- */
- fetchItemByIdentity(keywordArgs: Object): void;
- /**
- * Returns an array with all the attributes that this item has. This
- * method will always return an array; if the item has no attributes
- * at all, getAttributes() will return an empty array: [].
- *
- * @param item The item to access attributes on.
- */
- getAttributes(item: dojo.data.api.Item): void;
- /**
- * See dojo/data/api/Read.getFeatures()
- *
- */
- getFeatures(): Object;
- /**
- * Returns a unique identifier for an item. The return value will be
- * either a string or something that has a toString() method (such as,
- * for example, a dojox/uuid object).
- *
- * @param item The item from the store from which to obtain its identifier.
- */
- getIdentity(item: dojo.data.api.Item): void;
- /**
- * Returns an array of attribute names that are used to generate the identity.
- * For most stores, this is a single attribute, but for some complex stores
- * such as RDB backed stores that use compound (multi-attribute) identifiers
- * it can be more than one. If the identity is not composed of attributes
- * on the item, it will return null. This function is intended to identify
- * the attributes that comprise the identity so that so that during a render
- * of all attributes, the UI can hide the the identity information if it
- * chooses.
- *
- * @param item The item from the store from which to obtain the array of public attributes thatcompose the identifier, if any.
- */
- getIdentityAttributes(item: dojo.data.api.Item): void;
- /**
- * Method to inspect the item and return a user-readable 'label' for the item
- * that provides a general/adequate description of what the item is.
- * Method to inspect the item and return a user-readable 'label' for the item
- * that provides a general/adequate description of what the item is. In general
- * most labels will be a specific attribute value or collection of the attribute
- * values that combine to label the item in some manner. For example for an item
- * that represents a person it may return the label as: "firstname lastlame" where
- * the firstname and lastname are attributes on the item. If the store is unable
- * to determine an adequate human readable label, it should return undefined. Users that wish
- * to customize how a store instance labels items should replace the getLabel() function on
- * their instance of the store, or extend the store and replace the function in
- * the extension class.
- *
- * @param item The item to return the label for.
- */
- getLabel(item: dojo.data.api.Item): any;
- /**
- * Method to inspect the item and return an array of what attributes of the item were used
- * to generate its label, if any.
- * Method to inspect the item and return an array of what attributes of the item were used
- * to generate its label, if any. This function is to assist UI developers in knowing what
- * attributes can be ignored out of the attributes an item has when displaying it, in cases
- * where the UI is using the label as an overall identifer should they wish to hide
- * redundant information.
- *
- * @param item The item to return the list of label attributes for.
- */
- getLabelAttributes(item: dojo.data.api.Item): any;
- /**
- * Returns a single attribute value.
- * Returns defaultValue if and only if item does not have a value for attribute.
- * Returns null if and only if null was explicitly set as the attribute value.
- * Returns undefined if and only if the item does not have a value for the
- * given attribute (which is the same as saying the item does not have the attribute).
- * Saying that an "item x does not have a value for an attribute y"
- * is identical to saying that an "item x does not have attribute y".
- * It is an oxymoron to say "that attribute is present but has no values"
- * or "the item has that attribute but does not have any attribute values".
- * If store.hasAttribute(item, attribute) returns false, then
- * store.getValue(item, attribute) will return undefined.
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- * @param defaultValue OptionalOptional. A default value to use for the getValue return in the attribute does not exist or has no value.
- */
- getValue(item: dojo.data.api.Item, attribute: String, defaultValue?: any): any;
- /**
- * This getValues() method works just like the getValue() method, but getValues()
- * always returns an array rather than a single attribute value. The array
- * may be empty, may contain a single attribute value, or may contain
- * many attribute values.
- * If the item does not have a value for the given attribute, then getValues()
- * will return an empty array: []. (So, if store.hasAttribute(item, attribute)
- * has a return of false, then store.getValues(item, attribute) will return [].)
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- */
- getValues(item: dojo.data.api.Item, attribute: String): any;
- /**
- * Returns true if the given item has a value for the given attribute.
- *
- * @param item The item to access attributes on.
- * @param attribute The attribute to access represented as a string.
- */
- hasAttribute(item: dojo.data.api.Item, attribute: String): void;
- /**
- * Returns true if something is an item and came from the store instance.
- * Returns false if something is a literal, an item from another store instance,
- * or is any object other than an item.
- *
- * @param something Can be anything.
- */
- isItem(something: any): void;
- /**
- * Returns false if isItem(something) is false. Returns false if
- * if isItem(something) is true but the the item is not yet loaded
- * in local memory (for example, if the item has not yet been read
- * from the server).
- *
- * @param something Can be anything.
- */
- isItemLoaded(something: any): void;
- /**
- * Given an item, this method loads the item so that a subsequent call
- * to store.isItemLoaded(item) will return true. If a call to
- * isItemLoaded() returns true before loadItem() is even called,
- * then loadItem() need not do any work at all and will not even invoke
- * the callback handlers. So, before invoking this method, check that
- * the item has not already been loaded.
- *
- * @param keywordArgs An anonymous object that defines the item to load and callbacks to invoke when theload has completed. The format of the object is as follows:{ item: object, onItem: Function, onError: Function, scope: object}The item parameterThe item parameter is an object that represents the item in question that should becontained by the store. This attribute is required.The onItem parameterFunction(item)The onItem parameter is the callback to invoke when the item has been loaded. It takes only oneparameter, the fully loaded item.The onError parameterFunction(error)The onError parameter is the callback to invoke when the item load encountered an error. It takes only oneparameter, the error objectThe scope parameterIf a scope object is provided, all of the callback functions (onItem,onError, etc) will be invoked in the context of the scope object.In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global().For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global(), item, request)
- */
- loadItem(keywordArgs: Object): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/api/Request.html
- *
- * This class defines out the semantics of what a 'Request' object looks like
- * when returned from a fetch() method. In general, a request object is
- * nothing more than the original keywordArgs from fetch with an abort function
- * attached to it to allow users to abort a particular request if they so choose.
- * No other functions are required on a general Request object return. That does not
- * inhibit other store implementations from adding extensions to it, of course.
- *
- * This is an abstract API that data provider implementations conform to.
- * This file defines methods signatures and intentionally leaves all the
- * methods unimplemented.
- *
- * For more details on fetch, see dojo/data/api/Read.fetch().
- *
- */
- class Request {
- constructor();
- /**
- * This function is a hook point for stores to provide as a way for
- * a fetch to be halted mid-processing.
- * This function is a hook point for stores to provide as a way for
- * a fetch to be halted mid-processing. For more details on the fetch() api,
- * please see dojo/data/api/Read.fetch().
- *
- */
- abort(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/api/Notification.html
- *
- * This is an abstract API that data provider implementations conform to.
- * This file defines functions signatures and intentionally leaves all the
- * functions unimplemented.
- * This API defines a set of APIs that all datastores that conform to the
- * Notifications API must implement. In general, most stores will implement
- * these APIs as no-op functions for users who wish to monitor them to be able
- * to connect to then via dojo.connect(). For non-users of dojo.connect,
- * they should be able to just replace the function on the store to obtain
- * notifications. Both read-only and read-write stores may implement
- * this feature. In the case of a read-only store, this feature makes sense if
- * the store itself does internal polling to a back-end server and periodically updates
- * its cache of items (deletes, adds, and updates).
- *
- */
- class Notification extends dojo.data.api.Read {
- constructor();
- /**
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request.
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request. In general, this API
- * expects to receive as a parameter a request object returned from a fetch.
- * It will then close out anything associated with that request, such as
- * clearing any internal datastore caches and closing any 'open' connections.
- * For some store implementations, this call may be a no-op.
- *
- * @param request OptionalAn instance of a request for the store to use to identify what to close out.If no request is passed, then the store should clear all internal caches (if any)and close out all 'open' connections. It does not render the store unusable fromthere on, it merely cleans out any current data and resets the store to initialstate.
- */
- close(request?: dojo.data.api.Request ): void;
- /**
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request.
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request. In general, this API
- * expects to receive as a parameter a request object returned from a fetch.
- * It will then close out anything associated with that request, such as
- * clearing any internal datastore caches and closing any 'open' connections.
- * For some store implementations, this call may be a no-op.
- *
- * @param request OptionalAn instance of a request for the store to use to identify what to close out.If no request is passed, then the store should clear all internal caches (if any)and close out all 'open' connections. It does not render the store unusable fromthere on, it merely cleans out any current data and resets the store to initialstate.
- */
- close(request?: Object): void;
- /**
- * Returns true if the given value is one of the values that getValues()
- * would return.
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- * @param value The value to match as a value for the attribute.
- */
- containsValue(item: dojo.data.api.Item, attribute: String, value: any): void;
- /**
- * Given a query and set of defined options, such as a start and count of items to return,
- * this method executes the query and makes the results available as data items.
- * The format and expectations of stores is that they operate in a generally asynchronous
- * manner, therefore callbacks are always used to return items located by the fetch parameters.
- * A Request object will always be returned and is returned immediately.
- * The basic request is nothing more than the keyword args passed to fetch and
- * an additional function attached, abort(). The returned request object may then be used
- * to cancel a fetch. All data items returns are passed through the callbacks defined in the
- * fetch parameters and are not present on the 'request' object.
- *
- * This does not mean that custom stores can not add methods and properties to the request object
- * returned, only that the API does not require it. For more info about the Request API,
- * see dojo/data/api/Request
- *
- * @param keywordArgs The keywordArgs parameter may either be an instance ofconforming to dojo/data/api/Request or may be a simple anonymous objectthat may contain any of the following:{ query: query-object or query-string, queryOptions: object, onBegin: Function, onItem: Function, onComplete: Function, onError: Function, scope: object, start: int count: int sort: array}All implementations should accept keywordArgs objects with any ofthe 9 standard properties: query, onBegin, onItem, onComplete, onErrorscope, sort, start, and count. Some implementations may accept additionalproperties in the keywordArgs object as valid parameters, such as{includeOutliers:true}.The query parameterThe query may be optional in some data store implementations.The dojo/data/api/Read API does not specify the syntax or semanticsof the query itself -- each different data store implementationmay have its own notion of what a query should look like.However, as of dojo 0.9, 1.0, and 1.1, all the provided datastores in dojo.dataand dojox.data support an object structure query, where the object is a set ofname/value parameters such as { attrFoo: valueBar, attrFoo1: valueBar1}. Most of thedijit widgets, such as ComboBox assume this to be the case when working with a datastorewhen they dynamically update the query. Therefore, for maximum compatibility with dijitwidgets the recommended query parameter is a key/value object. That does not mean that thethe datastore may not take alternative query forms, such as a simple string, a Date, a number,or a mix of such. Ultimately, The dojo/data/api/Read API is agnostic about what the queryformat.Further note: In general for query objects that accept strings as attributevalue matches, the store should also support basic filtering capability, such as (match any character) and ? (match single character). An example query that is a query objectwould be like: { attrFoo: "value"}. Which generally means match all items where they havean attribute named attrFoo, with a value that starts with 'value'.The queryOptions parameterThe queryOptions parameter is an optional parameter used to specify options that may modifythe query in some fashion, such as doing a case insensitive search, or doing a deep searchwhere all items in a hierarchical representation of data are scanned instead of just the rootitems. It currently defines two options that all datastores should attempt to honor if possible:{ ignoreCase: boolean, // Whether or not the query should match case sensitively or not. Default behaviour is false. deep: boolean // Whether or not a fetch should do a deep search of items and all child // items instead of just root-level items in a datastore. Default is false.}The onBegin parameter.function(size, request);If an onBegin callback function is provided, the callback functionwill be called just once, before the first onItem callback is called.The onBegin callback function will be passed two arguments, thethe total number of items identified and the Request object. If the total number isunknown, then size will be -1. Note that size is not necessarily the size of thecollection of items returned from the query, as the request may have specified to return only asubset of the total set of items through the use of the start and count parameters.The onItem parameter.function(item, request);If an onItem callback function is provided, the callback functionwill be called as each item in the result is received. The callbackfunction will be passed two arguments: the item itself, and theRequest object.The onComplete parameter.function(items, request);If an onComplete callback function is provided, the callback functionwill be called just once, after the last onItem callback is called.Note that if the onItem callback is not present, then onComplete will be passedan array containing all items which matched the query and the request object.If the onItem callback is present, then onComplete is called as:onComplete(null, request).The onError parameter.function(errorData, request);If an onError callback function is provided, the callback functionwill be called if there is any sort of error while attempting toexecute the query.The onError callback function will be passed two arguments:an Error object and the Request object.The scope parameter.If a scope object is provided, all of the callback functions (onItem,onComplete, onError, etc) will be invoked in the context of the scopeobject. In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global().For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global(), item, request)The start parameter.If a start parameter is specified, this is a indication to the datastore toonly start returning items once the start number of items have been located andskipped. When this parameter is paired with 'count', the store should be ableto page across queries with millions of hits by only returning subsets of thehits for each queryThe count parameter.If a count parameter is specified, this is a indication to the datastore toonly return up to that many items. This allows a fetch call that may havemillions of item matches to be paired down to something reasonable.The sort parameter.If a sort parameter is specified, this is a indication to the datastore tosort the items in some manner before returning the items. The array is an array ofjavascript objects that must conform to the following format to be applied to thefetching of items:{ attribute: attribute || attribute-name-string, descending: true|false; // Optional. Default is false.}Note that when comparing attributes, if an item contains no value for the attribute(undefined), then it the default ascending sort logic should push it to the bottomof the list. In the descending order case, it such items should appear at the top of the list.
- */
- fetch(keywordArgs: Object): any;
- /**
- * Returns an array with all the attributes that this item has. This
- * method will always return an array; if the item has no attributes
- * at all, getAttributes() will return an empty array: [].
- *
- * @param item The item to access attributes on.
- */
- getAttributes(item: dojo.data.api.Item): void;
- /**
- * See dojo/data/api/Read.getFeatures()
- *
- */
- getFeatures(): Object;
- /**
- * Method to inspect the item and return a user-readable 'label' for the item
- * that provides a general/adequate description of what the item is.
- * Method to inspect the item and return a user-readable 'label' for the item
- * that provides a general/adequate description of what the item is. In general
- * most labels will be a specific attribute value or collection of the attribute
- * values that combine to label the item in some manner. For example for an item
- * that represents a person it may return the label as: "firstname lastlame" where
- * the firstname and lastname are attributes on the item. If the store is unable
- * to determine an adequate human readable label, it should return undefined. Users that wish
- * to customize how a store instance labels items should replace the getLabel() function on
- * their instance of the store, or extend the store and replace the function in
- * the extension class.
- *
- * @param item The item to return the label for.
- */
- getLabel(item: dojo.data.api.Item): any;
- /**
- * Method to inspect the item and return an array of what attributes of the item were used
- * to generate its label, if any.
- * Method to inspect the item and return an array of what attributes of the item were used
- * to generate its label, if any. This function is to assist UI developers in knowing what
- * attributes can be ignored out of the attributes an item has when displaying it, in cases
- * where the UI is using the label as an overall identifer should they wish to hide
- * redundant information.
- *
- * @param item The item to return the list of label attributes for.
- */
- getLabelAttributes(item: dojo.data.api.Item): any;
- /**
- * Returns a single attribute value.
- * Returns defaultValue if and only if item does not have a value for attribute.
- * Returns null if and only if null was explicitly set as the attribute value.
- * Returns undefined if and only if the item does not have a value for the
- * given attribute (which is the same as saying the item does not have the attribute).
- * Saying that an "item x does not have a value for an attribute y"
- * is identical to saying that an "item x does not have attribute y".
- * It is an oxymoron to say "that attribute is present but has no values"
- * or "the item has that attribute but does not have any attribute values".
- * If store.hasAttribute(item, attribute) returns false, then
- * store.getValue(item, attribute) will return undefined.
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- * @param defaultValue OptionalOptional. A default value to use for the getValue return in the attribute does not exist or has no value.
- */
- getValue(item: dojo.data.api.Item, attribute: String, defaultValue?: any): any;
- /**
- * This getValues() method works just like the getValue() method, but getValues()
- * always returns an array rather than a single attribute value. The array
- * may be empty, may contain a single attribute value, or may contain
- * many attribute values.
- * If the item does not have a value for the given attribute, then getValues()
- * will return an empty array: []. (So, if store.hasAttribute(item, attribute)
- * has a return of false, then store.getValues(item, attribute) will return [].)
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- */
- getValues(item: dojo.data.api.Item, attribute: String): any;
- /**
- * Returns true if the given item has a value for the given attribute.
- *
- * @param item The item to access attributes on.
- * @param attribute The attribute to access represented as a string.
- */
- hasAttribute(item: dojo.data.api.Item, attribute: String): void;
- /**
- * Returns true if something is an item and came from the store instance.
- * Returns false if something is a literal, an item from another store instance,
- * or is any object other than an item.
- *
- * @param something Can be anything.
- */
- isItem(something: any): void;
- /**
- * Returns false if isItem(something) is false. Returns false if
- * if isItem(something) is true but the the item is not yet loaded
- * in local memory (for example, if the item has not yet been read
- * from the server).
- *
- * @param something Can be anything.
- */
- isItemLoaded(something: any): void;
- /**
- * Given an item, this method loads the item so that a subsequent call
- * to store.isItemLoaded(item) will return true. If a call to
- * isItemLoaded() returns true before loadItem() is even called,
- * then loadItem() need not do any work at all and will not even invoke
- * the callback handlers. So, before invoking this method, check that
- * the item has not already been loaded.
- *
- * @param keywordArgs An anonymous object that defines the item to load and callbacks to invoke when theload has completed. The format of the object is as follows:{ item: object, onItem: Function, onError: Function, scope: object}The item parameterThe item parameter is an object that represents the item in question that should becontained by the store. This attribute is required.The onItem parameterFunction(item)The onItem parameter is the callback to invoke when the item has been loaded. It takes only oneparameter, the fully loaded item.The onError parameterFunction(error)The onError parameter is the callback to invoke when the item load encountered an error. It takes only oneparameter, the error objectThe scope parameterIf a scope object is provided, all of the callback functions (onItem,onError, etc) will be invoked in the context of the scope object.In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global().For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global(), item, request)
- */
- loadItem(keywordArgs: Object): void;
- /**
- * This function is called any time an item is deleted from the store.
- * It is called immediately after the store deleteItem processing has completed.
- * This function is called any time an item is deleted from the store.
- * It is called immediately after the store deleteItem processing has completed.
- *
- * @param deletedItem The item deleted.
- */
- onDelete(deletedItem: dojo.data.api.Item): any;
- /**
- * This function is called any time a new item is created in the store.
- * It is called immediately after the store newItem processing has completed.
- * This function is called any time a new item is created in the store.
- * It is called immediately after the store newItem processing has completed.
- *
- * @param newItem The item created.
- * @param parentInfo OptionalAn optional javascript object that is passed when the item created was placed in the storehierarchy as a value f another item's attribute, instead of a root level item. Note that if thisfunction is invoked with a value for parentInfo, then onSet is not invoked stating the attribute ofthe parent item was modified. This is to avoid getting two notification events occurring when a new itemwith a parent is created. The structure passed in is as follows:{ item: someItem, //The parent item attribute: "attribute-name-string", //The attribute the new item was assigned to. oldValue: something //Whatever was the previous value for the attribute. //If it is a single-value attribute only, then this value will be a single value. //If it was a multi-valued attribute, then this will be an array of all the values minus the new one. newValue: something //The new value of the attribute. In the case of single value calls, such as setValue, this value will be //generally be an atomic value of some sort (string, int, etc, object). In the case of multi-valued attributes, //it will be an array.}
- */
- onNew(newItem: dojo.data.api.Item, parentInfo?: Object): any;
- /**
- * This function is called any time an item is modified via setValue, setValues, unsetAttribute, etc.
- * This function is called any time an item is modified via setValue, setValues, unsetAttribute, etc.
- * Its purpose is to provide a hook point for those who wish to monitor actions on items in the store
- * in a simple manner. The general expected usage is to dojo.connect() to the store's
- * implementation and be called after the store function is called.
- *
- * @param item The item being modified.
- * @param attribute The attribute being changed represented as a string name.
- * @param oldValue The old value of the attribute. In the case of single value calls, such as setValue, unsetAttribute, etc,this value will be generally be an atomic value of some sort (string, int, etc, object). In the case ofmulti-valued attributes, it will be an array.
- * @param newValue The new value of the attribute. In the case of single value calls, such as setValue, this value will begenerally be an atomic value of some sort (string, int, etc, object). In the case of multi-valued attributes,it will be an array. In the case of unsetAttribute, the new value will be 'undefined'.
- */
- onSet(item: dojo.data.api.Item, attribute: String, oldValue: Object, newValue: Object): any;
- /**
- * This function is called any time an item is modified via setValue, setValues, unsetAttribute, etc.
- * This function is called any time an item is modified via setValue, setValues, unsetAttribute, etc.
- * Its purpose is to provide a hook point for those who wish to monitor actions on items in the store
- * in a simple manner. The general expected usage is to dojo.connect() to the store's
- * implementation and be called after the store function is called.
- *
- * @param item The item being modified.
- * @param attribute The attribute being changed represented as a string name.
- * @param oldValue The old value of the attribute. In the case of single value calls, such as setValue, unsetAttribute, etc,this value will be generally be an atomic value of some sort (string, int, etc, object). In the case ofmulti-valued attributes, it will be an array.
- * @param newValue The new value of the attribute. In the case of single value calls, such as setValue, this value will begenerally be an atomic value of some sort (string, int, etc, object). In the case of multi-valued attributes,it will be an array. In the case of unsetAttribute, the new value will be 'undefined'.
- */
- onSet(item: dojo.data.api.Item, attribute: String, oldValue: any[], newValue: Object): any;
- /**
- * This function is called any time an item is modified via setValue, setValues, unsetAttribute, etc.
- * This function is called any time an item is modified via setValue, setValues, unsetAttribute, etc.
- * Its purpose is to provide a hook point for those who wish to monitor actions on items in the store
- * in a simple manner. The general expected usage is to dojo.connect() to the store's
- * implementation and be called after the store function is called.
- *
- * @param item The item being modified.
- * @param attribute The attribute being changed represented as a string name.
- * @param oldValue The old value of the attribute. In the case of single value calls, such as setValue, unsetAttribute, etc,this value will be generally be an atomic value of some sort (string, int, etc, object). In the case ofmulti-valued attributes, it will be an array.
- * @param newValue The new value of the attribute. In the case of single value calls, such as setValue, this value will begenerally be an atomic value of some sort (string, int, etc, object). In the case of multi-valued attributes,it will be an array. In the case of unsetAttribute, the new value will be 'undefined'.
- */
- onSet(item: dojo.data.api.Item, attribute: String, oldValue: Object, newValue: any[]): any;
- /**
- * This function is called any time an item is modified via setValue, setValues, unsetAttribute, etc.
- * This function is called any time an item is modified via setValue, setValues, unsetAttribute, etc.
- * Its purpose is to provide a hook point for those who wish to monitor actions on items in the store
- * in a simple manner. The general expected usage is to dojo.connect() to the store's
- * implementation and be called after the store function is called.
- *
- * @param item The item being modified.
- * @param attribute The attribute being changed represented as a string name.
- * @param oldValue The old value of the attribute. In the case of single value calls, such as setValue, unsetAttribute, etc,this value will be generally be an atomic value of some sort (string, int, etc, object). In the case ofmulti-valued attributes, it will be an array.
- * @param newValue The new value of the attribute. In the case of single value calls, such as setValue, this value will begenerally be an atomic value of some sort (string, int, etc, object). In the case of multi-valued attributes,it will be an array. In the case of unsetAttribute, the new value will be 'undefined'.
- */
- onSet(item: dojo.data.api.Item, attribute: String, oldValue: any[], newValue: any[]): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/api/Read.html
- *
- * This is an abstract API that data provider implementations conform to.
- * This file defines methods signatures and intentionally leaves all the
- * methods unimplemented. For more information on the dojo.data APIs,
- * please visit: http://www.dojotoolkit.org/node/98
- *
- */
- class Read {
- constructor();
- /**
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request.
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request. In general, this API
- * expects to receive as a parameter a request object returned from a fetch.
- * It will then close out anything associated with that request, such as
- * clearing any internal datastore caches and closing any 'open' connections.
- * For some store implementations, this call may be a no-op.
- *
- * @param request OptionalAn instance of a request for the store to use to identify what to close out.If no request is passed, then the store should clear all internal caches (if any)and close out all 'open' connections. It does not render the store unusable fromthere on, it merely cleans out any current data and resets the store to initialstate.
- */
- close(request?: dojo.data.api.Request ): void;
- /**
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request.
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request. In general, this API
- * expects to receive as a parameter a request object returned from a fetch.
- * It will then close out anything associated with that request, such as
- * clearing any internal datastore caches and closing any 'open' connections.
- * For some store implementations, this call may be a no-op.
- *
- * @param request OptionalAn instance of a request for the store to use to identify what to close out.If no request is passed, then the store should clear all internal caches (if any)and close out all 'open' connections. It does not render the store unusable fromthere on, it merely cleans out any current data and resets the store to initialstate.
- */
- close(request?: Object): void;
- /**
- * Returns true if the given value is one of the values that getValues()
- * would return.
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- * @param value The value to match as a value for the attribute.
- */
- containsValue(item: dojo.data.api.Item, attribute: String, value: any): void;
- /**
- * Given a query and set of defined options, such as a start and count of items to return,
- * this method executes the query and makes the results available as data items.
- * The format and expectations of stores is that they operate in a generally asynchronous
- * manner, therefore callbacks are always used to return items located by the fetch parameters.
- * A Request object will always be returned and is returned immediately.
- * The basic request is nothing more than the keyword args passed to fetch and
- * an additional function attached, abort(). The returned request object may then be used
- * to cancel a fetch. All data items returns are passed through the callbacks defined in the
- * fetch parameters and are not present on the 'request' object.
- *
- * This does not mean that custom stores can not add methods and properties to the request object
- * returned, only that the API does not require it. For more info about the Request API,
- * see dojo/data/api/Request
- *
- * @param keywordArgs The keywordArgs parameter may either be an instance ofconforming to dojo/data/api/Request or may be a simple anonymous objectthat may contain any of the following:{ query: query-object or query-string, queryOptions: object, onBegin: Function, onItem: Function, onComplete: Function, onError: Function, scope: object, start: int count: int sort: array}All implementations should accept keywordArgs objects with any ofthe 9 standard properties: query, onBegin, onItem, onComplete, onErrorscope, sort, start, and count. Some implementations may accept additionalproperties in the keywordArgs object as valid parameters, such as{includeOutliers:true}.The query parameterThe query may be optional in some data store implementations.The dojo/data/api/Read API does not specify the syntax or semanticsof the query itself -- each different data store implementationmay have its own notion of what a query should look like.However, as of dojo 0.9, 1.0, and 1.1, all the provided datastores in dojo.dataand dojox.data support an object structure query, where the object is a set ofname/value parameters such as { attrFoo: valueBar, attrFoo1: valueBar1}. Most of thedijit widgets, such as ComboBox assume this to be the case when working with a datastorewhen they dynamically update the query. Therefore, for maximum compatibility with dijitwidgets the recommended query parameter is a key/value object. That does not mean that thethe datastore may not take alternative query forms, such as a simple string, a Date, a number,or a mix of such. Ultimately, The dojo/data/api/Read API is agnostic about what the queryformat.Further note: In general for query objects that accept strings as attributevalue matches, the store should also support basic filtering capability, such as (match any character) and ? (match single character). An example query that is a query objectwould be like: { attrFoo: "value"}. Which generally means match all items where they havean attribute named attrFoo, with a value that starts with 'value'.The queryOptions parameterThe queryOptions parameter is an optional parameter used to specify options that may modifythe query in some fashion, such as doing a case insensitive search, or doing a deep searchwhere all items in a hierarchical representation of data are scanned instead of just the rootitems. It currently defines two options that all datastores should attempt to honor if possible:{ ignoreCase: boolean, // Whether or not the query should match case sensitively or not. Default behaviour is false. deep: boolean // Whether or not a fetch should do a deep search of items and all child // items instead of just root-level items in a datastore. Default is false.}The onBegin parameter.function(size, request);If an onBegin callback function is provided, the callback functionwill be called just once, before the first onItem callback is called.The onBegin callback function will be passed two arguments, thethe total number of items identified and the Request object. If the total number isunknown, then size will be -1. Note that size is not necessarily the size of thecollection of items returned from the query, as the request may have specified to return only asubset of the total set of items through the use of the start and count parameters.The onItem parameter.function(item, request);If an onItem callback function is provided, the callback functionwill be called as each item in the result is received. The callbackfunction will be passed two arguments: the item itself, and theRequest object.The onComplete parameter.function(items, request);If an onComplete callback function is provided, the callback functionwill be called just once, after the last onItem callback is called.Note that if the onItem callback is not present, then onComplete will be passedan array containing all items which matched the query and the request object.If the onItem callback is present, then onComplete is called as:onComplete(null, request).The onError parameter.function(errorData, request);If an onError callback function is provided, the callback functionwill be called if there is any sort of error while attempting toexecute the query.The onError callback function will be passed two arguments:an Error object and the Request object.The scope parameter.If a scope object is provided, all of the callback functions (onItem,onComplete, onError, etc) will be invoked in the context of the scopeobject. In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global().For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global(), item, request)The start parameter.If a start parameter is specified, this is a indication to the datastore toonly start returning items once the start number of items have been located andskipped. When this parameter is paired with 'count', the store should be ableto page across queries with millions of hits by only returning subsets of thehits for each queryThe count parameter.If a count parameter is specified, this is a indication to the datastore toonly return up to that many items. This allows a fetch call that may havemillions of item matches to be paired down to something reasonable.The sort parameter.If a sort parameter is specified, this is a indication to the datastore tosort the items in some manner before returning the items. The array is an array ofjavascript objects that must conform to the following format to be applied to thefetching of items:{ attribute: attribute || attribute-name-string, descending: true|false; // Optional. Default is false.}Note that when comparing attributes, if an item contains no value for the attribute(undefined), then it the default ascending sort logic should push it to the bottomof the list. In the descending order case, it such items should appear at the top of the list.
- */
- fetch(keywordArgs: Object): any;
- /**
- * Returns an array with all the attributes that this item has. This
- * method will always return an array; if the item has no attributes
- * at all, getAttributes() will return an empty array: [].
- *
- * @param item The item to access attributes on.
- */
- getAttributes(item: dojo.data.api.Item): void;
- /**
- * The getFeatures() method returns an simple keyword values object
- * that specifies what interface features the datastore implements.
- * A simple CsvStore may be read-only, and the only feature it
- * implements will be the 'dojo/data/api/Read' interface, so the
- * getFeatures() method will return an object like this one:
- * {'dojo.data.api.Read': true}.
- * A more sophisticated datastore might implement a variety of
- * interface features, like 'dojo.data.api.Read', 'dojo/data/api/Write',
- * 'dojo.data.api.Identity', and 'dojo/data/api/Attribution'.
- *
- */
- getFeatures(): Object;
- /**
- * Method to inspect the item and return a user-readable 'label' for the item
- * that provides a general/adequate description of what the item is.
- * Method to inspect the item and return a user-readable 'label' for the item
- * that provides a general/adequate description of what the item is. In general
- * most labels will be a specific attribute value or collection of the attribute
- * values that combine to label the item in some manner. For example for an item
- * that represents a person it may return the label as: "firstname lastlame" where
- * the firstname and lastname are attributes on the item. If the store is unable
- * to determine an adequate human readable label, it should return undefined. Users that wish
- * to customize how a store instance labels items should replace the getLabel() function on
- * their instance of the store, or extend the store and replace the function in
- * the extension class.
- *
- * @param item The item to return the label for.
- */
- getLabel(item: dojo.data.api.Item): any;
- /**
- * Method to inspect the item and return an array of what attributes of the item were used
- * to generate its label, if any.
- * Method to inspect the item and return an array of what attributes of the item were used
- * to generate its label, if any. This function is to assist UI developers in knowing what
- * attributes can be ignored out of the attributes an item has when displaying it, in cases
- * where the UI is using the label as an overall identifer should they wish to hide
- * redundant information.
- *
- * @param item The item to return the list of label attributes for.
- */
- getLabelAttributes(item: dojo.data.api.Item): any;
- /**
- * Returns a single attribute value.
- * Returns defaultValue if and only if item does not have a value for attribute.
- * Returns null if and only if null was explicitly set as the attribute value.
- * Returns undefined if and only if the item does not have a value for the
- * given attribute (which is the same as saying the item does not have the attribute).
- * Saying that an "item x does not have a value for an attribute y"
- * is identical to saying that an "item x does not have attribute y".
- * It is an oxymoron to say "that attribute is present but has no values"
- * or "the item has that attribute but does not have any attribute values".
- * If store.hasAttribute(item, attribute) returns false, then
- * store.getValue(item, attribute) will return undefined.
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- * @param defaultValue OptionalOptional. A default value to use for the getValue return in the attribute does not exist or has no value.
- */
- getValue(item: dojo.data.api.Item, attribute: String, defaultValue?: any): any;
- /**
- * This getValues() method works just like the getValue() method, but getValues()
- * always returns an array rather than a single attribute value. The array
- * may be empty, may contain a single attribute value, or may contain
- * many attribute values.
- * If the item does not have a value for the given attribute, then getValues()
- * will return an empty array: []. (So, if store.hasAttribute(item, attribute)
- * has a return of false, then store.getValues(item, attribute) will return [].)
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- */
- getValues(item: dojo.data.api.Item, attribute: String): any;
- /**
- * Returns true if the given item has a value for the given attribute.
- *
- * @param item The item to access attributes on.
- * @param attribute The attribute to access represented as a string.
- */
- hasAttribute(item: dojo.data.api.Item, attribute: String): void;
- /**
- * Returns true if something is an item and came from the store instance.
- * Returns false if something is a literal, an item from another store instance,
- * or is any object other than an item.
- *
- * @param something Can be anything.
- */
- isItem(something: any): void;
- /**
- * Returns false if isItem(something) is false. Returns false if
- * if isItem(something) is true but the the item is not yet loaded
- * in local memory (for example, if the item has not yet been read
- * from the server).
- *
- * @param something Can be anything.
- */
- isItemLoaded(something: any): void;
- /**
- * Given an item, this method loads the item so that a subsequent call
- * to store.isItemLoaded(item) will return true. If a call to
- * isItemLoaded() returns true before loadItem() is even called,
- * then loadItem() need not do any work at all and will not even invoke
- * the callback handlers. So, before invoking this method, check that
- * the item has not already been loaded.
- *
- * @param keywordArgs An anonymous object that defines the item to load and callbacks to invoke when theload has completed. The format of the object is as follows:{ item: object, onItem: Function, onError: Function, scope: object}The item parameterThe item parameter is an object that represents the item in question that should becontained by the store. This attribute is required.The onItem parameterFunction(item)The onItem parameter is the callback to invoke when the item has been loaded. It takes only oneparameter, the fully loaded item.The onError parameterFunction(error)The onError parameter is the callback to invoke when the item load encountered an error. It takes only oneparameter, the error objectThe scope parameterIf a scope object is provided, all of the callback functions (onItem,onError, etc) will be invoked in the context of the scope object.In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global().For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global(), item, request)
- */
- loadItem(keywordArgs: Object): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/api/Write.html
- *
- * This is an abstract API that data provider implementations conform to.
- * This file defines function signatures and intentionally leaves all the
- * functions unimplemented.
- *
- */
- class Write extends dojo.data.api.Read {
- constructor();
- /**
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request.
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request. In general, this API
- * expects to receive as a parameter a request object returned from a fetch.
- * It will then close out anything associated with that request, such as
- * clearing any internal datastore caches and closing any 'open' connections.
- * For some store implementations, this call may be a no-op.
- *
- * @param request OptionalAn instance of a request for the store to use to identify what to close out.If no request is passed, then the store should clear all internal caches (if any)and close out all 'open' connections. It does not render the store unusable fromthere on, it merely cleans out any current data and resets the store to initialstate.
- */
- close(request?: dojo.data.api.Request ): void;
- /**
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request.
- * The close() method is intended for instructing the store to 'close' out
- * any information associated with a particular request. In general, this API
- * expects to receive as a parameter a request object returned from a fetch.
- * It will then close out anything associated with that request, such as
- * clearing any internal datastore caches and closing any 'open' connections.
- * For some store implementations, this call may be a no-op.
- *
- * @param request OptionalAn instance of a request for the store to use to identify what to close out.If no request is passed, then the store should clear all internal caches (if any)and close out all 'open' connections. It does not render the store unusable fromthere on, it merely cleans out any current data and resets the store to initialstate.
- */
- close(request?: Object): void;
- /**
- * Returns true if the given value is one of the values that getValues()
- * would return.
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- * @param value The value to match as a value for the attribute.
- */
- containsValue(item: dojo.data.api.Item, attribute: String, value: any): void;
- /**
- * Deletes an item from the store.
- *
- * @param item The item to delete.
- */
- deleteItem(item: dojo.data.api.Item): void;
- /**
- * Given a query and set of defined options, such as a start and count of items to return,
- * this method executes the query and makes the results available as data items.
- * The format and expectations of stores is that they operate in a generally asynchronous
- * manner, therefore callbacks are always used to return items located by the fetch parameters.
- * A Request object will always be returned and is returned immediately.
- * The basic request is nothing more than the keyword args passed to fetch and
- * an additional function attached, abort(). The returned request object may then be used
- * to cancel a fetch. All data items returns are passed through the callbacks defined in the
- * fetch parameters and are not present on the 'request' object.
- *
- * This does not mean that custom stores can not add methods and properties to the request object
- * returned, only that the API does not require it. For more info about the Request API,
- * see dojo/data/api/Request
- *
- * @param keywordArgs The keywordArgs parameter may either be an instance ofconforming to dojo/data/api/Request or may be a simple anonymous objectthat may contain any of the following:{ query: query-object or query-string, queryOptions: object, onBegin: Function, onItem: Function, onComplete: Function, onError: Function, scope: object, start: int count: int sort: array}All implementations should accept keywordArgs objects with any ofthe 9 standard properties: query, onBegin, onItem, onComplete, onErrorscope, sort, start, and count. Some implementations may accept additionalproperties in the keywordArgs object as valid parameters, such as{includeOutliers:true}.The query parameterThe query may be optional in some data store implementations.The dojo/data/api/Read API does not specify the syntax or semanticsof the query itself -- each different data store implementationmay have its own notion of what a query should look like.However, as of dojo 0.9, 1.0, and 1.1, all the provided datastores in dojo.dataand dojox.data support an object structure query, where the object is a set ofname/value parameters such as { attrFoo: valueBar, attrFoo1: valueBar1}. Most of thedijit widgets, such as ComboBox assume this to be the case when working with a datastorewhen they dynamically update the query. Therefore, for maximum compatibility with dijitwidgets the recommended query parameter is a key/value object. That does not mean that thethe datastore may not take alternative query forms, such as a simple string, a Date, a number,or a mix of such. Ultimately, The dojo/data/api/Read API is agnostic about what the queryformat.Further note: In general for query objects that accept strings as attributevalue matches, the store should also support basic filtering capability, such as (match any character) and ? (match single character). An example query that is a query objectwould be like: { attrFoo: "value"}. Which generally means match all items where they havean attribute named attrFoo, with a value that starts with 'value'.The queryOptions parameterThe queryOptions parameter is an optional parameter used to specify options that may modifythe query in some fashion, such as doing a case insensitive search, or doing a deep searchwhere all items in a hierarchical representation of data are scanned instead of just the rootitems. It currently defines two options that all datastores should attempt to honor if possible:{ ignoreCase: boolean, // Whether or not the query should match case sensitively or not. Default behaviour is false. deep: boolean // Whether or not a fetch should do a deep search of items and all child // items instead of just root-level items in a datastore. Default is false.}The onBegin parameter.function(size, request);If an onBegin callback function is provided, the callback functionwill be called just once, before the first onItem callback is called.The onBegin callback function will be passed two arguments, thethe total number of items identified and the Request object. If the total number isunknown, then size will be -1. Note that size is not necessarily the size of thecollection of items returned from the query, as the request may have specified to return only asubset of the total set of items through the use of the start and count parameters.The onItem parameter.function(item, request);If an onItem callback function is provided, the callback functionwill be called as each item in the result is received. The callbackfunction will be passed two arguments: the item itself, and theRequest object.The onComplete parameter.function(items, request);If an onComplete callback function is provided, the callback functionwill be called just once, after the last onItem callback is called.Note that if the onItem callback is not present, then onComplete will be passedan array containing all items which matched the query and the request object.If the onItem callback is present, then onComplete is called as:onComplete(null, request).The onError parameter.function(errorData, request);If an onError callback function is provided, the callback functionwill be called if there is any sort of error while attempting toexecute the query.The onError callback function will be passed two arguments:an Error object and the Request object.The scope parameter.If a scope object is provided, all of the callback functions (onItem,onComplete, onError, etc) will be invoked in the context of the scopeobject. In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global().For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global(), item, request)The start parameter.If a start parameter is specified, this is a indication to the datastore toonly start returning items once the start number of items have been located andskipped. When this parameter is paired with 'count', the store should be ableto page across queries with millions of hits by only returning subsets of thehits for each queryThe count parameter.If a count parameter is specified, this is a indication to the datastore toonly return up to that many items. This allows a fetch call that may havemillions of item matches to be paired down to something reasonable.The sort parameter.If a sort parameter is specified, this is a indication to the datastore tosort the items in some manner before returning the items. The array is an array ofjavascript objects that must conform to the following format to be applied to thefetching of items:{ attribute: attribute || attribute-name-string, descending: true|false; // Optional. Default is false.}Note that when comparing attributes, if an item contains no value for the attribute(undefined), then it the default ascending sort logic should push it to the bottomof the list. In the descending order case, it such items should appear at the top of the list.
- */
- fetch(keywordArgs: Object): any;
- /**
- * Returns an array with all the attributes that this item has. This
- * method will always return an array; if the item has no attributes
- * at all, getAttributes() will return an empty array: [].
- *
- * @param item The item to access attributes on.
- */
- getAttributes(item: dojo.data.api.Item): void;
- /**
- * See dojo/data/api/Read.getFeatures()
- *
- */
- getFeatures(): Object;
- /**
- * Method to inspect the item and return a user-readable 'label' for the item
- * that provides a general/adequate description of what the item is.
- * Method to inspect the item and return a user-readable 'label' for the item
- * that provides a general/adequate description of what the item is. In general
- * most labels will be a specific attribute value or collection of the attribute
- * values that combine to label the item in some manner. For example for an item
- * that represents a person it may return the label as: "firstname lastlame" where
- * the firstname and lastname are attributes on the item. If the store is unable
- * to determine an adequate human readable label, it should return undefined. Users that wish
- * to customize how a store instance labels items should replace the getLabel() function on
- * their instance of the store, or extend the store and replace the function in
- * the extension class.
- *
- * @param item The item to return the label for.
- */
- getLabel(item: dojo.data.api.Item): any;
- /**
- * Method to inspect the item and return an array of what attributes of the item were used
- * to generate its label, if any.
- * Method to inspect the item and return an array of what attributes of the item were used
- * to generate its label, if any. This function is to assist UI developers in knowing what
- * attributes can be ignored out of the attributes an item has when displaying it, in cases
- * where the UI is using the label as an overall identifer should they wish to hide
- * redundant information.
- *
- * @param item The item to return the list of label attributes for.
- */
- getLabelAttributes(item: dojo.data.api.Item): any;
- /**
- * Returns a single attribute value.
- * Returns defaultValue if and only if item does not have a value for attribute.
- * Returns null if and only if null was explicitly set as the attribute value.
- * Returns undefined if and only if the item does not have a value for the
- * given attribute (which is the same as saying the item does not have the attribute).
- * Saying that an "item x does not have a value for an attribute y"
- * is identical to saying that an "item x does not have attribute y".
- * It is an oxymoron to say "that attribute is present but has no values"
- * or "the item has that attribute but does not have any attribute values".
- * If store.hasAttribute(item, attribute) returns false, then
- * store.getValue(item, attribute) will return undefined.
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- * @param defaultValue OptionalOptional. A default value to use for the getValue return in the attribute does not exist or has no value.
- */
- getValue(item: dojo.data.api.Item, attribute: String, defaultValue?: any): any;
- /**
- * This getValues() method works just like the getValue() method, but getValues()
- * always returns an array rather than a single attribute value. The array
- * may be empty, may contain a single attribute value, or may contain
- * many attribute values.
- * If the item does not have a value for the given attribute, then getValues()
- * will return an empty array: []. (So, if store.hasAttribute(item, attribute)
- * has a return of false, then store.getValues(item, attribute) will return [].)
- *
- * @param item The item to access values on.
- * @param attribute The attribute to access represented as a string.
- */
- getValues(item: dojo.data.api.Item, attribute: String): any;
- /**
- * Returns true if the given item has a value for the given attribute.
- *
- * @param item The item to access attributes on.
- * @param attribute The attribute to access represented as a string.
- */
- hasAttribute(item: dojo.data.api.Item, attribute: String): void;
- /**
- * Given an item, isDirty() returns true if the item has been modified
- * since the last save(). If isDirty() is called with no item argument,
- * then this function returns true if any item has been modified since
- * the last save().
- *
- * @param item OptionalThe item to check.
- */
- isDirty(item?: any): void;
- /**
- * Returns true if something is an item and came from the store instance.
- * Returns false if something is a literal, an item from another store instance,
- * or is any object other than an item.
- *
- * @param something Can be anything.
- */
- isItem(something: any): void;
- /**
- * Returns false if isItem(something) is false. Returns false if
- * if isItem(something) is true but the the item is not yet loaded
- * in local memory (for example, if the item has not yet been read
- * from the server).
- *
- * @param something Can be anything.
- */
- isItemLoaded(something: any): void;
- /**
- * Given an item, this method loads the item so that a subsequent call
- * to store.isItemLoaded(item) will return true. If a call to
- * isItemLoaded() returns true before loadItem() is even called,
- * then loadItem() need not do any work at all and will not even invoke
- * the callback handlers. So, before invoking this method, check that
- * the item has not already been loaded.
- *
- * @param keywordArgs An anonymous object that defines the item to load and callbacks to invoke when theload has completed. The format of the object is as follows:{ item: object, onItem: Function, onError: Function, scope: object}The item parameterThe item parameter is an object that represents the item in question that should becontained by the store. This attribute is required.The onItem parameterFunction(item)The onItem parameter is the callback to invoke when the item has been loaded. It takes only oneparameter, the fully loaded item.The onError parameterFunction(error)The onError parameter is the callback to invoke when the item load encountered an error. It takes only oneparameter, the error objectThe scope parameterIf a scope object is provided, all of the callback functions (onItem,onError, etc) will be invoked in the context of the scope object.In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global().For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global(), item, request)
- */
- loadItem(keywordArgs: Object): void;
- /**
- * Returns a newly created item. Sets the attributes of the new
- * item based on the keywordArgs provided. In general, the attribute
- * names in the keywords become the attributes in the new item and as for
- * the attribute values in keywordArgs, they become the values of the attributes
- * in the new item. In addition, for stores that support hierarchical item
- * creation, an optional second parameter is accepted that defines what item is the parent
- * of the new item and what attribute of that item should the new item be assigned to.
- * In general, this will assume that the attribute targeted is multi-valued and a new item
- * is appended onto the list of values for that attribute.
- *
- * @param keywordArgs OptionalA javascript object defining the initial content of the item as a set of JavaScript 'property name: value' pairs.
- * @param parentInfo OptionalAn optional javascript object defining what item is the parent of this item (in a hierarchical store. Not all stores do hierarchical items),and what attribute of that parent to assign the new item to. If this is present, and the attribute specifiedis a multi-valued attribute, it will append this item into the array of values for that attribute. The structureof the object is as follows:{ parent: someItem, attribute: "attribute-name-string"}
- */
- newItem(keywordArgs?: Object, parentInfo?: Object): void;
- /**
- * Discards any unsaved changes.
- * Discards any unsaved changes.
- *
- */
- revert(): void;
- /**
- * Saves to the server all the changes that have been made locally.
- * The save operation may take some time and is generally performed
- * in an asynchronous fashion. The outcome of the save action is
- * is passed into the set of supported callbacks for the save.
- *
- * @param keywordArgs { onComplete: function onError: function scope: object} ####The *onComplete* parameter. function(); If an onComplete callback function is provided, the callback function will be called just once, after the save has completed. No parameters are generally passed to the onComplete. ####The *onError* parameter. function(errorData); If an onError callback function is provided, the callback function will be called if there is any sort of error while attempting to execute the save. The onError function will be based one parameter, the error. ####The *scope* parameter. If a scope object is provided, all of the callback function ( onComplete, onError, etc) will be invoked in the context of the scope object. In the body of the callback function, the value of the "this" keyword will be the scope object. If no scope object is provided, the callback functions will be called in the context of dojo.global. For example, onComplete.call(scope) vs. onComplete.call(dojo.global)
- */
- save(keywordArgs: Object): any;
- /**
- * Sets the value of an attribute on an item.
- * Replaces any previous value or values.
- *
- * @param item The item to modify.
- * @param attribute The attribute of the item to change represented as a string name.
- * @param value The value to assign to the item.
- */
- setValue(item: dojo.data.api.Item, attribute: String, value: any): void;
- /**
- * Adds each value in the values array as a value of the given
- * attribute on the given item.
- * Replaces any previous value or values.
- * Calling store.setValues(x, y, []) (with values as an empty array) has
- * the same effect as calling store.unsetAttribute(x, y).
- *
- * @param item The item to modify.
- * @param attribute The attribute of the item to change represented as a string name.
- * @param values An array of values to assign to the attribute..
- */
- setValues(item: dojo.data.api.Item, attribute: String, values: any[]): void;
- /**
- * Deletes all the values of an attribute on an item.
- *
- * @param item The item to modify.
- * @param attribute The attribute of the item to unset represented as a string.
- */
- unsetAttribute(item: dojo.data.api.Item, attribute: String): void;
- }
- }
- namespace util {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/util/filter.html
- *
- *
- */
- interface filter {
- /**
- * Helper function to convert a simple pattern to a regular expression for matching.
- * Returns a regular expression object that conforms to the defined conversion rules.
- * For example:
- *
- * ca -> /^ca.$/
- * ca -> /^.ca.$/
- * c\a -> /^.c*a.*$/
- * c\a? -> /^.c*a..*$/
- * and so on.
- *
- * @param pattern A simple matching pattern to convert that follows basic rules:Means match anything, so ca* means match anything starting with ca? Means match single character. So, b?b will match to bob and bab, and so on.\ is an escape character. So for example, * means do not treat as a match, but literal character .To use a \ as a character in the string, it must be escaped. So in the pattern it should berepresented by \ to be treated as an ordinary \ character instead of an escape.
- * @param ignoreCase OptionalAn optional flag to indicate if the pattern matching should be treated as case-sensitive or not when comparingBy default, it is assumed case sensitive.
- */
- patternToRegExp(pattern: String, ignoreCase?: boolean): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/util/simpleFetch.html
- *
- *
- */
- interface simpleFetch {
- /**
- * The error handler when there is an error fetching items. This function should not be called
- * directly and is used by simpleFetch.fetch().
- *
- * @param errorData
- * @param requestObject
- */
- errorHandler(errorData: Object, requestObject: Object): void;
- /**
- * The simpleFetch mixin is designed to serve as a set of function(s) that can
- * be mixed into other datastore implementations to accelerate their development.
- * The simpleFetch mixin should work well for any datastore that can respond to a _fetchItems()
- * call by returning an array of all the found items that matched the query. The simpleFetch mixin
- * is not designed to work for datastores that respond to a fetch() call by incrementally
- * loading items, or sequentially loading partial batches of the result
- * set. For datastores that mixin simpleFetch, simpleFetch
- * implements a fetch method that automatically handles eight of the fetch()
- * arguments -- onBegin, onItem, onComplete, onError, start, count, sort and scope
- * The class mixing in simpleFetch should not implement fetch(),
- * but should instead implement a _fetchItems() method. The _fetchItems()
- * method takes three arguments, the keywordArgs object that was passed
- * to fetch(), a callback function to be called when the result array is
- * available, and an error callback to be called if something goes wrong.
- * The _fetchItems() method should ignore any keywordArgs parameters for
- * start, count, onBegin, onItem, onComplete, onError, sort, and scope.
- * The _fetchItems() method needs to correctly handle any other keywordArgs
- * parameters, including the query parameter and any optional parameters
- * (such as includeChildren). The _fetchItems() method should create an array of
- * result items and pass it to the fetchHandler along with the original request object --
- * or, the _fetchItems() method may, if it wants to, create an new request object
- * with other specifics about the request that are specific to the datastore and pass
- * that as the request object to the handler.
- *
- * For more information on this specific function, see dojo/data/api/Read.fetch()
- *
- * @param request OptionalThe keywordArgs parameter may either be an instance ofconforming to dojo/data/api/Request or may be a simple anonymous objectthat may contain any of the following:{ query: query-object or query-string, queryOptions: object, onBegin: Function, onItem: Function, onComplete: Function, onError: Function, scope: object, start: int count: int sort: array}All implementations should accept keywordArgs objects with any ofthe 9 standard properties: query, onBegin, onItem, onComplete, onErrorscope, sort, start, and count. Some implementations may accept additionalproperties in the keywordArgs object as valid parameters, such as{includeOutliers:true}.The query parameterThe query may be optional in some data store implementations.The dojo/data/api/Read API does not specify the syntax or semanticsof the query itself -- each different data store implementationmay have its own notion of what a query should look like.However, as of dojo 0.9, 1.0, and 1.1, all the provided datastores in dojo.dataand dojox.data support an object structure query, where the object is a set ofname/value parameters such as { attrFoo: valueBar, attrFoo1: valueBar1}. Most of thedijit widgets, such as ComboBox assume this to be the case when working with a datastorewhen they dynamically update the query. Therefore, for maximum compatibility with dijitwidgets the recommended query parameter is a key/value object. That does not mean that thethe datastore may not take alternative query forms, such as a simple string, a Date, a number,or a mix of such. Ultimately, The dojo/data/api/Read API is agnostic about what the queryformat.Further note: In general for query objects that accept strings as attributevalue matches, the store should also support basic filtering capability, such as (match any character) and ? (match single character). An example query that is a query objectwould be like: { attrFoo: "value"}. Which generally means match all items where they havean attribute named attrFoo, with a value that starts with 'value'.The queryOptions parameterThe queryOptions parameter is an optional parameter used to specify options that may modifythe query in some fashion, such as doing a case insensitive search, or doing a deep searchwhere all items in a hierarchical representation of data are scanned instead of just the rootitems. It currently defines two options that all datastores should attempt to honor if possible:{ ignoreCase: boolean, // Whether or not the query should match case sensitively or not. Default behaviour is false. deep: boolean // Whether or not a fetch should do a deep search of items and all child // items instead of just root-level items in a datastore. Default is false.}The onBegin parameter.function(size, request);If an onBegin callback function is provided, the callback functionwill be called just once, before the first onItem callback is called.The onBegin callback function will be passed two arguments, thethe total number of items identified and the Request object. If the total number isunknown, then size will be -1. Note that size is not necessarily the size of thecollection of items returned from the query, as the request may have specified to return only asubset of the total set of items through the use of the start and count parameters.The onItem parameter.function(item, request);If an onItem callback function is provided, the callback functionwill be called as each item in the result is received. The callbackfunction will be passed two arguments: the item itself, and theRequest object.The onComplete parameter.function(items, request);If an onComplete callback function is provided, the callback functionwill be called just once, after the last onItem callback is called.Note that if the onItem callback is not present, then onComplete will be passedan array containing all items which matched the query and the request object.If the onItem callback is present, then onComplete is called as:onComplete(null, request).The onError parameter.function(errorData, request);If an onError callback function is provided, the callback functionwill be called if there is any sort of error while attempting toexecute the query.The onError callback function will be passed two arguments:an Error object and the Request object.The scope parameter.If a scope object is provided, all of the callback functions (onItem,onComplete, onError, etc) will be invoked in the context of the scopeobject. In the body of the callback function, the value of the "this"keyword will be the scope object. If no scope object is provided,the callback functions will be called in the context of dojo.global().For example, onItem.call(scope, item, request) vs.onItem.call(dojo.global(), item, request)The start parameter.If a start parameter is specified, this is a indication to the datastore toonly start returning items once the start number of items have been located andskipped. When this parameter is paired with 'count', the store should be ableto page across queries with millions of hits by only returning subsets of thehits for each queryThe count parameter.If a count parameter is specified, this is a indication to the datastore toonly return up to that many items. This allows a fetch call that may havemillions of item matches to be paired down to something reasonable.The sort parameter.If a sort parameter is specified, this is a indication to the datastore tosort the items in some manner before returning the items. The array is an array ofjavascript objects that must conform to the following format to be applied to thefetching of items:{ attribute: attribute || attribute-name-string, descending: true|false; // Optional. Default is false.}Note that when comparing attributes, if an item contains no value for the attribute(undefined), then it the default ascending sort logic should push it to the bottomof the list. In the descending order case, it such items should appear at the top of the list.
- */
- fetch(request: Object): void;
- /**
- * The handler when items are sucessfully fetched. This function should not be called directly
- * and is used by simpleFetch.fetch().
- *
- * @param items
- * @param requestObject
- */
- fetchHandler(items: any[], requestObject: Object): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/data/util/sorter.html
- *
- *
- */
- interface sorter {
- /**
- * Basic comparison function that compares if an item is greater or less than another item
- * returns 1 if a > b, -1 if a < b, 0 if equal.
- * 'null' values (null, undefined) are treated as larger values so that they're pushed to the end of the list.
- * And compared to each other, null is equivalent to undefined.
- *
- * @param a
- * @param b
- */
- basicComparator(a: any, b: any): number;
- /**
- * Helper function to generate the sorting function based off the list of sort attributes.
- * The sort function creation will look for a property on the store called 'comparatorMap'. If it exists
- * it will look in the mapping for comparisons function for the attributes. If one is found, it will
- * use it instead of the basic comparator, which is typically used for strings, ints, booleans, and dates.
- * Returns the sorting function for this particular list of attributes and sorting directions.
- *
- * @param sortSpec A JS object that array that defines out what attribute names to sort on and whether it should be descenting or asending.The objects should be formatted as follows:{ attribute: "attributeName-string" || attribute, descending: true|false; // Default is false.}
- * @param store The datastore object to look up item values from.
- */
- createSortFunction(sortSpec: Object, store: dojo.data.api.Read): String[];
- }
- }
- }
- namespace dnd {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/Avatar.html
- *
- * Object that represents transferred DnD items visually
- *
- * @param manager
- */
- class Avatar {
- constructor(manager: any);
- /**
- * a DnD manager object
- *
- */
- "manager": Object;
- /**
- * constructor function;
- * it is separate so it can be (dynamically) overwritten in case of need
- *
- */
- construct(): void;
- /**
- * destructor for the avatar; called to remove all references so it can be garbage-collected
- *
- */
- destroy(): void;
- /**
- * updates the avatar to reflect the current DnD state
- *
- */
- update(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/Manager.html
- *
- * the manager of DnD operations (usually a singleton)
- *
- */
- class Manager extends dojo.Evented {
- constructor();
- /**
- *
- */
- "OFFSET_X": number;
- /**
- *
- */
- "OFFSET_Y": number;
- /**
- * called to notify if the current target can accept items
- *
- * @param flag
- */
- canDrop(flag: any): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- * makes the avatar; it is separate to be overwritten dynamically, if needed
- *
- */
- makeAvatar(): any;
- /**
- * Returns the current DnD manager. Creates one if it is not created yet.
- *
- */
- manager(): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * called when a source detected a mouse-out condition
- *
- * @param source the reporter
- */
- outSource(source: Object): void;
- /**
- * called when a source detected a mouse-over condition
- *
- * @param source the reporter
- */
- overSource(source: Object): void;
- /**
- * called to initiate the DnD operation
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- startDrag(source: Object, nodes: any[], copy: boolean): void;
- /**
- * stop the DnD in progress
- *
- */
- stopDrag(): void;
- /**
- * updates the avatar; it is separate to be overwritten dynamically, if needed
- *
- */
- updateAvatar(): void;
- /**
- * event processor for onkeydown:
- * watching for CTRL for copy/move status, watching for ESCAPE to cancel the drag
- *
- * @param e keyboard event
- */
- onKeyDown(e: Event): void;
- /**
- * event processor for onkeyup, watching for CTRL for copy/move status
- *
- * @param e keyboard event
- */
- onKeyUp(e: Event): void;
- /**
- * event processor for onmousemove
- *
- * @param e mouse event
- */
- onMouseMove(e: Event): void;
- /**
- * event processor for onmouseup
- *
- * @param e mouse event
- */
- onMouseUp(e: Event): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/Container.html
- *
- * a Container object, which knows when mouse hovers over it,
- * and over which element it hovers
- *
- * @param node node or node's id to build the container on
- * @param params a dictionary of parameters
- */
- class Container extends dojo.Evented {
- constructor(node: HTMLElement, params: Object);
- /**
- * Indicates whether to allow dnd item nodes to be nested within other elements.
- * By default this is false, indicating that only direct children of the container can
- * be draggable dnd item nodes
- *
- */
- "allowNested": boolean;
- /**
- * The DOM node the mouse is currently hovered over
- *
- */
- "current": HTMLElement;
- /**
- * Map from an item's id (which is also the DOMNode's id) to
- * the dojo/dnd/Container.Item itself.
- *
- */
- "map": Object;
- node: HTMLElement;
- /**
- *
- */
- "skipForm": boolean;
- /**
- * removes all data items from the map
- *
- */
- clearItems(): void;
- /**
- * creator function, dummy at the moment
- *
- */
- creator(): void;
- /**
- * removes a data item from the map by its key (id)
- *
- * @param key
- */
- delItem(key: String): void;
- /**
- * prepares this object to be garbage-collected
- *
- */
- destroy(): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- * iterates over a data map skipping members that
- * are present in the empty object (IE and/or 3rd-party libraries).
- *
- * @param f
- * @param o Optional
- */
- forInItems(f: Function, o: Object): String;
- /**
- * returns a list (an array) of all valid child nodes
- *
- */
- getAllNodes(): any;
- /**
- * returns a data item by its key (id)
- *
- * @param key
- */
- getItem(key: String): any;
- /**
- * inserts an array of new nodes before/after an anchor node
- *
- * @param data Logical representation of the object being dragged.If the drag object's type is "text" then data is a String,if it's another type then data could be a different Object,perhaps a name/value hash.
- * @param before insert before the anchor, if true, and after the anchor otherwise
- * @param anchor the anchor node to be used as a point of insertion
- */
- insertNodes(addSelected?: boolean, data?: any[], before?: boolean, anchor?: HTMLElement): Function;
- /**
- * Represents (one of) the source node(s) being dragged.
- * Contains (at least) the "type" and "data" attributes.
- *
- */
- Item(): void;
- /**
- *
- * @param params
- * @param node
- * @param Ctor
- */
- markupFactory(params: any, node: any, Ctor: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * associates a data item with its key (id)
- *
- * @param key
- * @param data
- */
- setItem(key: String, data: any): void;
- /**
- * collects valid child items and populate the map
- *
- */
- startup(): void;
- /**
- * sync up the node list with the data map
- *
- */
- sync(): Function;
- /**
- * event processor for onmouseout
- *
- * @param e mouse event
- */
- onMouseOut(e: Event): void;
- /**
- * event processor for onmouseover or touch, to mark that element as the current element
- *
- * @param e mouse event
- */
- onMouseOver(e: Event): void;
- /**
- * this function is called once, when mouse is out of our container
- *
- */
- onOutEvent(): void;
- /**
- * this function is called once, when mouse is over our container
- *
- */
- onOverEvent(): void;
- /**
- * event processor for onselectevent and ondragevent
- *
- * @param e mouse event
- */
- onSelectStart(e: Event): void;
- }
- namespace Container {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/Container.__ContainerArgs.html
- *
- *
- */
- class __ContainerArgs {
- constructor();
- /**
- * node or node's id to use as the parent node for dropped items
- * (must be underneath the 'node' parameter in the DOM)
- *
- */
- "dropParent": HTMLElement;
- /**
- * don't start the drag operation, if clicked on form elements
- *
- */
- "skipForm": boolean;
- /**
- * a creator function, which takes a data item, and returns an object like that:
- * {node: newNode, data: usedData, type: arrayOfStrings}
- *
- */
- creator(): void;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/AutoSource.html
- *
- * a source that syncs its DnD nodes by default
- *
- * @param node
- * @param params
- */
- class AutoSource extends dojo.dnd.Source {
- constructor(node: any, params: any);
- /**
- *
- */
- "accept": any[];
- /**
- * Indicates whether to allow dnd item nodes to be nested within other elements.
- * By default this is false, indicating that only direct children of the container can
- * be draggable dnd item nodes
- *
- */
- "allowNested": boolean;
- /**
- *
- */
- "autoSync": boolean;
- /**
- *
- */
- "copyOnly": boolean;
- /**
- * The DOM node the mouse is currently hovered over
- *
- */
- "current": HTMLElement;
- /**
- *
- */
- "delay": number;
- /**
- *
- */
- "generateText": boolean;
- /**
- *
- */
- "horizontal": boolean;
- /**
- *
- */
- "isSource": boolean;
- /**
- * Map from an item's id (which is also the DOMNode's id) to
- * the dojo/dnd/Container.Item itself.
- *
- */
- "map": Object;
- /**
- * The set of id's that are currently selected, such that this.selection[id] == 1
- * if the node w/that id is selected. Can iterate over selected node's id's like:
- *
- * for(var id in this.selection)
- *
- */
- "selection": Object;
- /**
- *
- */
- "selfAccept": boolean;
- /**
- *
- */
- "selfCopy": boolean;
- /**
- *
- */
- "singular": boolean;
- /**
- *
- */
- "skipForm": boolean;
- /**
- *
- */
- "withHandles": boolean;
- /**
- * checks if the target can accept nodes from this source
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- */
- checkAcceptance(source: Object, nodes: any[]): boolean;
- /**
- * removes all data items from the map
- *
- */
- clearItems(): void;
- /**
- * Returns true if we need to copy items, false to move.
- * It is separated to be overwritten dynamically, if needed.
- *
- * @param keyPressed the "copy" key was pressed
- * @param self Optionaloptional flag that means that we are about to drop on itself
- */
- copyState(keyPressed: boolean, self?: boolean): any;
- /**
- * creator function, dummy at the moment
- *
- */
- creator(): void;
- /**
- * deletes all selected items
- *
- */
- deleteSelectedNodes(): Function;
- /**
- * removes a data item from the map by its key (id)
- *
- * @param key
- */
- delItem(key: String): void;
- /**
- * prepares the object to be garbage-collected
- *
- */
- destroy(): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- * iterates over a data map skipping members that
- * are present in the empty object (IE and/or 3rd-party libraries).
- *
- * @param f
- * @param o Optional
- */
- forInItems(f: Function, o?: Object): String;
- /**
- * iterates over selected items;
- * see dojo/dnd/Container.forInItems() for details
- *
- * @param f
- * @param o Optional
- */
- forInSelectedItems(f: Function, o?: Object): void;
- /**
- * returns a list (an array) of all valid child nodes
- *
- */
- getAllNodes(): any;
- /**
- * returns a data item by its key (id)
- *
- * @param key
- */
- getItem(key: String): any;
- /**
- * returns a list (an array) of selected nodes
- *
- */
- getSelectedNodes(): any;
- /**
- * inserts new data items (see dojo/dnd/Container.insertNodes() method for details)
- *
- * @param addSelected all new nodes will be added to selected items, if true, no selection change otherwise
- * @param data a list of data items, which should be processed by the creator function
- * @param before insert before the anchor, if true, and after the anchor otherwise
- * @param anchor the anchor node to be used as a point of insertion
- */
- insertNodes(addSelected: boolean, data: any[], before: boolean, anchor: HTMLElement): Function;
- /**
- *
- * @param params
- * @param node
- * @param Ctor
- */
- markupFactory(params: any, node: any, Ctor: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * selects all items
- *
- */
- selectAll(): any;
- /**
- * unselects all items
- *
- */
- selectNone(): any;
- /**
- * associates a data item with its key (id)
- *
- * @param key
- * @param data
- */
- setItem(key: String, data: any): void;
- /**
- * collects valid child items and populate the map
- *
- */
- startup(): void;
- /**
- * sync up the node list with the data map
- *
- */
- sync(): Function;
- /**
- * topic event processor for /dnd/cancel, called to cancel the DnD operation
- *
- */
- onDndCancel(): void;
- /**
- * topic event processor for /dnd/drop, called to finish the DnD operation
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- * @param target the target which accepts items
- */
- onDndDrop(source: Object, nodes: any[], copy: boolean, target: Object): void;
- /**
- * topic event processor for /dnd/source/over, called when detected a current source
- *
- * @param source the source which has the mouse over it
- */
- onDndSourceOver(source: Object): void;
- /**
- * topic event processor for /dnd/start, called to initiate the DnD operation
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDndStart(source: Object, nodes: any[], copy: boolean): void;
- /**
- * called during the active DnD operation, when items
- * are dragged away from this target, and it is not disabled
- *
- */
- onDraggingOut(): void;
- /**
- * called during the active DnD operation, when items
- * are dragged over this target, and it is not disabled
- *
- */
- onDraggingOver(): void;
- /**
- * called only on the current target, when drop is performed
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDrop(source: Object, nodes: any[], copy: boolean): void;
- /**
- * called only on the current target, when drop is performed
- * from an external source
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDropExternal(source: Object, nodes: any[], copy: boolean): void;
- /**
- * called only on the current target, when drop is performed
- * from the same target/source
- *
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDropInternal(nodes: any[], copy: boolean): void;
- /**
- * event processor for onmousedown
- *
- * @param e mouse event
- */
- onMouseDown(e: Event): void;
- /**
- * event processor for onmousemove
- *
- * @param e mouse event
- */
- onMouseMove(e: Event): void;
- /**
- * event processor for onmouseout
- *
- * @param e mouse event
- */
- onMouseOut(e: Event): void;
- /**
- * event processor for onmouseover or touch, to mark that element as the current element
- *
- * @param e mouse event
- */
- onMouseOver(e: Event): void;
- /**
- * event processor for onmouseup
- *
- * @param e mouse event
- */
- onMouseUp(e: Event): void;
- /**
- * this function is called once, when mouse is out of our container
- *
- */
- onOutEvent(): void;
- /**
- * this function is called once, when mouse is over our container
- *
- */
- onOverEvent(): void;
- /**
- * event processor for onselectevent and ondragevent
- *
- * @param e mouse event
- */
- onSelectStart(e: Event): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/Mover.html
- *
- * an object which makes a node follow the mouse, or touch-drag on touch devices.
- * Used as a default mover, and as a base class for custom movers.
- *
- * @param node a node (or node's id) to be moved
- * @param e a mouse event, which started the move;only pageX and pageY properties are used
- * @param host Optionalobject which implements the functionality of the move,and defines proper events (onMoveStart and onMoveStop)
- */
- class Mover extends dojo.Evented {
- constructor(node: HTMLElement, e: Event, host?: Object);
- /**
- * stops the move, deletes all references, so the object can be garbage-collected
- *
- */
- destroy(): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * makes the node absolute; it is meant to be called only once.
- * relative and absolutely positioned nodes are assumed to use pixel units
- *
- * @param e
- */
- onFirstMove(e: any): void;
- /**
- * event processor for onmousemove/ontouchmove
- *
- * @param e mouse/touch event
- */
- onMouseMove(e: Event): void;
- /**
- *
- * @param e
- */
- onMouseUp(e: any): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/Moveable.html
- *
- * an object, which makes a node movable
- *
- * @param node a node (or node's id) to be moved
- * @param params Optionaloptional parameters
- */
- class Moveable extends dojo.Evented {
- constructor(node: HTMLElement, params?: Object);
- /**
- *
- */
- "delay": number;
- /**
- *
- */
- "handle": string;
- /**
- *
- */
- "skip": boolean;
- /**
- * stops watching for possible move, deletes all references, so the object can be garbage-collected
- *
- */
- destroy(): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- *
- * @param params
- * @param node
- * @param Ctor
- */
- markupFactory(params: any, node: any, Ctor: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * called when the drag is detected;
- * responsible for creation of the mover
- *
- * @param e
- */
- onDragDetected(e: Event): void;
- /**
- * called during the very first move notification;
- * can be used to initialize coordinates, can be overwritten.
- *
- * @param mover
- * @param e
- */
- onFirstMove(mover: dojo.dnd.Mover, e: Event): void;
- /**
- * event processor for onmousedown/ontouchstart, creates a Mover for the node
- *
- * @param e mouse/touch event
- */
- onMouseDown(e: Event): void;
- /**
- * event processor for onmousemove/ontouchmove, used only for delayed drags
- *
- * @param e mouse/touch event
- */
- onMouseMove(e: Event): void;
- /**
- * event processor for onmouseup, used only for delayed drags
- *
- * @param e mouse event
- */
- onMouseUp(e: Event): void;
- /**
- * called during every move notification;
- * should actually move the node; can be overwritten.
- *
- * @param mover
- * @param leftTop
- * @param e
- */
- onMove(mover: dojo.dnd.Mover, leftTop: Object, e: Event): void;
- /**
- * called after every incremental move; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMoved(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * called before every move operation
- *
- * @param mover
- */
- onMoveStart(mover: dojo.dnd.Mover): void;
- /**
- * called after every move operation
- *
- * @param mover
- */
- onMoveStop(mover: dojo.dnd.Mover): void;
- /**
- * called before every incremental move; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMoving(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * event processor for onselectevent and ondragevent
- *
- * @param e mouse event
- */
- onSelectStart(e: Event): void;
- }
- namespace Moveable {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/Moveable.__MoveableArgs.html
- *
- *
- */
- class __MoveableArgs {
- constructor();
- /**
- * delay move by this number of pixels
- *
- */
- "delay": number;
- /**
- * A node (or node's id), which is used as a mouse handle.
- * If omitted, the node itself is used as a handle.
- *
- */
- "handle": HTMLElement;
- /**
- * a constructor of custom Mover
- *
- */
- "mover": Object;
- /**
- * skip move of form elements
- *
- */
- "skip": boolean;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/Selector.html
- *
- * a Selector object, which knows how to select its children
- *
- * @param node node or node's id to build the selector on
- * @param params Optionala dictionary of parameters
- */
- class Selector extends dojo.dnd.Container {
- constructor(node: HTMLElement, params?: Object);
- /**
- * Indicates whether to allow dnd item nodes to be nested within other elements.
- * By default this is false, indicating that only direct children of the container can
- * be draggable dnd item nodes
- *
- */
- "allowNested": boolean;
- /**
- * The DOM node the mouse is currently hovered over
- *
- */
- "current": HTMLElement;
- /**
- * Map from an item's id (which is also the DOMNode's id) to
- * the dojo/dnd/Container.Item itself.
- *
- */
- "map": Object;
- /**
- * The set of id's that are currently selected, such that this.selection[id] == 1
- * if the node w/that id is selected. Can iterate over selected node's id's like:
- *
- * for(var id in this.selection)
- *
- */
- "selection": Object;
- /**
- *
- */
- "singular": boolean;
- /**
- *
- */
- "skipForm": boolean;
- /**
- * removes all data items from the map
- *
- */
- clearItems(): void;
- /**
- * creator function, dummy at the moment
- *
- */
- creator(): void;
- /**
- * deletes all selected items
- *
- */
- deleteSelectedNodes(): Function;
- /**
- * removes a data item from the map by its key (id)
- *
- * @param key
- */
- delItem(key: String): void;
- /**
- * prepares the object to be garbage-collected
- *
- */
- destroy(): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- * iterates over a data map skipping members that
- * are present in the empty object (IE and/or 3rd-party libraries).
- *
- * @param f
- * @param o Optional
- */
- forInItems(f: Function, o?: Object): String;
- /**
- * iterates over selected items;
- * see dojo/dnd/Container.forInItems() for details
- *
- * @param f
- * @param o Optional
- */
- forInSelectedItems(f: Function, o?: Object): void;
- /**
- * returns a list (an array) of all valid child nodes
- *
- */
- getAllNodes(): any;
- /**
- * returns a data item by its key (id)
- *
- * @param key
- */
- getItem(key: String): any;
- /**
- * returns a list (an array) of selected nodes
- *
- */
- getSelectedNodes(): any;
- /**
- * inserts new data items (see dojo/dnd/Container.insertNodes() method for details)
- *
- * @param addSelected all new nodes will be added to selected items, if true, no selection change otherwise
- * @param data a list of data items, which should be processed by the creator function
- * @param before insert before the anchor, if true, and after the anchor otherwise
- * @param anchor the anchor node to be used as a point of insertion
- */
- insertNodes(addSelected?: boolean, data?: any[], before?: boolean, anchor?: HTMLElement): Function;
- /**
- *
- * @param params
- * @param node
- * @param Ctor
- */
- markupFactory(params: any, node: any, Ctor: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * selects all items
- *
- */
- selectAll(): any;
- /**
- * unselects all items
- *
- */
- selectNone(): any;
- /**
- * associates a data item with its key (id)
- *
- * @param key
- * @param data
- */
- setItem(key: String, data: any): void;
- /**
- * collects valid child items and populate the map
- *
- */
- startup(): void;
- /**
- * sync up the node list with the data map
- *
- */
- sync(): Function;
- /**
- * event processor for onmousedown
- *
- * @param e mouse event
- */
- onMouseDown(e: Event): void;
- /**
- * event processor for onmousemove
- *
- * @param e mouse event
- */
- onMouseMove(e: Event): void;
- /**
- * event processor for onmouseout
- *
- * @param e mouse event
- */
- onMouseOut(e: Event): void;
- /**
- * event processor for onmouseover or touch, to mark that element as the current element
- *
- * @param e mouse event
- */
- onMouseOver(e: Event): void;
- /**
- * event processor for onmouseup
- *
- * @param e mouse event
- */
- onMouseUp(e: Event): void;
- /**
- * this function is called once, when mouse is out of our container
- *
- */
- onOutEvent(): void;
- /**
- * this function is called once, when mouse is over our container
- *
- */
- onOverEvent(): void;
- /**
- * event processor for onselectevent and ondragevent
- *
- * @param e mouse event
- */
- onSelectStart(e: Event): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/TimedMoveable.html
- *
- * A specialized version of Moveable to support an FPS throttling.
- * This class puts an upper restriction on FPS, which may reduce
- * the CPU load. The additional parameter "timeout" regulates
- * the delay before actually moving the moveable object.
- *
- * @param node a node (or node's id) to be moved
- * @param params object with additional parameters.
- */
- class TimedMoveable extends dojo.dnd.Moveable {
- constructor(node: HTMLElement, params: Object);
- /**
- *
- */
- "delay": number;
- /**
- *
- */
- "handle": string;
- /**
- *
- */
- "skip": boolean;
- /**
- *
- */
- "timeout": number;
- /**
- * stops watching for possible move, deletes all references, so the object can be garbage-collected
- *
- */
- destroy(): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- *
- * @param params
- * @param node
- * @param Ctor
- */
- markupFactory(params: any, node: any, Ctor: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * called when the drag is detected;
- * responsible for creation of the mover
- *
- * @param e
- */
- onDragDetected(e: Event): void;
- /**
- * called during the very first move notification;
- * can be used to initialize coordinates, can be overwritten.
- *
- * @param mover
- * @param e
- */
- onFirstMove(mover: dojo.dnd.Mover, e: Event): void;
- /**
- * event processor for onmousedown/ontouchstart, creates a Mover for the node
- *
- * @param e mouse/touch event
- */
- onMouseDown(e: Event): void;
- /**
- * event processor for onmousemove/ontouchmove, used only for delayed drags
- *
- * @param e mouse/touch event
- */
- onMouseMove(e: Event): void;
- /**
- * event processor for onmouseup, used only for delayed drags
- *
- * @param e mouse event
- */
- onMouseUp(e: Event): void;
- /**
- *
- * @param mover
- * @param leftTop
- */
- onMove(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * called after every incremental move; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMoved(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * called before every move operation
- *
- * @param mover
- */
- onMoveStart(mover: dojo.dnd.Mover): void;
- /**
- *
- * @param mover
- */
- onMoveStop(mover: dojo.dnd.Mover): void;
- /**
- * called before every incremental move; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMoving(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * event processor for onselectevent and ondragevent
- *
- * @param e mouse event
- */
- onSelectStart(e: Event): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/Target.html
- *
- * a Target object, which can be used as a DnD target
- *
- * @param node
- * @param params
- */
- class Target extends dojo.dnd.Source {
- constructor(node: any, params: any);
- /**
- *
- */
- "accept": any[];
- /**
- * Indicates whether to allow dnd item nodes to be nested within other elements.
- * By default this is false, indicating that only direct children of the container can
- * be draggable dnd item nodes
- *
- */
- "allowNested": boolean;
- /**
- *
- */
- "autoSync": boolean;
- /**
- *
- */
- "copyOnly": boolean;
- /**
- * The DOM node the mouse is currently hovered over
- *
- */
- "current": HTMLElement;
- /**
- *
- */
- "delay": number;
- /**
- *
- */
- "generateText": boolean;
- /**
- *
- */
- "horizontal": boolean;
- /**
- *
- */
- "isSource": boolean;
- /**
- * Map from an item's id (which is also the DOMNode's id) to
- * the dojo/dnd/Container.Item itself.
- *
- */
- "map": Object;
- /**
- * The set of id's that are currently selected, such that this.selection[id] == 1
- * if the node w/that id is selected. Can iterate over selected node's id's like:
- *
- * for(var id in this.selection)
- *
- */
- "selection": Object;
- /**
- *
- */
- "selfAccept": boolean;
- /**
- *
- */
- "selfCopy": boolean;
- /**
- *
- */
- "singular": boolean;
- /**
- *
- */
- "skipForm": boolean;
- /**
- *
- */
- "withHandles": boolean;
- /**
- * checks if the target can accept nodes from this source
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- */
- checkAcceptance(source: Object, nodes: any[]): boolean;
- /**
- * removes all data items from the map
- *
- */
- clearItems(): void;
- /**
- * Returns true if we need to copy items, false to move.
- * It is separated to be overwritten dynamically, if needed.
- *
- * @param keyPressed the "copy" key was pressed
- * @param self Optionaloptional flag that means that we are about to drop on itself
- */
- copyState(keyPressed: boolean, self?: boolean): any;
- /**
- * creator function, dummy at the moment
- *
- */
- creator(): void;
- /**
- * deletes all selected items
- *
- */
- deleteSelectedNodes(): Function;
- /**
- * removes a data item from the map by its key (id)
- *
- * @param key
- */
- delItem(key: String): void;
- /**
- * prepares the object to be garbage-collected
- *
- */
- destroy(): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- * iterates over a data map skipping members that
- * are present in the empty object (IE and/or 3rd-party libraries).
- *
- * @param f
- * @param o Optional
- */
- forInItems(f: Function, o?: Object): String;
- /**
- * iterates over selected items;
- * see dojo/dnd/Container.forInItems() for details
- *
- * @param f
- * @param o Optional
- */
- forInSelectedItems(f: Function, o?: Object): void;
- /**
- * returns a list (an array) of all valid child nodes
- *
- */
- getAllNodes(): any;
- /**
- * returns a data item by its key (id)
- *
- * @param key
- */
- getItem(key: String): any;
- /**
- * returns a list (an array) of selected nodes
- *
- */
- getSelectedNodes(): any;
- /**
- * inserts new data items (see dojo/dnd/Container.insertNodes() method for details)
- *
- * @param addSelected all new nodes will be added to selected items, if true, no selection change otherwise
- * @param data a list of data items, which should be processed by the creator function
- * @param before insert before the anchor, if true, and after the anchor otherwise
- * @param anchor the anchor node to be used as a point of insertion
- */
- insertNodes(addSelected: boolean, data: any[], before?: boolean, anchor?: HTMLElement): Function;
- /**
- *
- * @param params
- * @param node
- * @param Ctor
- */
- markupFactory(params: any, node: any, Ctor: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * selects all items
- *
- */
- selectAll(): any;
- /**
- * unselects all items
- *
- */
- selectNone(): any;
- /**
- * associates a data item with its key (id)
- *
- * @param key
- * @param data
- */
- setItem(key: String, data: any): void;
- /**
- * collects valid child items and populate the map
- *
- */
- startup(): void;
- /**
- * sync up the node list with the data map
- *
- */
- sync(): Function;
- /**
- * topic event processor for /dnd/cancel, called to cancel the DnD operation
- *
- */
- onDndCancel(): void;
- /**
- * topic event processor for /dnd/drop, called to finish the DnD operation
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- * @param target the target which accepts items
- */
- onDndDrop(source: Object, nodes: any[], copy: boolean, target: Object): void;
- /**
- * topic event processor for /dnd/source/over, called when detected a current source
- *
- * @param source the source which has the mouse over it
- */
- onDndSourceOver(source: Object): void;
- /**
- * topic event processor for /dnd/start, called to initiate the DnD operation
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDndStart(source: Object, nodes: any[], copy: boolean): void;
- /**
- * called during the active DnD operation, when items
- * are dragged away from this target, and it is not disabled
- *
- */
- onDraggingOut(): void;
- /**
- * called during the active DnD operation, when items
- * are dragged over this target, and it is not disabled
- *
- */
- onDraggingOver(): void;
- /**
- * called only on the current target, when drop is performed
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDrop(source: Object, nodes: any[], copy: boolean): void;
- /**
- * called only on the current target, when drop is performed
- * from an external source
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDropExternal(source: Object, nodes: any[], copy: boolean): void;
- /**
- * called only on the current target, when drop is performed
- * from the same target/source
- *
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDropInternal(nodes: any[], copy: boolean): void;
- /**
- * event processor for onmousedown
- *
- * @param e mouse event
- */
- onMouseDown(e: Event): void;
- /**
- * event processor for onmousemove
- *
- * @param e mouse event
- */
- onMouseMove(e: Event): void;
- /**
- * event processor for onmouseout
- *
- * @param e mouse event
- */
- onMouseOut(e: Event): void;
- /**
- * event processor for onmouseover or touch, to mark that element as the current element
- *
- * @param e mouse event
- */
- onMouseOver(e: Event): void;
- /**
- * event processor for onmouseup
- *
- * @param e mouse event
- */
- onMouseUp(e: Event): void;
- /**
- * this function is called once, when mouse is out of our container
- *
- */
- onOutEvent(): void;
- /**
- * this function is called once, when mouse is over our container
- *
- */
- onOverEvent(): void;
- /**
- * event processor for onselectevent and ondragevent
- *
- * @param e mouse event
- */
- onSelectStart(e: Event): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/Source.html
- *
- * a Source object, which can be used as a DnD source, or a DnD target
- *
- * @param node node or node's id to build the source on
- * @param params Optionalany property of this class may be configured via the paramsobject which is mixed-in to the dojo/dnd/Source instance
- */
- class Source extends dojo.dnd.Selector {
- constructor(node: HTMLElement, params?: Object);
- /**
- *
- */
- "accept": any[];
- /**
- * Indicates whether to allow dnd item nodes to be nested within other elements.
- * By default this is false, indicating that only direct children of the container can
- * be draggable dnd item nodes
- *
- */
- "allowNested": boolean;
- /**
- *
- */
- "autoSync": boolean;
- /**
- *
- */
- "copyOnly": boolean;
- /**
- * The DOM node the mouse is currently hovered over
- *
- */
- "current": HTMLElement;
- /**
- *
- */
- "delay": number;
- /**
- *
- */
- "generateText": boolean;
- /**
- *
- */
- "horizontal": boolean;
- /**
- *
- */
- "isSource": boolean;
- /**
- * Map from an item's id (which is also the DOMNode's id) to
- * the dojo/dnd/Container.Item itself.
- *
- */
- "map": Object;
- /**
- * The set of id's that are currently selected, such that this.selection[id] == 1
- * if the node w/that id is selected. Can iterate over selected node's id's like:
- *
- * for(var id in this.selection)
- *
- */
- "selection": Object;
- /**
- *
- */
- "selfAccept": boolean;
- /**
- *
- */
- "selfCopy": boolean;
- /**
- *
- */
- "singular": boolean;
- /**
- *
- */
- "skipForm": boolean;
- /**
- *
- */
- "withHandles": boolean;
- /**
- * checks if the target can accept nodes from this source
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- */
- checkAcceptance(source: Object, nodes: any[]): boolean;
- /**
- * removes all data items from the map
- *
- */
- clearItems(): void;
- /**
- * Returns true if we need to copy items, false to move.
- * It is separated to be overwritten dynamically, if needed.
- *
- * @param keyPressed the "copy" key was pressed
- * @param self Optionaloptional flag that means that we are about to drop on itself
- */
- copyState(keyPressed: boolean, self?: boolean): any;
- /**
- * creator function, dummy at the moment
- *
- */
- creator(): void;
- /**
- * deletes all selected items
- *
- */
- deleteSelectedNodes(): Function;
- /**
- * removes a data item from the map by its key (id)
- *
- * @param key
- */
- delItem(key: String): void;
- /**
- * prepares the object to be garbage-collected
- *
- */
- destroy(): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- * iterates over a data map skipping members that
- * are present in the empty object (IE and/or 3rd-party libraries).
- *
- * @param f
- * @param o Optional
- */
- forInItems(f: Function, o?: Object): String;
- /**
- * iterates over selected items;
- * see dojo/dnd/Container.forInItems() for details
- *
- * @param f
- * @param o Optional
- */
- forInSelectedItems(f: Function, o?: Object): void;
- /**
- * returns a list (an array) of all valid child nodes
- *
- */
- getAllNodes(): any;
- /**
- * returns a data item by its key (id)
- *
- * @param key
- */
- getItem(key: String): any;
- /**
- * returns a list (an array) of selected nodes
- *
- */
- getSelectedNodes(): any;
- /**
- * inserts new data items (see dojo/dnd/Container.insertNodes() method for details)
- *
- * @param addSelected all new nodes will be added to selected items, if true, no selection change otherwise
- * @param data a list of data items, which should be processed by the creator function
- * @param before insert before the anchor, if true, and after the anchor otherwise
- * @param anchor the anchor node to be used as a point of insertion
- */
- insertNodes(addSelected: boolean, data: any[], before?: boolean, anchor?: HTMLElement): Function;
- /**
- *
- * @param params
- * @param node
- * @param Ctor
- */
- markupFactory(params: any, node: any, Ctor: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * selects all items
- *
- */
- selectAll(): any;
- /**
- * unselects all items
- *
- */
- selectNone(): any;
- /**
- * associates a data item with its key (id)
- *
- * @param key
- * @param data
- */
- setItem(key: String, data: any): void;
- /**
- * collects valid child items and populate the map
- *
- */
- startup(): void;
- /**
- * sync up the node list with the data map
- *
- */
- sync(): Function;
- /**
- * topic event processor for /dnd/cancel, called to cancel the DnD operation
- *
- */
- onDndCancel(): void;
- /**
- * topic event processor for /dnd/drop, called to finish the DnD operation
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- * @param target the target which accepts items
- */
- onDndDrop(source: Object, nodes: any[], copy: boolean, target: Object): void;
- /**
- * topic event processor for /dnd/source/over, called when detected a current source
- *
- * @param source the source which has the mouse over it
- */
- onDndSourceOver(source: Object): void;
- /**
- * topic event processor for /dnd/start, called to initiate the DnD operation
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDndStart(source: Object, nodes: any[], copy: boolean): void;
- /**
- * called during the active DnD operation, when items
- * are dragged away from this target, and it is not disabled
- *
- */
- onDraggingOut(): void;
- /**
- * called during the active DnD operation, when items
- * are dragged over this target, and it is not disabled
- *
- */
- onDraggingOver(): void;
- /**
- * called only on the current target, when drop is performed
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDrop(source: Object, nodes: any[], copy: boolean): void;
- /**
- * called only on the current target, when drop is performed
- * from an external source
- *
- * @param source the source which provides items
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDropExternal(source: Object, nodes: any[], copy: boolean): void;
- /**
- * called only on the current target, when drop is performed
- * from the same target/source
- *
- * @param nodes the list of transferred items
- * @param copy copy items, if true, move items otherwise
- */
- onDropInternal(nodes: any[], copy: boolean): void;
- /**
- * event processor for onmousedown
- *
- * @param e mouse event
- */
- onMouseDown(e: Event): void;
- /**
- * event processor for onmousemove
- *
- * @param e mouse event
- */
- onMouseMove(e: Event): void;
- /**
- * event processor for onmouseout
- *
- * @param e mouse event
- */
- onMouseOut(e: Event): void;
- /**
- * event processor for onmouseover or touch, to mark that element as the current element
- *
- * @param e mouse event
- */
- onMouseOver(e: Event): void;
- /**
- * event processor for onmouseup
- *
- * @param e mouse event
- */
- onMouseUp(e: Event): void;
- /**
- * this function is called once, when mouse is out of our container
- *
- */
- onOutEvent(): void;
- /**
- * this function is called once, when mouse is over our container
- *
- */
- onOverEvent(): void;
- /**
- * event processor for onselectevent and ondragevent
- *
- * @param e mouse event
- */
- onSelectStart(e: Event): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/autoscroll.html
- *
- * Used by dojo/dnd/Manager to scroll document or internal node when the user
- * drags near the edge of the viewport or a scrollable node
- *
- */
- interface autoscroll {
- /**
- *
- */
- H_AUTOSCROLL_VALUE: number;
- /**
- *
- */
- H_TRIGGER_AUTOSCROLL: number;
- /**
- *
- */
- V_AUTOSCROLL_VALUE: number;
- /**
- *
- */
- V_TRIGGER_AUTOSCROLL: number;
- /**
- * a handler for mousemove and touchmove events, which scrolls the window, if
- * necessary
- *
- * @param e mousemove/touchmove event
- */
- autoScroll(e: Event): void;
- /**
- * a handler for mousemove and touchmove events, which scrolls the first available
- * Dom element, it falls back to exports.autoScroll()
- *
- * @param e mousemove/touchmove event
- */
- autoScrollNodes(e: Event): void;
- /**
- * Called at the start of a drag.
- *
- * @param d The document of the node being dragged.
- */
- autoScrollStart(d: HTMLDocument): void;
- /**
- * Returns the dimensions and scroll position of the viewable area of a browser window
- *
- * @param doc Optional
- */
- getViewport(doc?: HTMLDocument): Object;
- }
- namespace autoscroll {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/autoscroll._validOverflow.html
- *
- *
- */
- interface _validOverflow {
- /**
- *
- */
- auto: number;
- /**
- *
- */
- scroll: number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/autoscroll._validNodes.html
- *
- *
- */
- interface _validNodes {
- /**
- *
- */
- div: number;
- /**
- *
- */
- p: number;
- /**
- *
- */
- td: number;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/common.html
- *
- * TODOC
- *
- */
- interface common {
- /**
- *
- * @param evt
- */
- getCopyKeyState(evt: any): any;
- /**
- * returns a unique string for use with any DOM element
- *
- */
- getUniqueId(): String;
- /**
- * returns true if user clicked on a form element
- *
- * @param e
- */
- isFormElement(e: Event): void;
- /**
- * Returns the current DnD manager. Creates one if it is not created yet.
- *
- */
- manager(): any;
- }
- namespace common {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/common._empty.html
- *
- *
- */
- interface _empty {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/common._defaultCreatorNodes.html
- *
- *
- */
- interface _defaultCreatorNodes {
- /**
- *
- */
- div: string;
- /**
- *
- */
- ol: string;
- /**
- *
- */
- p: string;
- /**
- *
- */
- ul: string;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/move.html
- *
- * TODOC
- *
- */
- interface move {
- /**
- *
- */
- boxConstrainedMoveable(): void;
- /**
- *
- */
- constrainedMoveable(): void;
- /**
- *
- */
- parentConstrainedMoveable(): void;
- }
- namespace move {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/move.parentConstrainedMoveable.html
- *
- *
- * @param node a node (or node's id) to be moved
- * @param params Optionalan optional object with parameters
- */
- class parentConstrainedMoveable extends dojo.dnd.Moveable {
- constructor(node: HTMLElement, params?: Object);
- /**
- * object attributes (for markup)
- *
- */
- "area": string;
- /**
- *
- */
- "delay": number;
- /**
- *
- */
- "handle": string;
- /**
- *
- */
- "skip": boolean;
- /**
- *
- */
- "within": boolean;
- /**
- *
- */
- constraints(): void;
- /**
- * stops watching for possible move, deletes all references, so the object can be garbage-collected
- *
- */
- destroy(): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- *
- * @param params
- * @param node
- * @param Ctor
- */
- markupFactory(params: any, node: any, Ctor: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * called when the drag is detected;
- * responsible for creation of the mover
- *
- * @param e
- */
- onDragDetected(e: Event): void;
- /**
- * called during the very first move notification;
- * can be used to initialize coordinates, can be overwritten.
- *
- * @param mover
- */
- onFirstMove(mover: dojo.dnd.Mover): void;
- /**
- * event processor for onmousedown/ontouchstart, creates a Mover for the node
- *
- * @param e mouse/touch event
- */
- onMouseDown(e: Event): void;
- /**
- * event processor for onmousemove/ontouchmove, used only for delayed drags
- *
- * @param e mouse/touch event
- */
- onMouseMove(e: Event): void;
- /**
- * event processor for onmouseup, used only for delayed drags
- *
- * @param e mouse event
- */
- onMouseUp(e: Event): void;
- /**
- * called during every move notification;
- * should actually move the node; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMove(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * called after every incremental move; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMoved(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * called before every move operation
- *
- * @param mover
- */
- onMoveStart(mover: dojo.dnd.Mover): void;
- /**
- * called after every move operation
- *
- * @param mover
- */
- onMoveStop(mover: dojo.dnd.Mover): void;
- /**
- * called before every incremental move; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMoving(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * event processor for onselectevent and ondragevent
- *
- * @param e mouse event
- */
- onSelectStart(e: Event): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/move.boxConstrainedMoveable.html
- *
- *
- * @param node a node (or node's id) to be moved
- * @param params Optionalan optional object with parameters
- */
- class boxConstrainedMoveable extends dojo.dnd.Moveable {
- constructor(node: HTMLElement, params?: Object);
- /**
- * object attributes (for markup)
- *
- */
- "box": Object;
- /**
- *
- */
- "delay": number;
- /**
- *
- */
- "handle": string;
- /**
- *
- */
- "skip": boolean;
- /**
- *
- */
- "within": boolean;
- /**
- *
- */
- constraints(): void;
- /**
- * stops watching for possible move, deletes all references, so the object can be garbage-collected
- *
- */
- destroy(): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- *
- * @param params
- * @param node
- * @param Ctor
- */
- markupFactory(params: any, node: any, Ctor: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * called when the drag is detected;
- * responsible for creation of the mover
- *
- * @param e
- */
- onDragDetected(e: Event): void;
- /**
- * called during the very first move notification;
- * can be used to initialize coordinates, can be overwritten.
- *
- * @param mover
- */
- onFirstMove(mover: dojo.dnd.Mover): void;
- /**
- * event processor for onmousedown/ontouchstart, creates a Mover for the node
- *
- * @param e mouse/touch event
- */
- onMouseDown(e: Event): void;
- /**
- * event processor for onmousemove/ontouchmove, used only for delayed drags
- *
- * @param e mouse/touch event
- */
- onMouseMove(e: Event): void;
- /**
- * event processor for onmouseup, used only for delayed drags
- *
- * @param e mouse event
- */
- onMouseUp(e: Event): void;
- /**
- * called during every move notification;
- * should actually move the node; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMove(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * called after every incremental move; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMoved(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * called before every move operation
- *
- * @param mover
- */
- onMoveStart(mover: dojo.dnd.Mover): void;
- /**
- * called after every move operation
- *
- * @param mover
- */
- onMoveStop(mover: dojo.dnd.Mover): void;
- /**
- * called before every incremental move; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMoving(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * event processor for onselectevent and ondragevent
- *
- * @param e mouse event
- */
- onSelectStart(e: Event): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dnd/move.constrainedMoveable.html
- *
- *
- * @param node a node (or node's id) to be moved
- * @param params Optionalan optional object with additional parameters;the rest is passed to the base class
- */
- class constrainedMoveable extends dojo.dnd.Moveable {
- constructor(node: HTMLElement, params?: Object);
- /**
- *
- */
- "delay": number;
- /**
- *
- */
- "handle": string;
- /**
- *
- */
- "skip": boolean;
- /**
- *
- */
- "within": boolean;
- /**
- *
- */
- constraints(): void;
- /**
- * stops watching for possible move, deletes all references, so the object can be garbage-collected
- *
- */
- destroy(): void;
- /**
- *
- * @param type
- * @param event
- */
- emit(type: any, event: any): any;
- /**
- *
- * @param params
- * @param node
- * @param Ctor
- */
- markupFactory(params: any, node: any, Ctor: any): any;
- /**
- *
- * @param type
- * @param listener
- */
- on(type: any, listener: any): any;
- /**
- * called when the drag is detected;
- * responsible for creation of the mover
- *
- * @param e
- */
- onDragDetected(e: Event): void;
- /**
- * called during the very first move notification;
- * can be used to initialize coordinates, can be overwritten.
- *
- * @param mover
- */
- onFirstMove(mover: dojo.dnd.Mover): void;
- /**
- * event processor for onmousedown/ontouchstart, creates a Mover for the node
- *
- * @param e mouse/touch event
- */
- onMouseDown(e: Event): void;
- /**
- * event processor for onmousemove/ontouchmove, used only for delayed drags
- *
- * @param e mouse/touch event
- */
- onMouseMove(e: Event): void;
- /**
- * event processor for onmouseup, used only for delayed drags
- *
- * @param e mouse event
- */
- onMouseUp(e: Event): void;
- /**
- * called during every move notification;
- * should actually move the node; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMove(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * called after every incremental move; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMoved(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * called before every move operation
- *
- * @param mover
- */
- onMoveStart(mover: dojo.dnd.Mover): void;
- /**
- * called after every move operation
- *
- * @param mover
- */
- onMoveStop(mover: dojo.dnd.Mover): void;
- /**
- * called before every incremental move; can be overwritten.
- *
- * @param mover
- * @param leftTop
- */
- onMoving(mover: dojo.dnd.Mover, leftTop: Object): void;
- /**
- * event processor for onselectevent and ondragevent
- *
- * @param e mouse event
- */
- onSelectStart(e: Event): void;
- }
- }
- }
- namespace errors {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/errors/create.html
- *
- *
- * @param name
- * @param ctor
- * @param base
- * @param props
- */
- interface create{(name: any, ctor: any, base: any, props: any): void}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/errors/CancelError.html
- *
- * Default error if a promise is canceled without a reason.
- *
- */
- interface CancelError{(): void}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/errors/RequestError.html
- *
- * TODOC
- *
- */
- interface RequestError{(): void}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/errors/RequestTimeoutError.html
- *
- * TODOC
- *
- */
- interface RequestTimeoutError{(): void}
- }
- namespace io {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/io/iframe.html
- *
- * Deprecated, use dojo/request/iframe instead.
- * Sends an Ajax I/O call using and Iframe (for instance, to upload files)
- *
- */
- interface iframe {
- /**
- * Creates a hidden iframe in the page. Used mostly for IO
- * transports. You do not need to call this to start a
- * dojo/io/iframe request. Just call send().
- *
- * @param fname The name of the iframe. Used for the name attribute on theiframe.
- * @param onloadstr A string of JavaScript that will be executed when the contentin the iframe loads.
- * @param uri The value of the src attribute on the iframe element. If avalue is not given, then dojo/resources/blank.html will beused.
- */
- create(fname: String, onloadstr: String, uri: String): void;
- /**
- * Returns the document object associated with the iframe DOM Node argument.
- *
- * @param iframeNode
- */
- doc(iframeNode: any): void;
- /**
- * Sets the URL that is loaded in an IFrame. The replace parameter
- * indicates whether location.replace() should be used when
- * changing the location of the iframe.
- *
- * @param iframe
- * @param src
- * @param replace
- */
- setSrc(iframe: any, src: any, replace: any): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/io/script.html
- *
- * TODOC
- *
- */
- interface script {
- /**
- * creates a new <script> tag pointing to the specified URL and
- * adds it to the document.
- * Attaches the script element to the DOM. Use this method if you
- * just want to attach a script to the DOM and do not care when or
- * if it loads.
- *
- * @param id
- * @param url
- * @param frameDocument
- */
- attach(id: any, url: any, frameDocument: any): void;
- /**
- * sends a get request using a dynamically created script tag.
- *
- * @param args An object with the following properties:callbackParamName (String): Deprecated as of Dojo 1.4 in favor of "jsonp", but still supported forlegacy code. See notes for jsonp property.jsonp (String): The URL parameter name that indicates the JSONP callback string.For instance, when using Yahoo JSONP calls it is normally,jsonp: "callback". For AOL JSONP calls it is normallyjsonp: "c".checkString (String): A string of JavaScript that when evaluated like so:"typeof(" + checkString + ") != 'undefined'"being true means that the script fetched has been loaded.Do not use this if doing a JSONP type of call (use callbackParamName instead).frameDoc (Document): The Document object for a child iframe. If this is passed in, the scriptwill be attached to that document. This can be helpful in some comet long-pollingscenarios with Firefox and Opera.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.handleAs (String, optional): Acceptable values depend on the type of IOtransport (see specific IO calls for more information).rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- get(args: Object): any;
- /**
- * removes the script element with the given id, from the given frameDocument.
- * If no frameDocument is passed, the current document is used.
- *
- * @param id
- * @param frameDocument
- */
- remove(id: any, frameDocument: any): void;
- }
- }
- namespace promise {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/promise/all.html
- *
- * Takes multiple promises and returns a new promise that is fulfilled
- * when all promises have been fulfilled.
- * Takes multiple promises and returns a new promise that is fulfilled
- * when all promises have been fulfilled. If one of the promises is rejected,
- * the returned promise is also rejected. Canceling the returned promise will
- * not cancel any passed promises.
- *
- * @param objectOrArray OptionalThe promise will be fulfilled with a list of results if invoked with anarray, or an object of results when passed an object (using the samekeys). If passed neither an object or array it is resolved with anundefined value.
- */
- interface all{<T>(value: Promise<T>[]): Promise<T[]>}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/promise/all.html
- *
- * Takes multiple promises and returns a new promise that is fulfilled
- * when all promises have been fulfilled.
- * Takes multiple promises and returns a new promise that is fulfilled
- * when all promises have been fulfilled. If one of the promises is rejected,
- * the returned promise is also rejected. Canceling the returned promise will
- * not cancel any passed promises.
- *
- * @param objectOrArray OptionalThe promise will be fulfilled with a list of results if invoked with anarray, or an object of results when passed an object (using the samekeys). If passed neither an object or array it is resolved with anundefined value.
- */
- interface all{(value: Object): Promise<any>}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/promise/first.html
- *
- * Takes multiple promises and returns a new promise that is fulfilled
- * when the first of these promises is fulfilled.
- * Takes multiple promises and returns a new promise that is fulfilled
- * when the first of these promises is fulfilled. Canceling the returned
- * promise will not cancel any passed promises. The promise will be
- * fulfilled with the value of the first fulfilled promise.
- *
- * @param objectOrArray OptionalThe promises are taken from the array or object values. If no valueis passed, the returned promise is resolved with an undefined value.
- */
- interface first{(objectOrArray?: Object): void}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/promise/first.html
- *
- * Takes multiple promises and returns a new promise that is fulfilled
- * when the first of these promises is fulfilled.
- * Takes multiple promises and returns a new promise that is fulfilled
- * when the first of these promises is fulfilled. Canceling the returned
- * promise will not cancel any passed promises. The promise will be
- * fulfilled with the value of the first fulfilled promise.
- *
- * @param objectOrArray OptionalThe promises are taken from the array or object values. If no valueis passed, the returned promise is resolved with an undefined value.
- */
- interface first{(objectOrArray?: any[]): void}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/promise/instrumentation.html
- *
- * Initialize instrumentation for the Deferred class.
- * Initialize instrumentation for the Deferred class.
- * Done automatically by dojo/Deferred if the
- * deferredInstrumentation and useDeferredInstrumentation
- * config options are set.
- *
- * Sets up dojo/promise/tracer to log to the console.
- *
- * Sets up instrumentation of rejected deferreds so unhandled
- * errors are logged to the console.
- *
- * @param Deferred
- */
- interface instrumentation{(Deferred: any): void}
- interface Callback<T, U> {
- (arg: T): U|Promise<U>;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/promise/Promise.html
- *
- * The public interface to a deferred.
- * The public interface to a deferred. All promises in Dojo are
- * instances of this class.
- *
- */
- interface Promise<T> {
- /**
- * Add a callback to be invoked when the promise is resolved
- * or rejected.
- *
- * @param callbackOrErrback OptionalA function that is used both as a callback and errback.
- */
- always<U>(callbackOrErrback: Callback<any, U>): Promise<U>;
- /**
- * Inform the deferred it may cancel its asynchronous operation.
- * Inform the deferred it may cancel its asynchronous operation.
- * The deferred's (optional) canceler is invoked and the
- * deferred will be left in a rejected state. Can affect other
- * promises that originate with the same deferred.
- *
- * @param reason A message that may be sent to the deferred's canceler,explaining why it's being canceled.
- * @param strict OptionalIf strict, will throw an error if the deferred has alreadybeen fulfilled and consequently cannot be canceled.
- */
- cancel(reason: any, strict?: boolean): any;
- /**
- * Checks whether the promise has been canceled.
- *
- */
- isCanceled(): boolean;
- /**
- * Checks whether the promise has been resolved or rejected.
- *
- */
- isFulfilled(): boolean;
- /**
- * Checks whether the promise has been rejected.
- *
- */
- isRejected(): boolean;
- /**
- * Checks whether the promise has been resolved.
- *
- */
- isResolved(): boolean;
- /**
- * Add new errbacks to the promise.
- *
- * @param errback OptionalCallback to be invoked when the promise is rejected.
- */
- otherwise<U>(errback?: Callback<any, U>): Promise<U>;
- /**
- * Add new callbacks to the promise.
- * Add new callbacks to the deferred. Callbacks can be added
- * before or after the deferred is fulfilled.
- *
- * @param callback OptionalCallback to be invoked when the promise is resolved.Receives the resolution value.
- * @param errback OptionalCallback to be invoked when the promise is rejected.Receives the rejection error.
- * @param progback OptionalCallback to be invoked when the promise emits a progressupdate. Receives the progress update.
- */
- then<U>(callback?: Callback<T, U>, errback?: Callback<any, U>, progback?: Callback<any, U>): Promise<U>;
- /**
- *
- */
- toString(): String;
- /**
- * Trace the promise.
- * Tracing allows you to transparently log progress,
- * resolution and rejection of promises, without affecting the
- * promise itself. Any arguments passed to trace() are
- * emitted in trace events. See dojo/promise/tracer on how
- * to handle traces.
- *
- */
- trace(): Promise<T>;
- /**
- * Trace rejection of the promise.
- * Tracing allows you to transparently log progress,
- * resolution and rejection of promises, without affecting the
- * promise itself. Any arguments passed to trace() are
- * emitted in trace events. See dojo/promise/tracer on how
- * to handle traces.
- *
- */
- traceRejected(): Promise<T>;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/promise/tracer.html
- *
- * Trace promise fulfillment.
- * Trace promise fulfillment. Calling .trace() or .traceError() on a
- * promise enables tracing. Will emit resolved, rejected or progress
- * events.
- *
- */
- interface tracer {
- /**
- * Subscribe to traces.
- * See dojo/Evented#on().
- *
- * @param type resolved, rejected, or progress
- * @param listener The listener is passed the traced value and any argumentsthat were used with the .trace() call.
- */
- on(type: String, listener: Function): void;
- }
- }
- namespace rpc {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/rpc/JsonpService.html
- *
- * Generic JSONP service. Minimally extends RpcService to allow
- * easy definition of nearly any JSONP style service. Example
- * SMD files exist in dojox.data
- *
- * @param args
- * @param requiredArgs
- */
- class JsonpService extends dojo.rpc.RpcService {
- constructor(args: any, requiredArgs: any);
- /**
- *
- */
- "serviceUrl": string;
- /**
- *
- */
- "strictArgChecks": boolean;
- /**
- * JSONP bind method. Takes remote method, parameters,
- * deferred, and a url, calls createRequest to make a JSON-RPC
- * envelope and passes that off with bind.
- *
- * @param method The name of the method we are calling
- * @param parameters The parameters we are passing off to the method
- * @param deferredRequestHandler The Deferred object for this particular request
- * @param url
- */
- bind(method: String, parameters: dojo._base.array, deferredRequestHandler: dojo.Deferred, url: any): void;
- /**
- * create a JSONP req
- *
- * @param parameters
- */
- createRequest(parameters: any): Object;
- /**
- * create callback that calls the Deferred errback method
- *
- * @param deferredRequestHandler The deferred object handling a request.
- */
- errorCallback(deferredRequestHandler: dojo._base.Deferred): Function;
- /**
- * generate the local bind methods for the remote object
- *
- * @param method The name of the method we are generating
- * @param parameters the array of parameters for this call.
- * @param url the service url for this call
- */
- generateMethod(method: String, parameters: dojo._base.array, url: String): any;
- /**
- * parse the results coming back from an rpc request. this
- * base implementation, just returns the full object
- * subclasses should parse and only return the actual results
- *
- * @param obj Object that is the return results from an rpc request
- */
- parseResults(obj: Object): Object;
- /**
- * callback method for receipt of a smd object. Parse the smd
- * and generate functions based on the description
- *
- * @param object smd object defining this service.
- */
- processSmd(object: any): void;
- /**
- * create callback that calls the Deferred's callback method
- *
- * @param deferredRequestHandler The deferred object handling a request.
- */
- resultCallback(deferredRequestHandler: dojo._base.Deferred): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/rpc/JsonService.html
- *
- * TODOC
- *
- * @param args Takes a number of properties as kwArgs for defining the service. It alsoaccepts a string. When passed a string, it is treated as a url fromwhich it should synchronously retrieve an smd file. Otherwise it is a kwArgsobject. It accepts serviceUrl, to manually define a url for the rpc serviceallowing the rpc system to be used without an smd definition. strictArgChecksforces the system to verify that the # of arguments provided in a callmatches those defined in the smd. smdString allows a developer to passa jsonString directly, which will be converted into an object or alternativelysmdObject is accepts an smdObject directly.
- */
- class JsonService extends dojo.rpc.RpcService {
- constructor(args: Object);
- /**
- *
- */
- "bustCache": boolean;
- /**
- *
- */
- "contentType": string;
- /**
- *
- */
- "lastSubmissionId": number;
- /**
- *
- */
- "serviceUrl": string;
- /**
- *
- */
- "strictArgChecks": boolean;
- /**
- * JSON-RPC bind method. Takes remote method, parameters,
- * deferred, and a url, calls createRequest to make a JSON-RPC
- * envelope and passes that off with bind.
- *
- * @param method The name of the method we are calling
- * @param parameters The parameters we are passing off to the method
- * @param deferredRequestHandler The Deferred object for this particular request
- * @param url
- */
- bind(method: String, parameters: any[], deferredRequestHandler: dojo.Deferred, url: any): void;
- /**
- * call an arbitrary remote method without requiring it to be
- * predefined with SMD
- *
- * @param method the name of the remote method you want to call.
- * @param params array of parameters to pass to method
- */
- callRemote(method: String, params: any[]): any;
- /**
- * create a JSON-RPC envelope for the request
- *
- * @param method The name of the method we are creating the request for
- * @param params The array of parameters for this request;
- */
- createRequest(method: String, params: dojo._base.array): any;
- /**
- * create callback that calls the Deferred errback method
- *
- * @param deferredRequestHandler The deferred object handling a request.
- */
- errorCallback(deferredRequestHandler: dojo._base.Deferred): Function;
- /**
- * generate the local bind methods for the remote object
- *
- * @param method The name of the method we are generating
- * @param parameters the array of parameters for this call.
- * @param url the service url for this call
- */
- generateMethod(method: String, parameters: dojo._base.array, url: String): any;
- /**
- * parse the result envelope and pass the results back to
- * the callback function
- *
- * @param obj Object containing envelope of data we receive from the server
- */
- parseResults(obj: Object): any;
- /**
- * callback method for receipt of a smd object. Parse the smd
- * and generate functions based on the description
- *
- * @param object smd object defining this service.
- */
- processSmd(object: any): void;
- /**
- * create callback that calls the Deferred's callback method
- *
- * @param deferredRequestHandler The deferred object handling a request.
- */
- resultCallback(deferredRequestHandler: dojo._base.Deferred): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/rpc/RpcService.html
- *
- * TODOC
- *
- * @param args Takes a number of properties as kwArgs for defining the service. It alsoaccepts a string. When passed a string, it is treated as a url fromwhich it should synchronously retrieve an smd file. Otherwise it is a kwArgsobject. It accepts serviceUrl, to manually define a url for the rpc serviceallowing the rpc system to be used without an smd definition. strictArgChecksforces the system to verify that the # of arguments provided in a callmatches those defined in the smd. smdString allows a developer to passa jsonString directly, which will be converted into an object or alternativelysmdObject is accepts an smdObject directly.
- */
- class RpcService {
- constructor(args: Object);
- /**
- *
- */
- "serviceUrl": string;
- /**
- *
- */
- "strictArgChecks": boolean;
- /**
- * create callback that calls the Deferred errback method
- *
- * @param deferredRequestHandler The deferred object handling a request.
- */
- errorCallback(deferredRequestHandler: dojo._base.Deferred): Function;
- /**
- * generate the local bind methods for the remote object
- *
- * @param method The name of the method we are generating
- * @param parameters the array of parameters for this call.
- * @param url the service url for this call
- */
- generateMethod(method: String, parameters: dojo._base.array, url: String): any;
- /**
- * parse the results coming back from an rpc request. this
- * base implementation, just returns the full object
- * subclasses should parse and only return the actual results
- *
- * @param obj Object that is the return results from an rpc request
- */
- parseResults(obj: Object): Object;
- /**
- * callback method for receipt of a smd object. Parse the smd
- * and generate functions based on the description
- *
- * @param object smd object defining this service.
- */
- processSmd(object: any): void;
- /**
- * create callback that calls the Deferred's callback method
- *
- * @param deferredRequestHandler The deferred object handling a request.
- */
- resultCallback(deferredRequestHandler: dojo._base.Deferred): any;
- }
- }
- namespace selector {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/selector/lite.html
- *
- * A small lightweight query selector engine that implements CSS2.1 selectors
- * minus pseudo-classes and the sibling combinator, plus CSS3 attribute selectors
- *
- * @param selector
- * @param root
- */
- interface lite{(selector: any, root: any): void}
- interface lite {
- /**
- *
- */
- match: Object;
- }
- namespace lite {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/selector/acme.html
- *
- * Returns nodes which match the given CSS3 selector, searching the
- * entire document by default but optionally taking a node to scope
- * the search by. Returns an array.
- * dojo.query() is the swiss army knife of DOM node manipulation in
- * Dojo. Much like Prototype's "$$" (bling-bling) function or JQuery's
- * "$" function, dojo.query provides robust, high-performance
- * CSS-based node selector support with the option of scoping searches
- * to a particular sub-tree of a document.
- *
- * Supported Selectors:
- * acme supports a rich set of CSS3 selectors, including:
- *
- * class selectors (e.g., .foo)
- * node type selectors like span
- * descendant selectors
- * > child element selectors
- * #foo style ID selectors
- * * universal selector
- * ~, the preceded-by sibling selector
- * +, the immediately preceded-by sibling selector
- * attribute queries:
- * [foo] attribute presence selector
- * [foo='bar'] attribute value exact match
- * [foo~='bar'] attribute value list item match
- * [foo^='bar'] attribute start match
- * [foo$='bar'] attribute end match
- * [foo*='bar'] attribute substring match
- *
- * :first-child, :last-child, and :only-child positional selectors
- * :empty content emtpy selector
- * :checked pseudo selector
- * :nth-child(n), :nth-child(2n+1) style positional calculations
- * :nth-child(even), :nth-child(odd) positional selectors
- * :not(...) negation pseudo selectors
- * Any legal combination of these selectors will work with
- * dojo.query(), including compound selectors ("," delimited).
- * Very complex and useful searches can be constructed with this
- * palette of selectors and when combined with functions for
- * manipulation presented by dojo/NodeList, many types of DOM
- * manipulation operations become very straightforward.
- *
- * Unsupported Selectors:
- * While dojo.query handles many CSS3 selectors, some fall outside of
- * what's reasonable for a programmatic node querying engine to
- * handle. Currently unsupported selectors include:
- *
- * namespace-differentiated selectors of any form
- * all :: pseduo-element selectors
- * certain pseudo-selectors which don't get a lot of day-to-day use:
- * :root, :lang(), :target, :focus
- *
- * all visual and state selectors:
- * :root, :active, :hover, :visited, :link,`:enabled`, `:disabled`
- * :*-of-type pseudo selectors
- *
- * dojo.query and XML Documents:
- * dojo.query (as of dojo 1.2) supports searching XML documents
- * in a case-sensitive manner. If an HTML document is served with
- * a doctype that forces case-sensitivity (e.g., XHTML 1.1
- * Strict), dojo.query() will detect this and "do the right
- * thing". Case sensitivity is dependent upon the document being
- * searched and not the query used. It is therefore possible to
- * use case-sensitive queries on strict sub-documents (iframes,
- * etc.) or XML documents while still assuming case-insensitivity
- * for a host/root document.
- *
- * Non-selector Queries:
- * If something other than a String is passed for the query,
- * dojo.query will return a new dojo/NodeList instance
- * constructed from that parameter alone and all further
- * processing will stop. This means that if you have a reference
- * to a node or NodeList, you can quickly construct a new NodeList
- * from the original by calling dojo.query(node) or
- * dojo.query(list).
- *
- * @param query The CSS3 expression to match against. For details on the syntax ofCSS3 selectors, see http://www.w3.org/TR/css3-selectors/#selectors
- * @param root OptionalA DOMNode (or node id) to scope the search from. Optional.
- */
- interface acme{(query: String, root?: String): void}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/selector/acme.html
- *
- * Returns nodes which match the given CSS3 selector, searching the
- * entire document by default but optionally taking a node to scope
- * the search by. Returns an array.
- * dojo.query() is the swiss army knife of DOM node manipulation in
- * Dojo. Much like Prototype's "$$" (bling-bling) function or JQuery's
- * "$" function, dojo.query provides robust, high-performance
- * CSS-based node selector support with the option of scoping searches
- * to a particular sub-tree of a document.
- *
- * Supported Selectors:
- * acme supports a rich set of CSS3 selectors, including:
- *
- * class selectors (e.g., .foo)
- * node type selectors like span
- * descendant selectors
- * > child element selectors
- * #foo style ID selectors
- * * universal selector
- * ~, the preceded-by sibling selector
- * +, the immediately preceded-by sibling selector
- * attribute queries:
- * [foo] attribute presence selector
- * [foo='bar'] attribute value exact match
- * [foo~='bar'] attribute value list item match
- * [foo^='bar'] attribute start match
- * [foo$='bar'] attribute end match
- * [foo*='bar'] attribute substring match
- *
- * :first-child, :last-child, and :only-child positional selectors
- * :empty content emtpy selector
- * :checked pseudo selector
- * :nth-child(n), :nth-child(2n+1) style positional calculations
- * :nth-child(even), :nth-child(odd) positional selectors
- * :not(...) negation pseudo selectors
- * Any legal combination of these selectors will work with
- * dojo.query(), including compound selectors ("," delimited).
- * Very complex and useful searches can be constructed with this
- * palette of selectors and when combined with functions for
- * manipulation presented by dojo/NodeList, many types of DOM
- * manipulation operations become very straightforward.
- *
- * Unsupported Selectors:
- * While dojo.query handles many CSS3 selectors, some fall outside of
- * what's reasonable for a programmatic node querying engine to
- * handle. Currently unsupported selectors include:
- *
- * namespace-differentiated selectors of any form
- * all :: pseduo-element selectors
- * certain pseudo-selectors which don't get a lot of day-to-day use:
- * :root, :lang(), :target, :focus
- *
- * all visual and state selectors:
- * :root, :active, :hover, :visited, :link,`:enabled`, `:disabled`
- * :*-of-type pseudo selectors
- *
- * dojo.query and XML Documents:
- * dojo.query (as of dojo 1.2) supports searching XML documents
- * in a case-sensitive manner. If an HTML document is served with
- * a doctype that forces case-sensitivity (e.g., XHTML 1.1
- * Strict), dojo.query() will detect this and "do the right
- * thing". Case sensitivity is dependent upon the document being
- * searched and not the query used. It is therefore possible to
- * use case-sensitive queries on strict sub-documents (iframes,
- * etc.) or XML documents while still assuming case-insensitivity
- * for a host/root document.
- *
- * Non-selector Queries:
- * If something other than a String is passed for the query,
- * dojo.query will return a new dojo/NodeList instance
- * constructed from that parameter alone and all further
- * processing will stop. This means that if you have a reference
- * to a node or NodeList, you can quickly construct a new NodeList
- * from the original by calling dojo.query(node) or
- * dojo.query(list).
- *
- * @param query The CSS3 expression to match against. For details on the syntax ofCSS3 selectors, see http://www.w3.org/TR/css3-selectors/#selectors
- * @param root OptionalA DOMNode (or node id) to scope the search from. Optional.
- */
- interface acme{(query: String, root?: HTMLElement): void}
- interface acme {
- /**
- * function for filtering a NodeList based on a selector, optimized for simple selectors
- *
- * @param nodeList
- * @param filter
- * @param root Optional
- */
- filter(nodeList: HTMLElement[], filter: String, root?: String): void;
- /**
- * function for filtering a NodeList based on a selector, optimized for simple selectors
- *
- * @param nodeList
- * @param filter
- * @param root Optional
- */
- filter(nodeList: HTMLElement[], filter: String, root?: HTMLElement): void;
- }
- namespace acme {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/selector/_loader.html
- *
- * This module handles loading the appropriate selector engine for the given browser
- *
- */
- interface _loader {
- /**
- *
- * @param id
- * @param parentRequire
- * @param loaded
- * @param config
- */
- load(id: any, parentRequire: any, loaded: any, config: any): any;
- }
- }
- namespace store {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/Observable.html
- *
- * The Observable store wrapper takes a store and sets an observe method on query()
- * results that can be used to monitor results for changes.
- * Observable wraps an existing store so that notifications can be made when a query
- * is performed.
- *
- * @param store
- */
- interface Observable{(store: dojo.store.api.Store): void}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/Cache.html
- *
- * The Cache store wrapper takes a master store and a caching store,
- * caches data from the master into the caching store for faster
- * lookup. Normally one would use a memory store for the caching
- * store and a server store like JsonRest for the master store.
- *
- * @param masterStore This is the authoritative store, all uncached requests or non-safe requests willbe made against this store.
- * @param cachingStore This is the caching store that will be used to store responses for quick access.Typically this should be a local store.
- * @param options OptionalThese are additional options for how caching is handled.
- */
- class Cache extends dojo.store.api.Store {
- constructor(masterStore: any, cachingStore: any, options?: Object);
- /**
- * If the store has a single primary key, this indicates the property to use as the
- * identity property. The values of this property should be unique.
- *
- */
- "idProperty": string;
- /**
- * If the store can be queried locally (on the client side in JS), this defines
- * the query engine to use for querying the data store.
- * This takes a query and query options and returns a function that can execute
- * the provided query on a JavaScript array. The queryEngine may be replace to
- * provide more sophisticated querying capabilities. For example:
- *
- * var query = store.queryEngine({foo:"bar"}, {count:10});
- * query(someArray) -> filtered array
- * The returned query function may have a "matches" property that can be
- *
- * used to determine if an object matches the query. For example:
- *
- * query.matches({id:"some-object", foo:"bar"}) -> true
- * query.matches({id:"some-object", foo:"something else"}) -> false
- *
- */
- queryEngine(query: Object, options: dojo.store.api.Store.QueryOptions): any;
- /**
- * Add the given object to the store.
- *
- * @param object The object to add to the store.
- * @param directives OptionalAny additional parameters needed to describe how the add should be performed.
- */
- add(object: Object, directives?: any): number;
- /**
- * Remove the object with the given id from the underlying caching store.
- *
- * @param id The identifier for the object in question.
- */
- evict(id: number): void;
- /**
- * Get the object with the specific id.
- *
- * @param id The identifier for the object in question.
- * @param directives OptionalAny additional parameters needed to describe how the get should be performed.
- */
- get(id: number, directives?: Object): dojo.store.api.Store.QueryResults;
- /**
- * Retrieves the children of an object.
- *
- * @param parent The object to find the children of.
- * @param options OptionalAdditional options to apply to the retrieval of the children.
- */
- getChildren(parent: Object, options?: dojo.store.api.Store.QueryOptions): dojo.store.api.Store.QueryResults;
- /**
- * Returns an object's identity
- *
- * @param object The object to get the identity from
- */
- getIdentity(object: Object): any;
- /**
- * Returns any metadata about the object. This may include attribution,
- * cache directives, history, or version information.
- *
- * @param object The object to return metadata for.
- */
- getMetadata(object: Object): Object;
- /**
- * Put the object into the store (similar to an HTTP PUT).
- *
- * @param object The object to put to the store.
- * @param directives OptionalAny additional parameters needed to describe how the put should be performed.
- */
- put(object: Object, directives?: dojo.store.api.Store.PutDirectives): number;
- /**
- * Query the underlying master store and cache any results.
- *
- * @param query The object or string containing query information. Dependent on the query engine used.
- * @param directives OptionalAn optional keyword arguments object with additional parameters describing the query.
- */
- query(query: Object, directives?: dojo.store.api.Store.QueryOptions): dojo.store.api.Store.QueryResults;
- /**
- * Query the underlying master store and cache any results.
- *
- * @param query The object or string containing query information. Dependent on the query engine used.
- * @param directives OptionalAn optional keyword arguments object with additional parameters describing the query.
- */
- query(query: String, directives?: dojo.store.api.Store.QueryOptions): dojo.store.api.Store.QueryResults;
- /**
- * Remove the object with the specific id.
- *
- * @param id The identifier for the object in question.
- */
- remove(id: number): void;
- /**
- * Starts a new transaction.
- * Note that a store user might not call transaction() prior to using put,
- * delete, etc. in which case these operations effectively could be thought of
- * as "auto-commit" style actions.
- *
- */
- transaction(): dojo.store.api.Store.Transaction;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/DataStore.html
- *
- * This is an adapter for using Dojo Data stores with an object store consumer.
- * You can provide a Dojo data store and use this adapter to interact with it through
- * the Dojo object store API
- *
- * @param options OptionalThis provides any configuration information that will be mixed into the store,including a reference to the Dojo data store under the property "store".
- */
- class DataStore extends dojo.store.api.Store {
- constructor(options?: Object);
- /**
- * The object property to use to store the identity of the store items.
- *
- */
- "idProperty": string;
- /**
- * The object store to convert to a data store
- *
- */
- "store": Object;
- /**
- *
- */
- "target": string;
- /**
- * Creates an object, throws an error if the object already exists
- *
- * @param object The object to store.
- * @param directives OptionalAdditional directives for creating objects.
- */
- add(object: Object, directives: dojo.store.api.Store.PutDirectives): any;
- /**
- * Retrieves an object by it's identity. This will trigger a fetchItemByIdentity
- *
- * @param id OptionalThe identity to use to lookup the object
- * @param options
- */
- get(id: Object, options?: any): any;
- /**
- * Retrieves the children of an object.
- *
- * @param parent The object to find the children of.
- * @param options OptionalAdditional options to apply to the retrieval of the children.
- */
- getChildren(parent: Object, options?: dojo.store.api.Store.QueryOptions): dojo.store.api.Store.QueryResults;
- /**
- * Fetch the identity for the given object.
- *
- * @param object The data object to get the identity from.
- */
- getIdentity(object: Object): any;
- /**
- * Returns any metadata about the object. This may include attribution,
- * cache directives, history, or version information.
- *
- * @param object The object to return metadata for.
- */
- getMetadata(object: Object): Object;
- /**
- * Stores an object by its identity.
- *
- * @param object The object to store.
- * @param options OptionalAdditional metadata for storing the data. Includes a reference to an idthat the object may be stored with (i.e. { id: "foo" }).
- */
- put(object: Object, options?: Object): void;
- /**
- * Queries the store for objects.
- *
- * @param query The query to use for retrieving objects from the store
- * @param options OptionalOptional options object as used by the underlying dojo.data Store.
- */
- query(query: Object, options?: Object): any;
- /**
- * Defines the query engine to use for querying the data store
- *
- * @param query An object hash with fields that may match fields of items in the store.Values in the hash will be compared by normal == operator, but regular expressionsor any object that provides a test() method are also supported and can beused to match strings by more complex expressions(and then the regex's or object's test() method will be used to match values).
- * @param options OptionalAn object that contains optional information such as sort, start, and count.
- */
- queryEngine(query: Object, options?: dojo.store.api.Store.QueryOptions): any;
- /**
- * Deletes an object by its identity.
- *
- * @param id The identity to use to delete the object
- */
- remove(id: Object): void;
- /**
- * Starts a new transaction.
- * Note that a store user might not call transaction() prior to using put,
- * delete, etc. in which case these operations effectively could be thought of
- * as "auto-commit" style actions.
- *
- */
- transaction(): dojo.store.api.Store.Transaction;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/Memory.html
- *
- * This is a basic in-memory object store. It implements dojo/store/api/Store.
- *
- * @param options This provides any configuration information that will be mixed into the store.This should generally include the data property to provide the starting set of data.
- */
- class Memory extends dojo.store.api.Store {
- constructor(options: dojo.store.Memory);
- /**
- * The array of all the objects in the memory store
- *
- */
- "data": any[];
- /**
- * Indicates the property to use as the identity property. The values of this
- * property should be unique.
- *
- */
- "idProperty": string;
- /**
- * An index of data indices into the data array by id
- *
- */
- "index": Object;
- /**
- * Creates an object, throws an error if the object already exists
- *
- * @param object The object to store.
- * @param options OptionalAdditional metadata for storing the data. Includes an "id"property if a specific id is to be used.
- */
- add(object: Object, options?: dojo.store.api.Store.PutDirectives): any;
- /**
- * Retrieves an object by its identity
- *
- * @param id The identity to use to lookup the object
- */
- get(id: number): any;
- /**
- * Retrieves the children of an object.
- *
- * @param parent The object to find the children of.
- * @param options OptionalAdditional options to apply to the retrieval of the children.
- */
- getChildren(parent: Object, options?: dojo.store.api.Store.QueryOptions): dojo.store.api.Store.QueryResults;
- /**
- * Returns an object's identity
- *
- * @param object The object to get the identity from
- */
- getIdentity(object: Object): any;
- /**
- * Returns any metadata about the object. This may include attribution,
- * cache directives, history, or version information.
- *
- * @param object The object to return metadata for.
- */
- getMetadata(object: Object): Object;
- /**
- * Stores an object
- *
- * @param object The object to store.
- * @param options OptionalAdditional metadata for storing the data. Includes an "id"property if a specific id is to be used.
- */
- put(object: Object, options?: dojo.store.api.Store.PutDirectives): any;
- /**
- * Queries the store for objects.
- *
- * @param query The query to use for retrieving objects from the store.
- * @param options OptionalThe optional arguments to apply to the resultset.
- */
- query(query: Object, options?: dojo.store.api.Store.QueryOptions): any;
- /**
- * Defines the query engine to use for querying the data store
- *
- * @param query An object hash with fields that may match fields of items in the store.Values in the hash will be compared by normal == operator, but regular expressionsor any object that provides a test() method are also supported and can beused to match strings by more complex expressions(and then the regex's or object's test() method will be used to match values).
- * @param options OptionalAn object that contains optional information such as sort, start, and count.
- */
- queryEngine(query: Object, options?: dojo.store.api.Store.QueryOptions): any;
- /**
- * Deletes an object by its identity
- *
- * @param id The identity to use to delete the object
- */
- remove(id: number): any;
- /**
- * Sets the given data as the source for this store, and indexes it
- *
- * @param data An array of objects to use as the source of data.
- */
- setData(data: Object[]): void;
- /**
- * Starts a new transaction.
- * Note that a store user might not call transaction() prior to using put,
- * delete, etc. in which case these operations effectively could be thought of
- * as "auto-commit" style actions.
- *
- */
- transaction(): dojo.store.api.Store.Transaction;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/JsonRest.html
- *
- * This is a basic store for RESTful communicating with a server through JSON
- * formatted data. It implements dojo/store/api/Store.
- *
- * @param options This provides any configuration information that will be mixed into the store
- */
- class JsonRest extends dojo.store.api.Store {
- constructor(options: dojo.store.JsonRest);
- /**
- * Defines the Accept header to use on HTTP requests
- *
- */
- "accepts": string;
- /**
- * The prefix to apply to sort attribute names that are ascending
- *
- */
- "ascendingPrefix": string;
- /**
- * The prefix to apply to sort attribute names that are ascending
- *
- */
- "descendingPrefix": string;
- /**
- * Additional headers to pass in all requests to the server. These can be overridden
- * by passing additional headers to calls to the store.
- *
- */
- "headers": Object;
- /**
- * Indicates the property to use as the identity property. The values of this
- * property should be unique.
- *
- */
- "idProperty": string;
- /**
- * If the store can be queried locally (on the client side in JS), this defines
- * the query engine to use for querying the data store.
- * This takes a query and query options and returns a function that can execute
- * the provided query on a JavaScript array. The queryEngine may be replace to
- * provide more sophisticated querying capabilities. For example:
- *
- * var query = store.queryEngine({foo:"bar"}, {count:10});
- * query(someArray) -> filtered array
- * The returned query function may have a "matches" property that can be
- *
- * used to determine if an object matches the query. For example:
- *
- * query.matches({id:"some-object", foo:"bar"}) -> true
- * query.matches({id:"some-object", foo:"something else"}) -> false
- *
- */
- queryEngine(query: Object, options: dojo.store.api.Store.QueryOptions): any;
- /**
- * The target base URL to use for all requests to the server. This string will be
- * prepended to the id to generate the URL (relative or absolute) for requests
- * sent to the server
- *
- */
- "target": string;
- /**
- * Adds an object. This will trigger a PUT request to the server
- * if the object has an id, otherwise it will trigger a POST request.
- *
- * @param object The object to store.
- * @param options OptionalAdditional metadata for storing the data. Includes an "id"property if a specific id is to be used.
- */
- add(object: Object, options?: Object): any;
- /**
- * Retrieves an object by its identity. This will trigger a GET request to the server using
- * the url this.target + id.
- *
- * @param id The identity to use to lookup the object
- * @param options OptionalHTTP headers. For consistency with other methods, if a headers key exists on this object, it will beused to provide HTTP headers instead.
- */
- get(id: number, options?: Object): any;
- /**
- * Retrieves the children of an object.
- *
- * @param parent The object to find the children of.
- * @param options OptionalAdditional options to apply to the retrieval of the children.
- */
- getChildren(parent: Object, options?: dojo.store.api.Store.QueryOptions): dojo.store.api.Store.QueryResults;
- /**
- * Returns an object's identity
- *
- * @param object The object to get the identity from
- */
- getIdentity(object: Object): any;
- /**
- * Returns any metadata about the object. This may include attribution,
- * cache directives, history, or version information.
- *
- * @param object The object to return metadata for.
- */
- getMetadata(object: Object): Object;
- /**
- * Stores an object. This will trigger a PUT request to the server
- * if the object has an id, otherwise it will trigger a POST request.
- *
- * @param object The object to store.
- * @param options OptionalAdditional metadata for storing the data. Includes an "id"property if a specific id is to be used.
- */
- put(object: Object, options?: Object): any;
- /**
- * Queries the store for objects. This will trigger a GET request to the server, with the
- * query added as a query string.
- *
- * @param query The query to use for retrieving objects from the store.
- * @param options OptionalThe optional arguments to apply to the resultset.
- */
- query(query: Object, options?: Object): any;
- /**
- * Deletes an object by its identity. This will trigger a DELETE request to the server.
- *
- * @param id The identity to use to delete the object
- * @param options OptionalHTTP headers.
- */
- remove(id: number, options?: Object): any;
- /**
- * Starts a new transaction.
- * Note that a store user might not call transaction() prior to using put,
- * delete, etc. in which case these operations effectively could be thought of
- * as "auto-commit" style actions.
- *
- */
- transaction(): dojo.store.api.Store.Transaction;
- }
- namespace api {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/api/Store.html
- *
- * This is an abstract API that data provider implementations conform to.
- * This file defines methods signatures and intentionally leaves all the
- * methods unimplemented. For more information on the ,
- * please visit: http://dojotoolkit.org/reference-guide/dojo/store.html
- * Every method and property is optional, and is only needed if the functionality
- * it provides is required.
- * Every method may return a promise for the specified return value if the
- * execution of the operation is asynchronous (except
- * for query() which already defines an async return value).
- *
- */
- class Store {
- constructor();
- /**
- * If the store has a single primary key, this indicates the property to use as the
- * identity property. The values of this property should be unique.
- *
- */
- "idProperty": string;
- /**
- * If the store can be queried locally (on the client side in JS), this defines
- * the query engine to use for querying the data store.
- * This takes a query and query options and returns a function that can execute
- * the provided query on a JavaScript array. The queryEngine may be replace to
- * provide more sophisticated querying capabilities. For example:
- *
- * var query = store.queryEngine({foo:"bar"}, {count:10});
- * query(someArray) -> filtered array
- * The returned query function may have a "matches" property that can be
- *
- * used to determine if an object matches the query. For example:
- *
- * query.matches({id:"some-object", foo:"bar"}) -> true
- * query.matches({id:"some-object", foo:"something else"}) -> false
- *
- */
- queryEngine(query: Object, options: dojo.store.api.Store.QueryOptions): any;
- /**
- * Creates an object, throws an error if the object already exists
- *
- * @param object The object to store.
- * @param directives OptionalAdditional directives for creating objects.
- */
- add(object: Object, directives?: dojo.store.api.Store.PutDirectives): any;
- /**
- * Retrieves an object by its identity
- *
- * @param id The identity to use to lookup the object
- */
- get(id: number): Object;
- /**
- * Retrieves the children of an object.
- *
- * @param parent The object to find the children of.
- * @param options OptionalAdditional options to apply to the retrieval of the children.
- */
- getChildren(parent: Object, options?: dojo.store.api.Store.QueryOptions): dojo.store.api.Store.QueryResults;
- /**
- * Returns an object's identity
- *
- * @param object The object to get the identity from
- */
- getIdentity(object: Object): any;
- /**
- * Returns any metadata about the object. This may include attribution,
- * cache directives, history, or version information.
- *
- * @param object The object to return metadata for.
- */
- getMetadata(object: Object): Object;
- /**
- * Stores an object
- *
- * @param object The object to store.
- * @param directives OptionalAdditional directives for storing objects.
- */
- put(object: Object, directives?: dojo.store.api.Store.PutDirectives): any;
- /**
- *
- */
- PutDirectives(): void;
- /**
- * Queries the store for objects. This does not alter the store, but returns a
- * set of data from the store.
- *
- * @param query The query to use for retrieving objects from the store.
- * @param options The optional arguments to apply to the resultset.
- */
- query(query: String, options?: dojo.store.api.Store.QueryOptions): dojo.store.api.Store.QueryResults;
- /**
- * Queries the store for objects. This does not alter the store, but returns a
- * set of data from the store.
- *
- * @param query The query to use for retrieving objects from the store.
- * @param options The optional arguments to apply to the resultset.
- */
- query(query: Object, options?: dojo.store.api.Store.QueryOptions): dojo.store.api.Store.QueryResults;
- /**
- * Queries the store for objects. This does not alter the store, but returns a
- * set of data from the store.
- *
- * @param query The query to use for retrieving objects from the store.
- * @param options The optional arguments to apply to the resultset.
- */
- query(query: Function, options?: dojo.store.api.Store.QueryOptions): dojo.store.api.Store.QueryResults;
- /**
- *
- */
- QueryOptions(): void;
- /**
- *
- */
- QueryResults(): void;
- /**
- * Deletes an object by its identity
- *
- * @param id The identity to use to delete the object
- */
- remove(id: number): void;
- /**
- *
- */
- SortInformation(): void;
- /**
- * Starts a new transaction.
- * Note that a store user might not call transaction() prior to using put,
- * delete, etc. in which case these operations effectively could be thought of
- * as "auto-commit" style actions.
- *
- */
- transaction(): dojo.store.api.Store.Transaction;
- /**
- *
- */
- Transaction(): void;
- }
- namespace Store {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/api/Store.PutDirectives.html
- *
- * Directives passed to put() and add() handlers for guiding the update and
- * creation of stored objects.
- *
- */
- class PutDirectives {
- constructor();
- /**
- * If the collection of objects in the store has a natural ordering,
- * this indicates that the created or updated object should be placed before the
- * object specified by the value of this property. A value of null indicates that the
- * object should be last.
- *
- */
- "before": Object;
- /**
- * Indicates the identity of the object if a new object is created
- *
- */
- "id": string;
- /**
- * If this is provided as a boolean it indicates that the object should or should not
- * overwrite an existing object. A value of true indicates that a new object
- * should not be created, the operation should update an existing object. A
- * value of false indicates that an existing object should not be updated, a new
- * object should be created (which is the same as an add() operation). When
- * this property is not provided, either an update or creation is acceptable.
- *
- */
- "overwrite": boolean;
- /**
- * If the store is hierarchical (with single parenting) this property indicates the
- * new parent of the created or updated object.
- *
- */
- "parent": Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/api/Store.QueryOptions.html
- *
- * Optional object with additional parameters for query results.
- *
- */
- class QueryOptions {
- constructor();
- /**
- * The number of how many results should be returned.
- *
- */
- "count": number;
- /**
- * A list of attributes to sort on, as well as direction
- * For example:
- *
- * [{attribute:"price, descending: true}].
- * If the sort parameter is omitted, then the natural order of the store may be
- *
- * applied if there is a natural order.
- *
- */
- "sort": Object;
- /**
- * The first result to begin iteration on
- *
- */
- "start": number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/api/Store.QueryResults.html
- *
- * This is an object returned from query() calls that provides access to the results
- * of a query. Queries may be executed asynchronously.
- *
- */
- class QueryResults {
- constructor();
- /**
- * This property should be included in if the query options included the "count"
- * property limiting the result set. This property indicates the total number of objects
- * matching the query (as if "start" and "count" weren't present). This may be
- * a promise if the query is asynchronous.
- *
- */
- "total": number;
- /**
- * Filters the query results, based on
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/filter.
- * Note that this may executed asynchronously. The callback may be called
- * after this function returns.
- *
- * @param callback Function that is called for each object in the query results
- * @param thisObject The object to use as |this| in the callback.
- */
- filter(callback: any, thisObject: any): dojo.store.api.Store.QueryResults;
- /**
- * Iterates over the query results, based on
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach.
- * Note that this may executed asynchronously. The callback may be called
- * after this function returns.
- *
- * @param callback Function that is called for each object in the query results
- * @param thisObject The object to use as |this| in the callback.
- */
- forEach(callback: any, thisObject: any): void;
- /**
- * Maps the query results, based on
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map.
- * Note that this may executed asynchronously. The callback may be called
- * after this function returns.
- *
- * @param callback Function that is called for each object in the query results
- * @param thisObject The object to use as |this| in the callback.
- */
- map(callback: any, thisObject: any): dojo.store.api.Store.QueryResults;
- /**
- * This registers a callback for notification of when data is modified in the query results.
- * This is an optional method, and is usually provided by dojo/store/Observable.
- *
- * @param listener The listener function is called when objects in the query results are modifiedto affect the query result. The listener function is called with the following arguments:listener(object, removedFrom, insertedInto);The object parameter indicates the object that was create, modified, or deleted.The removedFrom parameter indicates the index in the result array wherethe object used to be. If the value is -1, then the object is an addition tothis result set (due to a new object being created, or changed such that itis a part of the result set).The insertedInto parameter indicates the index in the result array wherethe object should be now. If the value is -1, then the object is a removalfrom this result set (due to an object being deleted, or changed such that itis not a part of the result set).
- * @param includeAllUpdates This indicates whether or not to include object updates that do not affectthe inclusion or order of the object in the query results. By default this is false,which means that if any object is updated in such a way that it remainsin the result set and it's position in result sets is not affected, then the listenerwill not be fired.
- */
- observe(listener: Function, includeAllUpdates: any): void;
- /**
- * This registers a callback for when the query is complete, if the query is asynchronous.
- * This is an optional method, and may not be present for synchronous queries.
- *
- * @param callback This is called when the query is completed successfully, and is passed a single argumentthat is an array representing the query results.
- * @param errorHandler This is called if the query failed, and is passed a single argument that is the errorfor the failure.
- */
- then(callback: any, errorHandler: any): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/api/Store.SortInformation.html
- *
- * An object describing what attribute to sort on, and the direction of the sort.
- *
- */
- class SortInformation {
- constructor();
- /**
- * The name of the attribute to sort on.
- *
- */
- "attribute": string;
- /**
- * The direction of the sort. Default is false.
- *
- */
- "descending": boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/api/Store.Transaction.html
- *
- * This is an object returned from transaction() calls that represents the current
- * transaction.
- *
- */
- class Transaction {
- constructor();
- /**
- * Aborts the transaction. This may throw an error if it fails. Of if the operation
- * is asynchronous, it may return a promise that represents the eventual success
- * or failure of the abort.
- *
- * @param callback
- * @param thisObject
- */
- abort(callback: any, thisObject: any): void;
- /**
- * Commits the transaction. This may throw an error if it fails. Of if the operation
- * is asynchronous, it may return a promise that represents the eventual success
- * or failure of the commit.
- *
- */
- commit(): void;
- }
- }
- }
- namespace util {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/util/QueryResults.html
- *
- * A function that wraps the results of a store query with additional
- * methods.
- * QueryResults is a basic wrapper that allows for array-like iteration
- * over any kind of returned data from a query. While the simplest store
- * will return a plain array of data, other stores may return deferreds or
- * promises; this wrapper makes sure that all results can be treated
- * the same.
- *
- * Additional methods include forEach, filter and map.
- *
- * @param results The result set as an array, or a promise for an array.
- */
- interface QueryResults{(results: any[]): void}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/util/QueryResults.html
- *
- * A function that wraps the results of a store query with additional
- * methods.
- * QueryResults is a basic wrapper that allows for array-like iteration
- * over any kind of returned data from a query. While the simplest store
- * will return a plain array of data, other stores may return deferreds or
- * promises; this wrapper makes sure that all results can be treated
- * the same.
- *
- * Additional methods include forEach, filter and map.
- *
- * @param results The result set as an array, or a promise for an array.
- */
- interface QueryResults{(results: dojo.promise.Promise<any>): void}
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/store/util/SimpleQueryEngine.html
- *
- * Simple query engine that matches using filter functions, named filter
- * functions or objects by name-value on a query object hash
- * The SimpleQueryEngine provides a way of getting a QueryResults through
- * the use of a simple object hash as a filter. The hash will be used to
- * match properties on data objects with the corresponding value given. In
- * other words, only exact matches will be returned.
- *
- * This function can be used as a template for more complex query engines;
- * for example, an engine can be created that accepts an object hash that
- * contains filtering functions, or a string that gets evaluated, etc.
- *
- * When creating a new dojo.store, simply set the store's queryEngine
- * field as a reference to this function.
- *
- * @param query An object hash with fields that may match fields of items in the store.Values in the hash will be compared by normal == operator, but regular expressionsor any object that provides a test() method are also supported and can beused to match strings by more complex expressions(and then the regex's or object's test() method will be used to match values).
- * @param options OptionalAn object that contains optional information such as sort, start, and count.
- */
- interface SimpleQueryEngine{(query: Object, options?: dojo.store.api.Store.QueryOptions): void}
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/date.html
- *
- * Date manipulation utilities
- *
- */
- interface date {
- /**
- * Add to a Date in intervals of different size, from milliseconds to years
- *
- * @param date Date object to start with
- * @param interval A string representing the interval. One of the following:"year", "month", "day", "hour", "minute", "second","millisecond", "quarter", "week", "weekday"
- * @param amount How much to add to the date.
- */
- add(date: Date, interval: String, amount: number): any;
- /**
- * Compare two date objects by date, time, or both.
- * Returns 0 if equal, positive if a > b, else negative.
- *
- * @param date1 Date object
- * @param date2 OptionalDate object. If not specified, the current Date is used.
- * @param portion OptionalA string indicating the "date" or "time" portion of a Date object.Compares both "date" and "time" by default. One of the following:"date", "time", "datetime"
- */
- compare(date1: Date, date2?: Date, portion?: String): number;
- /**
- * Get the difference in a specific unit of time (e.g., number of
- * months, weeks, days, etc.) between two dates, rounded to the
- * nearest integer.
- *
- * @param date1 Date object
- * @param date2 OptionalDate object. If not specified, the current Date is used.
- * @param interval OptionalA string representing the interval. One of the following:"year", "month", "day", "hour", "minute", "second","millisecond", "quarter", "week", "weekday"Defaults to "day".
- */
- difference(date1: Date, date2?: Date, interval?: String): any;
- /**
- * Returns the number of days in the month used by dateObject
- *
- * @param dateObject
- */
- getDaysInMonth(dateObject: Date): number;
- /**
- * Get the user's time zone as provided by the browser
- * Try to get time zone info from toString or toLocaleString method of
- * the Date object -- UTC offset is not a time zone. See
- * http://www.twinsun.com/tz/tz-link.htm Note: results may be
- * inconsistent across browsers.
- *
- * @param dateObject Needed because the timezone may vary with time (daylight savings)
- */
- getTimezoneName(dateObject: Date): any;
- /**
- * Determines if the year of the dateObject is a leap year
- * Leap years are years with an additional day YYYY-02-29, where the
- * year number is a multiple of four with the following exception: If
- * a year is a multiple of 100, then it is only a leap year if it is
- * also a multiple of 400. For example, 1900 was not a leap year, but
- * 2000 is one.
- *
- * @param dateObject
- */
- isLeapYear(dateObject: Date): boolean;
- }
- namespace date {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/date/stamp.html
- *
- * TODOC
- *
- */
- interface stamp {
- /**
- * Returns a Date object given a string formatted according to a subset of the ISO-8601 standard.
- * Accepts a string formatted according to a profile of ISO8601 as defined by
- * RFC3339, except that partial input is allowed.
- * Can also process dates as specified by the W3C
- * The following combinations are valid:
- *
- * dates only
- * yyyy
- * yyyy-MM
- * yyyy-MM-dd
- *
- * times only, with an optional time zone appended
- * THH:mm
- * THH:mm:ss
- * THH:mm:ss.SSS
- *
- * and "datetimes" which could be any combination of the above
- * timezones may be specified as Z (for UTC) or +/- followed by a time expression HH:mm
- * Assumes the local time zone if not specified. Does not validate. Improperly formatted
- * input may return null. Arguments which are out of bounds will be handled
- * by the Date constructor (e.g. January 32nd typically gets resolved to February 1st)
- * Only years between 100 and 9999 are supported.
- *
- * @param formattedString A string such as 2005-06-30T08:05:00-07:00 or 2005-06-30 or T08:05:00
- * @param defaultTime OptionalUsed for defaults for fields omitted in the formattedString.Uses 1970-01-01T00:00:00.0Z by default.
- */
- fromISOString(formattedString: String, defaultTime?: number): any;
- /**
- * Format a Date object as a string according a subset of the ISO-8601 standard
- * When options.selector is omitted, output follows RFC3339
- * The local time zone is included as an offset from GMT, except when selector=='time' (time without a date)
- * Does not check bounds. Only years between 100 and 9999 are supported.
- *
- * @param dateObject A Date object
- * @param options OptionalAn object with the following properties:selector (String): "date" or "time" for partial formatting of the Date object.Both date and time will be formatted by default.zulu (Boolean): if true, UTC/GMT is used for a timezonemilliseconds (Boolean): if true, output milliseconds
- */
- toISOString(dateObject: Date, options?: Object): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/date/locale.html
- *
- * This modules defines dojo/date/locale, localization methods for Date.
- *
- */
- interface locale {
- /**
- * Add a reference to a bundle containing localized custom formats to be
- * used by date/time formatting and parsing routines.
- * The user may add custom localized formats where the bundle has properties following the
- * same naming convention used by dojo.cldr: dateFormat-xxxx / timeFormat-xxxx
- * The pattern string should match the format used by the CLDR.
- * See dojo/date/locale.format() for details.
- * The resources must be loaded by dojo.requireLocalization() prior to use
- *
- * @param packageName
- * @param bundleName
- */
- addCustomFormats(packageName: String, bundleName: String): void;
- /**
- * Format a Date object as a String, using locale-specific settings.
- * Create a string from a Date object using a known localized pattern.
- * By default, this method formats both date and time from dateObject.
- * Formatting patterns are chosen appropriate to the locale. Different
- * formatting lengths may be chosen, with "full" used by default.
- * Custom patterns may be used or registered with translations using
- * the dojo/date/locale.addCustomFormats() method.
- * Formatting patterns are implemented using the syntax described at
- * unicode.org
- *
- * @param dateObject the date and/or time to be formatted. If a time only is formatted,the values in the year, month, and day fields are irrelevant. Theopposite is true when formatting only dates.
- * @param options OptionalAn object with the following properties:selector (String): choice of 'time','date' (default: date and time)formatLength (String): choice of long, short, medium or full (plus any custom additions). Defaults to 'short'datePattern (String): override pattern with this stringtimePattern (String): override pattern with this stringam (String): override strings for am in timespm (String): override strings for pm in timeslocale (String): override the locale used to determine formatting rulesfullYear (Boolean): (format only) use 4 digit years whenever 2 digit years are called forstrict (Boolean): (parse only) strict parsing, off by default
- */
- format(dateObject: Date, options?: Object): any;
- /**
- * Used to get localized strings from dojo.cldr for day or month names.
- *
- * @param item 'months' || 'days'
- * @param type 'wide' || 'abbr' || 'narrow' (e.g. "Monday", "Mon", or "M" respectively, in English)
- * @param context Optional'standAlone' || 'format' (default)
- * @param locale Optionaloverride locale used to find the names
- */
- getNames(item: String, type: String, context?: String, locale?: String): any;
- /**
- * Determines if the date falls on a weekend, according to local custom.
- *
- * @param dateObject Optional
- * @param locale Optional
- */
- isWeekend(dateObject?: Date, locale?: String): boolean;
- /**
- * Convert a properly formatted string to a primitive Date object,
- * using locale-specific settings.
- * Create a Date object from a string using a known localized pattern.
- * By default, this method parses looking for both date and time in the string.
- * Formatting patterns are chosen appropriate to the locale. Different
- * formatting lengths may be chosen, with "full" used by default.
- * Custom patterns may be used or registered with translations using
- * the dojo/date/locale.addCustomFormats() method.
- *
- * Formatting patterns are implemented using the syntax described at
- * unicode.org
- * When two digit years are used, a century is chosen according to a sliding
- * window of 80 years before and 20 years after present year, for both yy and yyyy patterns.
- * year < 100CE requires strict mode.
- *
- * @param value A string representation of a date
- * @param options OptionalAn object with the following properties:selector (String): choice of 'time','date' (default: date and time)formatLength (String): choice of long, short, medium or full (plus any custom additions). Defaults to 'short'datePattern (String): override pattern with this stringtimePattern (String): override pattern with this stringam (String): override strings for am in timespm (String): override strings for pm in timeslocale (String): override the locale used to determine formatting rulesfullYear (Boolean): (format only) use 4 digit years whenever 2 digit years are called forstrict (Boolean): (parse only) strict parsing, off by default
- */
- parse(value: String, options?: Object): any;
- /**
- * Builds the regular needed to parse a localized date
- *
- * @param options OptionalAn object with the following properties:selector (String): choice of 'time','date' (default: date and time)formatLength (String): choice of long, short, medium or full (plus any custom additions). Defaults to 'short'datePattern (String): override pattern with this stringtimePattern (String): override pattern with this stringam (String): override strings for am in timespm (String): override strings for pm in timeslocale (String): override the locale used to determine formatting rulesfullYear (Boolean): (format only) use 4 digit years whenever 2 digit years are called forstrict (Boolean): (parse only) strict parsing, off by default
- */
- regexp(options?: Object): any;
- }
- namespace locale {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/date/locale.__FormatOptions.html
- *
- *
- */
- class __FormatOptions {
- constructor();
- /**
- * override strings for am in times
- *
- */
- "am": string;
- /**
- * override pattern with this string
- *
- */
- "datePattern": string;
- /**
- * choice of long, short, medium or full (plus any custom additions). Defaults to 'short'
- *
- */
- "formatLength": string;
- /**
- * (format only) use 4 digit years whenever 2 digit years are called for
- *
- */
- "fullYear": boolean;
- /**
- * override the locale used to determine formatting rules
- *
- */
- "locale": string;
- /**
- * override strings for pm in times
- *
- */
- "pm": string;
- /**
- * choice of 'time','date' (default: date and time)
- *
- */
- "selector": string;
- /**
- * (parse only) strict parsing, off by default
- *
- */
- "strict": boolean;
- /**
- * override pattern with this string
- *
- */
- "timePattern": string;
- }
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/fx.html
- *
- * Effects library on top of Base animations
- *
- */
- interface fx {
- /**
- * Collection of easing functions to use beyond the default
- * dojo._defaultEasing function.
- *
- */
- easing: Object;
- /**
- * Chain a list of dojo/_base/fx.Animations to run in sequence
- * Return a dojo/_base/fx.Animation which will play all passed
- * dojo/_base/fx.Animation instances in sequence, firing its own
- * synthesized events simulating a single animation. (eg:
- * onEnd of this animation means the end of the chain,
- * not the individual animations within)
- *
- * @param animations
- */
- chain(animations: dojo._base.fx.Animation[]): any;
- /**
- * Combine a list of dojo/_base/fx.Animations to run in parallel
- * Combine an array of dojo/_base/fx.Animations to run in parallel,
- * providing a new dojo/_base/fx.Animation instance encompasing each
- * animation, firing standard animation events.
- *
- * @param animations
- */
- combine(animations: dojo._base.fx.Animation[]): any;
- /**
- * Slide a node to a new top/left position
- * Returns an animation that will slide "node"
- * defined in args Object from its current position to
- * the position defined by (args.left, args.top).
- *
- * @param args A hash-map of standard dojo/_base/fx.Animation constructor properties(such as easing: node: duration: and so on). Special args membersare top and left, which indicate the new position to slide to.
- */
- slideTo(args: Object): any;
- /**
- *
- */
- Toggler(): void;
- /**
- * Expand a node to it's natural height.
- * Returns an animation that will expand the
- * node defined in 'args' object from it's current height to
- * it's natural height (with no scrollbar).
- * Node must have no margin/border/padding.
- *
- * @param args A hash-map of standard dojo/_base/fx.Animation constructor properties(such as easing: node: duration: and so on)
- */
- wipeIn(args: Object): any;
- /**
- * Shrink a node to nothing and hide it.
- * Returns an animation that will shrink node defined in "args"
- * from it's current height to 1px, and then hide it.
- *
- * @param args A hash-map of standard dojo/_base/fx.Animation constructor properties(such as easing: node: duration: and so on)
- */
- wipeOut(args: Object): any;
- }
- namespace fx {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/fx/Toggler.html
- *
- * A simple dojo.Animation toggler API.
- * class constructor for an animation toggler. It accepts a packed
- * set of arguments about what type of animation to use in each
- * direction, duration, etc. All available members are mixed into
- * these animations from the constructor (for example, node,
- * showDuration, hideDuration).
- *
- * @param args
- */
- class Toggler {
- constructor(args: any);
- /**
- * Time in milliseconds to run the hide Animation
- *
- */
- "hideDuration": number;
- /**
- * the node to target for the showing and hiding animations
- *
- */
- "node": HTMLElement;
- /**
- * Time in milliseconds to run the show Animation
- *
- */
- "showDuration": number;
- /**
- * Toggle the node to hidden
- *
- * @param delay OptionalAmount of time to stall playing the hide animation
- */
- hide(delay?: number): any;
- /**
- * The function that returns the dojo.Animation to hide the node
- *
- * @param args An object with the following properties:node (DOMNode|String): The node referenced in the animationduration (Integer, optional): Duration of the animation in milliseconds.easing (Function, optional): An easing function.
- */
- hideFunc(args: Object): any;
- /**
- * Toggle the node to showing
- *
- * @param delay OptionalAmount of time to stall playing the show animation
- */
- show(delay?: number): any;
- /**
- * The function that returns the dojo.Animation to show the node
- *
- * @param args An object with the following properties:node (DOMNode|String): The node referenced in the animationduration (Integer, optional): Duration of the animation in milliseconds.easing (Function, optional): An easing function.
- */
- showFunc(args: Object): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/fx/easing.html
- *
- * Collection of easing functions to use beyond the default
- * dojo._defaultEasing function.
- * Easing functions are used to manipulate the iteration through
- * an dojo.Animations _Line. _Line being the properties of an Animation,
- * and the easing function progresses through that Line determining
- * how quickly (or slowly) it should go. Or more accurately: modify
- * the value of the _Line based on the percentage of animation completed.
- *
- * All functions follow a simple naming convention of "ease type" + "when".
- * If the name of the function ends in Out, the easing described appears
- * towards the end of the animation. "In" means during the beginning,
- * and InOut means both ranges of the Animation will applied, both
- * beginning and end.
- *
- * One does not call the easing function directly, it must be passed to
- * the easing property of an animation.
- *
- */
- interface easing {
- /**
- * An easing function that starts away from the target,
- * and quickly accelerates towards the end value.
- *
- * Use caution when the easing will cause values to become
- * negative as some properties cannot be set to negative values.
- *
- * @param n Optional
- */
- backIn(n?: number): number;
- /**
- * An easing function combining the effects of backIn and backOut
- * An easing function combining the effects of backIn and backOut.
- * Use caution when the easing will cause values to become negative
- * as some properties cannot be set to negative values.
- *
- * @param n Optional
- */
- backInOut(n?: number): number;
- /**
- * An easing function that pops past the range briefly, and slowly comes back.
- * An easing function that pops past the range briefly, and slowly comes back.
- *
- * Use caution when the easing will cause values to become negative as some
- * properties cannot be set to negative values.
- *
- * @param n Optional
- */
- backOut(n?: number): number;
- /**
- * An easing function that 'bounces' near the beginning of an Animation
- *
- * @param n Optional
- */
- bounceIn(n?: number): number;
- /**
- * An easing function that 'bounces' at the beginning and end of the Animation
- *
- * @param n Optional
- */
- bounceInOut(n?: number): number;
- /**
- * An easing function that 'bounces' near the end of an Animation
- *
- * @param n Optional
- */
- bounceOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- circIn(n?: number): number;
- /**
- *
- * @param n Optional
- */
- circInOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- circOut(n?: number): any;
- /**
- *
- * @param n Optional
- */
- cubicIn(n?: number): any;
- /**
- *
- * @param n Optional
- */
- cubicInOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- cubicOut(n?: number): number;
- /**
- * An easing function the elastically snaps from the start value
- * An easing function the elastically snaps from the start value
- *
- * Use caution when the elasticity will cause values to become negative
- * as some properties cannot be set to negative values.
- *
- * @param n Optional
- */
- elasticIn(n?: number): number;
- /**
- * An easing function that elasticly snaps around the value, near
- * the beginning and end of the Animation.
- * An easing function that elasticly snaps around the value, near
- * the beginning and end of the Animation.
- *
- * Use caution when the elasticity will cause values to become
- * negative as some properties cannot be set to negative values.
- *
- * @param n Optional
- */
- elasticInOut(n?: number): number;
- /**
- * An easing function that elasticly snaps around the target value,
- * near the end of the Animation
- * An easing function that elasticly snaps around the target value,
- * near the end of the Animation
- *
- * Use caution when the elasticity will cause values to become
- * negative as some properties cannot be set to negative values.
- *
- * @param n Optional
- */
- elasticOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- expoIn(n?: number): any;
- /**
- *
- * @param n Optional
- */
- expoInOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- expoOut(n?: number): number;
- /**
- * A linear easing function
- *
- * @param n Optional
- */
- linear(n?: number): number;
- /**
- *
- * @param n Optional
- */
- quadIn(n?: number): any;
- /**
- *
- * @param n Optional
- */
- quadInOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- quadOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- quartIn(n?: number): any;
- /**
- *
- * @param n Optional
- */
- quartInOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- quartOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- quintIn(n?: number): any;
- /**
- *
- * @param n Optional
- */
- quintInOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- quintOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- sineIn(n?: number): number;
- /**
- *
- * @param n Optional
- */
- sineInOut(n?: number): number;
- /**
- *
- * @param n Optional
- */
- sineOut(n?: number): any;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/router.html
- *
- * A singleton-style instance of dojo/router/RouterBase. See that
- * module for specifics.
- *
- */
- interface router extends dojo.router.RouterBase {
- }
- namespace router {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/router/RouterBase.html
- *
- * A module that allows one to easily map hash-based structures into
- * callbacks. The router module is a singleton, offering one central
- * point for all registrations of this type.
- *
- * @param kwArgs
- */
- class RouterBase {
- constructor(kwArgs: any);
- /**
- *
- */
- "globMatch": RegExp;
- /**
- *
- */
- "globReplacement": string;
- /**
- *
- */
- "idMatch": RegExp;
- /**
- *
- */
- "idReplacement": string;
- /**
- *
- */
- destroy(): void;
- /**
- * A simple pass-through to make changing the hash easy,
- * without having to require dojo/hash directly. It also
- * synchronously fires off any routes that match.
- *
- * @param path
- * @param replace
- */
- go(path: string, replace?: boolean): any;
- /**
- * Registers a route to a handling callback
- * Given either a string or a regular expression, the router
- * will monitor the page's hash and respond to changes that
- * match the string or regex as provided.
- *
- * When provided a regex for the route:
- *
- * Matching is performed, and the resulting capture groups
- * are passed through to the callback as an array.
- * When provided a string for the route:
- *
- * The string is parsed as a URL-like structure, like
- * "/foo/bar"
- * If any portions of that URL are prefixed with a colon
- * (:), they will be parsed out and provided to the callback
- * as properties of an object.
- * If the last piece of the URL-like structure is prefixed
- * with a star (*) instead of a colon, it will be replaced in
- * the resulting regex with a greedy (.+) match and
- * anything remaining on the hash will be provided as a
- * property on the object passed into the callback. Think of
- * it like a basic means of globbing the end of a route.
- *
- * @param route A string or regular expression which will be used whenmonitoring hash changes.
- * @param callback When the hash matches a pattern as described in the route,this callback will be executed. It will receive an eventobject that will have several properties:params: Either an array or object of properties pulledfrom the new hasholdPath: The hash in its state before the changenewPath: The new hash being shifted topreventDefault: A method that will stop hash changesfrom being actually applied to the active hash. This onlyworks if the hash change was initiated using router.go,as changes initiated more directly to the location.hashproperty will already be in placestopImmediatePropagation: When called, will stop anyfurther bound callbacks on this particular route frombeing executed. If two distinct routes are bound that aredifferent, but both happen to match the current hash insome way, this will not keep other routes from receivingnotice of the change.
- */
- register(route: String, callback: Function): any;
- /**
- * Registers a route to a handling callback
- * Given either a string or a regular expression, the router
- * will monitor the page's hash and respond to changes that
- * match the string or regex as provided.
- *
- * When provided a regex for the route:
- *
- * Matching is performed, and the resulting capture groups
- * are passed through to the callback as an array.
- * When provided a string for the route:
- *
- * The string is parsed as a URL-like structure, like
- * "/foo/bar"
- * If any portions of that URL are prefixed with a colon
- * (:), they will be parsed out and provided to the callback
- * as properties of an object.
- * If the last piece of the URL-like structure is prefixed
- * with a star (*) instead of a colon, it will be replaced in
- * the resulting regex with a greedy (.+) match and
- * anything remaining on the hash will be provided as a
- * property on the object passed into the callback. Think of
- * it like a basic means of globbing the end of a route.
- *
- * @param route A string or regular expression which will be used whenmonitoring hash changes.
- * @param callback When the hash matches a pattern as described in the route,this callback will be executed. It will receive an eventobject that will have several properties:params: Either an array or object of properties pulledfrom the new hasholdPath: The hash in its state before the changenewPath: The new hash being shifted topreventDefault: A method that will stop hash changesfrom being actually applied to the active hash. This onlyworks if the hash change was initiated using router.go,as changes initiated more directly to the location.hashproperty will already be in placestopImmediatePropagation: When called, will stop anyfurther bound callbacks on this particular route frombeing executed. If two distinct routes are bound that aredifferent, but both happen to match the current hash insome way, this will not keep other routes from receivingnotice of the change.
- */
- register(route: RegExp, callback: Function): any;
- /**
- * Registers a route to a handling callback, except before
- * any previously registered callbacks
- * Much like the register method, registerBefore allows
- * us to register route callbacks to happen before any
- * previously registered callbacks. See the documentation for
- * register for more details and examples.
- *
- * @param route
- * @param callback
- */
- registerBefore(route: String, callback: Function): any;
- /**
- * Registers a route to a handling callback, except before
- * any previously registered callbacks
- * Much like the register method, registerBefore allows
- * us to register route callbacks to happen before any
- * previously registered callbacks. See the documentation for
- * register for more details and examples.
- *
- * @param route
- * @param callback
- */
- registerBefore(route: RegExp, callback: Function): any;
- /**
- * This method must be called to activate the router. Until
- * startup is called, no hash changes will trigger route
- * callbacks.
- *
- * @param defaultPath
- */
- startup(defaultPath: any): void;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/aspect.html
- *
- * provides aspect oriented programming functionality, allowing for
- * one to add before, around, or after advice on existing methods.
- *
- */
- interface aspect {
- /**
- * The "after" export of the aspect module is a function that can be used to attach
- * "after" advice to a method. This function will be executed after the original method
- * is executed. By default the function will be called with a single argument, the return
- * value of the original method, or the the return value of the last executed advice (if a previous one exists).
- * The fourth (optional) argument can be set to true to so the function receives the original
- * arguments (from when the original method was called) rather than the return value.
- * If there are multiple "after" advisors, they are executed in the order they were registered.
- *
- * @param target This is the target object
- * @param methodName This is the name of the method to attach to.
- * @param advice This is function to be called after the original method
- * @param receiveArguments OptionalIf this is set to true, the advice function receives the original arguments (from when the original mehtodwas called) rather than the return value of the original/previous method.
- */
- after(target: Object, methodName: String, advice: Function, receiveArguments?: boolean): any;
- /**
- * The "around" export of the aspect module is a function that can be used to attach
- * "around" advice to a method. The advisor function is immediately executed when
- * the around() is called, is passed a single argument that is a function that can be
- * called to continue execution of the original method (or the next around advisor).
- * The advisor function should return a function, and this function will be called whenever
- * the method is called. It will be called with the arguments used to call the method.
- * Whatever this function returns will be returned as the result of the method call (unless after advise changes it).
- *
- * @param target This is the target object
- * @param methodName This is the name of the method to attach to.
- * @param advice This is function to be called around the original method
- */
- around(target: Object, methodName: String, advice: Function): void;
- /**
- * The "before" export of the aspect module is a function that can be used to attach
- * "before" advice to a method. This function will be executed before the original method
- * is executed. This function will be called with the arguments used to call the method.
- * This function may optionally return an array as the new arguments to use to call
- * the original method (or the previous, next-to-execute before advice, if one exists).
- * If the before method doesn't return anything (returns undefined) the original arguments
- * will be preserved.
- * If there are multiple "before" advisors, they are executed in the reverse order they were registered.
- *
- * @param target This is the target object
- * @param methodName This is the name of the method to attach to.
- * @param advice This is function to be called before the original method
- */
- before(target: Object, methodName: String, advice: Function): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/back.html
- *
- * Browser history management resources
- *
- */
- interface back {
- /**
- * adds a state object (args) to the history list.
- * To support getting back button notifications, the object
- * argument should implement a function called either "back",
- * "backButton", or "handle". The string "back" will be passed as
- * the first and only argument to this callback.
- *
- * To support getting forward button notifications, the object
- * argument should implement a function called either "forward",
- * "forwardButton", or "handle". The string "forward" will be
- * passed as the first and only argument to this callback.
- *
- * If you want the browser location string to change, define "changeUrl" on the object. If the
- * value of "changeUrl" is true, then a unique number will be appended to the URL as a fragment
- * identifier (http://some.domain.com/path#uniquenumber). If it is any other value that does
- * not evaluate to false, that value will be used as the fragment identifier. For example,
- * if changeUrl: 'page1', then the URL will look like: http://some.domain.com/path#page1
- *
- * There are problems with using dojo/back with semantically-named fragment identifiers
- * ("hash values" on an URL). In most browsers it will be hard for dojo/back to know
- * distinguish a back from a forward event in those cases. For back/forward support to
- * work best, the fragment ID should always be a unique value (something using new Date().getTime()
- * for example). If you want to detect hash changes using semantic fragment IDs, then
- * consider using dojo/hash instead (in Dojo 1.4+).
- *
- * @param args The state object that will be added to the history list.
- */
- addToHistory(args: Object): void;
- /**
- *
- */
- getHash(): any;
- /**
- * private method. Do not call this directly.
- *
- */
- goBack(): void;
- /**
- * private method. Do not call this directly.
- *
- */
- goForward(): void;
- /**
- * Initializes the undo stack. This must be called from a
- * block that lives inside the <code><body></code> tag to prevent bugs on IE.
- * </p>
- * <p>Only call this method before the page's DOM is finished loading. Otherwise
- * it will not work. Be careful with xdomain loading or djConfig.debugAtAllCosts scenarios,
- * in order for this method to work, dojo/back will need to be part of a build layer.</p>
- * </div>
- * </div>
- * <div class="jsdoc-field">
- * <div class="jsdoc-title"><a name="1_9dojo_back_setHash"></a><span class="functionIcon">setHash</span><span class="parameters">(h)</span>
- * </div>
- * <div class="jsdoc-inheritance">Defined by <a href="/api/1.9/dojo/back" class="jsdoc-link">dojo/back</a>
- * </div>
- * <div class="jsdoc-full-summary"></div>
- * <table class="jsdoc-parameters">
- * <tr>
- * <th>Parameter</th>
- * <th>Type</th>
- * <th>Description</th>
- * </tr>
- * <tr>
- * <td class="jsdoc-param-name">h</td>
- * <td class="jsdoc-param-type">undefined</td>
- * <td class="jsdoc-param-description">
- * </td>
- * </tr>
- * </table>
- * </div>
- * <div class="jsdoc-field">
- * <div class="jsdoc-title"><a name="1_9dojo_back_setInitialState"></a><span class="functionIcon">setInitialState</span><span class="parameters">(args)</span>
- * </div>
- * <div class="jsdoc-inheritance">Defined by <a href="/api/1.9/dojo/back" class="jsdoc-link">dojo/back</a>
- * </div>
- * <div class="jsdoc-full-summary"><p>Sets the state object and back callback for the very first page
- * that is loaded.
- * </p>
- * <p>It is recommended that you call this method as part of an event
- * listener that is registered via dojo/ready.</p>
- * </div>
- * <table class="jsdoc-parameters">
- * <tr>
- * <th>Parameter</th>
- * <th>Type</th>
- * <th>Description</th>
- * </tr>
- * <tr>
- * <td class="jsdoc-param-name">args</td>
- * <td class="jsdoc-param-type">Object</td>
- * <td class="jsdoc-param-description"><p>See the addToHistory() function for the list of valid args properties.</p>
- *
- * </td>
- * </tr>
- * </table>
- * </div>
- * </div>
- * </div>
- * </div><a href="https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dFlDcHEyaHMwbEd4MFBObkNrX0E1MFE6MQ&entry_0=/api/1.9/dojo/back" class="feedback">Error in the documentation? Can't find what you are looking for? Let us know!</a>
- */
- init(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/colors.html
- *
- * Color utilities, extending Base dojo.Color
- *
- */
- interface colors {
- /**
- *
- */
- ThreeD: Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/currency.html
- *
- * localized formatting and parsing routines for currencies
- * extends dojo.number to provide culturally-appropriate formatting of values
- * in various world currencies, including use of a currency symbol. The currencies are specified
- * by a three-letter international symbol in all uppercase, and support for the currencies is
- * provided by the data in dojo.cldr. The scripts generating dojo.cldr specify which
- * currency support is included. A fixed number of decimal places is determined based
- * on the currency type and is not determined by the 'pattern' argument. The fractional
- * portion is optional, by default, and variable length decimals are not supported.
- *
- */
- interface currency {
- /**
- * Format a Number as a currency, using locale-specific settings
- * Create a string from a Number using a known, localized pattern.
- * Formatting patterns
- * appropriate to the locale are chosen from the CLDR
- * as well as the appropriate symbols and delimiters and number of decimal places.
- *
- * @param value the number to be formatted.
- * @param options Optional
- */
- format(value: number, options?: dojo.currency.__FormatOptions): any;
- /**
- *
- * @param expression
- * @param options OptionalAn object with the following properties:type (String, optional): Should not be set. Value is assumed to be currency.currency (String, optional): an ISO4217 currency code, a three letter sequence like "USD".For use with dojo.currency only.symbol (String, optional): localized currency symbol. The default will be looked up in table of supported currencies in dojo.cldrA ISO4217 currency code will be used if not found.places (Number, optional): fixed number of decimal places to accept. The default is determined based on which currency is used.fractional (Boolean|Array, optional): Whether to include the fractional portion, where the number of decimal places are implied by the currencyor explicit 'places' parameter. The value [true,false] makes the fractional portion optional.By default for currencies, it the fractional portion is optional.pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization. Literal characters in patterns are not supported.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separators
- */
- parse(expression: String, options?: Object): any;
- /**
- *
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separatorsplaces (Number|String, optional): number of decimal places to accept: Infinity, a positive number, ora range "n,m". Defined by pattern or Infinity if pattern not provided.
- */
- regexp(options?: Object): any;
- }
- namespace currency {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/currency.__FormatOptions.html
- *
- *
- */
- class __FormatOptions {
- constructor();
- /**
- * an ISO4217 currency code, a three letter sequence like "USD".
- * For use with dojo.currency only.
- *
- */
- "currency": string;
- /**
- * If false, show no decimal places, overriding places and pattern settings.
- *
- */
- "fractional": boolean;
- /**
- * override the locale used to determine formatting rules
- *
- */
- "locale": string;
- /**
- * override formatting pattern
- * with this string. Default value is based on locale. Overriding this property will defeat
- * localization. Literal characters in patterns are not supported.
- *
- */
- "pattern": string;
- /**
- * number of decimal places to show. Default is defined based on which currency is used.
- *
- */
- "places": number;
- /**
- * 5 rounds to nearest .5; 0 rounds to nearest whole (default). -1
- * means do not round.
- *
- */
- "round": number;
- /**
- * localized currency symbol. The default will be looked up in table of supported currencies in dojo.cldr
- * A ISO4217 currency code will be used if not found.
- *
- */
- "symbol": string;
- /**
- * Should not be set. Value is assumed to be "currency".
- *
- */
- "type": string;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/currency.__ParseOptions.html
- *
- *
- */
- class __ParseOptions {
- constructor();
- /**
- * an ISO4217 currency code, a three letter sequence like "USD".
- * For use with dojo.currency only.
- *
- */
- "currency": string;
- /**
- * Whether to include the fractional portion, where the number of decimal places are implied by the currency
- * or explicit 'places' parameter. The value [true,false] makes the fractional portion optional.
- * By default for currencies, it the fractional portion is optional.
- *
- */
- "fractional": boolean;
- /**
- * override the locale used to determine formatting rules
- *
- */
- "locale": string;
- /**
- * override formatting pattern
- * with this string. Default value is based on locale. Overriding this property will defeat
- * localization. Literal characters in patterns are not supported.
- *
- */
- "pattern": string;
- /**
- * fixed number of decimal places to accept. The default is determined based on which currency is used.
- *
- */
- "places": number;
- /**
- * strict parsing, false by default. Strict parsing requires input as produced by the format() method.
- * Non-strict is more permissive, e.g. flexible on white space, omitting thousands separators
- *
- */
- "strict": boolean;
- /**
- * localized currency symbol. The default will be looked up in table of supported currencies in dojo.cldr
- * A ISO4217 currency code will be used if not found.
- *
- */
- "symbol": string;
- /**
- * Should not be set. Value is assumed to be currency.
- *
- */
- "type": string;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dom.html
- *
- * This module defines the core dojo DOM API.
- *
- */
- interface dom {
- /**
- * Returns DOM node with matching id attribute or falsy value (ex: null or undefined)
- * if not found. If id is a DomNode, this function is a no-op.
- *
- * @param id A string to match an HTML id attribute or a reference to a DOM Node
- * @param doc OptionalDocument to work in. Defaults to the current value ofdojo/_base/window.doc. Can be used to retrievenode references from other documents.
- */
- byId(id: String, doc?: HTMLDocument): any;
- /**
- * Returns DOM node with matching id attribute or falsy value (ex: null or undefined)
- * if not found. If id is a DomNode, this function is a no-op.
- *
- * @param id A string to match an HTML id attribute or a reference to a DOM Node
- * @param doc OptionalDocument to work in. Defaults to the current value ofdojo/_base/window.doc. Can be used to retrievenode references from other documents.
- */
- byId(id: HTMLElement, doc?: HTMLDocument): any;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: HTMLElement, ancestor: HTMLElement): boolean;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: String, ancestor: HTMLElement): boolean;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: HTMLElement, ancestor: String): boolean;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: String, ancestor: String): boolean;
- /**
- *
- * @param node
- * @param selectable
- */
- setSelectable(node: any, selectable: any): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dom-attr.html
- *
- *
- */
- interface dom_attr {
- /**
- * Gets an attribute on an HTML element.
- * Handles normalized getting of attributes on DOM Nodes.
- *
- * @param node id or reference to the element to get the attribute on
- * @param name the name of the attribute to get.
- */
- get(node: HTMLElement, name: String): any;
- /**
- * Gets an attribute on an HTML element.
- * Handles normalized getting of attributes on DOM Nodes.
- *
- * @param node id or reference to the element to get the attribute on
- * @param name the name of the attribute to get.
- */
- get(node: String, name: String): any;
- /**
- * Returns an effective value of a property or an attribute.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute
- */
- getNodeProp(node: HTMLElement, name: String): any;
- /**
- * Returns an effective value of a property or an attribute.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute
- */
- getNodeProp(node: String, name: String): any;
- /**
- * Returns true if the requested attribute is specified on the
- * given element, and false otherwise.
- *
- * @param node id or reference to the element to check
- * @param name the name of the attribute
- */
- has(node: HTMLElement, name: String): boolean;
- /**
- * Returns true if the requested attribute is specified on the
- * given element, and false otherwise.
- *
- * @param node id or reference to the element to check
- * @param name the name of the attribute
- */
- has(node: String, name: String): boolean;
- /**
- * Removes an attribute from an HTML element.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute to remove
- */
- remove(node: HTMLElement, name: String): void;
- /**
- * Removes an attribute from an HTML element.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute to remove
- */
- remove(node: String, name: String): void;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- set(node: HTMLElement, name: String, value?: String): any;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- set(node: String, name: String, value?: String): any;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- set(node: HTMLElement, name: Object, value?: String): any;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- set(node: String, name: Object, value?: String): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dom-class.html
- *
- * This module defines the core dojo DOM class API.
- *
- */
- interface dom_class {
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- add(node: String, classStr: String): void;
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- add(node: HTMLElement, classStr: String): void;
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- add(node: String, classStr: any[]): void;
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- add(node: HTMLElement, classStr: any[]): void;
- /**
- * Returns whether or not the specified classes are a portion of the
- * class list currently applied to the node.
- *
- * @param node String ID or DomNode reference to check the class for.
- * @param classStr A string class name to look for.
- */
- contains(node: String, classStr: String): boolean;
- /**
- * Returns whether or not the specified classes are a portion of the
- * class list currently applied to the node.
- *
- * @param node String ID or DomNode reference to check the class for.
- * @param classStr A string class name to look for.
- */
- contains(node: HTMLElement, classStr: String): boolean;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- remove(node: String, classStr?: String): void;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- remove(node: HTMLElement, classStr?: String): void;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- remove(node: String, classStr?: any[]): void;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- remove(node: HTMLElement, classStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replace(node: String, addClassStr: String, removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replace(node: HTMLElement, addClassStr: String, removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replace(node: String, addClassStr: any[], removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replace(node: HTMLElement, addClassStr: any[], removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replace(node: String, addClassStr: String, removeClassStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replace(node: HTMLElement, addClassStr: String, removeClassStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replace(node: String, addClassStr: any[], removeClassStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replace(node: HTMLElement, addClassStr: any[], removeClassStr?: any[]): void;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggle(node: String, classStr: String, condition?: boolean): boolean;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggle(node: HTMLElement, classStr: String, condition?: boolean): boolean;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggle(node: String, classStr: any[], condition?: boolean): boolean;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggle(node: HTMLElement, classStr: any[], condition?: boolean): boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dom-form.html
- *
- * This module defines form-processing functions.
- *
- */
- interface dom_form {
- /**
- * Serialize a form field to a JavaScript object.
- * Returns the value encoded in a form field as
- * as a string or an array of strings. Disabled form elements
- * and unchecked radio and checkboxes are skipped. Multi-select
- * elements are returned as an array of string values.
- *
- * @param inputNode
- */
- fieldToObject(inputNode: HTMLElement): Object;
- /**
- * Serialize a form field to a JavaScript object.
- * Returns the value encoded in a form field as
- * as a string or an array of strings. Disabled form elements
- * and unchecked radio and checkboxes are skipped. Multi-select
- * elements are returned as an array of string values.
- *
- * @param inputNode
- */
- fieldToObject(inputNode: String): Object;
- /**
- * Create a serialized JSON string from a form node or string
- * ID identifying the form to serialize
- *
- * @param formNode
- * @param prettyPrint Optional
- */
- toJson(formNode: HTMLElement, prettyPrint?: boolean): String;
- /**
- * Create a serialized JSON string from a form node or string
- * ID identifying the form to serialize
- *
- * @param formNode
- * @param prettyPrint Optional
- */
- toJson(formNode: String, prettyPrint?: boolean): String;
- /**
- * Serialize a form node to a JavaScript object.
- * Returns the values encoded in an HTML form as
- * string properties in an object which it then returns. Disabled form
- * elements, buttons, and other non-value form elements are skipped.
- * Multi-select elements are returned as an array of string values.
- *
- * @param formNode
- */
- toObject(formNode: HTMLElement): Object;
- /**
- * Serialize a form node to a JavaScript object.
- * Returns the values encoded in an HTML form as
- * string properties in an object which it then returns. Disabled form
- * elements, buttons, and other non-value form elements are skipped.
- * Multi-select elements are returned as an array of string values.
- *
- * @param formNode
- */
- toObject(formNode: String): Object;
- /**
- * Returns a URL-encoded string representing the form passed as either a
- * node or string ID identifying the form to serialize
- *
- * @param formNode
- */
- toQuery(formNode: HTMLElement): String;
- /**
- * Returns a URL-encoded string representing the form passed as either a
- * node or string ID identifying the form to serialize
- *
- * @param formNode
- */
- toQuery(formNode: String): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dom-construct.html
- *
- *
- */
- interface dom_construct {
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: HTMLElement, attrs: Object, refNode?: HTMLElement, pos?: String): any;
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: String, attrs: Object, refNode?: HTMLElement, pos?: String): any;
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: HTMLElement, attrs: Object, refNode?: String, pos?: String): any;
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: String, attrs: Object, refNode?: String, pos?: String): any;
- /**
- * Removes a node from its parent, clobbering it and all of its
- * children.
- * Removes a node from its parent, clobbering it and all of its
- * children. Function only works with DomNodes, and returns nothing.
- *
- * @param node A String ID or DomNode reference of the element to be destroyed
- */
- destroy(node: HTMLElement): void;
- /**
- * Removes a node from its parent, clobbering it and all of its
- * children.
- * Removes a node from its parent, clobbering it and all of its
- * children. Function only works with DomNodes, and returns nothing.
- *
- * @param node A String ID or DomNode reference of the element to be destroyed
- */
- destroy(node: String): void;
- /**
- * safely removes all children of the node.
- *
- * @param node a reference to a DOM node or an id.
- */
- empty(node: HTMLElement): void;
- /**
- * safely removes all children of the node.
- *
- * @param node a reference to a DOM node or an id.
- */
- empty(node: String): void;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: HTMLElement, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: HTMLElement, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: String, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: String, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: HTMLElement, position?: number): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: HTMLElement, position?: number): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: String, position?: number): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: String, position?: number): HTMLElement;
- /**
- * instantiates an HTML fragment returning the corresponding DOM.
- *
- * @param frag the HTML fragment
- * @param doc Optionaloptional document to use when creating DOM nodes, defaults todojo/_base/window.doc if not specified.
- */
- toDom(frag: String, doc?: HTMLDocument): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dom-prop.html
- *
- *
- */
- interface dom_prop {
- /**
- *
- */
- names: Object;
- /**
- * Gets a property on an HTML element.
- * Handles normalized getting of properties on DOM nodes.
- *
- * @param node id or reference to the element to get the property on
- * @param name the name of the property to get.
- */
- get(node: HTMLElement, name: String): any;
- /**
- * Gets a property on an HTML element.
- * Handles normalized getting of properties on DOM nodes.
- *
- * @param node id or reference to the element to get the property on
- * @param name the name of the property to get.
- */
- get(node: String, name: String): any;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- set(node: HTMLElement, name: String, value?: String): any;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- set(node: String, name: String, value?: String): any;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- set(node: HTMLElement, name: Object, value?: String): any;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- set(node: String, name: Object, value?: String): any;
- }
- namespace dom_prop {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dom-prop.names.html
- *
- *
- */
- interface names {
- /**
- *
- */
- class: string;
- /**
- *
- */
- colspan: string;
- /**
- *
- */
- for: string;
- /**
- *
- */
- frameborder: string;
- /**
- *
- */
- readonly: string;
- /**
- *
- */
- rowspan: string;
- /**
- *
- */
- tabindex: string;
- /**
- *
- */
- valuetype: string;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dom-style.html
- *
- * This module defines the core dojo DOM style API.
- *
- */
- interface dom_style {
- /**
- *
- * @param node
- * @param name
- */
- get(node: HTMLElement, name: String): any;
- /**
- *
- * @param node
- * @param name
- */
- get(node: String, name: String): any;
- /**
- *
- * @param node
- * @param name
- */
- get(node: HTMLElement, name: Object): any;
- /**
- *
- * @param node
- * @param name
- */
- get(node: String, name: Object): any;
- /**
- * Returns a "computed style" object.
- * Gets a "computed style" object which can be used to gather
- * information about the current state of the rendered node.
- *
- * Note that this may behave differently on different browsers.
- * Values may have different formats and value encodings across
- * browsers.
- *
- * Note also that this method is expensive. Wherever possible,
- * reuse the returned object.
- *
- * Use the dojo/dom-style.get() method for more consistent (pixelized)
- * return values.
- *
- * @param node A reference to a DOM node. Does NOT support taking anID string for speed reasons.
- */
- getComputedStyle(node: HTMLElement): void;
- /**
- *
- * @param node
- * @param name
- * @param value Optional
- */
- set(node: HTMLElement, name: String, value?: String): any;
- /**
- *
- * @param node
- * @param name
- * @param value Optional
- */
- set(node: String, name: String, value?: String): any;
- /**
- *
- * @param node
- * @param name
- * @param value Optional
- */
- set(node: HTMLElement, name: Object, value?: String): any;
- /**
- *
- * @param node
- * @param name
- * @param value Optional
- */
- set(node: String, name: Object, value?: String): any;
- /**
- * converts style value to pixels on IE or return a numeric value.
- *
- * @param node
- * @param value
- */
- toPixelValue(node: HTMLElement, value: String): number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/dom-geometry.html
- *
- * This module defines the core dojo DOM geometry API.
- *
- */
- interface dom_geometry {
- /**
- *
- */
- boxModel: string;
- /**
- * Returns an object with {node, x, y} with corresponding offsets.
- *
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- docScroll(doc?: HTMLDocument): Object;
- /**
- * In RTL direction, scrollLeft should be a negative value, but IE
- * returns a positive one. All codes using documentElement.scrollLeft
- * must call this function to fix this error, otherwise the position
- * will offset to right when there is a horizontal scrollbar.
- *
- * @param scrollLeft
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- fixIeBiDiScrollLeft(scrollLeft: number, doc?: HTMLDocument): number;
- /**
- * returns an object with properties useful for noting the border
- * dimensions.
- * l/t/r/b = the sum of left/top/right/bottom border (respectively)
- * w = the sum of the left and right border
- * h = the sum of the top and bottom border
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getBorderExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * Returns an object that encodes the width, height, left and top
- * positions of the node's content box, irrespective of the
- * current box model.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getContentBox(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns the offset in x and y from the document body to the
- * visual edge of the page for IE
- * The following values in IE contain an offset:
- *
- * event.clientX
- * event.clientY
- * node.getBoundingClientRect().left
- * node.getBoundingClientRect().top
- * But other position related values do not contain this offset,
- *
- * such as node.offsetLeft, node.offsetTop, node.style.left and
- * node.style.top. The offset is always (2, 2) in LTR direction.
- * When the body is in RTL direction, the offset counts the width
- * of left scroll bar's width. This function computes the actual
- * offset.
- *
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- getIeDocumentElementOffset(doc?: HTMLDocument): Object;
- /**
- * returns an object that encodes the width, height, left and top
- * positions of the node's margin box.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginBox(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns object with properties useful for box fitting with
- * regards to box margins (i.e., the outer-box).
- *
- * l/t = marginLeft, marginTop, respectively
- * w = total width, margin inclusive
- * h = total height, margin inclusive
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns an object that encodes the width and height of
- * the node's margin box
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginSize(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns an object that encodes the width and height of
- * the node's margin box
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginSize(node: String, computedStyle?: Object): Object;
- /**
- * Returns object with properties useful for box fitting with
- * regards to padding.
- * l/t/r/b = the sum of left/top/right/bottom padding and left/top/right/bottom border (respectively)
- * w = the sum of the left and right padding and border
- * h = the sum of the top and bottom padding and border
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getPadBorderExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * Returns object with special values specifically useful for node
- * fitting.
- * Returns an object with w, h, l, t properties:
- *
- * l/t/r/b = left/top/right/bottom padding (respectively)
- * w = the total of the left and right padding
- * h = the total of the top and bottom padding
- * If 'node' has position, l/t forms the origin for child nodes.
- *
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getPadExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * Returns true if the current language is left-to-right, and false otherwise.
- *
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- isBodyLtr(doc?: HTMLDocument): boolean;
- /**
- * Normalizes the geometry of a DOM event, normalizing the pageX, pageY,
- * offsetX, offsetY, layerX, and layerX properties
- *
- * @param event
- */
- normalizeEvent(event: Object): void;
- /**
- * Gets the position and size of the passed element relative to
- * the viewport (if includeScroll==false), or relative to the
- * document root (if includeScroll==true).
- * Returns an object of the form:
- * { x: 100, y: 300, w: 20, h: 15 }.
- * If includeScroll==true, the x and y values will include any
- * document offsets that may affect the position relative to the
- * viewport.
- * Uses the border-box model (inclusive of border and padding but
- * not margin). Does not act as a setter.
- *
- * @param node
- * @param includeScroll Optional
- */
- position(node: HTMLElement, includeScroll?: boolean): { w: number; h: number; x: number; y: number };
- /**
- * Gets the position and size of the passed element relative to
- * the viewport (if includeScroll==false), or relative to the
- * document root (if includeScroll==true).
- * Returns an object of the form:
- * { x: 100, y: 300, w: 20, h: 15 }.
- * If includeScroll==true, the x and y values will include any
- * document offsets that may affect the position relative to the
- * viewport.
- * Uses the border-box model (inclusive of border and padding but
- * not margin). Does not act as a setter.
- *
- * @param node
- * @param includeScroll Optional
- */
- position(node: String, includeScroll?: boolean): { w: number; h: number; x: number; y: number };
- /**
- * Sets the size of the node's contents, irrespective of margins,
- * padding, or borders.
- *
- * @param node
- * @param box hash with optional "w", and "h" properties for "width", and "height"respectively. All specified properties should have numeric values in whole pixels.
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- setContentSize(node: HTMLElement, box: Object, computedStyle?: Object): void;
- /**
- * sets the size of the node's margin box and placement
- * (left/top), irrespective of box model. Think of it as a
- * passthrough to setBox that handles box-model vagaries for
- * you.
- *
- * @param node
- * @param box hash with optional "l", "t", "w", and "h" properties for "left", "right", "width", and "height"respectively. All specified properties should have numeric values in whole pixels.
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- setMarginBox(node: HTMLElement, box: Object, computedStyle?: Object): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/gears.html
- *
- * TODOC
- *
- */
- interface gears {
- /**
- * True if client is using Google Gears
- *
- */
- available: Object;
- }
- namespace gears {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/gears.available.html
- *
- * True if client is using Google Gears
- *
- */
- interface available {
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/html.html
- *
- * TODOC
- *
- */
- interface html {
- /**
- * inserts (replaces) the given content into the given node. dojo/dom-construct.place(cont, node, "only")
- * may be a better choice for simple HTML insertion.
- * Unless you need to use the params capabilities of this method, you should use
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct..place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct..place does not handle NodeList insertions
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct.place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct.place does not handle NodeList insertions
- * or the other capabilities as defined by the params object for this method.
- *
- * @param node the parent element that will receive the content
- * @param cont the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param params OptionalOptional flags/properties to configure the content-setting. See dojo/html/_ContentSetter
- */
- set(node: HTMLElement, cont: String, params?: Object): any;
- /**
- * inserts (replaces) the given content into the given node. dojo/dom-construct.place(cont, node, "only")
- * may be a better choice for simple HTML insertion.
- * Unless you need to use the params capabilities of this method, you should use
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct..place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct..place does not handle NodeList insertions
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct.place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct.place does not handle NodeList insertions
- * or the other capabilities as defined by the params object for this method.
- *
- * @param node the parent element that will receive the content
- * @param cont the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param params OptionalOptional flags/properties to configure the content-setting. See dojo/html/_ContentSetter
- */
- set(node: HTMLElement, cont: HTMLElement, params?: Object): any;
- /**
- * inserts (replaces) the given content into the given node. dojo/dom-construct.place(cont, node, "only")
- * may be a better choice for simple HTML insertion.
- * Unless you need to use the params capabilities of this method, you should use
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct..place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct..place does not handle NodeList insertions
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct.place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct.place does not handle NodeList insertions
- * or the other capabilities as defined by the params object for this method.
- *
- * @param node the parent element that will receive the content
- * @param cont the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param params OptionalOptional flags/properties to configure the content-setting. See dojo/html/_ContentSetter
- */
- set(node: HTMLElement, cont: NodeList, params?: Object): any;
- }
- namespace html {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/html._ContentSetter.html
- *
- *
- * @param params
- * @param node
- */
- class _ContentSetter {
- constructor(params: Object, node: String);
- /**
- * Should the content be treated as a full html document,
- * and the real content stripped of , wrapper before injection
- *
- */
- "cleanContent": boolean;
- /**
- * The content to be placed in the node. Can be an HTML string, a node reference, or a enumerable list of nodes
- *
- */
- "content": string;
- /**
- * Should the content be treated as a full html document,
- * and the real content stripped of <html> <body> wrapper before injection
- *
- */
- "extractContent": boolean;
- /**
- * Usually only used internally, and auto-generated with each instance
- *
- */
- "id": Object;
- /**
- * An node which will be the parent element that we set content into
- *
- */
- "node": HTMLElement;
- /**
- * Should the node by passed to the parser after the new content is set
- *
- */
- "parseContent": boolean;
- /**
- * Flag passed to parser. Root for attribute names to search for. If scopeName is dojo,
- * will search for data-dojo-type (or dojoType). For backwards compatibility
- * reasons defaults to dojo._scopeName (which is "dojo" except when
- * multi-version support is used, when it will be something like dojo16, dojo20, etc.)
- *
- */
- "parserScope": string;
- /**
- * Start the child widgets after parsing them. Only obeyed if parseContent is true.
- *
- */
- "startup": boolean;
- /**
- * cleanly empty out existing content
- *
- */
- empty(): void;
- /**
- * front-end to the set-content sequence
- *
- * @param cont OptionalAn html string, node or enumerable list of nodes for insertion into the domIf not provided, the object's content property will be used
- * @param params Optional
- */
- set(cont: String, params?: Object): any;
- /**
- * front-end to the set-content sequence
- *
- * @param cont OptionalAn html string, node or enumerable list of nodes for insertion into the domIf not provided, the object's content property will be used
- * @param params Optional
- */
- set(cont: HTMLElement, params?: Object): any;
- /**
- * front-end to the set-content sequence
- *
- * @param cont OptionalAn html string, node or enumerable list of nodes for insertion into the domIf not provided, the object's content property will be used
- * @param params Optional
- */
- set(cont: NodeList, params?: Object): any;
- /**
- * sets the content on the node
- *
- */
- setContent(): void;
- /**
- * manually reset the Setter instance if its being re-used for example for another set()
- * tearDown() is not called automatically.
- * In normal use, the Setter instance properties are simply allowed to fall out of scope
- * but the tearDown method can be called to explicitly reset this instance.
- *
- */
- tearDown(): void;
- /**
- * Called after instantiation, but before set();
- * It allows modification of any of the object properties -
- * including the node and content provided - before the set operation actually takes place
- * This default implementation checks for cleanContent and extractContent flags to
- * optionally pre-process html string content
- *
- */
- onBegin(): any;
- /**
- *
- * @param err
- */
- onContentError(err: any): String;
- /**
- * Called after set(), when the new content has been pushed into the node
- * It provides an opportunity for post-processing before handing back the node to the caller
- * This default implementation checks a parseContent flag to optionally run the dojo parser over the new content
- *
- */
- onEnd(): any;
- /**
- *
- * @param err
- */
- onExecError(err: any): String;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/io-query.html
- *
- * This module defines query string processing functions.
- *
- */
- interface io_query {
- /**
- * takes a name/value mapping object and returns a string representing
- * a URL-encoded version of that object.
- *
- * @param map
- */
- objectToQuery(map: Object): any;
- /**
- * Create an object representing a de-serialized query section of a
- * URL. Query keys with multiple values are returned in an array.
- *
- * @param str
- */
- queryToObject(str: String): Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/i18n.html
- *
- * This module implements the dojo/i18n! plugin and the v1.6- i18n API
- * We choose to include our own plugin to leverage functionality already contained in dojo
- * and thereby reduce the size of the plugin compared to various loader implementations. Also, this
- * allows foreign AMD loaders to be used without their plugins.
- *
- */
- interface i18n {
- /**
- *
- */
- cache: Object;
- /**
- *
- */
- dynamic: boolean;
- /**
- *
- */
- unitTests: any[];
- /**
- *
- * @param moduleName
- * @param bundleName
- * @param locale
- */
- getL10nName(moduleName: any, bundleName: any, locale: any): String;
- /**
- *
- * @param moduleName
- * @param bundleName
- * @param locale
- */
- getLocalization(moduleName: any, bundleName: any, locale: any): any;
- /**
- * id is in one of the following formats
- *
- * /nls/
- * => load the bundle, localized to config.locale; load all bundles localized to
- * config.extraLocale (if any); return the loaded bundle localized to config.locale.
- * /nls//
- * => load then return the bundle localized to
- * preload/nls//
- * => for config.locale and all config.extraLocale, load all bundles found
- * in the best-matching bundle rollup. A value of 1 is returned, which
- * is meaningless other than to say the plugin is executing the requested
- * preloads
- *
- * In cases 1 and 2, is always normalized to an absolute module id upon entry; see
- * normalize. In case 3, it is assumed to be absolute; this is arranged by the builder.
- *
- * To load a bundle means to insert the bundle into the plugin's cache and publish the bundle
- * value to the loader. Given , , and a particular , the cache key
- *
- * <path>/nls/<bundle>/<locale>
- * will hold the value. Similarly, then plugin will publish this value to the loader by
- *
- * define("<path>/nls/<bundle>/<locale>", <bundle-value>);
- * Given this algorithm, other machinery can provide fast load paths be preplacing
- * values in the plugin's cache, which is public. When a load is demanded the
- * cache is inspected before starting any loading. Explicitly placing values in the plugin
- * cache is an advanced/experimental feature that should not be needed; use at your own risk.
- *
- * For the normal AMD algorithm, the root bundle is loaded first, which instructs the
- * plugin what additional localized bundles are required for a particular locale. These
- * additional locales are loaded and a mix of the root and each progressively-specific
- * locale is returned. For example:
- *
- * The client demands "dojo/i18n!some/path/nls/someBundle
- * The loader demands load(some/path/nls/someBundle)
- * This plugin require's "some/path/nls/someBundle", which is the root bundle.
- * Assuming config.locale is "ab-cd-ef" and the root bundle indicates that localizations
- * are available for "ab" and "ab-cd-ef" (note the missing "ab-cd", then the plugin
- * requires "some/path/nls/ab/someBundle" and "some/path/nls/ab-cd-ef/someBundle"
- * Upon receiving all required bundles, the plugin constructs the value of the bundle
- * ab-cd-ef as...
- * mixin(mixin(mixin({}, require("some/path/nls/someBundle"),
- * require("some/path/nls/ab/someBundle")),
- * require("some/path/nls/ab-cd-ef/someBundle"));
- *
- * This value is inserted into the cache and published to the loader at the
- * key/module-id some/path/nls/someBundle/ab-cd-ef.
- *
- * The special preload signature (case 3) instructs the plugin to stop servicing all normal requests
- * (further preload requests will be serviced) until all ongoing preloading has completed.
- *
- * The preload signature instructs the plugin that a special rollup module is available that contains
- * one or more flattened, localized bundles. The JSON array of available locales indicates which locales
- * are available. Here is an example:
- *
- * *preload*some/path/nls/someModule*["root", "ab", "ab-cd-ef"]
- * This indicates the following rollup modules are available:
- *
- * some/path/nls/someModule_ROOT
- * some/path/nls/someModule_ab
- * some/path/nls/someModule_ab-cd-ef
- * Each of these modules is a normal AMD module that contains one or more flattened bundles in a hash.
- * For example, assume someModule contained the bundles some/bundle/path/someBundle and
- * some/bundle/path/someOtherBundle, then some/path/nls/someModule_ab would be expressed as follows:
- *
- * define({
- * some/bundle/path/someBundle:<value of someBundle, flattened with respect to locale ab>,
- * some/bundle/path/someOtherBundle:<value of someOtherBundle, flattened with respect to locale ab>,
- * });
- * E.g., given this design, preloading for locale=="ab" can execute the following algorithm:
- *
- * require(["some/path/nls/someModule_ab"], function(rollup){
- * for(var p in rollup){
- * var id = p + "/ab",
- * cache[id] = rollup[p];
- * define(id, rollup[p]);
- * }
- * });
- * Similarly, if "ab-cd" is requested, the algorithm can determine that "ab" is the best available and
- * load accordingly.
- *
- * The builder will write such rollups for every layer if a non-empty localeList profile property is
- * provided. Further, the builder will include the following cache entry in the cache associated with
- * any layer.
- *
- * "*now":function(r){r(['dojo/i18n!*preload*<path>/nls/<module>*<JSON array of available locales>']);}
- * The *now special cache module instructs the loader to apply the provided function to context-require
- * with respect to the particular layer being defined. This causes the plugin to hold all normal service
- * requests until all preloading is complete.
- *
- * Notice that this algorithm is rarely better than the standard AMD load algorithm. Consider the normal case
- * where the target locale has a single segment and a layer depends on a single bundle:
- *
- * Without Preloads:
- *
- * Layer loads root bundle.
- * bundle is demanded; plugin loads single localized bundle.
- * With Preloads:
- *
- * Layer causes preloading of target bundle.
- * bundle is demanded; service is delayed until preloading complete; bundle is returned.
- * In each case a single transaction is required to load the target bundle. In cases where multiple bundles
- * are required and/or the locale has multiple segments, preloads still requires a single transaction whereas
- * the normal path requires an additional transaction for each additional bundle/locale-segment. However all
- * of these additional transactions can be done concurrently. Owing to this analysis, the entire preloading
- * algorithm can be discard during a build by setting the has feature dojo-preload-i18n-Api to false.
- *
- * @param id
- * @param require
- * @param load
- */
- load(id: any, require: any, load: any): void;
- /**
- * id may be relative.
- * preload has form *preload*<path>/nls/<module>*<flattened locales> and
- * therefore never looks like a relative
- *
- * @param id
- * @param toAbsMid
- */
- normalize(id: any, toAbsMid: any): any;
- /**
- *
- * @param locale
- */
- normalizeLocale(locale: any): any;
- }
- namespace i18n {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/i18n.cache.html
- *
- *
- */
- interface cache {
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/json.html
- *
- * Functions to parse and serialize JSON
- *
- */
- interface json {
- /**
- * Parses a JSON string to return a JavaScript object.
- * This function follows native JSON API
- * Throws for invalid JSON strings. This delegates to eval() if native JSON
- * support is not available. By default this will evaluate any valid JS expression.
- * With the strict parameter set to true, the parser will ensure that only
- * valid JSON strings are parsed (otherwise throwing an error). Without the strict
- * parameter, the content passed to this method must come
- * from a trusted source.
- *
- * @param str a string literal of a JSON item, for instance:'{ "foo": [ "bar", 1, { "baz": "thud" } ] }'
- * @param strict When set to true, this will ensure that only valid, secure JSON is ever parsed.Make sure this is set to true for untrusted content. Note that on browsers/engineswithout native JSON support, setting this to true will run slower.
- */
- parse(str: any, strict: any): void;
- /**
- * Returns a JSON serialization of an object.
- * Returns a JSON serialization of an object.
- * This function follows native JSON API
- * Note that this doesn't check for infinite recursion, so don't do that!
- *
- * @param value A value to be serialized.
- * @param replacer A replacer function that is called for each value and can return a replacement
- * @param spacer A spacer string to be used for pretty printing of JSON
- */
- stringify(value: any, replacer: any, spacer: any): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/loadInit.html
- *
- *
- */
- interface loadInit {
- /**
- *
- */
- dynamic: number;
- /**
- *
- */
- load: Object;
- /**
- *
- * @param id
- */
- normalize(id: any): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/keys.html
- *
- * Definitions for common key values. Client code should test keyCode against these named constants,
- * as the actual codes can vary by browser.
- *
- */
- interface keys {
- /**
- *
- */
- ALT: number;
- /**
- *
- */
- BACKSPACE: number;
- /**
- *
- */
- CAPS_LOCK: number;
- /**
- *
- */
- CLEAR: number;
- /**
- *
- */
- copyKey: number;
- /**
- *
- */
- CTRL: number;
- /**
- *
- */
- DELETE: number;
- /**
- *
- */
- DOWN_ARROW: number;
- /**
- *
- */
- DOWN_DPAD: number;
- /**
- *
- */
- END: number;
- /**
- *
- */
- ENTER: number;
- /**
- *
- */
- ESCAPE: number;
- /**
- *
- */
- F1: number;
- /**
- *
- */
- F10: number;
- /**
- *
- */
- F11: number;
- /**
- *
- */
- F12: number;
- /**
- *
- */
- F13: number;
- /**
- *
- */
- F14: number;
- /**
- *
- */
- F15: number;
- /**
- *
- */
- F2: number;
- /**
- *
- */
- F3: number;
- /**
- *
- */
- F4: number;
- /**
- *
- */
- F5: number;
- /**
- *
- */
- F6: number;
- /**
- *
- */
- F7: number;
- /**
- *
- */
- F8: number;
- /**
- *
- */
- F9: number;
- /**
- *
- */
- HELP: number;
- /**
- *
- */
- HOME: number;
- /**
- *
- */
- INSERT: number;
- /**
- *
- */
- LEFT_ARROW: number;
- /**
- *
- */
- LEFT_DPAD: number;
- /**
- *
- */
- LEFT_WINDOW: number;
- /**
- *
- */
- META: number;
- /**
- *
- */
- NUM_LOCK: number;
- /**
- *
- */
- NUMPAD_0: number;
- /**
- *
- */
- NUMPAD_1: number;
- /**
- *
- */
- NUMPAD_2: number;
- /**
- *
- */
- NUMPAD_3: number;
- /**
- *
- */
- NUMPAD_4: number;
- /**
- *
- */
- NUMPAD_5: number;
- /**
- *
- */
- NUMPAD_6: number;
- /**
- *
- */
- NUMPAD_7: number;
- /**
- *
- */
- NUMPAD_8: number;
- /**
- *
- */
- NUMPAD_9: number;
- /**
- *
- */
- NUMPAD_DIVIDE: number;
- /**
- *
- */
- NUMPAD_ENTER: number;
- /**
- *
- */
- NUMPAD_MINUS: number;
- /**
- *
- */
- NUMPAD_MULTIPLY: number;
- /**
- *
- */
- NUMPAD_PERIOD: number;
- /**
- *
- */
- NUMPAD_PLUS: number;
- /**
- *
- */
- PAGE_DOWN: number;
- /**
- *
- */
- PAGE_UP: number;
- /**
- *
- */
- PAUSE: number;
- /**
- *
- */
- RIGHT_ARROW: number;
- /**
- *
- */
- RIGHT_DPAD: number;
- /**
- *
- */
- RIGHT_WINDOW: number;
- /**
- *
- */
- SCROLL_LOCK: number;
- /**
- *
- */
- SELECT: number;
- /**
- *
- */
- SHIFT: number;
- /**
- *
- */
- SPACE: number;
- /**
- *
- */
- TAB: number;
- /**
- *
- */
- UP_ARROW: number;
- /**
- *
- */
- UP_DPAD: number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/mouse.html
- *
- * This module provide mouse event handling utility functions and exports
- * mouseenter and mouseleave event emulation.
- *
- */
- interface mouse {
- /**
- * This is an extension event for the mouseenter that IE provides, emulating the
- * behavior on other browsers.
- *
- */
- enter: Object;
- /**
- * This is an extension event for the mouseleave that IE provides, emulating the
- * behavior on other browsers.
- *
- */
- leave: Object;
- /**
- * Test an event object (from a mousedown event) to see if the left button was pressed.
- *
- */
- isLeft(): void;
- /**
- * Test an event object (from a mousedown event) to see if the middle button was pressed.
- *
- */
- isMiddle(): void;
- /**
- * Test an event object (from a mousedown event) to see if the right button was pressed.
- *
- */
- isRight(): void;
- /**
- * This is an extension event for the mousewheel that non-Mozilla browsers provide,
- * emulating the behavior on Mozilla based browsers.
- *
- * @param node
- * @param listener
- */
- wheel(node: any, listener: any): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/node.html
- *
- * This AMD plugin module allows native Node.js modules to be loaded by AMD modules using the Dojo
- * loader. Note that this plugin will not work with AMD loaders other than the Dojo loader.
- *
- */
- interface node {
- /**
- * Standard AMD plugin interface. See https://github.com/amdjs/amdjs-api/wiki/Loader-Plugins
- * for information.
- *
- * @param id
- * @param require
- * @param load
- */
- load(id: String, require: Function, load: Function): void;
- /**
- * Produces a normalized id to be used by node. Relative ids are resolved relative to the requesting
- * module's location in the file system and will return an id with path separators appropriate for the
- * local file system.
- *
- * @param id
- * @param normalize
- */
- normalize(id: String, normalize: Function): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/number.html
- *
- * localized formatting and parsing routines for Number
- *
- */
- interface number_ {
- /**
- * Format a Number as a String, using locale-specific settings
- * Create a string from a Number using a known localized pattern.
- * Formatting patterns appropriate to the locale are chosen from the
- * Common Locale Data Repository as well as the appropriate symbols and
- * delimiters.
- * If value is Infinity, -Infinity, or is not a valid JavaScript number, return null.
- *
- * @param value the number to be formatted
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization. Literal characters in patterns are not supported.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.places (Number, optional): fixed number of decimal places to show. This overrides anyinformation in the provided pattern.round (Number, optional): 5 rounds to nearest .5; 0 rounds to nearest whole (default). -1means do not round.locale (String, optional): override the locale used to determine formatting rulesfractional (Boolean, optional): If false, show no decimal places, overriding places and pattern settings.
- */
- format(value: number, options?: Object): any;
- /**
- * Convert a properly formatted string to a primitive Number, using
- * locale-specific settings.
- * Create a Number from a string using a known localized pattern.
- * Formatting patterns are chosen appropriate to the locale
- * and follow the syntax described by
- * unicode.org TR35
- * Note that literal characters in patterns are not supported.
- *
- * @param expression A string representation of a Number
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization. Literal characters in patterns are not supported.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separatorsfractional (Boolean|Array, optional): Whether to include the fractional portion, where the number of decimal places are implied by patternor explicit 'places' parameter. The value [true,false] makes the fractional portion optional.
- */
- parse(expression: String, options?: Object): number;
- /**
- * Builds the regular needed to parse a number
- * Returns regular expression with positive and negative match, group
- * and decimal separators
- *
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separatorsplaces (Number|String, optional): number of decimal places to accept: Infinity, a positive number, ora range "n,m". Defined by pattern or Infinity if pattern not provided.
- */
- regexp(options: Object): any;
- /**
- * Rounds to the nearest value with the given number of decimal places, away from zero
- * Rounds to the nearest value with the given number of decimal places, away from zero if equal.
- * Similar to Number.toFixed(), but compensates for browser quirks. Rounding can be done by
- * fractional increments also, such as the nearest quarter.
- * NOTE: Subject to floating point errors. See dojox/math/round for experimental workaround.
- *
- * @param value The number to round
- * @param places OptionalThe number of decimal places where rounding takes place. Defaults to 0 for whole rounding.Must be non-negative.
- * @param increment OptionalRounds next place to nearest value of increment/10. 10 by default.
- */
- round(value: number, places?: number, increment?: number): number;
- }
- namespace number_ {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/number.__FormatAbsoluteOptions.html
- *
- *
- */
- class __FormatAbsoluteOptions {
- constructor();
- /**
- * the decimal separator
- *
- */
- "decimal": string;
- /**
- * the group separator
- *
- */
- "group": string;
- /**
- * number of decimal places. the range "n,m" will format to m places.
- *
- */
- "places": number;
- /**
- * 5 rounds to nearest .5; 0 rounds to nearest whole (default). -1
- * means don't round.
- *
- */
- "round": number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/number.__IntegerRegexpFlags.html
- *
- *
- */
- class __IntegerRegexpFlags {
- constructor();
- /**
- * group size between separators
- *
- */
- "groupSize": number;
- /**
- * second grouping, where separators 2..n have a different interval than the first separator (for India)
- *
- */
- "groupSize2": number;
- /**
- * The character used as the thousands separator. Default is no
- * separator. For more than one symbol use an array, e.g. [",", ""],
- * makes ',' optional.
- *
- */
- "separator": string;
- /**
- * The leading plus-or-minus sign. Can be true, false, or [true,false].
- * Default is [true, false], (i.e. will match if it is signed
- * or unsigned).
- *
- */
- "signed": boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/number.__FormatOptions.html
- *
- *
- */
- class __FormatOptions {
- constructor();
- /**
- * If false, show no decimal places, overriding places and pattern settings.
- *
- */
- "fractional": boolean;
- /**
- * override the locale used to determine formatting rules
- *
- */
- "locale": string;
- /**
- * override formatting pattern
- * with this string. Default value is based on locale. Overriding this property will defeat
- * localization. Literal characters in patterns are not supported.
- *
- */
- "pattern": string;
- /**
- * fixed number of decimal places to show. This overrides any
- * information in the provided pattern.
- *
- */
- "places": number;
- /**
- * 5 rounds to nearest .5; 0 rounds to nearest whole (default). -1
- * means do not round.
- *
- */
- "round": number;
- /**
- * choose a format type based on the locale from the following:
- * decimal, scientific (not yet supported), percent, currency. decimal by default.
- *
- */
- "type": string;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/number.__RealNumberRegexpFlags.html
- *
- *
- */
- class __RealNumberRegexpFlags {
- constructor();
- /**
- * A string for the character used as the decimal point. Default
- * is ".".
- *
- */
- "decimal": string;
- /**
- * The leading plus-or-minus sign on the exponent. Can be true,
- * false, or [true, false]. Default is [true, false], (i.e. will
- * match if it is signed or unsigned). flags in regexp.integer can be
- * applied.
- *
- */
- "eSigned": boolean;
- /**
- * Express in exponential notation. Can be true, false, or [true,
- * false]. Default is [true, false], (i.e. will match if the
- * exponential part is present are not).
- *
- */
- "exponent": boolean;
- /**
- * Whether decimal places are used. Can be true, false, or [true,
- * false]. Default is [true, false] which means optional.
- *
- */
- "fractional": boolean;
- /**
- * The integer number of decimal places or a range given as "n,m". If
- * not given, the decimal part is optional and the number of places is
- * unlimited.
- *
- */
- "places": number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/number.__ParseOptions.html
- *
- *
- */
- class __ParseOptions {
- constructor();
- /**
- * Whether to include the fractional portion, where the number of decimal places are implied by pattern
- * or explicit 'places' parameter. The value [true,false] makes the fractional portion optional.
- *
- */
- "fractional": boolean;
- /**
- * override the locale used to determine formatting rules
- *
- */
- "locale": string;
- /**
- * override formatting pattern
- * with this string. Default value is based on locale. Overriding this property will defeat
- * localization. Literal characters in patterns are not supported.
- *
- */
- "pattern": string;
- /**
- * strict parsing, false by default. Strict parsing requires input as produced by the format() method.
- * Non-strict is more permissive, e.g. flexible on white space, omitting thousands separators
- *
- */
- "strict": boolean;
- /**
- * choose a format type based on the locale from the following:
- * decimal, scientific (not yet supported), percent, currency. decimal by default.
- *
- */
- "type": string;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/number.__RegexpOptions.html
- *
- *
- */
- class __RegexpOptions {
- constructor();
- /**
- * override the locale used to determine formatting rules
- *
- */
- "locale": string;
- /**
- * override formatting pattern
- * with this string. Default value is based on locale. Overriding this property will defeat
- * localization.
- *
- */
- "pattern": string;
- /**
- * number of decimal places to accept: Infinity, a positive number, or
- * a range "n,m". Defined by pattern or Infinity if pattern not provided.
- *
- */
- "places": number;
- /**
- * strict parsing, false by default. Strict parsing requires input as produced by the format() method.
- * Non-strict is more permissive, e.g. flexible on white space, omitting thousands separators
- *
- */
- "strict": boolean;
- /**
- * choose a format type based on the locale from the following:
- * decimal, scientific (not yet supported), percent, currency. decimal by default.
- *
- */
- "type": string;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/parser.html
- *
- * The Dom/Widget parsing package
- *
- */
- interface parser {
- /**
- * Calls new ctor(params, node), where params is the hash of parameters specified on the node,
- * excluding data-dojo-type and data-dojo-mixins. Does not call startup().
- *
- * @param ctor Widget constructor.
- * @param node This node will be replaced/attached to by the widget. It also specifies the arguments to pass to ctor.
- * @param mixin OptionalAttributes in this object will be passed as parameters to ctor,overriding attributes specified on the node.
- * @param options OptionalAn options object used to hold kwArgs for instantiation. See parse.options argument for details.
- * @param scripts OptionalArray of <script type="dojo//"> DOMNodes. If not specified, will search for <script> tags inside node.
- * @param inherited OptionalSettings from dir=rtl or lang=... on a node above this node. Overrides options.inherited.
- */
- construct(ctor: Function, node: HTMLElement, mixin?: Object, options?: Object, scripts?: HTMLElement[], inherited?: Object): any;
- /**
- * Takes array of nodes, and turns them into class instances and
- * potentially calls a startup method to allow them to connect with
- * any children.
- *
- * @param nodes Array of DOM nodes
- * @param mixin OptionalAn object that will be mixed in with each node in the array.Values in the mixin will override values in the node, if theyexist.
- * @param options OptionalAn object used to hold kwArgs for instantiation.See parse.options argument for details.
- */
- instantiate(nodes: any[], mixin?: Object, options?: Object): any;
- /**
- * Scan the DOM for class instances, and instantiate them.
- * Search specified node (or root node) recursively for class instances,
- * and instantiate them. Searches for either data-dojo-type="Class" or
- * dojoType="Class" where "Class" is a a fully qualified class name,
- * like dijit/form/Button
- *
- * Using data-dojo-type:
- * Attributes using can be mixed into the parameters used to instantiate the
- * Class by using a data-dojo-props attribute on the node being converted.
- * data-dojo-props should be a string attribute to be converted from JSON.
- *
- * Using dojoType:
- * Attributes are read from the original domNode and converted to appropriate
- * types by looking up the Class prototype values. This is the default behavior
- * from Dojo 1.0 to Dojo 1.5. dojoType support is deprecated, and will
- * go away in Dojo 2.0.
- *
- * @param rootNode OptionalA default starting root node from which to start the parsing. Can beomitted, defaulting to the entire document. If omitted, the optionsobject can be passed in this place. If the options object has arootNode member, that is used.
- * @param options OptionalA hash of options.noStart: Boolean?: when set will prevent the parser from calling .startup() when locating the nodes.rootNode: DomNode?: identical to the function's rootNode argument, though allowed to be passed in via this `options object.template: Boolean: If true, ignores ContentPane's stopParser flag and parses contents inside of a ContentPane inside of a template. This allows dojoAttachPoint on widgets/nodes nested inside the ContentPane to work.inherited: Object: Hash possibly containing dir and lang settings to be applied to parsed widgets, unless there's another setting on a sub-node that overridesscope: String: Root for attribute names to search for. If scopeName is dojo, will search for data-dojo-type (or dojoType). For backwards compatibility reasons defaults to dojo._scopeName (which is "dojo" except when multi-version support is used, when it will be something like dojo16, dojo20, etc.)propsThis: Object: If specified, "this" referenced from data-dojo-props will refer to propsThis. Intended for use from the widgets-in-template feature of dijit._WidgetsInTemplateMixincontextRequire: Function: If specified, this require is utilised for looking resolving modules instead of the dojo/parser context require(). Intended for use from the widgets-in-template feature of dijit._WidgetsInTemplateMixin.
- */
- parse(rootNode?: HTMLElement, options?: Object): any;
- /**
- * Scan a DOM tree and return an array of objects representing the DOMNodes
- * that need to be turned into widgets.
- * Search specified node (or document root node) recursively for class instances
- * and return an array of objects that represent potential widgets to be
- * instantiated. Searches for either data-dojo-type="MID" or dojoType="MID" where
- * "MID" is a module ID like "dijit/form/Button" or a fully qualified Class name
- * like "dijit/form/Button". If the MID is not currently available, scan will
- * attempt to require() in the module.
- *
- * See parser.parse() for details of markup.
- *
- * @param root OptionalA default starting root node from which to start the parsing. Can beomitted, defaulting to the entire document. If omitted, the optionsobject can be passed in this place. If the options object has arootNode member, that is used.
- * @param options a kwArgs options object, see parse() for details
- */
- scan(root?: HTMLElement, options?: Object): dojo.promise.Promise<any>;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/regexp.html
- *
- * Regular expressions and Builder resources
- *
- */
- interface regexp {
- /**
- * Builds a regular expression that groups subexpressions
- * A utility function used by some of the RE generators. The
- * subexpressions are constructed by the function, re, in the second
- * parameter. re builds one subexpression for each elem in the array
- * a, in the first parameter. Returns a string for a regular
- * expression that groups all the subexpressions.
- *
- * @param arr A single value or an array of values.
- * @param re A function. Takes one parameter and converts it to a regularexpression.
- * @param nonCapture OptionalIf true, uses non-capturing match, otherwise matches are retainedby regular expression. Defaults to false
- */
- buildGroupRE(arr: Object, re: Function, nonCapture?: boolean): any;
- /**
- * Builds a regular expression that groups subexpressions
- * A utility function used by some of the RE generators. The
- * subexpressions are constructed by the function, re, in the second
- * parameter. re builds one subexpression for each elem in the array
- * a, in the first parameter. Returns a string for a regular
- * expression that groups all the subexpressions.
- *
- * @param arr A single value or an array of values.
- * @param re A function. Takes one parameter and converts it to a regularexpression.
- * @param nonCapture OptionalIf true, uses non-capturing match, otherwise matches are retainedby regular expression. Defaults to false
- */
- buildGroupRE(arr: any[], re: Function, nonCapture?: boolean): any;
- /**
- * Adds escape sequences for special characters in regular expressions
- *
- * @param str
- * @param except Optionala String with special characters to be left unescaped
- */
- escapeString(str: String, except?: String): any;
- /**
- * adds group match to expression
- *
- * @param expression
- * @param nonCapture OptionalIf true, uses non-capturing match, otherwise matches are retainedby regular expression.
- */
- group(expression: String, nonCapture?: boolean): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/require.html
- *
- *
- */
- interface require {
- /**
- *
- */
- dynamic: number;
- /**
- *
- */
- load: Object;
- /**
- *
- * @param id
- */
- normalize(id: any): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/robotx.html
- *
- *
- */
- interface robotx {
- /**
- *
- */
- doc: Object;
- /**
- *
- */
- mouseWheelSize: number;
- /**
- *
- */
- window: Object;
- /**
- * Opens the application at the specified URL for testing, redirecting dojo to point to the application
- * environment instead of the test environment.
- *
- * @param url URL to open. Any of the test's dojo.doc calls (e.g. dojo.byId()), and any dijit.registry calls(e.g. dijit.byId()) will point to elements and widgets inside this application.
- */
- initRobot(url: String): void;
- /**
- * Holds down a single key, like SHIFT or 'a'.
- * Holds down a single key, like SHIFT or 'a'.
- *
- * @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to hold downWarning: holding down a shifted key, like 'A', can have unpredictable results.
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- */
- keyDown(charOrCode: number, delay?: number): void;
- /**
- * Types a key combination, like SHIFT-TAB.
- * Types a key combination, like SHIFT-TAB.
- *
- * @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to press
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param modifiers JSON object that represents all of the modifier keys being pressed.It takes the following Boolean attributes:shiftaltctrlmeta
- * @param asynchronous If true, the delay happens asynchronously and immediately, outside of the browser's JavaScript thread and any previous calls.This is useful for interacting with the browser's modal dialogs.
- */
- keyPress(charOrCode: number, delay: number, modifiers: Object, asynchronous: boolean): void;
- /**
- * Releases a single key, like SHIFT or 'a'.
- * Releases a single key, like SHIFT or 'a'.
- *
- * @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to releaseWarning: releasing a shifted key, like 'A', can have unpredictable results.
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- */
- keyUp(charOrCode: number, delay?: number): void;
- /**
- *
- */
- killRobot(): void;
- /**
- * Convenience function to do a press/release.
- * See robot.mousePress for more info.
- * Convenience function to do a press/release.
- * See robot.mousePress for more info.
- *
- * @param buttons
- * @param delay Optional
- */
- mouseClick(buttons: Object, delay?: number): void;
- /**
- * Moves the mouse to the specified x,y offset relative to the viewport.
- *
- * @param x x offset relative to the viewport, in pixels, to move the mouse.
- * @param y y offset relative to the viewport, in pixels, to move the mouse.
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration OptionalApproximate time Robot will spend moving the mouseThe default is 100ms. This also affects how many mousemove events willbe generated, which is the log of the duration.
- * @param absolute Boolean indicating whether the x and y values are absolute coordinates.If false, then mouseMove expects that the x,y will be relative to the window. (clientX/Y)If true, then mouseMove expects that the x,y will be absolute. (pageX/Y)
- */
- mouseMove(x: number, y: number, delay: number, duration: number, absolute: boolean): void;
- /**
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * If you do not specify an offset, mouseMove will default to move to the middle of the node.
- * Example: to move the mouse over a ComboBox's down arrow node, call doh.mouseMoveAt(dijit.byId('setvaluetest').downArrowNode);
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left:true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration Approximate time Robot will spend moving the mouseThe default is 100ms.
- * @param offsetX x offset relative to the node, in pixels, to move the mouse. The default is half the node's width.
- * @param offsetY y offset relative to the node, in pixels, to move the mouse. The default is half the node's height.
- */
- mouseMoveAt(node: String, delay: number, duration: number, offsetX: number, offsetY: number): void;
- /**
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * If you do not specify an offset, mouseMove will default to move to the middle of the node.
- * Example: to move the mouse over a ComboBox's down arrow node, call doh.mouseMoveAt(dijit.byId('setvaluetest').downArrowNode);
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left:true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration Approximate time Robot will spend moving the mouseThe default is 100ms.
- * @param offsetX x offset relative to the node, in pixels, to move the mouse. The default is half the node's width.
- * @param offsetY y offset relative to the node, in pixels, to move the mouse. The default is half the node's height.
- */
- mouseMoveAt(node: HTMLElement, delay: number, duration: number, offsetX: number, offsetY: number): void;
- /**
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * If you do not specify an offset, mouseMove will default to move to the middle of the node.
- * Example: to move the mouse over a ComboBox's down arrow node, call doh.mouseMoveAt(dijit.byId('setvaluetest').downArrowNode);
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left:true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration Approximate time Robot will spend moving the mouseThe default is 100ms.
- * @param offsetX x offset relative to the node, in pixels, to move the mouse. The default is half the node's width.
- * @param offsetY y offset relative to the node, in pixels, to move the mouse. The default is half the node's height.
- */
- mouseMoveAt(node: Function, delay: number, duration: number, offsetX: number, offsetY: number): void;
- /**
- * Move the mouse from the current position to the specified point.
- * Delays reading contents point until queued command starts running.
- * See mouseMove() for details.
- *
- * @param point x, y position relative to viewport, or if absolute == true, to document
- * @param delay Optional
- * @param duration Optional
- * @param absolute
- */
- mouseMoveTo(point: Object, delay: number, duration: number, absolute: boolean): void;
- /**
- * Presses mouse buttons.
- * Presses the mouse buttons you pass as true.
- * Example: to press the left mouse button, pass {left: true}.
- * Mouse buttons you don't specify keep their previous pressed state.
- *
- * @param buttons JSON object that represents all of the mouse buttons being pressed.It takes the following Boolean attributes:leftmiddleright
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- */
- mousePress(buttons: Object, delay?: number): void;
- /**
- * Releases mouse buttons.
- * Releases the mouse buttons you pass as true.
- * Example: to release the left mouse button, pass {left: true}.
- * Mouse buttons you don't specify keep their previous pressed state.
- * See robot.mousePress for more info.
- *
- * @param buttons
- * @param delay Optional
- */
- mouseRelease(buttons: Object, delay?: number): void;
- /**
- * Spins the mouse wheel.
- * Spins the wheel wheelAmt "notches."
- * Negative wheelAmt scrolls up/away from the user.
- * Positive wheelAmt scrolls down/toward the user.
- * Note: this will all happen in one event.
- * Warning: the size of one mouse wheel notch is an OS setting.
- * You can access this size from robot.mouseWheelSize
- *
- * @param wheelAmt Number of notches to spin the wheel.Negative wheelAmt scrolls up/away from the user.Positive wheelAmt scrolls down/toward the user.
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms: robot.mouseClick({left: true}, 100) // first call; wait 100ms robot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration OptionalApproximate time Robot will spend moving the mouseBy default, the Robot will wheel the mouse as fast as possible.
- */
- mouseWheel(wheelAmt: number, delay?: number, duration?: number): void;
- /**
- * Scroll the passed node into view, if it is not.
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.
- */
- scrollIntoView(node: String, delay: number): void;
- /**
- * Scroll the passed node into view, if it is not.
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.
- */
- scrollIntoView(node: HTMLElement, delay: number): void;
- /**
- * Scroll the passed node into view, if it is not.
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.
- */
- scrollIntoView(node: Function, delay: number): void;
- /**
- * Defer an action by adding it to the robot's incrementally delayed queue of actions to execute.
- *
- * @param f A function containing actions you want to defer. It can return a Promiseto delay further actions.
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration OptionalDelay to wait after firing.
- */
- sequence(f: Function, delay?: number, duration?: number): void;
- /**
- * Set clipboard content.
- * Set data as clipboard content, overriding anything already there. The
- * data will be put to the clipboard using the given format.
- *
- * @param data New clipboard content to set
- * @param format OptionalSet this to "text/html" to put richtext to the clipboard.Otherwise, data is treated as plaintext. By default, plaintextis used.
- */
- setClipboard(data: String, format?: String): void;
- /**
- *
- */
- startRobot(): any;
- /**
- * Types a string of characters in order, or types a dojo.keys.* constant.
- * Types a string of characters in order, or types a dojo.keys.* constant.
- *
- * @param chars String of characters to type, or a dojo.keys.* constant
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration OptionalTime, in milliseconds, to spend pressing all of the keys.The default is (string length)*50 ms.
- */
- typeKeys(chars: String, delay?: number, duration?: number): void;
- /**
- * Types a string of characters in order, or types a dojo.keys.* constant.
- * Types a string of characters in order, or types a dojo.keys.* constant.
- *
- * @param chars String of characters to type, or a dojo.keys.* constant
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration OptionalTime, in milliseconds, to spend pressing all of the keys.The default is (string length)*50 ms.
- */
- typeKeys(chars: number, delay?: number, duration?: number): void;
- /**
- * Notifies DOH that the doh.robot is about to make a page change in the application it is driving,
- * returning a doh.Deferred object the user should return in their runTest function as part of a DOH test.
- *
- * @param submitActions The doh.robot will execute the actions the test passes into the submitActions argument (like clicking the submit button),expecting these actions to create a page change (like a form submit).After these actions execute and the resulting page loads, the next test will start.
- */
- waitForPageToLoad(submitActions: Function): any;
- }
- namespace robotx {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/robotx._runsemaphore.html
- *
- *
- */
- interface _runsemaphore {
- /**
- *
- */
- lock: any[];
- /**
- *
- */
- unlock(): any;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/robot.html
- *
- *
- */
- interface robot {
- /**
- *
- */
- doc: Object;
- /**
- *
- */
- mouseWheelSize: number;
- /**
- *
- */
- window: Object;
- /**
- * Opens the application at the specified URL for testing, redirecting dojo to point to the application
- * environment instead of the test environment.
- *
- * @param url URL to open. Any of the test's dojo.doc calls (e.g. dojo.byId()), and any dijit.registry calls(e.g. dijit.byId()) will point to elements and widgets inside this application.
- */
- initRobot(url: String): void;
- /**
- * Holds down a single key, like SHIFT or 'a'.
- * Holds down a single key, like SHIFT or 'a'.
- *
- * @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to hold downWarning: holding down a shifted key, like 'A', can have unpredictable results.
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- */
- keyDown(charOrCode: number, delay?: number): void;
- /**
- * Types a key combination, like SHIFT-TAB.
- * Types a key combination, like SHIFT-TAB.
- *
- * @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to press
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param modifiers JSON object that represents all of the modifier keys being pressed.It takes the following Boolean attributes:shiftaltctrlmeta
- * @param asynchronous If true, the delay happens asynchronously and immediately, outside of the browser's JavaScript thread and any previous calls.This is useful for interacting with the browser's modal dialogs.
- */
- keyPress(charOrCode: number, delay: number, modifiers: Object, asynchronous: boolean): void;
- /**
- * Releases a single key, like SHIFT or 'a'.
- * Releases a single key, like SHIFT or 'a'.
- *
- * @param charOrCode char/JS keyCode/dojo.keys.* constant for the key you want to releaseWarning: releasing a shifted key, like 'A', can have unpredictable results.
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- */
- keyUp(charOrCode: number, delay?: number): void;
- /**
- *
- */
- killRobot(): void;
- /**
- * Convenience function to do a press/release.
- * See robot.mousePress for more info.
- * Convenience function to do a press/release.
- * See robot.mousePress for more info.
- *
- * @param buttons
- * @param delay Optional
- */
- mouseClick(buttons: Object, delay?: number): void;
- /**
- * Moves the mouse to the specified x,y offset relative to the viewport.
- *
- * @param x x offset relative to the viewport, in pixels, to move the mouse.
- * @param y y offset relative to the viewport, in pixels, to move the mouse.
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration OptionalApproximate time Robot will spend moving the mouseThe default is 100ms. This also affects how many mousemove events willbe generated, which is the log of the duration.
- * @param absolute Boolean indicating whether the x and y values are absolute coordinates.If false, then mouseMove expects that the x,y will be relative to the window. (clientX/Y)If true, then mouseMove expects that the x,y will be absolute. (pageX/Y)
- */
- mouseMove(x: number, y: number, delay: number, duration: number, absolute: boolean): void;
- /**
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * If you do not specify an offset, mouseMove will default to move to the middle of the node.
- * Example: to move the mouse over a ComboBox's down arrow node, call doh.mouseMoveAt(dijit.byId('setvaluetest').downArrowNode);
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left:true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration Approximate time Robot will spend moving the mouseThe default is 100ms.
- * @param offsetX x offset relative to the node, in pixels, to move the mouse. The default is half the node's width.
- * @param offsetY y offset relative to the node, in pixels, to move the mouse. The default is half the node's height.
- */
- mouseMoveAt(node: String, delay: number, duration: number, offsetX: number, offsetY: number): void;
- /**
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * If you do not specify an offset, mouseMove will default to move to the middle of the node.
- * Example: to move the mouse over a ComboBox's down arrow node, call doh.mouseMoveAt(dijit.byId('setvaluetest').downArrowNode);
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left:true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration Approximate time Robot will spend moving the mouseThe default is 100ms.
- * @param offsetX x offset relative to the node, in pixels, to move the mouse. The default is half the node's width.
- * @param offsetY y offset relative to the node, in pixels, to move the mouse. The default is half the node's height.
- */
- mouseMoveAt(node: HTMLElement, delay: number, duration: number, offsetX: number, offsetY: number): void;
- /**
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * Moves the mouse over the specified node at the specified relative x,y offset.
- * If you do not specify an offset, mouseMove will default to move to the middle of the node.
- * Example: to move the mouse over a ComboBox's down arrow node, call doh.mouseMoveAt(dijit.byId('setvaluetest').downArrowNode);
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left:true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration Approximate time Robot will spend moving the mouseThe default is 100ms.
- * @param offsetX x offset relative to the node, in pixels, to move the mouse. The default is half the node's width.
- * @param offsetY y offset relative to the node, in pixels, to move the mouse. The default is half the node's height.
- */
- mouseMoveAt(node: Function, delay: number, duration: number, offsetX: number, offsetY: number): void;
- /**
- * Move the mouse from the current position to the specified point.
- * Delays reading contents point until queued command starts running.
- * See mouseMove() for details.
- *
- * @param point x, y position relative to viewport, or if absolute == true, to document
- * @param delay Optional
- * @param duration Optional
- * @param absolute
- */
- mouseMoveTo(point: Object, delay: number, duration: number, absolute: boolean): void;
- /**
- * Presses mouse buttons.
- * Presses the mouse buttons you pass as true.
- * Example: to press the left mouse button, pass {left: true}.
- * Mouse buttons you don't specify keep their previous pressed state.
- *
- * @param buttons JSON object that represents all of the mouse buttons being pressed.It takes the following Boolean attributes:leftmiddleright
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- */
- mousePress(buttons: Object, delay?: number): void;
- /**
- * Releases mouse buttons.
- * Releases the mouse buttons you pass as true.
- * Example: to release the left mouse button, pass {left: true}.
- * Mouse buttons you don't specify keep their previous pressed state.
- * See robot.mousePress for more info.
- *
- * @param buttons
- * @param delay Optional
- */
- mouseRelease(buttons: Object, delay?: number): void;
- /**
- * Spins the mouse wheel.
- * Spins the wheel wheelAmt "notches."
- * Negative wheelAmt scrolls up/away from the user.
- * Positive wheelAmt scrolls down/toward the user.
- * Note: this will all happen in one event.
- * Warning: the size of one mouse wheel notch is an OS setting.
- * You can access this size from robot.mouseWheelSize
- *
- * @param wheelAmt Number of notches to spin the wheel.Negative wheelAmt scrolls up/away from the user.Positive wheelAmt scrolls down/toward the user.
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms: robot.mouseClick({left: true}, 100) // first call; wait 100ms robot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration OptionalApproximate time Robot will spend moving the mouseBy default, the Robot will wheel the mouse as fast as possible.
- */
- mouseWheel(wheelAmt: number, delay: number, duration: number): void;
- /**
- * Scroll the passed node into view, if it is not.
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.
- */
- scrollIntoView(node: String, delay: number): void;
- /**
- * Scroll the passed node into view, if it is not.
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.
- */
- scrollIntoView(node: HTMLElement, delay: number): void;
- /**
- * Scroll the passed node into view, if it is not.
- *
- * @param node The id of the node, or the node itself, to move the mouse to.If you pass an id or a function that returns a node, the node will not be evaluated until the movement executes.This is useful if you need to move the mouse to an node that is not yet present.
- * @param delay Delay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.
- */
- scrollIntoView(node: Function, delay: number): void;
- /**
- * Defer an action by adding it to the robot's incrementally delayed queue of actions to execute.
- *
- * @param f A function containing actions you want to defer. It can return a Promiseto delay further actions.
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration OptionalDelay to wait after firing.
- */
- sequence(f: Function, delay?: number, duration?: number): void;
- /**
- * Set clipboard content.
- * Set data as clipboard content, overriding anything already there. The
- * data will be put to the clipboard using the given format.
- *
- * @param data New clipboard content to set
- * @param format OptionalSet this to "text/html" to put richtext to the clipboard.Otherwise, data is treated as plaintext. By default, plaintextis used.
- */
- setClipboard(data: String, format?: String): void;
- /**
- *
- */
- startRobot(): any;
- /**
- * Types a string of characters in order, or types a dojo.keys.* constant.
- * Types a string of characters in order, or types a dojo.keys.* constant.
- *
- * @param chars String of characters to type, or a dojo.keys.* constant
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration OptionalTime, in milliseconds, to spend pressing all of the keys.The default is (string length)*50 ms.
- */
- typeKeys(chars: String, delay?: number, duration?: number): void;
- /**
- * Types a string of characters in order, or types a dojo.keys.* constant.
- * Types a string of characters in order, or types a dojo.keys.* constant.
- *
- * @param chars String of characters to type, or a dojo.keys.* constant
- * @param delay OptionalDelay, in milliseconds, to wait before firing.The delay is a delta with respect to the previous automation call.For example, the following code ends after 600ms:robot.mouseClick({left: true}, 100) // first call; wait 100msrobot.typeKeys("dij", 500) // 500ms AFTER previous call; 600ms in all
- * @param duration OptionalTime, in milliseconds, to spend pressing all of the keys.The default is (string length)*50 ms.
- */
- typeKeys(chars: number, delay?: number, duration?: number): void;
- /**
- * Notifies DOH that the doh.robot is about to make a page change in the application it is driving,
- * returning a doh.Deferred object the user should return in their runTest function as part of a DOH test.
- *
- * @param submitActions The doh.robot will execute the actions the test passes into the submitActions argument (like clicking the submit button),expecting these actions to create a page change (like a form submit).After these actions execute and the resulting page loads, the next test will start.
- */
- waitForPageToLoad(submitActions: Function): any;
- }
- namespace robot {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/robot._runsemaphore.html
- *
- *
- */
- interface _runsemaphore {
- /**
- *
- */
- lock: any[];
- /**
- *
- */
- unlock(): any;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.html
- *
- * This module is the foundational module of the dojo boot sequence; it defines the dojo object.
- *
- */
- interface main {
- /**
- * Browser history management resources
- *
- */
- back: Object;
- /**
- *
- */
- baseUrl: string;
- /**
- *
- */
- behavior: Object;
- /**
- *
- */
- cldr: Object;
- /**
- *
- */
- colors: Object;
- /**
- * This module defines the user configuration during bootstrap.
- *
- */
- config: Object;
- /**
- *
- */
- connectPublisher: Object;
- /**
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls.
- *
- */
- contentHandlers: Object;
- /**
- * localized formatting and parsing routines for currencies
- *
- */
- currency: Object;
- /**
- *
- */
- data: Object;
- /**
- *
- */
- date: Object;
- /**
- *
- */
- dijit: Object;
- /**
- *
- */
- dnd: Object;
- /**
- * Alias for the current document. 'doc' can be modified
- * for temporary context shifting. See also withDoc().
- *
- */
- doc: Object;
- /**
- *
- */
- dojox: Object;
- /**
- * Effects library on top of Base animations
- *
- */
- fx: Object;
- /**
- * TODOC
- *
- */
- gears: Object;
- /**
- * Alias for the current window. 'global' can be modified
- * for temporary context shifting. See also withGlobal().
- *
- */
- global: Object;
- /**
- * TODOC
- *
- */
- html: Object;
- /**
- * This module implements the dojo/i18n! plugin and the v1.6- i18n API
- *
- */
- i18n: Object;
- /**
- *
- */
- io: Object;
- /**
- * True if client is Adobe Air
- *
- */
- isAir: boolean;
- /**
- * Version as a Number if client is android browser. undefined otherwise.
- *
- */
- isAndroid: number;
- /**
- *
- */
- isAsync: boolean;
- /**
- *
- */
- isBrowser: boolean;
- /**
- * Version as a Number if client is Chrome browser. undefined otherwise.
- *
- */
- isChrome: number;
- /**
- *
- */
- isCopyKey: Object;
- /**
- *
- */
- isFF: Object;
- /**
- * Version as a Number if client is MSIE(PC). undefined otherwise. Corresponds to
- * major detected IE version (6, 7, 8, etc.)
- *
- */
- isIE: number;
- /**
- * Version as a Number if client is iPhone, iPod, or iPad. undefined otherwise.
- *
- */
- isIos: number;
- /**
- * Version as a Number if client is a KHTML browser. undefined otherwise. Corresponds to major
- * detected version.
- *
- */
- isKhtml: number;
- /**
- * True if the client runs on Mac
- *
- */
- isMac: boolean;
- /**
- *
- */
- isMoz: Object;
- /**
- *
- */
- isMozilla: Object;
- /**
- * Version as a Number if client is Opera. undefined otherwise. Corresponds to
- * major detected version.
- *
- */
- isOpera: number;
- /**
- *
- */
- isQuirks: boolean;
- /**
- * Version as a Number if client is Safari or iPhone. undefined otherwise.
- *
- */
- isSafari: number;
- /**
- *
- */
- isSpidermonkey: boolean;
- /**
- * Version as a Number if client is a WebKit-derived browser (Konqueror,
- * Safari, Chrome, etc.). undefined otherwise.
- *
- */
- isWebKit: number;
- /**
- * True if client is Wii
- *
- */
- isWii: boolean;
- /**
- * Definitions for common key values. Client code should test keyCode against these named constants,
- * as the actual codes can vary by browser.
- *
- */
- keys: Object;
- /**
- *
- */
- locale: Object;
- /**
- *
- */
- mouseButtons: Object;
- /**
- * localized formatting and parsing routines for Number
- *
- */
- number: Object;
- /**
- *
- */
- parser: string;
- /**
- *
- */
- publish: Object;
- /**
- *
- */
- query: Object;
- /**
- * Regular expressions and Builder resources
- *
- */
- regexp: Object;
- /**
- *
- */
- rpc: Object;
- /**
- *
- */
- scopeMap: Object;
- /**
- *
- */
- store: Object;
- /**
- * String utilities for Dojo
- *
- */
- string: Object;
- /**
- *
- */
- subscribe: Object;
- /**
- * D.O.H. Test files for Dojo unit testing.
- *
- */
- tests: Object;
- /**
- *
- */
- toJsonIndentStr: string;
- /**
- * This module provides unified touch event handlers by exporting
- * press, move, release and cancel which can also run well on desktop.
- * Based on http://dvcs.w3.org/hg/webevents/raw-file/tip/touchevents.html
- * Also, if the dojoClick property is set to truthy on a DOM node, dojo/touch generates
- * click events immediately for this node and its descendants (except for descendants that
- * have a dojoClick property set to falsy), to avoid the delay before native browser click events,
- * and regardless of whether evt.preventDefault() was called in a touch.press event listener.
- *
- */
- touch: Object;
- /**
- * Version number of the Dojo Toolkit
- *
- */
- version: Object;
- /**
- * TODOC
- *
- */
- window: Object;
- /**
- * A registry to make contextual calling/searching easier.
- * Objects of this class keep list of arrays in the form [name, check,
- * wrap, directReturn] that are used to determine what the contextual
- * result of a set of checked arguments is. All check/wrap functions
- * in this registry should be of the same arity.
- *
- * @param returnWrappers Optional
- */
- AdapterRegistry(returnWrappers: boolean): void;
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- addClass(node: String, classStr: String): void;
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- addClass(node: HTMLElement, classStr: String): void;
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- addClass(node: String, classStr: any[]): void;
- /**
- * Adds the specified classes to the end of the class list on the
- * passed node. Will not re-apply duplicate classes.
- *
- * @param node String ID or DomNode reference to add a class string too
- * @param classStr A String class name to add, or several space-separated class names,or an array of class names.
- */
- addClass(node: HTMLElement, classStr: any[]): void;
- /**
- * Add a function to execute on DOM content loaded and all requested modules have arrived and been evaluated.
- * In most cases, the domReady plug-in should suffice and this method should not be needed.
- *
- * When called in a non-browser environment, just checks that all requested modules have arrived and been
- * evaluated.
- *
- * @param priority OptionalThe order in which to exec this callback relative to other callbacks, defaults to 1000
- * @param context The context in which to run execute callback, or a callback if not using context
- * @param callback OptionalThe function to execute.
- */
- addOnLoad(priority: number, context: any, callback?: Function): void;
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Object, functionName?: String): void;
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Function, functionName?: String): void;
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Object, functionName?: Function): void;
- /**
- * registers a function to be triggered when the page unloads.
- * The first time that addOnUnload is called Dojo will
- * register a page listener to trigger your unload handler
- * with.
- *
- * In a browser environment, the functions will be triggered
- * during the window.onbeforeunload event. Be careful of doing
- * too much work in an unload handler. onbeforeunload can be
- * triggered if a link to download a file is clicked, or if
- * the link is a javascript: link. In these cases, the
- * onbeforeunload event fires, but the document is not
- * actually destroyed. So be careful about doing destructive
- * operations in a dojo.addOnUnload callback.
- *
- * Further note that calling dojo.addOnUnload will prevent
- * browsers from using a "fast back" cache to make page
- * loading via back button instantaneous.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnUnload(obj?: Function, functionName?: Function): void;
- /**
- * registers a function to be triggered when window.onunload fires.
- * Be careful trying to modify the DOM or access JavaScript properties
- * during this phase of page unloading: they may not always be available.
- * Consider dojo.addOnUnload() if you need to modify the DOM or do heavy
- * JavaScript work.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnWindowUnload(obj?: Object, functionName?: String): void;
- /**
- * registers a function to be triggered when window.onunload fires.
- * Be careful trying to modify the DOM or access JavaScript properties
- * during this phase of page unloading: they may not always be available.
- * Consider dojo.addOnUnload() if you need to modify the DOM or do heavy
- * JavaScript work.
- *
- * @param obj Optional
- * @param functionName Optional
- */
- addOnWindowUnload(obj?: Object, functionName?: Function): void;
- /**
- * A simpler interface to animateProperty(), also returns
- * an instance of Animation but begins the animation
- * immediately, unlike nearly every other Dojo animation API.
- * Simpler (but somewhat less powerful) version
- * of animateProperty. It uses defaults for many basic properties
- * and allows for positional parameters to be used in place of the
- * packed "property bag" which is used for other Dojo animation
- * methods.
- *
- * The Animation object returned will be already playing, so
- * calling play() on it again is (usually) a no-op.
- *
- * @param node a DOM node or the id of a node to animate CSS properties on
- * @param properties
- * @param duration OptionalThe number of milliseconds over which the animationshould run. Defaults to the global animation default duration(350ms).
- * @param easing OptionalAn easing function over which to calculate accelerationand deceleration of the animation through its duration.A default easing algorithm is provided, but you mayplug in any you wish. A large selection of easing algorithmsare available in dojo/fx/easing.
- * @param onEnd OptionalA function to be called when the animation finishesrunning.
- * @param delay OptionalThe number of milliseconds to delay beginning theanimation by. The default is 0.
- */
- anim(node: HTMLElement, properties: Object, duration?: number, easing?: Function, onEnd?: Function, delay?: number): any;
- /**
- * A simpler interface to animateProperty(), also returns
- * an instance of Animation but begins the animation
- * immediately, unlike nearly every other Dojo animation API.
- * Simpler (but somewhat less powerful) version
- * of animateProperty. It uses defaults for many basic properties
- * and allows for positional parameters to be used in place of the
- * packed "property bag" which is used for other Dojo animation
- * methods.
- *
- * The Animation object returned will be already playing, so
- * calling play() on it again is (usually) a no-op.
- *
- * @param node a DOM node or the id of a node to animate CSS properties on
- * @param properties
- * @param duration OptionalThe number of milliseconds over which the animationshould run. Defaults to the global animation default duration(350ms).
- * @param easing OptionalAn easing function over which to calculate accelerationand deceleration of the animation through its duration.A default easing algorithm is provided, but you mayplug in any you wish. A large selection of easing algorithmsare available in dojo/fx/easing.
- * @param onEnd OptionalA function to be called when the animation finishesrunning.
- * @param delay OptionalThe number of milliseconds to delay beginning theanimation by. The default is 0.
- */
- anim(node: String, properties: Object, duration?: number, easing?: Function, onEnd?: Function, delay?: number): any;
- /**
- * Returns an animation that will transition the properties of
- * node defined in args depending how they are defined in
- * args.properties
- * Foundation of most dojo/_base/fx
- * animations. It takes an object of "properties" corresponding to
- * style properties, and animates them in parallel over a set
- * duration.
- *
- * @param args An object with the following properties:properties (Object, optional): A hash map of style properties to Objects describing the transition,such as the properties of _Line with an additional 'units' propertynode (DOMNode|String): The node referenced in the animationduration (Integer, optional): Duration of the animation in milliseconds.easing (Function, optional): An easing function.
- */
- animateProperty(args: Object): any;
- /**
- * A generic animation class that fires callbacks into its handlers
- * object at various states.
- * A generic animation class that fires callbacks into its handlers
- * object at various states. Nearly all dojo animation functions
- * return an instance of this method, usually without calling the
- * .play() method beforehand. Therefore, you will likely need to
- * call .play() on instances of Animation when one is
- * returned.
- *
- * @param args The 'magic argument', mixing all the properties into thisanimation instance.
- */
- Animation(args: Object): void;
- /**
- * Gets or sets an attribute on an HTML element.
- * Handles normalized getting and setting of attributes on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the attribute on
- * @param name the name of the attribute to get or set.
- * @param value OptionalThe value to set for the attribute
- */
- attr(node: HTMLElement, name: String, value?: String): any;
- /**
- * Gets or sets an attribute on an HTML element.
- * Handles normalized getting and setting of attributes on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the attribute on
- * @param name the name of the attribute to get or set.
- * @param value OptionalThe value to set for the attribute
- */
- attr(node: String, name: String, value?: String): any;
- /**
- * Gets or sets an attribute on an HTML element.
- * Handles normalized getting and setting of attributes on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the attribute on
- * @param name the name of the attribute to get or set.
- * @param value OptionalThe value to set for the attribute
- */
- attr(node: HTMLElement, name: Object, value?: String): any;
- /**
- * Gets or sets an attribute on an HTML element.
- * Handles normalized getting and setting of attributes on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the attribute on
- * @param name the name of the attribute to get or set.
- * @param value OptionalThe value to set for the attribute
- */
- attr(node: String, name: Object, value?: String): any;
- /**
- * Blend colors end and start with weight from 0 to 1, 0.5 being a 50/50 blend,
- * can reuse a previously allocated Color object for the result
- *
- * @param start
- * @param end
- * @param weight
- * @param obj Optional
- */
- blendColors(start: dojo._base.Color, end: dojo._base.Color, weight: number, obj?: dojo._base.Color): any;
- /**
- * Return the body element of the specified document or of dojo/_base/window::doc.
- *
- * @param doc Optional
- */
- body(doc?: HTMLDocument): any;
- /**
- * Returns DOM node with matching id attribute or falsy value (ex: null or undefined)
- * if not found. If id is a DomNode, this function is a no-op.
- *
- * @param id A string to match an HTML id attribute or a reference to a DOM Node
- * @param doc OptionalDocument to work in. Defaults to the current value ofdojo/_base/window.doc. Can be used to retrievenode references from other documents.
- */
- byId(id: String, doc?: HTMLDocument): any;
- /**
- * Returns DOM node with matching id attribute or falsy value (ex: null or undefined)
- * if not found. If id is a DomNode, this function is a no-op.
- *
- * @param id A string to match an HTML id attribute or a reference to a DOM Node
- * @param doc OptionalDocument to work in. Defaults to the current value ofdojo/_base/window.doc. Can be used to retrievenode references from other documents.
- */
- byId(id: HTMLElement, doc?: HTMLDocument): any;
- /**
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- cache(module: String, url: String, value?: String): any;
- /**
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- cache(module: Object, url: String, value?: String): any;
- /**
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- cache(module: String, url: String, value?: Object): any;
- /**
- * A getter and setter for storing the string content associated with the
- * module and url arguments.
- * If module is a string that contains slashes, then it is interpretted as a fully
- * resolved path (typically a result returned by require.toUrl), and url should not be
- * provided. This is the preferred signature. If module is a string that does not
- * contain slashes, then url must also be provided and module and url are used to
- * call dojo.moduleUrl() to generate a module URL. This signature is deprecated.
- * If value is specified, the cache value for the moduleUrl will be set to
- * that value. Otherwise, dojo.cache will fetch the moduleUrl and store it
- * in its internal cache and return that cached value for the URL. To clear
- * a cache value pass null for value. Since XMLHttpRequest (XHR) is used to fetch the
- * the URL contents, only modules on the same domain of the page can use this capability.
- * The build system can inline the cache values though, to allow for xdomain hosting.
- *
- * @param module dojo/cldr/supplemental
- * @param url The rest of the path to append to the path derived from the module argument. Ifmodule is an object, then this second argument should be the "value" argument instead.
- * @param value OptionalIf a String, the value to use in the cache for the module/url combination.If an Object, it can have two properties: value and sanitize. The value propertyshould be the value to use in the cache, and sanitize can be set to true or false,to indicate if XML declarations should be removed from the value and if the HTMLinside a body tag in the value should be extracted as the real value. The value argumentor the value property on the value argument are usually only used by the build systemas it inlines cache content.
- */
- cache(module: Object, url: String, value?: Object): any;
- /**
- *
- */
- clearCache(): void;
- /**
- * Takes a named string, hex string, array of rgb or rgba values,
- * an object with r, g, b, and a properties, or another Color object
- * and creates a new Color instance to work from.
- *
- * @param color
- */
- Color(color: any[]): void;
- /**
- * Takes a named string, hex string, array of rgb or rgba values,
- * an object with r, g, b, and a properties, or another Color object
- * and creates a new Color instance to work from.
- *
- * @param color
- */
- Color(color: String): void;
- /**
- * Takes a named string, hex string, array of rgb or rgba values,
- * an object with r, g, b, and a properties, or another Color object
- * and creates a new Color instance to work from.
- *
- * @param color
- */
- Color(color: Object): void;
- /**
- * Builds a Color from a 3 or 4 element array, mapping each
- * element in sequence to the rgb(a) values of the color.
- *
- * @param a
- * @param obj Optional
- */
- colorFromArray(a: any[], obj?: dojo._base.Color): any;
- /**
- * Converts a hex string with a '#' prefix to a color object.
- * Supports 12-bit #rgb shorthand. Optionally accepts a
- * Color object to update with the parsed value.
- *
- * @param color
- * @param obj Optional
- */
- colorFromHex(color: String, obj?: dojo._base.Color): any;
- /**
- * get rgb(a) array from css-style color declarations
- * this function can handle all 4 CSS3 Color Module formats: rgb,
- * rgba, hsl, hsla, including rgb(a) with percentage values.
- *
- * @param color
- * @param obj Optional
- */
- colorFromRgb(color: String, obj?: dojo._base.Color): any;
- /**
- * Parses str for a color value. Accepts hex, rgb, and rgba
- * style color values.
- * Acceptable input values for str may include arrays of any form
- * accepted by dojo.colorFromArray, hex strings such as "#aaaaaa", or
- * rgb or rgba strings such as "rgb(133, 200, 16)" or "rgba(10, 10,
- * 10, 50)"
- *
- * @param str
- * @param obj Optional
- */
- colorFromString(str: String, obj?: dojo._base.Color): any;
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: Object, method: String, dontFix?: boolean): any;
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: any, method: String, dontFix?: boolean): any;
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: Object, method: Function, dontFix?: boolean): any;
- /**
- * dojo.connect is a deprecated event handling and delegation method in
- * Dojo. It allows one function to "listen in" on the execution of
- * any other, triggering the second whenever the first is called. Many
- * listeners may be attached to a function, and source functions may
- * be either regular function calls or DOM events.
- * Connects listeners to actions, so that after event fires, a
- * listener is called with the same arguments passed to the original
- * function.
- *
- * Since dojo.connect allows the source of events to be either a
- * "regular" JavaScript function or a DOM event, it provides a uniform
- * interface for listening to all the types of events that an
- * application is likely to deal with though a single, unified
- * interface. DOM programmers may want to think of it as
- * "addEventListener for everything and anything".
- *
- * When setting up a connection, the event parameter must be a
- * string that is the name of the method/event to be listened for. If
- * obj is null, kernel.global is assumed, meaning that connections
- * to global methods are supported but also that you may inadvertently
- * connect to a global by passing an incorrect object name or invalid
- * reference.
- *
- * dojo.connect generally is forgiving. If you pass the name of a
- * function or method that does not yet exist on obj, connect will
- * not fail, but will instead set up a stub method. Similarly, null
- * arguments may simply be omitted such that fewer than 4 arguments
- * may be required to set up a connection See the examples for details.
- *
- * The return value is a handle that is needed to
- * remove this connection with dojo.disconnect.
- *
- * @param obj OptionalThe source object for the event function.Defaults to kernel.global if null.If obj is a DOM node, the connection is delegatedto the DOM event manager (unless dontFix is true).
- * @param event String name of the event function in obj.I.e. identifies a property obj[event].
- * @param context The object that method will receive as "this".If context is null and method is a function, then methodinherits the context of event.If method is a string then context must be the sourceobject object for method (context[method]). If context is null,kernel.global is used.
- * @param method A function reference, or name of a function in context.The function identified by method fires after event does.method receives the same arguments as the event.See context argument comments for information on method's scope.
- * @param dontFix OptionalIf obj is a DOM node, set dontFix to true to prevent delegationof this connection to the DOM event manager.
- */
- connect(obj: Object, event: String, context: any, method: Function, dontFix?: boolean): any;
- /**
- * Getter/setter for the content-box of node.
- * Returns an object in the expected format of box (regardless if box is passed).
- * The object might look like:
- * { l: 50, t: 200, w: 300: h: 150 }
- * for a node offset from its parent 50px to the left, 200px from
- * the top with a content width of 300px and a content-height of
- * 150px. Note that the content box may have a much larger border
- * or margin box, depending on the box model currently in use and
- * CSS values set/inherited for node.
- * While the getter will return top and left values, the
- * setter only accepts setting the width and height.
- *
- * @param node id or reference to DOM Node to get/set box for
- * @param box OptionalIf passed, denotes that dojo.contentBox() shouldupdate/set the content box for node. Box is an object in theabove format, but only w (width) and h (height) are supported.All properties are optional if passed.
- */
- contentBox(node: HTMLElement, box?: Object): any;
- /**
- * Getter/setter for the content-box of node.
- * Returns an object in the expected format of box (regardless if box is passed).
- * The object might look like:
- * { l: 50, t: 200, w: 300: h: 150 }
- * for a node offset from its parent 50px to the left, 200px from
- * the top with a content width of 300px and a content-height of
- * 150px. Note that the content box may have a much larger border
- * or margin box, depending on the box model currently in use and
- * CSS values set/inherited for node.
- * While the getter will return top and left values, the
- * setter only accepts setting the width and height.
- *
- * @param node id or reference to DOM Node to get/set box for
- * @param box OptionalIf passed, denotes that dojo.contentBox() shouldupdate/set the content box for node. Box is an object in theabove format, but only w (width) and h (height) are supported.All properties are optional if passed.
- */
- contentBox(node: String, box?: Object): any;
- /**
- * Get or set a cookie.
- * If one argument is passed, returns the value of the cookie
- * For two or more arguments, acts as a setter.
- *
- * @param name Name of the cookie
- * @param value OptionalValue for the cookie
- * @param props OptionalProperties for the cookie
- */
- cookie(name: String, value?: String, props?: Object): any;
- /**
- * Deprecated: Use position() for border-box x/y/w/h
- * or marginBox() for margin-box w/h/l/t.
- *
- * Returns an object that measures margin-box (w)idth/(h)eight
- * and absolute position x/y of the border-box. Also returned
- * is computed (l)eft and (t)op values in pixels from the
- * node's offsetParent as returned from marginBox().
- * Return value will be in the form:
- *
- * { l: 50, t: 200, w: 300: h: 150, x: 100, y: 300 }
- * Does not act as a setter. If includeScroll is passed, the x and
- *
- * y params are affected as one would expect in dojo.position().
- *
- * @param node
- * @param includeScroll Optional
- */
- coords(node: HTMLElement, includeScroll?: boolean): any;
- /**
- * Deprecated: Use position() for border-box x/y/w/h
- * or marginBox() for margin-box w/h/l/t.
- *
- * Returns an object that measures margin-box (w)idth/(h)eight
- * and absolute position x/y of the border-box. Also returned
- * is computed (l)eft and (t)op values in pixels from the
- * node's offsetParent as returned from marginBox().
- * Return value will be in the form:
- *
- * { l: 50, t: 200, w: 300: h: 150, x: 100, y: 300 }
- * Does not act as a setter. If includeScroll is passed, the x and
- *
- * y params are affected as one would expect in dojo.position().
- *
- * @param node
- * @param includeScroll Optional
- */
- coords(node: String, includeScroll?: boolean): any;
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: HTMLElement, attrs: Object, refNode?: HTMLElement, pos?: String): any;
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: String, attrs: Object, refNode?: HTMLElement, pos?: String): any;
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: HTMLElement, attrs: Object, refNode?: String, pos?: String): any;
- /**
- * Create an element, allowing for optional attribute decoration
- * and placement.
- * A DOM Element creation function. A shorthand method for creating a node or
- * a fragment, and allowing for a convenient optional attribute setting step,
- * as well as an optional DOM placement reference.
- *
- * Attributes are set by passing the optional object through dojo.setAttr.
- * See dojo.setAttr for noted caveats and nuances, and API if applicable.
- *
- * Placement is done via dojo.place, assuming the new node to be the action
- * node, passing along the optional reference node and position.
- *
- * @param tag A string of the element to create (eg: "div", "a", "p", "li", "script", "br"),or an existing DOM node to process.
- * @param attrs An object-hash of attributes to set on the newly created node.Can be null, if you don't want to set any attributes/styles.See: dojo.setAttr for a description of available attributes.
- * @param refNode OptionalOptional reference node. Used by dojo.place to place the newly creatednode somewhere in the dom relative to refNode. Can be a DomNode referenceor String ID of a node.
- * @param pos OptionalOptional positional reference. Defaults to "last" by way of dojo.place,though can be set to "first","after","before","last", "replace" or "only"to further control the placement of the new node relative to the refNode.'refNode' is required if a 'pos' is specified.
- */
- create(tag: String, attrs: Object, refNode?: String, pos?: String): any;
- /**
- * Create a feature-rich constructor from compact notation.
- * Create a constructor using a compact notation for inheritance and
- * prototype extension.
- *
- * Mixin ancestors provide a type of multiple inheritance.
- * Prototypes of mixin ancestors are copied to the new class:
- * changes to mixin prototypes will not affect classes to which
- * they have been mixed in.
- *
- * Ancestors can be compound classes created by this version of
- * declare(). In complex cases all base classes are going to be
- * linearized according to C3 MRO algorithm
- * (see http://www.python.org/download/releases/2.3/mro/ for more
- * details).
- *
- * "className" is cached in "declaredClass" property of the new class,
- * if it was supplied. The immediate super class will be cached in
- * "superclass" property of the new class.
- *
- * Methods in "props" will be copied and modified: "nom" property
- * (the declared name of the method) will be added to all copied
- * functions to help identify them for the internal machinery. Be
- * very careful, while reusing methods: if you use the same
- * function under different names, it can produce errors in some
- * cases.
- *
- * It is possible to use constructors created "manually" (without
- * declare()) as bases. They will be called as usual during the
- * creation of an instance, their methods will be chained, and even
- * called by "this.inherited()".
- *
- * Special property "-chains-" governs how to chain methods. It is
- * a dictionary, which uses method names as keys, and hint strings
- * as values. If a hint string is "after", this method will be
- * called after methods of its base classes. If a hint string is
- * "before", this method will be called before methods of its base
- * classes.
- *
- * If "constructor" is not mentioned in "-chains-" property, it will
- * be chained using the legacy mode: using "after" chaining,
- * calling preamble() method before each constructor, if available,
- * and calling postscript() after all constructors were executed.
- * If the hint is "after", it is chained as a regular method, but
- * postscript() will be called after the chain of constructors.
- * "constructor" cannot be chained "before", but it allows
- * a special hint string: "manual", which means that constructors
- * are not going to be chained in any way, and programmer will call
- * them manually using this.inherited(). In the latter case
- * postscript() will be called after the construction.
- *
- * All chaining hints are "inherited" from base classes and
- * potentially can be overridden. Be very careful when overriding
- * hints! Make sure that all chained methods can work in a proposed
- * manner of chaining.
- *
- * Once a method was chained, it is impossible to unchain it. The
- * only exception is "constructor". You don't need to define a
- * method in order to supply a chaining hint.
- *
- * If a method is chained, it cannot use this.inherited() because
- * all other methods in the hierarchy will be called automatically.
- *
- * Usually constructors and initializers of any kind are chained
- * using "after" and destructors of any kind are chained as
- * "before". Note that chaining assumes that chained methods do not
- * return any value: any returned value will be discarded.
- *
- * @param className OptionalThe optional name of the constructor (loosely, a "class")stored in the "declaredClass" property in the created prototype.It will be used as a global name for a created constructor.
- * @param superclass May be null, a Function, or an Array of Functions. This argumentspecifies a list of bases (the left-most one is the most deepestbase).
- * @param props An object whose properties are copied to the created prototype.Add an instance-initialization function by making it a propertynamed "constructor".
- */
- declare(className: String, superclass: Function, props: Object): dojo._base.declare.__DeclareCreatedObject;
- /**
- * Create a feature-rich constructor from compact notation.
- * Create a constructor using a compact notation for inheritance and
- * prototype extension.
- *
- * Mixin ancestors provide a type of multiple inheritance.
- * Prototypes of mixin ancestors are copied to the new class:
- * changes to mixin prototypes will not affect classes to which
- * they have been mixed in.
- *
- * Ancestors can be compound classes created by this version of
- * declare(). In complex cases all base classes are going to be
- * linearized according to C3 MRO algorithm
- * (see http://www.python.org/download/releases/2.3/mro/ for more
- * details).
- *
- * "className" is cached in "declaredClass" property of the new class,
- * if it was supplied. The immediate super class will be cached in
- * "superclass" property of the new class.
- *
- * Methods in "props" will be copied and modified: "nom" property
- * (the declared name of the method) will be added to all copied
- * functions to help identify them for the internal machinery. Be
- * very careful, while reusing methods: if you use the same
- * function under different names, it can produce errors in some
- * cases.
- *
- * It is possible to use constructors created "manually" (without
- * declare()) as bases. They will be called as usual during the
- * creation of an instance, their methods will be chained, and even
- * called by "this.inherited()".
- *
- * Special property "-chains-" governs how to chain methods. It is
- * a dictionary, which uses method names as keys, and hint strings
- * as values. If a hint string is "after", this method will be
- * called after methods of its base classes. If a hint string is
- * "before", this method will be called before methods of its base
- * classes.
- *
- * If "constructor" is not mentioned in "-chains-" property, it will
- * be chained using the legacy mode: using "after" chaining,
- * calling preamble() method before each constructor, if available,
- * and calling postscript() after all constructors were executed.
- * If the hint is "after", it is chained as a regular method, but
- * postscript() will be called after the chain of constructors.
- * "constructor" cannot be chained "before", but it allows
- * a special hint string: "manual", which means that constructors
- * are not going to be chained in any way, and programmer will call
- * them manually using this.inherited(). In the latter case
- * postscript() will be called after the construction.
- *
- * All chaining hints are "inherited" from base classes and
- * potentially can be overridden. Be very careful when overriding
- * hints! Make sure that all chained methods can work in a proposed
- * manner of chaining.
- *
- * Once a method was chained, it is impossible to unchain it. The
- * only exception is "constructor". You don't need to define a
- * method in order to supply a chaining hint.
- *
- * If a method is chained, it cannot use this.inherited() because
- * all other methods in the hierarchy will be called automatically.
- *
- * Usually constructors and initializers of any kind are chained
- * using "after" and destructors of any kind are chained as
- * "before". Note that chaining assumes that chained methods do not
- * return any value: any returned value will be discarded.
- *
- * @param className OptionalThe optional name of the constructor (loosely, a "class")stored in the "declaredClass" property in the created prototype.It will be used as a global name for a created constructor.
- * @param superclass May be null, a Function, or an Array of Functions. This argumentspecifies a list of bases (the left-most one is the most deepestbase).
- * @param props An object whose properties are copied to the created prototype.Add an instance-initialization function by making it a propertynamed "constructor".
- */
- declare(className: String, superclass: Function[], props: Object): dojo._base.declare.__DeclareCreatedObject;
- /**
- * Deprecated. This module defines the legacy dojo/_base/Deferred API.
- * New code should use dojo/Deferred instead.
- * The Deferred API is based on the concept of promises that provide a
- * generic interface into the eventual completion of an asynchronous action.
- * The motivation for promises fundamentally is about creating a
- * separation of concerns that allows one to achieve the same type of
- * call patterns and logical data flow in asynchronous code as can be
- * achieved in synchronous code. Promises allows one
- * to be able to call a function purely with arguments needed for
- * execution, without conflating the call with concerns of whether it is
- * sync or async. One shouldn't need to alter a call's arguments if the
- * implementation switches from sync to async (or vice versa). By having
- * async functions return promises, the concerns of making the call are
- * separated from the concerns of asynchronous interaction (which are
- * handled by the promise).
- *
- * The Deferred is a type of promise that provides methods for fulfilling the
- * promise with a successful result or an error. The most important method for
- * working with Dojo's promises is the then() method, which follows the
- * CommonJS proposed promise API. An example of using a Dojo promise:
- *
- * var resultingPromise = someAsyncOperation.then(function(result){
- * ... handle result ...
- * },
- * function(error){
- * ... handle error ...
- * });
- * The .then() call returns a new promise that represents the result of the
- * execution of the callback. The callbacks will never affect the original promises value.
- *
- * The Deferred instances also provide the following functions for backwards compatibility:
- *
- * addCallback(handler)
- * addErrback(handler)
- * callback(result)
- * errback(result)
- * Callbacks are allowed to return promises themselves, so
- * you can build complicated sequences of events with ease.
- *
- * The creator of the Deferred may specify a canceller. The canceller
- * is a function that will be called if Deferred.cancel is called
- * before the Deferred fires. You can use this to implement clean
- * aborting of an XMLHttpRequest, etc. Note that cancel will fire the
- * deferred with a CancelledError (unless your canceller returns
- * another kind of error), so the errbacks should be prepared to
- * handle that error for cancellable Deferreds.
- *
- * @param canceller Optional
- */
- Deferred(canceller: Function): void;
- /**
- * Deprecated, use dojo/promise/all instead.
- * Provides event handling for a group of Deferred objects.
- * DeferredList takes an array of existing deferreds and returns a new deferred of its own
- * this new deferred will typically have its callback fired when all of the deferreds in
- * the given list have fired their own deferreds. The parameters fireOnOneCallback and
- * fireOnOneErrback, will fire before all the deferreds as appropriate
- *
- * @param list The list of deferreds to be synchronizied with this DeferredList
- * @param fireOnOneCallback OptionalWill cause the DeferredLists callback to be fired as soon as anyof the deferreds in its list have been fired instead of waiting untilthe entire list has finished
- * @param fireOnOneErrback Optional
- * @param consumeErrors Optional
- * @param canceller OptionalA deferred canceller function, see dojo.Deferred
- */
- DeferredList(list: any[], fireOnOneCallback?: boolean, fireOnOneErrback?: boolean, consumeErrors?: boolean, canceller?: Function): void;
- /**
- * Log a debug message to indicate that a behavior has been
- * deprecated.
- *
- * @param behaviour The API or behavior being deprecated. Usually in the formof "myApp.someFunction()".
- * @param extra OptionalText to append to the message. Often provides advice on anew function or facility to achieve the same goal duringthe deprecation period.
- * @param removal OptionalText to indicate when in the future the behavior will beremoved. Usually a version number.
- */
- deprecated(behaviour: String, extra?: String, removal?: String): void;
- /**
- *
- * @param node
- */
- destroy(node: any): void;
- /**
- * Remove a link created by dojo.connect.
- * Removes the connection between event and the method referenced by handle.
- *
- * @param handle the return value of the dojo.connect call that created the connection.
- */
- disconnect(handle: Object): void;
- /**
- * Returns an object with {node, x, y} with corresponding offsets.
- *
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- docScroll(doc?: HTMLDocument): Object;
- /**
- *
- * @param node
- */
- empty(node: any): void;
- /**
- * A legacy method created for use exclusively by internal Dojo methods. Do not use this method
- * directly unless you understand its possibly-different implications on the platforms your are targeting.
- * Makes an attempt to evaluate scriptText in the global scope. The function works correctly for browsers
- * that support indirect eval.
- *
- * As usual, IE does not. On IE, the only way to implement global eval is to
- * use execScript. Unfortunately, execScript does not return a value and breaks some current usages of dojo.eval.
- * This implementation uses the technique of executing eval in the scope of a function that is a single scope
- * frame below the global scope; thereby coming close to the global scope. Note carefully that
- *
- * dojo.eval("var pi = 3.14;");
- *
- * will define global pi in non-IE environments, but define pi only in a temporary local scope for IE. If you want
- * to define a global variable using dojo.eval, write something like
- *
- * dojo.eval("window.pi = 3.14;")
- *
- * @param scriptText The text to evaluation.
- */
- eval(scriptText: any): any;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: any[], callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: String, callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: any[], callback: String, thisObject?: Object): boolean;
- /**
- * Determines whether or not every item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.every() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's every skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/every
- *
- * @param arr the array to iterate on. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- every(arr: String, callback: String, thisObject?: Object): boolean;
- /**
- *
- * @param exitcode
- */
- exit(exitcode: any): void;
- /**
- * Marks code as experimental.
- * This can be used to mark a function, file, or module as
- * experimental. Experimental code is not ready to be used, and the
- * APIs are subject to change without notice. Experimental code may be
- * completed deleted without going through the normal deprecation
- * process.
- *
- * @param moduleName The name of a module, or the name of a module file or a specificfunction
- * @param extra Optionalsome additional message for the user
- */
- experimental(moduleName: String, extra?: String): void;
- /**
- * Returns an animation that will fade node defined in 'args' from
- * its current opacity to fully opaque.
- *
- * @param args An object with the following properties:node (DOMNode|String): The node referenced in the animationduration (Integer, optional): Duration of the animation in milliseconds.easing (Function, optional): An easing function.
- */
- fadeIn(args: Object): any;
- /**
- * Returns an animation that will fade node defined in 'args'
- * from its current opacity to fully transparent.
- *
- * @param args An object with the following properties:node (DOMNode|String): The node referenced in the animationduration (Integer, optional): Duration of the animation in milliseconds.easing (Function, optional): An easing function.
- */
- fadeOut(args: Object): any;
- /**
- * Serialize a form field to a JavaScript object.
- * Returns the value encoded in a form field as
- * as a string or an array of strings. Disabled form elements
- * and unchecked radio and checkboxes are skipped. Multi-select
- * elements are returned as an array of string values.
- *
- * @param inputNode
- */
- fieldToObject(inputNode: HTMLElement): Object;
- /**
- * Serialize a form field to a JavaScript object.
- * Returns the value encoded in a form field as
- * as a string or an array of strings. Disabled form elements
- * and unchecked radio and checkboxes are skipped. Multi-select
- * elements are returned as an array of string values.
- *
- * @param inputNode
- */
- fieldToObject(inputNode: String): Object;
- /**
- * Returns a new Array with those items from arr that match the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.filter() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's filter skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/filter
- *
- * @param arr the array to iterate over.
- * @param callback a function that is invoked with three arguments (item,index, array). The return of this function is expected tobe a boolean which determines whether the passed-in itemwill be included in the returned array.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- filter(arr: any[], callback: Function, thisObject?: Object): any[];
- /**
- * Returns a new Array with those items from arr that match the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.filter() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's filter skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/filter
- *
- * @param arr the array to iterate over.
- * @param callback a function that is invoked with three arguments (item,index, array). The return of this function is expected tobe a boolean which determines whether the passed-in itemwill be included in the returned array.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- filter(arr: any[], callback: String, thisObject?: Object): any[];
- /**
- * normalizes properties on the event object including event
- * bubbling methods, keystroke normalization, and x/y positions
- *
- * @param evt native event object
- * @param sender node to treat as "currentTarget"
- */
- fixEvent(evt: Event, sender: HTMLElement): Event;
- /**
- * In RTL direction, scrollLeft should be a negative value, but IE
- * returns a positive one. All codes using documentElement.scrollLeft
- * must call this function to fix this error, otherwise the position
- * will offset to right when there is a horizontal scrollbar.
- *
- * @param scrollLeft
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- fixIeBiDiScrollLeft(scrollLeft: number, doc?: HTMLDocument): number;
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: any[], callback: Function, thisObject?: Object): void;
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: String, callback: Function, thisObject?: Object): void;
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: any[], callback: String, thisObject?: Object): void;
- /**
- * for every item in arr, callback is invoked. Return values are ignored.
- * If you want to break out of the loop, consider using array.every() or array.some().
- * forEach does not allow breaking out of the loop over the items in arr.
- * This function corresponds to the JavaScript 1.6 Array.forEach() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's forEach skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/forEach
- *
- * @param arr
- * @param callback
- * @param thisObject Optional
- */
- forEach(arr: String, callback: String, thisObject?: Object): void;
- /**
- * Create a serialized JSON string from a form node or string
- * ID identifying the form to serialize
- *
- * @param formNode
- * @param prettyPrint Optional
- */
- formToJson(formNode: HTMLElement, prettyPrint?: boolean): String;
- /**
- * Create a serialized JSON string from a form node or string
- * ID identifying the form to serialize
- *
- * @param formNode
- * @param prettyPrint Optional
- */
- formToJson(formNode: String, prettyPrint?: boolean): String;
- /**
- * Serialize a form node to a JavaScript object.
- * Returns the values encoded in an HTML form as
- * string properties in an object which it then returns. Disabled form
- * elements, buttons, and other non-value form elements are skipped.
- * Multi-select elements are returned as an array of string values.
- *
- * @param formNode
- */
- formToObject(formNode: HTMLElement): Object;
- /**
- * Serialize a form node to a JavaScript object.
- * Returns the values encoded in an HTML form as
- * string properties in an object which it then returns. Disabled form
- * elements, buttons, and other non-value form elements are skipped.
- * Multi-select elements are returned as an array of string values.
- *
- * @param formNode
- */
- formToObject(formNode: String): Object;
- /**
- * Returns a URL-encoded string representing the form passed as either a
- * node or string ID identifying the form to serialize
- *
- * @param formNode
- */
- formToQuery(formNode: HTMLElement): String;
- /**
- * Returns a URL-encoded string representing the form passed as either a
- * node or string ID identifying the form to serialize
- *
- * @param formNode
- */
- formToQuery(formNode: String): String;
- /**
- * Parses a JavaScript expression and returns a JavaScript value.
- * Throws for invalid JavaScript expressions. It does not use a strict JSON parser. It
- * always delegates to eval(). The content passed to this method must therefore come
- * from a trusted source.
- * It is recommend that you use dojo/json's parse function for an
- * implementation uses the (faster) native JSON parse when available.
- *
- * @param js a string literal of a JavaScript expression, for instance:'{ "foo": [ "bar", 1, { "baz": "thud" } ] }'
- */
- fromJson(js: String): any;
- /**
- * Gets an attribute on an HTML element.
- * Handles normalized getting of attributes on DOM Nodes.
- *
- * @param node id or reference to the element to get the attribute on
- * @param name the name of the attribute to get.
- */
- getAttr(node: HTMLElement, name: String): any;
- /**
- * Gets an attribute on an HTML element.
- * Handles normalized getting of attributes on DOM Nodes.
- *
- * @param node id or reference to the element to get the attribute on
- * @param name the name of the attribute to get.
- */
- getAttr(node: String, name: String): any;
- /**
- * returns an object with properties useful for noting the border
- * dimensions.
- * l/t/r/b = the sum of left/top/right/bottom border (respectively)
- * w = the sum of the left and right border
- * h = the sum of the top and bottom border
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getBorderExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * Returns a "computed style" object.
- * Gets a "computed style" object which can be used to gather
- * information about the current state of the rendered node.
- *
- * Note that this may behave differently on different browsers.
- * Values may have different formats and value encodings across
- * browsers.
- *
- * Note also that this method is expensive. Wherever possible,
- * reuse the returned object.
- *
- * Use the dojo/dom-style.get() method for more consistent (pixelized)
- * return values.
- *
- * @param node A reference to a DOM node. Does NOT support taking anID string for speed reasons.
- */
- getComputedStyle(node: HTMLElement): void;
- /**
- * Returns an object that encodes the width, height, left and top
- * positions of the node's content box, irrespective of the
- * current box model.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getContentBox(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns the offset in x and y from the document body to the
- * visual edge of the page for IE
- * The following values in IE contain an offset:
- *
- * event.clientX
- * event.clientY
- * node.getBoundingClientRect().left
- * node.getBoundingClientRect().top
- * But other position related values do not contain this offset,
- *
- * such as node.offsetLeft, node.offsetTop, node.style.left and
- * node.style.top. The offset is always (2, 2) in LTR direction.
- * When the body is in RTL direction, the offset counts the width
- * of left scroll bar's width. This function computes the actual
- * offset.
- *
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- getIeDocumentElementOffset(doc?: HTMLDocument): Object;
- /**
- *
- * @param moduleName
- * @param bundleName
- * @param locale
- */
- getL10nName(moduleName: any, bundleName: any, locale: any): String;
- /**
- * returns an object that encodes the width, height, left and top
- * positions of the node's margin box.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginBox(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns object with properties useful for box fitting with
- * regards to box margins (i.e., the outer-box).
- *
- * l/t = marginLeft, marginTop, respectively
- * w = total width, margin inclusive
- * h = total height, margin inclusive
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns an object that encodes the width and height of
- * the node's margin box
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginSize(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * returns an object that encodes the width and height of
- * the node's margin box
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getMarginSize(node: String, computedStyle?: Object): Object;
- /**
- * Returns an effective value of a property or an attribute.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute
- */
- getNodeProp(node: HTMLElement, name: String): any;
- /**
- * Returns an effective value of a property or an attribute.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute
- */
- getNodeProp(node: String, name: String): any;
- /**
- * Returns object with properties useful for box fitting with
- * regards to padding.
- * l/t/r/b = the sum of left/top/right/bottom padding and left/top/right/bottom border (respectively)
- * w = the sum of the left and right padding and border
- * h = the sum of the top and bottom padding and border
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getPadBorderExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * Returns object with special values specifically useful for node
- * fitting.
- * Returns an object with w, h, l, t properties:
- *
- * l/t/r/b = left/top/right/bottom padding (respectively)
- * w = the total of the left and right padding
- * h = the total of the top and bottom padding
- * If 'node' has position, l/t forms the origin for child nodes.
- *
- * The w/h are used for calculating boxes.
- * Normally application code will not need to invoke this
- * directly, and will use the ...box... functions instead.
- *
- * @param node
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- getPadExtents(node: HTMLElement, computedStyle?: Object): Object;
- /**
- * Gets a property on an HTML element.
- * Handles normalized getting of properties on DOM nodes.
- *
- * @param node id or reference to the element to get the property on
- * @param name the name of the property to get.
- */
- getProp(node: HTMLElement, name: String): any;
- /**
- * Gets a property on an HTML element.
- * Handles normalized getting of properties on DOM nodes.
- *
- * @param node id or reference to the element to get the property on
- * @param name the name of the property to get.
- */
- getProp(node: String, name: String): any;
- /**
- * Accesses styles on a node.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo/dom-geometry.getMarginBox(),
- * dojo/dom-geometry.getContentBox() or dojo/dom-geometry.getPosition().
- *
- * @param node id or reference to node to get style for
- * @param name Optionalthe style property to get
- */
- getStyle(node: HTMLElement, name?: String): any;
- /**
- * Accesses styles on a node.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo/dom-geometry.getMarginBox(),
- * dojo/dom-geometry.getContentBox() or dojo/dom-geometry.getPosition().
- *
- * @param node id or reference to node to get style for
- * @param name Optionalthe style property to get
- */
- getStyle(node: String, name?: String): any;
- /**
- * Returns true if the requested attribute is specified on the
- * given element, and false otherwise.
- *
- * @param node id or reference to the element to check
- * @param name the name of the attribute
- */
- hasAttr(node: HTMLElement, name: String): boolean;
- /**
- * Returns true if the requested attribute is specified on the
- * given element, and false otherwise.
- *
- * @param node id or reference to the element to check
- * @param name the name of the attribute
- */
- hasAttr(node: String, name: String): boolean;
- /**
- * Returns whether or not the specified classes are a portion of the
- * class list currently applied to the node.
- *
- * @param node String ID or DomNode reference to check the class for.
- * @param classStr A string class name to look for.
- */
- hasClass(node: String, classStr: String): boolean;
- /**
- * Returns whether or not the specified classes are a portion of the
- * class list currently applied to the node.
- *
- * @param node String ID or DomNode reference to check the class for.
- * @param classStr A string class name to look for.
- */
- hasClass(node: HTMLElement, classStr: String): boolean;
- /**
- * Gets or sets the hash string in the browser URL.
- * Handles getting and setting of location.hash.
- *
- * If no arguments are passed, acts as a getter.
- * If a string is passed, acts as a setter.
- *
- * @param hash Optionalthe hash is set - #string.
- * @param replace OptionalIf true, updates the hash value in the current historystate instead of creating a new history state.
- */
- hash(hash?: String, replace?: boolean): any;
- /**
- * locates the first index of the provided value in the
- * passed array. If the value is not found, -1 is returned.
- * This method corresponds to the JavaScript 1.6 Array.indexOf method, with two differences:
- *
- * when run over sparse arrays, the Dojo function invokes the callback for every index
- * whereas JavaScript 1.6's indexOf skips the holes in the sparse array.
- * uses equality (==) rather than strict equality (===)
- * For details on this method, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/indexOf
- *
- * @param arr
- * @param value
- * @param fromIndex Optional
- * @param findLast OptionalMakes indexOf() work like lastIndexOf(). Used internally; not meant for external usage.
- */
- indexOf(arr: any[], value: Object, fromIndex?: number, findLast?: boolean): number;
- /**
- * Returns true if the current language is left-to-right, and false otherwise.
- *
- * @param doc OptionalOptional document to query. If unspecified, use win.doc.
- */
- isBodyLtr(doc?: HTMLDocument): boolean;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: HTMLElement, ancestor: HTMLElement): boolean;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: String, ancestor: HTMLElement): boolean;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: HTMLElement, ancestor: String): boolean;
- /**
- * Returns true if node is a descendant of ancestor
- *
- * @param node string id or node reference to test
- * @param ancestor string id or node reference of potential parent to test against
- */
- isDescendant(node: String, ancestor: String): boolean;
- /**
- * locates the last index of the provided value in the passed
- * array. If the value is not found, -1 is returned.
- * This method corresponds to the JavaScript 1.6 Array.lastIndexOf method, with two differences:
- *
- * when run over sparse arrays, the Dojo function invokes the callback for every index
- * whereas JavaScript 1.6's lasIndexOf skips the holes in the sparse array.
- * uses equality (==) rather than strict equality (===)
- * For details on this method, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/lastIndexOf
- *
- * @param arr
- * @param value
- * @param fromIndex Optional
- */
- lastIndexOf(arr: any, value: any, fromIndex?: number): number;
- /**
- *
- * @param f
- */
- loadInit(f: any): void;
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: any[], callback: Function, thisObject: Object, Ctr: any): any[];
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: String, callback: Function, thisObject: Object, Ctr: any): any[];
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: any[], callback: String, thisObject: Object, Ctr: any): any[];
- /**
- * applies callback to each element of arr and returns
- * an Array with the results
- * This function corresponds to the JavaScript 1.6 Array.map() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's map skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/map
- *
- * @param arr the array to iterate on. If a string, operates onindividual characters.
- * @param callback a function is invoked with three arguments, (item, index,array), and returns a value
- * @param thisObject Optionalmay be used to scope the call to callback
- * @param Ctr
- */
- map(arr: String, callback: String, thisObject: Object, Ctr: any): any[];
- /**
- * Getter/setter for the margin-box of node.
- * Getter/setter for the margin-box of node.
- * Returns an object in the expected format of box (regardless
- * if box is passed). The object might look like:
- * { l: 50, t: 200, w: 300: h: 150 }
- * for a node offset from its parent 50px to the left, 200px from
- * the top with a margin width of 300px and a margin-height of
- * 150px.
- *
- * @param node id or reference to DOM Node to get/set box for
- * @param box OptionalIf passed, denotes that dojo.marginBox() shouldupdate/set the margin box for node. Box is an object in theabove format. All properties are optional if passed.
- */
- marginBox(node: HTMLElement, box?: Object): any;
- /**
- * Getter/setter for the margin-box of node.
- * Getter/setter for the margin-box of node.
- * Returns an object in the expected format of box (regardless
- * if box is passed). The object might look like:
- * { l: 50, t: 200, w: 300: h: 150 }
- * for a node offset from its parent 50px to the left, 200px from
- * the top with a margin width of 300px and a margin-height of
- * 150px.
- *
- * @param node id or reference to DOM Node to get/set box for
- * @param box OptionalIf passed, denotes that dojo.marginBox() shouldupdate/set the margin box for node. Box is an object in theabove format. All properties are optional if passed.
- */
- marginBox(node: String, box?: Object): any;
- /**
- * Returns a URL relative to a module.
- *
- * @param module dojo/dom-class
- * @param url Optional
- */
- moduleUrl(module: String, url?: String): String;
- /**
- * Array-like object which adds syntactic
- * sugar for chaining, common iteration operations, animation, and
- * node manipulation. NodeLists are most often returned as the
- * result of dojo/query() calls.
- * NodeList instances provide many utilities that reflect
- * core Dojo APIs for Array iteration and manipulation, DOM
- * manipulation, and event handling. Instead of needing to dig up
- * functions in the dojo package, NodeLists generally make the
- * full power of Dojo available for DOM manipulation tasks in a
- * simple, chainable way.
- *
- * @param array
- */
- NodeList(array: any): any[];
- /**
- * takes a name/value mapping object and returns a string representing
- * a URL-encoded version of that object.
- *
- * @param map
- */
- objectToQuery(map: Object): any;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: HTMLElement, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: HTMLElement, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: String, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: String, position?: String): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: HTMLElement, position?: number): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: HTMLElement, position?: number): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: HTMLElement, refNode: String, position?: number): HTMLElement;
- /**
- * Attempt to insert node into the DOM, choosing from various positioning options.
- * Returns the first argument resolved to a DOM node.
- *
- * @param node id or node reference, or HTML fragment starting with "<" to place relative to refNode
- * @param refNode id or node reference to use as basis for placement
- * @param position Optionalstring noting the position of node relative to refNode or anumber indicating the location in the childNodes collection of refNode.Accepted string values are:beforeafterreplaceonlyfirstlast"first" and "last" indicate positions as children of refNode, "replace" replaces refNode,"only" replaces all children. position defaults to "last" if not specified
- */
- place(node: String, refNode: String, position?: number): HTMLElement;
- /**
- * require one or more modules based on which host environment
- * Dojo is currently operating in
- * This method takes a "map" of arrays which one can use to
- * optionally load dojo modules. The map is indexed by the
- * possible dojo.name values, with two additional values:
- * "default" and "common". The items in the "default" array will
- * be loaded if none of the other items have been choosen based on
- * dojo.name, set by your host environment. The items in the
- * "common" array will always be loaded, regardless of which
- * list is chosen.
- *
- * @param modMap
- */
- platformRequire(modMap: Object): void;
- /**
- * If the context stack contains elements, ensure that
- * subsequent code executes in the previous context to the
- * current context. The current context set ([global,
- * document]) is returned.
- *
- */
- popContext(): void;
- /**
- * Gets the position and size of the passed element relative to
- * the viewport (if includeScroll==false), or relative to the
- * document root (if includeScroll==true).
- * Returns an object of the form:
- * { x: 100, y: 300, w: 20, h: 15 }.
- * If includeScroll==true, the x and y values will include any
- * document offsets that may affect the position relative to the
- * viewport.
- * Uses the border-box model (inclusive of border and padding but
- * not margin). Does not act as a setter.
- *
- * @param node
- * @param includeScroll Optional
- */
- position(node: HTMLElement, includeScroll: boolean): Object;
- /**
- * Gets the position and size of the passed element relative to
- * the viewport (if includeScroll==false), or relative to the
- * document root (if includeScroll==true).
- * Returns an object of the form:
- * { x: 100, y: 300, w: 20, h: 15 }.
- * If includeScroll==true, the x and y values will include any
- * document offsets that may affect the position relative to the
- * viewport.
- * Uses the border-box model (inclusive of border and padding but
- * not margin). Does not act as a setter.
- *
- * @param node
- * @param includeScroll Optional
- */
- position(node: String, includeScroll?: boolean): Object;
- /**
- * Gets or sets a property on an HTML element.
- * Handles normalized getting and setting of properties on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the property on
- * @param name the name of the property to get or set.
- * @param value OptionalThe value to set for the property
- */
- prop(node: HTMLElement, name: String, value?: String): any;
- /**
- * Gets or sets a property on an HTML element.
- * Handles normalized getting and setting of properties on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the property on
- * @param name the name of the property to get or set.
- * @param value OptionalThe value to set for the property
- */
- prop(node: String, name: String, value?: String): any;
- /**
- * Gets or sets a property on an HTML element.
- * Handles normalized getting and setting of properties on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the property on
- * @param name the name of the property to get or set.
- * @param value OptionalThe value to set for the property
- */
- prop(node: HTMLElement, name: Object, value?: String): any;
- /**
- * Gets or sets a property on an HTML element.
- * Handles normalized getting and setting of properties on DOM
- * Nodes. If 2 arguments are passed, and a the second argument is a
- * string, acts as a getter.
- *
- * If a third argument is passed, or if the second argument is a
- * map of attributes, acts as a setter.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to get or set the property on
- * @param name the name of the property to get or set.
- * @param value OptionalThe value to set for the property
- */
- prop(node: String, name: Object, value?: String): any;
- /**
- *
- * @param mid
- */
- provide(mid: any): void;
- /**
- * causes subsequent calls to Dojo methods to assume the
- * passed object and, optionally, document as the default
- * scopes to use. A 2-element array of the previous global and
- * document are returned.
- * dojo.pushContext treats contexts as a stack. The
- * auto-detected contexts which are initially provided using
- * dojo.setContext() require authors to keep state in order to
- * "return" to a previous context, whereas the
- * dojo.pushContext and dojo.popContext methods provide a more
- * natural way to augment blocks of code to ensure that they
- * execute in a different window or frame without issue. If
- * called without any arguments, the default context (the
- * context when Dojo is first loaded) is instead pushed into
- * the stack. If only a single string is passed, a node in the
- * intitial context's document is looked up and its
- * contextWindow and contextDocument properties are used as
- * the context to push. This means that iframes can be given
- * an ID and code can be executed in the scope of the iframe's
- * document in subsequent calls easily.
- *
- * @param g OptionalThe global context. If a string, the id of the frame tosearch for a context and document.
- * @param d OptionalThe document element to execute subsequent code with.
- */
- pushContext(g?: Object, d?: HTMLDocument): void;
- /**
- * causes subsequent calls to Dojo methods to assume the
- * passed object and, optionally, document as the default
- * scopes to use. A 2-element array of the previous global and
- * document are returned.
- * dojo.pushContext treats contexts as a stack. The
- * auto-detected contexts which are initially provided using
- * dojo.setContext() require authors to keep state in order to
- * "return" to a previous context, whereas the
- * dojo.pushContext and dojo.popContext methods provide a more
- * natural way to augment blocks of code to ensure that they
- * execute in a different window or frame without issue. If
- * called without any arguments, the default context (the
- * context when Dojo is first loaded) is instead pushed into
- * the stack. If only a single string is passed, a node in the
- * intitial context's document is looked up and its
- * contextWindow and contextDocument properties are used as
- * the context to push. This means that iframes can be given
- * an ID and code can be executed in the scope of the iframe's
- * document in subsequent calls easily.
- *
- * @param g OptionalThe global context. If a string, the id of the frame tosearch for a context and document.
- * @param d OptionalThe document element to execute subsequent code with.
- */
- pushContext(g?: String, d?: HTMLDocument): void;
- /**
- * Create an object representing a de-serialized query section of a
- * URL. Query keys with multiple values are returned in an array.
- *
- * @param str
- */
- queryToObject(str: String): Object;
- /**
- * Sends an HTTP POST request to the server. In addition to the properties
- * listed for the dojo.__XhrArgs type, the following property is allowed:
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- rawXhrPost(args: Object): any;
- /**
- * Sends an HTTP PUT request to the server. In addition to the properties
- * listed for the dojo.__XhrArgs type, the following property is allowed:
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- rawXhrPut(args: Object): any;
- /**
- * Add a function to execute on DOM content loaded and all requested modules have arrived and been evaluated.
- * In most cases, the domReady plug-in should suffice and this method should not be needed.
- *
- * When called in a non-browser environment, just checks that all requested modules have arrived and been
- * evaluated.
- *
- * @param priority OptionalThe order in which to exec this callback relative to other callbacks, defaults to 1000
- * @param context The context in which to run execute callback, or a callback if not using context
- * @param callback OptionalThe function to execute.
- */
- ready(priority: number, context: any, callback: Function): void;
- /**
- * Maps a module name to a path
- * An unregistered module is given the default path of ../[module],
- * relative to Dojo root. For example, module acme is mapped to
- * ../acme. If you want to use a different module name, use
- * dojo.registerModulePath.
- *
- * @param moduleName
- * @param prefix
- */
- registerModulePath(moduleName: String, prefix: String): void;
- /**
- * Removes an attribute from an HTML element.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute to remove
- */
- removeAttr(node: HTMLElement, name: String): void;
- /**
- * Removes an attribute from an HTML element.
- *
- * @param node id or reference to the element to remove the attribute from
- * @param name the name of the attribute to remove
- */
- removeAttr(node: String, name: String): void;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- removeClass(node: String, classStr?: String): void;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- removeClass(node: HTMLElement, classStr?: String): void;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- removeClass(node: String, classStr?: any[]): void;
- /**
- * Removes the specified classes from node. No contains()
- * check is required.
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param classStr OptionalAn optional String class name to remove, or several space-separatedclass names, or an array of class names. If omitted, all class nameswill be deleted.
- */
- removeClass(node: HTMLElement, classStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: String, addClassStr: String, removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: HTMLElement, addClassStr: String, removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: String, addClassStr: any[], removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: HTMLElement, addClassStr: any[], removeClassStr?: String): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: String, addClassStr: String, removeClassStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: HTMLElement, addClassStr: String, removeClassStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: String, addClassStr: any[], removeClassStr?: any[]): void;
- /**
- * Replaces one or more classes on a node if not present.
- * Operates more quickly than calling dojo.removeClass and dojo.addClass
- *
- * @param node String ID or DomNode reference to remove the class from.
- * @param addClassStr A String class name to add, or several space-separated class names,or an array of class names.
- * @param removeClassStr OptionalA String class name to remove, or several space-separated class names,or an array of class names.
- */
- replaceClass(node: HTMLElement, addClassStr: any[], removeClassStr?: any[]): void;
- /**
- * loads a Javascript module from the appropriate URI
- * Modules are loaded via dojo.require by using one of two loaders: the normal loader
- * and the xdomain loader. The xdomain loader is used when dojo was built with a
- * custom build that specified loader=xdomain and the module lives on a modulePath
- * that is a whole URL, with protocol and a domain. The versions of Dojo that are on
- * the Google and AOL CDNs use the xdomain loader.
- *
- * If the module is loaded via the xdomain loader, it is an asynchronous load, since
- * the module is added via a dynamically created script tag. This
- * means that dojo.require() can return before the module has loaded. However, this
- * should only happen in the case where you do dojo.require calls in the top-level
- * HTML page, or if you purposely avoid the loader checking for dojo.require
- * dependencies in your module by using a syntax like dojo["require"] to load the module.
- *
- * Sometimes it is useful to not have the loader detect the dojo.require calls in the
- * module so that you can dynamically load the modules as a result of an action on the
- * page, instead of right at module load time.
- *
- * Also, for script blocks in an HTML page, the loader does not pre-process them, so
- * it does not know to download the modules before the dojo.require calls occur.
- *
- * So, in those two cases, when you want on-the-fly module loading or for script blocks
- * in the HTML page, special care must be taken if the dojo.required code is loaded
- * asynchronously. To make sure you can execute code that depends on the dojo.required
- * modules, be sure to add the code that depends on the modules in a dojo.addOnLoad()
- * callback. dojo.addOnLoad waits for all outstanding modules to finish loading before
- * executing.
- *
- * This type of syntax works with both xdomain and normal loaders, so it is good
- * practice to always use this idiom for on-the-fly code loading and in HTML script
- * blocks. If at some point you change loaders and where the code is loaded from,
- * it will all still work.
- *
- * More on how dojo.require
- * dojo.require("A.B") first checks to see if symbol A.B is
- * defined. If it is, it is simply returned (nothing to do).
- *
- * If it is not defined, it will look for A/B.js in the script root
- * directory.
- *
- * dojo.require throws an exception if it cannot find a file
- * to load, or if the symbol A.B is not defined after loading.
- *
- * It returns the object A.B, but note the caveats above about on-the-fly loading and
- * HTML script blocks when the xdomain loader is loading a module.
- *
- * dojo.require() does nothing about importing symbols into
- * the current namespace. It is presumed that the caller will
- * take care of that.
- *
- * @param moduleName module name to load, using periods for separators, e.g. "dojo.date.locale". Module paths are de-referenced by dojo'sinternal mapping of locations to names and are disambiguated bylongest prefix. See dojo.registerModulePath() for details onregistering new modules.
- * @param omitModuleCheck Optionalif true, omitModuleCheck skips the step of ensuring that theloaded file actually defines the symbol it is referenced by.For example if it called as dojo.require("a.b.c") and thefile located at a/b/c.js does not define an object a.b.c,and exception will be throws whereas no exception is raisedwhen called as dojo.require("a.b.c", true)
- */
- require(moduleName: String, omitModuleCheck?: boolean): any;
- /**
- * If the condition is true then call dojo.require() for the specified
- * resource
- *
- * @param condition
- * @param moduleName
- * @param omitModuleCheck Optional
- */
- requireAfterIf(condition: boolean, moduleName: String, omitModuleCheck?: boolean): void;
- /**
- * If the condition is true then call dojo.require() for the specified
- * resource
- *
- * @param condition
- * @param moduleName
- * @param omitModuleCheck Optional
- */
- requireIf(condition: boolean, moduleName: String, omitModuleCheck?: boolean): void;
- /**
- *
- * @param moduleName
- * @param bundleName
- * @param locale Optional
- */
- requireLocalization(moduleName: String, bundleName: String, locale?: String): void;
- /**
- * Mix in properties skipping a constructor and decorating functions
- * like it is done by declare().
- * This function is used to mix in properties like lang.mixin does,
- * but it skips a constructor property and decorates functions like
- * declare() does.
- *
- * It is meant to be used with classes and objects produced with
- * declare. Functions mixed in with dojo.safeMixin can use
- * this.inherited() like normal methods.
- *
- * This function is used to implement extend() method of a constructor
- * produced with declare().
- *
- * @param target Target object to accept new properties.
- * @param source Source object for new properties.
- */
- safeMixin(target: Object, source: Object): Object;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- setAttr(node: HTMLElement, name: String, value?: String): any;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- setAttr(node: String, name: String, value?: String): any;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- setAttr(node: HTMLElement, name: Object, value?: String): any;
- /**
- * Sets an attribute on an HTML element.
- * Handles normalized setting of attributes on DOM Nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the attribute on
- * @param name the name of the attribute to set, or a hash of key-value pairs to set.
- * @param value Optionalthe value to set for the attribute, if the name is a string.
- */
- setAttr(node: String, name: Object, value?: String): any;
- /**
- * Sets the size of the node's contents, irrespective of margins,
- * padding, or borders.
- *
- * @param node
- * @param box hash with optional "w", and "h" properties for "width", and "height"respectively. All specified properties should have numeric values in whole pixels.
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- setContentSize(node: HTMLElement, box: Object, computedStyle?: Object): void;
- /**
- * changes the behavior of many core Dojo functions that deal with
- * namespace and DOM lookup, changing them to work in a new global
- * context (e.g., an iframe). The varibles dojo.global and dojo.doc
- * are modified as a result of calling this function and the result of
- * dojo.body() likewise differs.
- *
- * @param globalObject
- * @param globalDocument
- */
- setContext(globalObject: Object, globalDocument: HTMLDocument): void;
- /**
- * sets the size of the node's margin box and placement
- * (left/top), irrespective of box model. Think of it as a
- * passthrough to setBox that handles box-model vagaries for
- * you.
- *
- * @param node
- * @param box hash with optional "l", "t", "w", and "h" properties for "left", "right", "width", and "height"respectively. All specified properties should have numeric values in whole pixels.
- * @param computedStyle OptionalThis parameter accepts computed styles object.If this parameter is omitted, the functions will calldojo/dom-style.getComputedStyle to get one. It is a better way, callingdojo/dom-style.getComputedStyle once, and then pass the reference to thiscomputedStyle parameter. Wherever possible, reuse the returnedobject of dojo/dom-style.getComputedStyle().
- */
- setMarginBox(node: HTMLElement, box: Object, computedStyle?: Object): void;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- setProp(node: HTMLElement, name: String, value?: String): any;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- setProp(node: String, name: String, value?: String): any;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- setProp(node: HTMLElement, name: Object, value?: String): any;
- /**
- * Sets a property on an HTML element.
- * Handles normalized setting of properties on DOM nodes.
- *
- * When passing functions as values, note that they will not be
- * directly assigned to slots on the node, but rather the default
- * behavior will be removed and the new behavior will be added
- * using dojo.connect(), meaning that event handler properties
- * will be normalized and that some caveats with regards to
- * non-standard behaviors for onsubmit apply. Namely that you
- * should cancel form submission using dojo.stopEvent() on the
- * passed event object instead of returning a boolean value from
- * the handler itself.
- *
- * @param node id or reference to the element to set the property on
- * @param name the name of the property to set, or a hash object to setmultiple properties at once.
- * @param value OptionalThe value to set for the property
- */
- setProp(node: String, name: Object, value?: String): any;
- /**
- *
- * @param node
- * @param selectable
- */
- setSelectable(node: any, selectable: any): void;
- /**
- * Sets styles on a node.
- *
- * @param node id or reference to node to set style for
- * @param name the style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- setStyle(node: HTMLElement, name: String, value?: String): String;
- /**
- * Sets styles on a node.
- *
- * @param node id or reference to node to set style for
- * @param name the style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- setStyle(node: String, name: String, value?: String): String;
- /**
- * Sets styles on a node.
- *
- * @param node id or reference to node to set style for
- * @param name the style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- setStyle(node: HTMLElement, name: Object, value?: String): String;
- /**
- * Sets styles on a node.
- *
- * @param node id or reference to node to set style for
- * @param name the style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- setStyle(node: String, name: Object, value?: String): String;
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: any[], callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: String, callback: Function, thisObject?: Object): boolean;
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: any[], callback: String, thisObject?: Object): boolean;
- /**
- * Determines whether or not any item in arr satisfies the
- * condition implemented by callback.
- * This function corresponds to the JavaScript 1.6 Array.some() method, with one difference: when
- * run over sparse arrays, this implementation passes the "holes" in the sparse array to
- * the callback function with a value of undefined. JavaScript 1.6's some skips the holes in the sparse array.
- * For more details, see:
- * https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Objects/Array/some
- *
- * @param arr the array to iterate over. If a string, operates on individual characters.
- * @param callback a function is invoked with three arguments: item, index,and array and returns true if the condition is met.
- * @param thisObject Optionalmay be used to scope the call to callback
- */
- some(arr: String, callback: String, thisObject?: Object): boolean;
- /**
- *
- */
- Stateful(): void;
- /**
- * prevents propagation and clobbers the default action of the
- * passed event
- *
- * @param evt The event object. If omitted, window.event is used on IE.
- */
- stopEvent(evt: Event): void;
- /**
- * Accesses styles on a node. If 2 arguments are
- * passed, acts as a getter. If 3 arguments are passed, acts
- * as a setter.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo.marginBox(),
- * dojo.contentBox() or dojo.position().
- *
- * @param node id or reference to node to get/set style for
- * @param name Optionalthe style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- style(node: HTMLElement, name?: String, value?: String): any;
- /**
- * Accesses styles on a node. If 2 arguments are
- * passed, acts as a getter. If 3 arguments are passed, acts
- * as a setter.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo.marginBox(),
- * dojo.contentBox() or dojo.position().
- *
- * @param node id or reference to node to get/set style for
- * @param name Optionalthe style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- style(node: String, name?: String, value?: String): any;
- /**
- * Accesses styles on a node. If 2 arguments are
- * passed, acts as a getter. If 3 arguments are passed, acts
- * as a setter.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo.marginBox(),
- * dojo.contentBox() or dojo.position().
- *
- * @param node id or reference to node to get/set style for
- * @param name Optionalthe style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- style(node: HTMLElement, name?: Object, value?: String): any;
- /**
- * Accesses styles on a node. If 2 arguments are
- * passed, acts as a getter. If 3 arguments are passed, acts
- * as a setter.
- * Getting the style value uses the computed style for the node, so the value
- * will be a calculated value, not just the immediate node.style value.
- * Also when getting values, use specific style names,
- * like "borderBottomWidth" instead of "border" since compound values like
- * "border" are not necessarily reflected as expected.
- * If you want to get node dimensions, use dojo.marginBox(),
- * dojo.contentBox() or dojo.position().
- *
- * @param node id or reference to node to get/set style for
- * @param name Optionalthe style property to set in DOM-accessor format("borderWidth", not "border-width") or an object with key/valuepairs suitable for setting each property.
- * @param value OptionalIf passed, sets value on the node for style, handlingcross-browser concerns. When setting a pixel value,be sure to include "px" in the value. For instance, top: "200px".Otherwise, in some cases, some browsers will not apply the style.
- */
- style(node: String, name?: Object, value?: String): any;
- /**
- * instantiates an HTML fragment returning the corresponding DOM.
- *
- * @param frag the HTML fragment
- * @param doc Optionaloptional document to use when creating DOM nodes, defaults todojo/_base/window.doc if not specified.
- */
- toDom(frag: String, doc?: HTMLDocument): any;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggleClass(node: String, classStr: String, condition?: boolean): boolean;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggleClass(node: HTMLElement, classStr: String, condition?: boolean): boolean;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggleClass(node: String, classStr: any[], condition?: boolean): boolean;
- /**
- * Adds a class to node if not present, or removes if present.
- * Pass a boolean condition if you want to explicitly add or remove.
- * Returns the condition that was specified directly or indirectly.
- *
- * @param node String ID or DomNode reference to toggle a class string
- * @param classStr A String class name to toggle, or several space-separated class names,or an array of class names.
- * @param condition OptionalIf passed, true means to add the class, false means to remove.Otherwise dojo.hasClass(node, classStr) is used to detect the class presence.
- */
- toggleClass(node: HTMLElement, classStr: any[], condition?: boolean): boolean;
- /**
- * Returns a JSON serialization of an object.
- * Returns a JSON serialization of an object.
- * Note that this doesn't check for infinite recursion, so don't do that!
- * It is recommend that you use dojo/json's stringify function for an lighter
- * and faster implementation that matches the native JSON API and uses the
- * native JSON serializer when available.
- *
- * @param it an object to be serialized. Objects may define their ownserialization via a special "json" or "json" functionproperty. If a specialized serializer has been defined, it willbe used as a fallback.Note that in 1.6, toJson would serialize undefined, but this no longer supportedsince it is not supported by native JSON serializer.
- * @param prettyPrint Optionalif true, we indent objects and arrays to make the output prettier.The variable dojo.toJsonIndentStr is used as the indent string --to use something other than the default (tab), change that variablebefore calling dojo.toJson().Note that if native JSON support is available, it will be used for serialization,and native implementations vary on the exact spacing used in pretty printing.
- */
- toJson(it: Object, prettyPrint?: boolean): any;
- /**
- * converts style value to pixels on IE or return a numeric value.
- *
- * @param node
- * @param value
- */
- toPixelValue(node: HTMLElement, value: String): number;
- /**
- * Remove a topic listener.
- *
- * @param handle The handle returned from a call to subscribe.
- */
- unsubscribe(handle: Object): void;
- /**
- * Transparently applies callbacks to values and/or promises.
- * Accepts promises but also transparently handles non-promises. If no
- * callbacks are provided returns a promise, regardless of the initial
- * value. Foreign promises are converted.
- *
- * If callbacks are provided and the initial value is not a promise,
- * the callback is executed immediately with no error handling. Returns
- * a promise if the initial value is a promise, or the result of the
- * callback otherwise.
- *
- * @param valueOrPromise Either a regular value or an object with a then() method thatfollows the Promises/A specification.
- * @param callback OptionalCallback to be invoked when the promise is resolved, or a non-promiseis received.
- * @param errback OptionalCallback to be invoked when the promise is rejected.
- * @param progback OptionalCallback to be invoked when the promise emits a progress update.
- */
- when(valueOrPromise: any, callback?: Function, errback?: Function, progback?: Function): dojo.promise.Promise<any>;
- /**
- * signal fired by impending window destruction. You may use
- * dojo.addOnWIndowUnload() or dojo.connect() to this method to perform
- * page/application cleanup methods. See dojo.addOnWindowUnload for more info.
- *
- */
- windowUnloaded(): void;
- /**
- * Invoke callback with documentObject as dojo/_base/window::doc.
- * Invoke callback with documentObject as dojo/_base/window::doc. If provided,
- * callback will be executed in the context of object thisObject
- * When callback() returns or throws an error, the dojo/_base/window::doc will
- * be restored to its previous state.
- *
- * @param documentObject
- * @param callback
- * @param thisObject Optional
- * @param cbArguments Optional
- */
- withDoc(documentObject: HTMLDocument, callback: Function, thisObject?: Object, cbArguments?: any[]): any;
- /**
- * Invoke callback with globalObject as dojo.global and
- * globalObject.document as dojo.doc.
- * Invoke callback with globalObject as dojo.global and
- * globalObject.document as dojo.doc. If provided, globalObject
- * will be executed in the context of object thisObject
- * When callback() returns or throws an error, the dojo.global
- * and dojo.doc will be restored to its previous state.
- *
- * @param globalObject
- * @param callback
- * @param thisObject Optional
- * @param cbArguments Optional
- */
- withGlobal(globalObject: Object, callback: Function, thisObject?: Object, cbArguments?: any[]): any;
- /**
- *
- * @param method
- * @param args
- */
- xhr(method: any, args: any): any;
- /**
- * Sends an HTTP DELETE request to the server.
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- xhrDelete(args: Object): any;
- /**
- * Sends an HTTP GET request to the server.
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- xhrGet(args: Object): any;
- /**
- * Sends an HTTP POST request to the server. In addition to the properties
- * listed for the dojo.__XhrArgs type, the following property is allowed:
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- xhrPost(args: Object): any;
- /**
- * Sends an HTTP PUT request to the server. In addition to the properties
- * listed for the dojo.__XhrArgs type, the following property is allowed:
- *
- * @param args An object with the following properties:handleAs (String, optional): Acceptable values are: text (default), json, json-comment-optional,json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlerssync (Boolean, optional): false is default. Indicates whether the request shouldbe a synchronous (blocking) request.headers (Object, optional): Additional HTTP headers to send in the request.failOk (Boolean, optional): false is default. Indicates whether a request should beallowed to fail (and therefore no console error message inthe event of a failure)contentType (String|Boolean): "application/x-www-form-urlencoded" is default. Set to false toprevent a Content-Type header from being sent, or to a stringto send a different Content-Type.load: This function will becalled on a successful HTTP response code.error: This function willbe called when the request fails due to a network or server error, the urlis invalid, etc. It will also be called if the load or handle callback throws anexception, unless djConfig.debugAtAllCosts is true. This allows deployed applicationsto continue to run even when a logic error happens in the callback, while makingit easier to troubleshoot while in debug mode.handle: This function willbe called at the end of every request, whether or not an error occurs.url (String): URL to server endpoint.content (Object, optional): Contains properties with string values. Theseproperties will be serialized as name1=value2 andpassed in the request.timeout (Integer, optional): Milliseconds to wait for the response. If this timepasses, the then error callbacks are called.form (DOMNode, optional): DOM node for a form. Used to extract the form valuesand send to the server.preventCache (Boolean, optional): Default is false. If true, then a"dojo.preventCache" parameter is sent in the requestwith a value that changes with each request(timestamp). Useful only with GET-type requests.rawBody (String, optional): Sets the raw body for an HTTP request. If this is used, then the contentproperty is ignored. This is mostly useful for HTTP methods that havea body to their requests, like PUT or POST. This property can be used insteadof postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.ioPublish (Boolean, optional): Set this explicitly to false to prevent publishing of topics related toIO operations. Otherwise, if djConfig.ioPublish is set to true, topicswill be published via dojo/topic.publish() for different phases of an IO operation.See dojo/main.__IoPublish for a list of topics that are published.
- */
- xhrPut(args: Object): any;
- }
- namespace main {
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.__IoArgs.html
- *
- *
- */
- class __IoArgs {
- constructor();
- /**
- * Contains properties with string values. These
- * properties will be serialized as name1=value2 and
- * passed in the request.
- *
- */
- "content": Object;
- /**
- * DOM node for a form. Used to extract the form values
- * and send to the server.
- *
- */
- "form": HTMLElement;
- /**
- * Acceptable values depend on the type of IO
- * transport (see specific IO calls for more information).
- *
- */
- "handleAs": string;
- /**
- * Set this explicitly to false to prevent publishing of topics related to
- * IO operations. Otherwise, if djConfig.ioPublish is set to true, topics
- * will be published via dojo/topic.publish() for different phases of an IO operation.
- * See dojo/main.__IoPublish for a list of topics that are published.
- *
- */
- "ioPublish": boolean;
- /**
- * Default is false. If true, then a
- * "dojo.preventCache" parameter is sent in the request
- * with a value that changes with each request
- * (timestamp). Useful only with GET-type requests.
- *
- */
- "preventCache": boolean;
- /**
- * Sets the raw body for an HTTP request. If this is used, then the content
- * property is ignored. This is mostly useful for HTTP methods that have
- * a body to their requests, like PUT or POST. This property can be used instead
- * of postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.
- *
- */
- "rawBody": string;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then error callbacks are called.
- *
- */
- "timeout": number;
- /**
- * URL to server endpoint.
- *
- */
- "url": string;
- /**
- * This function will
- * be called when the request fails due to a network or server error, the url
- * is invalid, etc. It will also be called if the load or handle callback throws an
- * exception, unless djConfig.debugAtAllCosts is true. This allows deployed applications
- * to continue to run even when a logic error happens in the callback, while making
- * it easier to troubleshoot while in debug mode.
- *
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- error(response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- /**
- * This function will
- * be called at the end of every request, whether or not an error occurs.
- *
- * @param loadOrError Provides a string that tells you whether this functionwas called because of success (load) or failure (error).
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- handle(loadOrError: String, response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- /**
- * This function will be
- * called on a successful HTTP response code.
- *
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- load(response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.__IoCallbackArgs.html
- *
- *
- */
- class __IoCallbackArgs {
- constructor();
- /**
- * the original object argument to the IO call.
- *
- */
- "args": Object;
- /**
- * For dojo/io/script calls only, indicates
- * whether the script tag that represents the
- * request can be deleted after callbacks have
- * been called. Used internally to know when
- * cleanup can happen on JSONP-type requests.
- *
- */
- "canDelete": boolean;
- /**
- * The final indicator on how the response will be
- * handled.
- *
- */
- "handleAs": string;
- /**
- * For dojo/io/script calls only, the internal
- * script ID used for the request.
- *
- */
- "id": string;
- /**
- * For dojo/io/script calls only: holds the JSON
- * response for JSONP-type requests. Used
- * internally to hold on to the JSON responses.
- * You should not need to access it directly --
- * the same object should be passed to the success
- * callbacks directly.
- *
- */
- "json": Object;
- /**
- * For non-GET requests, the
- * name1=value1&name2=value2 parameters sent up in
- * the request.
- *
- */
- "query": string;
- /**
- * The final URL used for the call. Many times it
- * will be different than the original args.url
- * value.
- *
- */
- "url": string;
- /**
- * For XMLHttpRequest calls only, the
- * XMLHttpRequest object that was used for the
- * request.
- *
- */
- "xhr": Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.__IoPublish.html
- *
- * This is a list of IO topics that can be published
- * if djConfig.ioPublish is set to true. IO topics can be
- * published for any Input/Output, network operation. So,
- * dojo.xhr, dojo.io.script and dojo.io.iframe can all
- * trigger these topics to be published.
- *
- */
- class __IoPublish {
- constructor();
- /**
- * "/dojo/io/done" is sent whenever an IO request has completed,
- * either by loading or by erroring. It passes the error and
- * the dojo.Deferred for the request with the topic.
- *
- */
- "done": string;
- /**
- * "/dojo/io/error" is sent whenever an IO request has errored.
- * It passes the error and the dojo.Deferred
- * for the request with the topic.
- *
- */
- "error": string;
- /**
- * "/dojo/io/load" is sent whenever an IO request has loaded
- * successfully. It passes the response and the dojo.Deferred
- * for the request with the topic.
- *
- */
- "load": string;
- /**
- * "/dojo/io/send" is sent whenever a new IO request is started.
- * It passes the dojo.Deferred for the request with the topic.
- *
- */
- "send": string;
- /**
- * "/dojo/io/start" is sent when there are no outstanding IO
- * requests, and a new IO request is started. No arguments
- * are passed with this topic.
- *
- */
- "start": string;
- /**
- * "/dojo/io/stop" is sent when all outstanding IO requests have
- * finished. No arguments are passed with this topic.
- *
- */
- "stop": string;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.__XhrArgs.html
- *
- * In addition to the properties listed for the dojo._IoArgs type,
- * the following properties are allowed for dojo.xhr* methods.
- *
- */
- class __XhrArgs {
- constructor();
- /**
- * Contains properties with string values. These
- * properties will be serialized as name1=value2 and
- * passed in the request.
- *
- */
- "content": Object;
- /**
- * "application/x-www-form-urlencoded" is default. Set to false to
- * prevent a Content-Type header from being sent, or to a string
- * to send a different Content-Type.
- *
- */
- "contentType": string;
- /**
- * false is default. Indicates whether a request should be
- * allowed to fail (and therefore no console error message in
- * the event of a failure)
- *
- */
- "failOk": boolean;
- /**
- * DOM node for a form. Used to extract the form values
- * and send to the server.
- *
- */
- "form": HTMLElement;
- /**
- * Acceptable values are: text (default), json, json-comment-optional,
- * json-comment-filtered, javascript, xml. See dojo/_base/xhr.contentHandlers
- *
- */
- "handleAs": string;
- /**
- * Additional HTTP headers to send in the request.
- *
- */
- "headers": Object;
- /**
- * Set this explicitly to false to prevent publishing of topics related to
- * IO operations. Otherwise, if djConfig.ioPublish is set to true, topics
- * will be published via dojo/topic.publish() for different phases of an IO operation.
- * See dojo/main.__IoPublish for a list of topics that are published.
- *
- */
- "ioPublish": boolean;
- /**
- * Default is false. If true, then a
- * "dojo.preventCache" parameter is sent in the request
- * with a value that changes with each request
- * (timestamp). Useful only with GET-type requests.
- *
- */
- "preventCache": boolean;
- /**
- * Sets the raw body for an HTTP request. If this is used, then the content
- * property is ignored. This is mostly useful for HTTP methods that have
- * a body to their requests, like PUT or POST. This property can be used instead
- * of postData and putData for dojo/_base/xhr.rawXhrPost and dojo/_base/xhr.rawXhrPut respectively.
- *
- */
- "rawBody": string;
- /**
- * false is default. Indicates whether the request should
- * be a synchronous (blocking) request.
- *
- */
- "sync": boolean;
- /**
- * Milliseconds to wait for the response. If this time
- * passes, the then error callbacks are called.
- *
- */
- "timeout": number;
- /**
- * URL to server endpoint.
- *
- */
- "url": string;
- /**
- * This function will
- * be called when the request fails due to a network or server error, the url
- * is invalid, etc. It will also be called if the load or handle callback throws an
- * exception, unless djConfig.debugAtAllCosts is true. This allows deployed applications
- * to continue to run even when a logic error happens in the callback, while making
- * it easier to troubleshoot while in debug mode.
- *
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- error(response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- /**
- * This function will
- * be called at the end of every request, whether or not an error occurs.
- *
- * @param loadOrError Provides a string that tells you whether this functionwas called because of success (load) or failure (error).
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- handle(loadOrError: String, response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- /**
- * This function will be
- * called on a successful HTTP response code.
- *
- * @param response The response in the format as defined with handleAs.
- * @param ioArgs Provides additional information about the request.
- */
- load(response: Object, ioArgs: dojo.main.__IoCallbackArgs): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.Stateful.html
- *
- * Base class for objects that provide named properties with optional getter/setter
- * control and the ability to watch for property changes
- *
- * The class also provides the functionality to auto-magically manage getters
- * and setters for object attributes/properties.
- *
- * Getters and Setters should follow the format of _xxxGetter or _xxxSetter where
- * the xxx is a name of the attribute to handle. So an attribute of "foo"
- * would have a custom getter of _fooGetter and a custom setter of _fooSetter.
- *
- */
- class Stateful {
- constructor();
- /**
- * Get a property on a Stateful instance.
- * Get a named property on a Stateful object. The property may
- * potentially be retrieved via a getter method in subclasses. In the base class
- * this just retrieves the object's property.
- *
- * @param name The property to get.
- */
- get(name: String): any;
- /**
- *
- * @param params Optional
- */
- postscript(params?: Object): void;
- /**
- * Set a property on a Stateful instance
- * Sets named properties on a stateful object and notifies any watchers of
- * the property. A programmatic setter may be defined in subclasses.
- *
- * @param name The property to set.
- * @param value The value to set in the property.
- */
- set(name: String, value: Object): any;
- /**
- * Watches a property for changes
- *
- * @param name OptionalIndicates the property to watch. This is optional (the callback may be theonly parameter), and if omitted, all the properties will be watched
- * @param callback The function to execute when the property changes. This will be called afterthe property has been changed. The callback will be called with the |this|set to the instance, the first argument as the name of the property, thesecond argument as the old value and the third argument as the new value.
- */
- watch(property: string, callback:{(property?:string, oldValue?:any, newValue?: any):void}) :{unwatch():void};
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main._hasResource.html
- *
- *
- */
- interface _hasResource {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main._contentHandlers.html
- *
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls.
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls. Each contentHandler is
- * called, passing the xhr object for manipulation. The return value
- * from the contentHandler will be passed to the load or handle
- * functions defined in the original xhr call.
- *
- */
- interface _contentHandlers {
- /**
- *
- * @param xhr
- */
- auto(xhr: any): void;
- /**
- * A contentHandler which evaluates the response data, expecting it to be valid JavaScript
- *
- * @param xhr
- */
- javascript(xhr: any): any;
- /**
- * A contentHandler which returns a JavaScript object created from the response data
- *
- * @param xhr
- */
- json(xhr: any): any;
- /**
- * A contentHandler which expects comment-filtered JSON.
- * A contentHandler which expects comment-filtered JSON.
- * the json-comment-filtered option was implemented to prevent
- * "JavaScript Hijacking", but it is less secure than standard JSON. Use
- * standard JSON instead. JSON prefixing can be used to subvert hijacking.
- *
- * Will throw a notice suggesting to use application/json mimetype, as
- * json-commenting can introduce security issues. To decrease the chances of hijacking,
- * use the standard json contentHandler, and prefix your "JSON" with: {}&&
- *
- * use djConfig.useCommentedJson = true to turn off the notice
- *
- * @param xhr
- */
- json_comment_filtered(xhr: any): any;
- /**
- * A contentHandler which checks the presence of comment-filtered JSON and
- * alternates between the json and json-comment-filtered contentHandlers.
- *
- * @param xhr
- */
- json_comment_optional(xhr: any): any;
- /**
- *
- * @param xhr
- */
- olson_zoneinfo(xhr: any): void;
- /**
- * A contentHandler which simply returns the plaintext response data
- *
- * @param xhr
- */
- text(xhr: any): any;
- /**
- * A contentHandler returning an XML Document parsed from the response data
- *
- * @param xhr
- */
- xml(xhr: any): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.cldr.html
- *
- *
- */
- interface cldr {
- /**
- * TODOC
- *
- */
- monetary: Object;
- /**
- * TODOC
- *
- */
- supplemental: Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main._nodeDataCache.html
- *
- *
- */
- interface _nodeDataCache {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.colors.html
- *
- *
- */
- interface colors {
- /**
- * creates a greyscale color with an optional alpha
- *
- * @param g
- * @param a Optional
- */
- makeGrey(g: number, a?: number): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.back.html
- *
- * Browser history management resources
- *
- */
- interface back {
- /**
- * adds a state object (args) to the history list.
- * To support getting back button notifications, the object
- * argument should implement a function called either "back",
- * "backButton", or "handle". The string "back" will be passed as
- * the first and only argument to this callback.
- *
- * To support getting forward button notifications, the object
- * argument should implement a function called either "forward",
- * "forwardButton", or "handle". The string "forward" will be
- * passed as the first and only argument to this callback.
- *
- * If you want the browser location string to change, define "changeUrl" on the object. If the
- * value of "changeUrl" is true, then a unique number will be appended to the URL as a fragment
- * identifier (http://some.domain.com/path#uniquenumber). If it is any other value that does
- * not evaluate to false, that value will be used as the fragment identifier. For example,
- * if changeUrl: 'page1', then the URL will look like: http://some.domain.com/path#page1
- *
- * There are problems with using dojo/back with semantically-named fragment identifiers
- * ("hash values" on an URL). In most browsers it will be hard for dojo/back to know
- * distinguish a back from a forward event in those cases. For back/forward support to
- * work best, the fragment ID should always be a unique value (something using new Date().getTime()
- * for example). If you want to detect hash changes using semantic fragment IDs, then
- * consider using dojo/hash instead (in Dojo 1.4+).
- *
- * @param args The state object that will be added to the history list.
- */
- addToHistory(args: Object): void;
- /**
- *
- */
- getHash(): any;
- /**
- * private method. Do not call this directly.
- *
- */
- goBack(): void;
- /**
- * private method. Do not call this directly.
- *
- */
- goForward(): void;
- /**
- * Initializes the undo stack. This must be called from a
- * block that lives inside the <code><body></code> tag to prevent bugs on IE.
- * </p>
- * <p>Only call this method before the page's DOM is finished loading. Otherwise
- * it will not work. Be careful with xdomain loading or djConfig.debugAtAllCosts scenarios,
- * in order for this method to work, dojo/back will need to be part of a build layer.</p>
- * </div>
- * </div>
- * <div class="jsdoc-field extension-module">
- * <div class="jsdoc-title"><a name="1_9dojo_main_back_setHash"></a><span class="functionIcon">setHash</span><span class="parameters">(h)</span>
- * </div>
- * <div class="jsdoc-inheritance">Defined by <a href="/api/1.9/dojo/back" class="jsdoc-link">dojo/back</a><span title="Must manually require () dojo/back to access" class="jsdoc-extension"></span>
- * </div>
- * <div class="jsdoc-full-summary"></div>
- * <table class="jsdoc-parameters">
- * <tr>
- * <th>Parameter</th>
- * <th>Type</th>
- * <th>Description</th>
- * </tr>
- * <tr>
- * <td class="jsdoc-param-name">h</td>
- * <td class="jsdoc-param-type">undefined</td>
- * <td class="jsdoc-param-description">
- * </td>
- * </tr>
- * </table>
- * </div>
- * <div class="jsdoc-field extension-module">
- * <div class="jsdoc-title"><a name="1_9dojo_main_back_setInitialState"></a><span class="functionIcon">setInitialState</span><span class="parameters">(args)</span>
- * </div>
- * <div class="jsdoc-inheritance">Defined by <a href="/api/1.9/dojo/back" class="jsdoc-link">dojo/back</a><span title="Must manually require () dojo/back to access" class="jsdoc-extension"></span>
- * </div>
- * <div class="jsdoc-full-summary"><p>Sets the state object and back callback for the very first page
- * that is loaded.
- * </p>
- * <p>It is recommended that you call this method as part of an event
- * listener that is registered via dojo/ready.</p>
- * </div>
- * <table class="jsdoc-parameters">
- * <tr>
- * <th>Parameter</th>
- * <th>Type</th>
- * <th>Description</th>
- * </tr>
- * <tr>
- * <td class="jsdoc-param-name">args</td>
- * <td class="jsdoc-param-type">Object</td>
- * <td class="jsdoc-param-description"><p>See the addToHistory() function for the list of valid args properties.</p>
- *
- * </td>
- * </tr>
- * </table>
- * </div>
- * </div>
- * </div>
- * </div><a href="https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dFlDcHEyaHMwbEd4MFBObkNrX0E1MFE6MQ&entry_0=/api/1.9/dojo/main.back" class="feedback">Error in the documentation? Can't find what you are looking for? Let us know!</a>
- */
- init(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.data.html
- *
- *
- */
- interface data {
- /**
- *
- */
- api: Object;
- /**
- *
- */
- util: Object;
- /**
- *
- */
- ItemFileReadStore(): void;
- /**
- *
- */
- ItemFileWriteStore(): void;
- /**
- *
- */
- ObjectStore(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.config.html
- *
- * This module defines the user configuration during bootstrap.
- * By defining user configuration as a module value, an entire configuration can be specified in a build,
- * thereby eliminating the need for sniffing and or explicitly setting in the global variable dojoConfig.
- * Also, when multiple instances of dojo exist in a single application, each will necessarily be located
- * at an unique absolute module identifier as given by the package configuration. Implementing configuration
- * as a module allows for specifying unique, per-instance configurations.
- *
- */
- interface config {
- /**
- * Adds a callback via dojo/ready. Useful when Dojo is added after
- * the page loads and djConfig.afterOnLoad is true. Supports the same
- * arguments as dojo/ready. When using a function reference, use
- * djConfig.addOnLoad = function(){};. For object with function name use
- * djConfig.addOnLoad = [myObject, "functionName"]; and for object with
- * function reference use
- * djConfig.addOnLoad = [myObject, function(){}];
- *
- */
- addOnLoad: Function;
- /**
- *
- */
- afterOnLoad: boolean;
- /**
- *
- */
- baseUrl: Object;
- /**
- * Defines a callback to be used when dependencies are defined before
- * the loader has been loaded. When provided, they cause the loader to
- * execute require(deps, callback) once it has finished loading.
- * Should be used with deps.
- *
- */
- callback: Function;
- /**
- *
- */
- debugContainerId: string;
- /**
- *
- */
- debugHeight: number;
- /**
- * Default duration, in milliseconds, for wipe and fade animations within dijits.
- * Assigned to dijit.defaultDuration.
- *
- */
- defaultDuration: number;
- /**
- * Whether deferred instrumentation should be loaded or included
- * in builds.
- *
- */
- deferredInstrumentation: boolean;
- /**
- * Defines dependencies to be used before the loader has been loaded.
- * When provided, they cause the loader to execute require(deps, callback)
- * once it has finished loading. Should be used with callback.
- *
- */
- deps: Function;
- /**
- * Used by some modules to configure an empty iframe. Used by dojo/io/iframe and
- * dojo/back, and dijit/popup support in IE where an iframe is needed to make sure native
- * controls do not bleed through the popups. Normally this configuration variable
- * does not need to be set, except when using cross-domain/CDN Dojo builds.
- * Save dojo/resources/blank.html to your domain and set djConfig.dojoBlankHtmlUrl
- * to the path on your domain your copy of blank.html.
- *
- */
- dojoBlankHtmlUrl: string;
- /**
- * No default value. Specifies additional locales whose
- * resources should also be loaded alongside the default locale when
- * calls to dojo.requireLocalization() are processed.
- *
- */
- extraLocale: any[];
- /**
- * Set this to true to enable publishing of topics for the different phases of
- * IO operations. Publishing is done via dojo/topic.publish(). See dojo/main.__IoPublish for a list
- * of topics that are published.
- *
- */
- ioPublish: Object;
- /**
- * Defaults to false. If set to true, ensures that Dojo provides
- * extended debugging feedback via Firebug. If Firebug is not available
- * on your platform, setting isDebug to true will force Dojo to
- * pull in (and display) the version of Firebug Lite which is
- * integrated into the Dojo distribution, thereby always providing a
- * debugging/logging console when isDebug is enabled. Note that
- * Firebug's console.* methods are ALWAYS defined by Dojo. If
- * isDebug is false and you are on a platform without Firebug, these
- * methods will be defined as no-ops.
- *
- */
- isDebug: boolean;
- /**
- * The locale to assume for loading localized resources in this page,
- * specified according to RFC 3066.
- * Must be specified entirely in lowercase, e.g. en-us and zh-cn.
- * See the documentation for dojo.i18n and dojo.requireLocalization
- * for details on loading localized resources. If no locale is specified,
- * Dojo assumes the locale of the user agent, according to navigator.userLanguage
- * or navigator.language properties.
- *
- */
- locale: string;
- /**
- * A map of module names to paths relative to dojo.baseUrl. The
- * key/value pairs correspond directly to the arguments which
- * dojo.registerModulePath accepts. Specifying
- * djConfig.modulePaths = { "foo": "../../bar" } is the equivalent
- * of calling dojo.registerModulePath("foo", "../../bar");. Multiple
- * modules may be configured via djConfig.modulePaths.
- *
- */
- modulePaths: Object;
- /**
- * Run the parser after the page is loaded
- *
- */
- parseOnLoad: boolean;
- /**
- * An array of module names to be loaded immediately after dojo.js has been included
- * in a page.
- *
- */
- require: Object;
- /**
- * Array containing the r, g, b components used as transparent color in dojo.Color;
- * if undefined, [255,255,255] (white) will be used.
- *
- */
- transparentColor: any[];
- /**
- * Used by dojox.analytics.Urchin as the default UA-123456-7 account
- * number used when being created. Alternately, you can pass an acct:""
- * parameter to the constructor a la: new dojox.analytics.Urchin({ acct:"UA-123456-7" });
- *
- */
- urchin: string;
- /**
- * If set to a value that evaluates to true such as a string or array and
- * isDebug is true and Firebug is not available or running, then it bypasses
- * the creation of Firebug Lite allowing you to define your own console object.
- *
- */
- useCustomLogger: Object;
- /**
- * Whether the deferred instrumentation should be used.
- *
- * "report-rejections": report each rejection as it occurs.
- * true or 1 or "report-unhandled-rejections": wait 1 second
- * in an attempt to detect unhandled rejections.
- *
- */
- useDeferredInstrumentation: boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.contentHandlers.html
- *
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls.
- * A map of available XHR transport handle types. Name matches the
- * handleAs attribute passed to XHR calls. Each contentHandler is
- * called, passing the xhr object for manipulation. The return value
- * from the contentHandler will be passed to the load or handle
- * functions defined in the original xhr call.
- *
- */
- interface contentHandlers {
- /**
- *
- * @param xhr
- */
- auto(xhr: any): void;
- /**
- * A contentHandler which evaluates the response data, expecting it to be valid JavaScript
- *
- * @param xhr
- */
- javascript(xhr: any): any;
- /**
- * A contentHandler which returns a JavaScript object created from the response data
- *
- * @param xhr
- */
- json(xhr: any): any;
- /**
- * A contentHandler which expects comment-filtered JSON.
- * A contentHandler which expects comment-filtered JSON.
- * the json-comment-filtered option was implemented to prevent
- * "JavaScript Hijacking", but it is less secure than standard JSON. Use
- * standard JSON instead. JSON prefixing can be used to subvert hijacking.
- *
- * Will throw a notice suggesting to use application/json mimetype, as
- * json-commenting can introduce security issues. To decrease the chances of hijacking,
- * use the standard json contentHandler, and prefix your "JSON" with: {}&&
- *
- * use djConfig.useCommentedJson = true to turn off the notice
- *
- * @param xhr
- */
- json_comment_filtered(xhr: any): any;
- /**
- * A contentHandler which checks the presence of comment-filtered JSON and
- * alternates between the json and json-comment-filtered contentHandlers.
- *
- * @param xhr
- */
- json_comment_optional(xhr: any): any;
- /**
- *
- * @param xhr
- */
- olson_zoneinfo(xhr: any): void;
- /**
- * A contentHandler which simply returns the plaintext response data
- *
- * @param xhr
- */
- text(xhr: any): any;
- /**
- * A contentHandler returning an XML Document parsed from the response data
- *
- * @param xhr
- */
- xml(xhr: any): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.date.html
- *
- *
- */
- interface date {
- /**
- * TODOC
- *
- */
- stamp: Object;
- /**
- * Add to a Date in intervals of different size, from milliseconds to years
- *
- * @param date Date object to start with
- * @param interval A string representing the interval. One of the following:"year", "month", "day", "hour", "minute", "second","millisecond", "quarter", "week", "weekday"
- * @param amount How much to add to the date.
- */
- add(date: Date, interval: String, amount: number): any;
- /**
- * Compare two date objects by date, time, or both.
- * Returns 0 if equal, positive if a > b, else negative.
- *
- * @param date1 Date object
- * @param date2 OptionalDate object. If not specified, the current Date is used.
- * @param portion OptionalA string indicating the "date" or "time" portion of a Date object.Compares both "date" and "time" by default. One of the following:"date", "time", "datetime"
- */
- compare(date1: Date, date2?: Date, portion?: String): number;
- /**
- * Get the difference in a specific unit of time (e.g., number of
- * months, weeks, days, etc.) between two dates, rounded to the
- * nearest integer.
- *
- * @param date1 Date object
- * @param date2 OptionalDate object. If not specified, the current Date is used.
- * @param interval OptionalA string representing the interval. One of the following:"year", "month", "day", "hour", "minute", "second","millisecond", "quarter", "week", "weekday"Defaults to "day".
- */
- difference(date1: Date, date2?: Date, interval?: String): any;
- /**
- * Returns the number of days in the month used by dateObject
- *
- * @param dateObject
- */
- getDaysInMonth(dateObject: Date): number;
- /**
- * Get the user's time zone as provided by the browser
- * Try to get time zone info from toString or toLocaleString method of
- * the Date object -- UTC offset is not a time zone. See
- * http://www.twinsun.com/tz/tz-link.htm Note: results may be
- * inconsistent across browsers.
- *
- * @param dateObject Needed because the timezone may vary with time (daylight savings)
- */
- getTimezoneName(dateObject: Date): any;
- /**
- * Determines if the year of the dateObject is a leap year
- * Leap years are years with an additional day YYYY-02-29, where the
- * year number is a multiple of four with the following exception: If
- * a year is a multiple of 100, then it is only a leap year if it is
- * also a multiple of 400. For example, 1900 was not a leap year, but
- * 2000 is one.
- *
- * @param dateObject
- */
- isLeapYear(dateObject: Date): boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.currency.html
- *
- * localized formatting and parsing routines for currencies
- * extends dojo.number to provide culturally-appropriate formatting of values
- * in various world currencies, including use of a currency symbol. The currencies are specified
- * by a three-letter international symbol in all uppercase, and support for the currencies is
- * provided by the data in dojo.cldr. The scripts generating dojo.cldr specify which
- * currency support is included. A fixed number of decimal places is determined based
- * on the currency type and is not determined by the 'pattern' argument. The fractional
- * portion is optional, by default, and variable length decimals are not supported.
- *
- */
- interface currency {
- /**
- * Format a Number as a currency, using locale-specific settings
- * Create a string from a Number using a known, localized pattern.
- * Formatting patterns
- * appropriate to the locale are chosen from the CLDR
- * as well as the appropriate symbols and delimiters and number of decimal places.
- *
- * @param value the number to be formatted.
- * @param options Optional
- */
- format(value: number, options?: dojo.currency.__FormatOptions): any;
- /**
- *
- * @param expression
- * @param options OptionalAn object with the following properties:type (String, optional): Should not be set. Value is assumed to be currency.currency (String, optional): an ISO4217 currency code, a three letter sequence like "USD".For use with dojo.currency only.symbol (String, optional): localized currency symbol. The default will be looked up in table of supported currencies in dojo.cldrA ISO4217 currency code will be used if not found.places (Number, optional): fixed number of decimal places to accept. The default is determined based on which currency is used.fractional (Boolean|Array, optional): Whether to include the fractional portion, where the number of decimal places are implied by the currencyor explicit 'places' parameter. The value [true,false] makes the fractional portion optional.By default for currencies, it the fractional portion is optional.pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization. Literal characters in patterns are not supported.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separators
- */
- parse(expression: String, options?: Object): any;
- /**
- *
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separatorsplaces (Number|String, optional): number of decimal places to accept: Infinity, a positive number, ora range "n,m". Defined by pattern or Infinity if pattern not provided.
- */
- regexp(options: Object): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.dnd.html
- *
- *
- */
- interface dnd {
- /**
- * Used by dojo/dnd/Manager to scroll document or internal node when the user
- * drags near the edge of the viewport or a scrollable node
- *
- */
- autoscroll: Object;
- /**
- *
- */
- move: Object;
- /**
- *
- */
- AutoSource(): void;
- /**
- *
- */
- Avatar(): void;
- /**
- *
- */
- Container(): void;
- /**
- *
- */
- Manager(): void;
- /**
- *
- */
- Moveable(): void;
- /**
- *
- */
- Mover(): void;
- /**
- *
- */
- Selector(): void;
- /**
- *
- */
- Source(): void;
- /**
- *
- */
- Target(): void;
- /**
- *
- */
- TimedMoveable(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.doc.html
- *
- * Alias for the current document. 'doc' can be modified
- * for temporary context shifting. See also withDoc().
- * Use this rather than referring to 'window.document' to ensure your code runs
- * correctly in managed contexts.
- *
- */
- interface doc {
- /**
- *
- */
- documentElement: Object;
- /**
- *
- */
- dojoClick: boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.gears.html
- *
- * TODOC
- *
- */
- interface gears {
- /**
- * True if client is using Google Gears
- *
- */
- available: Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.global.html
- *
- * Alias for the current window. 'global' can be modified
- * for temporary context shifting. See also withGlobal().
- * Use this rather than referring to 'window' to ensure your code runs
- * correctly in managed contexts.
- *
- */
- interface global {
- /**
- *
- */
- $(): any;
- /**
- *
- * @param start
- * @param data
- * @param responseCode
- * @param errorMsg
- */
- GoogleSearchStoreCallback_undefined_NaN(start: any, data: any, responseCode: any, errorMsg: any): void;
- /**
- *
- */
- jQuery(): any;
- /**
- *
- */
- swfIsInHTML(): void;
- /**
- *
- */
- undefined_onload(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.dijit.html
- *
- *
- */
- interface dijit {
- /**
- *
- */
- form: Object;
- /**
- *
- */
- layout: Object;
- /**
- * W3C range API
- *
- */
- range: Object;
- /**
- *
- */
- registry: Object;
- /**
- *
- */
- tree: Object;
- /**
- *
- * @param id
- */
- byId(id: any): any;
- /**
- *
- */
- Calendar(): void;
- /**
- *
- */
- CalendarLite(): void;
- /**
- *
- */
- CheckedMenuItem(): void;
- /**
- *
- */
- ColorPalette(): void;
- /**
- *
- */
- Declaration(): void;
- /**
- *
- */
- Destroyable(): void;
- /**
- *
- */
- Dialog(): void;
- /**
- *
- */
- DialogUnderlay(): void;
- /**
- *
- */
- DropDownMenu(): void;
- /**
- *
- */
- Dye(): void;
- /**
- *
- */
- Editor(): void;
- /**
- *
- */
- Fieldset(): void;
- /**
- *
- */
- InlineEditBox(): void;
- /**
- *
- */
- Menu(): void;
- /**
- *
- */
- MenuBar(): void;
- /**
- *
- */
- MenuBarItem(): void;
- /**
- *
- */
- MenuItem(): void;
- /**
- *
- */
- MenuSeparator(): void;
- /**
- *
- */
- PopupMenuBarItem(): void;
- /**
- *
- */
- PopupMenuItem(): void;
- /**
- *
- */
- ProgressBar(): void;
- /**
- *
- */
- RadioButtonMenuItem(): void;
- /**
- *
- */
- TitlePane(): void;
- /**
- *
- */
- Toolbar(): void;
- /**
- *
- */
- ToolbarSeparator(): void;
- /**
- *
- */
- Tooltip(): void;
- /**
- *
- */
- TooltipDialog(): void;
- /**
- *
- */
- Tree(): void;
- /**
- *
- */
- WidgetSet(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.io.html
- *
- *
- */
- interface io {
- /**
- *
- */
- iframe: Object;
- /**
- * TODOC
- *
- */
- script: Object;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.fx.html
- *
- * Effects library on top of Base animations
- *
- */
- interface fx {
- /**
- * Collection of easing functions to use beyond the default
- * dojo._defaultEasing function.
- *
- */
- easing: Object;
- /**
- * Chain a list of dojo/_base/fx.Animations to run in sequence
- * Return a dojo/_base/fx.Animation which will play all passed
- * dojo/_base/fx.Animation instances in sequence, firing its own
- * synthesized events simulating a single animation. (eg:
- * onEnd of this animation means the end of the chain,
- * not the individual animations within)
- *
- * @param animations
- */
- chain(animations: dojo._base.fx.Animation[]): any;
- /**
- * Combine a list of dojo/_base/fx.Animations to run in parallel
- * Combine an array of dojo/_base/fx.Animations to run in parallel,
- * providing a new dojo/_base/fx.Animation instance encompasing each
- * animation, firing standard animation events.
- *
- * @param animations
- */
- combine(animations: dojo._base.fx.Animation[]): any;
- /**
- * Slide a node to a new top/left position
- * Returns an animation that will slide "node"
- * defined in args Object from its current position to
- * the position defined by (args.left, args.top).
- *
- * @param args A hash-map of standard dojo/_base/fx.Animation constructor properties(such as easing: node: duration: and so on). Special args membersare top and left, which indicate the new position to slide to.
- */
- slideTo(args: Object): any;
- /**
- *
- */
- Toggler(): void;
- /**
- * Expand a node to it's natural height.
- * Returns an animation that will expand the
- * node defined in 'args' object from it's current height to
- * it's natural height (with no scrollbar).
- * Node must have no margin/border/padding.
- *
- * @param args A hash-map of standard dojo/_base/fx.Animation constructor properties(such as easing: node: duration: and so on)
- */
- wipeIn(args: Object): any;
- /**
- * Shrink a node to nothing and hide it.
- * Returns an animation that will shrink node defined in "args"
- * from it's current height to 1px, and then hide it.
- *
- * @param args A hash-map of standard dojo/_base/fx.Animation constructor properties(such as easing: node: duration: and so on)
- */
- wipeOut(args: Object): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.html.html
- *
- * TODOC
- *
- */
- interface html {
- /**
- * inserts (replaces) the given content into the given node. dojo/dom-construct.place(cont, node, "only")
- * may be a better choice for simple HTML insertion.
- * Unless you need to use the params capabilities of this method, you should use
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct..place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct..place does not handle NodeList insertions
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct.place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct.place does not handle NodeList insertions
- * or the other capabilities as defined by the params object for this method.
- *
- * @param node the parent element that will receive the content
- * @param cont the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param params OptionalOptional flags/properties to configure the content-setting. See dojo/html/_ContentSetter
- */
- set(node: HTMLElement, cont: String, params?: Object): any;
- /**
- * inserts (replaces) the given content into the given node. dojo/dom-construct.place(cont, node, "only")
- * may be a better choice for simple HTML insertion.
- * Unless you need to use the params capabilities of this method, you should use
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct..place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct..place does not handle NodeList insertions
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct.place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct.place does not handle NodeList insertions
- * or the other capabilities as defined by the params object for this method.
- *
- * @param node the parent element that will receive the content
- * @param cont the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param params OptionalOptional flags/properties to configure the content-setting. See dojo/html/_ContentSetter
- */
- set(node: HTMLElement, cont: HTMLElement, params?: Object): any;
- /**
- * inserts (replaces) the given content into the given node. dojo/dom-construct.place(cont, node, "only")
- * may be a better choice for simple HTML insertion.
- * Unless you need to use the params capabilities of this method, you should use
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct..place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct..place does not handle NodeList insertions
- * dojo/dom-construct.place(cont, node, "only"). dojo/dom-construct.place() has more robust support for injecting
- * an HTML string into the DOM, but it only handles inserting an HTML string as DOM
- * elements, or inserting a DOM node. dojo/dom-construct.place does not handle NodeList insertions
- * or the other capabilities as defined by the params object for this method.
- *
- * @param node the parent element that will receive the content
- * @param cont the content to be set on the parent element.This can be an html string, a node reference or a NodeList, dojo/NodeList, Array or other enumerable list of nodes
- * @param params OptionalOptional flags/properties to configure the content-setting. See dojo/html/_ContentSetter
- */
- set(node: HTMLElement, cont: NodeList, params?: Object): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.dojox.html
- *
- *
- */
- interface dojox {
- /**
- *
- */
- analytics: Object;
- /**
- *
- */
- app: Object;
- /**
- *
- */
- atom: Object;
- /**
- *
- */
- av: Object;
- /**
- *
- */
- BidiComplex: Object;
- /**
- *
- */
- calc: Object;
- /**
- *
- */
- calendar: Object;
- /**
- *
- */
- charting: Object;
- /**
- *
- */
- collections: Object;
- /**
- *
- */
- color: Object;
- /**
- *
- */
- css3: Object;
- /**
- *
- */
- data: Object;
- /**
- *
- */
- date: Object;
- /**
- *
- */
- dgauges: Object;
- /**
- *
- */
- dnd: Object;
- /**
- *
- */
- drawing: Object;
- /**
- *
- */
- dtl: Object;
- /**
- *
- */
- editor: Object;
- /**
- *
- */
- embed: Object;
- /**
- *
- */
- encoding: Object;
- /**
- *
- */
- enhanced: Object;
- /**
- * Utilities to embed and communicate with the Flash player from Javascript
- *
- */
- flash: Object;
- /**
- *
- */
- form: Object;
- /**
- *
- */
- fx: Object;
- /**
- *
- */
- gantt: Object;
- /**
- *
- */
- gauges: Object;
- /**
- *
- */
- geo: Object;
- /**
- *
- */
- gesture: Object;
- /**
- *
- */
- gfx: Object;
- /**
- *
- */
- gfx3d: Object;
- /**
- *
- */
- grid: Object;
- /**
- *
- */
- help: Object;
- /**
- *
- */
- highlight: Object;
- /**
- *
- */
- html: Object;
- /**
- *
- */
- image: Object;
- /**
- *
- */
- io: Object;
- /**
- *
- */
- jq: Object;
- /**
- *
- */
- json: Object;
- /**
- *
- */
- jsonPath: Object;
- /**
- *
- */
- lang: Object;
- /**
- *
- */
- layout: Object;
- /**
- *
- */
- math: Object;
- /**
- *
- */
- mdnd: Object;
- /**
- *
- */
- mobile: Object;
- /**
- *
- */
- mvc: Object;
- /**
- *
- */
- openlayers: Object;
- /**
- *
- */
- rails: Object;
- /**
- *
- */
- robot: Object;
- /**
- *
- */
- rpc: Object;
- /**
- *
- */
- secure: Object;
- /**
- *
- */
- sketch: Object;
- /**
- *
- */
- sql: Object;
- /**
- *
- */
- string: Object;
- /**
- *
- */
- testing: Object;
- /**
- *
- */
- timing: Object;
- /**
- *
- */
- treemap: Object;
- /**
- *
- */
- uuid: Object;
- /**
- *
- */
- validate: Object;
- /**
- *
- */
- widget: Object;
- /**
- *
- */
- xml: Object;
- /**
- * Provides a simple socket connection using WebSocket, or alternate
- * communication mechanisms in legacy browsers for comet-style communication. This is based
- * on the WebSocket API and returns an object that implements the WebSocket interface:
- * http://dev.w3.org/html5/websockets/#websocket
- * Provides socket connections. This can be used with virtually any Comet protocol.
- *
- * @param argsOrUrl This uses the same arguments as the other I/O functions in Dojo, or aURL to connect to. The URL should be a relative URL in order to properlywork with WebSockets (it can still be host relative, like //other-site.org/endpoint)
- */
- socket(argsOrUrl: Object): any;
- /**
- *
- * @param format
- * @param filler
- */
- sprintf(format: String, filler: any): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.i18n.html
- *
- * This module implements the dojo/i18n! plugin and the v1.6- i18n API
- * We choose to include our own plugin to leverage functionality already contained in dojo
- * and thereby reduce the size of the plugin compared to various loader implementations. Also, this
- * allows foreign AMD loaders to be used without their plugins.
- *
- */
- interface i18n {
- /**
- *
- */
- cache: Object;
- /**
- *
- */
- dynamic: boolean;
- /**
- *
- */
- unitTests: any[];
- /**
- *
- * @param moduleName
- * @param bundleName
- * @param locale
- */
- getL10nName(moduleName: any, bundleName: any, locale: any): String;
- /**
- *
- * @param moduleName
- * @param bundleName
- * @param locale
- */
- getLocalization(moduleName: any, bundleName: any, locale: any): any;
- /**
- * id is in one of the following formats
- *
- * /nls/
- * => load the bundle, localized to config.locale; load all bundles localized to
- * config.extraLocale (if any); return the loaded bundle localized to config.locale.
- * /nls//
- * => load then return the bundle localized to
- * preload/nls//
- * => for config.locale and all config.extraLocale, load all bundles found
- * in the best-matching bundle rollup. A value of 1 is returned, which
- * is meaningless other than to say the plugin is executing the requested
- * preloads
- *
- * In cases 1 and 2, is always normalized to an absolute module id upon entry; see
- * normalize. In case 3, it is assumed to be absolute; this is arranged by the builder.
- *
- * To load a bundle means to insert the bundle into the plugin's cache and publish the bundle
- * value to the loader. Given , , and a particular , the cache key
- *
- * <path>/nls/<bundle>/<locale>
- * will hold the value. Similarly, then plugin will publish this value to the loader by
- *
- * define("<path>/nls/<bundle>/<locale>", <bundle-value>);
- * Given this algorithm, other machinery can provide fast load paths be preplacing
- * values in the plugin's cache, which is public. When a load is demanded the
- * cache is inspected before starting any loading. Explicitly placing values in the plugin
- * cache is an advanced/experimental feature that should not be needed; use at your own risk.
- *
- * For the normal AMD algorithm, the root bundle is loaded first, which instructs the
- * plugin what additional localized bundles are required for a particular locale. These
- * additional locales are loaded and a mix of the root and each progressively-specific
- * locale is returned. For example:
- *
- * The client demands "dojo/i18n!some/path/nls/someBundle
- * The loader demands load(some/path/nls/someBundle)
- * This plugin require's "some/path/nls/someBundle", which is the root bundle.
- * Assuming config.locale is "ab-cd-ef" and the root bundle indicates that localizations
- * are available for "ab" and "ab-cd-ef" (note the missing "ab-cd", then the plugin
- * requires "some/path/nls/ab/someBundle" and "some/path/nls/ab-cd-ef/someBundle"
- * Upon receiving all required bundles, the plugin constructs the value of the bundle
- * ab-cd-ef as...
- * mixin(mixin(mixin({}, require("some/path/nls/someBundle"),
- * require("some/path/nls/ab/someBundle")),
- * require("some/path/nls/ab-cd-ef/someBundle"));
- *
- * This value is inserted into the cache and published to the loader at the
- * key/module-id some/path/nls/someBundle/ab-cd-ef.
- *
- * The special preload signature (case 3) instructs the plugin to stop servicing all normal requests
- * (further preload requests will be serviced) until all ongoing preloading has completed.
- *
- * The preload signature instructs the plugin that a special rollup module is available that contains
- * one or more flattened, localized bundles. The JSON array of available locales indicates which locales
- * are available. Here is an example:
- *
- * *preload*some/path/nls/someModule*["root", "ab", "ab-cd-ef"]
- * This indicates the following rollup modules are available:
- *
- * some/path/nls/someModule_ROOT
- * some/path/nls/someModule_ab
- * some/path/nls/someModule_ab-cd-ef
- * Each of these modules is a normal AMD module that contains one or more flattened bundles in a hash.
- * For example, assume someModule contained the bundles some/bundle/path/someBundle and
- * some/bundle/path/someOtherBundle, then some/path/nls/someModule_ab would be expressed as follows:
- *
- * define({
- * some/bundle/path/someBundle:<value of someBundle, flattened with respect to locale ab>,
- * some/bundle/path/someOtherBundle:<value of someOtherBundle, flattened with respect to locale ab>,
- * });
- * E.g., given this design, preloading for locale=="ab" can execute the following algorithm:
- *
- * require(["some/path/nls/someModule_ab"], function(rollup){
- * for(var p in rollup){
- * var id = p + "/ab",
- * cache[id] = rollup[p];
- * define(id, rollup[p]);
- * }
- * });
- * Similarly, if "ab-cd" is requested, the algorithm can determine that "ab" is the best available and
- * load accordingly.
- *
- * The builder will write such rollups for every layer if a non-empty localeList profile property is
- * provided. Further, the builder will include the following cache entry in the cache associated with
- * any layer.
- *
- * "*now":function(r){r(['dojo/i18n!*preload*<path>/nls/<module>*<JSON array of available locales>']);}
- * The *now special cache module instructs the loader to apply the provided function to context-require
- * with respect to the particular layer being defined. This causes the plugin to hold all normal service
- * requests until all preloading is complete.
- *
- * Notice that this algorithm is rarely better than the standard AMD load algorithm. Consider the normal case
- * where the target locale has a single segment and a layer depends on a single bundle:
- *
- * Without Preloads:
- *
- * Layer loads root bundle.
- * bundle is demanded; plugin loads single localized bundle.
- * With Preloads:
- *
- * Layer causes preloading of target bundle.
- * bundle is demanded; service is delayed until preloading complete; bundle is returned.
- * In each case a single transaction is required to load the target bundle. In cases where multiple bundles
- * are required and/or the locale has multiple segments, preloads still requires a single transaction whereas
- * the normal path requires an additional transaction for each additional bundle/locale-segment. However all
- * of these additional transactions can be done concurrently. Owing to this analysis, the entire preloading
- * algorithm can be discard during a build by setting the has feature dojo-preload-i18n-Api to false.
- *
- * @param id
- * @param require
- * @param load
- */
- load(id: any, require: any, load: any): void;
- /**
- * id may be relative.
- * preload has form *preload*<path>/nls/<module>*<flattened locales> and
- * therefore never looks like a relative
- *
- * @param id
- * @param toAbsMid
- */
- normalize(id: any, toAbsMid: any): any;
- /**
- *
- * @param locale
- */
- normalizeLocale(locale: any): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.scopeMap.html
- *
- *
- */
- interface scopeMap {
- /**
- *
- */
- dijit: any[];
- /**
- *
- */
- dojo: any[];
- /**
- *
- */
- dojox: any[];
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.regexp.html
- *
- * Regular expressions and Builder resources
- *
- */
- interface regexp {
- /**
- * Builds a regular expression that groups subexpressions
- * A utility function used by some of the RE generators. The
- * subexpressions are constructed by the function, re, in the second
- * parameter. re builds one subexpression for each elem in the array
- * a, in the first parameter. Returns a string for a regular
- * expression that groups all the subexpressions.
- *
- * @param arr A single value or an array of values.
- * @param re A function. Takes one parameter and converts it to a regularexpression.
- * @param nonCapture OptionalIf true, uses non-capturing match, otherwise matches are retainedby regular expression. Defaults to false
- */
- buildGroupRE(arr: Object, re: Function, nonCapture?: boolean): any;
- /**
- * Builds a regular expression that groups subexpressions
- * A utility function used by some of the RE generators. The
- * subexpressions are constructed by the function, re, in the second
- * parameter. re builds one subexpression for each elem in the array
- * a, in the first parameter. Returns a string for a regular
- * expression that groups all the subexpressions.
- *
- * @param arr A single value or an array of values.
- * @param re A function. Takes one parameter and converts it to a regularexpression.
- * @param nonCapture OptionalIf true, uses non-capturing match, otherwise matches are retainedby regular expression. Defaults to false
- */
- buildGroupRE(arr: any[], re: Function, nonCapture?: boolean): any;
- /**
- * Adds escape sequences for special characters in regular expressions
- *
- * @param str
- * @param except Optionala String with special characters to be left unescaped
- */
- escapeString(str: String, except?: String): any;
- /**
- * adds group match to expression
- *
- * @param expression
- * @param nonCapture OptionalIf true, uses non-capturing match, otherwise matches are retainedby regular expression.
- */
- group(expression: String, nonCapture?: boolean): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.mouseButtons.html
- *
- *
- */
- interface mouseButtons {
- /**
- * Numeric value of the left mouse button for the platform.
- *
- */
- LEFT: number;
- /**
- * Numeric value of the middle mouse button for the platform.
- *
- */
- MIDDLE: number;
- /**
- * Numeric value of the right mouse button for the platform.
- *
- */
- RIGHT: number;
- /**
- * Checks an event object for a pressed button
- *
- * @param e Event object to examine
- * @param button The button value (example: dojo.mouseButton.LEFT)
- */
- isButton(e: Event, button: number): boolean;
- /**
- * Checks an event object for the pressed left button
- *
- * @param e Event object to examine
- */
- isLeft(e: Event): boolean;
- /**
- * Checks an event object for the pressed middle button
- *
- * @param e Event object to examine
- */
- isMiddle(e: Event): boolean;
- /**
- * Checks an event object for the pressed right button
- *
- * @param e Event object to examine
- */
- isRight(e: Event): boolean;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.rpc.html
- *
- *
- */
- interface rpc {
- /**
- *
- */
- JsonpService(): void;
- /**
- *
- */
- JsonService(): void;
- /**
- *
- */
- RpcService(): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.number.html
- *
- * localized formatting and parsing routines for Number
- *
- */
- interface number_ {
- /**
- * Format a Number as a String, using locale-specific settings
- * Create a string from a Number using a known localized pattern.
- * Formatting patterns appropriate to the locale are chosen from the
- * Common Locale Data Repository as well as the appropriate symbols and
- * delimiters.
- * If value is Infinity, -Infinity, or is not a valid JavaScript number, return null.
- *
- * @param value the number to be formatted
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization. Literal characters in patterns are not supported.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.places (Number, optional): fixed number of decimal places to show. This overrides anyinformation in the provided pattern.round (Number, optional): 5 rounds to nearest .5; 0 rounds to nearest whole (default). -1means do not round.locale (String, optional): override the locale used to determine formatting rulesfractional (Boolean, optional): If false, show no decimal places, overriding places and pattern settings.
- */
- format(value: number, options?: Object): any;
- /**
- * Convert a properly formatted string to a primitive Number, using
- * locale-specific settings.
- * Create a Number from a string using a known localized pattern.
- * Formatting patterns are chosen appropriate to the locale
- * and follow the syntax described by
- * unicode.org TR35
- * Note that literal characters in patterns are not supported.
- *
- * @param expression A string representation of a Number
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization. Literal characters in patterns are not supported.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separatorsfractional (Boolean|Array, optional): Whether to include the fractional portion, where the number of decimal places are implied by patternor explicit 'places' parameter. The value [true,false] makes the fractional portion optional.
- */
- parse(expression: String, options?: Object): number;
- /**
- * Builds the regular needed to parse a number
- * Returns regular expression with positive and negative match, group
- * and decimal separators
- *
- * @param options OptionalAn object with the following properties:pattern (String, optional): override formatting patternwith this string. Default value is based on locale. Overriding this property will defeatlocalization.type (String, optional): choose a format type based on the locale from the following:decimal, scientific (not yet supported), percent, currency. decimal by default.locale (String, optional): override the locale used to determine formatting rulesstrict (Boolean, optional): strict parsing, false by default. Strict parsing requires input as produced by the format() method.Non-strict is more permissive, e.g. flexible on white space, omitting thousands separatorsplaces (Number|String, optional): number of decimal places to accept: Infinity, a positive number, ora range "n,m". Defined by pattern or Infinity if pattern not provided.
- */
- regexp(options?: Object): any;
- /**
- * Rounds to the nearest value with the given number of decimal places, away from zero
- * Rounds to the nearest value with the given number of decimal places, away from zero if equal.
- * Similar to Number.toFixed(), but compensates for browser quirks. Rounding can be done by
- * fractional increments also, such as the nearest quarter.
- * NOTE: Subject to floating point errors. See dojox/math/round for experimental workaround.
- *
- * @param value The number to round
- * @param places OptionalThe number of decimal places where rounding takes place. Defaults to 0 for whole rounding.Must be non-negative.
- * @param increment OptionalRounds next place to nearest value of increment/10. 10 by default.
- */
- round(value: number, places?: number, increment?: number): number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.keys.html
- *
- * Definitions for common key values. Client code should test keyCode against these named constants,
- * as the actual codes can vary by browser.
- *
- */
- interface keys {
- /**
- *
- */
- ALT: number;
- /**
- *
- */
- BACKSPACE: number;
- /**
- *
- */
- CAPS_LOCK: number;
- /**
- *
- */
- CLEAR: number;
- /**
- *
- */
- copyKey: number;
- /**
- *
- */
- CTRL: number;
- /**
- *
- */
- DELETE: number;
- /**
- *
- */
- DOWN_ARROW: number;
- /**
- *
- */
- DOWN_DPAD: number;
- /**
- *
- */
- END: number;
- /**
- *
- */
- ENTER: number;
- /**
- *
- */
- ESCAPE: number;
- /**
- *
- */
- F1: number;
- /**
- *
- */
- F10: number;
- /**
- *
- */
- F11: number;
- /**
- *
- */
- F12: number;
- /**
- *
- */
- F13: number;
- /**
- *
- */
- F14: number;
- /**
- *
- */
- F15: number;
- /**
- *
- */
- F2: number;
- /**
- *
- */
- F3: number;
- /**
- *
- */
- F4: number;
- /**
- *
- */
- F5: number;
- /**
- *
- */
- F6: number;
- /**
- *
- */
- F7: number;
- /**
- *
- */
- F8: number;
- /**
- *
- */
- F9: number;
- /**
- *
- */
- HELP: number;
- /**
- *
- */
- HOME: number;
- /**
- *
- */
- INSERT: number;
- /**
- *
- */
- LEFT_ARROW: number;
- /**
- *
- */
- LEFT_DPAD: number;
- /**
- *
- */
- LEFT_WINDOW: number;
- /**
- *
- */
- META: number;
- /**
- *
- */
- NUM_LOCK: number;
- /**
- *
- */
- NUMPAD_0: number;
- /**
- *
- */
- NUMPAD_1: number;
- /**
- *
- */
- NUMPAD_2: number;
- /**
- *
- */
- NUMPAD_3: number;
- /**
- *
- */
- NUMPAD_4: number;
- /**
- *
- */
- NUMPAD_5: number;
- /**
- *
- */
- NUMPAD_6: number;
- /**
- *
- */
- NUMPAD_7: number;
- /**
- *
- */
- NUMPAD_8: number;
- /**
- *
- */
- NUMPAD_9: number;
- /**
- *
- */
- NUMPAD_DIVIDE: number;
- /**
- *
- */
- NUMPAD_ENTER: number;
- /**
- *
- */
- NUMPAD_MINUS: number;
- /**
- *
- */
- NUMPAD_MULTIPLY: number;
- /**
- *
- */
- NUMPAD_PERIOD: number;
- /**
- *
- */
- NUMPAD_PLUS: number;
- /**
- *
- */
- PAGE_DOWN: number;
- /**
- *
- */
- PAGE_UP: number;
- /**
- *
- */
- PAUSE: number;
- /**
- *
- */
- RIGHT_ARROW: number;
- /**
- *
- */
- RIGHT_DPAD: number;
- /**
- *
- */
- RIGHT_WINDOW: number;
- /**
- *
- */
- SCROLL_LOCK: number;
- /**
- *
- */
- SELECT: number;
- /**
- *
- */
- SHIFT: number;
- /**
- *
- */
- SPACE: number;
- /**
- *
- */
- TAB: number;
- /**
- *
- */
- UP_ARROW: number;
- /**
- *
- */
- UP_DPAD: number;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.tests.html
- *
- * D.O.H. Test files for Dojo unit testing.
- *
- */
- interface tests {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.version.html
- *
- * Version number of the Dojo Toolkit
- * Hash about the version, including
- *
- * major: Integer: Major version. If total version is "1.2.0beta1", will be 1
- * minor: Integer: Minor version. If total version is "1.2.0beta1", will be 2
- * patch: Integer: Patch version. If total version is "1.2.0beta1", will be 0
- * flag: String: Descriptor flag. If total version is "1.2.0beta1", will be "beta1"
- * revision: Number: The Git rev from which dojo was pulled
- *
- */
- interface version {
- /**
- *
- */
- flag: string;
- /**
- *
- */
- major: number;
- /**
- *
- */
- minor: number;
- /**
- *
- */
- patch: number;
- /**
- *
- */
- revision: number;
- /**
- *
- */
- toString(): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.string.html
- *
- * String utilities for Dojo
- *
- */
- interface string_ {
- /**
- * Pad a string to guarantee that it is at least size length by
- * filling with the character ch at either the start or end of the
- * string. Pads at the start, by default.
- *
- * @param text the string to pad
- * @param size length to provide padding
- * @param ch Optionalcharacter to pad, defaults to '0'
- * @param end Optionaladds padding at the end if true, otherwise pads at start
- */
- pad(text: String, size: number, ch?: String, end?: boolean): number;
- /**
- * Efficiently replicate a string n times.
- *
- * @param str the string to replicate
- * @param num number of times to replicate the string
- */
- rep(str: String, num: number): String;
- /**
- * Performs parameterized substitutions on a string. Throws an
- * exception if any parameter is unmatched.
- *
- * @param template a string with expressions in the form ${key} to be replaced or${key:format} which specifies a format function. keys are case-sensitive.
- * @param map hash to search for substitutions
- * @param transform Optionala function to process all parameters before substitution takesplace, e.g. mylib.encodeXML
- * @param thisObject Optionalwhere to look for optional format function; default to the globalnamespace
- */
- substitute(template: String, map: Object, transform?: Function, thisObject?: Object): any;
- /**
- * Performs parameterized substitutions on a string. Throws an
- * exception if any parameter is unmatched.
- *
- * @param template a string with expressions in the form ${key} to be replaced or${key:format} which specifies a format function. keys are case-sensitive.
- * @param map hash to search for substitutions
- * @param transform Optionala function to process all parameters before substitution takesplace, e.g. mylib.encodeXML
- * @param thisObject Optionalwhere to look for optional format function; default to the globalnamespace
- */
- substitute(template: String, map: any[], transform?: Function, thisObject?: Object): any;
- /**
- * Trims whitespace from both sides of the string
- * This version of trim() was taken from Steven Levithan's blog.
- * The short yet performant version of this function is dojo/_base/lang.trim(),
- * which is part of Dojo base. Uses String.prototype.trim instead, if available.
- *
- * @param str String to be trimmed
- */
- trim(str: String): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.touch.html
- *
- * This module provides unified touch event handlers by exporting
- * press, move, release and cancel which can also run well on desktop.
- * Based on http://dvcs.w3.org/hg/webevents/raw-file/tip/touchevents.html
- * Also, if the dojoClick property is set to truthy on a DOM node, dojo/touch generates
- * click events immediately for this node and its descendants (except for descendants that
- * have a dojoClick property set to falsy), to avoid the delay before native browser click events,
- * and regardless of whether evt.preventDefault() was called in a touch.press event listener.
- *
- */
- interface touch {
- /**
- * Register a listener to 'touchcancel'|'mouseleave' for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- cancel(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to mouse.enter or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- enter(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to mouse.leave or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- leave(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener that fires when the mouse cursor or a finger is dragged over the given node.
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- move(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to 'mouseout' or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- out(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to 'mouseover' or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- over(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to 'touchstart'|'mousedown' for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- press(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to releasing the mouse button while the cursor is over the given node
- * (i.e. "mouseup") or for removing the finger from the screen while touching the given node.
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- release(node: HTMLElement, listener: Function): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.store.html
- *
- *
- */
- interface store {
- /**
- *
- */
- util: Object;
- /**
- *
- * @param masterStore
- * @param cachingStore
- * @param options
- */
- Cache(masterStore: any, cachingStore: any, options: any): any;
- /**
- *
- */
- DataStore(): void;
- /**
- *
- */
- JsonRest(): void;
- /**
- *
- */
- Memory(): void;
- /**
- * The Observable store wrapper takes a store and sets an observe method on query()
- * results that can be used to monitor results for changes.
- * Observable wraps an existing store so that notifications can be made when a query
- * is performed.
- *
- * @param store
- */
- Observable(store: dojo.store.api.Store): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/main.window.html
- *
- * TODOC
- *
- */
- interface window {
- /**
- * Get window object associated with document doc.
- *
- * @param doc The document to get the associated window for.
- */
- get(doc: HTMLDocument): any;
- /**
- * Returns the dimensions and scroll position of the viewable area of a browser window
- *
- * @param doc Optional
- */
- getBox(doc?: HTMLDocument): Object;
- /**
- * Scroll the passed node into view using minimal movement, if it is not already.
- *
- * @param node
- * @param pos Optional
- */
- scrollIntoView(node: HTMLElement, pos: Object): void;
- }
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/string.html
- *
- * String utilities for Dojo
- *
- */
- interface string_ {
- /**
- * Pad a string to guarantee that it is at least size length by
- * filling with the character ch at either the start or end of the
- * string. Pads at the start, by default.
- *
- * @param text the string to pad
- * @param size length to provide padding
- * @param ch Optionalcharacter to pad, defaults to '0'
- * @param end Optionaladds padding at the end if true, otherwise pads at start
- */
- pad(text: String, size: number, ch?: String, end?: boolean): number;
- /**
- * Efficiently replicate a string n times.
- *
- * @param str the string to replicate
- * @param num number of times to replicate the string
- */
- rep(str: String, num: number): String;
- /**
- * Performs parameterized substitutions on a string. Throws an
- * exception if any parameter is unmatched.
- *
- * @param template a string with expressions in the form ${key} to be replaced or${key:format} which specifies a format function. keys are case-sensitive.
- * @param map hash to search for substitutions
- * @param transform Optionala function to process all parameters before substitution takesplace, e.g. mylib.encodeXML
- * @param thisObject Optionalwhere to look for optional format function; default to the globalnamespace
- */
- substitute(template: String, map: Object, transform?: Function, thisObject?: Object): any;
- /**
- * Performs parameterized substitutions on a string. Throws an
- * exception if any parameter is unmatched.
- *
- * @param template a string with expressions in the form ${key} to be replaced or${key:format} which specifies a format function. keys are case-sensitive.
- * @param map hash to search for substitutions
- * @param transform Optionala function to process all parameters before substitution takesplace, e.g. mylib.encodeXML
- * @param thisObject Optionalwhere to look for optional format function; default to the globalnamespace
- */
- substitute(template: String, map: any[], transform?: Function, thisObject?: Object): any;
- /**
- * Trims whitespace from both sides of the string
- * This version of trim() was taken from Steven Levithan's blog.
- * The short yet performant version of this function is dojo/_base/lang.trim(),
- * which is part of Dojo base. Uses String.prototype.trim instead, if available.
- *
- * @param str String to be trimmed
- */
- trim(str: String): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/text.html
- *
- * This module implements the dojo/text! plugin and the dojo.cache API.
- * We choose to include our own plugin to leverage functionality already contained in dojo
- * and thereby reduce the size of the plugin compared to various foreign loader implementations.
- * Also, this allows foreign AMD loaders to be used without their plugins.
- *
- * CAUTION: this module is designed to optionally function synchronously to support the dojo v1.x synchronous
- * loader. This feature is outside the scope of the CommonJS plugins specification.
- *
- */
- interface text {
- /**
- *
- */
- dynamic: boolean;
- /**
- *
- * @param id Path to the resource.
- * @param require Object that include the function toUrl with given id returns a valid URL from which to load the text.
- * @param load Callback function which will be called, when the loading finished.
- */
- load(id: String, require: Function, load: Function): void;
- /**
- *
- * @param id
- * @param toAbsMid
- */
- normalize(id: any, toAbsMid: any): String;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/topic.html
- *
- * Pubsub hub.
- *
- */
- interface topic {
- /**
- * Publishes a message to a topic on the pub/sub hub. All arguments after
- * the first will be passed to the subscribers, so any number of arguments
- * can be provided (not just event).
- *
- * @param topic The name of the topic to publish to
- * @param event An event to distribute to the topic listeners
- */
- publish(topic: String, event: Object): any;
- /**
- * Subscribes to a topic on the pub/sub hub
- *
- * @param topic The topic to subscribe to
- * @param listener A function to call when a message is published to the given topic
- */
- subscribe(topic: String, listener: Function): any;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/uacss.html
- *
- * Applies pre-set CSS classes to the top-level HTML node, based on:
- *
- * browser (ex: dj_ie)
- * browser version (ex: dj_ie6)
- * box model (ex: dj_contentBox)
- * text direction (ex: dijitRtl)
- * In addition, browser, browser version, and box model are
- * combined with an RTL flag when browser text is RTL. ex: dj_ie-rtl.
- *
- * Returns the has() method.
- *
- */
- interface uacss {
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/window.html
- *
- * TODOC
- *
- */
- interface window {
- /**
- * Get window object associated with document doc.
- *
- * @param doc The document to get the associated window for.
- */
- get(doc: HTMLDocument): any;
- /**
- * Returns the dimensions and scroll position of the viewable area of a browser window
- *
- * @param doc Optional
- */
- getBox(doc?: HTMLDocument): Object;
- /**
- * Scroll the passed node into view using minimal movement, if it is not already.
- *
- * @param node
- * @param pos Optional
- */
- scrollIntoView(node: HTMLElement, pos: Object): void;
- }
- /**
- * Permalink: http://dojotoolkit.org/api/1.9/dojo/touch.html
- *
- * This module provides unified touch event handlers by exporting
- * press, move, release and cancel which can also run well on desktop.
- * Based on http://dvcs.w3.org/hg/webevents/raw-file/tip/touchevents.html
- * Also, if the dojoClick property is set to truthy on a DOM node, dojo/touch generates
- * click events immediately for this node and its descendants (except for descendants that
- * have a dojoClick property set to falsy), to avoid the delay before native browser click events,
- * and regardless of whether evt.preventDefault() was called in a touch.press event listener.
- *
- */
- interface touch {
- /**
- * Register a listener to 'touchcancel'|'mouseleave' for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- cancel(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to mouse.enter or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- enter(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to mouse.leave or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- leave(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener that fires when the mouse cursor or a finger is dragged over the given node.
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- move(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to 'mouseout' or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- out(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to 'mouseover' or touch equivalent for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- over(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to 'touchstart'|'mousedown' for the given node
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- press(node: HTMLElement, listener: Function): any;
- /**
- * Register a listener to releasing the mouse button while the cursor is over the given node
- * (i.e. "mouseup") or for removing the finger from the screen while touching the given node.
- *
- * @param node Target node to listen to
- * @param listener Callback function
- */
- release(node: HTMLElement, listener: Function): any;
- }
- }
- declare module "dojo/request" {
- var exp: dojo.request
- export=exp;
- }
- declare module "dojo/request.__BaseOptions" {
- var exp: dojo.request.__BaseOptions
- export=exp;
- }
- declare module "dojo/request.__MethodOptions" {
- var exp: dojo.request.__MethodOptions
- export=exp;
- }
- declare module "dojo/request.__Options" {
- var exp: dojo.request.__Options
- export=exp;
- }
- declare module "dojo/request.__Promise" {
- var exp: dojo.request.__Promise
- export=exp;
- }
- declare module "dojo/request/handlers" {
- var exp: dojo.request.handlers
- export=exp;
- }
- declare module "dojo/request/iframe" {
- var exp: dojo.request.iframe
- export=exp;
- }
- declare module "dojo/request/iframe.__MethodOptions" {
- var exp: dojo.request.iframe.__MethodOptions
- export=exp;
- }
- declare module "dojo/request/iframe.__BaseOptions" {
- var exp: dojo.request.iframe.__BaseOptions
- export=exp;
- }
- declare module "dojo/request/iframe.__Options" {
- var exp: dojo.request.iframe.__Options
- export=exp;
- }
- declare module "dojo/request/notify" {
- var exp: dojo.request.notify
- export=exp;
- }
- declare module "dojo/request/registry" {
- var exp: dojo.request.registry
- export=exp;
- }
- declare module "dojo/request/node" {
- var exp: dojo.request.node
- export=exp;
- }
- declare module "dojo/request/node.__MethodOptions" {
- var exp: dojo.request.node.__MethodOptions
- export=exp;
- }
- declare module "dojo/request/node.__Options" {
- var exp: dojo.request.node.__Options
- export=exp;
- }
- declare module "dojo/request/node.__BaseOptions" {
- var exp: dojo.request.node.__BaseOptions
- export=exp;
- }
- declare module "dojo/request/watch" {
- var exp: dojo.request.watch
- export=exp;
- }
- declare module "dojo/request/script" {
- var exp: dojo.request.script
- export=exp;
- }
- declare module "dojo/request/script.__MethodOptions" {
- var exp: dojo.request.script.__MethodOptions
- export=exp;
- }
- declare module "dojo/request/script.__BaseOptions" {
- var exp: dojo.request.script.__BaseOptions
- export=exp;
- }
- declare module "dojo/request/script.__Options" {
- var exp: dojo.request.script.__Options
- export=exp;
- }
- declare module "dojo/request/xhr" {
- var exp: dojo.request.xhr
- export=exp;
- }
- declare module "dojo/request/xhr.__BaseOptions" {
- var exp: dojo.request.xhr.__BaseOptions
- export=exp;
- }
- declare module "dojo/request/xhr.__MethodOptions" {
- var exp: dojo.request.xhr.__MethodOptions
- export=exp;
- }
- declare module "dojo/request/xhr.__Options" {
- var exp: dojo.request.xhr.__Options
- export=exp;
- }
- declare module "dojo/request/default" {
- var exp: dojo.request.default_
- export=exp;
- }
- declare module "dojo/request/util" {
- var exp: dojo.request.util
- export=exp;
- }
- declare module "dojo/AdapterRegistry" {
- var exp: dojo.AdapterRegistry
- export=exp;
- }
- declare module "dojo/cache" {
- var exp: dojo.cache
- export=exp;
- }
- declare module "dojo/cookie" {
- var exp: dojo.cookie
- export=exp;
- }
- declare module "dojo/domReady" {
- var exp: dojo.domReady
- export=exp;
- }
- declare module "dojo/hash" {
- var exp: dojo.hash
- export=exp;
- }
- declare module "dojo/has" {
- var exp: dojo.has
- export=exp;
- }
- declare module "dojo/hccss" {
- var exp: dojo.hccss
- export=exp;
- }
- declare module "dojo/NodeList-data" {
- var exp: dojo.NodeList_data
- export=exp;
- }
- declare module "dojo/NodeList-html" {
- var exp: dojo.NodeList_html
- export=exp;
- }
- declare module "dojo/NodeList-fx" {
- var exp: dojo.NodeList_fx
- export=exp;
- }
- declare module "dojo/NodeList-dom" {
- var exp: dojo.NodeList_dom
- export=exp;
- }
- declare module "dojo/NodeList-manipulate" {
- var exp: dojo.NodeList_manipulate
- export=exp;
- }
- declare module "dojo/NodeList-traverse" {
- var exp: dojo.NodeList_traverse
- export=exp;
- }
- declare module "dojo/on" {
- var exp: dojo.on
- export=exp;
- }
- declare module "dojo/query" {
- var exp: dojo.query
- export=exp;
- }
- declare module "dojo/ready" {
- var exp: dojo.ready
- export=exp;
- }
- declare module "dojo/sniff" {
- var exp: dojo.sniff
- export=exp;
- }
- declare module "dojo/when" {
- var exp: dojo.when
- export=exp;
- }
- declare module "dojo/date" {
- var exp: dojo.date
- export=exp;
- }
- declare module "dojo/date/stamp" {
- var exp: dojo.date.stamp
- export=exp;
- }
- declare module "dojo/date/locale" {
- var exp: dojo.date.locale
- export=exp;
- }
- declare module "dojo/date/locale.__FormatOptions" {
- var exp: dojo.date.locale.__FormatOptions
- export=exp;
- }
- declare module "dojo/fx" {
- var exp: dojo.fx
- export=exp;
- }
- declare module "dojo/fx/Toggler" {
- var exp: dojo.fx.Toggler
- export=exp;
- }
- declare module "dojo/fx/easing" {
- var exp: dojo.fx.easing
- export=exp;
- }
- declare module "dojo/router" {
- var exp: dojo.router
- export=exp;
- }
- declare module "dojo/router/RouterBase" {
- var exp: typeof dojo.router.RouterBase
- export=exp;
- }
- declare module "dojo/aspect" {
- var exp: dojo.aspect
- export=exp;
- }
- declare module "dojo/back" {
- var exp: dojo.back
- export=exp;
- }
- declare module "dojo/colors" {
- var exp: dojo.colors
- export=exp;
- }
- declare module "dojo/currency" {
- var exp: dojo.currency
- export=exp;
- }
- declare module "dojo/currency.__FormatOptions" {
- var exp: dojo.currency.__FormatOptions
- export=exp;
- }
- declare module "dojo/currency.__ParseOptions" {
- var exp: dojo.currency.__ParseOptions
- export=exp;
- }
- declare module "dojo/dom" {
- var exp: dojo.dom
- export=exp;
- }
- declare module "dojo/dom-attr" {
- var exp: dojo.dom_attr
- export=exp;
- }
- declare module "dojo/dom-class" {
- var exp: dojo.dom_class
- export=exp;
- }
- declare module "dojo/dom-form" {
- var exp: dojo.dom_form
- export=exp;
- }
- declare module "dojo/dom-construct" {
- var exp: dojo.dom_construct
- export=exp;
- }
- declare module "dojo/dom-prop" {
- var exp: dojo.dom_prop
- export=exp;
- }
- declare module "dojo/dom-prop.names" {
- var exp: dojo.dom_prop.names
- export=exp;
- }
- declare module "dojo/dom-style" {
- var exp: dojo.dom_style
- export=exp;
- }
- declare module "dojo/dom-geometry" {
- var exp: dojo.dom_geometry
- export=exp;
- }
- declare module "dojo/gears" {
- var exp: dojo.gears
- export=exp;
- }
- declare module "dojo/gears.available" {
- var exp: dojo.gears.available
- export=exp;
- }
- declare module "dojo/html" {
- var exp: dojo.html
- export=exp;
- }
- declare module "dojo/html._ContentSetter" {
- var exp: dojo.html._ContentSetter
- export=exp;
- }
- declare module "dojo/io-query" {
- var exp: dojo.io_query
- export=exp;
- }
- declare module "dojo/i18n" {
- var exp: dojo.i18n
- export=exp;
- }
- declare module "dojo/i18n.cache" {
- var exp: dojo.i18n.cache
- export=exp;
- }
- declare module "dojo/json" {
- var exp: dojo.json
- export=exp;
- }
- declare module "dojo/loadInit" {
- var exp: dojo.loadInit
- export=exp;
- }
- declare module "dojo/keys" {
- var exp: dojo.keys
- export=exp;
- }
- declare module "dojo/mouse" {
- var exp: dojo.mouse
- export=exp;
- }
- declare module "dojo/node" {
- var exp: dojo.node
- export=exp;
- }
- declare module "dojo/number" {
- var exp: dojo.number_
- export=exp;
- }
- declare module "dojo/number.__FormatAbsoluteOptions" {
- var exp: dojo.number_.__FormatAbsoluteOptions
- export=exp;
- }
- declare module "dojo/number.__IntegerRegexpFlags" {
- var exp: dojo.number_.__IntegerRegexpFlags
- export=exp;
- }
- declare module "dojo/number.__FormatOptions" {
- var exp: dojo.number_.__FormatOptions
- export=exp;
- }
- declare module "dojo/number.__RealNumberRegexpFlags" {
- var exp: dojo.number_.__RealNumberRegexpFlags
- export=exp;
- }
- declare module "dojo/number.__ParseOptions" {
- var exp: dojo.number_.__ParseOptions
- export=exp;
- }
- declare module "dojo/number.__RegexpOptions" {
- var exp: dojo.number_.__RegexpOptions
- export=exp;
- }
- declare module "dojo/parser" {
- var exp: dojo.parser
- export=exp;
- }
- declare module "dojo/regexp" {
- var exp: dojo.regexp
- export=exp;
- }
- declare module "dojo/require" {
- var exp: dojo.require
- export=exp;
- }
- declare module "dojo/robotx" {
- var exp: dojo.robotx
- export=exp;
- }
- declare module "dojo/robotx._runsemaphore" {
- var exp: dojo.robotx._runsemaphore
- export=exp;
- }
- declare module "dojo/robot" {
- var exp: dojo.robot
- export=exp;
- }
- declare module "dojo/robot._runsemaphore" {
- var exp: dojo.robot._runsemaphore
- export=exp;
- }
- declare module "dojo/main" {
- var exp: dojo.main
- export=exp;
- }
- declare module "dojo/main.__IoArgs" {
- var exp: dojo.main.__IoArgs
- export=exp;
- }
- declare module "dojo/main.__IoCallbackArgs" {
- var exp: dojo.main.__IoCallbackArgs
- export=exp;
- }
- declare module "dojo/main.__IoPublish" {
- var exp: dojo.main.__IoPublish
- export=exp;
- }
- declare module "dojo/main.__XhrArgs" {
- var exp: dojo.main.__XhrArgs
- export=exp;
- }
- declare module "dojo/main.Stateful" {
- var exp: dojo.main.Stateful
- export=exp;
- }
- declare module "dojo/main._hasResource" {
- var exp: dojo.main._hasResource
- export=exp;
- }
- declare module "dojo/main._contentHandlers" {
- var exp: dojo.main._contentHandlers
- export=exp;
- }
- declare module "dojo/main.cldr" {
- var exp: dojo.main.cldr
- export=exp;
- }
- declare module "dojo/main._nodeDataCache" {
- var exp: dojo.main._nodeDataCache
- export=exp;
- }
- declare module "dojo/main.colors" {
- var exp: dojo.main.colors
- export=exp;
- }
- declare module "dojo/main.back" {
- var exp: dojo.main.back
- export=exp;
- }
- declare module "dojo/main.data" {
- var exp: dojo.main.data
- export=exp;
- }
- declare module "dojo/main.config" {
- var exp: dojo.main.config
- export=exp;
- }
- declare module "dojo/main.contentHandlers" {
- var exp: dojo.main.contentHandlers
- export=exp;
- }
- declare module "dojo/main.date" {
- var exp: dojo.main.date
- export=exp;
- }
- declare module "dojo/main.currency" {
- var exp: dojo.main.currency
- export=exp;
- }
- declare module "dojo/main.dnd" {
- var exp: dojo.main.dnd
- export=exp;
- }
- declare module "dojo/main.doc" {
- var exp: dojo.main.doc
- export=exp;
- }
- declare module "dojo/main.gears" {
- var exp: dojo.main.gears
- export=exp;
- }
- declare module "dojo/main.global" {
- var exp: dojo.main.global
- export=exp;
- }
- declare module "dojo/main.dijit" {
- var exp: dojo.main.dijit
- export=exp;
- }
- declare module "dojo/main.io" {
- var exp: dojo.main.io
- export=exp;
- }
- declare module "dojo/main.fx" {
- var exp: dojo.main.fx
- export=exp;
- }
- declare module "dojo/main.html" {
- var exp: dojo.main.html
- export=exp;
- }
- declare module "dojo/main.dojox" {
- var exp: dojo.main.dojox
- export=exp;
- }
- declare module "dojo/main.i18n" {
- var exp: dojo.main.i18n
- export=exp;
- }
- declare module "dojo/main.scopeMap" {
- var exp: dojo.main.scopeMap
- export=exp;
- }
- declare module "dojo/main.regexp" {
- var exp: dojo.main.regexp
- export=exp;
- }
- declare module "dojo/main.mouseButtons" {
- var exp: dojo.main.mouseButtons
- export=exp;
- }
- declare module "dojo/main.rpc" {
- var exp: dojo.main.rpc
- export=exp;
- }
- declare module "dojo/main.number" {
- var exp: dojo.main.number_
- export=exp;
- }
- declare module "dojo/main.keys" {
- var exp: dojo.main.keys
- export=exp;
- }
- declare module "dojo/main.tests" {
- var exp: dojo.main.tests
- export=exp;
- }
- declare module "dojo/main.version" {
- var exp: dojo.main.version
- export=exp;
- }
- declare module "dojo/main.string" {
- var exp: dojo.main.string_
- export=exp;
- }
- declare module "dojo/main.touch" {
- var exp: dojo.main.touch
- export=exp;
- }
- declare module "dojo/main.store" {
- var exp: dojo.main.store
- export=exp;
- }
- declare module "dojo/main.window" {
- var exp: dojo.main.window
- export=exp;
- }
- declare module "dojo/string" {
- var exp: dojo.string_
- export=exp;
- }
- declare module "dojo/text" {
- var exp: dojo.text
- export=exp;
- }
- declare module "dojo/topic" {
- var exp: dojo.topic
- export=exp;
- }
- declare module "dojo/uacss" {
- var exp: dojo.uacss
- export=exp;
- }
- declare module "dojo/window" {
- var exp: dojo.window
- export=exp;
- }
- declare module "dojo/touch" {
- var exp: dojo.touch
- export=exp;
- }
- declare module "dojo/DeferredList" {
- var exp: typeof dojo.DeferredList
- export=exp;
- }
- declare module "dojo/Deferred" {
- var exp: typeof dojo.Deferred
- export=exp;
- }
- declare module "dojo/Evented" {
- var exp: typeof dojo.Evented
- export=exp;
- }
- declare module "dojo/NodeList" {
- var exp: typeof dojo.NodeList
- export=exp;
- }
- declare module "dojo/NodeList._nodeDataCache" {
- var exp: dojo.NodeList._nodeDataCache
- export=exp;
- }
- declare module "dojo/Stateful" {
- var exp: typeof dojo.Stateful
- export=exp;
- }
- declare module "dojo/_base/declare" {
- var exp: dojo._base.declare
- export=exp;
- }
- declare module "dojo/_base/declare.__DeclareCreatedObject" {
- var exp: dojo._base.declare.__DeclareCreatedObject
- export=exp;
- }
- declare module "dojo/_base/Deferred" {
- var exp: dojo._base.Deferred
- export=exp;
- }
- declare module "dojo/_base/url" {
- var exp: dojo._base.url
- export=exp;
- }
- declare module "dojo/_base/url.authority" {
- var exp: dojo._base.url.authority
- export=exp;
- }
- declare module "dojo/_base/url.password" {
- var exp: dojo._base.url.password
- export=exp;
- }
- declare module "dojo/_base/url.port" {
- var exp: dojo._base.url.port
- export=exp;
- }
- declare module "dojo/_base/url.fragment" {
- var exp: dojo._base.url.fragment
- export=exp;
- }
- declare module "dojo/_base/url.query" {
- var exp: dojo._base.url.query
- export=exp;
- }
- declare module "dojo/_base/url.user" {
- var exp: dojo._base.url.user
- export=exp;
- }
- declare module "dojo/_base/url.scheme" {
- var exp: dojo._base.url.scheme
- export=exp;
- }
- declare module "dojo/_base/xhr" {
- var exp: dojo._base.xhr
- export=exp;
- }
- declare module "dojo/_base/xhr.contentHandlers" {
- var exp: dojo._base.xhr.contentHandlers
- export=exp;
- }
- declare module "dojo/_base/browser" {
- var exp: dojo._base.browser
- export=exp;
- }
- declare module "dojo/_base/array" {
- var exp: dojo._base.array
- export=exp;
- }
- declare module "dojo/_base/connect" {
- var exp: dojo._base.connect
- export=exp;
- }
- declare module "dojo/_base/event" {
- var exp: dojo._base.event
- export=exp;
- }
- declare module "dojo/_base/html" {
- var exp: dojo._base.html
- export=exp;
- }
- declare module "dojo/_base/json" {
- var exp: dojo._base.json
- export=exp;
- }
- declare module "dojo/_base/fx" {
- var exp: dojo._base.fx
- export=exp;
- }
- declare module "dojo/_base/query" {
- var exp: dojo._base.query
- export=exp;
- }
- declare module "dojo/_base/NodeList" {
- var exp: dojo._base.NodeList
- export=exp;
- }
- declare module "dojo/_base/sniff" {
- var exp: dojo._base.sniff
- export=exp;
- }
- declare module "dojo/_base/lang" {
- var exp: dojo._base.lang
- export=exp;
- }
- declare module "dojo/_base/unload" {
- var exp: dojo._base.unload
- export=exp;
- }
- declare module "dojo/_base/window" {
- var exp: dojo._base.window
- export=exp;
- }
- declare module "dojo/_base/window.doc" {
- var exp: dojo._base.window.doc
- export=exp;
- }
- declare module "dojo/_base/window.global" {
- var exp: dojo._base.window.global
- export=exp;
- }
- declare module "dojo/_base/kernel" {
- var exp: dojo._base.kernel
- export=exp;
- }
- declare module "dojo/_base/kernel.__IoCallbackArgs" {
- var exp: dojo._base.kernel.__IoCallbackArgs
- export=exp;
- }
- declare module "dojo/_base/kernel.__IoPublish" {
- var exp: dojo._base.kernel.__IoPublish
- export=exp;
- }
- declare module "dojo/_base/kernel.__IoArgs" {
- var exp: dojo._base.kernel.__IoArgs
- export=exp;
- }
- declare module "dojo/_base/kernel.__XhrArgs" {
- var exp: dojo._base.kernel.__XhrArgs
- export=exp;
- }
- declare module "dojo/_base/kernel.Stateful" {
- var exp: dojo._base.kernel.Stateful
- export=exp;
- }
- declare module "dojo/_base/kernel._contentHandlers" {
- var exp: dojo._base.kernel._contentHandlers
- export=exp;
- }
- declare module "dojo/_base/kernel._hasResource" {
- var exp: dojo._base.kernel._hasResource
- export=exp;
- }
- declare module "dojo/_base/kernel._nodeDataCache" {
- var exp: dojo._base.kernel._nodeDataCache
- export=exp;
- }
- declare module "dojo/_base/kernel.back" {
- var exp: dojo._base.kernel.back
- export=exp;
- }
- declare module "dojo/_base/kernel.cldr" {
- var exp: dojo._base.kernel.cldr
- export=exp;
- }
- declare module "dojo/_base/kernel.colors" {
- var exp: dojo._base.kernel.colors
- export=exp;
- }
- declare module "dojo/_base/kernel.config" {
- var exp: dojo._base.kernel.config
- export=exp;
- }
- declare module "dojo/_base/kernel.contentHandlers" {
- var exp: dojo._base.kernel.contentHandlers
- export=exp;
- }
- declare module "dojo/_base/kernel.dnd" {
- var exp: dojo._base.kernel.dnd
- export=exp;
- }
- declare module "dojo/_base/kernel.date" {
- var exp: dojo._base.kernel.date
- export=exp;
- }
- declare module "dojo/_base/kernel.doc" {
- var exp: dojo._base.kernel.doc
- export=exp;
- }
- declare module "dojo/_base/kernel.data" {
- var exp: dojo._base.kernel.data
- export=exp;
- }
- declare module "dojo/_base/kernel.currency" {
- var exp: dojo._base.kernel.currency
- export=exp;
- }
- declare module "dojo/_base/kernel.dijit" {
- var exp: dojo._base.kernel.dijit
- export=exp;
- }
- declare module "dojo/_base/kernel.global" {
- var exp: dojo._base.kernel.global
- export=exp;
- }
- declare module "dojo/_base/kernel.gears" {
- var exp: dojo._base.kernel.gears
- export=exp;
- }
- declare module "dojo/_base/kernel.fx" {
- var exp: dojo._base.kernel.fx
- export=exp;
- }
- declare module "dojo/_base/kernel.html" {
- var exp: dojo._base.kernel.html
- export=exp;
- }
- declare module "dojo/_base/kernel.io" {
- var exp: dojo._base.kernel.io
- export=exp;
- }
- declare module "dojo/_base/kernel.dojox" {
- var exp: dojo._base.kernel.dojox
- export=exp;
- }
- declare module "dojo/_base/kernel.i18n" {
- var exp: dojo._base.kernel.i18n
- export=exp;
- }
- declare module "dojo/_base/kernel.mouseButtons" {
- var exp: dojo._base.kernel.mouseButtons
- export=exp;
- }
- declare module "dojo/_base/kernel.rpc" {
- var exp: dojo._base.kernel.rpc
- export=exp;
- }
- declare module "dojo/_base/kernel.regexp" {
- var exp: dojo._base.kernel.regexp
- export=exp;
- }
- declare module "dojo/_base/kernel.number" {
- var exp: dojo._base.kernel.number_
- export=exp;
- }
- declare module "dojo/_base/kernel.scopeMap" {
- var exp: dojo._base.kernel.scopeMap
- export=exp;
- }
- declare module "dojo/_base/kernel.tests" {
- var exp: dojo._base.kernel.tests
- export=exp;
- }
- declare module "dojo/_base/kernel.keys" {
- var exp: dojo._base.kernel.keys
- export=exp;
- }
- declare module "dojo/_base/kernel.store" {
- var exp: dojo._base.kernel.store
- export=exp;
- }
- declare module "dojo/_base/kernel.string" {
- var exp: dojo._base.kernel.string_
- export=exp;
- }
- declare module "dojo/_base/kernel.version" {
- var exp: dojo._base.kernel.version
- export=exp;
- }
- declare module "dojo/_base/kernel.touch" {
- var exp: dojo._base.kernel.touch
- export=exp;
- }
- declare module "dojo/_base/kernel.window" {
- var exp: dojo._base.kernel.window
- export=exp;
- }
- declare module "dojo/_base/config" {
- var exp: dojo._base.config
- export=exp;
- }
- declare module "dojo/_base/config.modulePaths" {
- var exp: dojo._base.config.modulePaths
- export=exp;
- }
- declare module "dojo/_base/Color" {
- var exp: typeof dojo._base.Color
- export=exp;
- }
- declare module "dojo/_base/Color.named" {
- var exp: dojo._base.Color.named
- export=exp;
- }
- declare module "dojo/cldr/monetary" {
- var exp: dojo.cldr.monetary
- export=exp;
- }
- declare module "dojo/cldr/supplemental" {
- var exp: dojo.cldr.supplemental
- export=exp;
- }
- declare module "dojo/data/ItemFileReadStore" {
- var exp: typeof dojo.data.ItemFileReadStore
- export=exp;
- }
- declare module "dojo/data/ObjectStore" {
- var exp: typeof dojo.data.ObjectStore
- export=exp;
- }
- declare module "dojo/data/ItemFileWriteStore" {
- var exp: typeof dojo.data.ItemFileWriteStore
- export=exp;
- }
- declare module "dojo/data/api/Item" {
- var exp: typeof dojo.data.api.Item
- export=exp;
- }
- declare module "dojo/data/api/Identity" {
- var exp: typeof dojo.data.api.Identity
- export=exp;
- }
- declare module "dojo/data/api/Request" {
- var exp: typeof dojo.data.api.Request
- export=exp;
- }
- declare module "dojo/data/api/Notification" {
- var exp: typeof dojo.data.api.Notification
- export=exp;
- }
- declare module "dojo/data/api/Read" {
- var exp: typeof dojo.data.api.Read
- export=exp;
- }
- declare module "dojo/data/api/Write" {
- var exp: typeof dojo.data.api.Write
- export=exp;
- }
- declare module "dojo/data/util/filter" {
- var exp: dojo.data.util.filter
- export=exp;
- }
- declare module "dojo/data/util/simpleFetch" {
- var exp: dojo.data.util.simpleFetch
- export=exp;
- }
- declare module "dojo/data/util/sorter" {
- var exp: dojo.data.util.sorter
- export=exp;
- }
- declare module "dojo/dnd/autoscroll" {
- var exp: dojo.dnd.autoscroll
- export=exp;
- }
- declare module "dojo/dnd/autoscroll._validOverflow" {
- var exp: dojo.dnd.autoscroll._validOverflow
- export=exp;
- }
- declare module "dojo/dnd/autoscroll._validNodes" {
- var exp: dojo.dnd.autoscroll._validNodes
- export=exp;
- }
- declare module "dojo/dnd/common" {
- var exp: dojo.dnd.common
- export=exp;
- }
- declare module "dojo/dnd/common._empty" {
- var exp: dojo.dnd.common._empty
- export=exp;
- }
- declare module "dojo/dnd/common._defaultCreatorNodes" {
- var exp: dojo.dnd.common._defaultCreatorNodes
- export=exp;
- }
- declare module "dojo/dnd/move" {
- var exp: dojo.dnd.move
- export=exp;
- }
- declare module "dojo/dnd/move.parentConstrainedMoveable" {
- var exp: dojo.dnd.move.parentConstrainedMoveable
- export=exp;
- }
- declare module "dojo/dnd/move.boxConstrainedMoveable" {
- var exp: dojo.dnd.move.boxConstrainedMoveable
- export=exp;
- }
- declare module "dojo/dnd/move.constrainedMoveable" {
- var exp: dojo.dnd.move.constrainedMoveable
- export=exp;
- }
- declare module "dojo/dnd/Avatar" {
- var exp: typeof dojo.dnd.Avatar
- export=exp;
- }
- declare module "dojo/dnd/Manager" {
- var exp: typeof dojo.dnd.Manager
- export=exp;
- }
- declare module "dojo/dnd/Container" {
- var exp: typeof dojo.dnd.Container
- export=exp;
- }
- declare module "dojo/dnd/Container.__ContainerArgs" {
- var exp: dojo.dnd.Container.__ContainerArgs
- export=exp;
- }
- declare module "dojo/dnd/AutoSource" {
- var exp: typeof dojo.dnd.AutoSource
- export=exp;
- }
- declare module "dojo/dnd/Mover" {
- var exp: typeof dojo.dnd.Mover
- export=exp;
- }
- declare module "dojo/dnd/Moveable" {
- var exp: typeof dojo.dnd.Moveable
- export=exp;
- }
- declare module "dojo/dnd/Moveable.__MoveableArgs" {
- var exp: typeof dojo.dnd.Moveable.__MoveableArgs
- export=exp;
- }
- declare module "dojo/dnd/Selector" {
- var exp: typeof dojo.dnd.Selector
- export=exp;
- }
- declare module "dojo/dnd/TimedMoveable" {
- var exp: typeof dojo.dnd.TimedMoveable
- export=exp;
- }
- declare module "dojo/dnd/Target" {
- var exp: typeof dojo.dnd.Target
- export=exp;
- }
- declare module "dojo/dnd/Source" {
- var exp: typeof dojo.dnd.Source
- export=exp;
- }
- declare module "dojo/errors/create" {
- var exp: dojo.errors.create
- export=exp;
- }
- declare module "dojo/errors/CancelError" {
- var exp: dojo.errors.CancelError
- export=exp;
- }
- declare module "dojo/errors/RequestError" {
- var exp: dojo.errors.RequestError
- export=exp;
- }
- declare module "dojo/errors/RequestTimeoutError" {
- var exp: dojo.errors.RequestTimeoutError
- export=exp;
- }
- declare module "dojo/io/iframe" {
- var exp: dojo.io.iframe
- export=exp;
- }
- declare module "dojo/io/script" {
- var exp: dojo.io.script
- export=exp;
- }
- declare module "dojo/promise/all" {
- var exp: dojo.promise.all
- export=exp;
- }
- declare module "dojo/promise/first" {
- var exp: dojo.promise.first
- export=exp;
- }
- declare module "dojo/promise/instrumentation" {
- var exp: dojo.promise.instrumentation
- export=exp;
- }
- declare module "dojo/promise/tracer" {
- var exp: dojo.promise.tracer
- export=exp;
- }
- declare module "dojo/promise/Promise" {
- interface Promise<T> extends dojo.promise.Promise<T> { }
- export = Promise;
- }
- declare module "dojo/rpc/JsonpService" {
- var exp: typeof dojo.rpc.JsonpService
- export=exp;
- }
- declare module "dojo/rpc/JsonService" {
- var exp: typeof dojo.rpc.JsonService
- export=exp;
- }
- declare module "dojo/rpc/RpcService" {
- var exp: typeof dojo.rpc.RpcService
- export=exp;
- }
- declare module "dojo/selector/lite" {
- var exp: dojo.selector.lite
- export=exp;
- }
- declare module "dojo/selector/acme" {
- var exp: dojo.selector.acme
- export=exp;
- }
- declare module "dojo/selector/_loader" {
- var exp: dojo.selector._loader
- export=exp;
- }
- declare module "dojo/store/Observable" {
- var exp: dojo.store.Observable
- export=exp;
- }
- declare module "dojo/store/Cache" {
- var exp: typeof dojo.store.Cache
- export=exp;
- }
- declare module "dojo/store/DataStore" {
- var exp: typeof dojo.store.DataStore
- export=exp;
- }
- declare module "dojo/store/Memory" {
- var exp: typeof dojo.store.Memory
- export=exp;
- }
- declare module "dojo/store/JsonRest" {
- var exp: typeof dojo.store.JsonRest
- export=exp;
- }
- declare module "dojo/store/api/Store" {
- var exp: typeof dojo.store.api.Store
- export=exp;
- }
- declare module "dojo/store/api/Store.PutDirectives" {
- var exp: typeof dojo.store.api.Store.PutDirectives
- export=exp;
- }
- declare module "dojo/store/api/Store.QueryOptions" {
- var exp: typeof dojo.store.api.Store.QueryOptions
- export=exp;
- }
- declare module "dojo/store/api/Store.QueryResults" {
- var exp: typeof dojo.store.api.Store.QueryResults
- export=exp;
- }
- declare module "dojo/store/api/Store.SortInformation" {
- var exp: typeof dojo.store.api.Store.SortInformation
- export=exp;
- }
- declare module "dojo/store/api/Store.Transaction" {
- var exp: typeof dojo.store.api.Store.Transaction
- export=exp;
- }
- declare module "dojo/store/util/QueryResults" {
- var exp: dojo.store.util.QueryResults
- export=exp;
- }
- declare module "dojo/store/util/SimpleQueryEngine" {
- var exp: dojo.store.util.SimpleQueryEngine
- export=exp;
- }
|