| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881 |
- /*!
- * ui-grid - v4.4.6 - 2018-04-06
- * Copyright (c) 2018 ; License: MIT
- */
- (function () {
- 'use strict';
- angular.module('ui.grid.i18n', []);
- angular.module('ui.grid', ['ui.grid.i18n']);
- })();
- (function () {
- 'use strict';
- /**
- * @ngdoc object
- * @name ui.grid.service:uiGridConstants
- * @description Constants for use across many grid features
- *
- */
- angular.module('ui.grid').constant('uiGridConstants', {
- LOG_DEBUG_MESSAGES: true,
- LOG_WARN_MESSAGES: true,
- LOG_ERROR_MESSAGES: true,
- CUSTOM_FILTERS: /CUSTOM_FILTERS/g,
- COL_FIELD: /COL_FIELD/g,
- MODEL_COL_FIELD: /MODEL_COL_FIELD/g,
- TOOLTIP: /title=\"TOOLTIP\"/g,
- DISPLAY_CELL_TEMPLATE: /DISPLAY_CELL_TEMPLATE/g,
- TEMPLATE_REGEXP: /<.+>/,
- FUNC_REGEXP: /(\([^)]*\))?$/,
- DOT_REGEXP: /\./g,
- APOS_REGEXP: /'/g,
- BRACKET_REGEXP: /^(.*)((?:\s*\[\s*\d+\s*\]\s*)|(?:\s*\[\s*"(?:[^"\\]|\\.)*"\s*\]\s*)|(?:\s*\[\s*'(?:[^'\\]|\\.)*'\s*\]\s*))(.*)$/,
- COL_CLASS_PREFIX: 'ui-grid-col',
- ENTITY_BINDING: '$$this',
- events: {
- GRID_SCROLL: 'uiGridScroll',
- COLUMN_MENU_SHOWN: 'uiGridColMenuShown',
- ITEM_DRAGGING: 'uiGridItemDragStart', // For any item being dragged
- COLUMN_HEADER_CLICK: 'uiGridColumnHeaderClick'
- },
- // copied from http://www.lsauer.com/2011/08/javascript-keymap-keycodes-in-json.html
- keymap: {
- TAB: 9,
- STRG: 17,
- CAPSLOCK: 20,
- CTRL: 17,
- CTRLRIGHT: 18,
- CTRLR: 18,
- SHIFT: 16,
- RETURN: 13,
- ENTER: 13,
- BACKSPACE: 8,
- BCKSP: 8,
- ALT: 18,
- ALTR: 17,
- ALTRIGHT: 17,
- SPACE: 32,
- WIN: 91,
- MAC: 91,
- FN: null,
- PG_UP: 33,
- PG_DOWN: 34,
- UP: 38,
- DOWN: 40,
- LEFT: 37,
- RIGHT: 39,
- ESC: 27,
- DEL: 46,
- F1: 112,
- F2: 113,
- F3: 114,
- F4: 115,
- F5: 116,
- F6: 117,
- F7: 118,
- F8: 119,
- F9: 120,
- F10: 121,
- F11: 122,
- F12: 123
- },
- /**
- * @ngdoc object
- * @name ASC
- * @propertyOf ui.grid.service:uiGridConstants
- * @description Used in {@link ui.grid.class:GridOptions.columnDef#properties_sort columnDef.sort} and
- * {@link ui.grid.class:GridOptions.columnDef#properties_sortDirectionCycle columnDef.sortDirectionCycle}
- * to configure the sorting direction of the column
- */
- ASC: 'asc',
- /**
- * @ngdoc object
- * @name DESC
- * @propertyOf ui.grid.service:uiGridConstants
- * @description Used in {@link ui.grid.class:GridOptions.columnDef#properties_sort columnDef.sort} and
- * {@link ui.grid.class:GridOptions.columnDef#properties_sortDirectionCycle columnDef.sortDirectionCycle}
- * to configure the sorting direction of the column
- */
- DESC: 'desc',
- /**
- * @ngdoc object
- * @name filter
- * @propertyOf ui.grid.service:uiGridConstants
- * @description Used in {@link ui.grid.class:GridOptions.columnDef#properties_filter columnDef.filter}
- * to configure filtering on the column
- *
- * `SELECT` and `INPUT` are used with the `type` property of the filter, the rest are used to specify
- * one of the built-in conditions.
- *
- * Available `condition` options are:
- * - `uiGridConstants.filter.STARTS_WITH`
- * - `uiGridConstants.filter.ENDS_WITH`
- * - `uiGridConstants.filter.CONTAINS`
- * - `uiGridConstants.filter.GREATER_THAN`
- * - `uiGridConstants.filter.GREATER_THAN_OR_EQUAL`
- * - `uiGridConstants.filter.LESS_THAN`
- * - `uiGridConstants.filter.LESS_THAN_OR_EQUAL`
- * - `uiGridConstants.filter.NOT_EQUAL`
- *
- *
- * Available `type` options are:
- * - `uiGridConstants.filter.SELECT` - use a dropdown box for the cell header filter field
- * - `uiGridConstants.filter.INPUT` - use a text box for the cell header filter field
- */
- filter: {
- STARTS_WITH: 2,
- ENDS_WITH: 4,
- EXACT: 8,
- CONTAINS: 16,
- GREATER_THAN: 32,
- GREATER_THAN_OR_EQUAL: 64,
- LESS_THAN: 128,
- LESS_THAN_OR_EQUAL: 256,
- NOT_EQUAL: 512,
- SELECT: 'select',
- INPUT: 'input'
- },
- /**
- * @ngdoc object
- * @name aggregationTypes
- * @propertyOf ui.grid.service:uiGridConstants
- * @description Used in {@link ui.grid.class:GridOptions.columnDef#properties_aggregationType columnDef.aggregationType}
- * to specify the type of built-in aggregation the column should use.
- *
- * Available options are:
- * - `uiGridConstants.aggregationTypes.sum` - add the values in this column to produce the aggregated value
- * - `uiGridConstants.aggregationTypes.count` - count the number of rows to produce the aggregated value
- * - `uiGridConstants.aggregationTypes.avg` - average the values in this column to produce the aggregated value
- * - `uiGridConstants.aggregationTypes.min` - use the minimum value in this column as the aggregated value
- * - `uiGridConstants.aggregationTypes.max` - use the maximum value in this column as the aggregated value
- */
- aggregationTypes: {
- sum: 2,
- count: 4,
- avg: 8,
- min: 16,
- max: 32
- },
- /**
- * @ngdoc array
- * @name CURRENCY_SYMBOLS
- * @propertyOf ui.grid.service:uiGridConstants
- * @description A list of all presently circulating currency symbols that was copied from
- * https://en.wikipedia.org/wiki/Currency_symbol#List_of_presently-circulating_currency_symbols
- *
- * Can be used on {@link ui.grid.class:rowSorter} to create a number string regex that ignores currency symbols.
- */
- CURRENCY_SYMBOLS: ['¤', '؋', 'Ar', 'Ƀ', '฿', 'B/.', 'Br', 'Bs.', 'Bs.F.', 'GH₵', '¢', 'c', 'Ch.', '₡', 'C$', 'D', 'ден',
- 'دج', '.د.ب', 'د.ع', 'JD', 'د.ك', 'ل.د', 'дин', 'د.ت', 'د.م.', 'د.إ', 'Db', '$', '₫', 'Esc', '€', 'ƒ', 'Ft', 'FBu',
- 'FCFA', 'CFA', 'Fr', 'FRw', 'G', 'gr', '₲', 'h', '₴', '₭', 'Kč', 'kr', 'kn', 'MK', 'ZK', 'Kz', 'K', 'L', 'Le', 'лв',
- 'E', 'lp', 'M', 'KM', 'MT', '₥', 'Nfk', '₦', 'Nu.', 'UM', 'T$', 'MOP$', '₱', 'Pt.', '£', 'ج.م.', 'LL', 'LS', 'P', 'Q',
- 'q', 'R', 'R$', 'ر.ع.', 'ر.ق', 'ر.س', '៛', 'RM', 'p', 'Rf.', '₹', '₨', 'SRe', 'Rp', '₪', 'Ksh', 'Sh.So.', 'USh', 'S/',
- 'SDR', 'сом', '৳ ', 'WS$', '₮', 'VT', '₩', '¥', 'zł'],
- /**
- * @ngdoc object
- * @name scrollDirection
- * @propertyOf ui.grid.service:uiGridConstants
- * @description Set on {@link ui.grid.class:Grid#properties_scrollDirection Grid.scrollDirection},
- * to indicate the direction the grid is currently scrolling in
- *
- * Available options are:
- * - `uiGridConstants.scrollDirection.UP` - set when the grid is scrolling up
- * - `uiGridConstants.scrollDirection.DOWN` - set when the grid is scrolling down
- * - `uiGridConstants.scrollDirection.LEFT` - set when the grid is scrolling left
- * - `uiGridConstants.scrollDirection.RIGHT` - set when the grid is scrolling right
- * - `uiGridConstants.scrollDirection.NONE` - set when the grid is not scrolling, this is the default
- */
- scrollDirection: {
- UP: 'up',
- DOWN: 'down',
- LEFT: 'left',
- RIGHT: 'right',
- NONE: 'none'
- },
- /**
- * @ngdoc object
- * @name dataChange
- * @propertyOf ui.grid.service:uiGridConstants
- * @description Used with {@link ui.grid.core.api:PublicApi#methods_notifyDataChange PublicApi.notifyDataChange},
- * {@link ui.grid.class:Grid#methods_callDataChangeCallbacks Grid.callDataChangeCallbacks},
- * and {@link ui.grid.class:Grid#methods_registerDataChangeCallback Grid.registerDataChangeCallback}
- * to specify the type of the event(s).
- *
- * Available options are:
- * - `uiGridConstants.dataChange.ALL` - listeners fired on any of these events, fires listeners on all events.
- * - `uiGridConstants.dataChange.EDIT` - fired when the data in a cell is edited
- * - `uiGridConstants.dataChange.ROW` - fired when a row is added or removed
- * - `uiGridConstants.dataChange.COLUMN` - fired when the column definitions are modified
- * - `uiGridConstants.dataChange.OPTIONS` - fired when the grid options are modified
- */
- dataChange: {
- ALL: 'all',
- EDIT: 'edit',
- ROW: 'row',
- COLUMN: 'column',
- OPTIONS: 'options'
- },
- /**
- * @ngdoc object
- * @name scrollbars
- * @propertyOf ui.grid.service:uiGridConstants
- * @description Used with {@link ui.grid.class:GridOptions#properties_enableHorizontalScrollbar GridOptions.enableHorizontalScrollbar}
- * and {@link ui.grid.class:GridOptions#properties_enableVerticalScrollbar GridOptions.enableVerticalScrollbar}
- * to specify the scrollbar policy for that direction.
- *
- * Available options are:
- * - `uiGridConstants.scrollbars.NEVER` - never show scrollbars in this direction
- * - `uiGridConstants.scrollbars.ALWAYS` - always show scrollbars in this direction
- * - `uiGridConstants.scrollbars.WHEN_NEEDED` - shows scrollbars in this direction when needed
- */
- scrollbars: {
- NEVER: 0,
- ALWAYS: 1,
- WHEN_NEEDED: 2
- }
- });
- })();
- angular.module('ui.grid').directive('uiGridCell', ['$compile', '$parse', 'gridUtil', 'uiGridConstants', function ($compile, $parse, gridUtil, uiGridConstants) {
- var uiGridCell = {
- priority: 0,
- scope: false,
- require: '?^uiGrid',
- compile: function() {
- return {
- pre: function($scope, $elm, $attrs, uiGridCtrl) {
- function compileTemplate() {
- var compiledElementFn = $scope.col.compiledElementFn;
- compiledElementFn($scope, function(clonedElement, scope) {
- $elm.append(clonedElement);
- });
- }
- // If the grid controller is present, use it to get the compiled cell template function
- if (uiGridCtrl && $scope.col.compiledElementFn) {
- compileTemplate();
- }
- // No controller, compile the element manually (for unit tests)
- else {
- if ( uiGridCtrl && !$scope.col.compiledElementFn ){
- // gridUtil.logError('Render has been called before precompile. Please log a ui-grid issue');
- $scope.col.getCompiledElementFn()
- .then(function (compiledElementFn) {
- compiledElementFn($scope, function(clonedElement, scope) {
- $elm.append(clonedElement);
- });
- }).catch(angular.noop);
- }
- else {
- var html = $scope.col.cellTemplate
- .replace(uiGridConstants.MODEL_COL_FIELD, 'row.entity.' + gridUtil.preEval($scope.col.field))
- .replace(uiGridConstants.COL_FIELD, 'grid.getCellValue(row, col)');
- var cellElement = $compile(html)($scope);
- $elm.append(cellElement);
- }
- }
- },
- post: function($scope, $elm, $attrs, uiGridCtrl) {
- var initColClass = $scope.col.getColClass(false);
- $elm.addClass(initColClass);
- var classAdded;
- var updateClass = function( grid ){
- var contents = $elm;
- if ( classAdded ){
- contents.removeClass( classAdded );
- classAdded = null;
- }
- if (angular.isFunction($scope.col.cellClass)) {
- classAdded = $scope.col.cellClass($scope.grid, $scope.row, $scope.col, $scope.rowRenderIndex, $scope.colRenderIndex);
- }
- else {
- classAdded = $scope.col.cellClass;
- }
- contents.addClass(classAdded);
- };
- if ($scope.col.cellClass) {
- updateClass();
- }
-
- // Register a data change watch that would get triggered whenever someone edits a cell or modifies column defs
- var dataChangeDereg = $scope.grid.registerDataChangeCallback( updateClass, [uiGridConstants.dataChange.COLUMN, uiGridConstants.dataChange.EDIT]);
-
- // watch the col and row to see if they change - which would indicate that we've scrolled or sorted or otherwise
- // changed the row/col that this cell relates to, and we need to re-evaluate cell classes and maybe other things
- var cellChangeFunction = function( n, o ){
- if ( n !== o ) {
- if ( classAdded || $scope.col.cellClass ){
- updateClass();
- }
- // See if the column's internal class has changed
- var newColClass = $scope.col.getColClass(false);
- if (newColClass !== initColClass) {
- $elm.removeClass(initColClass);
- $elm.addClass(newColClass);
- initColClass = newColClass;
- }
- }
- };
- // TODO(c0bra): Turn this into a deep array watch
- /* shouldn't be needed any more given track by col.name
- var colWatchDereg = $scope.$watch( 'col', cellChangeFunction );
- */
- var rowWatchDereg = $scope.$watch( 'row', cellChangeFunction );
-
-
- var deregisterFunction = function() {
- dataChangeDereg();
- // colWatchDereg();
- rowWatchDereg();
- };
-
- $scope.$on( '$destroy', deregisterFunction );
- $elm.on( '$destroy', deregisterFunction );
- }
- };
- }
- };
- return uiGridCell;
- }]);
- (function(){
- angular.module('ui.grid')
- .service('uiGridColumnMenuService', [ 'i18nService', 'uiGridConstants', 'gridUtil',
- function ( i18nService, uiGridConstants, gridUtil ) {
- /**
- * @ngdoc service
- * @name ui.grid.service:uiGridColumnMenuService
- *
- * @description Services for working with column menus, factored out
- * to make the code easier to understand
- */
- var service = {
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:uiGridColumnMenuService
- * @name initialize
- * @description Sets defaults, puts a reference to the $scope on
- * the uiGridController
- * @param {$scope} $scope the $scope from the uiGridColumnMenu
- * @param {controller} uiGridCtrl the uiGridController for the grid
- * we're on
- *
- */
- initialize: function( $scope, uiGridCtrl ){
- $scope.grid = uiGridCtrl.grid;
- // Store a reference to this link/controller in the main uiGrid controller
- // to allow showMenu later
- uiGridCtrl.columnMenuScope = $scope;
- // Save whether we're shown or not so the columns can check
- $scope.menuShown = false;
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:uiGridColumnMenuService
- * @name setColMenuItemWatch
- * @description Setup a watch on $scope.col.menuItems, and update
- * menuItems based on this. $scope.col needs to be set by the column
- * before calling the menu.
- * @param {$scope} $scope the $scope from the uiGridColumnMenu
- * @param {controller} uiGridCtrl the uiGridController for the grid
- * we're on
- *
- */
- setColMenuItemWatch: function ( $scope ){
- var deregFunction = $scope.$watch('col.menuItems', function (n) {
- if (typeof(n) !== 'undefined' && n && angular.isArray(n)) {
- n.forEach(function (item) {
- if (typeof(item.context) === 'undefined' || !item.context) {
- item.context = {};
- }
- item.context.col = $scope.col;
- });
- $scope.menuItems = $scope.defaultMenuItems.concat(n);
- }
- else {
- $scope.menuItems = $scope.defaultMenuItems;
- }
- });
- $scope.$on( '$destroy', deregFunction );
- },
- /**
- * @ngdoc boolean
- * @name enableSorting
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description (optional) True by default. When enabled, this setting adds sort
- * widgets to the column header, allowing sorting of the data in the individual column.
- */
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:uiGridColumnMenuService
- * @name sortable
- * @description determines whether this column is sortable
- * @param {$scope} $scope the $scope from the uiGridColumnMenu
- *
- */
- sortable: function( $scope ) {
- if ( $scope.grid.options.enableSorting && typeof($scope.col) !== 'undefined' && $scope.col && $scope.col.enableSorting) {
- return true;
- }
- else {
- return false;
- }
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:uiGridColumnMenuService
- * @name isActiveSort
- * @description determines whether the requested sort direction is current active, to
- * allow highlighting in the menu
- * @param {$scope} $scope the $scope from the uiGridColumnMenu
- * @param {string} direction the direction that we'd have selected for us to be active
- *
- */
- isActiveSort: function( $scope, direction ){
- return (typeof($scope.col) !== 'undefined' && typeof($scope.col.sort) !== 'undefined' &&
- typeof($scope.col.sort.direction) !== 'undefined' && $scope.col.sort.direction === direction);
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:uiGridColumnMenuService
- * @name suppressRemoveSort
- * @description determines whether we should suppress the removeSort option
- * @param {$scope} $scope the $scope from the uiGridColumnMenu
- *
- */
- suppressRemoveSort: function( $scope ) {
- if ($scope.col && $scope.col.suppressRemoveSort) {
- return true;
- }
- else {
- return false;
- }
- },
- /**
- * @ngdoc boolean
- * @name enableHiding
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description (optional) True by default. When set to false, this setting prevents a user from hiding the column
- * using the column menu or the grid menu.
- */
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:uiGridColumnMenuService
- * @name hideable
- * @description determines whether a column can be hidden, by checking the enableHiding columnDef option
- * @param {$scope} $scope the $scope from the uiGridColumnMenu
- *
- */
- hideable: function( $scope ) {
- if (typeof($scope.col) !== 'undefined' && $scope.col && $scope.col.colDef && $scope.col.colDef.enableHiding === false ) {
- return false;
- }
- else {
- return true;
- }
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:uiGridColumnMenuService
- * @name getDefaultMenuItems
- * @description returns the default menu items for a column menu
- * @param {$scope} $scope the $scope from the uiGridColumnMenu
- *
- */
- getDefaultMenuItems: function( $scope ){
- return [
- {
- title: function(){return i18nService.getSafeText('sort.ascending');},
- icon: 'ui-grid-icon-sort-alt-up',
- action: function($event) {
- $event.stopPropagation();
- $scope.sortColumn($event, uiGridConstants.ASC);
- },
- shown: function () {
- return service.sortable( $scope );
- },
- active: function() {
- return service.isActiveSort( $scope, uiGridConstants.ASC);
- }
- },
- {
- title: function(){return i18nService.getSafeText('sort.descending');},
- icon: 'ui-grid-icon-sort-alt-down',
- action: function($event) {
- $event.stopPropagation();
- $scope.sortColumn($event, uiGridConstants.DESC);
- },
- shown: function() {
- return service.sortable( $scope );
- },
- active: function() {
- return service.isActiveSort( $scope, uiGridConstants.DESC);
- }
- },
- {
- title: function(){return i18nService.getSafeText('sort.remove');},
- icon: 'ui-grid-icon-cancel',
- action: function ($event) {
- $event.stopPropagation();
- $scope.unsortColumn();
- },
- shown: function() {
- return service.sortable( $scope ) &&
- typeof($scope.col) !== 'undefined' && (typeof($scope.col.sort) !== 'undefined' &&
- typeof($scope.col.sort.direction) !== 'undefined') && $scope.col.sort.direction !== null &&
- !service.suppressRemoveSort( $scope );
- }
- },
- {
- title: function(){return i18nService.getSafeText('column.hide');},
- icon: 'ui-grid-icon-cancel',
- shown: function() {
- return service.hideable( $scope );
- },
- action: function ($event) {
- $event.stopPropagation();
- $scope.hideColumn();
- }
- }
- ];
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:uiGridColumnMenuService
- * @name getColumnElementPosition
- * @description gets the position information needed to place the column
- * menu below the column header
- * @param {$scope} $scope the $scope from the uiGridColumnMenu
- * @param {GridCol} column the column we want to position below
- * @param {element} $columnElement the column element we want to position below
- * @returns {hash} containing left, top, offset, height, width
- *
- */
- getColumnElementPosition: function( $scope, column, $columnElement ){
- var positionData = {};
- positionData.left = $columnElement[0].offsetLeft;
- positionData.top = $columnElement[0].offsetTop;
- positionData.parentLeft = $columnElement[0].offsetParent.offsetLeft;
- // Get the grid scrollLeft
- positionData.offset = 0;
- if (column.grid.options.offsetLeft) {
- positionData.offset = column.grid.options.offsetLeft;
- }
- positionData.height = gridUtil.elementHeight($columnElement, true);
- positionData.width = gridUtil.elementWidth($columnElement, true);
- return positionData;
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:uiGridColumnMenuService
- * @name repositionMenu
- * @description Reposition the menu below the new column. If the menu has no child nodes
- * (i.e. it's not currently visible) then we guess it's width at 100, we'll be called again
- * later to fix it
- * @param {$scope} $scope the $scope from the uiGridColumnMenu
- * @param {GridCol} column the column we want to position below
- * @param {hash} positionData a hash containing left, top, offset, height, width
- * @param {element} $elm the column menu element that we want to reposition
- * @param {element} $columnElement the column element that we want to reposition underneath
- *
- */
- repositionMenu: function( $scope, column, positionData, $elm, $columnElement ) {
- var menu = $elm[0].querySelectorAll('.ui-grid-menu');
- // It's possible that the render container of the column we're attaching to is
- // offset from the grid (i.e. pinned containers), we need to get the difference in the offsetLeft
- // between the render container and the grid
- var renderContainerElm = gridUtil.closestElm($columnElement, '.ui-grid-render-container');
- var renderContainerOffset = renderContainerElm.getBoundingClientRect().left - $scope.grid.element[0].getBoundingClientRect().left;
- var containerScrollLeft = renderContainerElm.querySelectorAll('.ui-grid-viewport')[0].scrollLeft;
- // repositionMenu is now always called after it's visible in the DOM,
- // allowing us to simply get the width every time the menu is opened
- var myWidth = gridUtil.elementWidth(menu, true);
- var paddingRight = column.lastMenuPaddingRight ? column.lastMenuPaddingRight : ( $scope.lastMenuPaddingRight ? $scope.lastMenuPaddingRight : 10);
- if ( menu.length !== 0 ){
- var mid = menu[0].querySelectorAll('.ui-grid-menu-mid');
- if ( mid.length !== 0 ) {
- // TODO(c0bra): use padding-left/padding-right based on document direction (ltr/rtl), place menu on proper side
- // Get the column menu right padding
- paddingRight = parseInt(gridUtil.getStyles(angular.element(menu)[0])['paddingRight'], 10);
- $scope.lastMenuPaddingRight = paddingRight;
- column.lastMenuPaddingRight = paddingRight;
- }
- }
- var left = positionData.left + renderContainerOffset - containerScrollLeft + positionData.parentLeft + positionData.width + paddingRight;
- if (left < positionData.offset + myWidth) {
- left = Math.max(positionData.left - containerScrollLeft + positionData.parentLeft - paddingRight + myWidth, positionData.offset + myWidth);
- }
- $elm.css('left', left + 'px');
- $elm.css('top', (positionData.top + positionData.height) + 'px');
- }
- };
- return service;
- }])
- .directive('uiGridColumnMenu', ['$timeout', 'gridUtil', 'uiGridConstants', 'uiGridColumnMenuService', '$document',
- function ($timeout, gridUtil, uiGridConstants, uiGridColumnMenuService, $document) {
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridColumnMenu
- * @description Provides the column menu framework, leverages uiGridMenu underneath
- *
- */
- var uiGridColumnMenu = {
- priority: 0,
- scope: true,
- require: '^uiGrid',
- templateUrl: 'ui-grid/uiGridColumnMenu',
- replace: true,
- link: function ($scope, $elm, $attrs, uiGridCtrl) {
- uiGridColumnMenuService.initialize( $scope, uiGridCtrl );
- $scope.defaultMenuItems = uiGridColumnMenuService.getDefaultMenuItems( $scope );
- // Set the menu items for use with the column menu. The user can later add additional items via the watch
- $scope.menuItems = $scope.defaultMenuItems;
- uiGridColumnMenuService.setColMenuItemWatch( $scope );
- /**
- * @ngdoc method
- * @methodOf ui.grid.directive:uiGridColumnMenu
- * @name showMenu
- * @description Shows the column menu. If the menu is already displayed it
- * calls the menu to ask it to hide (it will animate), then it repositions the menu
- * to the right place whilst hidden (it will make an assumption on menu width),
- * then it asks the menu to show (it will animate), then it repositions the menu again
- * once we can calculate it's size.
- * @param {GridCol} column the column we want to position below
- * @param {element} $columnElement the column element we want to position below
- */
- $scope.showMenu = function(column, $columnElement, event) {
- // Swap to this column
- $scope.col = column;
- // Get the position information for the column element
- var colElementPosition = uiGridColumnMenuService.getColumnElementPosition( $scope, column, $columnElement );
- if ($scope.menuShown) {
- // we want to hide, then reposition, then show, but we want to wait for animations
- // we set a variable, and then rely on the menu-hidden event to call the reposition and show
- $scope.colElement = $columnElement;
- $scope.colElementPosition = colElementPosition;
- $scope.hideThenShow = true;
- $scope.$broadcast('hide-menu', { originalEvent: event });
- } else {
- $scope.menuShown = true;
- $scope.colElement = $columnElement;
- $scope.colElementPosition = colElementPosition;
- $scope.$broadcast('show-menu', { originalEvent: event });
- }
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.directive:uiGridColumnMenu
- * @name hideMenu
- * @description Hides the column menu.
- * @param {boolean} broadcastTrigger true if we were triggered by a broadcast
- * from the menu itself - in which case don't broadcast again as we'll get
- * an infinite loop
- */
- $scope.hideMenu = function( broadcastTrigger ) {
- $scope.menuShown = false;
- if ( !broadcastTrigger ){
- $scope.$broadcast('hide-menu');
- }
- };
- $scope.$on('menu-hidden', function() {
- var menuItems = angular.element($elm[0].querySelector('.ui-grid-menu-items'))[0];
- $elm[0].removeAttribute('style');
- if ( $scope.hideThenShow ){
- delete $scope.hideThenShow;
- $scope.$broadcast('show-menu');
- $scope.menuShown = true;
- } else {
- $scope.hideMenu( true );
- if ($scope.col) {
- //Focus on the menu button
- gridUtil.focus.bySelector($document, '.ui-grid-header-cell.' + $scope.col.getColClass()+ ' .ui-grid-column-menu-button', $scope.col.grid, false);
- }
- }
- if (menuItems) {
- menuItems.onkeydown = null;
- angular.forEach(menuItems.children, function removeHandlers(item) {
- item.onkeydown = null;
- });
- }
- });
- $scope.$on('menu-shown', function() {
- $timeout( function() {
- uiGridColumnMenuService.repositionMenu( $scope, $scope.col, $scope.colElementPosition, $elm, $scope.colElement );
- //automatically set the focus to the first button element in the now open menu.
- gridUtil.focus.bySelector($document, '.ui-grid-menu-items .ui-grid-menu-item:not(.ng-hide)', true);
- delete $scope.colElementPosition;
- delete $scope.columnElement;
- addKeydownHandlersToMenu();
- });
- });
- /* Column methods */
- $scope.sortColumn = function (event, dir) {
- event.stopPropagation();
- $scope.grid.sortColumn($scope.col, dir, true)
- .then(function () {
- $scope.grid.refresh();
- $scope.hideMenu();
- }).catch(angular.noop);
- };
- $scope.unsortColumn = function () {
- $scope.col.unsort();
- $scope.grid.refresh();
- $scope.hideMenu();
- };
- function addKeydownHandlersToMenu() {
- var menu = angular.element($elm[0].querySelector('.ui-grid-menu-items'))[0],
- menuItems,
- visibleMenuItems = [];
- if (menu) {
- menu.onkeydown = function closeMenu(event) {
- if (event.keyCode === uiGridConstants.keymap.ESC) {
- event.preventDefault();
- $scope.hideMenu();
- }
- };
- menuItems = menu.querySelectorAll('.ui-grid-menu-item:not(.ng-hide)');
- angular.forEach(menuItems, function filterVisibleItems(item) {
- if (item.offsetParent !== null) {
- this.push(item);
- }
- }, visibleMenuItems);
- if (visibleMenuItems.length) {
- if (visibleMenuItems.length === 1) {
- visibleMenuItems[0].onkeydown = function singleItemHandler(event) {
- circularFocusHandler(event, true);
- };
- } else {
- visibleMenuItems[0].onkeydown = function firstItemHandler(event) {
- circularFocusHandler(event, false, event.shiftKey, visibleMenuItems.length - 1);
- };
- visibleMenuItems[visibleMenuItems.length - 1].onkeydown = function lastItemHandler(event) {
- circularFocusHandler(event, false, !event.shiftKey, 0);
- };
- }
- }
- }
- function circularFocusHandler(event, isSingleItem, shiftKeyStatus, index) {
- if (event.keyCode === uiGridConstants.keymap.TAB) {
- if (isSingleItem) {
- event.preventDefault();
- } else if (shiftKeyStatus) {
- event.preventDefault();
- visibleMenuItems[index].focus();
- }
- }
- }
- }
- // Since we are hiding this column the default hide action will fail so we need to focus somewhere else.
- var setFocusOnHideColumn = function(){
- $timeout(function() {
- // Get the UID of the first
- var focusToGridMenu = function(){
- return gridUtil.focus.byId('grid-menu', $scope.grid);
- };
- var thisIndex;
- $scope.grid.columns.some(function(element, index){
- if (angular.equals(element, $scope.col)) {
- thisIndex = index;
- return true;
- }
- });
- var previousVisibleCol;
- // Try and find the next lower or nearest column to focus on
- $scope.grid.columns.some(function(element, index){
- if (!element.visible){
- return false;
- } // This columns index is below the current column index
- else if ( index < thisIndex){
- previousVisibleCol = element;
- } // This elements index is above this column index and we haven't found one that is lower
- else if ( index > thisIndex && !previousVisibleCol) {
- // This is the next best thing
- previousVisibleCol = element;
- // We've found one so use it.
- return true;
- } // We've reached an element with an index above this column and the previousVisibleCol variable has been set
- else if (index > thisIndex && previousVisibleCol) {
- // We are done.
- return true;
- }
- });
- // If found then focus on it
- if (previousVisibleCol){
- var colClass = previousVisibleCol.getColClass();
- gridUtil.focus.bySelector($document, '.ui-grid-header-cell.' + colClass+ ' .ui-grid-header-cell-primary-focus', true).then(angular.noop, function(reason){
- if (reason !== 'canceled'){ // If this is canceled then don't perform the action
- //The fallback action is to focus on the grid menu
- return focusToGridMenu();
- }
- }).catch(angular.noop);
- } else {
- // Fallback action to focus on the grid menu
- focusToGridMenu();
- }
- });
- };
- $scope.hideColumn = function () {
- $scope.col.colDef.visible = false;
- $scope.col.visible = false;
- $scope.grid.queueGridRefresh();
- $scope.hideMenu();
- $scope.grid.api.core.notifyDataChange( uiGridConstants.dataChange.COLUMN );
- $scope.grid.api.core.raise.columnVisibilityChanged( $scope.col );
- // We are hiding so the default action of focusing on the button that opened this menu will fail.
- setFocusOnHideColumn();
- };
- },
- controller: ['$scope', function ($scope) {
- var self = this;
- $scope.$watch('menuItems', function (n) {
- self.menuItems = n;
- });
- }]
- };
- return uiGridColumnMenu;
- }]);
- })();
- (function(){
- 'use strict';
- angular.module('ui.grid').directive('uiGridFilter', ['$compile', '$templateCache', 'i18nService', 'gridUtil', function ($compile, $templateCache, i18nService, gridUtil) {
- return {
- compile: function() {
- return {
- pre: function ($scope, $elm, $attrs, controllers) {
- $scope.col.updateFilters = function( filterable ){
- $elm.children().remove();
- if ( filterable ) {
- var template = $scope.col.filterHeaderTemplate;
- if (template === undefined && $scope.col.providedFilterHeaderTemplate !== '') {
- if ($scope.col.filterHeaderTemplatePromise) {
- $scope.col.filterHeaderTemplatePromise.then(function () {
- template = $scope.col.filterHeaderTemplate;
- $elm.append($compile(template)($scope));
- });
- }
- }
- else {
- $elm.append($compile(template)($scope));
- }
- }
- };
- $scope.$on( '$destroy', function() {
- delete $scope.col.updateFilters;
- });
- },
- post: function ($scope, $elm, $attrs, controllers){
- $scope.aria = i18nService.getSafeText('headerCell.aria');
- $scope.removeFilter = function(colFilter, index){
- colFilter.term = null;
- //Set the focus to the filter input after the action disables the button
- gridUtil.focus.bySelector($elm, '.ui-grid-filter-input-' + index);
- };
- }
- };
- }
- };
- }]);
- })();
- (function () {
- 'use strict';
- angular.module('ui.grid').directive('uiGridFooterCell', ['$timeout', 'gridUtil', 'uiGridConstants', '$compile',
- function ($timeout, gridUtil, uiGridConstants, $compile) {
- var uiGridFooterCell = {
- priority: 0,
- scope: {
- col: '=',
- row: '=',
- renderIndex: '='
- },
- replace: true,
- require: '^uiGrid',
- compile: function compile(tElement, tAttrs, transclude) {
- return {
- pre: function ($scope, $elm, $attrs, uiGridCtrl) {
- var template = $scope.col.footerCellTemplate;
- if (template === undefined && $scope.col.providedFooterCellTemplate !== '') {
- if ($scope.col.footerCellTemplatePromise) {
- $scope.col.footerCellTemplatePromise.then(function () {
- template = $scope.col.footerCellTemplate;
- $elm.append($compile(template)($scope));
- });
- }
- }
- else {
- $elm.append($compile(template)($scope));
- }
- },
- post: function ($scope, $elm, $attrs, uiGridCtrl) {
- //$elm.addClass($scope.col.getColClass(false));
- $scope.grid = uiGridCtrl.grid;
- var initColClass = $scope.col.getColClass(false);
- $elm.addClass(initColClass);
- // apply any footerCellClass
- var classAdded;
- var updateClass = function( grid ){
- var contents = $elm;
- if ( classAdded ){
- contents.removeClass( classAdded );
- classAdded = null;
- }
-
- if (angular.isFunction($scope.col.footerCellClass)) {
- classAdded = $scope.col.footerCellClass($scope.grid, $scope.row, $scope.col, $scope.rowRenderIndex, $scope.colRenderIndex);
- }
- else {
- classAdded = $scope.col.footerCellClass;
- }
- contents.addClass(classAdded);
- };
-
- if ($scope.col.footerCellClass) {
- updateClass();
- }
- $scope.col.updateAggregationValue();
- // Watch for column changes so we can alter the col cell class properly
- /* shouldn't be needed any more, given track by col.name
- $scope.$watch('col', function (n, o) {
- if (n !== o) {
- // See if the column's internal class has changed
- var newColClass = $scope.col.getColClass(false);
- if (newColClass !== initColClass) {
- $elm.removeClass(initColClass);
- $elm.addClass(newColClass);
- initColClass = newColClass;
- }
- }
- });
- */
- // Register a data change watch that would get triggered whenever someone edits a cell or modifies column defs
- var dataChangeDereg = $scope.grid.registerDataChangeCallback( updateClass, [uiGridConstants.dataChange.COLUMN]);
- // listen for visible rows change and update aggregation values
- $scope.grid.api.core.on.rowsRendered( $scope, $scope.col.updateAggregationValue );
- $scope.grid.api.core.on.rowsRendered( $scope, updateClass );
- $scope.$on( '$destroy', dataChangeDereg );
- }
- };
- }
- };
- return uiGridFooterCell;
- }]);
- })();
- (function () {
- 'use strict';
- angular.module('ui.grid').directive('uiGridFooter', ['$templateCache', '$compile', 'uiGridConstants', 'gridUtil', '$timeout', function ($templateCache, $compile, uiGridConstants, gridUtil, $timeout) {
- return {
- restrict: 'EA',
- replace: true,
- // priority: 1000,
- require: ['^uiGrid', '^uiGridRenderContainer'],
- scope: true,
- compile: function ($elm, $attrs) {
- return {
- pre: function ($scope, $elm, $attrs, controllers) {
- var uiGridCtrl = controllers[0];
- var containerCtrl = controllers[1];
- $scope.grid = uiGridCtrl.grid;
- $scope.colContainer = containerCtrl.colContainer;
- containerCtrl.footer = $elm;
- var footerTemplate = $scope.grid.options.footerTemplate;
- gridUtil.getTemplate(footerTemplate)
- .then(function (contents) {
- var template = angular.element(contents);
- var newElm = $compile(template)($scope);
- $elm.append(newElm);
- if (containerCtrl) {
- // Inject a reference to the footer viewport (if it exists) into the grid controller for use in the horizontal scroll handler below
- var footerViewport = $elm[0].getElementsByClassName('ui-grid-footer-viewport')[0];
- if (footerViewport) {
- containerCtrl.footerViewport = footerViewport;
- }
- }
- }).catch(angular.noop);
- },
- post: function ($scope, $elm, $attrs, controllers) {
- var uiGridCtrl = controllers[0];
- var containerCtrl = controllers[1];
- // gridUtil.logDebug('ui-grid-footer link');
- var grid = uiGridCtrl.grid;
- // Don't animate footer cells
- gridUtil.disableAnimations($elm);
- containerCtrl.footer = $elm;
- var footerViewport = $elm[0].getElementsByClassName('ui-grid-footer-viewport')[0];
- if (footerViewport) {
- containerCtrl.footerViewport = footerViewport;
- }
- }
- };
- }
- };
- }]);
- })();
- (function () {
- 'use strict';
- angular.module('ui.grid').directive('uiGridGridFooter', ['$templateCache', '$compile', 'uiGridConstants', 'gridUtil', '$timeout', function ($templateCache, $compile, uiGridConstants, gridUtil, $timeout) {
- return {
- restrict: 'EA',
- replace: true,
- // priority: 1000,
- require: '^uiGrid',
- scope: true,
- compile: function ($elm, $attrs) {
- return {
- pre: function ($scope, $elm, $attrs, uiGridCtrl) {
- $scope.grid = uiGridCtrl.grid;
- var footerTemplate = $scope.grid.options.gridFooterTemplate;
- gridUtil.getTemplate(footerTemplate)
- .then(function (contents) {
- var template = angular.element(contents);
- var newElm = $compile(template)($scope);
- $elm.append(newElm);
- }).catch(angular.noop);
- },
- post: function ($scope, $elm, $attrs, controllers) {
- }
- };
- }
- };
- }]);
- })();
- (function(){
- 'use strict';
- angular.module('ui.grid').directive('uiGridHeaderCell', ['$compile', '$timeout', '$window', '$document', 'gridUtil', 'uiGridConstants', 'ScrollEvent', 'i18nService',
- function ($compile, $timeout, $window, $document, gridUtil, uiGridConstants, ScrollEvent, i18nService) {
- // Do stuff after mouse has been down this many ms on the header cell
- var mousedownTimeout = 500;
- var changeModeTimeout = 500; // length of time between a touch event and a mouse event being recognised again, and vice versa
- var uiGridHeaderCell = {
- priority: 0,
- scope: {
- col: '=',
- row: '=',
- renderIndex: '='
- },
- require: ['^uiGrid', '^uiGridRenderContainer'],
- replace: true,
- compile: function() {
- return {
- pre: function ($scope, $elm, $attrs) {
- var template = $scope.col.headerCellTemplate;
- if (template === undefined && $scope.col.providedHeaderCellTemplate !== '') {
- if ($scope.col.headerCellTemplatePromise) {
- $scope.col.headerCellTemplatePromise.then(function () {
- template = $scope.col.headerCellTemplate;
- $elm.append($compile(template)($scope));
- });
- }
- }
- else {
- $elm.append($compile(template)($scope));
- }
- },
- post: function ($scope, $elm, $attrs, controllers) {
- var uiGridCtrl = controllers[0];
- var renderContainerCtrl = controllers[1];
- $scope.i18n = {
- headerCell: i18nService.getSafeText('headerCell'),
- sort: i18nService.getSafeText('sort')
- };
- $scope.isSortPriorityVisible = function() {
- //show sort priority if column is sorted and there is at least one other sorted column
- return angular.isNumber($scope.col.sort.priority) && $scope.grid.columns.some(function(element, index){
- return angular.isNumber(element.sort.priority) && element !== $scope.col;
- });
- };
- $scope.getSortDirectionAriaLabel = function(){
- var col = $scope.col;
- //Trying to recreate this sort of thing but it was getting messy having it in the template.
- //Sort direction {{col.sort.direction == asc ? 'ascending' : ( col.sort.direction == desc ? 'descending':'none')}}. {{col.sort.priority ? {{columnPriorityText}} {{col.sort.priority}} : ''}
- var sortDirectionText = col.sort.direction === uiGridConstants.ASC ? $scope.i18n.sort.ascending : ( col.sort.direction === uiGridConstants.DESC ? $scope.i18n.sort.descending : $scope.i18n.sort.none);
- var label = sortDirectionText;
- if ($scope.isSortPriorityVisible()) {
- label = label + '. ' + $scope.i18n.headerCell.priority + ' ' + (col.sort.priority + 1);
- }
- return label;
- };
- $scope.grid = uiGridCtrl.grid;
- $scope.renderContainer = uiGridCtrl.grid.renderContainers[renderContainerCtrl.containerId];
- var initColClass = $scope.col.getColClass(false);
- $elm.addClass(initColClass);
- // Hide the menu by default
- $scope.menuShown = false;
- // Put asc and desc sort directions in scope
- $scope.asc = uiGridConstants.ASC;
- $scope.desc = uiGridConstants.DESC;
- // Store a reference to menu element
- var $colMenu = angular.element( $elm[0].querySelectorAll('.ui-grid-header-cell-menu') );
- var $contentsElm = angular.element( $elm[0].querySelectorAll('.ui-grid-cell-contents') );
- // apply any headerCellClass
- var classAdded;
- var previousMouseX;
- // filter watchers
- var filterDeregisters = [];
- /*
- * Our basic approach here for event handlers is that we listen for a down event (mousedown or touchstart).
- * Once we have a down event, we need to work out whether we have a click, a drag, or a
- * hold. A click would sort the grid (if sortable). A drag would be used by moveable, so
- * we ignore it. A hold would open the menu.
- *
- * So, on down event, we put in place handlers for move and up events, and a timer. If the
- * timer expires before we see a move or up, then we have a long press and hence a column menu open.
- * If the up happens before the timer, then we have a click, and we sort if the column is sortable.
- * If a move happens before the timer, then we are doing column move, so we do nothing, the moveable feature
- * will handle it.
- *
- * To deal with touch enabled devices that also have mice, we only create our handlers when
- * we get the down event, and we create the corresponding handlers - if we're touchstart then
- * we get touchmove and touchend, if we're mousedown then we get mousemove and mouseup.
- *
- * We also suppress the click action whilst this is happening - otherwise after the mouseup there
- * will be a click event and that can cause the column menu to close
- *
- */
- $scope.downFn = function( event ){
- event.stopPropagation();
- if (typeof(event.originalEvent) !== 'undefined' && event.originalEvent !== undefined) {
- event = event.originalEvent;
- }
- // Don't show the menu if it's not the left button
- if (event.button && event.button !== 0) {
- return;
- }
- previousMouseX = event.pageX;
- $scope.mousedownStartTime = (new Date()).getTime();
- $scope.mousedownTimeout = $timeout(function() { }, mousedownTimeout);
- $scope.mousedownTimeout.then(function () {
- if ( $scope.colMenu ) {
- uiGridCtrl.columnMenuScope.showMenu($scope.col, $elm, event);
- }
- }).catch(angular.noop);
- uiGridCtrl.fireEvent(uiGridConstants.events.COLUMN_HEADER_CLICK, {event: event, columnName: $scope.col.colDef.name});
- $scope.offAllEvents();
- if ( event.type === 'touchstart'){
- $document.on('touchend', $scope.upFn);
- $document.on('touchmove', $scope.moveFn);
- } else if ( event.type === 'mousedown' ){
- $document.on('mouseup', $scope.upFn);
- $document.on('mousemove', $scope.moveFn);
- }
- };
- $scope.upFn = function( event ){
- event.stopPropagation();
- $timeout.cancel($scope.mousedownTimeout);
- $scope.offAllEvents();
- $scope.onDownEvents(event.type);
- var mousedownEndTime = (new Date()).getTime();
- var mousedownTime = mousedownEndTime - $scope.mousedownStartTime;
- if (mousedownTime > mousedownTimeout) {
- // long click, handled above with mousedown
- }
- else {
- // short click
- if ( $scope.sortable ){
- $scope.handleClick(event);
- }
- }
- };
- $scope.handleKeyDown = function(event) {
- if (event.keyCode === 32) {
- event.preventDefault();
- }
- };
- $scope.moveFn = function( event ){
- // Chrome is known to fire some bogus move events.
- var changeValue = event.pageX - previousMouseX;
- if ( changeValue === 0 ){ return; }
- // we're a move, so do nothing and leave for column move (if enabled) to take over
- $timeout.cancel($scope.mousedownTimeout);
- $scope.offAllEvents();
- $scope.onDownEvents(event.type);
- };
- $scope.clickFn = function ( event ){
- event.stopPropagation();
- $contentsElm.off('click', $scope.clickFn);
- };
- $scope.offAllEvents = function(){
- $contentsElm.off('touchstart', $scope.downFn);
- $contentsElm.off('mousedown', $scope.downFn);
- $document.off('touchend', $scope.upFn);
- $document.off('mouseup', $scope.upFn);
- $document.off('touchmove', $scope.moveFn);
- $document.off('mousemove', $scope.moveFn);
- $contentsElm.off('click', $scope.clickFn);
- };
- $scope.onDownEvents = function( type ){
- // If there is a previous event, then wait a while before
- // activating the other mode - i.e. if the last event was a touch event then
- // don't enable mouse events for a wee while (500ms or so)
- // Avoids problems with devices that emulate mouse events when you have touch events
- switch (type){
- case 'touchmove':
- case 'touchend':
- $contentsElm.on('click', $scope.clickFn);
- $contentsElm.on('touchstart', $scope.downFn);
- $timeout(function(){
- $contentsElm.on('mousedown', $scope.downFn);
- }, changeModeTimeout);
- break;
- case 'mousemove':
- case 'mouseup':
- $contentsElm.on('click', $scope.clickFn);
- $contentsElm.on('mousedown', $scope.downFn);
- $timeout(function(){
- $contentsElm.on('touchstart', $scope.downFn);
- }, changeModeTimeout);
- break;
- default:
- $contentsElm.on('click', $scope.clickFn);
- $contentsElm.on('touchstart', $scope.downFn);
- $contentsElm.on('mousedown', $scope.downFn);
- }
- };
- var updateHeaderOptions = function( grid ){
- var contents = $elm;
- if ( classAdded ){
- contents.removeClass( classAdded );
- classAdded = null;
- }
- if (angular.isFunction($scope.col.headerCellClass)) {
- classAdded = $scope.col.headerCellClass($scope.grid, $scope.row, $scope.col, $scope.rowRenderIndex, $scope.colRenderIndex);
- }
- else {
- classAdded = $scope.col.headerCellClass;
- }
- contents.addClass(classAdded);
- $scope.$applyAsync(function() {
- var rightMostContainer = $scope.grid.renderContainers['right'] && $scope.grid.renderContainers['right'].visibleColumnCache.length ?
- $scope.grid.renderContainers['right'] : $scope.grid.renderContainers['body'];
- $scope.isLastCol = uiGridCtrl.grid.options && uiGridCtrl.grid.options.enableGridMenu &&
- $scope.col === rightMostContainer.visibleColumnCache[ rightMostContainer.visibleColumnCache.length - 1 ];
- });
- // Figure out whether this column is sortable or not
- $scope.sortable = Boolean($scope.col.enableSorting);
- // Figure out whether this column is filterable or not
- var oldFilterable = $scope.filterable;
- $scope.filterable = Boolean(uiGridCtrl.grid.options.enableFiltering && $scope.col.enableFiltering);
- if ( oldFilterable !== $scope.filterable){
- if ( typeof($scope.col.updateFilters) !== 'undefined' ){
- $scope.col.updateFilters($scope.filterable);
- }
- // if column is filterable add a filter watcher
- if ($scope.filterable) {
- $scope.col.filters.forEach( function(filter, i) {
- filterDeregisters.push($scope.$watch('col.filters[' + i + '].term', function(n, o) {
- if (n !== o) {
- uiGridCtrl.grid.api.core.raise.filterChanged();
- uiGridCtrl.grid.api.core.notifyDataChange( uiGridConstants.dataChange.COLUMN );
- uiGridCtrl.grid.queueGridRefresh();
- }
- }));
- });
- $scope.$on('$destroy', function() {
- filterDeregisters.forEach( function(filterDeregister) {
- filterDeregister();
- });
- });
- } else {
- filterDeregisters.forEach( function(filterDeregister) {
- filterDeregister();
- });
- }
- }
- // figure out whether we support column menus
- if ($scope.col.grid.options && $scope.col.grid.options.enableColumnMenus !== false &&
- $scope.col.colDef && $scope.col.colDef.enableColumnMenu !== false){
- $scope.colMenu = true;
- } else {
- $scope.colMenu = false;
- }
- /**
- * @ngdoc property
- * @name enableColumnMenu
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description if column menus are enabled, controls the column menus for this specific
- * column (i.e. if gridOptions.enableColumnMenus, then you can control column menus
- * using this option. If gridOptions.enableColumnMenus === false then you get no column
- * menus irrespective of the value of this option ). Defaults to true.
- *
- * By default column menu's trigger is hidden before mouse over, but you can always force it to be visible with CSS:
- *
- * <pre>
- * .ui-grid-column-menu-button {
- * display: block;
- * }
- * </pre>
- */
- /**
- * @ngdoc property
- * @name enableColumnMenus
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description Override for column menus everywhere - if set to false then you get no
- * column menus. Defaults to true.
- *
- */
- $scope.offAllEvents();
- if ($scope.sortable || $scope.colMenu) {
- $scope.onDownEvents();
- $scope.$on('$destroy', function () {
- $scope.offAllEvents();
- });
- }
- };
- /*
- $scope.$watch('col', function (n, o) {
- if (n !== o) {
- // See if the column's internal class has changed
- var newColClass = $scope.col.getColClass(false);
- if (newColClass !== initColClass) {
- $elm.removeClass(initColClass);
- $elm.addClass(newColClass);
- initColClass = newColClass;
- }
- }
- });
- */
- updateHeaderOptions();
- // Register a data change watch that would get triggered whenever someone edits a cell or modifies column defs
- var dataChangeDereg = $scope.grid.registerDataChangeCallback( updateHeaderOptions, [uiGridConstants.dataChange.COLUMN]);
- $scope.$on( '$destroy', dataChangeDereg );
- $scope.handleClick = function(event) {
- // If the shift key is being held down, add this column to the sort
- var add = false;
- if (event.shiftKey) {
- add = true;
- }
- // Sort this column then rebuild the grid's rows
- uiGridCtrl.grid.sortColumn($scope.col, add)
- .then(function () {
- if (uiGridCtrl.columnMenuScope) { uiGridCtrl.columnMenuScope.hideMenu(); }
- uiGridCtrl.grid.refresh();
- }).catch(angular.noop);
- };
- $scope.headerCellArrowKeyDown = function(event) {
- if (event.keyCode === 32 || event.keyCode === 13) {
- event.preventDefault();
- $scope.toggleMenu(event);
- }
- };
- $scope.toggleMenu = function(event) {
- event.stopPropagation();
- // If the menu is already showing...
- if (uiGridCtrl.columnMenuScope.menuShown) {
- // ... and we're the column the menu is on...
- if (uiGridCtrl.columnMenuScope.col === $scope.col) {
- // ... hide it
- uiGridCtrl.columnMenuScope.hideMenu();
- }
- // ... and we're NOT the column the menu is on
- else {
- // ... move the menu to our column
- uiGridCtrl.columnMenuScope.showMenu($scope.col, $elm);
- }
- }
- // If the menu is NOT showing
- else {
- // ... show it on our column
- uiGridCtrl.columnMenuScope.showMenu($scope.col, $elm);
- }
- };
- }
- };
- }
- };
- return uiGridHeaderCell;
- }]);
- })();
- (function(){
- 'use strict';
- angular.module('ui.grid').directive('uiGridHeader', ['$templateCache', '$compile', 'uiGridConstants', 'gridUtil', '$timeout', 'ScrollEvent',
- function($templateCache, $compile, uiGridConstants, gridUtil, $timeout, ScrollEvent) {
- var defaultTemplate = 'ui-grid/ui-grid-header';
- var emptyTemplate = 'ui-grid/ui-grid-no-header';
- return {
- restrict: 'EA',
- // templateUrl: 'ui-grid/ui-grid-header',
- replace: true,
- // priority: 1000,
- require: ['^uiGrid', '^uiGridRenderContainer'],
- scope: true,
- compile: function($elm, $attrs) {
- return {
- pre: function ($scope, $elm, $attrs, controllers) {
- var uiGridCtrl = controllers[0];
- var containerCtrl = controllers[1];
- $scope.grid = uiGridCtrl.grid;
- $scope.colContainer = containerCtrl.colContainer;
- updateHeaderReferences();
-
- var headerTemplate;
- if (!$scope.grid.options.showHeader) {
- headerTemplate = emptyTemplate;
- }
- else {
- headerTemplate = ($scope.grid.options.headerTemplate) ? $scope.grid.options.headerTemplate : defaultTemplate;
- }
- gridUtil.getTemplate(headerTemplate)
- .then(function (contents) {
- var template = angular.element(contents);
-
- var newElm = $compile(template)($scope);
- $elm.replaceWith(newElm);
- // And update $elm to be the new element
- $elm = newElm;
- updateHeaderReferences();
- if (containerCtrl) {
- // Inject a reference to the header viewport (if it exists) into the grid controller for use in the horizontal scroll handler below
- var headerViewport = $elm[0].getElementsByClassName('ui-grid-header-viewport')[0];
- if (headerViewport) {
- containerCtrl.headerViewport = headerViewport;
- angular.element(headerViewport).on('scroll', scrollHandler);
- $scope.$on('$destroy', function () {
- angular.element(headerViewport).off('scroll', scrollHandler);
- });
- }
- }
- $scope.grid.queueRefresh();
- }).catch(angular.noop);
- function updateHeaderReferences() {
- containerCtrl.header = containerCtrl.colContainer.header = $elm;
- var headerCanvases = $elm[0].getElementsByClassName('ui-grid-header-canvas');
- if (headerCanvases.length > 0) {
- containerCtrl.headerCanvas = containerCtrl.colContainer.headerCanvas = headerCanvases[0];
- }
- else {
- containerCtrl.headerCanvas = null;
- }
- }
- function scrollHandler(evt) {
- if (uiGridCtrl.grid.isScrollingHorizontally) {
- return;
- }
- var newScrollLeft = gridUtil.normalizeScrollLeft(containerCtrl.headerViewport, uiGridCtrl.grid);
- var horizScrollPercentage = containerCtrl.colContainer.scrollHorizontal(newScrollLeft);
- var scrollEvent = new ScrollEvent(uiGridCtrl.grid, null, containerCtrl.colContainer, ScrollEvent.Sources.ViewPortScroll);
- scrollEvent.newScrollLeft = newScrollLeft;
- if ( horizScrollPercentage > -1 ){
- scrollEvent.x = { percentage: horizScrollPercentage };
- }
- uiGridCtrl.grid.scrollContainers(null, scrollEvent);
- }
- },
- post: function ($scope, $elm, $attrs, controllers) {
- var uiGridCtrl = controllers[0];
- var containerCtrl = controllers[1];
- // gridUtil.logDebug('ui-grid-header link');
- var grid = uiGridCtrl.grid;
- // Don't animate header cells
- gridUtil.disableAnimations($elm);
- function updateColumnWidths() {
- // this styleBuilder always runs after the renderContainer, so we can rely on the column widths
- // already being populated correctly
- var columnCache = containerCtrl.colContainer.visibleColumnCache;
-
- // Build the CSS
- // uiGridCtrl.grid.columns.forEach(function (column) {
- var ret = '';
- var canvasWidth = 0;
- columnCache.forEach(function (column) {
- ret = ret + column.getColClassDefinition();
- canvasWidth += column.drawnWidth;
- });
- containerCtrl.colContainer.canvasWidth = canvasWidth;
-
- // Return the styles back to buildStyles which pops them into the `customStyles` scope variable
- return ret;
- }
-
- containerCtrl.header = $elm;
-
- var headerViewport = $elm[0].getElementsByClassName('ui-grid-header-viewport')[0];
- if (headerViewport) {
- containerCtrl.headerViewport = headerViewport;
- }
- //todo: remove this if by injecting gridCtrl into unit tests
- if (uiGridCtrl) {
- uiGridCtrl.grid.registerStyleComputation({
- priority: 15,
- func: updateColumnWidths
- });
- }
- }
- };
- }
- };
- }]);
- })();
- (function(){
- angular.module('ui.grid')
- .service('uiGridGridMenuService', [ 'gridUtil', 'i18nService', 'uiGridConstants', function( gridUtil, i18nService, uiGridConstants ) {
- /**
- * @ngdoc service
- * @name ui.grid.uiGridGridMenuService
- *
- * @description Methods for working with the grid menu
- */
- var service = {
- /**
- * @ngdoc method
- * @methodOf ui.grid.uiGridGridMenuService
- * @name initialize
- * @description Sets up the gridMenu. Most importantly, sets our
- * scope onto the grid object as grid.gridMenuScope, allowing us
- * to operate when passed only the grid. Second most importantly,
- * we register the 'addToGridMenu' and 'removeFromGridMenu' methods
- * on the core api.
- * @param {$scope} $scope the scope of this gridMenu
- * @param {Grid} grid the grid to which this gridMenu is associated
- */
- initialize: function( $scope, grid ){
- grid.gridMenuScope = $scope;
- $scope.grid = grid;
- $scope.registeredMenuItems = [];
- // not certain this is needed, but would be bad to create a memory leak
- $scope.$on('$destroy', function() {
- if ( $scope.grid && $scope.grid.gridMenuScope ){
- $scope.grid.gridMenuScope = null;
- }
- if ( $scope.grid ){
- $scope.grid = null;
- }
- if ( $scope.registeredMenuItems ){
- $scope.registeredMenuItems = null;
- }
- });
- $scope.registeredMenuItems = [];
- /**
- * @ngdoc function
- * @name addToGridMenu
- * @methodOf ui.grid.core.api:PublicApi
- * @description add items to the grid menu. Used by features
- * to add their menu items if they are enabled, can also be used by
- * end users to add menu items. This method has the advantage of allowing
- * remove again, which can simplify management of which items are included
- * in the menu when. (Noting that in most cases the shown and active functions
- * provide a better way to handle visibility of menu items)
- * @param {Grid} grid the grid on which we are acting
- * @param {array} items menu items in the format as described in the tutorial, with
- * the added note that if you want to use remove you must also specify an `id` field,
- * which is provided when you want to remove an item. The id should be unique.
- *
- */
- grid.api.registerMethod( 'core', 'addToGridMenu', service.addToGridMenu );
- /**
- * @ngdoc function
- * @name removeFromGridMenu
- * @methodOf ui.grid.core.api:PublicApi
- * @description Remove an item from the grid menu based on a provided id. Assumes
- * that the id is unique, removes only the last instance of that id. Does nothing if
- * the specified id is not found
- * @param {Grid} grid the grid on which we are acting
- * @param {string} id the id we'd like to remove from the menu
- *
- */
- grid.api.registerMethod( 'core', 'removeFromGridMenu', service.removeFromGridMenu );
- },
- /**
- * @ngdoc function
- * @name addToGridMenu
- * @propertyOf ui.grid.uiGridGridMenuService
- * @description add items to the grid menu. Used by features
- * to add their menu items if they are enabled, can also be used by
- * end users to add menu items. This method has the advantage of allowing
- * remove again, which can simplify management of which items are included
- * in the menu when. (Noting that in most cases the shown and active functions
- * provide a better way to handle visibility of menu items)
- * @param {Grid} grid the grid on which we are acting
- * @param {array} menuItems menu items in the format as described in the tutorial, with
- * the added note that if you want to use remove you must also specify an `id` field,
- * which is provided when you want to remove an item. The id should be unique.
- *
- */
- addToGridMenu: function( grid, menuItems ) {
- if ( !angular.isArray( menuItems ) ) {
- gridUtil.logError( 'addToGridMenu: menuItems must be an array, and is not, not adding any items');
- } else {
- if ( grid.gridMenuScope ){
- grid.gridMenuScope.registeredMenuItems = grid.gridMenuScope.registeredMenuItems ? grid.gridMenuScope.registeredMenuItems : [];
- grid.gridMenuScope.registeredMenuItems = grid.gridMenuScope.registeredMenuItems.concat( menuItems );
- } else {
- gridUtil.logError( 'Asked to addToGridMenu, but gridMenuScope not present. Timing issue? Please log issue with ui-grid');
- }
- }
- },
- /**
- * @ngdoc function
- * @name removeFromGridMenu
- * @methodOf ui.grid.uiGridGridMenuService
- * @description Remove an item from the grid menu based on a provided id. Assumes
- * that the id is unique, removes only the last instance of that id. Does nothing if
- * the specified id is not found. If there is no gridMenuScope or registeredMenuItems
- * then do nothing silently - the desired result is those menu items not be present and they
- * aren't.
- * @param {Grid} grid the grid on which we are acting
- * @param {string} id the id we'd like to remove from the menu
- *
- */
- removeFromGridMenu: function( grid, id ){
- var foundIndex = -1;
- if ( grid && grid.gridMenuScope ){
- grid.gridMenuScope.registeredMenuItems.forEach( function( value, index ) {
- if ( value.id === id ){
- if (foundIndex > -1) {
- gridUtil.logError( 'removeFromGridMenu: found multiple items with the same id, removing only the last' );
- } else {
- foundIndex = index;
- }
- }
- });
- }
- if ( foundIndex > -1 ){
- grid.gridMenuScope.registeredMenuItems.splice( foundIndex, 1 );
- }
- },
- /**
- * @ngdoc array
- * @name gridMenuCustomItems
- * @propertyOf ui.grid.class:GridOptions
- * @description (optional) An array of menu items that should be added to
- * the gridMenu. Follow the format documented in the tutorial for column
- * menu customisation. The context provided to the action function will
- * include context.grid. An alternative if working with dynamic menus is to use the
- * provided api - core.addToGridMenu and core.removeFromGridMenu, which handles
- * some of the management of items for you.
- *
- */
- /**
- * @ngdoc boolean
- * @name gridMenuShowHideColumns
- * @propertyOf ui.grid.class:GridOptions
- * @description true by default, whether the grid menu should allow hide/show
- * of columns
- *
- */
- /**
- * @ngdoc method
- * @methodOf ui.grid.uiGridGridMenuService
- * @name getMenuItems
- * @description Decides the menu items to show in the menu. This is a
- * combination of:
- *
- * - the default menu items that are always included,
- * - any menu items that have been provided through the addMenuItem api. These
- * are typically added by features within the grid
- * - any menu items included in grid.options.gridMenuCustomItems. These can be
- * changed dynamically, as they're always recalculated whenever we show the
- * menu
- * @param {$scope} $scope the scope of this gridMenu, from which we can find all
- * the information that we need
- * @returns {Array} an array of menu items that can be shown
- */
- getMenuItems: function( $scope ) {
- var menuItems = [
- // this is where we add any menu items we want to always include
- ];
- if ( $scope.grid.options.gridMenuCustomItems ){
- if ( !angular.isArray( $scope.grid.options.gridMenuCustomItems ) ){
- gridUtil.logError( 'gridOptions.gridMenuCustomItems must be an array, and is not');
- } else {
- menuItems = menuItems.concat( $scope.grid.options.gridMenuCustomItems );
- }
- }
- var clearFilters = [{
- title: i18nService.getSafeText('gridMenu.clearAllFilters'),
- action: function ($event) {
- $scope.grid.clearAllFilters();
- },
- shown: function() {
- return $scope.grid.options.enableFiltering;
- },
- order: 100
- }];
- menuItems = menuItems.concat( clearFilters );
- menuItems = menuItems.concat( $scope.registeredMenuItems );
- if ( $scope.grid.options.gridMenuShowHideColumns !== false ){
- menuItems = menuItems.concat( service.showHideColumns( $scope ) );
- }
- menuItems.sort(function(a, b){
- return a.order - b.order;
- });
- return menuItems;
- },
- /**
- * @ngdoc array
- * @name gridMenuTitleFilter
- * @propertyOf ui.grid.class:GridOptions
- * @description (optional) A function that takes a title string
- * (usually the col.displayName), and converts it into a display value. The function
- * must return either a string or a promise.
- *
- * Used for internationalization of the grid menu column names - for angular-translate
- * you can pass $translate as the function, for i18nService you can pass getSafeText as the
- * function
- * @example
- * <pre>
- * gridOptions = {
- * gridMenuTitleFilter: $translate
- * }
- * </pre>
- */
- /**
- * @ngdoc method
- * @methodOf ui.grid.uiGridGridMenuService
- * @name showHideColumns
- * @description Adds two menu items for each of the columns in columnDefs. One
- * menu item for hide, one menu item for show. Each is visible when appropriate
- * (show when column is not visible, hide when column is visible). Each toggles
- * the visible property on the columnDef using toggleColumnVisibility
- * @param {$scope} $scope of a gridMenu, which contains a reference to the grid
- */
- showHideColumns: function( $scope ){
- var showHideColumns = [];
- if ( !$scope.grid.options.columnDefs || $scope.grid.options.columnDefs.length === 0 || $scope.grid.columns.length === 0 ) {
- return showHideColumns;
- }
- function isColumnVisible(colDef) {
- return colDef.visible === true || colDef.visible === undefined;
- }
- // add header for columns
- showHideColumns.push({
- title: i18nService.getSafeText('gridMenu.columns'),
- order: 300
- });
- $scope.grid.options.gridMenuTitleFilter = $scope.grid.options.gridMenuTitleFilter ? $scope.grid.options.gridMenuTitleFilter : function( title ) { return title; };
- $scope.grid.options.columnDefs.forEach( function( colDef, index ){
- if ( colDef.enableHiding !== false ){
- // add hide menu item - shows an OK icon as we only show when column is already visible
- var menuItem = {
- icon: isColumnVisible(colDef) ? 'ui-grid-icon-ok' : 'ui-grid-icon-cancel',
- action: function($event) {
- $event.stopPropagation();
- service.toggleColumnVisibility( this.context.gridCol );
- if ($event.target && $event.target.firstChild) {
- $event.target.firstChild.className = isColumnVisible(this.context.gridCol.colDef) ?
- 'ui-grid-icon-ok' : 'ui-grid-icon-cancel';
- }
- },
- shown: function() {
- return this.context.gridCol.colDef.enableHiding !== false;
- },
- context: { gridCol: $scope.grid.getColumn(colDef.name || colDef.field) },
- leaveOpen: true,
- order: 301 + index
- };
- service.setMenuItemTitle( menuItem, colDef, $scope.grid );
- showHideColumns.push( menuItem );
- }
- });
- return showHideColumns;
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.uiGridGridMenuService
- * @name setMenuItemTitle
- * @description Handles the response from gridMenuTitleFilter, adding it directly to the menu
- * item if it returns a string, otherwise waiting for the promise to resolve or reject then
- * putting the result into the title
- * @param {object} menuItem the menuItem we want to put the title on
- * @param {object} colDef the colDef from which we can get displayName, name or field
- * @param {Grid} grid the grid, from which we can get the options.gridMenuTitleFilter
- *
- */
- setMenuItemTitle: function( menuItem, colDef, grid ){
- var title = grid.options.gridMenuTitleFilter( colDef.displayName || gridUtil.readableColumnName(colDef.name) || colDef.field );
- if ( typeof(title) === 'string' ){
- menuItem.title = title;
- } else if ( title.then ){
- // must be a promise
- menuItem.title = "";
- title.then( function( successValue ) {
- menuItem.title = successValue;
- }, function( errorValue ) {
- menuItem.title = errorValue;
- }).catch(angular.noop);
- } else {
- gridUtil.logError('Expected gridMenuTitleFilter to return a string or a promise, it has returned neither, bad config');
- menuItem.title = 'badconfig';
- }
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.uiGridGridMenuService
- * @name toggleColumnVisibility
- * @description Toggles the visibility of an individual column. Expects to be
- * provided a context that has on it a gridColumn, which is the column that
- * we'll operate upon. We change the visibility, and refresh the grid as appropriate
- * @param {GridColumn} gridCol the column that we want to toggle
- *
- */
- toggleColumnVisibility: function( gridCol ) {
- gridCol.colDef.visible = !( gridCol.colDef.visible === true || gridCol.colDef.visible === undefined );
- gridCol.grid.refresh();
- gridCol.grid.api.core.notifyDataChange( uiGridConstants.dataChange.COLUMN );
- gridCol.grid.api.core.raise.columnVisibilityChanged( gridCol );
- }
- };
- return service;
- }])
- .directive('uiGridMenuButton', ['gridUtil', 'uiGridConstants', 'uiGridGridMenuService', 'i18nService',
- function (gridUtil, uiGridConstants, uiGridGridMenuService, i18nService) {
- return {
- priority: 0,
- scope: true,
- require: ['^uiGrid'],
- templateUrl: 'ui-grid/ui-grid-menu-button',
- replace: true,
- link: function ($scope, $elm, $attrs, controllers) {
- var uiGridCtrl = controllers[0];
- // For the aria label
- $scope.i18n = {
- aria: i18nService.getSafeText('gridMenu.aria')
- };
- uiGridGridMenuService.initialize($scope, uiGridCtrl.grid);
- $scope.shown = false;
- $scope.toggleMenu = function () {
- if ( $scope.shown ){
- $scope.$broadcast('hide-menu');
- $scope.shown = false;
- } else {
- $scope.menuItems = uiGridGridMenuService.getMenuItems( $scope );
- $scope.$broadcast('show-menu');
- $scope.shown = true;
- }
- };
- $scope.$on('menu-hidden', function() {
- $scope.shown = false;
- gridUtil.focus.bySelector($elm, '.ui-grid-icon-container');
- });
- }
- };
- }]);
- })();
- (function(){
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridMenu
- * @element style
- * @restrict A
- *
- * @description
- * Allows us to interpolate expressions in `<style>` elements. Angular doesn't do this by default as it can/will/might? break in IE8.
- *
- * @example
- <doc:example module="app">
- <doc:source>
- <script>
- var app = angular.module('app', ['ui.grid']);
- app.controller('MainCtrl', ['$scope', function ($scope) {
- }]);
- </script>
- <div ng-controller="MainCtrl">
- <div ui-grid-menu shown="true" ></div>
- </div>
- </doc:source>
- <doc:scenario>
- </doc:scenario>
- </doc:example>
- */
- angular.module('ui.grid')
- .directive('uiGridMenu', ['$compile', '$timeout', '$window', '$document', 'gridUtil', 'uiGridConstants', 'i18nService',
- function ($compile, $timeout, $window, $document, gridUtil, uiGridConstants, i18nService) {
- var uiGridMenu = {
- priority: 0,
- scope: {
- // shown: '&',
- menuItems: '=',
- autoHide: '=?'
- },
- require: '?^uiGrid',
- templateUrl: 'ui-grid/uiGridMenu',
- replace: false,
- link: function ($scope, $elm, $attrs, uiGridCtrl) {
- $scope.dynamicStyles = '';
- if (uiGridCtrl && uiGridCtrl.grid && uiGridCtrl.grid.options && uiGridCtrl.grid.options.gridMenuTemplate) {
- var gridMenuTemplate = uiGridCtrl.grid.options.gridMenuTemplate;
- gridUtil.getTemplate(gridMenuTemplate).then(function (contents) {
- var template = angular.element(contents);
- var newElm = $compile(template)($scope);
- $elm.replaceWith(newElm);
- }).catch(angular.noop);
- }
- var setupHeightStyle = function(gridHeight) {
- //menu appears under header row, so substract that height from it's total
- // additional 20px for general padding
- var gridMenuMaxHeight = gridHeight - uiGridCtrl.grid.headerHeight - 20;
- $scope.dynamicStyles = [
- '.grid' + uiGridCtrl.grid.id + ' .ui-grid-menu-mid {',
- 'max-height: ' + gridMenuMaxHeight + 'px;',
- '}'
- ].join(' ');
- };
- if (uiGridCtrl) {
- setupHeightStyle(uiGridCtrl.grid.gridHeight);
- uiGridCtrl.grid.api.core.on.gridDimensionChanged($scope, function(oldGridHeight, oldGridWidth, newGridHeight, newGridWidth) {
- setupHeightStyle(newGridHeight);
- });
- }
- $scope.i18n = {
- close: i18nService.getSafeText('columnMenu.close')
- };
- // *** Show/Hide functions ******
- $scope.showMenu = function(event, args) {
- if ( !$scope.shown ){
- /*
- * In order to animate cleanly we remove the ng-if, wait a digest cycle, then
- * animate the removal of the ng-hide. We can't successfully (so far as I can tell)
- * animate removal of the ng-if, as the menu items aren't there yet. And we don't want
- * to rely on ng-show only, as that leaves elements in the DOM that are needlessly evaluated
- * on scroll events.
- *
- * Note when testing animation that animations don't run on the tutorials. When debugging it looks
- * like they do, but angular has a default $animate provider that is just a stub, and that's what's
- * being called. ALso don't be fooled by the fact that your browser has actually loaded the
- * angular-translate.js, it's not using it. You need to test animations in an external application.
- */
- $scope.shown = true;
- // Must be a timeout in order to work properly in Firefox. Issue #6533
- $timeout(function() {
- $scope.shownMid = true;
- $scope.$emit('menu-shown');
- });
- } else if ( !$scope.shownMid ) {
- // we're probably doing a hide then show, so we don't need to wait for ng-if
- $scope.shownMid = true;
- $scope.$emit('menu-shown');
- }
- var docEventType = 'click';
- if (args && args.originalEvent && args.originalEvent.type && args.originalEvent.type === 'touchstart') {
- docEventType = args.originalEvent.type;
- }
- // Turn off an existing document click handler
- angular.element(document).off('click touchstart', applyHideMenu);
- $elm.off('keyup', checkKeyUp);
- $elm.off('keydown', checkKeyDown);
- // Turn on the document click handler, but in a timeout so it doesn't apply to THIS click if there is one
- $timeout(function() {
- angular.element(document).on(docEventType, applyHideMenu);
- $elm.on('keyup', checkKeyUp);
- $elm.on('keydown', checkKeyDown);
- });
- };
- $scope.hideMenu = function(event) {
- if ( $scope.shown ){
- /*
- * In order to animate cleanly we animate the addition of ng-hide, then use a $timeout to
- * set the ng-if (shown = false) after the animation runs. In theory we can cascade off the
- * callback on the addClass method, but it is very unreliable with unit tests for no discernable reason.
- *
- * The user may have clicked on the menu again whilst
- * we're waiting, so we check that the mid isn't shown before applying the ng-if.
- */
- $scope.shownMid = false;
- $timeout( function() {
- if ( !$scope.shownMid ){
- $scope.shown = false;
- $scope.$emit('menu-hidden');
- }
- }, 40);
- }
- angular.element(document).off('click touchstart', applyHideMenu);
- $elm.off('keyup', checkKeyUp);
- $elm.off('keydown', checkKeyDown);
- };
- $scope.$on('hide-menu', function (event, args) {
- $scope.hideMenu(event, args);
- });
- $scope.$on('show-menu', function (event, args) {
- $scope.showMenu(event, args);
- });
- // *** Auto hide when click elsewhere ******
- var applyHideMenu = function(){
- if ($scope.shown) {
- $scope.$apply(function () {
- $scope.hideMenu();
- });
- }
- };
- // close menu on ESC and keep tab cyclical
- var checkKeyUp = function(event) {
- if (event.keyCode === 27) {
- $scope.hideMenu();
- }
- };
- var checkKeyDown = function(event) {
- var setFocus = function(elm) {
- elm.focus();
- event.preventDefault();
- return false;
- };
- if (event.keyCode === 9) {
- var firstMenuItem, lastMenuItem;
- var menuItemButtons = $elm[0].querySelectorAll('button:not(.ng-hide)');
- if (menuItemButtons.length > 0) {
- firstMenuItem = menuItemButtons[0];
- lastMenuItem = menuItemButtons[menuItemButtons.length - 1];
- if (event.target === lastMenuItem && !event.shiftKey) {
- setFocus(firstMenuItem);
- } else if (event.target === firstMenuItem && event.shiftKey) {
- setFocus(lastMenuItem);
- }
- }
- }
- };
- if (typeof($scope.autoHide) === 'undefined' || $scope.autoHide === undefined) {
- $scope.autoHide = true;
- }
- if ($scope.autoHide) {
- angular.element($window).on('resize', applyHideMenu);
- }
- $scope.$on('$destroy', function unbindEvents() {
- angular.element($window).off('resize', applyHideMenu);
- angular.element(document).off('click touchstart', applyHideMenu);
- $elm.off('keyup', checkKeyUp);
- $elm.off('keydown', checkKeyDown);
- });
- if (uiGridCtrl) {
- $scope.$on('$destroy', uiGridCtrl.grid.api.core.on.scrollBegin($scope, applyHideMenu ));
- }
- $scope.$on('$destroy', $scope.$on(uiGridConstants.events.ITEM_DRAGGING, applyHideMenu ));
- }
- };
- return uiGridMenu;
- }])
- .directive('uiGridMenuItem', ['gridUtil', '$compile', 'i18nService', function (gridUtil, $compile, i18nService) {
- var uiGridMenuItem = {
- priority: 0,
- scope: {
- name: '=',
- active: '=',
- action: '=',
- icon: '=',
- shown: '=',
- context: '=',
- templateUrl: '=',
- leaveOpen: '=',
- screenReaderOnly: '='
- },
- require: ['?^uiGrid'],
- templateUrl: 'ui-grid/uiGridMenuItem',
- replace: false,
- compile: function() {
- return {
- pre: function ($scope, $elm) {
- if ($scope.templateUrl) {
- gridUtil.getTemplate($scope.templateUrl)
- .then(function (contents) {
- var template = angular.element(contents);
- var newElm = $compile(template)($scope);
- $elm.replaceWith(newElm);
- }).catch(angular.noop);
- }
- },
- post: function ($scope, $elm, $attrs, controllers) {
- var uiGridCtrl = controllers[0];
- // TODO(c0bra): validate that shown and active are functions if they're defined. An exception is already thrown above this though
- // if (typeof($scope.shown) !== 'undefined' && $scope.shown && typeof($scope.shown) !== 'function') {
- // throw new TypeError("$scope.shown is defined but not a function");
- // }
- if (typeof($scope.shown) === 'undefined' || $scope.shown === null) {
- $scope.shown = function() { return true; };
- }
- $scope.itemShown = function () {
- var context = {};
- if ($scope.context) {
- context.context = $scope.context;
- }
- if (typeof(uiGridCtrl) !== 'undefined' && uiGridCtrl) {
- context.grid = uiGridCtrl.grid;
- }
- return $scope.shown.call(context);
- };
- $scope.itemAction = function($event,title) {
- $event.stopPropagation();
- if (typeof($scope.action) === 'function') {
- var context = {};
- if ($scope.context) {
- context.context = $scope.context;
- }
- // Add the grid to the function call context if the uiGrid controller is present
- if (typeof(uiGridCtrl) !== 'undefined' && uiGridCtrl) {
- context.grid = uiGridCtrl.grid;
- }
- $scope.action.call(context, $event, title);
- if ( !$scope.leaveOpen ){
- $scope.$emit('hide-menu');
- } else {
- // Maintain focus on the selected item
- var correctParent = $event.target.parentElement;
- // nodeName of 'I' means target is i element, need the next parent
- if (angular.element($event.target)[0].nodeName === 'I') {
- correctParent = correctParent.parentElement;
- }
- gridUtil.focus.bySelector(correctParent, 'button[type=button]', true);
- }
- }
- };
- $scope.label = function(){
- var toBeDisplayed = $scope.name;
- if (typeof($scope.name) === 'function'){
- toBeDisplayed = $scope.name.call();
- }
- return toBeDisplayed;
- };
- $scope.i18n = i18nService.get();
- }
- };
- }
- };
- return uiGridMenuItem;
- }]);
- })();
- (function(){
- 'use strict';
- /**
- * @ngdoc overview
- * @name ui.grid.directive:uiGridOneBind
- * @summary A group of directives that provide a one time bind to a dom element.
- * @description A group of directives that provide a one time bind to a dom element.
- * As one time bindings are not supported in Angular 1.2.* this directive provdes this capability.
- * This is done to reduce the number of watchers on the dom.
- * <br/>
- * <h2>Short Example ({@link ui.grid.directive:uiGridOneBindSrc ui-grid-one-bind-src})</h2>
- * <pre>
- <div ng-init="imageName = 'myImageDir.jpg'">
- <img ui-grid-one-bind-src="imageName"></img>
- </div>
- </pre>
- * Will become:
- * <pre>
- <div ng-init="imageName = 'myImageDir.jpg'">
- <img ui-grid-one-bind-src="imageName" src="myImageDir.jpg"></img>
- </div>
- </pre>
- </br>
- <h2>Short Example ({@link ui.grid.directive:uiGridOneBindText ui-grid-one-bind-text})</h2>
- * <pre>
- <div ng-init="text='Add this text'" ui-grid-one-bind-text="text"></div>
- </pre>
- * Will become:
- * <pre>
- <div ng-init="text='Add this text'" ui-grid-one-bind-text="text">Add this text</div>
- </pre>
- </br>
- * <b>Note:</b> This behavior is slightly different for the {@link ui.grid.directive:uiGridOneBindIdGrid uiGridOneBindIdGrid}
- * and {@link ui.grid.directive:uiGridOneBindAriaLabelledbyGrid uiGridOneBindAriaLabelledbyGrid} directives.
- *
- */
- //https://github.com/joshkurz/Black-Belt-AngularJS-Directives/blob/master/directives/Optimization/oneBind.js
- var oneBinders = angular.module('ui.grid');
- angular.forEach([
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindSrc
- * @memberof ui.grid.directive:uiGridOneBind
- * @element img
- * @restrict A
- * @param {String} uiGridOneBindSrc The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the src dom tag.
- *
- */
- {tag: 'Src', method: 'attr'},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindText
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindText The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the text dom tag.
- */
- {tag: 'Text', method: 'text'},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindHref
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindHref The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the href dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- */
- {tag: 'Href', method: 'attr'},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindClass
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindClass The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @param {Object} uiGridOneBindClass The object that you want to bind. At least one of the values in the object must be something other than null or undefined for the watcher to be removed.
- * this is to prevent the watcher from being removed before the scope is initialized.
- * @param {Array} uiGridOneBindClass An array of classes to bind to this element.
- * @description One time binding for the class dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- */
- {tag: 'Class', method: 'addClass'},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindHtml
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindHtml The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the html method on a dom element. For more information see {@link ui.grid.directive:uiGridOneBind}.
- */
- {tag: 'Html', method: 'html'},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindAlt
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindAlt The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the alt dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- */
- {tag: 'Alt', method: 'attr'},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindStyle
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindStyle The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the style dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- */
- {tag: 'Style', method: 'css'},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindValue
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindValue The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the value dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- */
- {tag: 'Value', method: 'attr'},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindId
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindId The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the value dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- */
- {tag: 'Id', method: 'attr'},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindIdGrid
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindIdGrid The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the id dom tag.
- * <h1>Important Note!</h1>
- * If the id tag passed as a parameter does <b>not</b> contain the grid id as a substring
- * then the directive will search the scope and the parent controller (if it is a uiGridController) for the grid.id value.
- * If this value is found then it is appended to the begining of the id tag. If the grid is not found then the directive throws an error.
- * This is done in order to ensure uniqueness of id tags across the grid.
- * This is to prevent two grids in the same document having duplicate id tags.
- */
- {tag: 'Id', directiveName:'IdGrid', method: 'attr', appendGridId: true},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindTitle
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindTitle The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the title dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- */
- {tag: 'Title', method: 'attr'},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindAriaLabel
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindAriaLabel The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the aria-label dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- *<br/>
- * <pre>
- <div ng-init="text='Add this text'" ui-grid-one-bind-aria-label="text"></div>
- </pre>
- * Will become:
- * <pre>
- <div ng-init="text='Add this text'" ui-grid-one-bind-aria-label="text" aria-label="Add this text"></div>
- </pre>
- */
- {tag: 'Label', method: 'attr', aria:true},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindAriaLabelledby
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindAriaLabelledby The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the aria-labelledby dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- *<br/>
- * <pre>
- <div ng-init="anId = 'gridID32'" ui-grid-one-bind-aria-labelledby="anId"></div>
- </pre>
- * Will become:
- * <pre>
- <div ng-init="anId = 'gridID32'" ui-grid-one-bind-aria-labelledby="anId" aria-labelledby="gridID32"></div>
- </pre>
- */
- {tag: 'Labelledby', method: 'attr', aria:true},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindAriaLabelledbyGrid
- * @element div
- * @restrict A
- * @param {String} uiGridOneBindAriaLabelledbyGrid The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the aria-labelledby dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- * Works somewhat like {@link ui.grid.directive:uiGridOneBindIdGrid} however this one supports a list of ids (seperated by a space) and will dynamically add the
- * grid id to each one.
- *<br/>
- * <pre>
- <div ng-init="anId = 'gridID32'" ui-grid-one-bind-aria-labelledby-grid="anId"></div>
- </pre>
- * Will become ([grid.id] will be replaced by the actual grid id):
- * <pre>
- <div ng-init="anId = 'gridID32'" ui-grid-one-bind-aria-labelledby-grid="anId" aria-labelledby-Grid="[grid.id]-gridID32"></div>
- </pre>
- */
- {tag: 'Labelledby', directiveName:'LabelledbyGrid', appendGridId:true, method: 'attr', aria:true},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindAriaDescribedby
- * @element ANY
- * @restrict A
- * @param {String} uiGridOneBindAriaDescribedby The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the aria-describedby dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- *<br/>
- * <pre>
- <div ng-init="anId = 'gridID32'" ui-grid-one-bind-aria-describedby="anId"></div>
- </pre>
- * Will become:
- * <pre>
- <div ng-init="anId = 'gridID32'" ui-grid-one-bind-aria-describedby="anId" aria-describedby="gridID32"></div>
- </pre>
- */
- {tag: 'Describedby', method: 'attr', aria:true},
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridOneBindAriaDescribedbyGrid
- * @element ANY
- * @restrict A
- * @param {String} uiGridOneBindAriaDescribedbyGrid The angular string you want to bind. Does not support interpolation. Don't use <code>{{scopeElt}}</code> instead use <code>scopeElt</code>.
- * @description One time binding for the aria-labelledby dom tag. For more information see {@link ui.grid.directive:uiGridOneBind}.
- * Works somewhat like {@link ui.grid.directive:uiGridOneBindIdGrid} however this one supports a list of ids (seperated by a space) and will dynamically add the
- * grid id to each one.
- *<br/>
- * <pre>
- <div ng-init="anId = 'gridID32'" ui-grid-one-bind-aria-describedby-grid="anId"></div>
- </pre>
- * Will become ([grid.id] will be replaced by the actual grid id):
- * <pre>
- <div ng-init="anId = 'gridID32'" ui-grid-one-bind-aria-describedby-grid="anId" aria-describedby="[grid.id]-gridID32"></div>
- </pre>
- */
- {tag: 'Describedby', directiveName:'DescribedbyGrid', appendGridId:true, method: 'attr', aria:true}],
- function(v){
- var baseDirectiveName = 'uiGridOneBind';
- //If it is an aria tag then append the aria label seperately
- //This is done because the aria tags are formatted aria-* and the directive name can't have a '-' character in it.
- //If the diretiveName has to be overridden then it does so here. This is because the tag being modified and the directive sometimes don't match up.
- var directiveName = (v.aria ? baseDirectiveName + 'Aria' : baseDirectiveName) + (v.directiveName ? v.directiveName : v.tag);
- oneBinders.directive(directiveName, ['gridUtil', function(gridUtil){
- return {
- restrict: 'A',
- require: ['?uiGrid','?^uiGrid'],
- link: function(scope, iElement, iAttrs, controllers){
- /* Appends the grid id to the beginnig of the value. */
- var appendGridId = function(val){
- var grid; //Get an instance of the grid if its available
- //If its available in the scope then we don't need to try to find it elsewhere
- if (scope.grid) {
- grid = scope.grid;
- }
- //Another possible location to try to find the grid
- else if (scope.col && scope.col.grid){
- grid = scope.col.grid;
- }
- //Last ditch effort: Search through the provided controllers.
- else if (!controllers.some( //Go through the controllers till one has the element we need
- function(controller){
- if (controller && controller.grid) {
- grid = controller.grid;
- return true; //We've found the grid
- }
- })){
- //We tried our best to find it for you
- gridUtil.logError("["+directiveName+"] A valid grid could not be found to bind id. Are you using this directive " +
- "within the correct scope? Trying to generate id: [gridID]-" + val);
- throw new Error("No valid grid could be found");
- }
- if (grid){
- var idRegex = new RegExp(grid.id.toString());
- //If the grid id hasn't been appended already in the template declaration
- if (!idRegex.test(val)){
- val = grid.id.toString() + '-' + val;
- }
- }
- return val;
- };
- // The watch returns a function to remove itself.
- var rmWatcher = scope.$watch(iAttrs[directiveName], function(newV){
- if (newV){
- //If we are trying to add an id element then we also apply the grid id if it isn't already there
- if (v.appendGridId) {
- var newIdString = null;
- //Append the id to all of the new ids.
- angular.forEach( newV.split(' '), function(s){
- newIdString = (newIdString ? (newIdString + ' ') : '') + appendGridId(s);
- });
- newV = newIdString;
- }
- // Append this newValue to the dom element.
- switch (v.method) {
- case 'attr': //The attr method takes two paraams the tag and the value
- if (v.aria) {
- //If it is an aria element then append the aria prefix
- iElement[v.method]('aria-' + v.tag.toLowerCase(),newV);
- } else {
- iElement[v.method](v.tag.toLowerCase(),newV);
- }
- break;
- case 'addClass':
- //Pulled from https://github.com/Pasvaz/bindonce/blob/master/bindonce.js
- if (angular.isObject(newV) && !angular.isArray(newV)) {
- var results = [];
- var nonNullFound = false; //We don't want to remove the binding unless the key is actually defined
- angular.forEach(newV, function (value, index) {
- if (value !== null && typeof(value) !== "undefined"){
- nonNullFound = true; //A non null value for a key was found so the object must have been initialized
- if (value) {results.push(index);}
- }
- });
- //A non null value for a key wasn't found so assume that the scope values haven't been fully initialized
- if (!nonNullFound){
- return; // If not initialized then the watcher should not be removed yet.
- }
- newV = results;
- }
- if (newV) {
- iElement.addClass(angular.isArray(newV) ? newV.join(' ') : newV);
- } else {
- return;
- }
- break;
- default:
- iElement[v.method](newV);
- break;
- }
- //Removes the watcher on itself after the bind
- rmWatcher();
- }
- // True ensures that equality is determined using angular.equals instead of ===
- }, true); //End rm watchers
- } //End compile function
- }; //End directive return
- } // End directive function
- ]); //End directive
- }); // End angular foreach
- })();
- (function () {
- 'use strict';
- var module = angular.module('ui.grid');
- module.directive('uiGridRenderContainer', ['$timeout', '$document', 'uiGridConstants', 'gridUtil', 'ScrollEvent',
- function($timeout, $document, uiGridConstants, gridUtil, ScrollEvent) {
- return {
- replace: true,
- transclude: true,
- templateUrl: 'ui-grid/uiGridRenderContainer',
- require: ['^uiGrid', 'uiGridRenderContainer'],
- scope: {
- containerId: '=',
- rowContainerName: '=',
- colContainerName: '=',
- bindScrollHorizontal: '=',
- bindScrollVertical: '=',
- enableVerticalScrollbar: '=',
- enableHorizontalScrollbar: '='
- },
- controller: 'uiGridRenderContainer as RenderContainer',
- compile: function () {
- return {
- pre: function prelink($scope, $elm, $attrs, controllers) {
- var uiGridCtrl = controllers[0];
- var containerCtrl = controllers[1];
- var grid = $scope.grid = uiGridCtrl.grid;
- // Verify that the render container for this element exists
- if (!$scope.rowContainerName) {
- throw new Error("No row render container name specified");
- }
- if (!$scope.colContainerName) {
- throw new Error("No column render container name specified");
- }
- if (!grid.renderContainers[$scope.rowContainerName]) {
- throw new Error("Row render container '" + $scope.rowContainerName + "' is not registered.");
- }
- if (!grid.renderContainers[$scope.colContainerName]) {
- throw new Error("Column render container '" + $scope.colContainerName + "' is not registered.");
- }
- var rowContainer = $scope.rowContainer = grid.renderContainers[$scope.rowContainerName];
- var colContainer = $scope.colContainer = grid.renderContainers[$scope.colContainerName];
- containerCtrl.containerId = $scope.containerId;
- containerCtrl.rowContainer = rowContainer;
- containerCtrl.colContainer = colContainer;
- },
- post: function postlink($scope, $elm, $attrs, controllers) {
- var uiGridCtrl = controllers[0];
- var containerCtrl = controllers[1];
- var grid = uiGridCtrl.grid;
- var rowContainer = containerCtrl.rowContainer;
- var colContainer = containerCtrl.colContainer;
- var scrollTop = null;
- var scrollLeft = null;
- var renderContainer = grid.renderContainers[$scope.containerId];
- // Put the container name on this element as a class
- $elm.addClass('ui-grid-render-container-' + $scope.containerId);
- // Scroll the render container viewport when the mousewheel is used
- gridUtil.on.mousewheel($elm, function (event) {
- var scrollEvent = new ScrollEvent(grid, rowContainer, colContainer, ScrollEvent.Sources.RenderContainerMouseWheel);
- if (event.deltaY !== 0) {
- var scrollYAmount = event.deltaY * -1 * event.deltaFactor;
- scrollTop = containerCtrl.viewport[0].scrollTop;
- // Get the scroll percentage
- scrollEvent.verticalScrollLength = rowContainer.getVerticalScrollLength();
- var scrollYPercentage = (scrollTop + scrollYAmount) / scrollEvent.verticalScrollLength;
- // If we should be scrolled 100%, make sure the scrollTop matches the maximum scroll length
- // Viewports that have "overflow: hidden" don't let the mousewheel scroll all the way to the bottom without this check
- if (scrollYPercentage >= 1 && scrollTop < scrollEvent.verticalScrollLength) {
- containerCtrl.viewport[0].scrollTop = scrollEvent.verticalScrollLength;
- }
- // Keep scrollPercentage within the range 0-1.
- if (scrollYPercentage < 0) { scrollYPercentage = 0; }
- else if (scrollYPercentage > 1) { scrollYPercentage = 1; }
- scrollEvent.y = { percentage: scrollYPercentage, pixels: scrollYAmount };
- }
- if (event.deltaX !== 0) {
- var scrollXAmount = event.deltaX * event.deltaFactor;
- // Get the scroll percentage
- scrollLeft = gridUtil.normalizeScrollLeft(containerCtrl.viewport, grid);
- scrollEvent.horizontalScrollLength = (colContainer.getCanvasWidth() - colContainer.getViewportWidth());
- var scrollXPercentage = (scrollLeft + scrollXAmount) / scrollEvent.horizontalScrollLength;
- // Keep scrollPercentage within the range 0-1.
- if (scrollXPercentage < 0) { scrollXPercentage = 0; }
- else if (scrollXPercentage > 1) { scrollXPercentage = 1; }
- scrollEvent.x = { percentage: scrollXPercentage, pixels: scrollXAmount };
- }
- // Let the parent container scroll if the grid is already at the top/bottom
- if ((event.deltaY !== 0 && (scrollEvent.atTop(scrollTop) || scrollEvent.atBottom(scrollTop))) ||
- (event.deltaX !== 0 && (scrollEvent.atLeft(scrollLeft) || scrollEvent.atRight(scrollLeft)))) {
- //parent controller scrolls
- }
- else {
- event.preventDefault();
- event.stopPropagation();
- scrollEvent.fireThrottledScrollingEvent('', scrollEvent);
- }
- });
- $elm.bind('$destroy', function() {
- $elm.unbind('keydown');
- ['touchstart', 'touchmove', 'touchend','keydown', 'wheel', 'mousewheel', 'DomMouseScroll', 'MozMousePixelScroll'].forEach(function (eventName) {
- $elm.unbind(eventName);
- });
- });
- // TODO(c0bra): Handle resizing the inner canvas based on the number of elements
- function update() {
- var ret = '';
- var canvasWidth = colContainer.canvasWidth;
- var viewportWidth = colContainer.getViewportWidth();
- var canvasHeight = rowContainer.getCanvasHeight();
- //add additional height for scrollbar on left and right container
- //if ($scope.containerId !== 'body') {
- // canvasHeight -= grid.scrollbarHeight;
- //}
- var viewportHeight = rowContainer.getViewportHeight();
- //shorten the height to make room for a scrollbar placeholder
- if (colContainer.needsHScrollbarPlaceholder()) {
- viewportHeight -= grid.scrollbarHeight;
- }
- var headerViewportWidth,
- footerViewportWidth;
- headerViewportWidth = footerViewportWidth = colContainer.getHeaderViewportWidth();
- // Set canvas dimensions
- ret += '\n .grid' + uiGridCtrl.grid.id + ' .ui-grid-render-container-' + $scope.containerId + ' .ui-grid-canvas { width: ' + canvasWidth + 'px; height: ' + canvasHeight + 'px; }';
- ret += '\n .grid' + uiGridCtrl.grid.id + ' .ui-grid-render-container-' + $scope.containerId + ' .ui-grid-header-canvas { width: ' + (canvasWidth + grid.scrollbarWidth) + 'px; }';
- if (renderContainer.explicitHeaderCanvasHeight) {
- // get height from body container
- var reHCHeight = document.querySelector(
- '.grid' + uiGridCtrl.grid.id + ' .ui-grid-render-container-body .ui-grid-header-canvas');
- if (reHCHeight) {
- renderContainer.explicitHeaderCanvasHeight = reHCHeight.offsetHeight;
- }
- ret += '\n .grid' + uiGridCtrl.grid.id + ' .ui-grid-render-container-' + $scope.containerId +
- ' .ui-grid-header-canvas { height: ' + renderContainer.explicitHeaderCanvasHeight + 'px; }';
- }
- else {
- ret += '\n .grid' + uiGridCtrl.grid.id + ' .ui-grid-render-container-' + $scope.containerId + ' .ui-grid-header-canvas { height: inherit; }';
- }
-
- ret += '\n .grid' + uiGridCtrl.grid.id + ' .ui-grid-render-container-' + $scope.containerId +
- ' .ui-grid-viewport { width: ' + viewportWidth + 'px; height: ' + viewportHeight + 'px; }';
- ret += '\n .grid' + uiGridCtrl.grid.id + ' .ui-grid-render-container-' + $scope.containerId +
- ' .ui-grid-header-viewport { width: ' + headerViewportWidth + 'px; }';
- ret += '\n .grid' + uiGridCtrl.grid.id + ' .ui-grid-render-container-' + $scope.containerId +
- ' .ui-grid-footer-canvas { width: ' + (canvasWidth + grid.scrollbarWidth) + 'px; }';
- ret += '\n .grid' + uiGridCtrl.grid.id + ' .ui-grid-render-container-' + $scope.containerId +
- ' .ui-grid-footer-viewport { width: ' + footerViewportWidth + 'px; }';
- return ret;
- }
- uiGridCtrl.grid.registerStyleComputation({
- priority: 6,
- func: update
- });
- }
- };
- }
- };
- }]);
- module.controller('uiGridRenderContainer', ['$scope', 'gridUtil', function ($scope, gridUtil) {
- }]);
- })();
- (function(){
- 'use strict';
- angular.module('ui.grid').directive('uiGridRow', ['gridUtil', function(gridUtil) {
- return {
- replace: true,
- // priority: 2001,
- // templateUrl: 'ui-grid/ui-grid-row',
- require: ['^uiGrid', '^uiGridRenderContainer'],
- scope: {
- row: '=uiGridRow',
- //rowRenderIndex is added to scope to give the true visual index of the row to any directives that need it
- rowRenderIndex: '='
- },
- compile: function() {
- return {
- pre: function($scope, $elm, $attrs, controllers) {
- var uiGridCtrl = controllers[0];
- var containerCtrl = controllers[1];
- var grid = uiGridCtrl.grid;
- $scope.grid = uiGridCtrl.grid;
- $scope.colContainer = containerCtrl.colContainer;
- // Function for attaching the template to this scope
- var clonedElement, cloneScope;
- function compileTemplate() {
- $scope.row.getRowTemplateFn.then(function (compiledElementFn) {
- // var compiledElementFn = $scope.row.compiledElementFn;
- // Create a new scope for the contents of this row, so we can destroy it later if need be
- var newScope = $scope.$new();
- compiledElementFn(newScope, function (newElm, scope) {
- // If we already have a cloned element, we need to remove it and destroy its scope
- if (clonedElement) {
- clonedElement.remove();
- cloneScope.$destroy();
- }
- // Empty the row and append the new element
- $elm.empty().append(newElm);
- // Save the new cloned element and scope
- clonedElement = newElm;
- cloneScope = newScope;
- });
- }).catch(angular.noop);
- }
- // Initially attach the compiled template to this scope
- compileTemplate();
- // If the row's compiled element function changes, we need to replace this element's contents with the new compiled template
- $scope.$watch('row.getRowTemplateFn', function (newFunc, oldFunc) {
- if (newFunc !== oldFunc) {
- compileTemplate();
- }
- });
- },
- post: function($scope, $elm, $attrs, controllers) {
- }
- };
- }
- };
- }]);
- })();
- (function(){
- // 'use strict';
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGridStyle
- * @element style
- * @restrict A
- *
- * @description
- * Allows us to interpolate expressions in `<style>` elements. Angular doesn't do this by default as it can/will/might? break in IE8.
- *
- * @example
- <doc:example module="app">
- <doc:source>
- <script>
- var app = angular.module('app', ['ui.grid']);
- app.controller('MainCtrl', ['$scope', function ($scope) {
- $scope.myStyle = '.blah { border: 1px solid }';
- }]);
- </script>
- <div ng-controller="MainCtrl">
- <style ui-grid-style>{{ myStyle }}</style>
- <span class="blah">I am in a box.</span>
- </div>
- </doc:source>
- <doc:scenario>
- it('should apply the right class to the element', function () {
- element(by.css('.blah')).getCssValue('border-top-width')
- .then(function(c) {
- expect(c).toContain('1px');
- });
- });
- </doc:scenario>
- </doc:example>
- */
- angular.module('ui.grid').directive('uiGridStyle', ['gridUtil', '$interpolate', function(gridUtil, $interpolate) {
- return {
- // restrict: 'A',
- // priority: 1000,
- // require: '?^uiGrid',
- link: function($scope, $elm, $attrs, uiGridCtrl) {
- // gridUtil.logDebug('ui-grid-style link');
- // if (uiGridCtrl === undefined) {
- // gridUtil.logWarn('[ui-grid-style link] uiGridCtrl is undefined!');
- // }
- var interpolateFn = $interpolate($elm.text(), true);
- if (interpolateFn) {
- $scope.$watch(interpolateFn, function(value) {
- $elm.text(value);
- });
- }
- // uiGridCtrl.recalcRowStyles = function() {
- // var offset = (scope.options.offsetTop || 0) - (scope.options.excessRows * scope.options.rowHeight);
- // var rowHeight = scope.options.rowHeight;
- // var ret = '';
- // var rowStyleCount = uiGridCtrl.minRowsToRender() + (scope.options.excessRows * 2);
- // for (var i = 1; i <= rowStyleCount; i++) {
- // ret = ret + ' .grid' + scope.gridId + ' .ui-grid-row:nth-child(' + i + ') { top: ' + offset + 'px; }';
- // offset = offset + rowHeight;
- // }
- // scope.rowStyles = ret;
- // };
- // uiGridCtrl.styleComputions.push(uiGridCtrl.recalcRowStyles);
- }
- };
- }]);
- })();
- (function(){
- 'use strict';
- angular.module('ui.grid').directive('uiGridViewport', ['gridUtil','ScrollEvent','uiGridConstants', '$log',
- function(gridUtil, ScrollEvent, uiGridConstants, $log) {
- return {
- replace: true,
- scope: {},
- controllerAs: 'Viewport',
- templateUrl: 'ui-grid/uiGridViewport',
- require: ['^uiGrid', '^uiGridRenderContainer'],
- link: function($scope, $elm, $attrs, controllers) {
- // gridUtil.logDebug('viewport post-link');
- var uiGridCtrl = controllers[0];
- var containerCtrl = controllers[1];
- $scope.containerCtrl = containerCtrl;
- var rowContainer = containerCtrl.rowContainer;
- var colContainer = containerCtrl.colContainer;
- var grid = uiGridCtrl.grid;
- $scope.grid = uiGridCtrl.grid;
- // Put the containers in scope so we can get rows and columns from them
- $scope.rowContainer = containerCtrl.rowContainer;
- $scope.colContainer = containerCtrl.colContainer;
- // Register this viewport with its container
- containerCtrl.viewport = $elm;
- /**
- * @ngdoc function
- * @name customScroller
- * @methodOf ui.grid.class:GridOptions
- * @description (optional) uiGridViewport.on('scroll', scrollHandler) by default.
- * A function that allows you to provide your own scroller function. It is particularly helpful if you want to use third party scrollers
- * as this allows you to do that.
- *
- * <div class="alert alert-info" role="alert"> <strong>NOTE:</strong> It is important to remember to always pass in an event object to
- * the scrollHandler as the grid scrolling behavior will break without it.</div>
- * <h5>Example</h5>
- * <pre>
- * $scope.gridOptions = {
- * customScroller: function myScrolling(uiGridViewport, scrollHandler) {
- * uiGridViewport.on('scroll', function myScrollingOverride(event) {
- * // Do something here
- *
- * scrollHandler(event);
- * });
- * }
- * };
- * </pre>
- * @param {object} uiGridViewport Element being scrolled. (this gets passed in by the grid).
- * @param {function} scrollHandler Function that needs to be called when scrolling happens. (this gets passed in by the grid).
- */
- if (grid && grid.options && grid.options.customScroller) {
- grid.options.customScroller($elm, scrollHandler);
- } else {
- $elm.on('scroll', scrollHandler);
- }
- var ignoreScroll = false;
- function scrollHandler(evt) {
- //Leaving in this commented code in case it can someday be used
- //It does improve performance, but because the horizontal scroll is normalized,
- // using this code will lead to the column header getting slightly out of line with columns
- //
- //if (ignoreScroll && (grid.isScrollingHorizontally || grid.isScrollingHorizontally)) {
- // //don't ask for scrollTop if we just set it
- // ignoreScroll = false;
- // return;
- //}
- //ignoreScroll = true;
- var newScrollTop = $elm[0].scrollTop;
- var newScrollLeft = gridUtil.normalizeScrollLeft($elm, grid);
- var vertScrollPercentage = rowContainer.scrollVertical(newScrollTop);
- var horizScrollPercentage = colContainer.scrollHorizontal(newScrollLeft);
- var scrollEvent = new ScrollEvent(grid, rowContainer, colContainer, ScrollEvent.Sources.ViewPortScroll);
- scrollEvent.newScrollLeft = newScrollLeft;
- scrollEvent.newScrollTop = newScrollTop;
- if ( horizScrollPercentage > -1 ){
- scrollEvent.x = { percentage: horizScrollPercentage };
- }
- if ( vertScrollPercentage > -1 ){
- scrollEvent.y = { percentage: vertScrollPercentage };
- }
- grid.scrollContainers($scope.$parent.containerId, scrollEvent);
- }
- if ($scope.$parent.bindScrollVertical) {
- grid.addVerticalScrollSync($scope.$parent.containerId, syncVerticalScroll);
- }
- if ($scope.$parent.bindScrollHorizontal) {
- grid.addHorizontalScrollSync($scope.$parent.containerId, syncHorizontalScroll);
- grid.addHorizontalScrollSync($scope.$parent.containerId + 'header', syncHorizontalHeader);
- grid.addHorizontalScrollSync($scope.$parent.containerId + 'footer', syncHorizontalFooter);
- }
- function syncVerticalScroll(scrollEvent){
- containerCtrl.prevScrollArgs = scrollEvent;
- var newScrollTop = scrollEvent.getNewScrollTop(rowContainer,containerCtrl.viewport);
- $elm[0].scrollTop = newScrollTop;
- }
- function syncHorizontalScroll(scrollEvent){
- containerCtrl.prevScrollArgs = scrollEvent;
- var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
- $elm[0].scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
- }
- function syncHorizontalHeader(scrollEvent){
- var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
- if (containerCtrl.headerViewport) {
- containerCtrl.headerViewport.scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
- }
- }
- function syncHorizontalFooter(scrollEvent){
- var newScrollLeft = scrollEvent.getNewScrollLeft(colContainer, containerCtrl.viewport);
- if (containerCtrl.footerViewport) {
- containerCtrl.footerViewport.scrollLeft = gridUtil.denormalizeScrollLeft(containerCtrl.viewport,newScrollLeft, grid);
- }
- }
- $scope.$on('$destroy', function unbindEvents() {
- $elm.off();
- });
- },
- controller: ['$scope', function ($scope) {
- this.rowStyle = function (index) {
- var rowContainer = $scope.rowContainer;
- var colContainer = $scope.colContainer;
- var styles = {};
- if (rowContainer.currentTopRow !== 0){
- //top offset based on hidden rows count
- var translateY = "translateY("+ (rowContainer.currentTopRow * rowContainer.grid.options.rowHeight) +"px)";
- styles['transform'] = translateY;
- styles['-webkit-transform'] = translateY;
- styles['-ms-transform'] = translateY;
- }
- if (colContainer.currentFirstColumn !== 0) {
- if (colContainer.grid.isRTL()) {
- styles['margin-right'] = colContainer.columnOffset + 'px';
- }
- else {
- styles['margin-left'] = colContainer.columnOffset + 'px';
- }
- }
- return styles;
- };
- }]
- };
- }
- ]);
- })();
- (function() {
- angular.module('ui.grid')
- .directive('uiGridVisible', function uiGridVisibleAction() {
- return function ($scope, $elm, $attr) {
- $scope.$watch($attr.uiGridVisible, function (visible) {
- // $elm.css('visibility', visible ? 'visible' : 'hidden');
- $elm[visible ? 'removeClass' : 'addClass']('ui-grid-invisible');
- });
- };
- });
- })();
- (function () {
- 'use strict';
- angular.module('ui.grid').controller('uiGridController', ['$scope', '$element', '$attrs', 'gridUtil', '$q', 'uiGridConstants',
- 'gridClassFactory', '$parse', '$compile',
- function ($scope, $elm, $attrs, gridUtil, $q, uiGridConstants,
- gridClassFactory, $parse, $compile) {
- // gridUtil.logDebug('ui-grid controller');
- var self = this;
- var deregFunctions = [];
- self.grid = gridClassFactory.createGrid($scope.uiGrid);
- //assign $scope.$parent if appScope not already assigned
- self.grid.appScope = self.grid.appScope || $scope.$parent;
- $elm.addClass('grid' + self.grid.id);
- self.grid.rtl = gridUtil.getStyles($elm[0])['direction'] === 'rtl';
- // angular.extend(self.grid.options, );
- //all properties of grid are available on scope
- $scope.grid = self.grid;
- if ($attrs.uiGridColumns) {
- deregFunctions.push( $attrs.$observe('uiGridColumns', function(value) {
- self.grid.options.columnDefs = angular.isString(value) ? angular.fromJson(value) : value;
- self.grid.buildColumns()
- .then(function(){
- self.grid.preCompileCellTemplates();
- self.grid.refreshCanvas(true);
- }).catch(angular.noop);
- }) );
- }
- // prevents an error from being thrown when the array is not defined yet and fastWatch is on
- function getSize(array) {
- return array ? array.length : 0;
- }
- // if fastWatch is set we watch only the length and the reference, not every individual object
- if (self.grid.options.fastWatch) {
- self.uiGrid = $scope.uiGrid;
- if (angular.isString($scope.uiGrid.data)) {
- deregFunctions.push( $scope.$parent.$watch($scope.uiGrid.data, dataWatchFunction) );
- deregFunctions.push( $scope.$parent.$watch(function() {
- if ( self.grid.appScope[$scope.uiGrid.data] ){
- return self.grid.appScope[$scope.uiGrid.data].length;
- } else {
- return undefined;
- }
- }, dataWatchFunction) );
- } else {
- deregFunctions.push( $scope.$parent.$watch(function() { return $scope.uiGrid.data; }, dataWatchFunction) );
- deregFunctions.push( $scope.$parent.$watch(function() { return getSize($scope.uiGrid.data); }, function(){ dataWatchFunction($scope.uiGrid.data); }) );
- }
- deregFunctions.push( $scope.$parent.$watch(function() { return $scope.uiGrid.columnDefs; }, columnDefsWatchFunction) );
- deregFunctions.push( $scope.$parent.$watch(function() { return getSize($scope.uiGrid.columnDefs); }, function(){ columnDefsWatchFunction($scope.uiGrid.columnDefs); }) );
- } else {
- if (angular.isString($scope.uiGrid.data)) {
- deregFunctions.push( $scope.$parent.$watchCollection($scope.uiGrid.data, dataWatchFunction) );
- } else {
- deregFunctions.push( $scope.$parent.$watchCollection(function() { return $scope.uiGrid.data; }, dataWatchFunction) );
- }
- deregFunctions.push( $scope.$parent.$watchCollection(function() { return $scope.uiGrid.columnDefs; }, columnDefsWatchFunction) );
- }
- function columnDefsWatchFunction(n, o) {
- if (n && n !== o) {
- self.grid.options.columnDefs = $scope.uiGrid.columnDefs;
- self.grid.callDataChangeCallbacks(uiGridConstants.dataChange.COLUMN, {
- orderByColumnDefs: true,
- preCompileCellTemplates: true
- });
- }
- }
- var mostRecentData;
- function dataWatchFunction(newData) {
- // gridUtil.logDebug('dataWatch fired');
- var promises = [];
- if ( self.grid.options.fastWatch ) {
- if (angular.isString($scope.uiGrid.data)) {
- newData = self.grid.appScope.$eval($scope.uiGrid.data);
- } else {
- newData = $scope.uiGrid.data;
- }
- }
- mostRecentData = newData;
- if (newData) {
- // columns length is greater than the number of row header columns, which don't count because they're created automatically
- var hasColumns = self.grid.columns.length > (self.grid.rowHeaderColumns ? self.grid.rowHeaderColumns.length : 0);
- if (
- // If we have no columns
- !hasColumns &&
- // ... and we don't have a ui-grid-columns attribute, which would define columns for us
- !$attrs.uiGridColumns &&
- // ... and we have no pre-defined columns
- self.grid.options.columnDefs.length === 0 &&
- // ... but we DO have data
- newData.length > 0
- ) {
- // ... then build the column definitions from the data that we have
- self.grid.buildColumnDefsFromData(newData);
- }
- // If we haven't built columns before and either have some columns defined or some data defined
- if (!hasColumns && (self.grid.options.columnDefs.length > 0 || newData.length > 0)) {
- // Build the column set, then pre-compile the column cell templates
- promises.push(self.grid.buildColumns()
- .then(function() {
- self.grid.preCompileCellTemplates();
- }).catch(angular.noop));
- }
- $q.all(promises).then(function() {
- // use most recent data, rather than the potentially outdated data passed into watcher handler
- self.grid.modifyRows(mostRecentData)
- .then(function () {
- // if (self.viewport) {
- self.grid.redrawInPlace(true);
- // }
- $scope.$evalAsync(function() {
- self.grid.refreshCanvas(true);
- self.grid.callDataChangeCallbacks(uiGridConstants.dataChange.ROW);
- });
- }).catch(angular.noop);
- }).catch(angular.noop);
- }
- }
- var styleWatchDereg = $scope.$watch(function () { return self.grid.styleComputations; }, function() {
- self.grid.refreshCanvas(true);
- });
- $scope.$on('$destroy', function() {
- deregFunctions.forEach( function( deregFn ){ deregFn(); });
- styleWatchDereg();
- });
- self.fireEvent = function(eventName, args) {
- args = args || {};
- // Add the grid to the event arguments if it's not there
- if (angular.isUndefined(args.grid)) {
- args.grid = self.grid;
- }
- $scope.$broadcast(eventName, args);
- };
- self.innerCompile = function innerCompile(elm) {
- $compile(elm)($scope);
- };
- }]);
- /**
- * @ngdoc directive
- * @name ui.grid.directive:uiGrid
- * @element div
- * @restrict EA
- * @param {Object} uiGrid Options for the grid to use
- *
- * @description Create a very basic grid.
- *
- * @example
- <example module="app">
- <file name="app.js">
- var app = angular.module('app', ['ui.grid']);
- app.controller('MainCtrl', ['$scope', function ($scope) {
- $scope.data = [
- { name: 'Bob', title: 'CEO' },
- { name: 'Frank', title: 'Lowly Developer' }
- ];
- }]);
- </file>
- <file name="index.html">
- <div ng-controller="MainCtrl">
- <div ui-grid="{ data: data }"></div>
- </div>
- </file>
- </example>
- */
- angular.module('ui.grid').directive('uiGrid', uiGridDirective);
- uiGridDirective.$inject = ['$window', 'gridUtil', 'uiGridConstants'];
- function uiGridDirective($window, gridUtil, uiGridConstants) {
- return {
- templateUrl: 'ui-grid/ui-grid',
- scope: {
- uiGrid: '='
- },
- replace: true,
- transclude: true,
- controller: 'uiGridController',
- compile: function () {
- return {
- post: function ($scope, $elm, $attrs, uiGridCtrl) {
- var grid = uiGridCtrl.grid;
- // Initialize scrollbars (TODO: move to controller??)
- uiGridCtrl.scrollbars = [];
- grid.element = $elm;
- // See if the grid has a rendered width, if not, wait a bit and try again
- var sizeCheckInterval = 100; // ms
- var maxSizeChecks = 20; // 2 seconds total
- var sizeChecks = 0;
- // Setup (event listeners) the grid
- setup();
- // And initialize it
- init();
- // Mark rendering complete so API events can happen
- grid.renderingComplete();
- // If the grid doesn't have size currently, wait for a bit to see if it gets size
- checkSize();
- /*-- Methods --*/
- function checkSize() {
- // If the grid has no width and we haven't checked more than <maxSizeChecks> times, check again in <sizeCheckInterval> milliseconds
- if ($elm[0].offsetWidth <= 0 && sizeChecks < maxSizeChecks) {
- setTimeout(checkSize, sizeCheckInterval);
- sizeChecks++;
- } else {
- $scope.$applyAsync(init);
- }
- }
- // Setup event listeners and watchers
- function setup() {
- var deregisterLeftWatcher, deregisterRightWatcher;
- // Bind to window resize events
- angular.element($window).on('resize', gridResize);
- // Unbind from window resize events when the grid is destroyed
- $elm.on('$destroy', function () {
- angular.element($window).off('resize', gridResize);
- deregisterLeftWatcher();
- deregisterRightWatcher();
- });
- // If we add a left container after render, we need to watch and react
- deregisterLeftWatcher = $scope.$watch(function () { return grid.hasLeftContainer();}, function (newValue, oldValue) {
- if (newValue === oldValue) {
- return;
- }
- grid.refreshCanvas(true);
- });
- // If we add a right container after render, we need to watch and react
- deregisterRightWatcher = $scope.$watch(function () { return grid.hasRightContainer();}, function (newValue, oldValue) {
- if (newValue === oldValue) {
- return;
- }
- grid.refreshCanvas(true);
- });
- }
- // Initialize the directive
- function init() {
- grid.gridWidth = $scope.gridWidth = gridUtil.elementWidth($elm);
- // Default canvasWidth to the grid width, in case we don't get any column definitions to calculate it from
- grid.canvasWidth = uiGridCtrl.grid.gridWidth;
- grid.gridHeight = $scope.gridHeight = gridUtil.elementHeight($elm);
- // If the grid isn't tall enough to fit a single row, it's kind of useless. Resize it to fit a minimum number of rows
- if (grid.gridHeight - grid.scrollbarHeight <= grid.options.rowHeight && grid.options.enableMinHeightCheck) {
- autoAdjustHeight();
- }
- // Run initial canvas refresh
- grid.refreshCanvas(true);
- }
- // Set the grid's height ourselves in the case that its height would be unusably small
- function autoAdjustHeight() {
- // Figure out the new height
- var contentHeight = grid.options.minRowsToShow * grid.options.rowHeight;
- var headerHeight = grid.options.showHeader ? grid.options.headerRowHeight : 0;
- var footerHeight = grid.calcFooterHeight();
- var scrollbarHeight = 0;
- if (grid.options.enableHorizontalScrollbar === uiGridConstants.scrollbars.ALWAYS) {
- scrollbarHeight = gridUtil.getScrollbarWidth();
- }
- var maxNumberOfFilters = 0;
- // Calculates the maximum number of filters in the columns
- angular.forEach(grid.options.columnDefs, function(col) {
- if (col.hasOwnProperty('filter')) {
- if (maxNumberOfFilters < 1) {
- maxNumberOfFilters = 1;
- }
- }
- else if (col.hasOwnProperty('filters')) {
- if (maxNumberOfFilters < col.filters.length) {
- maxNumberOfFilters = col.filters.length;
- }
- }
- });
- if (grid.options.enableFiltering && !maxNumberOfFilters) {
- var allColumnsHaveFilteringTurnedOff = grid.options.columnDefs.length && grid.options.columnDefs.every(function(col) {
- return col.enableFiltering === false;
- });
- if (!allColumnsHaveFilteringTurnedOff) {
- maxNumberOfFilters = 1;
- }
- }
- var filterHeight = maxNumberOfFilters * headerHeight;
- var newHeight = headerHeight + contentHeight + footerHeight + scrollbarHeight + filterHeight;
- $elm.css('height', newHeight + 'px');
- grid.gridHeight = $scope.gridHeight = gridUtil.elementHeight($elm);
- }
- // Resize the grid on window resize events
- function gridResize() {
- grid.gridWidth = $scope.gridWidth = gridUtil.elementWidth($elm);
- grid.gridHeight = $scope.gridHeight = gridUtil.elementHeight($elm);
- grid.refreshCanvas(true);
- }
- }
- };
- }
- };
- }
- })();
- (function(){
- 'use strict';
- // TODO: rename this file to ui-grid-pinned-container.js
- angular.module('ui.grid').directive('uiGridPinnedContainer', ['gridUtil', function (gridUtil) {
- return {
- restrict: 'EA',
- replace: true,
- template: '<div class="ui-grid-pinned-container"><div ui-grid-render-container container-id="side" row-container-name="\'body\'" col-container-name="side" bind-scroll-vertical="true" class="{{ side }} ui-grid-render-container-{{ side }}"></div></div>',
- scope: {
- side: '=uiGridPinnedContainer'
- },
- require: '^uiGrid',
- compile: function compile() {
- return {
- post: function ($scope, $elm, $attrs, uiGridCtrl) {
- // gridUtil.logDebug('ui-grid-pinned-container ' + $scope.side + ' link');
- var grid = uiGridCtrl.grid;
- var myWidth = 0;
- $elm.addClass('ui-grid-pinned-container-' + $scope.side);
- // Monkey-patch the viewport width function
- if ($scope.side === 'left' || $scope.side === 'right') {
- grid.renderContainers[$scope.side].getViewportWidth = monkeyPatchedGetViewportWidth;
- }
- function monkeyPatchedGetViewportWidth() {
- /*jshint validthis: true */
- var self = this;
- var viewportWidth = 0;
- self.visibleColumnCache.forEach(function (column) {
- viewportWidth += column.drawnWidth;
- });
- var adjustment = self.getViewportAdjustment();
- viewportWidth = viewportWidth + adjustment.width;
- return viewportWidth;
- }
- function updateContainerWidth() {
- if ($scope.side === 'left' || $scope.side === 'right') {
- var cols = grid.renderContainers[$scope.side].visibleColumnCache;
- var width = 0;
- for (var i = 0; i < cols.length; i++) {
- var col = cols[i];
- width += col.drawnWidth || col.width || 0;
- }
- return width;
- }
- }
- function updateContainerDimensions() {
- var ret = '';
- // Column containers
- if ($scope.side === 'left' || $scope.side === 'right') {
- myWidth = updateContainerWidth();
- // gridUtil.logDebug('myWidth', myWidth);
- // TODO(c0bra): Subtract sum of col widths from grid viewport width and update it
- $elm.attr('style', null);
- // var myHeight = grid.renderContainers.body.getViewportHeight(); // + grid.horizontalScrollbarHeight;
- ret += '.grid' + grid.id + ' .ui-grid-pinned-container-' + $scope.side + ', .grid' + grid.id + ' .ui-grid-pinned-container-' + $scope.side + ' .ui-grid-render-container-' + $scope.side + ' .ui-grid-viewport { width: ' + myWidth + 'px; } ';
- }
- return ret;
- }
- grid.renderContainers.body.registerViewportAdjuster(function (adjustment) {
- myWidth = updateContainerWidth();
- // Subtract our own width
- adjustment.width -= myWidth;
- adjustment.side = $scope.side;
- return adjustment;
- });
- // Register style computation to adjust for columns in `side`'s render container
- grid.registerStyleComputation({
- priority: 15,
- func: updateContainerDimensions
- });
- }
- };
- }
- };
- }]);
- })();
- (function(){
- angular.module('ui.grid')
- .factory('Grid', ['$q', '$compile', '$parse', 'gridUtil', 'uiGridConstants', 'GridOptions', 'GridColumn', 'GridRow', 'GridApi', 'rowSorter', 'rowSearcher', 'GridRenderContainer', '$timeout','ScrollEvent',
- function($q, $compile, $parse, gridUtil, uiGridConstants, GridOptions, GridColumn, GridRow, GridApi, rowSorter, rowSearcher, GridRenderContainer, $timeout, ScrollEvent) {
- /**
- * @ngdoc object
- * @name ui.grid.core.api:PublicApi
- * @description Public Api for the core grid features
- *
- */
- /**
- * @ngdoc function
- * @name ui.grid.class:Grid
- * @description Grid is the main viewModel. Any properties or methods needed to maintain state are defined in
- * this prototype. One instance of Grid is created per Grid directive instance.
- * @param {object} options Object map of options to pass into the grid. An 'id' property is expected.
- */
- var Grid = function Grid(options) {
- var self = this;
- // Get the id out of the options, then remove it
- if (options !== undefined && typeof(options.id) !== 'undefined' && options.id) {
- if (!/^[_a-zA-Z0-9-]+$/.test(options.id)) {
- throw new Error("Grid id '" + options.id + '" is invalid. It must follow CSS selector syntax rules.');
- }
- }
- else {
- throw new Error('No ID provided. An ID must be given when creating a grid.');
- }
- self.id = options.id;
- delete options.id;
- // Get default options
- self.options = GridOptions.initialize( options );
- /**
- * @ngdoc object
- * @name appScope
- * @propertyOf ui.grid.class:Grid
- * @description reference to the application scope (the parent scope of the ui-grid element). Assigned in ui-grid controller
- * <br/>
- * use gridOptions.appScopeProvider to override the default assignment of $scope.$parent with any reference
- */
- self.appScope = self.options.appScopeProvider;
- self.headerHeight = self.options.headerRowHeight;
- /**
- * @ngdoc object
- * @name footerHeight
- * @propertyOf ui.grid.class:Grid
- * @description returns the total footer height gridFooter + columnFooter
- */
- self.footerHeight = self.calcFooterHeight();
- /**
- * @ngdoc object
- * @name columnFooterHeight
- * @propertyOf ui.grid.class:Grid
- * @description returns the total column footer height
- */
- self.columnFooterHeight = self.calcColumnFooterHeight();
- self.rtl = false;
- self.gridHeight = 0;
- self.gridWidth = 0;
- self.columnBuilders = [];
- self.rowBuilders = [];
- self.rowsProcessors = [];
- self.columnsProcessors = [];
- self.styleComputations = [];
- self.viewportAdjusters = [];
- self.rowHeaderColumns = [];
- self.dataChangeCallbacks = {};
- self.verticalScrollSyncCallBackFns = {};
- self.horizontalScrollSyncCallBackFns = {};
- // self.visibleRowCache = [];
- // Set of 'render' containers for self grid, which can render sets of rows
- self.renderContainers = {};
- // Create a
- self.renderContainers.body = new GridRenderContainer('body', self);
- self.cellValueGetterCache = {};
- // Cached function to use with custom row templates
- self.getRowTemplateFn = null;
- //representation of the rows on the grid.
- //these are wrapped references to the actual data rows (options.data)
- self.rows = [];
- //represents the columns on the grid
- self.columns = [];
- /**
- * @ngdoc boolean
- * @name isScrollingVertically
- * @propertyOf ui.grid.class:Grid
- * @description set to true when Grid is scrolling vertically. Set to false via debounced method
- */
- self.isScrollingVertically = false;
- /**
- * @ngdoc boolean
- * @name isScrollingHorizontally
- * @propertyOf ui.grid.class:Grid
- * @description set to true when Grid is scrolling horizontally. Set to false via debounced method
- */
- self.isScrollingHorizontally = false;
- /**
- * @ngdoc property
- * @name scrollDirection
- * @propertyOf ui.grid.class:Grid
- * @description set one of the {@link ui.grid.service:uiGridConstants#properties_scrollDirection uiGridConstants.scrollDirection}
- * values (UP, DOWN, LEFT, RIGHT, NONE), which tells us which direction we are scrolling.
- * Set to NONE via debounced method
- */
- self.scrollDirection = uiGridConstants.scrollDirection.NONE;
- //if true, grid will not respond to any scroll events
- self.disableScrolling = false;
- function vertical (scrollEvent) {
- self.isScrollingVertically = false;
- self.api.core.raise.scrollEnd(scrollEvent);
- self.scrollDirection = uiGridConstants.scrollDirection.NONE;
- }
- var debouncedVertical = gridUtil.debounce(vertical, self.options.scrollDebounce);
- var debouncedVerticalMinDelay = gridUtil.debounce(vertical, 0);
- function horizontal (scrollEvent) {
- self.isScrollingHorizontally = false;
- self.api.core.raise.scrollEnd(scrollEvent);
- self.scrollDirection = uiGridConstants.scrollDirection.NONE;
- }
- var debouncedHorizontal = gridUtil.debounce(horizontal, self.options.scrollDebounce);
- var debouncedHorizontalMinDelay = gridUtil.debounce(horizontal, 0);
- /**
- * @ngdoc function
- * @name flagScrollingVertically
- * @methodOf ui.grid.class:Grid
- * @description sets isScrollingVertically to true and sets it to false in a debounced function
- */
- self.flagScrollingVertically = function(scrollEvent) {
- if (!self.isScrollingVertically && !self.isScrollingHorizontally) {
- self.api.core.raise.scrollBegin(scrollEvent);
- }
- self.isScrollingVertically = true;
- if (self.options.scrollDebounce === 0 || !scrollEvent.withDelay) {
- debouncedVerticalMinDelay(scrollEvent);
- }
- else {
- debouncedVertical(scrollEvent);
- }
- };
- /**
- * @ngdoc function
- * @name flagScrollingHorizontally
- * @methodOf ui.grid.class:Grid
- * @description sets isScrollingHorizontally to true and sets it to false in a debounced function
- */
- self.flagScrollingHorizontally = function(scrollEvent) {
- if (!self.isScrollingVertically && !self.isScrollingHorizontally) {
- self.api.core.raise.scrollBegin(scrollEvent);
- }
- self.isScrollingHorizontally = true;
- if (self.options.scrollDebounce === 0 || !scrollEvent.withDelay) {
- debouncedHorizontalMinDelay(scrollEvent);
- }
- else {
- debouncedHorizontal(scrollEvent);
- }
- };
- self.scrollbarHeight = 0;
- self.scrollbarWidth = 0;
- if (self.options.enableHorizontalScrollbar !== uiGridConstants.scrollbars.NEVER) {
- self.scrollbarHeight = gridUtil.getScrollbarWidth();
- }
- if (self.options.enableVerticalScrollbar !== uiGridConstants.scrollbars.NEVER) {
- self.scrollbarWidth = gridUtil.getScrollbarWidth();
- }
- self.api = new GridApi(self);
- /**
- * @ngdoc function
- * @name refresh
- * @methodOf ui.grid.core.api:PublicApi
- * @description Refresh the rendered grid on screen.
- * The refresh method re-runs both the columnProcessors and the
- * rowProcessors, as well as calling refreshCanvas to update all
- * the grid sizing. In general you should prefer to use queueGridRefresh
- * instead, which is basically a debounced version of refresh.
- *
- * If you only want to resize the grid, not regenerate all the rows
- * and columns, you should consider directly calling refreshCanvas instead.
- *
- * @param {boolean} [rowsAltered] Optional flag for refreshing when the number of rows has changed
- */
- self.api.registerMethod( 'core', 'refresh', this.refresh );
- /**
- * @ngdoc function
- * @name queueGridRefresh
- * @methodOf ui.grid.core.api:PublicApi
- * @description Request a refresh of the rendered grid on screen, if multiple
- * calls to queueGridRefresh are made within a digest cycle only one will execute.
- * The refresh method re-runs both the columnProcessors and the
- * rowProcessors, as well as calling refreshCanvas to update all
- * the grid sizing. In general you should prefer to use queueGridRefresh
- * instead, which is basically a debounced version of refresh.
- *
- */
- self.api.registerMethod( 'core', 'queueGridRefresh', this.queueGridRefresh );
- /**
- * @ngdoc function
- * @name refreshRows
- * @methodOf ui.grid.core.api:PublicApi
- * @description Runs only the rowProcessors, columns remain as they were.
- * It then calls redrawInPlace and refreshCanvas, which adjust the grid sizing.
- * @returns {promise} promise that is resolved when render completes?
- *
- */
- self.api.registerMethod( 'core', 'refreshRows', this.refreshRows );
- /**
- * @ngdoc function
- * @name queueRefresh
- * @methodOf ui.grid.core.api:PublicApi
- * @description Requests execution of refreshCanvas, if multiple requests are made
- * during a digest cycle only one will run. RefreshCanvas updates the grid sizing.
- * @returns {promise} promise that is resolved when render completes?
- *
- */
- self.api.registerMethod( 'core', 'queueRefresh', this.queueRefresh );
- /**
- * @ngdoc function
- * @name handleWindowResize
- * @methodOf ui.grid.core.api:PublicApi
- * @description Trigger a grid resize, normally this would be picked
- * up by a watch on window size, but in some circumstances it is necessary
- * to call this manually
- * @returns {promise} promise that is resolved when render completes?
- *
- */
- self.api.registerMethod( 'core', 'handleWindowResize', this.handleWindowResize );
- /**
- * @ngdoc function
- * @name addRowHeaderColumn
- * @methodOf ui.grid.core.api:PublicApi
- * @description adds a row header column to the grid
- * @param {object} column def
- * @param {number} order Determines order of header column on grid. Lower order means header
- * is positioned to the left of higher order headers
- *
- */
- self.api.registerMethod( 'core', 'addRowHeaderColumn', this.addRowHeaderColumn );
- /**
- * @ngdoc function
- * @name scrollToIfNecessary
- * @methodOf ui.grid.core.api:PublicApi
- * @description Scrolls the grid to make a certain row and column combo visible,
- * in the case that it is not completely visible on the screen already.
- * @param {GridRow} gridRow row to make visible
- * @param {GridColumn} gridCol column to make visible
- * @returns {promise} a promise that is resolved when scrolling is complete
- *
- */
- self.api.registerMethod( 'core', 'scrollToIfNecessary', function(gridRow, gridCol) { return self.scrollToIfNecessary(gridRow, gridCol);} );
- /**
- * @ngdoc function
- * @name scrollTo
- * @methodOf ui.grid.core.api:PublicApi
- * @description Scroll the grid such that the specified
- * row and column is in view
- * @param {object} rowEntity gridOptions.data[] array instance to make visible
- * @param {object} colDef to make visible
- * @returns {promise} a promise that is resolved after any scrolling is finished
- */
- self.api.registerMethod( 'core', 'scrollTo', function (rowEntity, colDef) { return self.scrollTo(rowEntity, colDef);} );
- /**
- * @ngdoc function
- * @name registerRowsProcessor
- * @methodOf ui.grid.core.api:PublicApi
- * @description
- * Register a "rows processor" function. When the rows are updated,
- * the grid calls each registered "rows processor", which has a chance
- * to alter the set of rows (sorting, etc) as long as the count is not
- * modified.
- *
- * @param {function(renderedRowsToProcess, columns )} processorFunction rows processor function, which
- * is run in the context of the grid (i.e. this for the function will be the grid), and must
- * return the updated rows list, which is passed to the next processor in the chain
- * @param {number} priority the priority of this processor. In general we try to do them in 100s to leave room
- * for other people to inject rows processors at intermediate priorities. Lower priority rowsProcessors run earlier.
- *
- * At present allRowsVisible is running at 50, sort manipulations running at 60-65, filter is running at 100,
- * sort is at 200, grouping and treeview at 400-410, selectable rows at 500, pagination at 900 (pagination will generally want to be last)
- */
- self.api.registerMethod( 'core', 'registerRowsProcessor', this.registerRowsProcessor );
- /**
- * @ngdoc function
- * @name registerColumnsProcessor
- * @methodOf ui.grid.core.api:PublicApi
- * @description
- * Register a "columns processor" function. When the columns are updated,
- * the grid calls each registered "columns processor", which has a chance
- * to alter the set of columns as long as the count is not
- * modified.
- *
- * @param {function(renderedColumnsToProcess, rows )} processorFunction columns processor function, which
- * is run in the context of the grid (i.e. this for the function will be the grid), and must
- * return the updated columns list, which is passed to the next processor in the chain
- * @param {number} priority the priority of this processor. In general we try to do them in 100s to leave room
- * for other people to inject columns processors at intermediate priorities. Lower priority columnsProcessors run earlier.
- *
- * At present allRowsVisible is running at 50, filter is running at 100, sort is at 200, grouping at 400, selectable rows at 500, pagination at 900 (pagination will generally want to be last)
- */
- self.api.registerMethod( 'core', 'registerColumnsProcessor', this.registerColumnsProcessor );
- /**
- * @ngdoc function
- * @name sortHandleNulls
- * @methodOf ui.grid.core.api:PublicApi
- * @description A null handling method that can be used when building custom sort
- * functions
- * @example
- * <pre>
- * mySortFn = function(a, b) {
- * var nulls = $scope.gridApi.core.sortHandleNulls(a, b);
- * if ( nulls !== null ){
- * return nulls;
- * } else {
- * // your code for sorting here
- * };
- * </pre>
- * @param {object} a sort value a
- * @param {object} b sort value b
- * @returns {number} null if there were no nulls/undefineds, otherwise returns
- * a sort value that should be passed back from the sort function
- *
- */
- self.api.registerMethod( 'core', 'sortHandleNulls', rowSorter.handleNulls );
- /**
- * @ngdoc function
- * @name sortChanged
- * @methodOf ui.grid.core.api:PublicApi
- * @description The sort criteria on one or more columns has
- * changed. Provides as parameters the grid and the output of
- * getColumnSorting, which is an array of gridColumns
- * that have sorting on them, sorted in priority order.
- *
- * @param {$scope} scope The scope of the controller. This is used to deregister this event when the scope is destroyed.
- * @param {Function} callBack Will be called when the event is emited. The function passes back the grid and an array of
- * columns with sorts on them, in priority order.
- *
- * @example
- * <pre>
- * gridApi.core.on.sortChanged( $scope, function(grid, sortColumns){
- * // do something
- * });
- * </pre>
- */
- self.api.registerEvent( 'core', 'sortChanged' );
- /**
- * @ngdoc function
- * @name columnVisibilityChanged
- * @methodOf ui.grid.core.api:PublicApi
- * @description The visibility of a column has changed,
- * the column itself is passed out as a parameter of the event.
- *
- * @param {$scope} scope The scope of the controller. This is used to deregister this event when the scope is destroyed.
- * @param {Function} callBack Will be called when the event is emited. The function passes back the GridCol that has changed.
- *
- * @example
- * <pre>
- * gridApi.core.on.columnVisibilityChanged( $scope, function (column) {
- * // do something
- * } );
- * </pre>
- */
- self.api.registerEvent( 'core', 'columnVisibilityChanged' );
- /**
- * @ngdoc method
- * @name notifyDataChange
- * @methodOf ui.grid.core.api:PublicApi
- * @description Notify the grid that a data or config change has occurred,
- * where that change isn't something the grid was otherwise noticing. This
- * might be particularly relevant where you've changed values within the data
- * and you'd like cell classes to be re-evaluated, or changed config within
- * the columnDef and you'd like headerCellClasses to be re-evaluated.
- * @param {string} type one of the
- * {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
- * values (ALL, ROW, EDIT, COLUMN, OPTIONS), which tells us which refreshes to fire.
- *
- * - ALL: listeners fired on any of these events, fires listeners on all events.
- * - ROW: fired when a row is added or removed.
- * - EDIT: fired when the data in a cell is edited.
- * - COLUMN: fired when the column definitions are modified.
- * - OPTIONS: fired when the grid options are modified.
- */
- self.api.registerMethod( 'core', 'notifyDataChange', this.notifyDataChange );
- /**
- * @ngdoc method
- * @name clearAllFilters
- * @methodOf ui.grid.core.api:PublicApi
- * @description Clears all filters and optionally refreshes the visible rows.
- * @param {object} refreshRows Defaults to true.
- * @param {object} clearConditions Defaults to false.
- * @param {object} clearFlags Defaults to false.
- * @returns {promise} If `refreshRows` is true, returns a promise of the rows refreshing.
- */
- self.api.registerMethod('core', 'clearAllFilters', this.clearAllFilters);
- self.registerDataChangeCallback( self.columnRefreshCallback, [uiGridConstants.dataChange.COLUMN]);
- self.registerDataChangeCallback( self.processRowsCallback, [uiGridConstants.dataChange.EDIT]);
- self.registerDataChangeCallback( self.updateFooterHeightCallback, [uiGridConstants.dataChange.OPTIONS]);
- self.registerStyleComputation({
- priority: 10,
- func: self.getFooterStyles
- });
- };
- Grid.prototype.calcFooterHeight = function () {
- if (!this.hasFooter()) {
- return 0;
- }
- var height = 0;
- if (this.options.showGridFooter) {
- height += this.options.gridFooterHeight;
- }
- height += this.calcColumnFooterHeight();
- return height;
- };
- Grid.prototype.calcColumnFooterHeight = function () {
- var height = 0;
- if (this.options.showColumnFooter) {
- height += this.options.columnFooterHeight;
- }
- return height;
- };
- Grid.prototype.getFooterStyles = function () {
- var style = '.grid' + this.id + ' .ui-grid-footer-aggregates-row { height: ' + this.options.columnFooterHeight + 'px; }';
- style += ' .grid' + this.id + ' .ui-grid-footer-info { height: ' + this.options.gridFooterHeight + 'px; }';
- return style;
- };
- Grid.prototype.hasFooter = function () {
- return this.options.showGridFooter || this.options.showColumnFooter;
- };
- /**
- * @ngdoc function
- * @name isRTL
- * @methodOf ui.grid.class:Grid
- * @description Returns true if grid is RightToLeft
- */
- Grid.prototype.isRTL = function () {
- return this.rtl;
- };
- /**
- * @ngdoc function
- * @name registerColumnBuilder
- * @methodOf ui.grid.class:Grid
- * @description When the build creates columns from column definitions, the columnbuilders will be called to add
- * additional properties to the column.
- * @param {function(colDef, col, gridOptions)} columnBuilder function to be called
- */
- Grid.prototype.registerColumnBuilder = function registerColumnBuilder(columnBuilder) {
- this.columnBuilders.push(columnBuilder);
- };
- /**
- * @ngdoc function
- * @name buildColumnDefsFromData
- * @methodOf ui.grid.class:Grid
- * @description Populates columnDefs from the provided data
- * @param {function(colDef, col, gridOptions)} rowBuilder function to be called
- */
- Grid.prototype.buildColumnDefsFromData = function (dataRows){
- this.options.columnDefs = gridUtil.getColumnsFromData(dataRows, this.options.excludeProperties);
- };
- /**
- * @ngdoc function
- * @name registerRowBuilder
- * @methodOf ui.grid.class:Grid
- * @description When the build creates rows from gridOptions.data, the rowBuilders will be called to add
- * additional properties to the row.
- * @param {function(row, gridOptions)} rowBuilder function to be called
- */
- Grid.prototype.registerRowBuilder = function registerRowBuilder(rowBuilder) {
- this.rowBuilders.push(rowBuilder);
- };
- /**
- * @ngdoc function
- * @name registerDataChangeCallback
- * @methodOf ui.grid.class:Grid
- * @description When a data change occurs, the data change callbacks of the specified type
- * will be called. The rules are:
- *
- * - when the data watch fires, that is considered a ROW change (the data watch only notices
- * added or removed rows)
- * - when the api is called to inform us of a change, the declared type of that change is used
- * - when a cell edit completes, the EDIT callbacks are triggered
- * - when the columnDef watch fires, the COLUMN callbacks are triggered
- * - when the options watch fires, the OPTIONS callbacks are triggered
- *
- * For a given event:
- * - ALL calls ROW, EDIT, COLUMN, OPTIONS and ALL callbacks
- * - ROW calls ROW and ALL callbacks
- * - EDIT calls EDIT and ALL callbacks
- * - COLUMN calls COLUMN and ALL callbacks
- * - OPTIONS calls OPTIONS and ALL callbacks
- *
- * @param {function(grid)} callback function to be called
- * @param {array} types the types of data change you want to be informed of. Values from
- * the {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
- * values ( ALL, EDIT, ROW, COLUMN, OPTIONS ). Optional and defaults to ALL
- * @returns {function} deregister function - a function that can be called to deregister this callback
- */
- Grid.prototype.registerDataChangeCallback = function registerDataChangeCallback(callback, types, _this) {
- var uid = gridUtil.nextUid();
- if ( !types ){
- types = [uiGridConstants.dataChange.ALL];
- }
- if ( !Array.isArray(types)){
- gridUtil.logError("Expected types to be an array or null in registerDataChangeCallback, value passed was: " + types );
- }
- this.dataChangeCallbacks[uid] = { callback: callback, types: types, _this:_this };
- var self = this;
- var deregisterFunction = function() {
- delete self.dataChangeCallbacks[uid];
- };
- return deregisterFunction;
- };
- /**
- * @ngdoc function
- * @name callDataChangeCallbacks
- * @methodOf ui.grid.class:Grid
- * @description Calls the callbacks based on the type of data change that
- * has occurred. Always calls the ALL callbacks, calls the ROW, EDIT, COLUMN and OPTIONS callbacks if the
- * event type is matching, or if the type is ALL.
- * @param {string} type the type of event that occurred - one of the
- * {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
- * values (ALL, ROW, EDIT, COLUMN, OPTIONS)
- */
- Grid.prototype.callDataChangeCallbacks = function callDataChangeCallbacks(type, options) {
- angular.forEach( this.dataChangeCallbacks, function( callback, uid ){
- if ( callback.types.indexOf( uiGridConstants.dataChange.ALL ) !== -1 ||
- callback.types.indexOf( type ) !== -1 ||
- type === uiGridConstants.dataChange.ALL ) {
- if (callback._this) {
- callback.callback.apply(callback._this, this, options);
- }
- else {
- callback.callback(this, options);
- }
- }
- }, this);
- };
- /**
- * @ngdoc function
- * @name notifyDataChange
- * @methodOf ui.grid.class:Grid
- * @description Notifies us that a data change has occurred, used in the public
- * api for users to tell us when they've changed data or some other event that
- * our watches cannot pick up
- * @param {string} type the type of event that occurred - one of the
- * uiGridConstants.dataChange values (ALL, ROW, EDIT, COLUMN, OPTIONS)
- *
- * - ALL: listeners fired on any of these events, fires listeners on all events.
- * - ROW: fired when a row is added or removed.
- * - EDIT: fired when the data in a cell is edited.
- * - COLUMN: fired when the column definitions are modified.
- * - OPTIONS: fired when the grid options are modified.
- */
- Grid.prototype.notifyDataChange = function notifyDataChange(type) {
- var constants = uiGridConstants.dataChange;
- if ( type === constants.ALL ||
- type === constants.COLUMN ||
- type === constants.EDIT ||
- type === constants.ROW ||
- type === constants.OPTIONS ){
- this.callDataChangeCallbacks( type );
- } else {
- gridUtil.logError("Notified of a data change, but the type was not recognised, so no action taken, type was: " + type);
- }
- };
- /**
- * @ngdoc function
- * @name columnRefreshCallback
- * @methodOf ui.grid.class:Grid
- * @description refreshes the grid when a column refresh
- * is notified, which triggers handling of the visible flag.
- * This is called on uiGridConstants.dataChange.COLUMN, and is
- * registered as a dataChangeCallback in grid.js
- * @param {object} grid The grid object.
- * @param {object} options Any options passed into the callback.
- */
- Grid.prototype.columnRefreshCallback = function columnRefreshCallback(grid, options){
- grid.buildColumns(options);
- grid.queueGridRefresh();
- };
- /**
- * @ngdoc function
- * @name processRowsCallback
- * @methodOf ui.grid.class:Grid
- * @description calls the row processors, specifically
- * intended to reset the sorting when an edit is called,
- * registered as a dataChangeCallback on uiGridConstants.dataChange.EDIT
- * @param {string} name column name
- */
- Grid.prototype.processRowsCallback = function processRowsCallback( grid ){
- grid.queueGridRefresh();
- };
- /**
- * @ngdoc function
- * @name updateFooterHeightCallback
- * @methodOf ui.grid.class:Grid
- * @description recalculates the footer height,
- * registered as a dataChangeCallback on uiGridConstants.dataChange.OPTIONS
- * @param {string} name column name
- */
- Grid.prototype.updateFooterHeightCallback = function updateFooterHeightCallback( grid ){
- grid.footerHeight = grid.calcFooterHeight();
- grid.columnFooterHeight = grid.calcColumnFooterHeight();
- };
- /**
- * @ngdoc function
- * @name getColumn
- * @methodOf ui.grid.class:Grid
- * @description returns a grid column for the column name
- * @param {string} name column name
- */
- Grid.prototype.getColumn = function getColumn(name) {
- var columns = this.columns.filter(function (column) {
- return column.colDef.name === name;
- });
- return columns.length > 0 ? columns[0] : null;
- };
- /**
- * @ngdoc function
- * @name getColDef
- * @methodOf ui.grid.class:Grid
- * @description returns a grid colDef for the column name
- * @param {string} name column.field
- */
- Grid.prototype.getColDef = function getColDef(name) {
- var colDefs = this.options.columnDefs.filter(function (colDef) {
- return colDef.name === name;
- });
- return colDefs.length > 0 ? colDefs[0] : null;
- };
- /**
- * @ngdoc function
- * @name assignTypes
- * @methodOf ui.grid.class:Grid
- * @description uses the first row of data to assign colDef.type for any types not defined.
- */
- /**
- * @ngdoc property
- * @name type
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description the type of the column, used in sorting. If not provided then the
- * grid will guess the type. Add this only if the grid guessing is not to your
- * satisfaction. One of:
- * - 'string'
- * - 'boolean'
- * - 'number'
- * - 'date'
- * - 'object'
- * - 'numberStr'
- * Note that if you choose date, your dates should be in a javascript date type
- *
- */
- Grid.prototype.assignTypes = function(){
- var self = this;
- self.options.columnDefs.forEach(function (colDef, index) {
- //Assign colDef type if not specified
- if (!colDef.type) {
- var col = new GridColumn(colDef, index, self);
- var firstRow = self.rows.length > 0 ? self.rows[0] : null;
- if (firstRow) {
- colDef.type = gridUtil.guessType(self.getCellValue(firstRow, col));
- }
- else {
- colDef.type = 'string';
- }
- }
- });
- };
- /**
- * @ngdoc function
- * @name isRowHeaderColumn
- * @methodOf ui.grid.class:Grid
- * @description returns true if the column is a row Header
- * @param {object} column column
- */
- Grid.prototype.isRowHeaderColumn = function isRowHeaderColumn(column) {
- return this.rowHeaderColumns.indexOf(column) !== -1;
- };
- /**
- * @ngdoc function
- * @name addRowHeaderColumn
- * @methodOf ui.grid.class:Grid
- * @description adds a row header column to the grid
- * @param {object} colDef Column definition object.
- * @param {float} order Number that indicates where the column should be placed in the grid.
- * @param {boolean} stopColumnBuild Prevents the buildColumn callback from being triggered. This is useful to improve
- * performance of the grid during initial load.
- */
- Grid.prototype.addRowHeaderColumn = function addRowHeaderColumn(colDef, order, stopColumnBuild) {
- var self = this;
- //default order
- if (order === undefined) {
- order = 0;
- }
- var rowHeaderCol = new GridColumn(colDef, gridUtil.nextUid(), self);
- rowHeaderCol.isRowHeader = true;
- if (self.isRTL()) {
- self.createRightContainer();
- rowHeaderCol.renderContainer = 'right';
- }
- else {
- self.createLeftContainer();
- rowHeaderCol.renderContainer = 'left';
- }
- // relies on the default column builder being first in array, as it is instantiated
- // as part of grid creation
- self.columnBuilders[0](colDef,rowHeaderCol,self.options)
- .then(function(){
- rowHeaderCol.enableFiltering = false;
- rowHeaderCol.enableSorting = false;
- rowHeaderCol.enableHiding = false;
- rowHeaderCol.headerPriority = order;
- self.rowHeaderColumns.push(rowHeaderCol);
- self.rowHeaderColumns = self.rowHeaderColumns.sort(function (a, b) {
- return a.headerPriority - b.headerPriority;
- });
- if (!stopColumnBuild) {
- self.buildColumns()
- .then(function() {
- self.preCompileCellTemplates();
- self.queueGridRefresh();
- }).catch(angular.noop);
- }
- }).catch(angular.noop);
- };
- /**
- * @ngdoc function
- * @name getOnlyDataColumns
- * @methodOf ui.grid.class:Grid
- * @description returns all columns except for rowHeader columns
- */
- Grid.prototype.getOnlyDataColumns = function getOnlyDataColumns() {
- var self = this;
- var cols = [];
- self.columns.forEach(function (col) {
- if (self.rowHeaderColumns.indexOf(col) === -1) {
- cols.push(col);
- }
- });
- return cols;
- };
- /**
- * @ngdoc function
- * @name buildColumns
- * @methodOf ui.grid.class:Grid
- * @description creates GridColumn objects from the columnDefinition. Calls each registered
- * columnBuilder to further process the column
- * @param {object} options An object contains options to use when building columns
- *
- * * **orderByColumnDefs**: defaults to **false**. When true, `buildColumns` will reorder existing columns according to the order within the column definitions.
- *
- * @returns {Promise} a promise to load any needed column resources
- */
- Grid.prototype.buildColumns = function buildColumns(opts) {
- var options = {
- orderByColumnDefs: false
- };
- angular.extend(options, opts);
- // gridUtil.logDebug('buildColumns');
- var self = this;
- var builderPromises = [];
- var headerOffset = self.rowHeaderColumns.length;
- var i;
- // Remove any columns for which a columnDef cannot be found
- // Deliberately don't use forEach, as it doesn't like splice being called in the middle
- // Also don't cache columns.length, as it will change during this operation
- for (i = 0; i < self.columns.length; i++){
- if (!self.getColDef(self.columns[i].name)) {
- self.columns.splice(i, 1);
- i--;
- }
- }
- //add row header columns to the grid columns array _after_ columns without columnDefs have been removed
- //rowHeaderColumns is ordered by priority so insert in reverse
- for (var j = self.rowHeaderColumns.length - 1; j >= 0; j--) {
- self.columns.unshift(self.rowHeaderColumns[j]);
- }
- // look at each column def, and update column properties to match. If the column def
- // doesn't have a column, then splice in a new gridCol
- self.options.columnDefs.forEach(function (colDef, index) {
- self.preprocessColDef(colDef);
- var col = self.getColumn(colDef.name);
- if (!col) {
- col = new GridColumn(colDef, gridUtil.nextUid(), self);
- self.columns.splice(index + headerOffset, 0, col);
- }
- else {
- // tell updateColumnDef that the column was pre-existing
- col.updateColumnDef(colDef, false);
- }
- self.columnBuilders.forEach(function (builder) {
- builderPromises.push(builder.call(self, colDef, col, self.options));
- });
- });
- /*** Reorder columns if necessary ***/
- if (!!options.orderByColumnDefs) {
- // Create a shallow copy of the columns as a cache
- var columnCache = self.columns.slice(0);
- // We need to allow for the "row headers" when mapping from the column defs array to the columns array
- // If we have a row header in columns[0] and don't account for it we'll overwrite it with the column in columnDefs[0]
- // Go through all the column defs, use the shorter of columns length and colDefs.length because if a user has given two columns the same name then
- // columns will be shorter than columnDefs. In this situation we'll avoid an error, but the user will still get an unexpected result
- var len = Math.min(self.options.columnDefs.length, self.columns.length);
- for (i = 0; i < len; i++) {
- // If the column at this index has a different name than the column at the same index in the column defs...
- if (self.columns[i + headerOffset].name !== self.options.columnDefs[i].name) {
- // Replace the one in the cache with the appropriate column
- columnCache[i + headerOffset] = self.getColumn(self.options.columnDefs[i].name);
- }
- else {
- // Otherwise just copy over the one from the initial columns
- columnCache[i + headerOffset] = self.columns[i + headerOffset];
- }
- }
- // Empty out the columns array, non-destructively
- self.columns.length = 0;
- // And splice in the updated, ordered columns from the cache
- Array.prototype.splice.apply(self.columns, [0, 0].concat(columnCache));
- }
- return $q.all(builderPromises).then(function(){
- if (self.rows.length > 0){
- self.assignTypes();
- }
- if (options.preCompileCellTemplates) {
- self.preCompileCellTemplates();
- }
- }).catch(angular.noop);
- };
- Grid.prototype.preCompileCellTemplate = function(col) {
- var self = this;
- var html = col.cellTemplate.replace(uiGridConstants.MODEL_COL_FIELD, self.getQualifiedColField(col));
- html = html.replace(uiGridConstants.COL_FIELD, 'grid.getCellValue(row, col)');
- col.compiledElementFn = $compile(html);
- if (col.compiledElementFnDefer) {
- col.compiledElementFnDefer.resolve(col.compiledElementFn);
- }
- };
- /**
- * @ngdoc function
- * @name preCompileCellTemplates
- * @methodOf ui.grid.class:Grid
- * @description precompiles all cell templates
- */
- Grid.prototype.preCompileCellTemplates = function() {
- var self = this;
- self.columns.forEach(function (col) {
- if ( col.cellTemplate ){
- self.preCompileCellTemplate( col );
- } else if ( col.cellTemplatePromise ){
- col.cellTemplatePromise.then( function() {
- self.preCompileCellTemplate( col );
- }).catch(angular.noop);
- }
- });
- };
- /**
- * @ngdoc function
- * @name getGridQualifiedColField
- * @methodOf ui.grid.class:Grid
- * @description Returns the $parse-able accessor for a column within its $scope
- * @param {GridColumn} col col object
- */
- Grid.prototype.getQualifiedColField = function (col) {
- var base = 'row.entity';
- if ( col.field === uiGridConstants.ENTITY_BINDING ) {
- return base;
- }
- return gridUtil.preEval(base + '.' + col.field);
- };
- /**
- * @ngdoc function
- * @name createLeftContainer
- * @methodOf ui.grid.class:Grid
- * @description creates the left render container if it doesn't already exist
- */
- Grid.prototype.createLeftContainer = function() {
- if (!this.hasLeftContainer()) {
- this.renderContainers.left = new GridRenderContainer('left', this, { disableColumnOffset: true });
- }
- };
- /**
- * @ngdoc function
- * @name createRightContainer
- * @methodOf ui.grid.class:Grid
- * @description creates the right render container if it doesn't already exist
- */
- Grid.prototype.createRightContainer = function() {
- if (!this.hasRightContainer()) {
- this.renderContainers.right = new GridRenderContainer('right', this, { disableColumnOffset: true });
- }
- };
- /**
- * @ngdoc function
- * @name hasLeftContainer
- * @methodOf ui.grid.class:Grid
- * @description returns true if leftContainer exists
- */
- Grid.prototype.hasLeftContainer = function() {
- return this.renderContainers.left !== undefined;
- };
- /**
- * @ngdoc function
- * @name hasRightContainer
- * @methodOf ui.grid.class:Grid
- * @description returns true if rightContainer exists
- */
- Grid.prototype.hasRightContainer = function() {
- return this.renderContainers.right !== undefined;
- };
- /**
- * undocumented function
- * @name preprocessColDef
- * @methodOf ui.grid.class:Grid
- * @description defaults the name property from field to maintain backwards compatibility with 2.x
- * validates that name or field is present
- */
- Grid.prototype.preprocessColDef = function preprocessColDef(colDef) {
- var self = this;
- if (!colDef.field && !colDef.name) {
- throw new Error('colDef.name or colDef.field property is required');
- }
- //maintain backwards compatibility with 2.x
- //field was required in 2.x. now name is required
- if (colDef.name === undefined && colDef.field !== undefined) {
- // See if the column name already exists:
- var newName = colDef.field,
- counter = 2;
- while (self.getColumn(newName)) {
- newName = colDef.field + counter.toString();
- counter++;
- }
- colDef.name = newName;
- }
- };
- // Return a list of items that exist in the `n` array but not the `o` array. Uses optional property accessors passed as third & fourth parameters
- Grid.prototype.newInN = function newInN(o, n, oAccessor, nAccessor) {
- var self = this;
- var t = [];
- for (var i = 0; i < n.length; i++) {
- var nV = nAccessor ? n[i][nAccessor] : n[i];
- var found = false;
- for (var j = 0; j < o.length; j++) {
- var oV = oAccessor ? o[j][oAccessor] : o[j];
- if (self.options.rowEquality(nV, oV)) {
- found = true;
- break;
- }
- }
- if (!found) {
- t.push(nV);
- }
- }
- return t;
- };
- /**
- * @ngdoc function
- * @name getRow
- * @methodOf ui.grid.class:Grid
- * @description returns the GridRow that contains the rowEntity
- * @param {object} rowEntity the gridOptions.data array element instance
- * @param {array} lookInRows [optional] the rows to look in - if not provided then
- * looks in grid.rows
- */
- Grid.prototype.getRow = function getRow(rowEntity, lookInRows) {
- var self = this;
- lookInRows = typeof(lookInRows) === 'undefined' ? self.rows : lookInRows;
- var rows = lookInRows.filter(function (row) {
- return self.options.rowEquality(row.entity, rowEntity);
- });
- return rows.length > 0 ? rows[0] : null;
- };
- /**
- * @ngdoc function
- * @name modifyRows
- * @methodOf ui.grid.class:Grid
- * @description creates or removes GridRow objects from the newRawData array. Calls each registered
- * rowBuilder to further process the row
- * @param {array} newRawData Modified set of data
- *
- * This method aims to achieve three things:
- * 1. the resulting rows array is in the same order as the newRawData, we'll call
- * rowsProcessors immediately after to sort the data anyway
- * 2. if we have row hashing available, we try to use the rowHash to find the row
- * 3. no memory leaks - rows that are no longer in newRawData need to be garbage collected
- *
- * The basic logic flow makes use of the newRawData, oldRows and oldHash, and creates
- * the newRows and newHash
- *
- * ```
- * newRawData.forEach newEntity
- * if (hashing enabled)
- * check oldHash for newEntity
- * else
- * look for old row directly in oldRows
- * if !oldRowFound // must be a new row
- * create newRow
- * append to the newRows and add to newHash
- * run the processors
- * ```
- *
- * Rows are identified using the hashKey if configured. If not configured, then rows
- * are identified using the gridOptions.rowEquality function
- *
- * This method is useful when trying to select rows immediately after loading data without
- * using a $timeout/$interval, e.g.:
- *
- * $scope.gridOptions.data = someData;
- * $scope.gridApi.grid.modifyRows($scope.gridOptions.data);
- * $scope.gridApi.selection.selectRow($scope.gridOptions.data[0]);
- *
- * OR to persist row selection after data update (e.g. rows selected, new data loaded, want
- * originally selected rows to be re-selected))
- */
- Grid.prototype.modifyRows = function modifyRows(newRawData) {
- var self = this;
- var oldRows = self.rows.slice(0);
- var oldRowHash = self.rowHashMap || self.createRowHashMap();
- var allRowsSelected = true;
- self.rowHashMap = self.createRowHashMap();
- self.rows.length = 0;
- newRawData.forEach( function( newEntity, i ) {
- var newRow, oldRow;
- if ( self.options.enableRowHashing ){
- // if hashing is enabled, then this row will be in the hash if we already know about it
- oldRow = oldRowHash.get( newEntity );
- } else {
- // otherwise, manually search the oldRows to see if we can find this row
- oldRow = self.getRow(newEntity, oldRows);
- }
- // update newRow to have an entity
- if ( oldRow ) {
- newRow = oldRow;
- newRow.entity = newEntity;
- }
- // if we didn't find the row, it must be new, so create it
- if ( !newRow ){
- newRow = self.processRowBuilders(new GridRow(newEntity, i, self));
- }
- self.rows.push( newRow );
- self.rowHashMap.put( newEntity, newRow );
- if (!newRow.isSelected) {
- allRowsSelected = false;
- }
- });
- if (self.selection && self.rows.length) {
- self.selection.selectAll = allRowsSelected;
- }
- self.assignTypes();
- var p1 = $q.when(self.processRowsProcessors(self.rows))
- .then(function (renderableRows) {
- return self.setVisibleRows(renderableRows);
- }).catch(angular.noop);
- var p2 = $q.when(self.processColumnsProcessors(self.columns))
- .then(function (renderableColumns) {
- return self.setVisibleColumns(renderableColumns);
- }).catch(angular.noop);
- return $q.all([p1, p2]);
- };
- /**
- * Private Undocumented Method
- * @name addRows
- * @methodOf ui.grid.class:Grid
- * @description adds the newRawData array of rows to the grid and calls all registered
- * rowBuilders. this keyword will reference the grid
- */
- Grid.prototype.addRows = function addRows(newRawData) {
- var self = this;
- var existingRowCount = self.rows.length;
- for (var i = 0; i < newRawData.length; i++) {
- var newRow = self.processRowBuilders(new GridRow(newRawData[i], i + existingRowCount, self));
- if (self.options.enableRowHashing) {
- var found = self.rowHashMap.get(newRow.entity);
- if (found) {
- found.row = newRow;
- }
- }
- self.rows.push(newRow);
- }
- };
- /**
- * @ngdoc function
- * @name processRowBuilders
- * @methodOf ui.grid.class:Grid
- * @description processes all RowBuilders for the gridRow
- * @param {GridRow} gridRow reference to gridRow
- * @returns {GridRow} the gridRow with all additional behavior added
- */
- Grid.prototype.processRowBuilders = function processRowBuilders(gridRow) {
- var self = this;
- self.rowBuilders.forEach(function (builder) {
- builder.call(self, gridRow, self.options);
- });
- return gridRow;
- };
- /**
- * @ngdoc function
- * @name registerStyleComputation
- * @methodOf ui.grid.class:Grid
- * @description registered a styleComputation function
- *
- * If the function returns a value it will be appended into the grid's `<style>` block
- * @param {function($scope)} styleComputationInfo function
- */
- Grid.prototype.registerStyleComputation = function registerStyleComputation(styleComputationInfo) {
- this.styleComputations.push(styleComputationInfo);
- };
- // NOTE (c0bra): We already have rowBuilders. I think these do exactly the same thing...
- // Grid.prototype.registerRowFilter = function(filter) {
- // // TODO(c0bra): validate filter?
- // this.rowFilters.push(filter);
- // };
- // Grid.prototype.removeRowFilter = function(filter) {
- // var idx = this.rowFilters.indexOf(filter);
- // if (typeof(idx) !== 'undefined' && idx !== undefined) {
- // this.rowFilters.slice(idx, 1);
- // }
- // };
- // Grid.prototype.processRowFilters = function(rows) {
- // var self = this;
- // self.rowFilters.forEach(function (filter) {
- // filter.call(self, rows);
- // });
- // };
- /**
- * @ngdoc function
- * @name registerRowsProcessor
- * @methodOf ui.grid.class:Grid
- * @description
- *
- * Register a "rows processor" function. When the rows are updated,
- * the grid calls each registered "rows processor", which has a chance
- * to alter the set of rows (sorting, etc) as long as the count is not
- * modified.
- *
- * @param {function(renderedRowsToProcess, columns )} processor rows processor function, which
- * is run in the context of the grid (i.e. this for the function will be the grid), and must
- * return the updated rows list, which is passed to the next processor in the chain
- * @param {number} priority the priority of this processor. In general we try to do them in 100s to leave room
- * for other people to inject rows processors at intermediate priorities. Lower priority rowsProcessors run earlier.
- *
- * At present all rows visible is running at 50, filter is running at 100, sort is at 200, grouping at 400, selectable rows at 500, pagination at 900 (pagination will generally want to be last)
- *
- */
- Grid.prototype.registerRowsProcessor = function registerRowsProcessor(processor, priority) {
- if (!angular.isFunction(processor)) {
- throw 'Attempt to register non-function rows processor: ' + processor;
- }
- this.rowsProcessors.push({processor: processor, priority: priority});
- this.rowsProcessors.sort(function sortByPriority( a, b ){
- return a.priority - b.priority;
- });
- };
- /**
- * @ngdoc function
- * @name removeRowsProcessor
- * @methodOf ui.grid.class:Grid
- * @param {function(renderableRows)} processor processor function
- * @description Remove a registered rows processor
- */
- Grid.prototype.removeRowsProcessor = function removeRowsProcessor(processor) {
- var idx = -1;
- this.rowsProcessors.forEach(function(rowsProcessor, index){
- if ( rowsProcessor.processor === processor ){
- idx = index;
- }
- });
- if ( idx !== -1 ) {
- this.rowsProcessors.splice(idx, 1);
- }
- };
- /**
- * Private Undocumented Method
- * @name processRowsProcessors
- * @methodOf ui.grid.class:Grid
- * @param {Array[GridRow]} renderableRows The array of "renderable" rows
- * @description Run all the registered rows processors on the array of renderable rows
- */
- Grid.prototype.processRowsProcessors = function processRowsProcessors(renderableRows) {
- var self = this;
- // Create a shallow copy of the rows so that we can safely sort them without altering the original grid.rows sort order
- var myRenderableRows = renderableRows.slice(0);
- // Return myRenderableRows with no processing if we have no rows processors
- if (self.rowsProcessors.length === 0) {
- return $q.when(myRenderableRows);
- }
- // Counter for iterating through rows processors
- var i = 0;
- // Promise for when we're done with all the processors
- var finished = $q.defer();
- // This function will call the processor in self.rowsProcessors at index 'i', and then
- // when done will call the next processor in the list, using the output from the processor
- // at i as the argument for 'renderedRowsToProcess' on the next iteration.
- //
- // If we're at the end of the list of processors, we resolve our 'finished' callback with
- // the result.
- function startProcessor(i, renderedRowsToProcess) {
- // Get the processor at 'i'
- var processor = self.rowsProcessors[i].processor;
- // Call the processor, passing in the rows to process and the current columns
- // (note: it's wrapped in $q.when() in case the processor does not return a promise)
- return $q.when( processor.call(self, renderedRowsToProcess, self.columns) )
- .then(function handleProcessedRows(processedRows) {
- // Check for errors
- if (!processedRows) {
- throw "Processor at index " + i + " did not return a set of renderable rows";
- }
- if (!angular.isArray(processedRows)) {
- throw "Processor at index " + i + " did not return an array";
- }
- // Processor is done, increment the counter
- i++;
- // If we're not done with the processors, call the next one
- if (i <= self.rowsProcessors.length - 1) {
- return startProcessor(i, processedRows);
- }
- // We're done! Resolve the 'finished' promise
- else {
- finished.resolve(processedRows);
- }
- }).catch(function(error) {
- throw error;
- });
- }
- // Start on the first processor
- startProcessor(0, myRenderableRows);
- return finished.promise;
- };
- Grid.prototype.setVisibleRows = function setVisibleRows(rows) {
- var self = this;
- // Reset all the render container row caches
- for (var i in self.renderContainers) {
- var container = self.renderContainers[i];
- container.canvasHeightShouldUpdate = true;
- if ( typeof(container.visibleRowCache) === 'undefined' ){
- container.visibleRowCache = [];
- } else {
- container.visibleRowCache.length = 0;
- }
- }
- // rows.forEach(function (row) {
- for (var ri = 0; ri < rows.length; ri++) {
- var row = rows[ri];
- var targetContainer = (typeof(row.renderContainer) !== 'undefined' && row.renderContainer) ? row.renderContainer : 'body';
- // If the row is visible
- if (row.visible) {
- self.renderContainers[targetContainer].visibleRowCache.push(row);
- }
- }
- self.api.core.raise.rowsVisibleChanged(this.api);
- self.api.core.raise.rowsRendered(this.api);
- };
- /**
- * @ngdoc function
- * @name registerColumnsProcessor
- * @methodOf ui.grid.class:Grid
- * @param {function(renderedColumnsToProcess, rows)} processor column processor function, which
- * is run in the context of the grid (i.e. this for the function will be the grid), and
- * which must return an updated renderedColumnsToProcess which can be passed to the next processor
- * in the chain
- * @param {number} priority the priority of this processor. In general we try to do them in 100s to leave room
- * for other people to inject columns processors at intermediate priorities. Lower priority columnsProcessors run earlier.
- *
- * At present all rows visible is running at 50, filter is running at 100, sort is at 200, grouping at 400, selectable rows at 500, pagination at 900 (pagination will generally want to be last)
- * @description
- Register a "columns processor" function. When the columns are updated,
- the grid calls each registered "columns processor", which has a chance
- to alter the set of columns, as long as the count is not modified.
- */
- Grid.prototype.registerColumnsProcessor = function registerColumnsProcessor(processor, priority) {
- if (!angular.isFunction(processor)) {
- throw 'Attempt to register non-function rows processor: ' + processor;
- }
- this.columnsProcessors.push({processor: processor, priority: priority});
- this.columnsProcessors.sort(function sortByPriority( a, b ){
- return a.priority - b.priority;
- });
- };
- Grid.prototype.removeColumnsProcessor = function removeColumnsProcessor(processor) {
- var idx = this.columnsProcessors.indexOf(processor);
- if (typeof(idx) !== 'undefined' && idx !== undefined) {
- this.columnsProcessors.splice(idx, 1);
- }
- };
- Grid.prototype.processColumnsProcessors = function processColumnsProcessors(renderableColumns) {
- var self = this;
- // Create a shallow copy of the rows so that we can safely sort them without altering the original grid.rows sort order
- var myRenderableColumns = renderableColumns.slice(0);
- // Return myRenderableRows with no processing if we have no rows processors
- if (self.columnsProcessors.length === 0) {
- return $q.when(myRenderableColumns);
- }
- // Counter for iterating through rows processors
- var i = 0;
- // Promise for when we're done with all the processors
- var finished = $q.defer();
- // This function will call the processor in self.rowsProcessors at index 'i', and then
- // when done will call the next processor in the list, using the output from the processor
- // at i as the argument for 'renderedRowsToProcess' on the next iteration.
- //
- // If we're at the end of the list of processors, we resolve our 'finished' callback with
- // the result.
- function startProcessor(i, renderedColumnsToProcess) {
- // Get the processor at 'i'
- var processor = self.columnsProcessors[i].processor;
- // Call the processor, passing in the rows to process and the current columns
- // (note: it's wrapped in $q.when() in case the processor does not return a promise)
- return $q.when( processor.call(self, renderedColumnsToProcess, self.rows) )
- .then(function handleProcessedRows(processedColumns) {
- // Check for errors
- if (!processedColumns) {
- throw "Processor at index " + i + " did not return a set of renderable rows";
- }
- if (!angular.isArray(processedColumns)) {
- throw "Processor at index " + i + " did not return an array";
- }
- // Processor is done, increment the counter
- i++;
- // If we're not done with the processors, call the next one
- if (i <= self.columnsProcessors.length - 1) {
- return startProcessor(i, myRenderableColumns);
- }
- // We're done! Resolve the 'finished' promise
- else {
- finished.resolve(myRenderableColumns);
- }
- }).catch(angular.noop);
- }
- // Start on the first processor
- startProcessor(0, myRenderableColumns);
- return finished.promise;
- };
- Grid.prototype.setVisibleColumns = function setVisibleColumns(columns) {
- // gridUtil.logDebug('setVisibleColumns');
- var self = this;
- // Reset all the render container row caches
- for (var i in self.renderContainers) {
- var container = self.renderContainers[i];
- container.visibleColumnCache.length = 0;
- }
- for (var ci = 0; ci < columns.length; ci++) {
- var column = columns[ci];
- // If the column is visible
- if (column.visible) {
- // If the column has a container specified
- if (typeof(column.renderContainer) !== 'undefined' && column.renderContainer) {
- self.renderContainers[column.renderContainer].visibleColumnCache.push(column);
- }
- // If not, put it into the body container
- else {
- self.renderContainers.body.visibleColumnCache.push(column);
- }
- }
- }
- };
- /**
- * @ngdoc function
- * @name handleWindowResize
- * @methodOf ui.grid.class:Grid
- * @description Triggered when the browser window resizes; automatically resizes the grid
- * @returns {Promise} A resolved promise once the window resize has completed.
- */
- Grid.prototype.handleWindowResize = function handleWindowResize($event) {
- var self = this;
- self.gridWidth = gridUtil.elementWidth(self.element);
- self.gridHeight = gridUtil.elementHeight(self.element);
- return self.queueRefresh();
- };
- /**
- * @ngdoc function
- * @name queueRefresh
- * @methodOf ui.grid.class:Grid
- * @description queues a grid refreshCanvas, a way of debouncing all the refreshes we might otherwise issue
- */
- Grid.prototype.queueRefresh = function queueRefresh() {
- var self = this;
- if (self.refreshCanceller) {
- $timeout.cancel(self.refreshCanceller);
- }
- self.refreshCanceller = $timeout(function () {
- self.refreshCanvas(true);
- });
- self.refreshCanceller.then(function () {
- self.refreshCanceller = null;
- }).catch(angular.noop);
- return self.refreshCanceller;
- };
- /**
- * @ngdoc function
- * @name queueGridRefresh
- * @methodOf ui.grid.class:Grid
- * @description queues a grid refresh, a way of debouncing all the refreshes we might otherwise issue
- */
- Grid.prototype.queueGridRefresh = function queueGridRefresh() {
- var self = this;
- if (self.gridRefreshCanceller) {
- $timeout.cancel(self.gridRefreshCanceller);
- }
- self.gridRefreshCanceller = $timeout(function () {
- self.refresh(true);
- });
- self.gridRefreshCanceller.then(function () {
- self.gridRefreshCanceller = null;
- }).catch(angular.noop);
- return self.gridRefreshCanceller;
- };
- /**
- * @ngdoc function
- * @name updateCanvasHeight
- * @methodOf ui.grid.class:Grid
- * @description flags all render containers to update their canvas height
- */
- Grid.prototype.updateCanvasHeight = function updateCanvasHeight() {
- var self = this;
- for (var containerId in self.renderContainers) {
- if (self.renderContainers.hasOwnProperty(containerId)) {
- var container = self.renderContainers[containerId];
- container.canvasHeightShouldUpdate = true;
- }
- }
- };
- /**
- * @ngdoc function
- * @name buildStyles
- * @methodOf ui.grid.class:Grid
- * @description calls each styleComputation function
- */
- Grid.prototype.buildStyles = function buildStyles() {
- var self = this;
- // gridUtil.logDebug('buildStyles');
- self.customStyles = '';
- self.styleComputations
- .sort(function(a, b) {
- if (a.priority === null) { return 1; }
- if (b.priority === null) { return -1; }
- if (a.priority === null && b.priority === null) { return 0; }
- return a.priority - b.priority;
- })
- .forEach(function (compInfo) {
- // this used to provide $scope as a second parameter, but I couldn't find any
- // style builders that used it, so removed it as part of moving to grid from controller
- var ret = compInfo.func.call(self);
- if (angular.isString(ret)) {
- self.customStyles += '\n' + ret;
- }
- });
- };
- Grid.prototype.minColumnsToRender = function minColumnsToRender() {
- var self = this;
- var viewport = this.getViewportWidth();
- var min = 0;
- var totalWidth = 0;
- self.columns.forEach(function(col, i) {
- if (totalWidth < viewport) {
- totalWidth += col.drawnWidth;
- min++;
- }
- else {
- var currWidth = 0;
- for (var j = i; j >= i - min; j--) {
- currWidth += self.columns[j].drawnWidth;
- }
- if (currWidth < viewport) {
- min++;
- }
- }
- });
- return min;
- };
- Grid.prototype.getBodyHeight = function getBodyHeight() {
- // Start with the viewportHeight
- var bodyHeight = this.getViewportHeight();
- // Add the horizontal scrollbar height if there is one
- //if (typeof(this.horizontalScrollbarHeight) !== 'undefined' && this.horizontalScrollbarHeight !== undefined && this.horizontalScrollbarHeight > 0) {
- // bodyHeight = bodyHeight + this.horizontalScrollbarHeight;
- //}
- return bodyHeight;
- };
- // NOTE: viewport drawable height is the height of the grid minus the header row height (including any border)
- // TODO(c0bra): account for footer height
- Grid.prototype.getViewportHeight = function getViewportHeight() {
- var self = this;
- var viewPortHeight = this.gridHeight - this.headerHeight - this.footerHeight;
- // Account for native horizontal scrollbar, if present
- //if (typeof(this.horizontalScrollbarHeight) !== 'undefined' && this.horizontalScrollbarHeight !== undefined && this.horizontalScrollbarHeight > 0) {
- // viewPortHeight = viewPortHeight - this.horizontalScrollbarHeight;
- //}
- var adjustment = self.getViewportAdjustment();
- viewPortHeight = viewPortHeight + adjustment.height;
- //gridUtil.logDebug('viewPortHeight', viewPortHeight);
- return viewPortHeight;
- };
- Grid.prototype.getViewportWidth = function getViewportWidth() {
- var self = this;
- var viewPortWidth = this.gridWidth;
- //if (typeof(this.verticalScrollbarWidth) !== 'undefined' && this.verticalScrollbarWidth !== undefined && this.verticalScrollbarWidth > 0) {
- // viewPortWidth = viewPortWidth - this.verticalScrollbarWidth;
- //}
- var adjustment = self.getViewportAdjustment();
- viewPortWidth = viewPortWidth + adjustment.width;
- //gridUtil.logDebug('getviewPortWidth', viewPortWidth);
- return viewPortWidth;
- };
- Grid.prototype.getHeaderViewportWidth = function getHeaderViewportWidth() {
- var viewPortWidth = this.getViewportWidth();
- //if (typeof(this.verticalScrollbarWidth) !== 'undefined' && this.verticalScrollbarWidth !== undefined && this.verticalScrollbarWidth > 0) {
- // viewPortWidth = viewPortWidth + this.verticalScrollbarWidth;
- //}
- return viewPortWidth;
- };
- Grid.prototype.addVerticalScrollSync = function (containerId, callBackFn) {
- this.verticalScrollSyncCallBackFns[containerId] = callBackFn;
- };
- Grid.prototype.addHorizontalScrollSync = function (containerId, callBackFn) {
- this.horizontalScrollSyncCallBackFns[containerId] = callBackFn;
- };
- /**
- * Scroll needed containers by calling their ScrollSyncs
- * @param sourceContainerId the containerId that has already set it's top/left.
- * can be empty string which means all containers need to set top/left
- * @param scrollEvent
- */
- Grid.prototype.scrollContainers = function (sourceContainerId, scrollEvent) {
- if (scrollEvent.y) {
- //default for no container Id (ex. mousewheel means that all containers must set scrollTop/Left)
- var verts = ['body','left', 'right'];
- this.flagScrollingVertically(scrollEvent);
- if (sourceContainerId === 'body') {
- verts = ['left', 'right'];
- }
- else if (sourceContainerId === 'left') {
- verts = ['body', 'right'];
- }
- else if (sourceContainerId === 'right') {
- verts = ['body', 'left'];
- }
- for (var i = 0; i < verts.length; i++) {
- var id = verts[i];
- if (this.verticalScrollSyncCallBackFns[id]) {
- this.verticalScrollSyncCallBackFns[id](scrollEvent);
- }
- }
- }
- if (scrollEvent.x) {
- //default for no container Id (ex. mousewheel means that all containers must set scrollTop/Left)
- var horizs = ['body','bodyheader', 'bodyfooter'];
- this.flagScrollingHorizontally(scrollEvent);
- if (sourceContainerId === 'body') {
- horizs = ['bodyheader', 'bodyfooter'];
- }
- for (var j = 0; j < horizs.length; j++) {
- var idh = horizs[j];
- if (this.horizontalScrollSyncCallBackFns[idh]) {
- this.horizontalScrollSyncCallBackFns[idh](scrollEvent);
- }
- }
- }
- };
- Grid.prototype.registerViewportAdjuster = function registerViewportAdjuster(func) {
- this.viewportAdjusters.push(func);
- };
- Grid.prototype.removeViewportAdjuster = function registerViewportAdjuster(func) {
- var idx = this.viewportAdjusters.indexOf(func);
- if (typeof(idx) !== 'undefined' && idx !== undefined) {
- this.viewportAdjusters.splice(idx, 1);
- }
- };
- Grid.prototype.getViewportAdjustment = function getViewportAdjustment() {
- var self = this;
- var adjustment = { height: 0, width: 0 };
- self.viewportAdjusters.forEach(function (func) {
- adjustment = func.call(this, adjustment);
- });
- return adjustment;
- };
- Grid.prototype.getVisibleRowCount = function getVisibleRowCount() {
- // var count = 0;
- // this.rows.forEach(function (row) {
- // if (row.visible) {
- // count++;
- // }
- // });
- // return this.visibleRowCache.length;
- return this.renderContainers.body.visibleRowCache.length;
- };
- Grid.prototype.getVisibleRows = function getVisibleRows() {
- return this.renderContainers.body.visibleRowCache;
- };
- Grid.prototype.getVisibleColumnCount = function getVisibleColumnCount() {
- // var count = 0;
- // this.rows.forEach(function (row) {
- // if (row.visible) {
- // count++;
- // }
- // });
- // return this.visibleRowCache.length;
- return this.renderContainers.body.visibleColumnCache.length;
- };
- Grid.prototype.searchRows = function searchRows(renderableRows) {
- return rowSearcher.search(this, renderableRows, this.columns);
- };
- Grid.prototype.sortByColumn = function sortByColumn(renderableRows) {
- return rowSorter.sort(this, renderableRows, this.columns);
- };
- /**
- * @ngdoc function
- * @name getCellValue
- * @methodOf ui.grid.class:Grid
- * @description Gets the value of a cell for a particular row and column
- * @param {GridRow} row Row to access
- * @param {GridColumn} col Column to access
- */
- Grid.prototype.getCellValue = function getCellValue(row, col){
- if ( typeof(row.entity[ '$$' + col.uid ]) !== 'undefined' ) {
- return row.entity[ '$$' + col.uid].rendered;
- } else if (this.options.flatEntityAccess && typeof(col.field) !== 'undefined' ){
- return row.entity[col.field];
- } else {
- if (!col.cellValueGetterCache) {
- col.cellValueGetterCache = $parse(row.getEntityQualifiedColField(col));
- }
- return col.cellValueGetterCache(row);
- }
- };
- /**
- * @ngdoc function
- * @name getCellDisplayValue
- * @methodOf ui.grid.class:Grid
- * @description Gets the displayed value of a cell after applying any the `cellFilter`
- * @param {GridRow} row Row to access
- * @param {GridColumn} col Column to access
- */
- Grid.prototype.getCellDisplayValue = function getCellDisplayValue(row, col) {
- if ( !col.cellDisplayGetterCache ) {
- var custom_filter = col.cellFilter ? " | " + col.cellFilter : "";
- if (typeof(row.entity['$$' + col.uid]) !== 'undefined') {
- col.cellDisplayGetterCache = $parse(row.entity['$$' + col.uid].rendered + custom_filter);
- } else if (this.options.flatEntityAccess && typeof(col.field) !== 'undefined') {
- var colField = col.field.replace(/(')|(\\)/g, "\\$&");
- col.cellDisplayGetterCache = $parse('entity[\'' + colField + '\']' + custom_filter);
- } else {
- col.cellDisplayGetterCache = $parse(row.getEntityQualifiedColField(col) + custom_filter);
- }
- }
- var rowWithCol = angular.extend({}, row, {col: col});
- return col.cellDisplayGetterCache(rowWithCol);
- };
- Grid.prototype.getNextColumnSortPriority = function getNextColumnSortPriority() {
- var self = this,
- p = 0;
- self.columns.forEach(function (col) {
- if (col.sort && col.sort.priority !== undefined && col.sort.priority >= p) {
- p = col.sort.priority + 1;
- }
- });
- return p;
- };
- /**
- * @ngdoc function
- * @name resetColumnSorting
- * @methodOf ui.grid.class:Grid
- * @description Return the columns that the grid is currently being sorted by
- * @param {GridColumn} [excludedColumn] Optional GridColumn to exclude from having its sorting reset
- */
- Grid.prototype.resetColumnSorting = function resetColumnSorting(excludeCol) {
- var self = this;
- self.columns.forEach(function (col) {
- if (col !== excludeCol && !col.suppressRemoveSort) {
- col.sort = {};
- }
- });
- };
- /**
- * @ngdoc function
- * @name getColumnSorting
- * @methodOf ui.grid.class:Grid
- * @description Return the columns that the grid is currently being sorted by
- * @returns {Array[GridColumn]} An array of GridColumn objects
- */
- Grid.prototype.getColumnSorting = function getColumnSorting() {
- var self = this;
- var sortedCols = [], myCols;
- // Iterate through all the columns, sorted by priority
- // Make local copy of column list, because sorting is in-place and we do not want to
- // change the original sequence of columns
- myCols = self.columns.slice(0);
- myCols.sort(rowSorter.prioritySort).forEach(function (col) {
- if (col.sort && typeof(col.sort.direction) !== 'undefined' && col.sort.direction && (col.sort.direction === uiGridConstants.ASC || col.sort.direction === uiGridConstants.DESC)) {
- sortedCols.push(col);
- }
- });
- return sortedCols;
- };
- /**
- * @ngdoc function
- * @name sortColumn
- * @methodOf ui.grid.class:Grid
- * @description Set the sorting on a given column, optionally resetting any existing sorting on the Grid.
- * Emits the sortChanged event whenever the sort criteria are changed.
- * @param {GridColumn} column Column to set the sorting on
- * @param {uiGridConstants.ASC|uiGridConstants.DESC} [direction] Direction to sort by, either descending or ascending.
- * If not provided, the column will iterate through the sort directions
- * specified in the {@link ui.grid.class:GridOptions.columnDef#sortDirectionCycle sortDirectionCycle} attribute.
- * @param {boolean} [add] Add this column to the sorting. If not provided or set to `false`, the Grid will reset any existing sorting and sort
- * by this column only
- * @returns {Promise} A resolved promise that supplies the column.
- */
- Grid.prototype.sortColumn = function sortColumn(column, directionOrAdd, add) {
- var self = this,
- direction = null;
- if (typeof(column) === 'undefined' || !column) {
- throw new Error('No column parameter provided');
- }
- // Second argument can either be a direction or whether to add this column to the existing sort.
- // If it's a boolean, it's an add, otherwise, it's a direction
- if (typeof(directionOrAdd) === 'boolean') {
- add = directionOrAdd;
- }
- else {
- direction = directionOrAdd;
- }
- if (!add) {
- self.resetColumnSorting(column);
- column.sort.priority = undefined;
- // Get the actual priority since there may be columns which have suppressRemoveSort set
- column.sort.priority = self.getNextColumnSortPriority();
- }
- else if (column.sort.priority === undefined){
- column.sort.priority = self.getNextColumnSortPriority();
- }
- if (!direction) {
- // Find the current position in the cycle (or -1).
- var i = column.sortDirectionCycle.indexOf(column.sort.direction ? column.sort.direction : null);
- // Proceed to the next position in the cycle (or start at the beginning).
- i = (i+1) % column.sortDirectionCycle.length;
- // If suppressRemoveSort is set, and the next position in the cycle would
- // remove the sort, skip it.
- if (column.colDef && column.suppressRemoveSort && !column.sortDirectionCycle[i]) {
- i = (i+1) % column.sortDirectionCycle.length;
- }
- if (column.sortDirectionCycle[i]) {
- column.sort.direction = column.sortDirectionCycle[i];
- } else {
- removeSortOfColumn(column, self);
- }
- }
- else {
- column.sort.direction = direction;
- }
- self.api.core.raise.sortChanged( self, self.getColumnSorting() );
- return $q.when(column);
- };
- var removeSortOfColumn = function removeSortOfColumn(column, grid) {
- //Decrease priority for every col where priority is higher than the removed sort's priority.
- grid.columns.forEach(function (col) {
- if (col.sort && col.sort.priority !== undefined && col.sort.priority > column.sort.priority) {
- col.sort.priority -= 1;
- }
- });
- //Remove sort
- column.sort = {};
- };
- /**
- * communicate to outside world that we are done with initial rendering
- */
- Grid.prototype.renderingComplete = function(){
- if (angular.isFunction(this.options.onRegisterApi)) {
- this.options.onRegisterApi(this.api);
- }
- this.api.core.raise.renderingComplete( this.api );
- };
- Grid.prototype.createRowHashMap = function createRowHashMap() {
- var self = this;
- var hashMap = new RowHashMap();
- hashMap.grid = self;
- return hashMap;
- };
- /**
- * @ngdoc function
- * @name refresh
- * @methodOf ui.grid.class:Grid
- * @description Refresh the rendered grid on screen.
- * @param {boolean} [rowsAltered] Optional flag for refreshing when the number of rows has changed.
- */
- Grid.prototype.refresh = function refresh(rowsAltered) {
- var self = this;
- var p1 = self.processRowsProcessors(self.rows).then(function (renderableRows) {
- self.setVisibleRows(renderableRows);
- }).catch(angular.noop);
- var p2 = self.processColumnsProcessors(self.columns).then(function (renderableColumns) {
- self.setVisibleColumns(renderableColumns);
- }).catch(angular.noop);
- return $q.all([p1, p2]).then(function () {
- self.refreshCanvas(true);
- self.redrawInPlace(rowsAltered);
- }).catch(angular.noop);
- };
- /**
- * @ngdoc function
- * @name refreshRows
- * @methodOf ui.grid.class:Grid
- * @description Refresh the rendered rows on screen? Note: not functional at present
- * @returns {promise} promise that is resolved when render completes?
- *
- */
- Grid.prototype.refreshRows = function refreshRows() {
- var self = this;
- return self.processRowsProcessors(self.rows)
- .then(function (renderableRows) {
- self.setVisibleRows(renderableRows);
- self.redrawInPlace();
- self.refreshCanvas( true );
- }).catch(angular.noop);
- };
- /**
- * @ngdoc function
- * @name refreshCanvas
- * @methodOf ui.grid.class:Grid
- * @description Builds all styles and recalculates much of the grid sizing
- * @param {object} buildStyles optional parameter. Use TBD
- * @returns {promise} promise that is resolved when the canvas
- * has been refreshed
- *
- */
- Grid.prototype.refreshCanvas = function(buildStyles) {
- var self = this;
- // gridUtil.logDebug('refreshCanvas');
- var p = $q.defer();
- // Get all the header heights
- var containerHeadersToRecalc = [];
- for (var containerId in self.renderContainers) {
- if (self.renderContainers.hasOwnProperty(containerId)) {
- var container = self.renderContainers[containerId];
- // Skip containers that have no canvasWidth set yet
- if (container.canvasWidth === null || isNaN(container.canvasWidth)) {
- continue;
- }
- if (container.header || container.headerCanvas) {
- container.explicitHeaderHeight = container.explicitHeaderHeight || null;
- container.explicitHeaderCanvasHeight = container.explicitHeaderCanvasHeight || null;
- containerHeadersToRecalc.push(container);
- }
- }
- }
- // Build the styles without the explicit header heights
- if (buildStyles) {
- self.buildStyles();
- }
- /*
- *
- * Here we loop through the headers, measuring each element as well as any header "canvas" it has within it.
- *
- * If any header is less than the largest header height, it will be resized to that so that we don't have headers
- * with different heights, which looks like a rendering problem
- *
- * We'll do the same thing with the header canvases, and give the header CELLS an explicit height if their canvas
- * is smaller than the largest canvas height. That was header cells without extra controls like filtering don't
- * appear shorter than other cells.
- *
- */
- if (containerHeadersToRecalc.length > 0) {
- // Putting in a timeout as it's not calculating after the grid element is rendered and filled out
- $timeout(function() {
- // var oldHeaderHeight = self.grid.headerHeight;
- // self.grid.headerHeight = gridUtil.outerElementHeight(self.header);
- var rebuildStyles = false;
- // Get all the header heights
- var maxHeaderHeight = 0;
- var maxHeaderCanvasHeight = 0;
- var i, container;
- var getHeight = function(oldVal, newVal){
- if ( oldVal !== newVal){
- rebuildStyles = true;
- }
- return newVal;
- };
- for (i = 0; i < containerHeadersToRecalc.length; i++) {
- container = containerHeadersToRecalc[i];
- // Skip containers that have no canvasWidth set yet
- if (container.canvasWidth === null || isNaN(container.canvasWidth)) {
- continue;
- }
- if (container.header) {
- var headerHeight = container.headerHeight = getHeight(container.headerHeight, gridUtil.outerElementHeight(container.header));
- // Get the "inner" header height, that is the height minus the top and bottom borders, if present. We'll use it to make sure all the headers have a consistent height
- var topBorder = gridUtil.getBorderSize(container.header, 'top');
- var bottomBorder = gridUtil.getBorderSize(container.header, 'bottom');
- var innerHeaderHeight = parseInt(headerHeight - topBorder - bottomBorder, 10);
- innerHeaderHeight = innerHeaderHeight < 0 ? 0 : innerHeaderHeight;
- container.innerHeaderHeight = innerHeaderHeight;
- // If the header doesn't have an explicit height set, save the largest header height for use later
- // Explicit header heights are based off of the max we are calculating here. We never want to base the max on something we're setting explicitly
- if (!container.explicitHeaderHeight && innerHeaderHeight > maxHeaderHeight) {
- maxHeaderHeight = innerHeaderHeight;
- }
- }
- if (container.headerCanvas) {
- var headerCanvasHeight = container.headerCanvasHeight = getHeight(container.headerCanvasHeight, parseInt(gridUtil.outerElementHeight(container.headerCanvas), 10));
- // If the header doesn't have an explicit canvas height, save the largest header canvas height for use later
- // Explicit header heights are based off of the max we are calculating here. We never want to base the max on something we're setting explicitly
- if (!container.explicitHeaderCanvasHeight && headerCanvasHeight > maxHeaderCanvasHeight) {
- maxHeaderCanvasHeight = headerCanvasHeight;
- }
- }
- }
- // Go through all the headers
- for (i = 0; i < containerHeadersToRecalc.length; i++) {
- container = containerHeadersToRecalc[i];
- /* If:
- 1. We have a max header height
- 2. This container has a header height defined
- 3. And either this container has an explicit header height set, OR its header height is less than the max
- then:
- Give this container's header an explicit height so it will line up with the tallest header
- */
- if (
- maxHeaderHeight > 0 && typeof(container.headerHeight) !== 'undefined' && container.headerHeight !== null &&
- (container.explicitHeaderHeight || container.headerHeight < maxHeaderHeight)
- ) {
- container.explicitHeaderHeight = getHeight(container.explicitHeaderHeight, maxHeaderHeight);
- }
- // Do the same as above except for the header canvas
- if (
- maxHeaderCanvasHeight > 0 && typeof(container.headerCanvasHeight) !== 'undefined' && container.headerCanvasHeight !== null &&
- (container.explicitHeaderCanvasHeight || container.headerCanvasHeight < maxHeaderCanvasHeight)
- ) {
- container.explicitHeaderCanvasHeight = getHeight(container.explicitHeaderCanvasHeight, maxHeaderCanvasHeight);
- }
- }
- // Rebuild styles if the header height has changed
- // The header height is used in body/viewport calculations and those are then used in other styles so we need it to be available
- if (buildStyles && rebuildStyles) {
- self.buildStyles();
- }
- p.resolve();
- });
- }
- else {
- // Timeout still needs to be here to trigger digest after styles have been rebuilt
- $timeout(function() {
- p.resolve();
- });
- }
- return p.promise;
- };
- /**
- * @ngdoc function
- * @name redrawInPlace
- * @methodOf ui.grid.class:Grid
- * @description Redraw the rows and columns based on our current scroll position
- * @param {boolean} [rowsAdded] Optional to indicate rows are added and the scroll percentage must be recalculated
- *
- */
- Grid.prototype.redrawInPlace = function redrawInPlace(rowsAdded) {
- // gridUtil.logDebug('redrawInPlace');
- var self = this;
- for (var i in self.renderContainers) {
- var container = self.renderContainers[i];
- // gridUtil.logDebug('redrawing container', i);
- if (rowsAdded) {
- container.adjustRows(container.prevScrollTop, null);
- container.adjustColumns(container.prevScrollLeft, null);
- }
- else {
- container.adjustRows(null, container.prevScrolltopPercentage);
- container.adjustColumns(null, container.prevScrollleftPercentage);
- }
- }
- };
- /**
- * @ngdoc function
- * @name hasLeftContainerColumns
- * @methodOf ui.grid.class:Grid
- * @description returns true if leftContainer has columns
- */
- Grid.prototype.hasLeftContainerColumns = function () {
- return this.hasLeftContainer() && this.renderContainers.left.renderedColumns.length > 0;
- };
- /**
- * @ngdoc function
- * @name hasRightContainerColumns
- * @methodOf ui.grid.class:Grid
- * @description returns true if rightContainer has columns
- */
- Grid.prototype.hasRightContainerColumns = function () {
- return this.hasRightContainer() && this.renderContainers.right.renderedColumns.length > 0;
- };
- // Turn the scroll position into a percentage and make it an argument for a scroll event
- function getScrollPercentage(scrollPixels, scrollLength) {
- var percentage = scrollPixels / scrollLength;
- // if the percentage is greater than 1, set it to 1
- return percentage <= 1 ? percentage : 1;
- }
- // Only returns the scroll Y position if the percentage is different from the previous
- function getScrollY(scrollPixels, scrollLength, prevScrolltopPercentage) {
- var scrollPercentage = getScrollPercentage(scrollPixels, scrollLength);
- if (scrollPercentage !== prevScrolltopPercentage) {
- return { percentage: getScrollPercentage(scrollPixels, scrollLength) };
- }
- return undefined;
- }
- // Only returns the scroll X position if the percentage is different from the previous
- function getScrollX(horizScrollPixels, horizScrollLength, prevScrollleftPercentage) {
- var horizPercentage = horizScrollPixels / horizScrollLength;
- horizPercentage = (horizPercentage > 1) ? 1 : horizPercentage;
- if (horizPercentage !== prevScrollleftPercentage) {
- return { percentage: horizPercentage };
- }
- return undefined;
- }
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:Grid
- * @name scrollToIfNecessary
- * @description Scrolls the grid to make a certain row and column combo visible,
- * in the case that it is not completely visible on the screen already.
- * @param {GridRow} gridRow row to make visible
- * @param {GridColumn} gridCol column to make visible
- * @returns {promise} a promise that is resolved when scrolling is complete
- */
- Grid.prototype.scrollToIfNecessary = function (gridRow, gridCol) {
- var self = this;
- var scrollEvent = new ScrollEvent(self, 'uiGrid.scrollToIfNecessary');
- // Alias the visible row and column caches
- var visRowCache = self.renderContainers.body.visibleRowCache;
- var visColCache = self.renderContainers.body.visibleColumnCache;
- /*-- Get the top, left, right, and bottom "scrolled" edges of the grid --*/
- // The top boundary is the current Y scroll position PLUS the header height, because the header can obscure rows when the grid is scrolled downwards
- var topBound = self.renderContainers.body.prevScrollTop + self.headerHeight;
- // Don't the let top boundary be less than 0
- topBound = (topBound < 0) ? 0 : topBound;
- // The left boundary is the current X scroll position
- var leftBound = self.renderContainers.body.prevScrollLeft;
- // The bottom boundary is the current Y scroll position, plus the height of the grid, but minus the header height.
- // Basically this is the viewport height added on to the scroll position
- var bottomBound = self.renderContainers.body.prevScrollTop + self.gridHeight - self.renderContainers.body.headerHeight - self.footerHeight - self.scrollbarWidth;
- // If there's a horizontal scrollbar, remove its height from the bottom boundary, otherwise we'll be letting it obscure rows
- //if (self.horizontalScrollbarHeight) {
- // bottomBound = bottomBound - self.horizontalScrollbarHeight;
- //}
- // The right position is the current X scroll position minus the grid width
- var rightBound = self.renderContainers.body.prevScrollLeft + Math.ceil(self.renderContainers.body.getViewportWidth());
- // If there's a vertical scrollbar, subtract it from the right boundary or we'll allow it to obscure cells
- //if (self.verticalScrollbarWidth) {
- // rightBound = rightBound - self.verticalScrollbarWidth;
- //}
- // We were given a row to scroll to
- if (gridRow !== null) {
- // This is the index of the row we want to scroll to, within the list of rows that can be visible
- var seekRowIndex = visRowCache.indexOf(gridRow);
- // Total vertical scroll length of the grid
- var scrollLength = (self.renderContainers.body.getCanvasHeight() - self.renderContainers.body.getViewportHeight());
- // Add the height of the native horizontal scrollbar to the scroll length, if it's there. Otherwise it will mask over the final row
- //if (self.horizontalScrollbarHeight && self.horizontalScrollbarHeight > 0) {
- // scrollLength = scrollLength + self.horizontalScrollbarHeight;
- //}
- // This is the minimum amount of pixels we need to scroll vertical in order to see this row.
- var pixelsToSeeRow = (seekRowIndex * self.options.rowHeight + self.headerHeight);
- // Don't let the pixels required to see the row be less than zero
- pixelsToSeeRow = (pixelsToSeeRow < 0) ? 0 : pixelsToSeeRow;
- var scrollPixels;
- // If the scroll position we need to see the row is LESS than the top boundary, i.e. obscured above the top of the self...
- if (pixelsToSeeRow < topBound) {
- // Get the different between the top boundary and the required scroll position and subtract it from the current scroll position\
- // to get the full position we need
- scrollPixels = self.renderContainers.body.prevScrollTop - (topBound - pixelsToSeeRow);
- scrollEvent.y = getScrollY(scrollPixels, scrollLength, self.renderContainers.body.prevScrolltopPercentage);
- }
- // Otherwise if the scroll position we need to see the row is MORE than the bottom boundary, i.e. obscured below the bottom of the self...
- else if (pixelsToSeeRow > bottomBound) {
- // Get the different between the bottom boundary and the required scroll position and add it to the current scroll position
- // to get the full position we need
- scrollPixels = pixelsToSeeRow - bottomBound + self.renderContainers.body.prevScrollTop;
- scrollEvent.y = getScrollY(scrollPixels, scrollLength,self.renderContainers.body.prevScrolltopPercentage);
- }
- }
- // We were given a column to scroll to
- if (gridCol !== null) {
- // This is the index of the column we want to scroll to, within the list of columns that can be visible
- var seekColumnIndex = visColCache.indexOf(gridCol);
- // Total horizontal scroll length of the grid
- var horizScrollLength = (self.renderContainers.body.getCanvasWidth() - self.renderContainers.body.getViewportWidth());
- // This is the minimum amount of pixels we need to scroll horizontal in order to see this column
- var columnLeftEdge = 0;
- for (var i = 0; i < seekColumnIndex; i++) {
- var col = visColCache[i];
- columnLeftEdge += col.drawnWidth;
- }
- columnLeftEdge = (columnLeftEdge < 0) ? 0 : columnLeftEdge;
- var columnRightEdge = columnLeftEdge + gridCol.drawnWidth;
- // Don't let the pixels required to see the column be less than zero
- columnRightEdge = (columnRightEdge < 0) ? 0 : columnRightEdge;
- var horizScrollPixels;
- // If the scroll position we need to see the column is LESS than the left boundary, i.e. obscured before the left of the self...
- if (columnLeftEdge < leftBound) {
- // Get the different between the left boundary and the required scroll position and subtract it from the current scroll position\
- // to get the full position we need
- horizScrollPixels = self.renderContainers.body.prevScrollLeft - (leftBound - columnLeftEdge);
- // Turn the scroll position into a percentage and make it an argument for a scroll event
- scrollEvent.x = getScrollX(horizScrollPixels, horizScrollLength, self.renderContainers.body.prevScrollleftPercentage);
- }
- // Otherwise if the scroll position we need to see the column is MORE than the right boundary, i.e. obscured after the right of the self...
- else if (columnRightEdge > rightBound) {
- // Get the different between the right boundary and the required scroll position and add it to the current scroll position
- // to get the full position we need
- horizScrollPixels = columnRightEdge - rightBound + self.renderContainers.body.prevScrollLeft;
- // Turn the scroll position into a percentage and make it an argument for a scroll event
- scrollEvent.x = getScrollX(horizScrollPixels, horizScrollLength, self.renderContainers.body.prevScrollleftPercentage);
- }
- }
- var deferred = $q.defer();
- // If we need to scroll on either the x or y axes, fire a scroll event
- if (scrollEvent.y || scrollEvent.x) {
- scrollEvent.withDelay = false;
- self.scrollContainers('',scrollEvent);
- var dereg = self.api.core.on.scrollEnd(null,function() {
- deferred.resolve(scrollEvent);
- dereg();
- });
- }
- else {
- deferred.resolve();
- }
- return deferred.promise;
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:Grid
- * @name scrollTo
- * @description Scroll the grid such that the specified
- * row and column is in view
- * @param {object} rowEntity gridOptions.data[] array instance to make visible
- * @param {object} colDef to make visible
- * @returns {promise} a promise that is resolved after any scrolling is finished
- */
- Grid.prototype.scrollTo = function (rowEntity, colDef) {
- var gridRow = null, gridCol = null;
- if (rowEntity !== null && typeof(rowEntity) !== 'undefined' ) {
- gridRow = this.getRow(rowEntity);
- }
- if (colDef !== null && typeof(colDef) !== 'undefined' ) {
- gridCol = this.getColumn(colDef.name ? colDef.name : colDef.field);
- }
- return this.scrollToIfNecessary(gridRow, gridCol);
- };
- /**
- * @ngdoc function
- * @name clearAllFilters
- * @methodOf ui.grid.class:Grid
- * @description Clears all filters and optionally refreshes the visible rows.
- * @param {object} refreshRows Defaults to true.
- * @param {object} clearConditions Defaults to false.
- * @param {object} clearFlags Defaults to false.
- * @returns {promise} If `refreshRows` is true, returns a promise of the rows refreshing.
- */
- Grid.prototype.clearAllFilters = function clearAllFilters(refreshRows, clearConditions, clearFlags) {
- // Default `refreshRows` to true because it will be the most commonly desired behaviour.
- if (refreshRows === undefined) {
- refreshRows = true;
- }
- if (clearConditions === undefined) {
- clearConditions = false;
- }
- if (clearFlags === undefined) {
- clearFlags = false;
- }
- this.columns.forEach(function(column) {
- column.filters.forEach(function(filter) {
- filter.term = undefined;
- if (clearConditions) {
- filter.condition = undefined;
- }
- if (clearFlags) {
- filter.flags = undefined;
- }
- });
- });
- if (refreshRows) {
- return this.refreshRows();
- }
- };
- // Blatantly stolen from Angular as it isn't exposed (yet? 2.0?)
- function RowHashMap() {}
- RowHashMap.prototype = {
- /**
- * Store key value pair
- * @param key key to store can be any type
- * @param value value to store can be any type
- */
- put: function(key, value) {
- this[this.grid.options.rowIdentity(key)] = value;
- },
- /**
- * @param key
- * @returns {Object} the value for the key
- */
- get: function(key) {
- return this[this.grid.options.rowIdentity(key)];
- },
- /**
- * Remove the key/value pair
- * @param key
- */
- remove: function(key) {
- var value = this[key = this.grid.options.rowIdentity(key)];
- delete this[key];
- return value;
- }
- };
- return Grid;
- }]);
- })();
- (function () {
- angular.module('ui.grid')
- .factory('GridApi', ['$q', '$rootScope', 'gridUtil', 'uiGridConstants', 'GridRow', 'uiGridGridMenuService',
- function ($q, $rootScope, gridUtil, uiGridConstants, GridRow, uiGridGridMenuService) {
- /**
- * @ngdoc function
- * @name ui.grid.class:GridApi
- * @description GridApi provides the ability to register public methods events inside the grid and allow
- * for other components to use the api via featureName.raise.methodName and featureName.on.eventName(function(args){}.
- * <br/>
- * To listen to events, you must add a callback to gridOptions.onRegisterApi
- * <pre>
- * $scope.gridOptions.onRegisterApi = function(gridApi){
- * gridApi.cellNav.on.navigate($scope,function(newRowCol, oldRowCol){
- * $log.log('navigation event');
- * });
- * };
- * </pre>
- * @param {object} grid grid that owns api
- */
- var GridApi = function GridApi(grid) {
- this.grid = grid;
- this.listeners = [];
- /**
- * @ngdoc function
- * @name renderingComplete
- * @methodOf ui.grid.core.api:PublicApi
- * @description Rendering is complete, called at the same
- * time as `onRegisterApi`, but provides a way to obtain
- * that same event within features without stopping end
- * users from getting at the onRegisterApi method.
- *
- * Included in gridApi so that it's always there - otherwise
- * there is still a timing problem with when a feature can
- * call this.
- *
- * @param {GridApi} gridApi the grid api, as normally
- * returned in the onRegisterApi method
- *
- * @example
- * <pre>
- * gridApi.core.on.renderingComplete( grid );
- * </pre>
- */
- this.registerEvent( 'core', 'renderingComplete' );
- /**
- * @ngdoc event
- * @name filterChanged
- * @eventOf ui.grid.core.api:PublicApi
- * @description is raised after the filter is changed. The nature
- * of the watch expression doesn't allow notification of what changed,
- * so the receiver of this event will need to re-extract the filter
- * conditions from the columns.
- *
- */
- this.registerEvent( 'core', 'filterChanged' );
- /**
- * @ngdoc function
- * @name setRowInvisible
- * @methodOf ui.grid.core.api:PublicApi
- * @description Sets an override on the row to make it always invisible,
- * which will override any filtering or other visibility calculations.
- * If the row is currently visible then sets it to invisible and calls
- * both grid refresh and emits the rowsVisibleChanged event
- * @param {GridRow} row the row we want to make invisible
- */
- this.registerMethod( 'core', 'setRowInvisible', GridRow.prototype.setRowInvisible );
- /**
- * @ngdoc function
- * @name clearRowInvisible
- * @methodOf ui.grid.core.api:PublicApi
- * @description Clears any override on visibility for the row so that it returns to
- * using normal filtering and other visibility calculations.
- * If the row is currently invisible then sets it to visible and calls
- * both grid refresh and emits the rowsVisibleChanged event
- * TODO: if a filter is active then we can't just set it to visible?
- * @param {GridRow} row the row we want to make visible
- */
- this.registerMethod( 'core', 'clearRowInvisible', GridRow.prototype.clearRowInvisible );
- /**
- * @ngdoc function
- * @name getVisibleRows
- * @methodOf ui.grid.core.api:PublicApi
- * @description Returns all visible rows
- * @param {Grid} grid the grid you want to get visible rows from
- * @returns {array} an array of gridRow
- */
- this.registerMethod( 'core', 'getVisibleRows', this.grid.getVisibleRows );
- /**
- * @ngdoc event
- * @name rowsVisibleChanged
- * @eventOf ui.grid.core.api:PublicApi
- * @description is raised after the rows that are visible
- * change. The filtering is zero-based, so it isn't possible
- * to say which rows changed (unlike in the selection feature).
- * We can plausibly know which row was changed when setRowInvisible
- * is called, but in that situation the user already knows which row
- * they changed. When a filter runs we don't know what changed,
- * and that is the one that would have been useful.
- *
- */
- this.registerEvent( 'core', 'rowsVisibleChanged' );
- /**
- * @ngdoc event
- * @name rowsRendered
- * @eventOf ui.grid.core.api:PublicApi
- * @description is raised after the cache of visible rows is changed.
- */
- this.registerEvent( 'core', 'rowsRendered' );
- /**
- * @ngdoc event
- * @name scrollBegin
- * @eventOf ui.grid.core.api:PublicApi
- * @description is raised when scroll begins. Is throttled, so won't be raised too frequently
- */
- this.registerEvent( 'core', 'scrollBegin' );
- /**
- * @ngdoc event
- * @name scrollEnd
- * @eventOf ui.grid.core.api:PublicApi
- * @description is raised when scroll has finished. Is throttled, so won't be raised too frequently
- */
- this.registerEvent( 'core', 'scrollEnd' );
- /**
- * @ngdoc event
- * @name canvasHeightChanged
- * @eventOf ui.grid.core.api:PublicApi
- * @description is raised when the canvas height has changed
- * <br/>
- * arguments: oldHeight, newHeight
- */
- this.registerEvent( 'core', 'canvasHeightChanged');
- /**
- * @ngdoc event
- * @name gridDimensionChanged
- * @eventOf ui.grid.core.api:PublicApi
- * @description is raised when the grid dimensions have changed (when autoResize is on)
- * <br/>
- * arguments: oldGridHeight, oldGridWidth, newGridHeight, newGridWidth
- */
- this.registerEvent( 'core', 'gridDimensionChanged');
- };
- /**
- * @ngdoc function
- * @name ui.grid.class:suppressEvents
- * @methodOf ui.grid.class:GridApi
- * @description Used to execute a function while disabling the specified event listeners.
- * Disables the listenerFunctions, executes the callbackFn, and then enables
- * the listenerFunctions again
- * @param {object} listenerFuncs listenerFunc or array of listenerFuncs to suppress. These must be the same
- * functions that were used in the .on.eventName method
- * @param {object} callBackFn function to execute
- * @example
- * <pre>
- * var navigate = function (newRowCol, oldRowCol){
- * //do something on navigate
- * }
- *
- * gridApi.cellNav.on.navigate(scope,navigate);
- *
- *
- * //call the scrollTo event and suppress our navigate listener
- * //scrollTo will still raise the event for other listeners
- * gridApi.suppressEvents(navigate, function(){
- * gridApi.cellNav.scrollTo(aRow, aCol);
- * });
- *
- * </pre>
- */
- GridApi.prototype.suppressEvents = function (listenerFuncs, callBackFn) {
- var self = this;
- var listeners = angular.isArray(listenerFuncs) ? listenerFuncs : [listenerFuncs];
- //find all registered listeners
- var foundListeners = self.listeners.filter(function(listener) {
- return listeners.some(function(l) {
- return listener.handler === l;
- });
- });
- //deregister all the listeners
- foundListeners.forEach(function(l){
- l.dereg();
- });
- callBackFn();
- //reregister all the listeners
- foundListeners.forEach(function(l){
- l.dereg = registerEventWithAngular(l.eventId, l.handler, self.grid, l._this);
- });
- };
- /**
- * @ngdoc function
- * @name registerEvent
- * @methodOf ui.grid.class:GridApi
- * @description Registers a new event for the given feature. The event will get a
- * .raise and .on prepended to it
- * <br>
- * .raise.eventName() - takes no arguments
- * <br/>
- * <br/>
- * .on.eventName(scope, callBackFn, _this)
- * <br/>
- * scope - a scope reference to add a deregister call to the scopes .$on('destroy'). Scope is optional and can be a null value,
- * but in this case you must deregister it yourself via the returned deregister function
- * <br/>
- * callBackFn - The function to call
- * <br/>
- * _this - optional this context variable for callbackFn. If omitted, grid.api will be used for the context
- * <br/>
- * .on.eventName returns a dereg funtion that will remove the listener. It's not necessary to use it as the listener
- * will be removed when the scope is destroyed.
- * @param {string} featureName name of the feature that raises the event
- * @param {string} eventName name of the event
- */
- GridApi.prototype.registerEvent = function (featureName, eventName) {
- var self = this;
- if (!self[featureName]) {
- self[featureName] = {};
- }
- var feature = self[featureName];
- if (!feature.on) {
- feature.on = {};
- feature.raise = {};
- }
- var eventId = self.grid.id + featureName + eventName;
- // gridUtil.logDebug('Creating raise event method ' + featureName + '.raise.' + eventName);
- feature.raise[eventName] = function () {
- $rootScope.$emit.apply($rootScope, [eventId].concat(Array.prototype.slice.call(arguments)));
- };
- // gridUtil.logDebug('Creating on event method ' + featureName + '.on.' + eventName);
- feature.on[eventName] = function (scope, handler, _this) {
- if ( scope !== null && typeof(scope.$on) === 'undefined' ){
- gridUtil.logError('asked to listen on ' + featureName + '.on.' + eventName + ' but scope wasn\'t passed in the input parameters. It is legitimate to pass null, but you\'ve passed something else, so you probably forgot to provide scope rather than did it deliberately, not registering');
- return;
- }
- var deregAngularOn = registerEventWithAngular(eventId, handler, self.grid, _this);
- //track our listener so we can turn off and on
- var listener = {handler: handler, dereg: deregAngularOn, eventId: eventId, scope: scope, _this:_this};
- self.listeners.push(listener);
- var removeListener = function(){
- listener.dereg();
- var index = self.listeners.indexOf(listener);
- self.listeners.splice(index,1);
- };
- //destroy tracking when scope is destroyed
- if (scope) {
- scope.$on('$destroy', function() {
- removeListener();
- });
- }
- return removeListener;
- };
- };
- function registerEventWithAngular(eventId, handler, grid, _this) {
- return $rootScope.$on(eventId, function (event) {
- var args = Array.prototype.slice.call(arguments);
- args.splice(0, 1); //remove evt argument
- handler.apply(_this ? _this : grid.api, args);
- });
- }
- /**
- * @ngdoc function
- * @name registerEventsFromObject
- * @methodOf ui.grid.class:GridApi
- * @description Registers features and events from a simple objectMap.
- * eventObjectMap must be in this format (multiple features allowed)
- * <pre>
- * {featureName:
- * {
- * eventNameOne:function(args){},
- * eventNameTwo:function(args){}
- * }
- * }
- * </pre>
- * @param {object} eventObjectMap map of feature/event names
- */
- GridApi.prototype.registerEventsFromObject = function (eventObjectMap) {
- var self = this;
- var features = [];
- angular.forEach(eventObjectMap, function (featProp, featPropName) {
- var feature = {name: featPropName, events: []};
- angular.forEach(featProp, function (prop, propName) {
- feature.events.push(propName);
- });
- features.push(feature);
- });
- features.forEach(function (feature) {
- feature.events.forEach(function (event) {
- self.registerEvent(feature.name, event);
- });
- });
- };
- /**
- * @ngdoc function
- * @name registerMethod
- * @methodOf ui.grid.class:GridApi
- * @description Registers a new event for the given feature
- * @param {string} featureName name of the feature
- * @param {string} methodName name of the method
- * @param {object} callBackFn function to execute
- * @param {object} _this binds callBackFn 'this' to _this. Defaults to gridApi.grid
- */
- GridApi.prototype.registerMethod = function (featureName, methodName, callBackFn, _this) {
- if (!this[featureName]) {
- this[featureName] = {};
- }
- var feature = this[featureName];
- feature[methodName] = gridUtil.createBoundedWrapper(_this || this.grid, callBackFn);
- };
- /**
- * @ngdoc function
- * @name registerMethodsFromObject
- * @methodOf ui.grid.class:GridApi
- * @description Registers features and methods from a simple objectMap.
- * eventObjectMap must be in this format (multiple features allowed)
- * <br>
- * {featureName:
- * {
- * methodNameOne:function(args){},
- * methodNameTwo:function(args){}
- * }
- * @param {object} eventObjectMap map of feature/event names
- * @param {object} _this binds this to _this for all functions. Defaults to gridApi.grid
- */
- GridApi.prototype.registerMethodsFromObject = function (methodMap, _this) {
- var self = this;
- var features = [];
- angular.forEach(methodMap, function (featProp, featPropName) {
- var feature = {name: featPropName, methods: []};
- angular.forEach(featProp, function (prop, propName) {
- feature.methods.push({name: propName, fn: prop});
- });
- features.push(feature);
- });
- features.forEach(function (feature) {
- feature.methods.forEach(function (method) {
- self.registerMethod(feature.name, method.name, method.fn, _this);
- });
- });
- };
- return GridApi;
- }]);
- })();
- (function(){
- angular.module('ui.grid')
- .factory('GridColumn', ['gridUtil', 'uiGridConstants', 'i18nService', function(gridUtil, uiGridConstants, i18nService) {
- /**
- * ******************************************************************************************
- * PaulL1: Ugly hack here in documentation. These properties are clearly properties of GridColumn,
- * and need to be noted as such for those extending and building ui-grid itself.
- * However, from an end-developer perspective, they interact with all these through columnDefs,
- * and they really need to be documented there. I feel like they're relatively static, and
- * I can't find an elegant way for ngDoc to reference to both....so I've duplicated each
- * comment block. Ugh.
- *
- */
- /**
- * @ngdoc property
- * @name name
- * @propertyOf ui.grid.class:GridColumn
- * @description (mandatory) Each column should have a name, although for backward
- * compatibility with 2.x name can be omitted if field is present.
- *
- * Important - This must be unique to each column on a web page since it can
- * be used as a key for retrieving information such as custom sort algorithms.
- *
- */
- /**
- * @ngdoc property
- * @name name
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description (mandatory) Each column should have a name, although for backward
- * compatibility with 2.x name can be omitted if field is present.
- *
- * Important - This must be unique to each column on a web page since it can
- * be used as a key for retrieving information such as custom sort algorithms.
- *
- */
- /**
- * @ngdoc property
- * @name displayName
- * @propertyOf ui.grid.class:GridColumn
- * @description Column name that will be shown in the header. If displayName is not
- * provided then one is generated using the name.
- *
- */
- /**
- * @ngdoc property
- * @name displayName
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description Column name that will be shown in the header. If displayName is not
- * provided then one is generated using the name.
- *
- */
- /**
- * @ngdoc property
- * @name field
- * @propertyOf ui.grid.class:GridColumn
- * @description field must be provided if you wish to bind to a
- * property in the data source. Should be an angular expression that evaluates against grid.options.data
- * array element. Can be a complex expression: <code>employee.address.city</code>, or can be a function: <code>employee.getFullAddress()</code>.
- * See the angular docs on binding expressions.
- *
- */
- /**
- * @ngdoc property
- * @name field
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description field must be provided if you wish to bind to a
- * property in the data source. Should be an angular expression that evaluates against grid.options.data
- * array element. Can be a complex expression: <code>employee.address.city</code>, or can be a function: <code>employee.getFullAddress()</code>. * See the angular docs on binding expressions. *
- */
- /**
- * @ngdoc property
- * @name filter
- * @propertyOf ui.grid.class:GridColumn
- * @description Filter on this column.
- *
- * Available built-in conditions and types are listed under {@link jui.grid.service:uiGridConstants#properties_filter uiGridOptions.filter}
- * @example
- * <pre>{ term: 'text', condition: uiGridConstants.filter.STARTS_WITH, placeholder: 'type to filter...', ariaLabel: 'Filter for text', flags: { caseSensitive: false }, type: uiGridConstants.filter.SELECT, [ { value: 1, label: 'male' }, { value: 2, label: 'female' } ] }</pre>
- *
- */
- /**
- * @ngdoc property
- * @name extraStyle
- * @propertyOf ui.grid.class:GridColumn
- * @description additional on this column.
- * @example
- * <pre>{extraStyle: {display:'table-cell'}}</pre>
- *
- */
- /**
- * @ngdoc object
- * @name ui.grid.class:GridColumn
- * @description Represents the viewModel for each column. Any state or methods needed for a Grid Column
- * are defined on this prototype
- * @param {ColumnDef} colDef the column def to associate with this column
- * @param {number} uid the unique and immutable uid we'd like to allocate to this column
- * @param {Grid} grid the grid we'd like to create this column in
- */
- function GridColumn(colDef, uid, grid) {
- var self = this;
- self.grid = grid;
- self.uid = uid;
- self.updateColumnDef(colDef, true);
- self.aggregationValue = undefined;
- // The footer cell registers to listen for the rowsRendered event, and calls this. Needed to be
- // in something with a scope so that the dereg would get called
- self.updateAggregationValue = function() {
- // gridUtil.logDebug('getAggregationValue for Column ' + self.colDef.name);
- /**
- * @ngdoc property
- * @name aggregationType
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description The aggregation that you'd like to show in the columnFooter for this
- * column. Valid values are in
- * {@link ui.grid.service:uiGridConstants#properties_aggregationTypes uiGridConstants.aggregationTypes},
- * and currently include `uiGridConstants.aggregationTypes.count`,
- * `uiGridConstants.aggregationTypes.sum`, `uiGridConstants.aggregationTypes.avg`, `uiGridConstants.aggregationTypes.min`,
- * `uiGridConstants.aggregationTypes.max`.
- *
- * You can also provide a function as the aggregation type, in this case your function needs to accept the full
- * set of visible rows, and return a value that should be shown
- */
- if (!self.aggregationType) {
- self.aggregationValue = undefined;
- return;
- }
- var result = 0;
- var visibleRows = self.grid.getVisibleRows();
- var cellValues = function(){
- var values = [];
- visibleRows.forEach(function (row) {
- var cellValue = self.grid.getCellValue(row, self);
- var cellNumber = Number(cellValue);
- if (!isNaN(cellNumber)) {
- values.push(cellNumber);
- }
- });
- return values;
- };
- if (angular.isFunction(self.aggregationType)) {
- self.aggregationValue = self.aggregationType(visibleRows, self);
- }
- else if (self.aggregationType === uiGridConstants.aggregationTypes.count) {
- self.aggregationValue = self.grid.getVisibleRowCount();
- }
- else if (self.aggregationType === uiGridConstants.aggregationTypes.sum) {
- cellValues().forEach(function (value) {
- result += value;
- });
- self.aggregationValue = result;
- }
- else if (self.aggregationType === uiGridConstants.aggregationTypes.avg) {
- cellValues().forEach(function (value) {
- result += value;
- });
- result = result / cellValues().length;
- self.aggregationValue = result;
- }
- else if (self.aggregationType === uiGridConstants.aggregationTypes.min) {
- self.aggregationValue = Math.min.apply(null, cellValues());
- }
- else if (self.aggregationType === uiGridConstants.aggregationTypes.max) {
- self.aggregationValue = Math.max.apply(null, cellValues());
- }
- else {
- self.aggregationValue = '\u00A0';
- }
- };
- // var throttledUpdateAggregationValue = gridUtil.throttle(updateAggregationValue, self.grid.options.aggregationCalcThrottle, { trailing: true, context: self.name });
- /**
- * @ngdoc function
- * @name getAggregationValue
- * @methodOf ui.grid.class:GridColumn
- * @description gets the aggregation value based on the aggregation type for this column.
- * Debounced using scrollDebounce option setting
- */
- this.getAggregationValue = function() {
- // if (!self.grid.isScrollingVertically && !self.grid.isScrollingHorizontally) {
- // throttledUpdateAggregationValue();
- // }
- return self.aggregationValue;
- };
- }
- /**
- * @ngdoc function
- * @name hideColumn
- * @methodOf ui.grid.class:GridColumn
- * @description Hides the column by setting colDef.visible = false
- */
- GridColumn.prototype.hideColumn = function() {
- this.colDef.visible = false;
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:GridColumn
- * @name setPropertyOrDefault
- * @description Sets a property on the column using the passed in columnDef, and
- * setting the defaultValue if the value cannot be found on the colDef
- * @param {ColumnDef} colDef the column def to look in for the property value
- * @param {string} propName the property name we'd like to set
- * @param {object} defaultValue the value to use if the colDef doesn't provide the setting
- */
- GridColumn.prototype.setPropertyOrDefault = function (colDef, propName, defaultValue) {
- var self = this;
- // Use the column definition filter if we were passed it
- if (typeof(colDef[propName]) !== 'undefined' && colDef[propName]) {
- self[propName] = colDef[propName];
- }
- // Otherwise use our own if it's set
- else if (typeof(self[propName]) !== 'undefined') {
- self[propName] = self[propName];
- }
- // Default to empty object for the filter
- else {
- self[propName] = defaultValue ? defaultValue : {};
- }
- };
- /**
- * @ngdoc property
- * @name width
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description sets the column width. Can be either
- * a number or a percentage, or an * for auto.
- * @example
- * <pre> $scope.gridOptions.columnDefs = [ { field: 'field1', width: 100},
- * { field: 'field2', width: '20%'},
- * { field: 'field3', width: '*' }]; </pre>
- *
- */
- /**
- * @ngdoc property
- * @name minWidth
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description Sets the minimum column width. Should be a number.
- * Defaults to gridOptions.minimumColumnSize if minWidth is not provided.
- * @example
- * <pre> $scope.gridOptions.columnDefs = [ { field: 'field1', minWidth: 100}]; </pre>
- *
- */
- /**
- * @ngdoc property
- * @name maxWidth
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description sets the maximum column width. Should be a number.
- * @example
- * <pre> $scope.gridOptions.columnDefs = [ { field: 'field1', maxWidth: 100}]; </pre>
- *
- */
- /**
- * @ngdoc property
- * @name visible
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description sets whether or not the column is visible
- * </br>Default is true
- * @example
- * <pre> $scope.gridOptions.columnDefs = [
- * { field: 'field1', visible: true},
- * { field: 'field2', visible: false }
- * ]; </pre>
- *
- */
- /**
- * @ngdoc property
- * @name sort
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description An object of sort information, attributes are:
- *
- * - direction: values are {@link ui.grid.service:uiGridConstants#properties_ASC uiGridConstants.ASC}
- * or {@link ui.grid.service:uiGridConstants#properties_DESC uiGridConstants.DESC}
- * - ignoreSort: if set to true this sort is ignored (used by tree to manipulate the sort functionality)
- * - priority: says what order to sort the columns in (lower priority gets sorted first).
- * @example
- * <pre>
- * $scope.gridOptions.columnDefs = [{
- * field: 'field1',
- * sort: {
- * direction: uiGridConstants.ASC,
- * ignoreSort: true,
- * priority: 0
- * }
- * }];
- * </pre>
- */
- /**
- * @ngdoc property
- * @name sortingAlgorithm
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description Algorithm to use for sorting this column. Takes 'a' and 'b' parameters
- * like any normal sorting function with additional 'rowA', 'rowB', and 'direction' parameters
- * that are the row objects and the current direction of the sort respectively.
- *
- */
- /**
- * @ngdoc property
- * @name defaultSort
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description An object of sort information, provides a hidden default ordering of the data
- * when no user sorts are applied, or when a user-provided sort deems two rows to be equal.
- *
- * May be combined with a regular {@link ui.grid.class:GridOptions.columnDef#properties_sort columnDef.sort}
- * to explicitly sort by that column by default.
- *
- * Shares the same object format as {@link ui.grid.class:GridOptions.columnDef#properties_sort columnDef.sort}.
- *
- * Note that a defaultSort can never take priority over an explicit sort.
- * @example
- * <pre>
- * $scope.gridOptions.columnDefs = [{
- * field: 'field1',
- * defaultSort: {
- * direction: uiGridConstants.ASC,
- * priority: 0
- * }
- * }];
- * </pre>
- */
- /**
- * @ngdoc array
- * @name filters
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description Specify multiple filter fields.
- * @example
- * <pre>$scope.gridOptions.columnDefs = [
- * {
- * field: 'field1', filters: [
- * {
- * term: 'aa',
- * condition: uiGridConstants.filter.STARTS_WITH,
- * placeholder: 'starts with...',
- * ariaLabel: 'Filter for field1',
- * flags: { caseSensitive: false },
- * type: uiGridConstants.filter.SELECT,
- * selectOptions: [ { value: 1, label: 'male' }, { value: 2, label: 'female' } ]
- * },
- * {
- * condition: uiGridConstants.filter.ENDS_WITH,
- * placeholder: 'ends with...'
- * }
- * ]
- * }
- * ]; </pre>
- *
- *
- */
- /**
- * @ngdoc array
- * @name filters
- * @propertyOf ui.grid.class:GridColumn
- * @description Filters for this column. Includes 'term' property bound to filter input elements.
- * @example
- * <pre>[
- * {
- * term: 'foo', // ngModel for <input>
- * condition: uiGridConstants.filter.STARTS_WITH,
- * placeholder: 'starts with...',
- * ariaLabel: 'Filter for foo',
- * flags: { caseSensitive: false },
- * type: uiGridConstants.filter.SELECT,
- * selectOptions: [ { value: 1, label: 'male' }, { value: 2, label: 'female' } ]
- * },
- * {
- * term: 'baz',
- * condition: uiGridConstants.filter.ENDS_WITH,
- * placeholder: 'ends with...'
- * }
- * ] </pre>
- *
- *
- */
- /**
- * @ngdoc array
- * @name menuItems
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description used to add menu items to a column. Refer to the tutorial on this
- * functionality. A number of settings are supported:
- *
- * - title: controls the title that is displayed in the menu
- * - icon: the icon shown alongside that title
- * - action: the method to call when the menu is clicked
- * - shown: a function to evaluate to determine whether or not to show the item
- * - active: a function to evaluate to determine whether or not the item is currently selected
- * - context: context to pass to the action function, available in this.context in your handler
- * - leaveOpen: if set to true, the menu should stay open after the action, defaults to false
- * @example
- * <pre> $scope.gridOptions.columnDefs = [
- * { field: 'field1', menuItems: [
- * {
- * title: 'Outer Scope Alert',
- * icon: 'ui-grid-icon-info-circled',
- * action: function($event) {
- * this.context.blargh(); // $scope.blargh() would work too, this is just an example
- * },
- * shown: function() { return true; },
- * active: function() { return true; },
- * context: $scope
- * },
- * {
- * title: 'Grid ID',
- * action: function() {
- * alert('Grid ID: ' + this.grid.id);
- * }
- * }
- * ] }]; </pre>
- *
- */
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:GridColumn
- * @name updateColumnDef
- * @description Moves settings from the columnDef down onto the column,
- * and sets properties as appropriate
- * @param {ColumnDef} colDef the column def to look in for the property value
- * @param {boolean} isNew whether the column is being newly created, if not
- * we're updating an existing column, and some items such as the sort shouldn't
- * be copied down
- */
- GridColumn.prototype.updateColumnDef = function(colDef, isNew) {
- var self = this;
- self.colDef = colDef;
- if (colDef.name === undefined) {
- throw new Error('colDef.name is required for column at index ' + self.grid.options.columnDefs.indexOf(colDef));
- }
- self.displayName = (colDef.displayName === undefined) ? gridUtil.readableColumnName(colDef.name) : colDef.displayName;
- if (!angular.isNumber(self.width) || !self.hasCustomWidth || colDef.allowCustomWidthOverride) {
- var colDefWidth = colDef.width;
- var parseErrorMsg = "Cannot parse column width '" + colDefWidth + "' for column named '" + colDef.name + "'";
- self.hasCustomWidth = false;
- if (!angular.isString(colDefWidth) && !angular.isNumber(colDefWidth)) {
- self.width = '*';
- } else if (angular.isString(colDefWidth)) {
- // See if it ends with a percent
- if (gridUtil.endsWith(colDefWidth, '%')) {
- // If so we should be able to parse the non-percent-sign part to a number
- var percentStr = colDefWidth.replace(/%/g, '');
- var percent = parseInt(percentStr, 10);
- if (isNaN(percent)) {
- throw new Error(parseErrorMsg);
- }
- self.width = colDefWidth;
- }
- // And see if it's a number string
- else if (colDefWidth.match(/^(\d+)$/)) {
- self.width = parseInt(colDefWidth.match(/^(\d+)$/)[1], 10);
- }
- // Otherwise it should be a string of asterisks
- else if (colDefWidth.match(/^\*+$/)) {
- self.width = colDefWidth;
- }
- // No idea, throw an Error
- else {
- throw new Error(parseErrorMsg);
- }
- }
- // Is a number, use it as the width
- else {
- self.width = colDefWidth;
- }
- }
- function isValidWidthValue(value) {
- return angular.isString(value) || angular.isNumber(value);
- }
- ['minWidth', 'maxWidth'].forEach(function (name) {
- var minOrMaxWidth = colDef[name];
- var parseErrorMsg = "Cannot parse column " + name + " '" + minOrMaxWidth + "' for column named '" + colDef.name + "'";
- // default minWidth to the minimumColumnSize
- if (name === 'minWidth' && !isValidWidthValue(minOrMaxWidth) && angular.isDefined(self.grid.options.minimumColumnSize)) {
- minOrMaxWidth = self.grid.options.minimumColumnSize;
- }
- if (!isValidWidthValue(minOrMaxWidth)) {
- // Sets default minWidth and maxWidth values
- self[name] = ((name === 'minWidth') ? 30 : 9000);
- } else if (angular.isString(minOrMaxWidth)) {
- if (minOrMaxWidth.match(/^(\d+)$/)) {
- self[name] = parseInt(minOrMaxWidth.match(/^(\d+)$/)[1], 10);
- } else {
- throw new Error(parseErrorMsg);
- }
- } else {
- self[name] = minOrMaxWidth;
- }
- });
- //use field if it is defined; name if it is not
- self.field = (colDef.field === undefined) ? colDef.name : colDef.field;
- if ( typeof( self.field ) !== 'string' ){
- gridUtil.logError( 'Field is not a string, this is likely to break the code, Field is: ' + self.field );
- }
- self.name = colDef.name;
- // Use colDef.displayName as long as it's not undefined, otherwise default to the field name
- self.displayName = (colDef.displayName === undefined) ? gridUtil.readableColumnName(colDef.name) : colDef.displayName;
- //self.originalIndex = index;
- self.aggregationType = angular.isDefined(colDef.aggregationType) ? colDef.aggregationType : null;
- self.footerCellTemplate = angular.isDefined(colDef.footerCellTemplate) ? colDef.footerCellTemplate : null;
- /**
- * @ngdoc property
- * @name cellTooltip
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description Whether or not to show a tooltip when a user hovers over the cell.
- * If set to false, no tooltip. If true, the cell value is shown in the tooltip (useful
- * if you have long values in your cells), if a function then that function is called
- * passing in the row and the col `cellTooltip( row, col )`, and the return value is shown in the tooltip,
- * if it is a static string then displays that static string.
- *
- * Defaults to false
- *
- */
- if ( typeof(colDef.cellTooltip) === 'undefined' || colDef.cellTooltip === false ) {
- self.cellTooltip = false;
- } else if ( colDef.cellTooltip === true ){
- self.cellTooltip = function(row, col) {
- return self.grid.getCellValue( row, col );
- };
- } else if (typeof(colDef.cellTooltip) === 'function' ){
- self.cellTooltip = colDef.cellTooltip;
- } else {
- self.cellTooltip = function ( row, col ){
- return col.colDef.cellTooltip;
- };
- }
- /**
- * @ngdoc property
- * @name headerTooltip
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description Whether or not to show a tooltip when a user hovers over the header cell.
- * If set to false, no tooltip. If true, the displayName is shown in the tooltip (useful
- * if you have long values in your headers), if a function then that function is called
- * passing in the row and the col `headerTooltip( col )`, and the return value is shown in the tooltip,
- * if a static string then shows that static string.
- *
- * Defaults to false
- *
- */
- if ( typeof(colDef.headerTooltip) === 'undefined' || colDef.headerTooltip === false ) {
- self.headerTooltip = false;
- } else if ( colDef.headerTooltip === true ){
- self.headerTooltip = function(col) {
- return col.displayName;
- };
- } else if (typeof(colDef.headerTooltip) === 'function' ){
- self.headerTooltip = colDef.headerTooltip;
- } else {
- self.headerTooltip = function ( col ) {
- return col.colDef.headerTooltip;
- };
- }
- /**
- * @ngdoc property
- * @name footerCellClass
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description footerCellClass can be a string specifying the class to append to a cell
- * or it can be a function(grid, row, col, rowRenderIndex, colRenderIndex) that returns a class name
- *
- */
- self.footerCellClass = colDef.footerCellClass;
- /**
- * @ngdoc property
- * @name cellClass
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description cellClass can be a string specifying the class to append to a cell
- * or it can be a function(grid, row, col, rowRenderIndex, colRenderIndex) that returns a class name
- *
- */
- self.cellClass = colDef.cellClass;
- /**
- * @ngdoc property
- * @name headerCellClass
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description headerCellClass can be a string specifying the class to append to a cell
- * or it can be a function(grid, row, col, rowRenderIndex, colRenderIndex) that returns a class name
- *
- */
- self.headerCellClass = colDef.headerCellClass;
- /**
- * @ngdoc property
- * @name cellFilter
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description cellFilter is a filter to apply to the content of each cell
- * @example
- * <pre>
- * gridOptions.columnDefs[0].cellFilter = 'date'
- *
- */
- self.cellFilter = colDef.cellFilter ? colDef.cellFilter : "";
- /**
- * @ngdoc boolean
- * @name sortCellFiltered
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description (optional) False by default. When `true` uiGrid will apply the cellFilter before
- * sorting the data. Note that when using this option uiGrid will assume that the displayed value is
- * a string, and use the {@link ui.grid.class:RowSorter#sortAlpha sortAlpha} `sortFn`. It is possible
- * to return a non-string value from an angularjs filter, in which case you should define a {@link ui.grid.class:GridOptions.columnDef#sortingAlgorithm sortingAlgorithm}
- * for the column which hanldes the returned type. You may specify one of the `sortingAlgorithms`
- * found in the {@link ui.grid.RowSorter rowSorter} service.
- */
- self.sortCellFiltered = colDef.sortCellFiltered ? true : false;
- /**
- * @ngdoc boolean
- * @name filterCellFiltered
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description (optional) False by default. When `true` uiGrid will apply the cellFilter before
- * applying "search" `filters`.
- */
- self.filterCellFiltered = colDef.filterCellFiltered ? true : false;
- /**
- * @ngdoc property
- * @name headerCellFilter
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description headerCellFilter is a filter to apply to the content of the column header
- * @example
- * <pre>
- * gridOptions.columnDefs[0].headerCellFilter = 'translate'
- *
- */
- self.headerCellFilter = colDef.headerCellFilter ? colDef.headerCellFilter : "";
- /**
- * @ngdoc property
- * @name footerCellFilter
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description footerCellFilter is a filter to apply to the content of the column footer
- * @example
- * <pre>
- * gridOptions.columnDefs[0].footerCellFilter = 'date'
- *
- */
- self.footerCellFilter = colDef.footerCellFilter ? colDef.footerCellFilter : "";
- self.visible = gridUtil.isNullOrUndefined(colDef.visible) || colDef.visible;
- self.headerClass = colDef.headerClass;
- //self.cursor = self.sortable ? 'pointer' : 'default';
- // Turn on sorting by default
- self.enableSorting = typeof(colDef.enableSorting) !== 'undefined' ? colDef.enableSorting : self.grid.options.enableSorting;
- self.sortingAlgorithm = colDef.sortingAlgorithm;
- /**
- * @ngdoc property
- * @name sortDirectionCycle
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description (optional) An array of {@link ui.grid.service:uiGridConstants#properties_ASC sort directions},
- * specifying the order that they should cycle through as the user repeatedly clicks on the column heading.
- * The default is `[null, uiGridConstants.ASC, uiGridConstants.DESC]`. Null
- * refers to the unsorted state. This does not affect the initial sort
- * direction; use the {@link ui.grid.class:GridOptions.columnDef#sort sort}
- * property for that. If
- * {@link ui.grid.class:GridOptions.columnDef#suppressRemoveSort suppressRemoveSort}
- * is also set, the unsorted state will be skipped even if it is listed here.
- * Each direction may not appear in the list more than once (e.g. `[ASC,
- * DESC, DESC]` is not allowed), and the list may not be empty.
- */
- self.sortDirectionCycle = typeof(colDef.sortDirectionCycle) !== 'undefined' ?
- colDef.sortDirectionCycle :
- [null, uiGridConstants.ASC, uiGridConstants.DESC];
- /**
- * @ngdoc boolean
- * @name suppressRemoveSort
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description (optional) False by default. When enabled, this setting hides the removeSort option
- * in the menu, and prevents users from manually removing the sort
- */
- if ( typeof(self.suppressRemoveSort) === 'undefined'){
- self.suppressRemoveSort = typeof(colDef.suppressRemoveSort) !== 'undefined' ? colDef.suppressRemoveSort : false;
- }
- /**
- * @ngdoc property
- * @name enableFiltering
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description turn off filtering for an individual column, where
- * you've turned on filtering for the overall grid
- * @example
- * <pre>
- * gridOptions.columnDefs[0].enableFiltering = false;
- *
- */
- // Turn on filtering by default (it's disabled by default at the Grid level)
- self.enableFiltering = typeof(colDef.enableFiltering) !== 'undefined' ? colDef.enableFiltering : true;
- // self.menuItems = colDef.menuItems;
- self.setPropertyOrDefault(colDef, 'menuItems', []);
- // Use the column definition sort if we were passed it, but only if this is a newly added column
- if ( isNew ){
- self.setPropertyOrDefault(colDef, 'sort');
- }
- // Use the column definition defaultSort always, unlike normal sort
- self.setPropertyOrDefault(colDef, 'defaultSort');
- // Set up default filters array for when one is not provided.
- // In other words, this (in column def):
- //
- // filter: { term: 'something', flags: {}, condition: [CONDITION] }
- //
- // is just shorthand for this:
- //
- // filters: [{ term: 'something', flags: {}, condition: [CONDITION] }]
- //
- var defaultFilters = [];
- if (colDef.filter) {
- defaultFilters.push(colDef.filter);
- }
- else if ( colDef.filters ){
- defaultFilters = colDef.filters;
- } else {
- // Add an empty filter definition object, which will
- // translate to a guessed condition and no pre-populated
- // value for the filter <input>.
- defaultFilters.push({});
- }
- /**
- * @ngdoc property
- * @name filter
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description Specify a single filter field on this column.
- *
- * A filter consists of a condition, a term, and a placeholder:
- *
- * - condition defines how rows are chosen as matching the filter term. This can be set to
- * one of the constants in {@link ui.grid.service:uiGridConstants#properties_filter uiGridConstants.filter},
- * or you can supply a custom filter function
- * that gets passed the following arguments: [searchTerm, cellValue, row, column].
- * - term: If set, the filter field will be pre-populated
- * with this value.
- * - placeholder: String that will be set to the `<input>.placeholder` attribute.
- * - ariaLabel: String that will be set to the `<input>.ariaLabel` attribute. This is what is read as a label to screen reader users.
- * - noTerm: set this to true if you have defined a custom function in condition, and
- * your custom function doesn't require a term (so it can run even when the term is null)
- * - rawTerm: set this to true if you have defined a custom function in condition, and
- * your custom function requires access to the raw unmodified search term that was entered
- * - flags: only flag currently available is `caseSensitive`, set to false if you don't want
- * case sensitive matching
- * - type: defaults to {@link ui.grid.service:uiGridConstants#properties_filter uiGridConstants.filter.INPUT},
- * which gives a text box. If set to {@link ui.grid.service:uiGridConstants#properties_filter uiGridConstants.filter.SELECT}
- * then a select box will be shown with options selectOptions
- * - selectOptions: options in the format `[ { value: 1, label: 'male' }]`. No i18n filter is provided, you need
- * to perform the i18n on the values before you provide them
- * - disableCancelFilterButton: defaults to false. If set to true then the 'x' button that cancels/clears the filter
- * will not be shown.
- * @example
- * <pre>$scope.gridOptions.columnDefs = [
- * {
- * field: 'field1',
- * filter: {
- * term: 'xx',
- * condition: uiGridConstants.filter.STARTS_WITH,
- * placeholder: 'starts with...',
- * ariaLabel: 'Starts with filter for field1',
- * flags: { caseSensitive: false },
- * type: uiGridConstants.filter.SELECT,
- * selectOptions: [ { value: 1, label: 'male' }, { value: 2, label: 'female' } ],
- * disableCancelFilterButton: true
- * }
- * }
- * ]; </pre>
- *
- */
- /*
- /*
- self.filters = [
- {
- term: 'search term'
- condition: uiGridConstants.filter.CONTAINS,
- placeholder: 'my placeholder',
- ariaLabel: 'Starts with filter for field1',
- flags: {
- caseSensitive: true
- }
- }
- ]
- */
- // Only set filter if this is a newly added column, if we're updating an existing
- // column then we don't want to put the default filter back if the user may have already
- // removed it.
- // However, we do want to keep the settings if they change, just not the term
- if ( isNew ) {
- self.setPropertyOrDefault(colDef, 'filter');
- self.setPropertyOrDefault(colDef, 'extraStyle');
- self.setPropertyOrDefault(colDef, 'filters', defaultFilters);
- } else if ( self.filters.length === defaultFilters.length ) {
- self.filters.forEach( function( filter, index ){
- if (typeof(defaultFilters[index].placeholder) !== 'undefined') {
- filter.placeholder = defaultFilters[index].placeholder;
- }
- if (typeof(defaultFilters[index].ariaLabel) !== 'undefined') {
- filter.ariaLabel = defaultFilters[index].ariaLabel;
- }
- if (typeof(defaultFilters[index].flags) !== 'undefined') {
- filter.flags = defaultFilters[index].flags;
- }
- if (typeof(defaultFilters[index].type) !== 'undefined') {
- filter.type = defaultFilters[index].type;
- }
- if (typeof(defaultFilters[index].selectOptions) !== 'undefined') {
- filter.selectOptions = defaultFilters[index].selectOptions;
- }
- });
- }
- };
- /**
- * @ngdoc function
- * @name unsort
- * @methodOf ui.grid.class:GridColumn
- * @description Removes column from the grid sorting
- */
- GridColumn.prototype.unsort = function () {
- //Decrease priority for every col where priority is higher than the removed sort's priority.
- var thisPriority = this.sort.priority;
- this.grid.columns.forEach(function (col) {
- if (col.sort && col.sort.priority !== undefined && col.sort.priority > thisPriority) {
- col.sort.priority -= 1;
- }
- });
- this.sort = {};
- this.grid.api.core.raise.sortChanged( this.grid, this.grid.getColumnSorting() );
- };
- /**
- * @ngdoc function
- * @name getColClass
- * @methodOf ui.grid.class:GridColumn
- * @description Returns the class name for the column
- * @param {bool} prefixDot if true, will return .className instead of className
- */
- GridColumn.prototype.getColClass = function (prefixDot) {
- var cls = uiGridConstants.COL_CLASS_PREFIX + this.uid;
- return prefixDot ? '.' + cls : cls;
- };
- /**
- * @ngdoc function
- * @name isPinnedLeft
- * @methodOf ui.grid.class:GridColumn
- * @description Returns true if column is in the left render container
- */
- GridColumn.prototype.isPinnedLeft = function () {
- return this.renderContainer === 'left';
- };
- /**
- * @ngdoc function
- * @name isPinnedRight
- * @methodOf ui.grid.class:GridColumn
- * @description Returns true if column is in the right render container
- */
- GridColumn.prototype.isPinnedRight = function () {
- return this.renderContainer === 'right';
- };
- /**
- * @ngdoc function
- * @name getColClassDefinition
- * @methodOf ui.grid.class:GridColumn
- * @description Returns the class definition for th column
- */
- GridColumn.prototype.getColClassDefinition = function () {
- return ' .grid' + this.grid.id + ' ' + this.getColClass(true) + ' { min-width: ' + this.drawnWidth + 'px; max-width: ' + this.drawnWidth + 'px; }';
- };
- /**
- * @ngdoc function
- * @name getRenderContainer
- * @methodOf ui.grid.class:GridColumn
- * @description Returns the render container object that this column belongs to.
- *
- * Columns will be default be in the `body` render container if they aren't allocated to one specifically.
- */
- GridColumn.prototype.getRenderContainer = function getRenderContainer() {
- var self = this;
- var containerId = self.renderContainer;
- if (containerId === null || containerId === '' || containerId === undefined) {
- containerId = 'body';
- }
- return self.grid.renderContainers[containerId];
- };
- /**
- * @ngdoc function
- * @name showColumn
- * @methodOf ui.grid.class:GridColumn
- * @description Makes the column visible by setting colDef.visible = true
- */
- GridColumn.prototype.showColumn = function() {
- this.colDef.visible = true;
- };
- /**
- * @ngdoc property
- * @name aggregationHideLabel
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description defaults to false, if set to true hides the label text
- * in the aggregation footer, so only the value is displayed.
- *
- */
- /**
- * @ngdoc function
- * @name getAggregationText
- * @methodOf ui.grid.class:GridColumn
- * @description Gets the aggregation label from colDef.aggregationLabel if
- * specified or by using i18n, including deciding whether or not to display
- * based on colDef.aggregationHideLabel.
- *
- * @param {string} label the i18n lookup value to use for the column label
- *
- */
- GridColumn.prototype.getAggregationText = function () {
- var self = this;
- if ( self.colDef.aggregationHideLabel ){
- return '';
- }
- else if ( self.colDef.aggregationLabel ) {
- return self.colDef.aggregationLabel;
- }
- else {
- switch ( self.colDef.aggregationType ){
- case uiGridConstants.aggregationTypes.count:
- return i18nService.getSafeText('aggregation.count');
- case uiGridConstants.aggregationTypes.sum:
- return i18nService.getSafeText('aggregation.sum');
- case uiGridConstants.aggregationTypes.avg:
- return i18nService.getSafeText('aggregation.avg');
- case uiGridConstants.aggregationTypes.min:
- return i18nService.getSafeText('aggregation.min');
- case uiGridConstants.aggregationTypes.max:
- return i18nService.getSafeText('aggregation.max');
- default:
- return '';
- }
- }
- };
- GridColumn.prototype.getCellTemplate = function () {
- var self = this;
- return self.cellTemplatePromise;
- };
- GridColumn.prototype.getCompiledElementFn = function () {
- var self = this;
- return self.compiledElementFnDefer.promise;
- };
- return GridColumn;
- }]);
- })();
- (function(){
- angular.module('ui.grid')
- .factory('GridOptions', ['gridUtil','uiGridConstants', function(gridUtil,uiGridConstants) {
- /**
- * @ngdoc function
- * @name ui.grid.class:GridOptions
- * @description Default GridOptions class. GridOptions are defined by the application developer and overlaid
- * over this object. Setting gridOptions within your controller is the most common method for an application
- * developer to configure the behaviour of their ui-grid
- *
- * @example To define your gridOptions within your controller:
- * <pre>$scope.gridOptions = {
- * data: $scope.myData,
- * columnDefs: [
- * { name: 'field1', displayName: 'pretty display name' },
- * { name: 'field2', visible: false }
- * ]
- * };</pre>
- *
- * You can then use this within your html template, when you define your grid:
- * <pre><div ui-grid="gridOptions"></div></pre>
- *
- * To provide default options for all of the grids within your application, use an angular
- * decorator to modify the GridOptions factory.
- * <pre>
- * app.config(function($provide){
- * $provide.decorator('GridOptions',function($delegate){
- * var gridOptions;
- * gridOptions = angular.copy($delegate);
- * gridOptions.initialize = function(options) {
- * var initOptions;
- * initOptions = $delegate.initialize(options);
- * initOptions.enableColumnMenus = false;
- * return initOptions;
- * };
- * return gridOptions;
- * });
- * });
- * </pre>
- */
- return {
- initialize: function( baseOptions ){
- /**
- * @ngdoc function
- * @name onRegisterApi
- * @propertyOf ui.grid.class:GridOptions
- * @description A callback that returns the gridApi once the grid is instantiated, which is
- * then used to interact with the grid programatically.
- *
- * Note that the gridApi.core.renderingComplete event is identical to this
- * callback, but has the advantage that it can be called from multiple places
- * if needed
- *
- * @example
- * <pre>
- * $scope.gridOptions.onRegisterApi = function ( gridApi ) {
- * $scope.gridApi = gridApi;
- * $scope.gridApi.selection.selectAllRows( $scope.gridApi.grid );
- * };
- * </pre>
- *
- */
- baseOptions.onRegisterApi = baseOptions.onRegisterApi || angular.noop();
- /**
- * @ngdoc object
- * @name data
- * @propertyOf ui.grid.class:GridOptions
- * @description (mandatory) Array of data to be rendered into the grid, providing the data source or data binding for
- * the grid.
- *
- * Most commonly the data is an array of objects, where each object has a number of attributes.
- * Each attribute automatically becomes a column in your grid. This array could, for example, be sourced from
- * an angularJS $resource query request. The array can also contain complex objects, refer the binding tutorial
- * for examples of that.
- *
- * The most flexible usage is to set your data on $scope:
- *
- * `$scope.data = data;`
- *
- * And then direct the grid to resolve whatever is in $scope.data:
- *
- * `$scope.gridOptions.data = 'data';`
- *
- * This is the most flexible approach as it allows you to replace $scope.data whenever you feel like it without
- * getting pointer issues.
- *
- * Alternatively you can directly set the data array:
- *
- * `$scope.gridOptions.data = [ ];`
- * or
- *
- * `$http.get('/data/100.json')
- * .success(function(data) {
- * $scope.myData = data;
- * $scope.gridOptions.data = $scope.myData;
- * });`
- *
- * Where you do this, you need to take care in updating the data - you can't just update `$scope.myData` to some other
- * array, you need to update $scope.gridOptions.data to point to that new array as well.
- *
- */
- baseOptions.data = baseOptions.data || [];
- /**
- * @ngdoc array
- * @name columnDefs
- * @propertyOf ui.grid.class:GridOptions
- * @description Array of columnDef objects. Only required property is name.
- * The individual options available in columnDefs are documented in the
- * {@link ui.grid.class:GridOptions.columnDef columnDef} section
- * </br>_field property can be used in place of name for backwards compatibility with 2.x_
- * @example
- *
- * <pre>var columnDefs = [{name:'field1'}, {name:'field2'}];</pre>
- *
- */
- baseOptions.columnDefs = baseOptions.columnDefs || [];
- /**
- * @ngdoc object
- * @name ui.grid.class:GridOptions.columnDef
- * @description Definition / configuration of an individual column, which would typically be
- * one of many column definitions within the gridOptions.columnDefs array
- * @example
- * <pre>{name:'field1', field: 'field1', filter: { term: 'xxx' }}</pre>
- *
- */
- /**
- * @ngdoc object
- * @name enableGridMenu
- * @propertyOf ui.grid.class:GridOptions
- * @description Takes a boolean that adds a settings icon in the top right of the grid, which floats above
- * the column header, when true. The menu by default gives access to show/hide columns, but can be
- * customised to show additional actions.
- *
- * See the {@link #!/tutorial/121_grid_menu Grid Menu tutorial} for more detailed information.
- */
- /**
- * @ngdoc array
- * @name excludeProperties
- * @propertyOf ui.grid.class:GridOptions
- * @description Array of property names in data to ignore when auto-generating column names. Provides the
- * inverse of columnDefs - columnDefs is a list of columns to include, excludeProperties is a list of columns
- * to exclude.
- *
- * If columnDefs is defined, this will be ignored.
- *
- * Defaults to ['$$hashKey']
- */
- baseOptions.excludeProperties = baseOptions.excludeProperties || ['$$hashKey'];
- /**
- * @ngdoc boolean
- * @name enableRowHashing
- * @propertyOf ui.grid.class:GridOptions
- * @description True by default. When enabled, this setting allows uiGrid to add
- * `$$hashKey`-type properties (similar to Angular) to elements in the `data` array. This allows
- * the grid to maintain state while vastly speeding up the process of altering `data` by adding/moving/removing rows.
- *
- * Note that this DOES add properties to your data that you may not want, but they are stripped out when using `angular.toJson()`. IF
- * you do not want this at all you can disable this setting but you will take a performance hit if you are using large numbers of rows
- * and are altering the data set often.
- */
- baseOptions.enableRowHashing = baseOptions.enableRowHashing !== false;
- /**
- * @ngdoc function
- * @name rowIdentity
- * @methodOf ui.grid.class:GridOptions
- * @description This function is used to get and, if necessary, set the value uniquely identifying this row (i.e. if an identity is not present it will set one).
- *
- * By default it returns the `$$hashKey` property if it exists. If it doesn't it uses gridUtil.nextUid() to generate one
- */
- baseOptions.rowIdentity = baseOptions.rowIdentity || function rowIdentity(row) {
- return gridUtil.hashKey(row);
- };
- /**
- * @ngdoc function
- * @name getRowIdentity
- * @methodOf ui.grid.class:GridOptions
- * @description This function returns the identity value uniquely identifying this row, if one is not present it does not set it.
- *
- * By default it returns the `$$hashKey` property but can be overridden to use any property or set of properties you want.
- */
- baseOptions.getRowIdentity = baseOptions.getRowIdentity || function getRowIdentity(row) {
- return row.$$hashKey;
- };
- /**
- * @ngdoc property
- * @name flatEntityAccess
- * @propertyOf ui.grid.class:GridOptions
- * @description Set to true if your columns are all related directly to fields in a flat object structure - i.e.
- * each of your columns associate directly with a property on each of the entities in your data array.
- *
- * In that situation we can avoid all the logic associated with complex binding to functions or to properties of sub-objects,
- * which can provide a significant speed improvement with large data sets when filtering or sorting.
- *
- * By default false
- */
- baseOptions.flatEntityAccess = baseOptions.flatEntityAccess === true;
- /**
- * @ngdoc property
- * @name showHeader
- * @propertyOf ui.grid.class:GridOptions
- * @description True by default. When set to false, this setting will replace the
- * standard header template with '<div></div>', resulting in no header being shown.
- */
- baseOptions.showHeader = typeof(baseOptions.showHeader) !== "undefined" ? baseOptions.showHeader : true;
- /* (NOTE): Don't show this in the docs. We only use it internally
- * @ngdoc property
- * @name headerRowHeight
- * @propertyOf ui.grid.class:GridOptions
- * @description The height of the header in pixels, defaults to 30
- *
- */
- if (!baseOptions.showHeader) {
- baseOptions.headerRowHeight = 0;
- }
- else {
- baseOptions.headerRowHeight = typeof(baseOptions.headerRowHeight) !== "undefined" ? baseOptions.headerRowHeight : 30;
- }
- /**
- * @ngdoc property
- * @name rowHeight
- * @propertyOf ui.grid.class:GridOptions
- * @description The height of the row in pixels, Can be passed as integer or string. defaults to 30.
- *
- */
- if (typeof baseOptions.rowHeight === "string") {
- baseOptions.rowHeight = parseInt(baseOptions.rowHeight) || 30;
- }
- else {
- baseOptions.rowHeight = baseOptions.rowHeight || 30;
- }
- /**
- * @ngdoc integer
- * @name minRowsToShow
- * @propertyOf ui.grid.class:GridOptions
- * @description Minimum number of rows to show when the grid doesn't have a defined height. Defaults to "10".
- */
- baseOptions.minRowsToShow = typeof(baseOptions.minRowsToShow) !== "undefined" ? baseOptions.minRowsToShow : 10;
- /**
- * @ngdoc property
- * @name showGridFooter
- * @propertyOf ui.grid.class:GridOptions
- * @description Whether or not to show the footer, defaults to false
- * The footer display Total Rows and Visible Rows (filtered rows)
- */
- baseOptions.showGridFooter = baseOptions.showGridFooter === true;
- /**
- * @ngdoc property
- * @name showColumnFooter
- * @propertyOf ui.grid.class:GridOptions
- * @description Whether or not to show the column footer, defaults to false
- * The column footer displays column aggregates
- */
- baseOptions.showColumnFooter = baseOptions.showColumnFooter === true;
- /**
- * @ngdoc property
- * @name columnFooterHeight
- * @propertyOf ui.grid.class:GridOptions
- * @description The height of the footer rows (column footer and grid footer) in pixels
- *
- */
- baseOptions.columnFooterHeight = typeof(baseOptions.columnFooterHeight) !== "undefined" ? baseOptions.columnFooterHeight : 30;
- baseOptions.gridFooterHeight = typeof(baseOptions.gridFooterHeight) !== "undefined" ? baseOptions.gridFooterHeight : 30;
- baseOptions.columnWidth = typeof(baseOptions.columnWidth) !== "undefined" ? baseOptions.columnWidth : 50;
- /**
- * @ngdoc property
- * @name maxVisibleColumnCount
- * @propertyOf ui.grid.class:GridOptions
- * @description Defaults to 200
- *
- */
- baseOptions.maxVisibleColumnCount = typeof(baseOptions.maxVisibleColumnCount) !== "undefined" ? baseOptions.maxVisibleColumnCount : 200;
- /**
- * @ngdoc property
- * @name virtualizationThreshold
- * @propertyOf ui.grid.class:GridOptions
- * @description Turn virtualization on when number of data elements goes over this number, defaults to 20
- */
- baseOptions.virtualizationThreshold = typeof(baseOptions.virtualizationThreshold) !== "undefined" ? baseOptions.virtualizationThreshold : 20;
- /**
- * @ngdoc property
- * @name columnVirtualizationThreshold
- * @propertyOf ui.grid.class:GridOptions
- * @description Turn virtualization on when number of columns goes over this number, defaults to 10
- */
- baseOptions.columnVirtualizationThreshold = typeof(baseOptions.columnVirtualizationThreshold) !== "undefined" ? baseOptions.columnVirtualizationThreshold : 10;
- /**
- * @ngdoc property
- * @name excessRows
- * @propertyOf ui.grid.class:GridOptions
- * @description Extra rows to to render outside of the viewport, which helps with smoothness of scrolling.
- * Defaults to 4
- */
- baseOptions.excessRows = typeof(baseOptions.excessRows) !== "undefined" ? baseOptions.excessRows : 4;
- /**
- * @ngdoc property
- * @name scrollThreshold
- * @propertyOf ui.grid.class:GridOptions
- * @description Defaults to 4
- */
- baseOptions.scrollThreshold = typeof(baseOptions.scrollThreshold) !== "undefined" ? baseOptions.scrollThreshold : 4;
- /**
- * @ngdoc property
- * @name excessColumns
- * @propertyOf ui.grid.class:GridOptions
- * @description Extra columns to to render outside of the viewport, which helps with smoothness of scrolling.
- * Defaults to 4
- */
- baseOptions.excessColumns = typeof(baseOptions.excessColumns) !== "undefined" ? baseOptions.excessColumns : 4;
- /**
- * @ngdoc property
- * @name horizontalScrollThreshold
- * @propertyOf ui.grid.class:GridOptions
- * @description Defaults to 4
- */
- baseOptions.horizontalScrollThreshold = typeof(baseOptions.horizontalScrollThreshold) !== "undefined" ? baseOptions.horizontalScrollThreshold : 2;
- /**
- * @ngdoc property
- * @name aggregationCalcThrottle
- * @propertyOf ui.grid.class:GridOptions
- * @description Default time in milliseconds to throttle aggregation calcuations, defaults to 500ms
- */
- baseOptions.aggregationCalcThrottle = typeof(baseOptions.aggregationCalcThrottle) !== "undefined" ? baseOptions.aggregationCalcThrottle : 500;
- /**
- * @ngdoc property
- * @name wheelScrollThrottle
- * @propertyOf ui.grid.class:GridOptions
- * @description Default time in milliseconds to throttle scroll events to, defaults to 70ms
- */
- baseOptions.wheelScrollThrottle = typeof(baseOptions.wheelScrollThrottle) !== "undefined" ? baseOptions.wheelScrollThrottle : 70;
- /**
- * @ngdoc property
- * @name scrollDebounce
- * @propertyOf ui.grid.class:GridOptions
- * @description Default time in milliseconds to debounce scroll events, defaults to 300ms
- */
- baseOptions.scrollDebounce = typeof(baseOptions.scrollDebounce) !== "undefined" ? baseOptions.scrollDebounce : 300;
- /**
- * @ngdoc boolean
- * @name enableSorting
- * @propertyOf ui.grid.class:GridOptions
- * @description True by default. When enabled, this setting adds sort
- * widgets to the column headers, allowing sorting of the data for the entire grid.
- * Sorting can then be disabled / enabled on individual columns using the columnDefs,
- * if it set, it will override GridOptions enableSorting setting.
- */
- baseOptions.enableSorting = baseOptions.enableSorting !== false;
- /**
- * @ngdoc boolean
- * @name enableFiltering
- * @propertyOf ui.grid.class:GridOptions
- * @description False by default. When enabled, this setting adds filter
- * boxes to each column header, allowing filtering within the column for the entire grid.
- * Filtering can then be disabled on individual columns using the columnDefs.
- */
- baseOptions.enableFiltering = baseOptions.enableFiltering === true;
- /**
- * @ngdoc boolean
- * @name enableColumnMenus
- * @propertyOf ui.grid.class:GridOptions
- * @description True by default. When enabled, this setting displays a column
- * menu within each column.
- * By default column menu's trigger is hidden before mouse over, but you can always force it to be visible with CSS:
- *
- * <pre>
- * .ui-grid-column-menu-button {
- * display: block;
- * }
- * </pre>
- */
- baseOptions.enableColumnMenus = baseOptions.enableColumnMenus !== false;
- /**
- * @ngdoc boolean
- * @name enableVerticalScrollbar
- * @propertyOf ui.grid.class:GridOptions
- * @description {@link ui.grid.service:uiGridConstants#properties_scrollbars uiGridConstants.scrollbars.ALWAYS} by default.
- * This settings controls the vertical scrollbar for the grid.
- * Supported values: uiGridConstants.scrollbars.ALWAYS, uiGridConstants.scrollbars.NEVER, uiGridConstants.scrollbars.WHEN_NEEDED
- */
- baseOptions.enableVerticalScrollbar = typeof(baseOptions.enableVerticalScrollbar) !== "undefined" ? baseOptions.enableVerticalScrollbar : uiGridConstants.scrollbars.ALWAYS;
- /**
- * @ngdoc boolean
- * @name enableHorizontalScrollbar
- * @propertyOf ui.grid.class:GridOptions
- * @description {@link ui.grid.service:uiGridConstants#properties_scrollbars uiGridConstants.scrollbars.ALWAYS} by default.
- * This settings controls the horizontal scrollbar for the grid.
- * Supported values: uiGridConstants.scrollbars.ALWAYS, uiGridConstants.scrollbars.NEVER, uiGridConstants.scrollbars.WHEN_NEEDED
- */
- baseOptions.enableHorizontalScrollbar = typeof(baseOptions.enableHorizontalScrollbar) !== "undefined" ? baseOptions.enableHorizontalScrollbar : uiGridConstants.scrollbars.ALWAYS;
- /**
- * @ngdoc boolean
- * @name enableMinHeightCheck
- * @propertyOf ui.grid.class:GridOptions
- * @description True by default. When enabled, a newly initialized grid will check to see if it is tall enough to display
- * at least one row of data. If the grid is not tall enough, it will resize the DOM element to display minRowsToShow number
- * of rows.
- */
- baseOptions.enableMinHeightCheck = baseOptions.enableMinHeightCheck !== false;
- /**
- * @ngdoc boolean
- * @name minimumColumnSize
- * @propertyOf ui.grid.class:GridOptions
- * @description Sets the default minimum column width, in other words,
- * it defines the default value for a column minWidth attribute if that is not otherwise specified.
- * Should be a number. Defaults to 30 pixels.
- */
- baseOptions.minimumColumnSize = typeof(baseOptions.minimumColumnSize) !== "undefined" ? baseOptions.minimumColumnSize : 30;
- /**
- * @ngdoc function
- * @name rowEquality
- * @methodOf ui.grid.class:GridOptions
- * @description By default, rows are compared using object equality. This option can be overridden
- * to compare on any data item property or function
- * @param {object} entityA First Data Item to compare
- * @param {object} entityB Second Data Item to compare
- */
- baseOptions.rowEquality = baseOptions.rowEquality || function(entityA, entityB) {
- return entityA === entityB;
- };
- /**
- * @ngdoc string
- * @name headerTemplate
- * @propertyOf ui.grid.class:GridOptions
- * @description Null by default. When provided, this setting uses a custom header
- * template, rather than the default template. Can be set to either the name of a template file:
- * <pre> $scope.gridOptions.headerTemplate = 'header_template.html';</pre>
- * inline html
- * <pre> $scope.gridOptions.headerTemplate = '<div class="ui-grid-top-panel" style="text-align: center">I am a Custom Grid Header</div>'</pre>
- * or the id of a precompiled template (TBD how to use this).
- * </br>Refer to the custom header tutorial for more information.
- * If you want no header at all, you can set to an empty div:
- * <pre> $scope.gridOptions.headerTemplate = '<div></div>';</pre>
- *
- * If you want to only have a static header, then you can set to static content. If
- * you want to tailor the existing column headers, then you should look at the
- * current 'ui-grid-header.html' template in github as your starting point.
- *
- */
- baseOptions.headerTemplate = baseOptions.headerTemplate || null;
- /**
- * @ngdoc string
- * @name footerTemplate
- * @propertyOf ui.grid.class:GridOptions
- * @description (optional) ui-grid/ui-grid-footer by default. This footer shows the per-column
- * aggregation totals.
- * When provided, this setting uses a custom footer template. Can be set to either the name of a template file 'footer_template.html', inline html
- * <pre>'<div class="ui-grid-bottom-panel" style="text-align: center">I am a Custom Grid Footer</div>'</pre>, or the id
- * of a precompiled template (TBD how to use this). Refer to the custom footer tutorial for more information.
- */
- baseOptions.footerTemplate = baseOptions.footerTemplate || 'ui-grid/ui-grid-footer';
- /**
- * @ngdoc string
- * @name gridFooterTemplate
- * @propertyOf ui.grid.class:GridOptions
- * @description (optional) ui-grid/ui-grid-grid-footer by default. This template by default shows the
- * total items at the bottom of the grid, and the selected items if selection is enabled.
- */
- baseOptions.gridFooterTemplate = baseOptions.gridFooterTemplate || 'ui-grid/ui-grid-grid-footer';
- /**
- * @ngdoc string
- * @name rowTemplate
- * @propertyOf ui.grid.class:GridOptions
- * @description 'ui-grid/ui-grid-row' by default. When provided, this setting uses a
- * custom row template. Can be set to either the name of a template file:
- * <pre> $scope.gridOptions.rowTemplate = 'row_template.html';</pre>
- * inline html
- * <pre> $scope.gridOptions.rowTemplate = '<div style="background-color: aquamarine" ng-click="grid.appScope.fnOne(row)" ng-repeat="col in colContainer.renderedColumns track by col.colDef.name" class="ui-grid-cell" ui-grid-cell></div>';</pre>
- * or the id of a precompiled template (TBD how to use this) can be provided.
- * </br>Refer to the custom row template tutorial for more information.
- */
- baseOptions.rowTemplate = baseOptions.rowTemplate || 'ui-grid/ui-grid-row';
- /**
- * @ngdoc string
- * @name gridMenuTemplate
- * @propertyOf ui.grid.class:GridOptions
- * @description 'ui-grid/uiGridMenu' by default. When provided, this setting uses a
- * custom grid menu template.
- */
- baseOptions.gridMenuTemplate = baseOptions.gridMenuTemplate || 'ui-grid/uiGridMenu';
- /**
- * @ngdoc object
- * @name appScopeProvider
- * @propertyOf ui.grid.class:GridOptions
- * @description by default, the parent scope of the ui-grid element will be assigned to grid.appScope
- * this property allows you to assign any reference you want to grid.appScope
- */
- baseOptions.appScopeProvider = baseOptions.appScopeProvider || null;
- return baseOptions;
- }
- };
- }]);
- })();
- (function(){
- angular.module('ui.grid')
- /**
- * @ngdoc function
- * @name ui.grid.class:GridRenderContainer
- * @description The grid has render containers, allowing the ability to have pinned columns. If the grid
- * is right-to-left then there may be a right render container, if left-to-right then there may
- * be a left render container. There is always a body render container.
- * @param {string} name The name of the render container ('body', 'left', or 'right')
- * @param {Grid} grid the grid the render container is in
- * @param {object} options the render container options
- */
- .factory('GridRenderContainer', ['gridUtil', 'uiGridConstants', function(gridUtil, uiGridConstants) {
- function GridRenderContainer(name, grid, options) {
- var self = this;
- // if (gridUtil.type(grid) !== 'Grid') {
- // throw new Error('Grid argument is not a Grid object');
- // }
- self.name = name;
- self.grid = grid;
- // self.rowCache = [];
- // self.columnCache = [];
- self.visibleRowCache = [];
- self.visibleColumnCache = [];
- self.renderedRows = [];
- self.renderedColumns = [];
- self.prevScrollTop = 0;
- self.prevScrolltopPercentage = 0;
- self.prevRowScrollIndex = 0;
- self.prevScrollLeft = 0;
- self.prevScrollleftPercentage = 0;
- self.prevColumnScrollIndex = 0;
- self.columnStyles = '';
- self.viewportAdjusters = [];
- /**
- * @ngdoc boolean
- * @name hasHScrollbar
- * @propertyOf ui.grid.class:GridRenderContainer
- * @description flag to signal that container has a horizontal scrollbar
- */
- self.hasHScrollbar = false;
- /**
- * @ngdoc boolean
- * @name hasVScrollbar
- * @propertyOf ui.grid.class:GridRenderContainer
- * @description flag to signal that container has a vertical scrollbar
- */
- self.hasVScrollbar = false;
- /**
- * @ngdoc boolean
- * @name canvasHeightShouldUpdate
- * @propertyOf ui.grid.class:GridRenderContainer
- * @description flag to signal that container should recalculate the canvas size
- */
- self.canvasHeightShouldUpdate = true;
- /**
- * @ngdoc boolean
- * @name canvasHeight
- * @propertyOf ui.grid.class:GridRenderContainer
- * @description last calculated canvas height value
- */
- self.$$canvasHeight = 0;
- if (options && angular.isObject(options)) {
- angular.extend(self, options);
- }
- grid.registerStyleComputation({
- priority: 5,
- func: function () {
- self.updateColumnWidths();
- return self.columnStyles;
- }
- });
- }
- GridRenderContainer.prototype.reset = function reset() {
- // this.rowCache.length = 0;
- // this.columnCache.length = 0;
- this.visibleColumnCache.length = 0;
- this.visibleRowCache.length = 0;
- this.renderedRows.length = 0;
- this.renderedColumns.length = 0;
- };
- // TODO(c0bra): calculate size?? Should this be in a stackable directive?
- GridRenderContainer.prototype.containsColumn = function (col) {
- return this.visibleColumnCache.indexOf(col) !== -1;
- };
- GridRenderContainer.prototype.minRowsToRender = function minRowsToRender() {
- var self = this;
- var minRows = 0;
- var rowAddedHeight = 0;
- var viewPortHeight = self.getViewportHeight();
- for (var i = self.visibleRowCache.length - 1; rowAddedHeight < viewPortHeight && i >= 0; i--) {
- rowAddedHeight += self.visibleRowCache[i].height;
- minRows++;
- }
- return minRows;
- };
- GridRenderContainer.prototype.minColumnsToRender = function minColumnsToRender() {
- var self = this;
- var viewportWidth = this.getViewportWidth();
- var min = 0;
- var totalWidth = 0;
- for (var i = 0; i < self.visibleColumnCache.length; i++) {
- var col = self.visibleColumnCache[i];
- if (totalWidth < viewportWidth) {
- totalWidth += col.drawnWidth ? col.drawnWidth : 0;
- min++;
- }
- else {
- var currWidth = 0;
- for (var j = i; j >= i - min; j--) {
- currWidth += self.visibleColumnCache[j].drawnWidth ? self.visibleColumnCache[j].drawnWidth : 0;
- }
- if (currWidth < viewportWidth) {
- min++;
- }
- }
- }
- return min;
- };
- GridRenderContainer.prototype.getVisibleRowCount = function getVisibleRowCount() {
- return this.visibleRowCache.length;
- };
- /**
- * @ngdoc function
- * @name registerViewportAdjuster
- * @methodOf ui.grid.class:GridRenderContainer
- * @description Registers an adjuster to the render container's available width or height. Adjusters are used
- * to tell the render container that there is something else consuming space, and to adjust it's size
- * appropriately.
- * @param {function} func the adjuster function we want to register
- */
- GridRenderContainer.prototype.registerViewportAdjuster = function registerViewportAdjuster(func) {
- this.viewportAdjusters.push(func);
- };
- /**
- * @ngdoc function
- * @name removeViewportAdjuster
- * @methodOf ui.grid.class:GridRenderContainer
- * @description Removes an adjuster, should be used when your element is destroyed
- * @param {function} func the adjuster function we want to remove
- */
- GridRenderContainer.prototype.removeViewportAdjuster = function removeViewportAdjuster(func) {
- var idx = this.viewportAdjusters.indexOf(func);
- if (idx > -1) {
- this.viewportAdjusters.splice(idx, 1);
- }
- };
- /**
- * @ngdoc function
- * @name getViewportAdjustment
- * @methodOf ui.grid.class:GridRenderContainer
- * @description Gets the adjustment based on the viewportAdjusters.
- * @returns {object} a hash of { height: x, width: y }. Usually the values will be negative
- */
- GridRenderContainer.prototype.getViewportAdjustment = function getViewportAdjustment() {
- var self = this;
- var adjustment = { height: 0, width: 0 };
- self.viewportAdjusters.forEach(function (func) {
- adjustment = func.call(this, adjustment);
- });
- return adjustment;
- };
- GridRenderContainer.prototype.getMargin = function getMargin(side) {
- var self = this;
- var amount = 0;
- self.viewportAdjusters.forEach(function (func) {
- var adjustment = func.call(this, { height: 0, width: 0 });
- if (adjustment.side && adjustment.side === side) {
- amount += adjustment.width * -1;
- }
- });
- return amount;
- };
- GridRenderContainer.prototype.getViewportHeight = function getViewportHeight() {
- var self = this;
- var headerHeight = (self.headerHeight) ? self.headerHeight : self.grid.headerHeight;
- var viewPortHeight = self.grid.gridHeight - headerHeight - self.grid.footerHeight;
- var adjustment = self.getViewportAdjustment();
- viewPortHeight = viewPortHeight + adjustment.height;
- return viewPortHeight;
- };
- GridRenderContainer.prototype.getViewportWidth = function getViewportWidth() {
- var self = this;
- var viewportWidth = self.grid.gridWidth;
- //if (typeof(self.grid.verticalScrollbarWidth) !== 'undefined' && self.grid.verticalScrollbarWidth !== undefined && self.grid.verticalScrollbarWidth > 0) {
- // viewPortWidth = viewPortWidth - self.grid.verticalScrollbarWidth;
- //}
- // var viewportWidth = 0;\
- // self.visibleColumnCache.forEach(function (column) {
- // viewportWidth += column.drawnWidth;
- // });
- var adjustment = self.getViewportAdjustment();
- viewportWidth = viewportWidth + adjustment.width;
- return viewportWidth;
- };
- GridRenderContainer.prototype.getHeaderViewportWidth = function getHeaderViewportWidth() {
- var self = this;
- var viewportWidth = this.getViewportWidth();
- //if (typeof(self.grid.verticalScrollbarWidth) !== 'undefined' && self.grid.verticalScrollbarWidth !== undefined && self.grid.verticalScrollbarWidth > 0) {
- // viewPortWidth = viewPortWidth + self.grid.verticalScrollbarWidth;
- //}
- // var adjustment = self.getViewportAdjustment();
- // viewPortWidth = viewPortWidth + adjustment.width;
- return viewportWidth;
- };
- /**
- * @ngdoc function
- * @name getCanvasHeight
- * @methodOf ui.grid.class:GridRenderContainer
- * @description Returns the total canvas height. Only recalculates if canvasHeightShouldUpdate = false
- * @returns {number} total height of all the visible rows in the container
- */
- GridRenderContainer.prototype.getCanvasHeight = function getCanvasHeight() {
- var self = this;
- if (!self.canvasHeightShouldUpdate) {
- return self.$$canvasHeight;
- }
- var oldCanvasHeight = self.$$canvasHeight;
- self.$$canvasHeight = 0;
- self.visibleRowCache.forEach(function(row){
- self.$$canvasHeight += row.height;
- });
- self.canvasHeightShouldUpdate = false;
- self.grid.api.core.raise.canvasHeightChanged(oldCanvasHeight, self.$$canvasHeight);
- return self.$$canvasHeight;
- };
- GridRenderContainer.prototype.getVerticalScrollLength = function getVerticalScrollLength() {
- return this.getCanvasHeight() - this.getViewportHeight() + this.grid.scrollbarHeight !== 0 ? this.getCanvasHeight() - this.getViewportHeight() + this.grid.scrollbarHeight : -1;
- };
- GridRenderContainer.prototype.getHorizontalScrollLength = function getHorizontalScrollLength() {
- return this.getCanvasWidth() - this.getViewportWidth() + this.grid.scrollbarWidth !== 0 ? this.getCanvasWidth() - this.getViewportWidth() + this.grid.scrollbarWidth : -1;
- };
- GridRenderContainer.prototype.getCanvasWidth = function getCanvasWidth() {
- var self = this;
- return self.canvasWidth;
- };
- GridRenderContainer.prototype.setRenderedRows = function setRenderedRows(newRows) {
- this.renderedRows.length = newRows.length;
- for (var i = 0; i < newRows.length; i++) {
- this.renderedRows[i] = newRows[i];
- }
- };
- GridRenderContainer.prototype.setRenderedColumns = function setRenderedColumns(newColumns) {
- var self = this;
- // OLD:
- this.renderedColumns.length = newColumns.length;
- for (var i = 0; i < newColumns.length; i++) {
- this.renderedColumns[i] = newColumns[i];
- }
- this.updateColumnOffset();
- };
- GridRenderContainer.prototype.updateColumnOffset = function updateColumnOffset() {
- // Calculate the width of the columns on the left side that are no longer rendered.
- // That will be the offset for the columns as we scroll horizontally.
- var hiddenColumnsWidth = 0;
- for (var i = 0; i < this.currentFirstColumn; i++) {
- hiddenColumnsWidth += this.visibleColumnCache[i].drawnWidth;
- }
- this.columnOffset = hiddenColumnsWidth;
- };
- GridRenderContainer.prototype.scrollVertical = function (newScrollTop) {
- var vertScrollPercentage = -1;
- if (newScrollTop !== this.prevScrollTop) {
- var yDiff = newScrollTop - this.prevScrollTop;
- if (yDiff > 0 ) { this.grid.scrollDirection = uiGridConstants.scrollDirection.DOWN; }
- if (yDiff < 0 ) { this.grid.scrollDirection = uiGridConstants.scrollDirection.UP; }
- var vertScrollLength = this.getVerticalScrollLength();
- vertScrollPercentage = newScrollTop / vertScrollLength;
- // console.log('vert', vertScrollPercentage, newScrollTop, vertScrollLength);
- if (vertScrollPercentage > 1) { vertScrollPercentage = 1; }
- if (vertScrollPercentage < 0) { vertScrollPercentage = 0; }
- this.adjustScrollVertical(newScrollTop, vertScrollPercentage);
- return vertScrollPercentage;
- }
- };
- GridRenderContainer.prototype.scrollHorizontal = function(newScrollLeft){
- var horizScrollPercentage = -1;
- // Handle RTL here
- if (newScrollLeft !== this.prevScrollLeft) {
- var xDiff = newScrollLeft - this.prevScrollLeft;
- if (xDiff > 0) { this.grid.scrollDirection = uiGridConstants.scrollDirection.RIGHT; }
- if (xDiff < 0) { this.grid.scrollDirection = uiGridConstants.scrollDirection.LEFT; }
- var horizScrollLength = this.getHorizontalScrollLength();
- if (horizScrollLength !== 0) {
- horizScrollPercentage = newScrollLeft / horizScrollLength;
- }
- else {
- horizScrollPercentage = 0;
- }
- this.adjustScrollHorizontal(newScrollLeft, horizScrollPercentage);
- return horizScrollPercentage;
- }
- };
- GridRenderContainer.prototype.adjustScrollVertical = function adjustScrollVertical(scrollTop, scrollPercentage, force) {
- if (this.prevScrollTop === scrollTop && !force) {
- return;
- }
- if (typeof(scrollTop) === 'undefined' || scrollTop === undefined || scrollTop === null) {
- scrollTop = (this.getCanvasHeight() - this.getViewportHeight()) * scrollPercentage;
- }
- this.adjustRows(scrollTop, scrollPercentage, false);
- this.prevScrollTop = scrollTop;
- this.prevScrolltopPercentage = scrollPercentage;
- this.grid.queueRefresh();
- };
- GridRenderContainer.prototype.adjustScrollHorizontal = function adjustScrollHorizontal(scrollLeft, scrollPercentage, force) {
- if (this.prevScrollLeft === scrollLeft && !force) {
- return;
- }
- if (typeof(scrollLeft) === 'undefined' || scrollLeft === undefined || scrollLeft === null) {
- scrollLeft = (this.getCanvasWidth() - this.getViewportWidth()) * scrollPercentage;
- }
- this.adjustColumns(scrollLeft, scrollPercentage);
- this.prevScrollLeft = scrollLeft;
- this.prevScrollleftPercentage = scrollPercentage;
- this.grid.queueRefresh();
- };
- GridRenderContainer.prototype.adjustRows = function adjustRows(scrollTop, scrollPercentage, postDataLoaded) {
- var self = this;
- var minRows = self.minRowsToRender();
- var rowCache = self.visibleRowCache;
- var maxRowIndex = rowCache.length - minRows;
- // console.log('scroll%1', scrollPercentage);
- // Calculate the scroll percentage according to the scrollTop location, if no percentage was provided
- if ((typeof(scrollPercentage) === 'undefined' || scrollPercentage === null) && scrollTop) {
- scrollPercentage = scrollTop / self.getVerticalScrollLength();
- }
- var rowIndex = Math.ceil(Math.min(maxRowIndex, maxRowIndex * scrollPercentage));
- // console.log('maxRowIndex / scroll%', maxRowIndex, scrollPercentage, rowIndex);
- // Define a max row index that we can't scroll past
- if (rowIndex > maxRowIndex) {
- rowIndex = maxRowIndex;
- }
- var newRange = [];
- if (rowCache.length > self.grid.options.virtualizationThreshold) {
- if (!(typeof(scrollTop) === 'undefined' || scrollTop === null)) {
- // Have we hit the threshold going down?
- if ( !self.grid.suppressParentScrollDown && self.prevScrollTop < scrollTop && rowIndex < self.prevRowScrollIndex + self.grid.options.scrollThreshold && rowIndex < maxRowIndex) {
- return;
- }
- //Have we hit the threshold going up?
- if ( !self.grid.suppressParentScrollUp && self.prevScrollTop > scrollTop && rowIndex > self.prevRowScrollIndex - self.grid.options.scrollThreshold && rowIndex < maxRowIndex) {
- return;
- }
- }
- var rangeStart = Math.max(0, rowIndex - self.grid.options.excessRows);
- var rangeEnd = Math.min(rowCache.length, rowIndex + minRows + self.grid.options.excessRows);
- newRange = [rangeStart, rangeEnd];
- }
- else {
- var maxLen = self.visibleRowCache.length;
- newRange = [0, Math.max(maxLen, minRows + self.grid.options.excessRows)];
- }
- self.updateViewableRowRange(newRange);
- self.prevRowScrollIndex = rowIndex;
- };
- GridRenderContainer.prototype.adjustColumns = function adjustColumns(scrollLeft, scrollPercentage) {
- var self = this;
- var minCols = self.minColumnsToRender();
- var columnCache = self.visibleColumnCache;
- var maxColumnIndex = columnCache.length - minCols;
- // Calculate the scroll percentage according to the scrollLeft location, if no percentage was provided
- if ((typeof(scrollPercentage) === 'undefined' || scrollPercentage === null) && scrollLeft) {
- scrollPercentage = scrollLeft / self.getHorizontalScrollLength();
- }
- var colIndex = Math.ceil(Math.min(maxColumnIndex, maxColumnIndex * scrollPercentage));
- // Define a max row index that we can't scroll past
- if (colIndex > maxColumnIndex) {
- colIndex = maxColumnIndex;
- }
- var newRange = [];
- if (columnCache.length > self.grid.options.columnVirtualizationThreshold && self.getCanvasWidth() > self.getViewportWidth()) {
- /* Commented the following lines because otherwise the moved column wasn't visible immediately on the new position
- * in the case of many columns with horizontal scroll, one had to scroll left or right and then return in order to see it
- // Have we hit the threshold going down?
- if (self.prevScrollLeft < scrollLeft && colIndex < self.prevColumnScrollIndex + self.grid.options.horizontalScrollThreshold && colIndex < maxColumnIndex) {
- return;
- }
- //Have we hit the threshold going up?
- if (self.prevScrollLeft > scrollLeft && colIndex > self.prevColumnScrollIndex - self.grid.options.horizontalScrollThreshold && colIndex < maxColumnIndex) {
- return;
- }*/
- var rangeStart = Math.max(0, colIndex - self.grid.options.excessColumns);
- var rangeEnd = Math.min(columnCache.length, colIndex + minCols + self.grid.options.excessColumns);
- newRange = [rangeStart, rangeEnd];
- }
- else {
- var maxLen = self.visibleColumnCache.length;
- newRange = [0, Math.max(maxLen, minCols + self.grid.options.excessColumns)];
- }
- self.updateViewableColumnRange(newRange);
- self.prevColumnScrollIndex = colIndex;
- };
- // Method for updating the visible rows
- GridRenderContainer.prototype.updateViewableRowRange = function updateViewableRowRange(renderedRange) {
- // Slice out the range of rows from the data
- // var rowArr = uiGridCtrl.grid.rows.slice(renderedRange[0], renderedRange[1]);
- var rowArr = this.visibleRowCache.slice(renderedRange[0], renderedRange[1]);
- // Define the top-most rendered row
- this.currentTopRow = renderedRange[0];
- this.setRenderedRows(rowArr);
- };
- // Method for updating the visible columns
- GridRenderContainer.prototype.updateViewableColumnRange = function updateViewableColumnRange(renderedRange) {
- // Slice out the range of rows from the data
- // var columnArr = uiGridCtrl.grid.columns.slice(renderedRange[0], renderedRange[1]);
- var columnArr = this.visibleColumnCache.slice(renderedRange[0], renderedRange[1]);
- // Define the left-most rendered columns
- this.currentFirstColumn = renderedRange[0];
- this.setRenderedColumns(columnArr);
- };
- GridRenderContainer.prototype.headerCellWrapperStyle = function () {
- var self = this;
- if (self.currentFirstColumn !== 0) {
- var offset = self.columnOffset;
- if (self.grid.isRTL()) {
- return { 'margin-right': offset + 'px' };
- }
- else {
- return { 'margin-left': offset + 'px' };
- }
- }
- return null;
- };
- /**
- * @ngdoc boolean
- * @name updateColumnWidths
- * @propertyOf ui.grid.class:GridRenderContainer
- * @description Determine the appropriate column width of each column across all render containers.
- *
- * Column width is easy when each column has a specified width. When columns are variable width (i.e.
- * have an * or % of the viewport) then we try to calculate so that things fit in. The problem is that
- * we have multiple render containers, and we don't want one render container to just take the whole viewport
- * when it doesn't need to - we want things to balance out across the render containers.
- *
- * To do this, we use this method to calculate all the renderContainers, recognising that in a given render
- * cycle it'll get called once per render container, so it needs to return the same values each time.
- *
- * The constraints on this method are therefore:
- * - must return the same value when called multiple times, to do this it needs to rely on properties of the
- * columns, but not properties that change when this is called (so it shouldn't rely on drawnWidth)
- *
- * The general logic of this method is:
- * - calculate our total available width
- * - look at all the columns across all render containers, and work out which have widths and which have
- * constraints such as % or * or something else
- * - for those with *, count the total number of * we see and add it onto a running total, add this column to an * array
- * - for those with a %, allocate the % as a percentage of the viewport, having consideration of min and max
- * - for those with manual width (in pixels) we set the drawnWidth to the specified width
- * - we end up with an asterisks array still to process
- * - we look at our remaining width. If it's greater than zero, we divide it up among the asterisk columns, then process
- * them for min and max width constraints
- * - if it's zero or less, we set the asterisk columns to their minimum widths
- * - we use parseInt quite a bit, as we try to make all our column widths integers
- */
- GridRenderContainer.prototype.updateColumnWidths = function () {
- var self = this;
- var asterisksArray = [],
- asteriskNum = 0,
- usedWidthSum = 0,
- ret = '',
- pinRightColumn = false,
- fixedNumberArray = [],
- percentageArray = [],
- totalPercentage = 0;
- // Get the width of the viewport
- var availableWidth = self.grid.getViewportWidth() - self.grid.scrollbarWidth;
- // get all the columns across all render containers, we have to calculate them all or one render container
- // could consume the whole viewport
- var columnCache = [];
- angular.forEach(self.grid.renderContainers, function (container) {
- columnCache = columnCache.concat(container.visibleColumnCache);
- });
- // look at each column, process any manual values or %, put the * into an array to look at later
- columnCache.forEach(function (column) {
- var width = 0;
- // Skip hidden columns
- if (!column.visible) { return; }
- if (pinRightColumn) {
- availableWidth += self.grid.scrollbarWidth;
- }
- if (!pinRightColumn && column.colDef.pinnedRight) {
- pinRightColumn = true;
- }
- if (angular.isNumber(column.width)) {
- // pixel width, set to this value
- width = parseInt(column.width, 10);
- usedWidthSum = usedWidthSum + width;
- column.drawnWidth = width;
- fixedNumberArray.push(column);
- } else if (gridUtil.endsWith(column.width, '%')) {
- // percentage width, set to percentage of the viewport
- // round down to int - some browsers don't play nice with float maxWidth
- var percentageIntegerValue = parseInt(column.width.replace(/%/g, ''), 10);
- width = parseInt(percentageIntegerValue / 100 * availableWidth);
- if (width > column.maxWidth) {
- width = column.maxWidth;
- }
- if (width < column.minWidth) {
- width = column.minWidth;
- }
- usedWidthSum = usedWidthSum + width;
- column.drawnWidth = width;
- totalPercentage = totalPercentage + percentageIntegerValue;
- percentageArray.push(column);
- } else if (angular.isString(column.width) && column.width.indexOf('*') !== -1) {
- // is an asterisk column, the gridColumn already checked the string consists only of '****'
- asteriskNum = asteriskNum + column.width.length;
- asterisksArray.push(column);
- }
- });
- // Get the remaining width (available width subtracted by the used widths sum)
- var remainingWidth = availableWidth - usedWidthSum;
- if (asterisksArray.length > 0) {
- // the width that each asterisk value would be assigned (this can be negative)
- var asteriskVal = remainingWidth / asteriskNum;
- asterisksArray.forEach(function (column) {
- var width = parseInt(column.width.length * asteriskVal, 10);
- if (width > column.maxWidth) {
- width = column.maxWidth;
- }
- if (width < column.minWidth) {
- width = column.minWidth;
- }
- usedWidthSum = usedWidthSum + width;
- column.drawnWidth = width;
- });
- }
- // If there are no columns with asterisk widths then check if there are any with % widths and
- // use them as a fallback for adjusting column widths up or down if we have remaining grid width
- // or need to claw some width back
- var variableWidthColumnArray;
- if (asterisksArray.length > 0) {
- variableWidthColumnArray = asterisksArray;
- } else if (percentageArray.length > 0 && fixedNumberArray.length === 0 && totalPercentage === 100) {
- variableWidthColumnArray = percentageArray;
- }
- if (!angular.isUndefined(variableWidthColumnArray)) {
- // If the grid width didn't divide evenly into the column widths and we have pixels left over, or our
- // calculated widths would have the grid narrower than the available space,
- // dole the remainder out one by one to make everything fit
- var processColumnUpwards = function (column) {
- if (column.drawnWidth < column.maxWidth && leftoverWidth > 0) {
- column.drawnWidth++;
- usedWidthSum++;
- leftoverWidth--;
- columnsToChange = true;
- }
- };
- var leftoverWidth = availableWidth - usedWidthSum;
- var columnsToChange = true;
- while (leftoverWidth > 0 && columnsToChange) {
- columnsToChange = false;
- variableWidthColumnArray.forEach(processColumnUpwards);
- }
- // We can end up with too much width even though some columns aren't at their max width, in this situation
- // we can trim the columns a little
- var processColumnDownwards = function (column) {
- if (column.drawnWidth > column.minWidth && excessWidth > 0) {
- column.drawnWidth--;
- usedWidthSum--;
- excessWidth--;
- columnsToChange = true;
- }
- };
- var excessWidth = usedWidthSum - availableWidth;
- columnsToChange = true;
- while (excessWidth > 0 && columnsToChange) {
- columnsToChange = false;
- variableWidthColumnArray.forEach(processColumnDownwards);
- }
- }
- // all that was across all the renderContainers, now we need to work out what that calculation decided for
- // our renderContainer
- var canvasWidth = 0;
- self.visibleColumnCache.forEach(function(column){
- if ( column.visible ){
- canvasWidth = canvasWidth + column.drawnWidth;
- }
- });
- // Build the CSS
- columnCache.forEach(function (column) {
- ret = ret + column.getColClassDefinition();
- });
- self.canvasWidth = canvasWidth;
- // Return the styles back to buildStyles which pops them into the `customStyles` scope variable
- // return ret;
- // Set this render container's column styles so they can be used in style computation
- this.columnStyles = ret;
- };
- GridRenderContainer.prototype.needsHScrollbarPlaceholder = function () {
- var self = this,
- containerBody;
- if (self.name === 'left' || self.name === 'right' && !this.hasHScrollbar && !this.grid.disableScrolling) {
- if (self.grid.options.enableHorizontalScrollbar === uiGridConstants.scrollbars.ALWAYS) {
- return true;
- }
- containerBody = this.grid.element[0].querySelector('.ui-grid-render-container-body .ui-grid-viewport');
- return containerBody.scrollWidth > containerBody.offsetWidth;
- }
- return false;
- };
- GridRenderContainer.prototype.getViewportStyle = function () {
- var self = this;
- var styles = {};
- var scrollbarVisibility = {};
- scrollbarVisibility[uiGridConstants.scrollbars.ALWAYS] = 'scroll';
- scrollbarVisibility[uiGridConstants.scrollbars.WHEN_NEEDED] = 'auto';
- self.hasHScrollbar = false;
- self.hasVScrollbar = false;
- if (self.grid.disableScrolling) {
- styles['overflow-x'] = 'hidden';
- styles['overflow-y'] = 'hidden';
- return styles;
- }
- if (self.name === 'body') {
- self.hasHScrollbar = self.grid.options.enableHorizontalScrollbar !== uiGridConstants.scrollbars.NEVER;
- if (!self.grid.isRTL()) {
- if (!self.grid.hasRightContainerColumns()) {
- self.hasVScrollbar = self.grid.options.enableVerticalScrollbar !== uiGridConstants.scrollbars.NEVER;
- }
- }
- else {
- if (!self.grid.hasLeftContainerColumns()) {
- self.hasVScrollbar = self.grid.options.enableVerticalScrollbar !== uiGridConstants.scrollbars.NEVER;
- }
- }
- }
- else if (self.name === 'left') {
- self.hasVScrollbar = self.grid.isRTL() ? self.grid.options.enableVerticalScrollbar !== uiGridConstants.scrollbars.NEVER : false;
- }
- else {
- self.hasVScrollbar = !self.grid.isRTL() ? self.grid.options.enableVerticalScrollbar !== uiGridConstants.scrollbars.NEVER : false;
- }
- styles['overflow-x'] = self.hasHScrollbar ? scrollbarVisibility[self.grid.options.enableHorizontalScrollbar] : 'hidden';
- styles['overflow-y'] = self.hasVScrollbar ? scrollbarVisibility[self.grid.options.enableVerticalScrollbar] : 'hidden';
- return styles;
- };
- return GridRenderContainer;
- }]);
- })();
- (function(){
- angular.module('ui.grid')
- .factory('GridRow', ['gridUtil', 'uiGridConstants', function(gridUtil, uiGridConstants) {
- /**
- * @class GridRow
- * @ngdoc function
- * @name ui.grid.class:GridRow
- * @description GridRow is the viewModel for one logical row on the grid. A grid Row is not necessarily a one-to-one
- * relation to gridOptions.data.
- * @param {object} entity the array item from GridOptions.data
- * @param {number} index the current position of the row in the array
- * @param {Grid} grid reference to the parent grid
- */
- function GridRow(entity, index, grid) {
- /**
- * @ngdoc object
- * @name grid
- * @propertyOf ui.grid.class:GridRow
- * @description A reference back to the grid
- */
- this.grid = grid;
- /**
- * @ngdoc object
- * @name entity
- * @propertyOf ui.grid.class:GridRow
- * @description A reference to an item in gridOptions.data[]
- */
- this.entity = entity;
- /**
- * @ngdoc object
- * @name uid
- * @propertyOf ui.grid.class:GridRow
- * @description UniqueId of row
- */
- this.uid = gridUtil.nextUid();
- /**
- * @ngdoc object
- * @name visible
- * @propertyOf ui.grid.class:GridRow
- * @description If true, the row will be rendered
- */
- // Default to true
- this.visible = true;
- /**
- * @ngdoc object
- * @name isSelected
- * @propertyOf ui.grid.class:GridRow
- * @description Marks if the row has been selected
- */
- // Default to false
- this.isSelected = false;
- this.$$height = grid.options.rowHeight;
- }
- /**
- * @ngdoc object
- * @name height
- * @propertyOf ui.grid.class:GridRow
- * @description height of each individual row. changing the height will flag all
- * row renderContainers to recalculate their canvas height
- */
- Object.defineProperty(GridRow.prototype, 'height', {
- get: function() {
- return this.$$height;
- },
- set: function(height) {
- if (height !== this.$$height) {
- this.grid.updateCanvasHeight();
- this.$$height = height;
- }
- }
- });
- /**
- * @ngdoc function
- * @name getQualifiedColField
- * @methodOf ui.grid.class:GridRow
- * @description returns the qualified field name as it exists on scope
- * ie: row.entity.fieldA
- * @param {GridColumn} col column instance
- * @returns {string} resulting name that can be evaluated on scope
- */
- GridRow.prototype.getQualifiedColField = function(col) {
- return 'row.' + this.getEntityQualifiedColField(col);
- };
- /**
- * @ngdoc function
- * @name getEntityQualifiedColField
- * @methodOf ui.grid.class:GridRow
- * @description returns the qualified field name minus the row path
- * ie: entity.fieldA
- * @param {GridColumn} col column instance
- * @returns {string} resulting name that can be evaluated against a row
- */
- GridRow.prototype.getEntityQualifiedColField = function(col) {
- var base = 'entity';
- if ( col.field === uiGridConstants.ENTITY_BINDING ) {
- return base;
- }
- return gridUtil.preEval(base + '.' + col.field);
- };
- /**
- * @ngdoc function
- * @name setRowInvisible
- * @methodOf ui.grid.class:GridRow
- * @description Sets an override on the row that forces it to always
- * be invisible. Emits the rowsVisibleChanged event if it changed the row visibility.
- *
- * This method can be called from the api, passing in the gridRow we want
- * altered. It should really work by calling gridRow.setRowInvisible, but that's
- * not the way I coded it, and too late to change now. Changed to just call
- * the internal function row.setThisRowInvisible().
- *
- * @param {GridRow} row the row we want to set to invisible
- *
- */
- GridRow.prototype.setRowInvisible = function ( row ) {
- if (row && row.setThisRowInvisible){
- row.setThisRowInvisible( 'user' );
- }
- };
- /**
- * @ngdoc function
- * @name clearRowInvisible
- * @methodOf ui.grid.class:GridRow
- * @description Clears an override on the row that forces it to always
- * be invisible. Emits the rowsVisibleChanged event if it changed the row visibility.
- *
- * This method can be called from the api, passing in the gridRow we want
- * altered. It should really work by calling gridRow.clearRowInvisible, but that's
- * not the way I coded it, and too late to change now. Changed to just call
- * the internal function row.clearThisRowInvisible().
- *
- * @param {GridRow} row the row we want to clear the invisible flag
- *
- */
- GridRow.prototype.clearRowInvisible = function ( row ) {
- if (row && row.clearThisRowInvisible){
- row.clearThisRowInvisible( 'user' );
- }
- };
- /**
- * @ngdoc function
- * @name setThisRowInvisible
- * @methodOf ui.grid.class:GridRow
- * @description Sets an override on the row that forces it to always
- * be invisible. Emits the rowsVisibleChanged event if it changed the row visibility
- *
- * @param {string} reason the reason (usually the module) for the row to be invisible.
- * E.g. grouping, user, filter
- * @param {boolean} fromRowsProcessor whether we were called from a rowsProcessor, passed through to evaluateRowVisibility
- */
- GridRow.prototype.setThisRowInvisible = function ( reason, fromRowsProcessor ) {
- if ( !this.invisibleReason ){
- this.invisibleReason = {};
- }
- this.invisibleReason[reason] = true;
- this.evaluateRowVisibility( fromRowsProcessor);
- };
- /**
- * @ngdoc function
- * @name clearRowInvisible
- * @methodOf ui.grid.class:GridRow
- * @description Clears any override on the row visibility, returning it
- * to normal visibility calculations. Emits the rowsVisibleChanged
- * event
- *
- * @param {string} reason the reason (usually the module) for the row to be invisible.
- * E.g. grouping, user, filter
- * @param {boolean} fromRowsProcessor whether we were called from a rowsProcessor, passed through to evaluateRowVisibility
- */
- GridRow.prototype.clearThisRowInvisible = function ( reason, fromRowsProcessor ) {
- if (typeof(this.invisibleReason) !== 'undefined' ) {
- delete this.invisibleReason[reason];
- }
- this.evaluateRowVisibility( fromRowsProcessor );
- };
- /**
- * @ngdoc function
- * @name evaluateRowVisibility
- * @methodOf ui.grid.class:GridRow
- * @description Determines whether the row should be visible based on invisibleReason,
- * and if it changes the row visibility, then emits the rowsVisibleChanged event.
- *
- * Queues a grid refresh, but doesn't call it directly to avoid hitting lots of grid refreshes.
- * @param {boolean} fromRowProcessor if true, then it won't raise events or queue the refresh, the
- * row processor does that already
- */
- GridRow.prototype.evaluateRowVisibility = function ( fromRowProcessor ) {
- var newVisibility = true;
- if ( typeof(this.invisibleReason) !== 'undefined' ){
- angular.forEach(this.invisibleReason, function( value, key ){
- if ( value ){
- newVisibility = false;
- }
- });
- }
- if ( typeof(this.visible) === 'undefined' || this.visible !== newVisibility ){
- this.visible = newVisibility;
- if ( !fromRowProcessor ){
- this.grid.queueGridRefresh();
- this.grid.api.core.raise.rowsVisibleChanged(this);
- }
- }
- };
- return GridRow;
- }]);
- })();
- (function(){
- 'use strict';
- /**
- * @ngdoc object
- * @name ui.grid.class:GridRowColumn
- * @param {GridRow} row The row for this pair
- * @param {GridColumn} column The column for this pair
- * @description A row and column pair that represents the intersection of these two entities.
- * Must be instantiated as a constructor using the `new` keyword.
- */
- angular.module('ui.grid')
- .factory('GridRowColumn', ['$parse', '$filter',
- function GridRowColumnFactory($parse, $filter){
- var GridRowColumn = function GridRowColumn(row, col) {
- if ( !(this instanceof GridRowColumn)){
- throw "Using GridRowColumn as a function insead of as a constructor. Must be called with `new` keyword";
- }
- /**
- * @ngdoc object
- * @name row
- * @propertyOf ui.grid.class:GridRowColumn
- * @description {@link ui.grid.class:GridRow }
- */
- this.row = row;
- /**
- * @ngdoc object
- * @name col
- * @propertyOf ui.grid.class:GridRowColumn
- * @description {@link ui.grid.class:GridColumn }
- */
- this.col = col;
- };
- /**
- * @ngdoc function
- * @name getIntersectionValueRaw
- * @methodOf ui.grid.class:GridRowColumn
- * @description Gets the intersection of where the row and column meet.
- * @returns {String|Number|Object} The value from the grid data that this GridRowColumn points too.
- * If the column has a cellFilter this will NOT return the filtered value.
- */
- GridRowColumn.prototype.getIntersectionValueRaw = function(){
- var getter = $parse(this.row.getEntityQualifiedColField(this.col));
- var context = this.row;
- return getter(context);
- };
- return GridRowColumn;
- }
- ]);
- })();
- (function () {
- angular.module('ui.grid')
- .factory('ScrollEvent', ['gridUtil', function (gridUtil) {
- /**
- * @ngdoc function
- * @name ui.grid.class:ScrollEvent
- * @description Model for all scrollEvents
- * @param {Grid} grid that owns the scroll event
- * @param {GridRenderContainer} sourceRowContainer that owns the scroll event. Can be null
- * @param {GridRenderContainer} sourceColContainer that owns the scroll event. Can be null
- * @param {string} source the source of the event - from uiGridConstants.scrollEventSources or a string value of directive/service/factory.functionName
- */
- function ScrollEvent(grid, sourceRowContainer, sourceColContainer, source) {
- var self = this;
- if (!grid) {
- throw new Error("grid argument is required");
- }
- /**
- * @ngdoc object
- * @name grid
- * @propertyOf ui.grid.class:ScrollEvent
- * @description A reference back to the grid
- */
- self.grid = grid;
- /**
- * @ngdoc object
- * @name source
- * @propertyOf ui.grid.class:ScrollEvent
- * @description the source of the scroll event. limited to values from uiGridConstants.scrollEventSources
- */
- self.source = source;
- /**
- * @ngdoc object
- * @name noDelay
- * @propertyOf ui.grid.class:ScrollEvent
- * @description most scroll events from the mouse or trackpad require delay to operate properly
- * set to false to eliminate delay. Useful for scroll events that the grid causes, such as scrolling to make a row visible.
- */
- self.withDelay = true;
- self.sourceRowContainer = sourceRowContainer;
- self.sourceColContainer = sourceColContainer;
- self.newScrollLeft = null;
- self.newScrollTop = null;
- self.x = null;
- self.y = null;
- self.verticalScrollLength = -9999999;
- self.horizontalScrollLength = -999999;
- /**
- * @ngdoc function
- * @name fireThrottledScrollingEvent
- * @methodOf ui.grid.class:ScrollEvent
- * @description fires a throttled event using grid.api.core.raise.scrollEvent
- */
- self.fireThrottledScrollingEvent = gridUtil.throttle(function(sourceContainerId) {
- self.grid.scrollContainers(sourceContainerId, self);
- }, self.grid.options.wheelScrollThrottle, {trailing: true});
- }
- /**
- * @ngdoc function
- * @name getNewScrollLeft
- * @methodOf ui.grid.class:ScrollEvent
- * @description returns newScrollLeft property if available; calculates a new value if it isn't
- */
- ScrollEvent.prototype.getNewScrollLeft = function(colContainer, viewport){
- var self = this;
- if (!self.newScrollLeft){
- var scrollWidth = (colContainer.getCanvasWidth() - colContainer.getViewportWidth());
- var oldScrollLeft = gridUtil.normalizeScrollLeft(viewport, self.grid);
- var scrollXPercentage;
- if (typeof(self.x.percentage) !== 'undefined' && self.x.percentage !== undefined) {
- scrollXPercentage = self.x.percentage;
- }
- else if (typeof(self.x.pixels) !== 'undefined' && self.x.pixels !== undefined) {
- scrollXPercentage = self.x.percentage = (oldScrollLeft + self.x.pixels) / scrollWidth;
- }
- else {
- throw new Error("No percentage or pixel value provided for scroll event X axis");
- }
- return Math.max(0, scrollXPercentage * scrollWidth);
- }
- return self.newScrollLeft;
- };
- /**
- * @ngdoc function
- * @name getNewScrollTop
- * @methodOf ui.grid.class:ScrollEvent
- * @description returns newScrollTop property if available; calculates a new value if it isn't
- */
- ScrollEvent.prototype.getNewScrollTop = function(rowContainer, viewport){
- var self = this;
- if (!self.newScrollTop){
- var scrollLength = rowContainer.getVerticalScrollLength();
- var oldScrollTop = viewport[0].scrollTop;
- var scrollYPercentage;
- if (typeof(self.y.percentage) !== 'undefined' && self.y.percentage !== undefined) {
- scrollYPercentage = self.y.percentage;
- }
- else if (typeof(self.y.pixels) !== 'undefined' && self.y.pixels !== undefined) {
- scrollYPercentage = self.y.percentage = (oldScrollTop + self.y.pixels) / scrollLength;
- }
- else {
- throw new Error("No percentage or pixel value provided for scroll event Y axis");
- }
- return Math.max(0, scrollYPercentage * scrollLength);
- }
- return self.newScrollTop;
- };
- ScrollEvent.prototype.atTop = function(scrollTop) {
- return (this.y && (this.y.percentage === 0 || this.verticalScrollLength < 0) && scrollTop === 0);
- };
- ScrollEvent.prototype.atBottom = function(scrollTop) {
- return (this.y && (this.y.percentage === 1 || this.verticalScrollLength === 0) && scrollTop > 0);
- };
- ScrollEvent.prototype.atLeft = function(scrollLeft) {
- return (this.x && (this.x.percentage === 0 || this.horizontalScrollLength < 0) && scrollLeft === 0);
- };
- ScrollEvent.prototype.atRight = function(scrollLeft) {
- return (this.x && (this.x.percentage === 1 || this.horizontalScrollLength ===0) && scrollLeft > 0);
- };
- ScrollEvent.Sources = {
- ViewPortScroll: 'ViewPortScroll',
- RenderContainerMouseWheel: 'RenderContainerMouseWheel',
- RenderContainerTouchMove: 'RenderContainerTouchMove',
- Other: 99
- };
- return ScrollEvent;
- }]);
- })();
- (function () {
- 'use strict';
- /**
- * @ngdoc object
- * @name ui.grid.service:gridClassFactory
- *
- * @description factory to return dom specific instances of a grid
- *
- */
- angular.module('ui.grid').service('gridClassFactory', ['gridUtil', '$q', '$compile', '$templateCache', 'uiGridConstants', 'Grid', 'GridColumn', 'GridRow',
- function (gridUtil, $q, $compile, $templateCache, uiGridConstants, Grid, GridColumn, GridRow) {
- var service = {
- /**
- * @ngdoc method
- * @name createGrid
- * @methodOf ui.grid.service:gridClassFactory
- * @description Creates a new grid instance. Each instance will have a unique id
- * @param {object} options An object map of options to pass into the created grid instance.
- * @returns {Grid} grid
- */
- createGrid : function(options) {
- options = (typeof(options) !== 'undefined') ? options : {};
- options.id = gridUtil.newId();
- var grid = new Grid(options);
- // NOTE/TODO: rowTemplate should always be defined...
- if (grid.options.rowTemplate) {
- var rowTemplateFnPromise = $q.defer();
- grid.getRowTemplateFn = rowTemplateFnPromise.promise;
-
- gridUtil.getTemplate(grid.options.rowTemplate)
- .then(
- function (template) {
- var rowTemplateFn = $compile(template);
- rowTemplateFnPromise.resolve(rowTemplateFn);
- },
- function (res) {
- // Todo handle response error here?
- throw new Error("Couldn't fetch/use row template '" + grid.options.rowTemplate + "'");
- }).catch(angular.noop);
- }
- grid.registerColumnBuilder(service.defaultColumnBuilder);
- // Row builder for custom row templates
- grid.registerRowBuilder(service.rowTemplateAssigner);
- // Reset all rows to visible initially
- grid.registerRowsProcessor(function allRowsVisible(rows) {
- rows.forEach(function (row) {
- row.evaluateRowVisibility( true );
- });
- return rows;
- }, 50);
- grid.registerColumnsProcessor(function applyColumnVisibility(columns) {
- columns.forEach(function (column) {
- column.visible = angular.isDefined(column.colDef.visible) ? column.colDef.visible : true;
- });
- return columns;
- }, 50);
- grid.registerRowsProcessor(grid.searchRows, 100);
- // Register the default row processor, it sorts rows by selected columns
- if (grid.options.externalSort && angular.isFunction(grid.options.externalSort)) {
- grid.registerRowsProcessor(grid.options.externalSort, 200);
- }
- else {
- grid.registerRowsProcessor(grid.sortByColumn, 200);
- }
- return grid;
- },
- /**
- * @ngdoc function
- * @name defaultColumnBuilder
- * @methodOf ui.grid.service:gridClassFactory
- * @description Processes designTime column definitions and applies them to col for the
- * core grid features
- * @param {object} colDef reference to column definition
- * @param {GridColumn} col reference to gridCol
- * @param {object} gridOptions reference to grid options
- */
- defaultColumnBuilder: function (colDef, col, gridOptions) {
- var templateGetPromises = [];
- // Abstracts the standard template processing we do for every template type.
- var processTemplate = function( templateType, providedType, defaultTemplate, filterType, tooltipType ) {
- if ( !colDef[templateType] ){
- col[providedType] = defaultTemplate;
- } else {
- col[providedType] = colDef[templateType];
- }
- var templatePromise = gridUtil.getTemplate(col[providedType])
- .then(
- function (template) {
- if ( angular.isFunction(template) ) { template = template(); }
- var tooltipCall = ( tooltipType === 'cellTooltip' ) ? 'col.cellTooltip(row,col)' : 'col.headerTooltip(col)';
- if ( tooltipType && col[tooltipType] === false ){
- template = template.replace(uiGridConstants.TOOLTIP, '');
- } else if ( tooltipType && col[tooltipType] ){
- template = template.replace(uiGridConstants.TOOLTIP, 'title="{{' + tooltipCall + ' CUSTOM_FILTERS }}"');
- }
- if ( filterType ){
- col[templateType] = template.replace(uiGridConstants.CUSTOM_FILTERS, function() {
- return col[filterType] ? "|" + col[filterType] : "";
- });
- } else {
- col[templateType] = template;
- }
- },
- function (res) {
- throw new Error("Couldn't fetch/use colDef." + templateType + " '" + colDef[templateType] + "'");
- }).catch(angular.noop);
- templateGetPromises.push(templatePromise);
- return templatePromise;
- };
- /**
- * @ngdoc property
- * @name cellTemplate
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description a custom template for each cell in this column. The default
- * is ui-grid/uiGridCell. If you are using the cellNav feature, this template
- * must contain a div that can receive focus.
- *
- */
- col.cellTemplatePromise = processTemplate( 'cellTemplate', 'providedCellTemplate', 'ui-grid/uiGridCell', 'cellFilter', 'cellTooltip' );
- /**
- * @ngdoc property
- * @name headerCellTemplate
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description a custom template for the header for this column. The default
- * is ui-grid/uiGridHeaderCell
- *
- */
- col.headerCellTemplatePromise = processTemplate( 'headerCellTemplate', 'providedHeaderCellTemplate', 'ui-grid/uiGridHeaderCell', 'headerCellFilter', 'headerTooltip' );
- /**
- * @ngdoc property
- * @name footerCellTemplate
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description a custom template for the footer for this column. The default
- * is ui-grid/uiGridFooterCell
- *
- */
- col.footerCellTemplatePromise = processTemplate( 'footerCellTemplate', 'providedFooterCellTemplate', 'ui-grid/uiGridFooterCell', 'footerCellFilter' );
- /**
- * @ngdoc property
- * @name filterHeaderTemplate
- * @propertyOf ui.grid.class:GridOptions.columnDef
- * @description a custom template for the filter input. The default is ui-grid/ui-grid-filter
- *
- */
- col.filterHeaderTemplatePromise = processTemplate( 'filterHeaderTemplate', 'providedFilterHeaderTemplate', 'ui-grid/ui-grid-filter' );
- // Create a promise for the compiled element function
- col.compiledElementFnDefer = $q.defer();
- return $q.all(templateGetPromises);
- },
- rowTemplateAssigner: function rowTemplateAssigner(row) {
- var grid = this;
- // Row has no template assigned to it
- if (!row.rowTemplate) {
- // Use the default row template from the grid
- row.rowTemplate = grid.options.rowTemplate;
- // Use the grid's function for fetching the compiled row template function
- row.getRowTemplateFn = grid.getRowTemplateFn;
- }
- // Row has its own template assigned
- else {
- // Create a promise for the compiled row template function
- var perRowTemplateFnPromise = $q.defer();
- row.getRowTemplateFn = perRowTemplateFnPromise.promise;
- // Get the row template
- gridUtil.getTemplate(row.rowTemplate)
- .then(function (template) {
- // Compile the template
- var rowTemplateFn = $compile(template);
-
- // Resolve the compiled template function promise
- perRowTemplateFnPromise.resolve(rowTemplateFn);
- },
- function (res) {
- // Todo handle response error here?
- throw new Error("Couldn't fetch/use row template '" + row.rowTemplate + "'");
- });
- }
- return row.getRowTemplateFn;
- }
- };
- //class definitions (moved to separate factories)
- return service;
- }]);
- })();
- (function() {
- var module = angular.module('ui.grid');
- function escapeRegExp(str) {
- return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
- }
- /**
- * @ngdoc service
- * @name ui.grid.service:rowSearcher
- *
- * @description Service for searching/filtering rows based on column value conditions.
- */
- module.service('rowSearcher', ['gridUtil', 'uiGridConstants', function (gridUtil, uiGridConstants) {
- var defaultCondition = uiGridConstants.filter.CONTAINS;
- var rowSearcher = {};
- /**
- * @ngdoc function
- * @name getTerm
- * @methodOf ui.grid.service:rowSearcher
- * @description Get the term from a filter
- * Trims leading and trailing whitespace
- * @param {object} filter object to use
- * @returns {object} Parsed term
- */
- rowSearcher.getTerm = function getTerm(filter) {
- if (typeof(filter.term) === 'undefined') { return filter.term; }
- var term = filter.term;
- // Strip leading and trailing whitespace if the term is a string
- if (typeof(term) === 'string') {
- term = term.trim();
- }
- return term;
- };
- /**
- * @ngdoc function
- * @name stripTerm
- * @methodOf ui.grid.service:rowSearcher
- * @description Remove leading and trailing asterisk (*) from the filter's term
- * @param {object} filter object to use
- * @returns {uiGridConstants.filter<int>} Value representing the condition constant value
- */
- rowSearcher.stripTerm = function stripTerm(filter) {
- var term = rowSearcher.getTerm(filter);
- if (typeof(term) === 'string') {
- return escapeRegExp(term.replace(/(^\*|\*$)/g, ''));
- }
- else {
- return term;
- }
- };
- /**
- * @ngdoc function
- * @name guessCondition
- * @methodOf ui.grid.service:rowSearcher
- * @description Guess the condition for a filter based on its term
- * <br>
- * Defaults to STARTS_WITH. Uses CONTAINS for strings beginning and ending with *s (*bob*).
- * Uses STARTS_WITH for strings ending with * (bo*). Uses ENDS_WITH for strings starting with * (*ob).
- * @param {object} filter object to use
- * @returns {uiGridConstants.filter<int>} Value representing the condition constant value
- */
- rowSearcher.guessCondition = function guessCondition(filter) {
- if (typeof(filter.term) === 'undefined' || !filter.term) {
- return defaultCondition;
- }
- var term = rowSearcher.getTerm(filter);
- if (/\*/.test(term)) {
- var regexpFlags = '';
- if (!filter.flags || !filter.flags.caseSensitive) {
- regexpFlags += 'i';
- }
- var reText = term.replace(/(\\)?\*/g, function ($0, $1) { return $1 ? $0 : '[\\s\\S]*?'; });
- return new RegExp('^' + reText + '$', regexpFlags);
- }
- // Otherwise default to default condition
- else {
- return defaultCondition;
- }
- };
- /**
- * @ngdoc function
- * @name setupFilters
- * @methodOf ui.grid.service:rowSearcher
- * @description For a given columns filters (either col.filters, or [col.filter] can be passed in),
- * do all the parsing and pre-processing and store that data into a new filters object. The object
- * has the condition, the flags, the stripped term, and a parsed reg exp if there was one.
- *
- * We could use a forEach in here, since it's much less performance sensitive, but since we're using
- * for loops everywhere else in this module...
- *
- * @param {array} filters the filters from the column (col.filters or [col.filter])
- * @returns {array} An array of parsed/preprocessed filters
- */
- rowSearcher.setupFilters = function setupFilters( filters ){
- var newFilters = [];
- var filtersLength = filters.length;
- for ( var i = 0; i < filtersLength; i++ ){
- var filter = filters[i];
- if ( filter.noTerm || !gridUtil.isNullOrUndefined(filter.term) ){
- var newFilter = {};
- var regexpFlags = '';
- if (!filter.flags || !filter.flags.caseSensitive) {
- regexpFlags += 'i';
- }
- if ( !gridUtil.isNullOrUndefined(filter.term) ){
- // it is possible to have noTerm.
- if ( filter.rawTerm ){
- newFilter.term = filter.term;
- } else {
- newFilter.term = rowSearcher.stripTerm(filter);
- }
- }
- newFilter.noTerm = filter.noTerm;
- if ( filter.condition ){
- newFilter.condition = filter.condition;
- } else {
- newFilter.condition = rowSearcher.guessCondition(filter);
- }
- newFilter.flags = angular.extend( { caseSensitive: false, date: false }, filter.flags );
- if (newFilter.condition === uiGridConstants.filter.STARTS_WITH) {
- newFilter.startswithRE = new RegExp('^' + newFilter.term, regexpFlags);
- }
- if (newFilter.condition === uiGridConstants.filter.ENDS_WITH) {
- newFilter.endswithRE = new RegExp(newFilter.term + '$', regexpFlags);
- }
- if (newFilter.condition === uiGridConstants.filter.CONTAINS) {
- newFilter.containsRE = new RegExp(newFilter.term, regexpFlags);
- }
- if (newFilter.condition === uiGridConstants.filter.EXACT) {
- newFilter.exactRE = new RegExp('^' + newFilter.term + '$', regexpFlags);
- }
- newFilters.push(newFilter);
- }
- }
- return newFilters;
- };
- /**
- * @ngdoc function
- * @name runColumnFilter
- * @methodOf ui.grid.service:rowSearcher
- * @description Runs a single pre-parsed filter against a cell, returning true
- * if the cell matches that one filter.
- *
- * @param {Grid} grid the grid we're working against
- * @param {GridRow} row the row we're matching against
- * @param {GridColumn} column the column that we're working against
- * @param {object} filter the specific, preparsed, filter that we want to test
- * @returns {boolean} true if we match (row stays visible)
- */
- rowSearcher.runColumnFilter = function runColumnFilter(grid, row, column, filter) {
- // Cache typeof condition
- var conditionType = typeof(filter.condition);
- // Term to search for.
- var term = filter.term;
- // Get the column value for this row
- var value;
- if ( column.filterCellFiltered ){
- value = grid.getCellDisplayValue(row, column);
- } else {
- value = grid.getCellValue(row, column);
- }
- // If the filter's condition is a RegExp, then use it
- if (filter.condition instanceof RegExp) {
- return filter.condition.test(value);
- }
- // If the filter's condition is a function, run it
- if (conditionType === 'function') {
- return filter.condition(term, value, row, column);
- }
- if (filter.startswithRE) {
- return filter.startswithRE.test(value);
- }
- if (filter.endswithRE) {
- return filter.endswithRE.test(value);
- }
- if (filter.containsRE) {
- return filter.containsRE.test(value);
- }
- if (filter.exactRE) {
- return filter.exactRE.test(value);
- }
- if (filter.condition === uiGridConstants.filter.NOT_EQUAL) {
- var regex = new RegExp('^' + term + '$');
- return !regex.exec(value);
- }
- if (typeof(value) === 'number' && typeof(term) === 'string' ){
- // if the term has a decimal in it, it comes through as '9\.4', we need to take out the \
- // the same for negative numbers
- // TODO: I suspect the right answer is to look at escapeRegExp at the top of this code file, maybe it's not needed?
- var tempFloat = parseFloat(term.replace(/\\\./,'.').replace(/\\\-/,'-'));
- if (!isNaN(tempFloat)) {
- term = tempFloat;
- }
- }
- if (filter.flags.date === true) {
- value = new Date(value);
- // If the term has a dash in it, it comes through as '\-' -- we need to take out the '\'.
- term = new Date(term.replace(/\\/g, ''));
- }
- if (filter.condition === uiGridConstants.filter.GREATER_THAN) {
- return (value > term);
- }
- if (filter.condition === uiGridConstants.filter.GREATER_THAN_OR_EQUAL) {
- return (value >= term);
- }
- if (filter.condition === uiGridConstants.filter.LESS_THAN) {
- return (value < term);
- }
- if (filter.condition === uiGridConstants.filter.LESS_THAN_OR_EQUAL) {
- return (value <= term);
- }
- return true;
- };
- /**
- * @ngdoc boolean
- * @name useExternalFiltering
- * @propertyOf ui.grid.class:GridOptions
- * @description False by default. When enabled, this setting suppresses the internal filtering.
- * All UI logic will still operate, allowing filter conditions to be set and modified.
- *
- * The external filter logic can listen for the `filterChange` event, which fires whenever
- * a filter has been adjusted.
- */
- /**
- * @ngdoc function
- * @name searchColumn
- * @methodOf ui.grid.service:rowSearcher
- * @description Process provided filters on provided column against a given row. If the row meets
- * the conditions on all the filters, return true.
- * @param {Grid} grid Grid to search in
- * @param {GridRow} row Row to search on
- * @param {GridColumn} column Column with the filters to use
- * @param {array} filters array of pre-parsed/preprocessed filters to apply
- * @returns {boolean} Whether the column matches or not.
- */
- rowSearcher.searchColumn = function searchColumn(grid, row, column, filters) {
- if (grid.options.useExternalFiltering) {
- return true;
- }
- var filtersLength = filters.length;
- for (var i = 0; i < filtersLength; i++) {
- var filter = filters[i];
- if ( !gridUtil.isNullOrUndefined(filter.term) && filter.term !== '' || filter.noTerm ){
- var ret = rowSearcher.runColumnFilter(grid, row, column, filter);
- if (!ret) {
- return false;
- }
- }
- }
- return true;
- };
- /**
- * @ngdoc function
- * @name search
- * @methodOf ui.grid.service:rowSearcher
- * @description Run a search across the given rows and columns, marking any rows that don't
- * match the stored col.filters or col.filter as invisible.
- * @param {Grid} grid Grid instance to search inside
- * @param {Array[GridRow]} rows GridRows to filter
- * @param {Array[GridColumn]} columns GridColumns with filters to process
- */
- rowSearcher.search = function search(grid, rows, columns) {
- /*
- * Added performance optimisations into this code base, as this logic creates deeply nested
- * loops and is therefore very performance sensitive. In particular, avoiding forEach as
- * this impacts some browser optimisers (particularly Chrome), using iterators instead
- */
- // Don't do anything if we weren't passed any rows
- if (!rows) {
- return;
- }
- // don't filter if filtering currently disabled
- if (!grid.options.enableFiltering){
- return rows;
- }
- // Build list of filters to apply
- var filterData = [];
- var colsLength = columns.length;
- var hasTerm = function( filters ) {
- var hasTerm = false;
- filters.forEach( function (filter) {
- if ( !gridUtil.isNullOrUndefined(filter.term) && filter.term !== '' || filter.noTerm ){
- hasTerm = true;
- }
- });
- return hasTerm;
- };
- for (var i = 0; i < colsLength; i++) {
- var col = columns[i];
- if (typeof(col.filters) !== 'undefined' && hasTerm(col.filters) ) {
- filterData.push( { col: col, filters: rowSearcher.setupFilters(col.filters) } );
- }
- }
- if (filterData.length > 0) {
- // define functions outside the loop, performance optimisation
- var foreachRow = function(grid, row, col, filters){
- if ( row.visible && !rowSearcher.searchColumn(grid, row, col, filters) ) {
- row.visible = false;
- }
- };
- var foreachFilterCol = function(grid, filterData){
- var rowsLength = rows.length;
- for ( var i = 0; i < rowsLength; i++){
- foreachRow(grid, rows[i], filterData.col, filterData.filters);
- }
- };
- // nested loop itself - foreachFilterCol, which in turn calls foreachRow
- var filterDataLength = filterData.length;
- for ( var j = 0; j < filterDataLength; j++){
- foreachFilterCol( grid, filterData[j] );
- }
- if (grid.api.core.raise.rowsVisibleChanged) {
- grid.api.core.raise.rowsVisibleChanged();
- }
- // drop any invisible rows
- // keeping these, as needed with filtering for trees - we have to come back and make parent nodes visible if child nodes are selected in the filter
- // rows = rows.filter(function(row){ return row.visible; });
- }
- return rows;
- };
- return rowSearcher;
- }]);
- })();
- (function() {
- var module = angular.module('ui.grid');
- /**
- * @ngdoc object
- * @name ui.grid.class:rowSorter
- * @description rowSorter provides the default sorting mechanisms,
- * including guessing column types and applying appropriate sort
- * algorithms
- *
- */
- module.service('rowSorter', ['$parse', 'uiGridConstants', function ($parse, uiGridConstants) {
- var currencyRegexStr =
- '(' +
- uiGridConstants.CURRENCY_SYMBOLS
- .map(function (a) { return '\\' + a; }) // Escape all the currency symbols ($ at least will jack up this regex)
- .join('|') + // Join all the symbols together with |s
- ')?';
- // /^[-+]?[£$¤¥]?[\d,.]+%?$/
- var numberStrRegex = new RegExp('^[-+]?' + currencyRegexStr + '[\\d,.]+' + currencyRegexStr + '%?$');
- var rowSorter = {
- // Cache of sorting functions. Once we create them, we don't want to keep re-doing it
- // this takes a piece of data from the cell and tries to determine its type and what sorting
- // function to use for it
- colSortFnCache: {}
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:rowSorter
- * @name guessSortFn
- * @description Assigns a sort function to use based on the itemType in the column
- * @param {string} itemType one of 'number', 'boolean', 'string', 'date', 'object'. And
- * error will be thrown for any other type.
- * @returns {function} a sort function that will sort that type
- */
- rowSorter.guessSortFn = function guessSortFn(itemType) {
- switch (itemType) {
- case "number":
- return rowSorter.sortNumber;
- case "numberStr":
- return rowSorter.sortNumberStr;
- case "boolean":
- return rowSorter.sortBool;
- case "string":
- return rowSorter.sortAlpha;
- case "date":
- return rowSorter.sortDate;
- case "object":
- return rowSorter.basicSort;
- default:
- throw new Error('No sorting function found for type:' + itemType);
- }
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:rowSorter
- * @name handleNulls
- * @description Sorts nulls and undefined to the bottom (top when
- * descending). Called by each of the internal sorters before
- * attempting to sort. Note that this method is available on the core api
- * via gridApi.core.sortHandleNulls
- * @param {object} a sort value a
- * @param {object} b sort value b
- * @returns {number} null if there were no nulls/undefineds, otherwise returns
- * a sort value that should be passed back from the sort function
- */
- rowSorter.handleNulls = function handleNulls(a, b) {
- // We want to allow zero values and false values to be evaluated in the sort function
- if ((!a && a !== 0 && a !== false) || (!b && b !== 0 && b !== false)) {
- // We want to force nulls and such to the bottom when we sort... which effectively is "greater than"
- if ((!a && a !== 0 && a !== false) && (!b && b !== 0 && b !== false)) {
- return 0;
- }
- else if (!a && a !== 0 && a !== false) {
- return 1;
- }
- else if (!b && b !== 0 && b !== false) {
- return -1;
- }
- }
- return null;
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:rowSorter
- * @name basicSort
- * @description Sorts any values that provide the < method, including strings
- * or numbers. Handles nulls and undefined through calling handleNulls
- * @param {object} a sort value a
- * @param {object} b sort value b
- * @returns {number} normal sort function, returns -ve, 0, +ve
- */
- rowSorter.basicSort = function basicSort(a, b) {
- var nulls = rowSorter.handleNulls(a, b);
- if ( nulls !== null ){
- return nulls;
- } else {
- if (a === b) {
- return 0;
- }
- if (a < b) {
- return -1;
- }
- return 1;
- }
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:rowSorter
- * @name sortNumber
- * @description Sorts numerical values. Handles nulls and undefined through calling handleNulls
- * @param {object} a sort value a
- * @param {object} b sort value b
- * @returns {number} normal sort function, returns -ve, 0, +ve
- */
- rowSorter.sortNumber = function sortNumber(a, b) {
- var nulls = rowSorter.handleNulls(a, b);
- if ( nulls !== null ){
- return nulls;
- } else {
- return a - b;
- }
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:rowSorter
- * @name sortNumberStr
- * @description Sorts numerical values that are stored in a string (i.e. parses them to numbers first).
- * Handles nulls and undefined through calling handleNulls
- * @param {object} a sort value a
- * @param {object} b sort value b
- * @returns {number} normal sort function, returns -ve, 0, +ve
- */
- rowSorter.sortNumberStr = function sortNumberStr(a, b) {
- var nulls = rowSorter.handleNulls(a, b);
- if ( nulls !== null ){
- return nulls;
- } else {
- var numA, // The parsed number form of 'a'
- numB, // The parsed number form of 'b'
- badA = false,
- badB = false;
- // Try to parse 'a' to a float
- numA = parseFloat(a.replace(/[^0-9.-]/g, ''));
- // If 'a' couldn't be parsed to float, flag it as bad
- if (isNaN(numA)) {
- badA = true;
- }
- // Try to parse 'b' to a float
- numB = parseFloat(b.replace(/[^0-9.-]/g, ''));
- // If 'b' couldn't be parsed to float, flag it as bad
- if (isNaN(numB)) {
- badB = true;
- }
- // We want bad ones to get pushed to the bottom... which effectively is "greater than"
- if (badA && badB) {
- return 0;
- }
- if (badA) {
- return 1;
- }
- if (badB) {
- return -1;
- }
- return numA - numB;
- }
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:rowSorter
- * @name sortAlpha
- * @description Sorts string values. Handles nulls and undefined through calling handleNulls
- * @param {object} a sort value a
- * @param {object} b sort value b
- * @returns {number} normal sort function, returns -ve, 0, +ve
- */
- rowSorter.sortAlpha = function sortAlpha(a, b) {
- var nulls = rowSorter.handleNulls(a, b);
- if ( nulls !== null ){
- return nulls;
- } else {
- var strA = a.toString().toLowerCase(),
- strB = b.toString().toLowerCase();
- return strA === strB ? 0 : strA.localeCompare(strB);
- }
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:rowSorter
- * @name sortDate
- * @description Sorts date values. Handles nulls and undefined through calling handleNulls.
- * Handles date strings by converting to Date object if not already an instance of Date
- * @param {object} a sort value a
- * @param {object} b sort value b
- * @returns {number} normal sort function, returns -ve, 0, +ve
- */
- rowSorter.sortDate = function sortDate(a, b) {
- var nulls = rowSorter.handleNulls(a, b);
- if ( nulls !== null ){
- return nulls;
- } else {
- if (!(a instanceof Date)) {
- a = new Date(a);
- }
- if (!(b instanceof Date)){
- b = new Date(b);
- }
- var timeA = a.getTime(),
- timeB = b.getTime();
- return timeA === timeB ? 0 : (timeA < timeB ? -1 : 1);
- }
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:rowSorter
- * @name sortBool
- * @description Sorts boolean values, true is considered larger than false.
- * Handles nulls and undefined through calling handleNulls
- * @param {object} a sort value a
- * @param {object} b sort value b
- * @returns {number} normal sort function, returns -ve, 0, +ve
- */
- rowSorter.sortBool = function sortBool(a, b) {
- var nulls = rowSorter.handleNulls(a, b);
- if ( nulls !== null ){
- return nulls;
- } else {
- if (a && b) {
- return 0;
- }
- if (!a && !b) {
- return 0;
- }
- else {
- return a ? 1 : -1;
- }
- }
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:rowSorter
- * @name getSortFn
- * @description Get the sort function for the column. Looks first in
- * rowSorter.colSortFnCache using the column name, failing that it
- * looks at col.sortingAlgorithm (and puts it in the cache), failing that
- * it guesses the sort algorithm based on the data type.
- *
- * The cache currently seems a bit pointless, as none of the work we do is
- * processor intensive enough to need caching. Presumably in future we might
- * inspect the row data itself to guess the sort function, and in that case
- * it would make sense to have a cache, the infrastructure is in place to allow
- * that.
- *
- * @param {Grid} grid the grid to consider
- * @param {GridColumn} col the column to find a function for
- * @param {array} rows an array of grid rows. Currently unused, but presumably in future
- * we might inspect the rows themselves to decide what sort of data might be there
- * @returns {function} the sort function chosen for the column
- */
- rowSorter.getSortFn = function getSortFn(grid, col, rows) {
- var sortFn, item;
- // See if we already figured out what to use to sort the column and have it in the cache
- if (rowSorter.colSortFnCache[col.colDef.name]) {
- sortFn = rowSorter.colSortFnCache[col.colDef.name];
- }
- // If the column has its OWN sorting algorithm, use that
- else if (col.sortingAlgorithm !== undefined) {
- sortFn = col.sortingAlgorithm;
- rowSorter.colSortFnCache[col.colDef.name] = col.sortingAlgorithm;
- }
- // Always default to sortAlpha when sorting after a cellFilter
- else if ( col.sortCellFiltered && col.cellFilter ){
- sortFn = rowSorter.sortAlpha;
- rowSorter.colSortFnCache[col.colDef.name] = sortFn;
- }
- // Try and guess what sort function to use
- else {
- // Guess the sort function
- sortFn = rowSorter.guessSortFn(col.colDef.type);
- // If we found a sort function, cache it
- if (sortFn) {
- rowSorter.colSortFnCache[col.colDef.name] = sortFn;
- }
- else {
- // We assign the alpha sort because anything that is null/undefined will never get passed to
- // the actual sorting function. It will get caught in our null check and returned to be sorted
- // down to the bottom
- sortFn = rowSorter.sortAlpha;
- }
- }
- return sortFn;
- };
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:rowSorter
- * @name prioritySort
- * @description Used where multiple columns are present in the sort criteria,
- * we determine which column should take precedence in the sort by sorting
- * the columns based on their sort.priority
- *
- * @param {gridColumn} a column a
- * @param {gridColumn} b column b
- * @returns {number} normal sort function, returns -ve, 0, +ve
- */
- rowSorter.prioritySort = function (a, b) {
- // Both columns have a sort priority
- if (a.sort.priority !== undefined && b.sort.priority !== undefined) {
- // A is higher priority
- if (a.sort.priority < b.sort.priority) {
- return -1;
- }
- // Equal
- else if (a.sort.priority === b.sort.priority) {
- return 0;
- }
- // B is higher
- else {
- return 1;
- }
- }
- // Only A has a priority
- else if (a.sort.priority !== undefined) {
- return -1;
- }
- // Only B has a priority
- else if (b.sort.priority !== undefined) {
- return 1;
- }
- // Neither has a priority
- else {
- return 0;
- }
- };
- /**
- * @ngdoc object
- * @name useExternalSorting
- * @propertyOf ui.grid.class:GridOptions
- * @description Prevents the internal sorting from executing. Events will
- * still be fired when the sort changes, and the sort information on
- * the columns will be updated, allowing an external sorter (for example,
- * server sorting) to be implemented. Defaults to false.
- *
- */
- /**
- * @ngdoc method
- * @methodOf ui.grid.class:rowSorter
- * @name sort
- * @description sorts the grid
- * @param {Object} grid the grid itself
- * @param {array} rows the rows to be sorted
- * @param {array} columns the columns in which to look
- * for sort criteria
- * @returns {array} sorted rows
- */
- rowSorter.sort = function rowSorterSort(grid, rows, columns) {
- // first make sure we are even supposed to do work
- if (!rows) {
- return;
- }
- if (grid.options.useExternalSorting){
- return rows;
- }
- // Build the list of columns to sort by
- var sortCols = [];
- var defaultSortCols = [];
- columns.forEach(function (col) {
- if (col.sort && !col.sort.ignoreSort && col.sort.direction && (col.sort.direction === uiGridConstants.ASC || col.sort.direction === uiGridConstants.DESC)) {
- sortCols.push({
- col: col,
- sort: col.sort
- });
- } else if ( col.defaultSort && col.defaultSort.direction && (col.defaultSort.direction === uiGridConstants.ASC || col.defaultSort.direction === uiGridConstants.DESC) ) {
- defaultSortCols.push({
- col: col,
- sort: col.defaultSort
- });
- }
- });
- // Sort the "sort columns" by their sort priority
- sortCols = sortCols.sort(rowSorter.prioritySort);
- defaultSortCols = defaultSortCols.sort(rowSorter.prioritySort);
- sortCols = sortCols.concat(defaultSortCols);
- // Now rows to sort by, maintain original order
- if (sortCols.length === 0) {
- return rows;
- }
- // Re-usable variables
- var col, direction;
- // put a custom index field on each row, used to make a stable sort out of unstable sorts (e.g. Chrome)
- var setIndex = function( row, idx ){
- row.entity.$$uiGridIndex = idx;
- };
- rows.forEach(setIndex);
- // IE9-11 HACK.... the 'rows' variable would be empty where we call rowSorter.getSortFn(...) below. We have to use a separate reference
- // var d = data.slice(0);
- var r = rows.slice(0);
- // Now actually sort the data
- var rowSortFn = function (rowA, rowB) {
- var tem = 0,
- idx = 0,
- sortFn;
- while (tem === 0 && idx < sortCols.length) {
- // grab the metadata for the rest of the logic
- col = sortCols[idx].col;
- direction = sortCols[idx].sort.direction;
- sortFn = rowSorter.getSortFn(grid, col, r);
- var propA, propB;
- if ( col.sortCellFiltered ){
- propA = grid.getCellDisplayValue(rowA, col);
- propB = grid.getCellDisplayValue(rowB, col);
- } else {
- propA = grid.getCellValue(rowA, col);
- propB = grid.getCellValue(rowB, col);
- }
- tem = sortFn(propA, propB, rowA, rowB, direction, col);
- idx++;
- }
- // Chrome doesn't implement a stable sort function. If our sort returns 0
- // (i.e. the items are equal), and we're at the last sort column in the list,
- // then return the previous order using our custom
- // index variable
- if (tem === 0 ) {
- return rowA.entity.$$uiGridIndex - rowB.entity.$$uiGridIndex;
- }
- // Made it this far, we don't have to worry about null & undefined
- if (direction === uiGridConstants.ASC) {
- return tem;
- } else {
- return 0 - tem;
- }
- };
- var newRows = rows.sort(rowSortFn);
- // remove the custom index field on each row, used to make a stable sort out of unstable sorts (e.g. Chrome)
- var clearIndex = function( row, idx ){
- delete row.entity.$$uiGridIndex;
- };
- rows.forEach(clearIndex);
- return newRows;
- };
- return rowSorter;
- }]);
- })();
- (function() {
- var module = angular.module('ui.grid');
- var bindPolyfill;
- if (typeof Function.prototype.bind !== "function") {
- bindPolyfill = function() {
- var slice = Array.prototype.slice;
- return function(context) {
- var fn = this,
- args = slice.call(arguments, 1);
- if (args.length) {
- return function() {
- return arguments.length ? fn.apply(context, args.concat(slice.call(arguments))) : fn.apply(context, args);
- };
- }
- return function() {
- return arguments.length ? fn.apply(context, arguments) : fn.call(context);
- };
- };
- };
- }
- function getStyles (elem) {
- var e = elem;
- if (typeof(e.length) !== 'undefined' && e.length) {
- e = elem[0];
- }
- return e.ownerDocument.defaultView.getComputedStyle(e, null);
- }
- var rnumnonpx = new RegExp( "^(" + (/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/).source + ")(?!px)[a-z%]+$", "i" ),
- // swappable if display is none or starts with table except "table", "table-cell", or "table-caption"
- // see here for display values: https://developer.mozilla.org/en-US/docs/CSS/display
- rdisplayswap = /^(block|none|table(?!-c[ea]).+)/,
- cssShow = { position: "absolute", visibility: "hidden", display: "block" };
- function augmentWidthOrHeight( elem, name, extra, isBorderBox, styles ) {
- var i = extra === ( isBorderBox ? 'border' : 'content' ) ?
- // If we already have the right measurement, avoid augmentation
- 4 :
- // Otherwise initialize for horizontal or vertical properties
- name === 'width' ? 1 : 0,
- val = 0;
- var sides = ['Top', 'Right', 'Bottom', 'Left'];
- for ( ; i < 4; i += 2 ) {
- var side = sides[i];
- // dump('side', side);
- // both box models exclude margin, so add it if we want it
- if ( extra === 'margin' ) {
- var marg = parseFloat(styles[extra + side]);
- if (!isNaN(marg)) {
- val += marg;
- }
- }
- // dump('val1', val);
- if ( isBorderBox ) {
- // border-box includes padding, so remove it if we want content
- if ( extra === 'content' ) {
- var padd = parseFloat(styles['padding' + side]);
- if (!isNaN(padd)) {
- val -= padd;
- // dump('val2', val);
- }
- }
- // at this point, extra isn't border nor margin, so remove border
- if ( extra !== 'margin' ) {
- var bordermarg = parseFloat(styles['border' + side + 'Width']);
- if (!isNaN(bordermarg)) {
- val -= bordermarg;
- // dump('val3', val);
- }
- }
- }
- else {
- // at this point, extra isn't content, so add padding
- var nocontentPad = parseFloat(styles['padding' + side]);
- if (!isNaN(nocontentPad)) {
- val += nocontentPad;
- // dump('val4', val);
- }
- // at this point, extra isn't content nor padding, so add border
- if ( extra !== 'padding') {
- var nocontentnopad = parseFloat(styles['border' + side + 'Width']);
- if (!isNaN(nocontentnopad)) {
- val += nocontentnopad;
- // dump('val5', val);
- }
- }
- }
- }
- // dump('augVal', val);
- return val;
- }
- function getWidthOrHeight( elem, name, extra ) {
- // Start with offset property, which is equivalent to the border-box value
- var valueIsBorderBox = true,
- val, // = name === 'width' ? elem.offsetWidth : elem.offsetHeight,
- styles = getStyles(elem),
- isBorderBox = styles['boxSizing'] === 'border-box';
- // some non-html elements return undefined for offsetWidth, so check for null/undefined
- // svg - https://bugzilla.mozilla.org/show_bug.cgi?id=649285
- // MathML - https://bugzilla.mozilla.org/show_bug.cgi?id=491668
- if ( val <= 0 || val == null ) {
- // Fall back to computed then uncomputed css if necessary
- val = styles[name];
- if ( val < 0 || val == null ) {
- val = elem.style[ name ];
- }
- // Computed unit is not pixels. Stop here and return.
- if ( rnumnonpx.test(val) ) {
- return val;
- }
- // we need the check for style in case a browser which returns unreliable values
- // for getComputedStyle silently falls back to the reliable elem.style
- valueIsBorderBox = isBorderBox &&
- ( true || val === elem.style[ name ] ); // use 'true' instead of 'support.boxSizingReliable()'
- // Normalize "", auto, and prepare for extra
- val = parseFloat( val ) || 0;
- }
- // use the active box-sizing model to add/subtract irrelevant styles
- var ret = ( val +
- augmentWidthOrHeight(
- elem,
- name,
- extra || ( isBorderBox ? "border" : "content" ),
- valueIsBorderBox,
- styles
- )
- );
- // dump('ret', ret, val);
- return ret;
- }
- function getLineHeight(elm) {
- elm = angular.element(elm)[0];
- var parent = elm.parentElement;
- if (!parent) {
- parent = document.getElementsByTagName('body')[0];
- }
- return parseInt( getStyles(parent).fontSize ) || parseInt( getStyles(elm).fontSize ) || 16;
- }
- var uid = ['0', '0', '0', '0'];
- var uidPrefix = 'uiGrid-';
- /**
- * @ngdoc service
- * @name ui.grid.service:GridUtil
- *
- * @description Grid utility functions
- */
- module.service('gridUtil', ['$log', '$window', '$document', '$http', '$templateCache', '$timeout', '$interval', '$injector', '$q', '$interpolate', 'uiGridConstants',
- function ($log, $window, $document, $http, $templateCache, $timeout, $interval, $injector, $q, $interpolate, uiGridConstants) {
- var s = {
- augmentWidthOrHeight: augmentWidthOrHeight,
- getStyles: getStyles,
- /**
- * @ngdoc method
- * @name createBoundedWrapper
- * @methodOf ui.grid.service:GridUtil
- *
- * @param {object} Object to bind 'this' to
- * @param {method} Method to bind
- * @returns {Function} The wrapper that performs the binding
- *
- * @description
- * Binds given method to given object.
- *
- * By means of a wrapper, ensures that ``method`` is always bound to
- * ``object`` regardless of its calling environment.
- * Iow, inside ``method``, ``this`` always points to ``object``.
- *
- * See http://alistapart.com/article/getoutbindingsituations
- *
- */
- createBoundedWrapper: function(object, method) {
- return function() {
- return method.apply(object, arguments);
- };
- },
- /**
- * @ngdoc method
- * @name readableColumnName
- * @methodOf ui.grid.service:GridUtil
- *
- * @param {string} columnName Column name as a string
- * @returns {string} Column name appropriately capitalized and split apart
- *
- @example
- <example module="app">
- <file name="app.js">
- var app = angular.module('app', ['ui.grid']);
- app.controller('MainCtrl', ['$scope', 'gridUtil', function ($scope, gridUtil) {
- $scope.name = 'firstName';
- $scope.columnName = function(name) {
- return gridUtil.readableColumnName(name);
- };
- }]);
- </file>
- <file name="index.html">
- <div ng-controller="MainCtrl">
- <strong>Column name:</strong> <input ng-model="name" />
- <br>
- <strong>Output:</strong> <span ng-bind="columnName(name)"></span>
- </div>
- </file>
- </example>
- */
- readableColumnName: function (columnName) {
- // Convert underscores to spaces
- if (typeof(columnName) === 'undefined' || columnName === undefined || columnName === null) { return columnName; }
- if (typeof(columnName) !== 'string') {
- columnName = String(columnName);
- }
- return columnName.replace(/_+/g, ' ')
- // Replace a completely all-capsed word with a first-letter-capitalized version
- .replace(/^[A-Z]+$/, function (match) {
- return angular.lowercase(angular.uppercase(match.charAt(0)) + match.slice(1));
- })
- // Capitalize the first letter of words
- .replace(/([\w\u00C0-\u017F]+)/g, function (match) {
- return angular.uppercase(match.charAt(0)) + match.slice(1);
- })
- // Put a space in between words that have partial capilizations (i.e. 'firstName' becomes 'First Name')
- // .replace(/([A-Z]|[A-Z]\w+)([A-Z])/g, "$1 $2");
- // .replace(/(\w+?|\w)([A-Z])/g, "$1 $2");
- .replace(/(\w+?(?=[A-Z]))/g, '$1 ');
- },
- /**
- * @ngdoc method
- * @name getColumnsFromData
- * @methodOf ui.grid.service:GridUtil
- * @description Return a list of column names, given a data set
- *
- * @param {string} data Data array for grid
- * @returns {Object} Column definitions with field accessor and column name
- *
- * @example
- <pre>
- var data = [
- { firstName: 'Bob', lastName: 'Jones' },
- { firstName: 'Frank', lastName: 'Smith' }
- ];
- var columnDefs = GridUtil.getColumnsFromData(data, excludeProperties);
- columnDefs == [
- {
- field: 'firstName',
- name: 'First Name'
- },
- {
- field: 'lastName',
- name: 'Last Name'
- }
- ];
- </pre>
- */
- getColumnsFromData: function (data, excludeProperties) {
- var columnDefs = [];
- if (!data || typeof(data[0]) === 'undefined' || data[0] === undefined) { return []; }
- if (angular.isUndefined(excludeProperties)) { excludeProperties = []; }
- var item = data[0];
- angular.forEach(item,function (prop, propName) {
- if ( excludeProperties.indexOf(propName) === -1){
- columnDefs.push({
- name: propName
- });
- }
- });
- return columnDefs;
- },
- /**
- * @ngdoc method
- * @name newId
- * @methodOf ui.grid.service:GridUtil
- * @description Return a unique ID string
- *
- * @returns {string} Unique string
- *
- * @example
- <pre>
- var id = GridUtil.newId();
- # 1387305700482;
- </pre>
- */
- newId: (function() {
- var seedId = new Date().getTime();
- return function() {
- return seedId += 1;
- };
- })(),
- /**
- * @ngdoc method
- * @name getTemplate
- * @methodOf ui.grid.service:GridUtil
- * @description Get's template from cache / element / url
- *
- * @param {string|element|promise} Either a string representing the template id, a string representing the template url,
- * an jQuery/Angualr element, or a promise that returns the template contents to use.
- * @returns {object} a promise resolving to template contents
- *
- * @example
- <pre>
- GridUtil.getTemplate(url).then(function (contents) {
- alert(contents);
- })
- </pre>
- */
- getTemplate: function (template) {
- // Try to fetch the template out of the templateCache
- if ($templateCache.get(template)) {
- return s.postProcessTemplate($templateCache.get(template));
- }
- // See if the template is itself a promise
- if (angular.isFunction(template.then)) {
- return template.then(s.postProcessTemplate).catch(angular.noop);
- }
- // If the template is an element, return the element
- try {
- if (angular.element(template).length > 0) {
- return $q.when(template).then(s.postProcessTemplate).catch(angular.noop);
- }
- }
- catch (err){
- //do nothing; not valid html
- }
- // s.logDebug('fetching url', template);
- // Default to trying to fetch the template as a url with $http
- return $http({ method: 'GET', url: template})
- .then(
- function (result) {
- var templateHtml = result.data.trim();
- //put in templateCache for next call
- $templateCache.put(template, templateHtml);
- return templateHtml;
- },
- function (err) {
- throw new Error("Could not get template " + template + ": " + err);
- }
- )
- .then(s.postProcessTemplate).catch(angular.noop);
- },
- //
- postProcessTemplate: function (template) {
- var startSym = $interpolate.startSymbol(),
- endSym = $interpolate.endSymbol();
- // If either of the interpolation symbols have been changed, we need to alter this template
- if (startSym !== '{{' || endSym !== '}}') {
- template = template.replace(/\{\{/g, startSym);
- template = template.replace(/\}\}/g, endSym);
- }
- return $q.when(template);
- },
- /**
- * @ngdoc method
- * @name guessType
- * @methodOf ui.grid.service:GridUtil
- * @description guesses the type of an argument
- *
- * @param {string/number/bool/object} item variable to examine
- * @returns {string} one of the following
- * - 'string'
- * - 'boolean'
- * - 'number'
- * - 'date'
- * - 'object'
- */
- guessType : function (item) {
- var itemType = typeof(item);
- // Check for numbers and booleans
- switch (itemType) {
- case "number":
- case "boolean":
- case "string":
- return itemType;
- default:
- if (angular.isDate(item)) {
- return "date";
- }
- return "object";
- }
- },
- /**
- * @ngdoc method
- * @name elementWidth
- * @methodOf ui.grid.service:GridUtil
- *
- * @param {element} element DOM element
- * @param {string} [extra] Optional modifier for calculation. Use 'margin' to account for margins on element
- *
- * @returns {number} Element width in pixels, accounting for any borders, etc.
- */
- elementWidth: function (elem) {
- },
- /**
- * @ngdoc method
- * @name elementHeight
- * @methodOf ui.grid.service:GridUtil
- *
- * @param {element} element DOM element
- * @param {string} [extra] Optional modifier for calculation. Use 'margin' to account for margins on element
- *
- * @returns {number} Element height in pixels, accounting for any borders, etc.
- */
- elementHeight: function (elem) {
- },
- // Thanks to http://stackoverflow.com/a/13382873/888165
- getScrollbarWidth: function() {
- var outer = document.createElement("div");
- outer.style.visibility = "hidden";
- outer.style.width = "100px";
- outer.style.msOverflowStyle = "scrollbar"; // needed for WinJS apps
- document.body.appendChild(outer);
- var widthNoScroll = outer.offsetWidth;
- // force scrollbars
- outer.style.overflow = "scroll";
- // add innerdiv
- var inner = document.createElement("div");
- inner.style.width = "100%";
- outer.appendChild(inner);
- var widthWithScroll = inner.offsetWidth;
- // remove divs
- outer.parentNode.removeChild(outer);
- return widthNoScroll - widthWithScroll;
- },
- swap: function( elem, options, callback, args ) {
- var ret, name,
- old = {};
- // Remember the old values, and insert the new ones
- for ( name in options ) {
- old[ name ] = elem.style[ name ];
- elem.style[ name ] = options[ name ];
- }
- ret = callback.apply( elem, args || [] );
- // Revert the old values
- for ( name in options ) {
- elem.style[ name ] = old[ name ];
- }
- return ret;
- },
- fakeElement: function( elem, options, callback, args ) {
- var ret, name,
- newElement = angular.element(elem).clone()[0];
- for ( name in options ) {
- newElement.style[ name ] = options[ name ];
- }
- angular.element(document.body).append(newElement);
- ret = callback.call( newElement, newElement );
- angular.element(newElement).remove();
- return ret;
- },
- /**
- * @ngdoc method
- * @name normalizeWheelEvent
- * @methodOf ui.grid.service:GridUtil
- *
- * @param {event} event A mouse wheel event
- *
- * @returns {event} A normalized event
- *
- * @description
- * Given an event from this list:
- *
- * `wheel, mousewheel, DomMouseScroll, MozMousePixelScroll`
- *
- * "normalize" it
- * so that it stays consistent no matter what browser it comes from (i.e. scale it correctly and make sure the direction is right.)
- */
- normalizeWheelEvent: function (event) {
- // var toFix = ['wheel', 'mousewheel', 'DOMMouseScroll', 'MozMousePixelScroll'];
- // var toBind = 'onwheel' in document || document.documentMode >= 9 ? ['wheel'] : ['mousewheel', 'DomMouseScroll', 'MozMousePixelScroll'];
- var lowestDelta, lowestDeltaXY;
- var orgEvent = event || window.event,
- args = [].slice.call(arguments, 1),
- delta = 0,
- deltaX = 0,
- deltaY = 0,
- absDelta = 0,
- absDeltaXY = 0,
- fn;
- // event = $.event.fix(orgEvent);
- // event.type = 'mousewheel';
- // NOTE: jQuery masks the event and stores it in the event as originalEvent
- if (orgEvent.originalEvent) {
- orgEvent = orgEvent.originalEvent;
- }
- // Old school scrollwheel delta
- if ( orgEvent.wheelDelta ) { delta = orgEvent.wheelDelta; }
- if ( orgEvent.detail ) { delta = orgEvent.detail * -1; }
- // At a minimum, setup the deltaY to be delta
- deltaY = delta;
- // Firefox < 17 related to DOMMouseScroll event
- if ( orgEvent.axis !== undefined && orgEvent.axis === orgEvent.HORIZONTAL_AXIS ) {
- deltaY = 0;
- deltaX = delta * -1;
- }
- // New school wheel delta (wheel event)
- if ( orgEvent.deltaY ) {
- deltaY = orgEvent.deltaY * -1;
- delta = deltaY;
- }
- if ( orgEvent.deltaX ) {
- deltaX = orgEvent.deltaX;
- delta = deltaX * -1;
- }
- // Webkit
- if ( orgEvent.wheelDeltaY !== undefined ) { deltaY = orgEvent.wheelDeltaY; }
- if ( orgEvent.wheelDeltaX !== undefined ) { deltaX = orgEvent.wheelDeltaX; }
- // Look for lowest delta to normalize the delta values
- absDelta = Math.abs(delta);
- if ( !lowestDelta || absDelta < lowestDelta ) { lowestDelta = absDelta; }
- absDeltaXY = Math.max(Math.abs(deltaY), Math.abs(deltaX));
- if ( !lowestDeltaXY || absDeltaXY < lowestDeltaXY ) { lowestDeltaXY = absDeltaXY; }
- // Get a whole value for the deltas
- fn = delta > 0 ? 'floor' : 'ceil';
- delta = Math[fn](delta / lowestDelta);
- deltaX = Math[fn](deltaX / lowestDeltaXY);
- deltaY = Math[fn](deltaY / lowestDeltaXY);
- return {
- delta: delta,
- deltaX: deltaX,
- deltaY: deltaY
- };
- },
- // Stolen from Modernizr
- // TODO: make this, and everythign that flows from it, robust
- //http://www.stucox.com/blog/you-cant-detect-a-touchscreen/
- isTouchEnabled: function() {
- var bool;
- if (('ontouchstart' in $window) || $window.DocumentTouch && $document instanceof DocumentTouch) {
- bool = true;
- }
- return bool;
- },
- isNullOrUndefined: function(obj) {
- return (obj === undefined || obj === null);
- },
- endsWith: function(str, suffix) {
- if (!str || !suffix || typeof str !== "string") {
- return false;
- }
- return str.indexOf(suffix, str.length - suffix.length) !== -1;
- },
- arrayContainsObjectWithProperty: function(array, propertyName, propertyValue) {
- var found = false;
- angular.forEach(array, function (object) {
- if (object[propertyName] === propertyValue) {
- found = true;
- }
- });
- return found;
- },
- //// Shim requestAnimationFrame
- //requestAnimationFrame: $window.requestAnimationFrame && $window.requestAnimationFrame.bind($window) ||
- // $window.webkitRequestAnimationFrame && $window.webkitRequestAnimationFrame.bind($window) ||
- // function(fn) {
- // return $timeout(fn, 10, false);
- // },
- numericAndNullSort: function (a, b) {
- if (a === null) { return 1; }
- if (b === null) { return -1; }
- if (a === null && b === null) { return 0; }
- return a - b;
- },
- // Disable ngAnimate animations on an element
- disableAnimations: function (element) {
- var $animate;
- try {
- $animate = $injector.get('$animate');
- // See: http://brianhann.com/angular-1-4-breaking-changes-to-be-aware-of/#animate
- if (angular.version.major > 1 || (angular.version.major === 1 && angular.version.minor >= 4)) {
- $animate.enabled(element, false);
- } else {
- $animate.enabled(false, element);
- }
- }
- catch (e) {}
- },
- enableAnimations: function (element) {
- var $animate;
- try {
- $animate = $injector.get('$animate');
- // See: http://brianhann.com/angular-1-4-breaking-changes-to-be-aware-of/#animate
- if (angular.version.major > 1 || (angular.version.major === 1 && angular.version.minor >= 4)) {
- $animate.enabled(element, true);
- } else {
- $animate.enabled(true, element);
- }
- return $animate;
- }
- catch (e) {}
- },
- // Blatantly stolen from Angular as it isn't exposed (yet)
- nextUid: function nextUid() {
- var index = uid.length;
- var digit;
- while (index) {
- index--;
- digit = uid[index].charCodeAt(0);
- if (digit === 57 /*'9'*/) {
- uid[index] = 'A';
- return uidPrefix + uid.join('');
- }
- if (digit === 90 /*'Z'*/) {
- uid[index] = '0';
- } else {
- uid[index] = String.fromCharCode(digit + 1);
- return uidPrefix + uid.join('');
- }
- }
- uid.unshift('0');
- return uidPrefix + uid.join('');
- },
- // Blatantly stolen from Angular as it isn't exposed (yet)
- hashKey: function hashKey(obj) {
- var objType = typeof obj,
- key;
- if (objType === 'object' && obj !== null) {
- if (typeof (key = obj.$$hashKey) === 'function') {
- // must invoke on object to keep the right this
- key = obj.$$hashKey();
- }
- else if (typeof(obj.$$hashKey) !== 'undefined' && obj.$$hashKey) {
- key = obj.$$hashKey;
- }
- else if (key === undefined) {
- key = obj.$$hashKey = s.nextUid();
- }
- }
- else {
- key = obj;
- }
- return objType + ':' + key;
- },
- resetUids: function () {
- uid = ['0', '0', '0'];
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:GridUtil
- * @name logError
- * @description wraps the $log method, allowing us to choose different
- * treatment within ui-grid if we so desired. At present we only log
- * error messages if uiGridConstants.LOG_ERROR_MESSAGES is set to true
- * @param {string} logMessage message to be logged to the console
- *
- */
- logError: function( logMessage ){
- if ( uiGridConstants.LOG_ERROR_MESSAGES ){
- $log.error( logMessage );
- }
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:GridUtil
- * @name logWarn
- * @description wraps the $log method, allowing us to choose different
- * treatment within ui-grid if we so desired. At present we only log
- * warning messages if uiGridConstants.LOG_WARN_MESSAGES is set to true
- * @param {string} logMessage message to be logged to the console
- *
- */
- logWarn: function( logMessage ){
- if ( uiGridConstants.LOG_WARN_MESSAGES ){
- $log.warn( logMessage );
- }
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:GridUtil
- * @name logDebug
- * @description wraps the $log method, allowing us to choose different
- * treatment within ui-grid if we so desired. At present we only log
- * debug messages if uiGridConstants.LOG_DEBUG_MESSAGES is set to true
- *
- */
- logDebug: function() {
- if ( uiGridConstants.LOG_DEBUG_MESSAGES ){
- $log.debug.apply($log, arguments);
- }
- }
- };
- /**
- * @ngdoc object
- * @name focus
- * @propertyOf ui.grid.service:GridUtil
- * @description Provies a set of methods to set the document focus inside the grid.
- * See {@link ui.grid.service:GridUtil.focus} for more information.
- */
- /**
- * @ngdoc object
- * @name ui.grid.service:GridUtil.focus
- * @description Provies a set of methods to set the document focus inside the grid.
- * Timeouts are utilized to ensure that the focus is invoked after any other event has been triggered.
- * e.g. click events that need to run before the focus or
- * inputs elements that are in a disabled state but are enabled when those events
- * are triggered.
- */
- s.focus = {
- queue: [],
- //http://stackoverflow.com/questions/25596399/set-element-focus-in-angular-way
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:GridUtil.focus
- * @name byId
- * @description Sets the focus of the document to the given id value.
- * If provided with the grid object it will automatically append the grid id.
- * This is done to encourage unique dom id's as it allows for multiple grids on a
- * page.
- * @param {String} id the id of the dom element to set the focus on
- * @param {Object=} Grid the grid object for this grid instance. See: {@link ui.grid.class:Grid}
- * @param {Number} Grid.id the unique id for this grid. Already set on an initialized grid object.
- * @returns {Promise} The `$timeout` promise that will be resolved once focus is set. If another focus is requested before this request is evaluated.
- * then the promise will fail with the `'canceled'` reason.
- */
- byId: function (id, Grid) {
- this._purgeQueue();
- var promise = $timeout(function() {
- var elementID = (Grid && Grid.id ? Grid.id + '-' : '') + id;
- var element = $window.document.getElementById(elementID);
- if (element) {
- element.focus();
- } else {
- s.logWarn('[focus.byId] Element id ' + elementID + ' was not found.');
- }
- }, 0, false);
- this.queue.push(promise);
- return promise;
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:GridUtil.focus
- * @name byElement
- * @description Sets the focus of the document to the given dom element.
- * @param {(element|angular.element)} element the DOM element to set the focus on
- * @returns {Promise} The `$timeout` promise that will be resolved once focus is set. If another focus is requested before this request is evaluated.
- * then the promise will fail with the `'canceled'` reason.
- */
- byElement: function(element){
- if (!angular.isElement(element)){
- s.logWarn("Trying to focus on an element that isn\'t an element.");
- return $q.reject('not-element');
- }
- element = angular.element(element);
- this._purgeQueue();
- var promise = $timeout(function(){
- if (element){
- element[0].focus();
- }
- }, 0, false);
- this.queue.push(promise);
- return promise;
- },
- /**
- * @ngdoc method
- * @methodOf ui.grid.service:GridUtil.focus
- * @name bySelector
- * @description Sets the focus of the document to the given dom element.
- * @param {(element|angular.element)} parentElement the parent/ancestor of the dom element that you are selecting using the query selector
- * @param {String} querySelector finds the dom element using the {@link http://www.w3schools.com/jsref/met_document_queryselector.asp querySelector}
- * @param {boolean} [aSync=false] If true then the selector will be querried inside of a timeout. Otherwise the selector will be querried imidately
- * then the focus will be called.
- * @returns {Promise} The `$timeout` promise that will be resolved once focus is set. If another focus is requested before this request is evaluated.
- * then the promise will fail with the `'canceled'` reason.
- */
- bySelector: function(parentElement, querySelector, aSync){
- var self = this;
- if (!angular.isElement(parentElement)){
- throw new Error("The parent element is not an element.");
- }
- // Ensure that this is an angular element.
- // It is fine if this is already an angular element.
- parentElement = angular.element(parentElement);
- var focusBySelector = function(){
- var element = parentElement[0].querySelector(querySelector);
- return self.byElement(element);
- };
- this._purgeQueue();
- if (aSync){ //Do this asynchronysly
- var promise = $timeout(focusBySelector, 0, false);
- this.queue.push(promise);
- return promise;
- } else {
- return focusBySelector();
- }
- },
- _purgeQueue: function(){
- this.queue.forEach(function(element){
- $timeout.cancel(element);
- });
- this.queue = [];
- }
- };
- ['width', 'height'].forEach(function (name) {
- var capsName = angular.uppercase(name.charAt(0)) + name.substr(1);
- s['element' + capsName] = function (elem, extra) {
- var e = elem;
- if (e && typeof(e.length) !== 'undefined' && e.length) {
- e = elem[0];
- }
- if (e && e !== null) {
- var styles = getStyles(e);
- return e.offsetWidth === 0 && rdisplayswap.test(styles.display) ?
- s.swap(e, cssShow, function() {
- return getWidthOrHeight(e, name, extra );
- }) :
- getWidthOrHeight( e, name, extra );
- }
- else {
- return null;
- }
- };
- s['outerElement' + capsName] = function (elem, margin) {
- return elem ? s['element' + capsName].call(this, elem, margin ? 'margin' : 'border') : null;
- };
- });
- // http://stackoverflow.com/a/24107550/888165
- s.closestElm = function closestElm(el, selector) {
- if (typeof(el.length) !== 'undefined' && el.length) {
- el = el[0];
- }
- var matchesFn;
- // find vendor prefix
- ['matches','webkitMatchesSelector','mozMatchesSelector','msMatchesSelector','oMatchesSelector'].some(function(fn) {
- if (typeof document.body[fn] === 'function') {
- matchesFn = fn;
- return true;
- }
- return false;
- });
- // traverse parents
- var parent;
- while (el !== null) {
- parent = el.parentElement;
- if (parent !== null && parent[matchesFn](selector)) {
- return parent;
- }
- el = parent;
- }
- return null;
- };
- s.type = function (obj) {
- var text = Function.prototype.toString.call(obj.constructor);
- return text.match(/function (.*?)\(/)[1];
- };
- s.getBorderSize = function getBorderSize(elem, borderType) {
- if (typeof(elem.length) !== 'undefined' && elem.length) {
- elem = elem[0];
- }
- var styles = getStyles(elem);
- // If a specific border is supplied, like 'top', read the 'borderTop' style property
- if (borderType) {
- borderType = 'border' + borderType.charAt(0).toUpperCase() + borderType.slice(1);
- }
- else {
- borderType = 'border';
- }
- borderType += 'Width';
- var val = parseInt(styles[borderType], 10);
- if (isNaN(val)) {
- return 0;
- }
- else {
- return val;
- }
- };
- // http://stackoverflow.com/a/22948274/888165
- // TODO: Opera? Mobile?
- s.detectBrowser = function detectBrowser() {
- var userAgent = $window.navigator.userAgent;
- var browsers = {chrome: /chrome/i, safari: /safari/i, firefox: /firefox/i, ie: /internet explorer|trident\//i};
- for (var key in browsers) {
- if (browsers[key].test(userAgent)) {
- return key;
- }
- }
- return 'unknown';
- };
- // Borrowed from https://github.com/othree/jquery.rtl-scroll-type
- // Determine the scroll "type" this browser is using for RTL
- s.rtlScrollType = function rtlScrollType() {
- if (rtlScrollType.type) {
- return rtlScrollType.type;
- }
- var definer = angular.element('<div dir="rtl" style="font-size: 14px; width: 1px; height: 1px; position: absolute; top: -1000px; overflow: scroll">A</div>')[0],
- type = 'reverse';
- document.body.appendChild(definer);
- if (definer.scrollLeft > 0) {
- type = 'default';
- }
- else {
- definer.scrollLeft = 1;
- if (definer.scrollLeft === 0) {
- type = 'negative';
- }
- }
- angular.element(definer).remove();
- rtlScrollType.type = type;
- return type;
- };
- /**
- * @ngdoc method
- * @name normalizeScrollLeft
- * @methodOf ui.grid.service:GridUtil
- *
- * @param {element} element The element to get the `scrollLeft` from.
- * @param {grid} grid - grid used to normalize (uses the rtl property)
- *
- * @returns {number} A normalized scrollLeft value for the current browser.
- *
- * @description
- * Browsers currently handle RTL in different ways, resulting in inconsistent scrollLeft values. This method normalizes them
- */
- s.normalizeScrollLeft = function normalizeScrollLeft(element, grid) {
- if (typeof(element.length) !== 'undefined' && element.length) {
- element = element[0];
- }
- var scrollLeft = element.scrollLeft;
- if (grid.isRTL()) {
- switch (s.rtlScrollType()) {
- case 'default':
- return element.scrollWidth - scrollLeft - element.clientWidth;
- case 'negative':
- return Math.abs(scrollLeft);
- case 'reverse':
- return scrollLeft;
- }
- }
- return scrollLeft;
- };
- /**
- * @ngdoc method
- * @name denormalizeScrollLeft
- * @methodOf ui.grid.service:GridUtil
- *
- * @param {element} element The element to normalize the `scrollLeft` value for
- * @param {number} scrollLeft The `scrollLeft` value to denormalize.
- * @param {grid} grid The grid that owns the scroll event.
- *
- * @returns {number} A normalized scrollLeft value for the current browser.
- *
- * @description
- * Browsers currently handle RTL in different ways, resulting in inconsistent scrollLeft values. This method denormalizes a value for the current browser.
- */
- s.denormalizeScrollLeft = function denormalizeScrollLeft(element, scrollLeft, grid) {
- if (typeof(element.length) !== 'undefined' && element.length) {
- element = element[0];
- }
- if (grid.isRTL()) {
- switch (s.rtlScrollType()) {
- case 'default':
- // Get the max scroll for the element
- var maxScrollLeft = element.scrollWidth - element.clientWidth;
- // Subtract the current scroll amount from the max scroll
- return maxScrollLeft - scrollLeft;
- case 'negative':
- return scrollLeft * -1;
- case 'reverse':
- return scrollLeft;
- }
- }
- return scrollLeft;
- };
- /**
- * @ngdoc method
- * @name preEval
- * @methodOf ui.grid.service:GridUtil
- *
- * @param {string} path Path to evaluate
- *
- * @returns {string} A path that is normalized.
- *
- * @description
- * Takes a field path and converts it to bracket notation to allow for special characters in path
- * @example
- * <pre>
- * gridUtil.preEval('property') == 'property'
- * gridUtil.preEval('nested.deep.prop-erty') = "nested['deep']['prop-erty']"
- * </pre>
- */
- s.preEval = function (path) {
- var m = uiGridConstants.BRACKET_REGEXP.exec(path);
- if (m) {
- return (m[1] ? s.preEval(m[1]) : m[1]) + m[2] + (m[3] ? s.preEval(m[3]) : m[3]);
- } else {
- path = path.replace(uiGridConstants.APOS_REGEXP, '\\\'');
- var parts = path.split(uiGridConstants.DOT_REGEXP);
- var preparsed = [parts.shift()]; // first item must be var notation, thus skip
- angular.forEach(parts, function (part) {
- preparsed.push(part.replace(uiGridConstants.FUNC_REGEXP, '\']$1'));
- });
- return preparsed.join('[\'');
- }
- };
- /**
- * @ngdoc method
- * @name debounce
- * @methodOf ui.grid.service:GridUtil
- *
- * @param {function} func function to debounce
- * @param {number} wait milliseconds to delay
- * @param {boolean} immediate execute before delay
- *
- * @returns {function} A function that can be executed as debounced function
- *
- * @description
- * Copied from https://github.com/shahata/angular-debounce
- * Takes a function, decorates it to execute only 1 time after multiple calls, and returns the decorated function
- * @example
- * <pre>
- * var debouncedFunc = gridUtil.debounce(function(){alert('debounced');}, 500);
- * debouncedFunc();
- * debouncedFunc();
- * debouncedFunc();
- * </pre>
- */
- s.debounce = function (func, wait, immediate) {
- var timeout, args, context, result;
- function debounce() {
- /* jshint validthis:true */
- context = this;
- args = arguments;
- var later = function () {
- timeout = null;
- if (!immediate) {
- result = func.apply(context, args);
- }
- };
- var callNow = immediate && !timeout;
- if (timeout) {
- $timeout.cancel(timeout);
- }
- timeout = $timeout(later, wait, false);
- if (callNow) {
- result = func.apply(context, args);
- }
- return result;
- }
- debounce.cancel = function () {
- $timeout.cancel(timeout);
- timeout = null;
- };
- return debounce;
- };
- /**
- * @ngdoc method
- * @name throttle
- * @methodOf ui.grid.service:GridUtil
- *
- * @param {function} func function to throttle
- * @param {number} wait milliseconds to delay after first trigger
- * @param {Object} params to use in throttle.
- *
- * @returns {function} A function that can be executed as throttled function
- *
- * @description
- * Adapted from debounce function (above)
- * Potential keys for Params Object are:
- * trailing (bool) - whether to trigger after throttle time ends if called multiple times
- * Updated to use $interval rather than $timeout, as protractor (e2e tests) is able to work with $interval,
- * but not with $timeout
- *
- * Note that when using throttle, you need to use throttle to create a new function upfront, then use the function
- * return from that call each time you need to call throttle. If you call throttle itself repeatedly, the lastCall
- * variable will get overwritten and the throttling won't work
- *
- * @example
- * <pre>
- * var throttledFunc = gridUtil.throttle(function(){console.log('throttled');}, 500, {trailing: true});
- * throttledFunc(); //=> logs throttled
- * throttledFunc(); //=> queues attempt to log throttled for ~500ms (since trailing param is truthy)
- * throttledFunc(); //=> updates arguments to keep most-recent request, but does not do anything else.
- * </pre>
- */
- s.throttle = function(func, wait, options){
- options = options || {};
- var lastCall = 0, queued = null, context, args;
- function runFunc(endDate){
- lastCall = +new Date();
- func.apply(context, args);
- $interval(function(){queued = null; }, 0, 1, false);
- }
- return function(){
- /* jshint validthis:true */
- context = this;
- args = arguments;
- if (queued === null){
- var sinceLast = +new Date() - lastCall;
- if (sinceLast > wait){
- runFunc();
- }
- else if (options.trailing){
- queued = $interval(runFunc, wait - sinceLast, 1, false);
- }
- }
- };
- };
- s.on = {};
- s.off = {};
- s._events = {};
- s.addOff = function (eventName) {
- s.off[eventName] = function (elm, fn) {
- var idx = s._events[eventName].indexOf(fn);
- if (idx > 0) {
- s._events[eventName].removeAt(idx);
- }
- };
- };
- var mouseWheeltoBind = ( 'onwheel' in document || document.documentMode >= 9 ) ? ['wheel'] : ['mousewheel', 'DomMouseScroll', 'MozMousePixelScroll'],
- nullLowestDeltaTimeout,
- lowestDelta;
- s.on.mousewheel = function (elm, fn) {
- if (!elm || !fn) { return; }
- var $elm = angular.element(elm);
- // Store the line height and page height for this particular element
- $elm.data('mousewheel-line-height', getLineHeight($elm));
- $elm.data('mousewheel-page-height', s.elementHeight($elm));
- if (!$elm.data('mousewheel-callbacks')) { $elm.data('mousewheel-callbacks', {}); }
- var cbs = $elm.data('mousewheel-callbacks');
- cbs[fn] = (Function.prototype.bind || bindPolyfill).call(mousewheelHandler, $elm[0], fn);
- // Bind all the mousew heel events
- for ( var i = mouseWheeltoBind.length; i; ) {
- $elm.on(mouseWheeltoBind[--i], cbs[fn]);
- }
- $elm.on('$destroy', function unbindEvents() {
- for ( var i = mouseWheeltoBind.length; i; ) {
- $elm.off(mouseWheeltoBind[--i], cbs[fn]);
- }
- });
- };
- s.off.mousewheel = function (elm, fn) {
- var $elm = angular.element(elm);
- var cbs = $elm.data('mousewheel-callbacks');
- var handler = cbs[fn];
- if (handler) {
- for ( var i = mouseWheeltoBind.length; i; ) {
- $elm.off(mouseWheeltoBind[--i], handler);
- }
- }
- delete cbs[fn];
- if (Object.keys(cbs).length === 0) {
- $elm.removeData('mousewheel-line-height');
- $elm.removeData('mousewheel-page-height');
- $elm.removeData('mousewheel-callbacks');
- }
- };
- function mousewheelHandler(fn, event) {
- var $elm = angular.element(this);
- var delta = 0,
- deltaX = 0,
- deltaY = 0,
- absDelta = 0,
- offsetX = 0,
- offsetY = 0;
- // jQuery masks events
- if (event.originalEvent) { event = event.originalEvent; }
- if ( 'detail' in event ) { deltaY = event.detail * -1; }
- if ( 'wheelDelta' in event ) { deltaY = event.wheelDelta; }
- if ( 'wheelDeltaY' in event ) { deltaY = event.wheelDeltaY; }
- if ( 'wheelDeltaX' in event ) { deltaX = event.wheelDeltaX * -1; }
- // Firefox < 17 horizontal scrolling related to DOMMouseScroll event
- if ( 'axis' in event && event.axis === event.HORIZONTAL_AXIS ) {
- deltaX = deltaY * -1;
- deltaY = 0;
- }
- // Set delta to be deltaY or deltaX if deltaY is 0 for backwards compatabilitiy
- delta = deltaY === 0 ? deltaX : deltaY;
- // New school wheel delta (wheel event)
- if ( 'deltaY' in event ) {
- deltaY = event.deltaY * -1;
- delta = deltaY;
- }
- if ( 'deltaX' in event ) {
- deltaX = event.deltaX;
- if ( deltaY === 0 ) { delta = deltaX * -1; }
- }
- // No change actually happened, no reason to go any further
- if ( deltaY === 0 && deltaX === 0 ) { return; }
- // Need to convert lines and pages to pixels if we aren't already in pixels
- // There are three delta modes:
- // * deltaMode 0 is by pixels, nothing to do
- // * deltaMode 1 is by lines
- // * deltaMode 2 is by pages
- if ( event.deltaMode === 1 ) {
- var lineHeight = $elm.data('mousewheel-line-height');
- delta *= lineHeight;
- deltaY *= lineHeight;
- deltaX *= lineHeight;
- }
- else if ( event.deltaMode === 2 ) {
- var pageHeight = $elm.data('mousewheel-page-height');
- delta *= pageHeight;
- deltaY *= pageHeight;
- deltaX *= pageHeight;
- }
- // Store lowest absolute delta to normalize the delta values
- absDelta = Math.max( Math.abs(deltaY), Math.abs(deltaX) );
- if ( !lowestDelta || absDelta < lowestDelta ) {
- lowestDelta = absDelta;
- // Adjust older deltas if necessary
- if ( shouldAdjustOldDeltas(event, absDelta) ) {
- lowestDelta /= 40;
- }
- }
- // Get a whole, normalized value for the deltas
- delta = Math[ delta >= 1 ? 'floor' : 'ceil' ](delta / lowestDelta);
- deltaX = Math[ deltaX >= 1 ? 'floor' : 'ceil' ](deltaX / lowestDelta);
- deltaY = Math[ deltaY >= 1 ? 'floor' : 'ceil' ](deltaY / lowestDelta);
- // Normalise offsetX and offsetY properties
- // if ($elm[0].getBoundingClientRect ) {
- // var boundingRect = $(elm)[0].getBoundingClientRect();
- // offsetX = event.clientX - boundingRect.left;
- // offsetY = event.clientY - boundingRect.top;
- // }
- // event.deltaX = deltaX;
- // event.deltaY = deltaY;
- // event.deltaFactor = lowestDelta;
- var newEvent = {
- originalEvent: event,
- deltaX: deltaX,
- deltaY: deltaY,
- deltaFactor: lowestDelta,
- preventDefault: function () { event.preventDefault(); },
- stopPropagation: function () { event.stopPropagation(); }
- };
- // Clearout lowestDelta after sometime to better
- // handle multiple device types that give
- // a different lowestDelta
- // Ex: trackpad = 3 and mouse wheel = 120
- if (nullLowestDeltaTimeout) { clearTimeout(nullLowestDeltaTimeout); }
- nullLowestDeltaTimeout = setTimeout(nullLowestDelta, 200);
- fn.call($elm[0], newEvent);
- }
- function nullLowestDelta() {
- lowestDelta = null;
- }
- function shouldAdjustOldDeltas(orgEvent, absDelta) {
- // If this is an older event and the delta is divisable by 120,
- // then we are assuming that the browser is treating this as an
- // older mouse wheel event and that we should divide the deltas
- // by 40 to try and get a more usable deltaFactor.
- // Side note, this actually impacts the reported scroll distance
- // in older browsers and can cause scrolling to be slower than native.
- // Turn this off by setting $.event.special.mousewheel.settings.adjustOldDeltas to false.
- return orgEvent.type === 'mousewheel' && absDelta % 120 === 0;
- }
- return s;
- }]);
- // Add 'px' to the end of a number string if it doesn't have it already
- module.filter('px', function() {
- return function(str) {
- if (str.match(/^[\d\.]+$/)) {
- return str + 'px';
- }
- else {
- return str;
- }
- };
- });
- })();
- /**
- * @ngdoc overview
- * @name ui.grid.i18n
- * @description
- *
- * # ui.grid.i18n
- * This module provides i18n functions to ui.grid and any application that wants to use it
- *
- * <div doc-module-components="ui.grid.i18n"></div>
- */
- (function () {
- var DIRECTIVE_ALIASES = ['uiT', 'uiTranslate'];
- var FILTER_ALIASES = ['t', 'uiTranslate'];
- var module = angular.module('ui.grid.i18n');
- /**
- * @ngdoc object
- * @name ui.grid.i18n.constant:i18nConstants
- *
- * @description constants available in i18n module
- */
- module.constant('i18nConstants', {
- MISSING: '[MISSING]',
- UPDATE_EVENT: '$uiI18n',
- LOCALE_DIRECTIVE_ALIAS: 'uiI18n',
- // default to english
- DEFAULT_LANG: 'en'
- });
- // module.config(['$provide', function($provide) {
- // $provide.decorator('i18nService', ['$delegate', function($delegate) {}])}]);
- /**
- * @ngdoc service
- * @name ui.grid.i18n.service:i18nService
- *
- * @description Services for i18n
- */
- module.service('i18nService', ['$log', 'i18nConstants', '$rootScope',
- function ($log, i18nConstants, $rootScope) {
- var langCache = {
- _langs: {},
- current: null,
- get: function (lang) {
- return this._langs[lang.toLowerCase()];
- },
- add: function (lang, strings) {
- var lower = lang.toLowerCase();
- if (!this._langs[lower]) {
- this._langs[lower] = {};
- }
- angular.extend(this._langs[lower], strings);
- },
- getAllLangs: function () {
- var langs = [];
- if (!this._langs) {
- return langs;
- }
- for (var key in this._langs) {
- langs.push(key);
- }
- return langs;
- },
- setCurrent: function (lang) {
- this.current = lang.toLowerCase();
- },
- getCurrentLang: function () {
- return this.current;
- }
- };
- var service = {
- /**
- * @ngdoc service
- * @name add
- * @methodOf ui.grid.i18n.service:i18nService
- * @description Adds the languages and strings to the cache. Decorate this service to
- * add more translation strings
- * @param {string} lang language to add
- * @param {object} stringMaps of strings to add grouped by property names
- * @example
- * <pre>
- * i18nService.add('en', {
- * aggregate: {
- * label1: 'items',
- * label2: 'some more items'
- * }
- * },
- * groupPanel: {
- * description: 'Drag a column header here and drop it to group by that column.'
- * }
- * }
- * </pre>
- */
- add: function (langs, stringMaps) {
- if (typeof(langs) === 'object') {
- angular.forEach(langs, function (lang) {
- if (lang) {
- langCache.add(lang, stringMaps);
- }
- });
- } else {
- langCache.add(langs, stringMaps);
- }
- },
- /**
- * @ngdoc service
- * @name getAllLangs
- * @methodOf ui.grid.i18n.service:i18nService
- * @description return all currently loaded languages
- * @returns {array} string
- */
- getAllLangs: function () {
- return langCache.getAllLangs();
- },
- /**
- * @ngdoc service
- * @name get
- * @methodOf ui.grid.i18n.service:i18nService
- * @description return all currently loaded languages
- * @param {string} lang to return. If not specified, returns current language
- * @returns {object} the translation string maps for the language
- */
- get: function (lang) {
- var language = lang ? lang : service.getCurrentLang();
- return langCache.get(language);
- },
- /**
- * @ngdoc service
- * @name getSafeText
- * @methodOf ui.grid.i18n.service:i18nService
- * @description returns the text specified in the path or a Missing text if text is not found
- * @param {String} path property path to use for retrieving text from string map
- * @param {String} [lang] to return. If not specified, returns current language
- * @returns {object} the translation for the path
- * @example
- * <pre>
- * i18nService.getSafeText('sort.ascending')
- * </pre>
- */
- getSafeText: function (path, lang) {
- var language = lang || service.getCurrentLang();
- var trans = langCache.get(language);
- if (!trans) {
- return i18nConstants.MISSING;
- }
- var paths = path.split('.');
- var current = trans;
- for (var i = 0; i < paths.length; ++i) {
- if (current[paths[i]] === undefined || current[paths[i]] === null) {
- return i18nConstants.MISSING;
- } else {
- current = current[paths[i]];
- }
- }
- return current;
- },
- /**
- * @ngdoc service
- * @name setCurrentLang
- * @methodOf ui.grid.i18n.service:i18nService
- * @description sets the current language to use in the application
- * $broadcasts the i18nConstants.UPDATE_EVENT on the $rootScope
- * @param {string} lang to set
- * @example
- * <pre>
- * i18nService.setCurrentLang('fr');
- * </pre>
- */
- setCurrentLang: function (lang) {
- if (lang) {
- langCache.setCurrent(lang);
- $rootScope.$broadcast(i18nConstants.UPDATE_EVENT);
- }
- },
- /**
- * @ngdoc service
- * @name getCurrentLang
- * @methodOf ui.grid.i18n.service:i18nService
- * @description returns the current language used in the application
- */
- getCurrentLang: function () {
- var lang = langCache.getCurrentLang();
- if (!lang) {
- lang = i18nConstants.DEFAULT_LANG;
- langCache.setCurrent(lang);
- }
- return lang;
- }
- };
- return service;
- }]);
- var localeDirective = function (i18nService, i18nConstants) {
- return {
- compile: function () {
- return {
- pre: function ($scope, $elm, $attrs) {
- var alias = i18nConstants.LOCALE_DIRECTIVE_ALIAS;
- // check for watchable property
- var lang = $scope.$eval($attrs[alias]);
- if (lang) {
- $scope.$watch($attrs[alias], function () {
- i18nService.setCurrentLang(lang);
- });
- } else if ($attrs.$$observers) {
- $attrs.$observe(alias, function () {
- i18nService.setCurrentLang($attrs[alias] || i18nConstants.DEFAULT_LANG);
- });
- }
- }
- };
- }
- };
- };
- module.directive('uiI18n', ['i18nService', 'i18nConstants', localeDirective]);
- // directive syntax
- var uitDirective = function ($parse, i18nService, i18nConstants) {
- return {
- restrict: 'EA',
- compile: function () {
- return {
- pre: function ($scope, $elm, $attrs) {
- var alias1 = DIRECTIVE_ALIASES[0],
- alias2 = DIRECTIVE_ALIASES[1];
- var token = $attrs[alias1] || $attrs[alias2] || $elm.html();
- var missing = i18nConstants.MISSING + token;
- var observer;
- if ($attrs.$$observers) {
- var prop = $attrs[alias1] ? alias1 : alias2;
- observer = $attrs.$observe(prop, function (result) {
- if (result) {
- $elm.html($parse(result)(i18nService.getCurrentLang()) || missing);
- }
- });
- }
- var getter = $parse(token);
- var listener = $scope.$on(i18nConstants.UPDATE_EVENT, function (evt) {
- if (observer) {
- observer($attrs[alias1] || $attrs[alias2]);
- } else {
- // set text based on i18n current language
- $elm.html(getter(i18nService.get()) || missing);
- }
- });
- $scope.$on('$destroy', listener);
- $elm.html(getter(i18nService.get()) || missing);
- }
- };
- }
- };
- };
- angular.forEach( DIRECTIVE_ALIASES, function ( alias ) {
- module.directive( alias, ['$parse', 'i18nService', 'i18nConstants', uitDirective] );
- } );
- // optional filter syntax
- var uitFilter = function ($parse, i18nService, i18nConstants) {
- return function (data) {
- var getter = $parse(data);
- // set text based on i18n current language
- return getter(i18nService.get()) || i18nConstants.MISSING + data;
- };
- };
- angular.forEach( FILTER_ALIASES, function ( alias ) {
- module.filter( alias, ['$parse', 'i18nService', 'i18nConstants', uitFilter] );
- } );
- })();
- (function () {
- angular.module('ui.grid').config(['$provide', function($provide) {
- $provide.decorator('i18nService', ['$delegate', function($delegate) {
- $delegate.add('en', {
- headerCell: {
- aria: {
- defaultFilterLabel: 'Filter for column',
- removeFilter: 'Remove Filter',
- columnMenuButtonLabel: 'Column Menu',
- column: 'Column'
- },
- priority: 'Priority:',
- filterLabel: "Filter for column: "
- },
- aggregate: {
- label: 'items'
- },
- groupPanel: {
- description: 'Drag a column header here and drop it to group by that column.'
- },
- search: {
- aria: {
- selected: 'Row selected',
- notSelected: 'Row not selected'
- },
- placeholder: 'Search...',
- showingItems: 'Showing Items:',
- selectedItems: 'Selected Items:',
- totalItems: 'Total Items:',
- size: 'Page Size:',
- first: 'First Page',
- next: 'Next Page',
- previous: 'Previous Page',
- last: 'Last Page'
- },
- menu: {
- text: 'Choose Columns:'
- },
- sort: {
- ascending: 'Sort Ascending',
- descending: 'Sort Descending',
- none: 'Sort None',
- remove: 'Remove Sort'
- },
- column: {
- hide: 'Hide Column'
- },
- aggregation: {
- count: 'total rows: ',
- sum: 'total: ',
- avg: 'avg: ',
- min: 'min: ',
- max: 'max: '
- },
- pinning: {
- pinLeft: 'Pin Left',
- pinRight: 'Pin Right',
- unpin: 'Unpin'
- },
- columnMenu: {
- close: 'Close'
- },
- gridMenu: {
- aria: {
- buttonLabel: 'Grid Menu'
- },
- columns: 'Columns:',
- importerTitle: 'Import file',
- exporterAllAsCsv: 'Export all data as csv',
- exporterVisibleAsCsv: 'Export visible data as csv',
- exporterSelectedAsCsv: 'Export selected data as csv',
- exporterAllAsPdf: 'Export all data as pdf',
- exporterVisibleAsPdf: 'Export visible data as pdf',
- exporterSelectedAsPdf: 'Export selected data as pdf',
- exporterAllAsExcel: 'Export all data as excel',
- exporterVisibleAsExcel: 'Export visible data as excel',
- exporterSelectedAsExcel: 'Export selected data as excel',
- clearAllFilters: 'Clear all filters'
- },
- importer: {
- noHeaders: 'Column names were unable to be derived, does the file have a header?',
- noObjects: 'Objects were not able to be derived, was there data in the file other than headers?',
- invalidCsv: 'File was unable to be processed, is it valid CSV?',
- invalidJson: 'File was unable to be processed, is it valid Json?',
- jsonNotArray: 'Imported json file must contain an array, aborting.'
- },
- pagination: {
- aria: {
- pageToFirst: 'Page to first',
- pageBack: 'Page back',
- pageSelected: 'Selected page',
- pageForward: 'Page forward',
- pageToLast: 'Page to last'
- },
- sizes: 'items per page',
- totalItems: 'items',
- through: 'through',
- of: 'of'
- },
- grouping: {
- group: 'Group',
- ungroup: 'Ungroup',
- aggregate_count: 'Agg: Count',
- aggregate_sum: 'Agg: Sum',
- aggregate_max: 'Agg: Max',
- aggregate_min: 'Agg: Min',
- aggregate_avg: 'Agg: Avg',
- aggregate_remove: 'Agg: Remove'
- },
- validate: {
- error: 'Error:',
- minLength: 'Value should be at least THRESHOLD characters long.',
- maxLength: 'Value should be at most THRESHOLD characters long.',
- required: 'A value is needed.'
- }
- });
- return $delegate;
- }]);
- }]);
- })();
- angular.module('ui.grid').run(['$templateCache', function($templateCache) {
- 'use strict';
- $templateCache.put('ui-grid/ui-grid-filter',
- "<div class=\"ui-grid-filter-container\" ng-style=\"col.extraStyle\" ng-repeat=\"colFilter in col.filters\" ng-class=\"{'ui-grid-filter-cancel-button-hidden' : colFilter.disableCancelFilterButton === true }\"><div ng-if=\"colFilter.type !== 'select'\"><input type=\"text\" class=\"ui-grid-filter-input ui-grid-filter-input-{{$index}}\" ng-model=\"colFilter.term\" ng-attr-placeholder=\"{{colFilter.placeholder || ''}}\" aria-label=\"{{colFilter.ariaLabel || aria.defaultFilterLabel}}\"><div role=\"button\" class=\"ui-grid-filter-button\" ng-click=\"removeFilter(colFilter, $index)\" ng-if=\"!colFilter.disableCancelFilterButton\" ng-disabled=\"colFilter.term === undefined || colFilter.term === null || colFilter.term === ''\" ng-show=\"colFilter.term !== undefined && colFilter.term !== null && colFilter.term !== ''\"><i class=\"ui-grid-icon-cancel\" ui-grid-one-bind-aria-label=\"aria.removeFilter\"> </i></div></div><div ng-if=\"colFilter.type === 'select'\"><select class=\"ui-grid-filter-select ui-grid-filter-input-{{$index}}\" ng-model=\"colFilter.term\" ng-show=\"colFilter.selectOptions.length > 0\" ng-attr-placeholder=\"{{colFilter.placeholder || aria.defaultFilterLabel}}\" aria-label=\"{{colFilter.ariaLabel || ''}}\" ng-options=\"option.value as option.label for option in colFilter.selectOptions\"><option value=\"\"></option></select><div role=\"button\" class=\"ui-grid-filter-button-select\" ng-click=\"removeFilter(colFilter, $index)\" ng-if=\"!colFilter.disableCancelFilterButton\" ng-disabled=\"colFilter.term === undefined || colFilter.term === null || colFilter.term === ''\" ng-show=\"colFilter.term !== undefined && colFilter.term != null\"><i class=\"ui-grid-icon-cancel\" ui-grid-one-bind-aria-label=\"aria.removeFilter\"> </i></div></div></div>"
- );
- $templateCache.put('ui-grid/ui-grid-footer',
- "<div class=\"ui-grid-footer-panel ui-grid-footer-aggregates-row\"><!-- tfooter --><div class=\"ui-grid-footer ui-grid-footer-viewport\"><div class=\"ui-grid-footer-canvas\"><div class=\"ui-grid-footer-cell-wrapper\" ng-style=\"colContainer.headerCellWrapperStyle()\"><div role=\"row\" class=\"ui-grid-footer-cell-row\"><div ui-grid-footer-cell role=\"gridcell\" ng-repeat=\"col in colContainer.renderedColumns track by col.uid\" col=\"col\" render-index=\"$index\" class=\"ui-grid-footer-cell ui-grid-clearfix\"></div></div></div></div></div></div>"
- );
- $templateCache.put('ui-grid/ui-grid-grid-footer',
- "<div class=\"ui-grid-footer-info ui-grid-grid-footer\"><span>{{'search.totalItems' | t}} {{grid.rows.length}}</span> <span ng-if=\"grid.renderContainers.body.visibleRowCache.length !== grid.rows.length\" class=\"ngLabel\">({{\"search.showingItems\" | t}} {{grid.renderContainers.body.visibleRowCache.length}})</span></div>"
- );
- $templateCache.put('ui-grid/ui-grid-header',
- "<div role=\"rowgroup\" class=\"ui-grid-header\"><!-- theader --><div class=\"ui-grid-top-panel\"><div class=\"ui-grid-header-viewport\"><div class=\"ui-grid-header-canvas\"><div class=\"ui-grid-header-cell-wrapper\" ng-style=\"colContainer.headerCellWrapperStyle()\"><div role=\"row\" class=\"ui-grid-header-cell-row\"><div class=\"ui-grid-header-cell ui-grid-clearfix\" ng-repeat=\"col in colContainer.renderedColumns track by col.uid\" ui-grid-header-cell col=\"col\" render-index=\"$index\"></div></div></div></div></div></div></div>"
- );
- $templateCache.put('ui-grid/ui-grid-menu-button',
- "<div class=\"ui-grid-menu-button\"><div role=\"button\" ui-grid-one-bind-id-grid=\"'grid-menu'\" class=\"ui-grid-icon-container\" ng-click=\"toggleMenu()\" aria-haspopup=\"true\"><i class=\"ui-grid-icon-menu\" ui-grid-one-bind-aria-label=\"i18n.aria.buttonLabel\"> </i></div><div ui-grid-menu menu-items=\"menuItems\"></div></div>"
- );
- $templateCache.put('ui-grid/ui-grid-no-header',
- "<div class=\"ui-grid-top-panel\"></div>"
- );
- $templateCache.put('ui-grid/ui-grid-row',
- "<div ng-repeat=\"(colRenderIndex, col) in colContainer.renderedColumns track by col.uid\" ui-grid-one-bind-id-grid=\"rowRenderIndex + '-' + col.uid + '-cell'\" class=\"ui-grid-cell\" ng-class=\"{ 'ui-grid-row-header-cell': col.isRowHeader }\" role=\"{{col.isRowHeader ? 'rowheader' : 'gridcell'}}\" ui-grid-cell></div>"
- );
- $templateCache.put('ui-grid/ui-grid',
- "<div ui-i18n=\"en\" class=\"ui-grid\"><!-- TODO (c0bra): add \"scoped\" attr here, eventually? --><style ui-grid-style>.grid{{ grid.id }} {\n" +
- " /* Styles for the grid */\n" +
- " }\n" +
- "\n" +
- " .grid{{ grid.id }} .ui-grid-row, .grid{{ grid.id }} .ui-grid-cell, .grid{{ grid.id }} .ui-grid-cell .ui-grid-vertical-bar {\n" +
- " height: {{ grid.options.rowHeight }}px;\n" +
- " }\n" +
- "\n" +
- " .grid{{ grid.id }} .ui-grid-row:last-child .ui-grid-cell {\n" +
- " border-bottom-width: {{ (((grid.getVisibleRowCount() * grid.options.rowHeight) < grid.getViewportHeight()) && '1') || '0' }}px;\n" +
- " }\n" +
- "\n" +
- " {{ grid.verticalScrollbarStyles }}\n" +
- " {{ grid.horizontalScrollbarStyles }}\n" +
- "\n" +
- " /*\n" +
- " .ui-grid[dir=rtl] .ui-grid-viewport {\n" +
- " padding-left: {{ grid.verticalScrollbarWidth }}px;\n" +
- " }\n" +
- " */\n" +
- "\n" +
- " {{ grid.customStyles }}</style><div class=\"ui-grid-contents-wrapper\" role=\"grid\"><div ui-grid-menu-button ng-if=\"grid.options.enableGridMenu\"></div><div ng-if=\"grid.hasLeftContainer()\" style=\"width: 0\" ui-grid-pinned-container=\"'left'\"></div><div ui-grid-render-container container-id=\"'body'\" col-container-name=\"'body'\" row-container-name=\"'body'\" bind-scroll-horizontal=\"true\" bind-scroll-vertical=\"true\" enable-horizontal-scrollbar=\"grid.options.enableHorizontalScrollbar\" enable-vertical-scrollbar=\"grid.options.enableVerticalScrollbar\"></div><div ng-if=\"grid.hasRightContainer()\" style=\"width: 0\" ui-grid-pinned-container=\"'right'\"></div><div ui-grid-grid-footer ng-if=\"grid.options.showGridFooter\"></div><div ui-grid-column-menu ng-if=\"grid.options.enableColumnMenus\"></div><div ng-transclude></div></div></div>"
- );
- $templateCache.put('ui-grid/uiGridCell',
- "<div class=\"ui-grid-cell-contents\" title=\"TOOLTIP\">{{COL_FIELD CUSTOM_FILTERS}}</div>"
- );
- $templateCache.put('ui-grid/uiGridColumnMenu',
- "<div class=\"ui-grid-column-menu\"><div ui-grid-menu menu-items=\"menuItems\"><!-- <div class=\"ui-grid-column-menu\">\n" +
- " <div class=\"inner\" ng-show=\"menuShown\">\n" +
- " <ul>\n" +
- " <div ng-show=\"grid.options.enableSorting\">\n" +
- " <li ng-click=\"sortColumn($event, asc)\" ng-class=\"{ 'selected' : col.sort.direction == asc }\"><i class=\"ui-grid-icon-sort-alt-up\"></i> Sort Ascending</li>\n" +
- " <li ng-click=\"sortColumn($event, desc)\" ng-class=\"{ 'selected' : col.sort.direction == desc }\"><i class=\"ui-grid-icon-sort-alt-down\"></i> Sort Descending</li>\n" +
- " <li ng-show=\"col.sort.direction\" ng-click=\"unsortColumn()\"><i class=\"ui-grid-icon-cancel\"></i> Remove Sort</li>\n" +
- " </div>\n" +
- " </ul>\n" +
- " </div>\n" +
- " </div> --></div></div>"
- );
- $templateCache.put('ui-grid/uiGridFooterCell',
- "<div class=\"ui-grid-cell-contents\" col-index=\"renderIndex\"><div>{{ col.getAggregationText() + ( col.getAggregationValue() CUSTOM_FILTERS ) }}</div></div>"
- );
- $templateCache.put('ui-grid/uiGridHeaderCell',
- "<div role=\"columnheader\" ng-class=\"{ 'sortable': sortable, 'ui-grid-header-cell-last-col': isLastCol }\" ui-grid-one-bind-aria-labelledby-grid=\"col.uid + '-header-text ' + col.uid + '-sortdir-text'\" aria-sort=\"{{col.sort.direction == asc ? 'ascending' : ( col.sort.direction == desc ? 'descending' : (!col.sort.direction ? 'none' : 'other'))}}\"><div role=\"button\" tabindex=\"0\" ng-keydown=\"handleKeyDown($event)\" class=\"ui-grid-cell-contents ui-grid-header-cell-primary-focus\" col-index=\"renderIndex\" title=\"TOOLTIP\"><span class=\"ui-grid-header-cell-label\" ui-grid-one-bind-id-grid=\"col.uid + '-header-text'\">{{ col.displayName CUSTOM_FILTERS }}</span> <span ui-grid-one-bind-id-grid=\"col.uid + '-sortdir-text'\" ui-grid-visible=\"col.sort.direction\" aria-label=\"{{getSortDirectionAriaLabel()}}\"><i ng-class=\"{ 'ui-grid-icon-up-dir': col.sort.direction == asc, 'ui-grid-icon-down-dir': col.sort.direction == desc, 'ui-grid-icon-blank': !col.sort.direction }\" title=\"{{isSortPriorityVisible() ? i18n.headerCell.priority + ' ' + ( col.sort.priority + 1 ) : null}}\" aria-hidden=\"true\"></i> <sub ui-grid-visible=\"isSortPriorityVisible()\" class=\"ui-grid-sort-priority-number\">{{col.sort.priority + 1}}</sub></span></div><div role=\"button\" tabindex=\"0\" ui-grid-one-bind-id-grid=\"col.uid + '-menu-button'\" class=\"ui-grid-column-menu-button\" ng-if=\"grid.options.enableColumnMenus && !col.isRowHeader && col.colDef.enableColumnMenu !== false\" ng-click=\"toggleMenu($event)\" ng-keydown=\"headerCellArrowKeyDown($event)\" ui-grid-one-bind-aria-label=\"i18n.headerCell.aria.columnMenuButtonLabel\" aria-haspopup=\"true\"><i class=\"ui-grid-icon-angle-down\" aria-hidden=\"true\"> </i></div><div ui-grid-filter></div></div>"
- );
- $templateCache.put('ui-grid/uiGridMenu',
- "<div class=\"ui-grid-menu\" ng-show=\"shown\"><style ui-grid-style>{{dynamicStyles}}</style><div class=\"ui-grid-menu-mid\" ng-show=\"shownMid\"><div class=\"ui-grid-menu-inner\" ng-if=\"shown\"><ul role=\"menu\" class=\"ui-grid-menu-items\"><li ng-repeat=\"item in menuItems\" role=\"menuitem\" ui-grid-menu-item ui-grid-one-bind-id=\"'menuitem-'+$index\" action=\"item.action\" name=\"item.title\" active=\"item.active\" icon=\"item.icon\" shown=\"item.shown\" context=\"item.context\" template-url=\"item.templateUrl\" leave-open=\"item.leaveOpen\" screen-reader-only=\"item.screenReaderOnly\"></li></ul></div></div></div>"
- );
- $templateCache.put('ui-grid/uiGridMenuItem',
- "<button type=\"button\" class=\"ui-grid-menu-item\" ng-click=\"itemAction($event, title)\" ng-show=\"itemShown()\" ng-class=\"{ 'ui-grid-menu-item-active': active(), 'ui-grid-sr-only': (!focus && screenReaderOnly) }\" aria-pressed=\"{{active()}}\" tabindex=\"0\" ng-focus=\"focus=true\" ng-blur=\"focus=false\"><i ng-class=\"icon\" aria-hidden=\"true\"> </i> {{ label() }}</button>"
- );
- $templateCache.put('ui-grid/uiGridRenderContainer',
- "<div role=\"presentation\" ui-grid-one-bind-id-grid=\"'grid-container'\" class=\"ui-grid-render-container\" ng-style=\"{ 'margin-left': colContainer.getMargin('left') + 'px', 'margin-right': colContainer.getMargin('right') + 'px' }\"><!-- All of these dom elements are replaced in place --><div ui-grid-header></div><div ui-grid-viewport></div><div ng-if=\"colContainer.needsHScrollbarPlaceholder()\" class=\"ui-grid-scrollbar-placeholder\" ng-style=\"{height:colContainer.grid.scrollbarHeight + 'px'}\"></div><ui-grid-footer ng-if=\"grid.options.showColumnFooter\"></ui-grid-footer></div>"
- );
- $templateCache.put('ui-grid/uiGridViewport',
- "<div role=\"rowgroup\" class=\"ui-grid-viewport\" ng-style=\"colContainer.getViewportStyle()\"><!-- tbody --><div class=\"ui-grid-canvas\"><div ng-repeat=\"(rowRenderIndex, row) in rowContainer.renderedRows track by $index\" class=\"ui-grid-row\" ng-style=\"Viewport.rowStyle(rowRenderIndex)\"><div role=\"row\" ui-grid-row=\"row\" row-render-index=\"rowRenderIndex\"></div></div></div></div>"
- );
- $templateCache.put('ui-grid/cellEditor',
- "<div><form name=\"inputForm\"><input type=\"INPUT_TYPE\" ng-class=\"'colt' + col.uid\" ui-grid-editor ng-model=\"MODEL_COL_FIELD\"></form></div>"
- );
- $templateCache.put('ui-grid/dropdownEditor',
- "<div><form name=\"inputForm\"><select ng-class=\"'colt' + col.uid\" ui-grid-edit-dropdown ng-model=\"MODEL_COL_FIELD\" ng-options=\"field[editDropdownIdLabel] as field[editDropdownValueLabel] CUSTOM_FILTERS for field in editDropdownOptionsArray\"></select></form></div>"
- );
- $templateCache.put('ui-grid/fileChooserEditor',
- "<div><form name=\"inputForm\"><input ng-class=\"'colt' + col.uid\" ui-grid-edit-file-chooser type=\"file\" id=\"files\" name=\"files[]\" ng-model=\"MODEL_COL_FIELD\"></form></div>"
- );
- $templateCache.put('ui-grid/emptyBaseLayerContainer',
- "<div class=\"ui-grid-empty-base-layer-container ui-grid-canvas\"><div class=\"ui-grid-row\" ng-repeat=\"(rowRenderIndex, row) in grid.baseLayer.emptyRows track by $index\" ng-style=\"Viewport.rowStyle(rowRenderIndex)\"><div><div><div ng-repeat=\"(colRenderIndex, col) in colContainer.renderedColumns track by col.colDef.name\" class=\"ui-grid-cell {{ col.getColClass(false) }}\"></div></div></div></div></div>"
- );
- $templateCache.put('ui-grid/expandableRow',
- "<div ui-grid-expandable-row ng-if=\"expandableRow.shouldRenderExpand()\" class=\"expandableRow\" style=\"float:left; margin-top: 1px; margin-bottom: 1px\" ng-style=\"{width: (grid.renderContainers.body.getCanvasWidth()) + 'px', height: row.expandedRowHeight + 'px'}\"></div>"
- );
- $templateCache.put('ui-grid/expandableRowHeader',
- "<div class=\"ui-grid-row-header-cell ui-grid-expandable-buttons-cell\"><div class=\"ui-grid-cell-contents\"><i ng-if=\"!(row.groupHeader==true || row.entity.subGridOptions.disableRowExpandable)\" ng-class=\"{ 'ui-grid-icon-plus-squared' : !row.isExpanded, 'ui-grid-icon-minus-squared' : row.isExpanded }\" ng-click=\"grid.api.expandable.toggleRowExpansion(row.entity)\"></i></div></div>"
- );
- $templateCache.put('ui-grid/expandableScrollFiller',
- "<div ng-if=\"expandableRow.shouldRenderFiller()\" ng-class=\"{scrollFiller:true, scrollFillerClass:(colContainer.name === 'body')}\" ng-style=\"{ width: (grid.getViewportWidth()) + 'px', height: row.expandedRowHeight + 2 + 'px', 'margin-left': grid.options.rowHeader.rowHeaderWidth + 'px' }\"><i class=\"ui-grid-icon-spin5 ui-grid-animate-spin\" ng-style=\"{'margin-top': ( row.expandedRowHeight/2 - 5) + 'px', 'margin-left' : ((grid.getViewportWidth() - grid.options.rowHeader.rowHeaderWidth)/2 - 5) + 'px'}\"></i></div>"
- );
- $templateCache.put('ui-grid/expandableTopRowHeader',
- "<div class=\"ui-grid-row-header-cell ui-grid-expandable-buttons-cell\"><div class=\"ui-grid-cell-contents\"><span class=\"ui-grid-cell-empty\" ng-if=\"!grid.options.showExpandAllButton\"></span> <button type=\"button\" class=\"ui-grid-icon-button\" ng-if=\"grid.options.showExpandAllButton\" ng-class=\"{ 'ui-grid-icon-plus-squared' : !grid.expandable.expandedAll, 'ui-grid-icon-minus-squared' : grid.expandable.expandedAll }\" ng-click=\"grid.api.expandable.toggleAllRows()\"></button></div></div>"
- );
- $templateCache.put('ui-grid/csvLink',
- "<span class=\"ui-grid-exporter-csv-link-span\"><a href=\"data:text/csv;charset=UTF-8,CSV_CONTENT\" download=\"FILE_NAME\">LINK_LABEL</a></span>"
- );
- $templateCache.put('ui-grid/importerMenuItem',
- "<li class=\"ui-grid-menu-item\"><form><input class=\"ui-grid-importer-file-chooser\" type=\"file\" id=\"files\" name=\"files[]\"></form></li>"
- );
- $templateCache.put('ui-grid/importerMenuItemContainer',
- "<div ui-grid-importer-menu-item></div>"
- );
- $templateCache.put('ui-grid/pagination',
- "<div class=\"ui-grid-pager-panel\" ui-grid-pager ng-show=\"grid.options.enablePaginationControls\"><div role=\"navigation\" class=\"ui-grid-pager-container\"><div class=\"ui-grid-pager-control\"><button type=\"button\" class=\"ui-grid-pager-first\" ui-grid-one-bind-title=\"aria.pageToFirst\" ui-grid-one-bind-aria-label=\"aria.pageToFirst\" ng-click=\"pageFirstPageClick()\" ng-disabled=\"cantPageBackward()\"><div ng-class=\"grid.isRTL() ? 'last-triangle' : 'first-triangle'\"><div ng-class=\"grid.isRTL() ? 'last-bar-rtl' : 'first-bar'\"></div></div></button> <button type=\"button\" class=\"ui-grid-pager-previous\" ui-grid-one-bind-title=\"aria.pageBack\" ui-grid-one-bind-aria-label=\"aria.pageBack\" ng-click=\"pagePreviousPageClick()\" ng-disabled=\"cantPageBackward()\"><div ng-class=\"grid.isRTL() ? 'last-triangle prev-triangle' : 'first-triangle prev-triangle'\"></div></button> <input type=\"number\" ui-grid-one-bind-title=\"aria.pageSelected\" ui-grid-one-bind-aria-label=\"aria.pageSelected\" class=\"ui-grid-pager-control-input\" ng-model=\"grid.options.paginationCurrentPage\" min=\"1\" max=\"{{ paginationApi.getTotalPages() }}\" step=\"1\" required> <span class=\"ui-grid-pager-max-pages-number\" ng-show=\"paginationApi.getTotalPages() > 0\"><abbr ui-grid-one-bind-title=\"paginationOf\">/</abbr> {{ paginationApi.getTotalPages() }}</span> <button type=\"button\" class=\"ui-grid-pager-next\" ui-grid-one-bind-title=\"aria.pageForward\" ui-grid-one-bind-aria-label=\"aria.pageForward\" ng-click=\"pageNextPageClick()\" ng-disabled=\"cantPageForward()\"><div ng-class=\"grid.isRTL() ? 'first-triangle next-triangle' : 'last-triangle next-triangle'\"></div></button> <button type=\"button\" class=\"ui-grid-pager-last\" ui-grid-one-bind-title=\"aria.pageToLast\" ui-grid-one-bind-aria-label=\"aria.pageToLast\" ng-click=\"pageLastPageClick()\" ng-disabled=\"cantPageToLast()\"><div ng-class=\"grid.isRTL() ? 'first-triangle' : 'last-triangle'\"><div ng-class=\"grid.isRTL() ? 'first-bar-rtl' : 'last-bar'\"></div></div></button></div><div class=\"ui-grid-pager-row-count-picker\" ng-if=\"grid.options.paginationPageSizes.length > 1 && !grid.options.useCustomPagination\"><select ui-grid-one-bind-aria-labelledby-grid=\"'items-per-page-label'\" ng-model=\"grid.options.paginationPageSize\" ng-options=\"o as o for o in grid.options.paginationPageSizes\"></select><span ui-grid-one-bind-id-grid=\"'items-per-page-label'\" class=\"ui-grid-pager-row-count-label\"> {{sizesLabel}}</span></div><span ng-if=\"grid.options.paginationPageSizes.length <= 1\" class=\"ui-grid-pager-row-count-label\">{{grid.options.paginationPageSize}} {{sizesLabel}}</span></div><div class=\"ui-grid-pager-count-container\"><div class=\"ui-grid-pager-count\"><span ng-show=\"grid.options.totalItems > 0\">{{ 1 + paginationApi.getFirstRowIndex() }} <abbr ui-grid-one-bind-title=\"paginationThrough\">-</abbr> {{ 1 + paginationApi.getLastRowIndex() }} {{paginationOf}} {{grid.options.totalItems}} {{totalItemsLabel}}</span></div></div></div>"
- );
- $templateCache.put('ui-grid/columnResizer',
- "<div ui-grid-column-resizer ng-if=\"grid.options.enableColumnResizing\" class=\"ui-grid-column-resizer\" col=\"col\" position=\"right\" render-index=\"renderIndex\" unselectable=\"on\"></div>"
- );
- $templateCache.put('ui-grid/gridFooterSelectedItems',
- "<span ng-if=\"grid.selection.selectedCount !== 0 && grid.options.enableFooterTotalSelected\">({{\"search.selectedItems\" | t}} {{grid.selection.selectedCount}})</span>"
- );
- $templateCache.put('ui-grid/selectionHeaderCell',
- "<div><!-- <div class=\"ui-grid-vertical-bar\"> </div> --><div class=\"ui-grid-cell-contents\" col-index=\"renderIndex\"><ui-grid-selection-select-all-buttons ng-if=\"grid.options.enableSelectAll\" role=\"checkbox\" ng-model=\"grid.selection.selectAll\"></ui-grid-selection-select-all-buttons></div></div>"
- );
- $templateCache.put('ui-grid/selectionRowHeader',
- "<div class=\"ui-grid-cell-contents ui-grid-disable-selection\"><ui-grid-selection-row-header-buttons></ui-grid-selection-row-header-buttons></div>"
- );
- $templateCache.put('ui-grid/selectionRowHeaderButtons',
- "<div class=\"ui-grid-selection-row-header-buttons ui-grid-icon-ok\" ng-class=\"{'ui-grid-row-selected': row.isSelected}\" ng-click=\"selectButtonClick(row, $event)\" ng-keydown=\"selectButtonKeyDown(row, $event)\" role=\"checkbox\" ng-model=\"row.isSelected\"> </div>"
- );
- $templateCache.put('ui-grid/selectionSelectAllButtons',
- "<div role=\"button\" class=\"ui-grid-selection-row-header-buttons ui-grid-icon-ok\" ng-class=\"{'ui-grid-all-selected': grid.selection.selectAll}\" ng-click=\"headerButtonClick($event)\" ng-keydown=\"headerButtonKeyDown($event)\"></div>"
- );
- $templateCache.put('ui-grid/treeBaseExpandAllButtons',
- "<div class=\"ui-grid-tree-base-row-header-buttons\" ng-class=\"{'ui-grid-icon-minus-squared': grid.treeBase.numberLevels > 0 && grid.treeBase.expandAll, 'ui-grid-icon-plus-squared': grid.treeBase.numberLevels > 0 && !grid.treeBase.expandAll}\" ng-click=\"headerButtonClick($event)\"></div>"
- );
- $templateCache.put('ui-grid/treeBaseHeaderCell',
- "<div><div class=\"ui-grid-cell-contents\" col-index=\"renderIndex\"><ui-grid-tree-base-expand-all-buttons ng-if=\"grid.options.enableExpandAll\"></ui-grid-tree-base-expand-all-buttons></div></div>"
- );
- $templateCache.put('ui-grid/treeBaseRowHeader',
- "<div class=\"ui-grid-cell-contents\"><ui-grid-tree-base-row-header-buttons></ui-grid-tree-base-row-header-buttons></div>"
- );
- $templateCache.put('ui-grid/treeBaseRowHeaderButtons',
- "<div class=\"ui-grid-tree-base-row-header-buttons\" ng-class=\"{'ui-grid-tree-base-header': row.treeLevel > -1 }\" ng-click=\"treeButtonClick(row, $event)\"><i ng-class=\"{'ui-grid-icon-minus-squared': ( ( grid.options.showTreeExpandNoChildren && row.treeLevel > -1 ) || ( row.treeNode.children && row.treeNode.children.length > 0 ) ) && row.treeNode.state === 'expanded', 'ui-grid-icon-plus-squared': ( ( grid.options.showTreeExpandNoChildren && row.treeLevel > -1 ) || ( row.treeNode.children && row.treeNode.children.length > 0 ) ) && row.treeNode.state === 'collapsed'}\" ng-style=\"{'padding-left': grid.options.treeIndent * row.treeLevel + 'px'}\"></i> </div>"
- );
- $templateCache.put('ui-grid/cellTitleValidator',
- "<div class=\"ui-grid-cell-contents\" ng-class=\"{invalid:grid.validate.isInvalid(row.entity,col.colDef)}\" title=\"{{grid.validate.getTitleFormattedErrors(row.entity,col.colDef)}}\">{{COL_FIELD CUSTOM_FILTERS}}</div>"
- );
- $templateCache.put('ui-grid/cellTooltipValidator',
- "<div class=\"ui-grid-cell-contents\" ng-class=\"{invalid:grid.validate.isInvalid(row.entity,col.colDef)}\" tooltip-html-unsafe=\"{{grid.validate.getFormattedErrors(row.entity,col.colDef)}}\" tooltip-enable=\"grid.validate.isInvalid(row.entity,col.colDef)\" tooltip-append-to-body=\"true\" tooltip-placement=\"top\" title=\"TOOLTIP\">{{COL_FIELD CUSTOM_FILTERS}}</div>"
- );
- }]);
|