T I K Z - N E T W O R K M A N U A L

Transcription

1 Layr β J Ü R G E N H A C K L arxiv: v1 [cs.oh] 18 Sp 2017 T I K Z - N E T W O R K M A N U A L Layr α V E R S I O N 0. 2

2 Th tikz-ntwork packag is still undr dvlopmnt. Hnc, changs in th commands and functionality cannot xcludd. Copyright 2017 Jürgn Hackl vrsion ntwork Rlasd, Sptmr 2017

3 Contnts 1 Introduction How to rad this manual? A fw xplanations Inputs Additional hlp Installation Additional ncssary packags Simpl Ntworks Vrtx Edg Complx Ntworks Vrtics Edgs Multilayr Ntworks Simpl Ntworks Complx Ntworks Layrs and Layouts Dfault Sttings Gnral Sttings Vrtx Styl Edg Styl Troulshooting and Support Tuft-LATEX Wsit Gtting Hlp Errors, Warnings, and Informational Mssags Packag Dpndncis A ToDo 33 A.1 Cod to fix A.2 Documntation A.3 Faturs A.4 Add-ons

4

5 1 Introduction In rcnt yars, complx ntwork thory coms mor and mor popular within th scintific community. Bsids a solid mathmatical as on which ths thoris ar uilt on, a visual rprsntation of th ntworks allow communicating complx rlationships to a road audinc. Nowadays, a varity of grat visualization tools ar availal, which hlps to structur, filtr, manipulat and of cours to visualiz th ntworks. Howvr, thy com with som limitations, including th nd for spcific softwar tools, difficultis to md th outputs proprly in a LATEX fil (.g. font typ, font siz, additional quations and math symols ndd,... ) and challngs in th post-procssing of th graphs, without rrunning th softwar tools again. In ordr to ovrcom this issus, th packag tikz-ntwork was cratd. Som of th faturs ar: LATEX is a standard for scintific pulications and widly usd sid LATEX no othr softwar is ndd no programming skills ar ndd simpl to us ut allows 100% control ovr th output asy for post-procssing (.g. adding drawings, txts, quations,... ) sam fonts, font sizs, mathmatical symols,... as in th documnt no quality loss of th output du to th pdf format ntworks ar asy to adapt or modify for lcturs or small xampls al to visualiz largr ntworks thr-dimnsional visualization of (multilayr) ntworks compatil with othr visualization tools

6 6 introduction 1.1 How to rad this manual? Th aim of this manual is to dscri th us of th tikz-ntwork lirary for visualizing ntworks. To nsur an asy us of th lmnts and to kp th clarity, this manual is structurd as follows: In Chaptr 2 th lmnts to crat simpl ntworks (y hand) in a plan ar xplaind. Thry, th us of th commands \Vrtx and \Edg ar shown. How to crat complx ntworks from xtrnal fils 1 ar xplaind in Chaptr 3. Th main commands, thrfor ar \Vrtics and \Edgs which ar using th sam options as in th simpl cas. 1.g. igraph or ntworkx In Chaptr 4, th visualization of multilayr ntworks is xplaind. Additional visualization tools such as \Plain and Layr ar introducd. Th dfault sttings usd and how thy can modifid is xplaind in Chaptr 5. Information aout troulshooting and support is givn in Chaptr 6 Sinc this is th alpha vrsion (0.1) of th packag, faturs which will proaly addd and commands which hav to fixd ar listd in Appndix A A fw xplanations Th imags in this manual ar cratd with th tikz-ntwork lirary or TikZ. Th cod usd for this is spcifid for ach imag. \filldraw (-.2,.2) circl (2pt) (.2,.2) circl (2pt); \draw (0,0) circl (5mm) (-.3,-.1).. controls (0,-.3).. (.3,-.1); Spcial additions which ar ndd for a ttr undrstanding ar shown in orang ut ar not in th sampl cod availal. \draw (0,0).. controls (1,1) and (2,1).. (2,0); Inputs Th commands in th tikz-ntwork lirary (.g. \Vrtx, \Edg) always start with capital lttrs and DO NOT nd a smicolon «;» at th nd. Boolan argumnts start also with capital lttrs (.g. NoLal ). Argumnts which nd an usr input, us ar writtn in small lttrs (.g. color ).

7 tikz-ntwork manual 7 Basically, on can distinguish twn th mandatory argumnt { } and th optional argumnt [ ]. Th first valus must ntrd compulsory. By contrast, nothing has to ntrd for th optional input. Additional faturs (.g. siz )) can activatd whn ntring optional paramtrs. Whn ntring siz valus th as unit is always prdfind in [cm] 2, xcpt for lin widths which ar ddind in [pt]. Prcntag valus % ar always spcifid as dcimal valus; for xampl, 100% = 1.0 and 10% corrsponds to Th dfault unit can changd with \StDfaultUnit; s Sction Additional hlp Is th manual not nough, occur som amiguitis or som TikZ commands ar unclar, plas hav a look in th TikZ and PGF Manual from Till Tantau 3. Should you hav any furthr qustions, plas do not hsitat to contact m. 3 mirror/tx/graphics/pgf/as/doc/ pgfmanual.pdf 1.2 Installation Actually, w can hardly spak of an installation sinc only th ncssary packag tikz-ntwork must loadd in th praml of your documnt. Th currnt rlas of th packag is availal via CTAN 4. A rlas candidat for th nxt vrsion of tikz-ntwork is availal on githu 5 Is th packag installd or th styl fil is stord in th foldr of th main fil, so th lirary can importd, as th following xampl shows: 4 TODO! upload th packag to CTAN, and add hr th link 5 % % hadr \documntclass{scrrprt} % % packags \uspackag{tikz-ntwork} 1.3 Additional ncssary packags To us all commands and options of TikZ, possily som packags nd to rloadd. Ths missing fils (or thir nams) appar in th rror log whn you convrt th fil. Howvr, for th packag dscrid in this manual, it is sufficint to us th lirary and th TikZ standard commands.

8

9 2 Simpl Ntworks 2.1 Vrtx On ssntial command is \Vrtx, which allow placing vrtics in th documnt and modify thir apparanc. \Vrtx[ local options ]{Nam} In ordr to al to plac a vrtx, a non-mpty Nam argumnt is rquird. This argumnt dfins th vrtx s rfrnc nam, which must uniqu. Mathmatical symols ar not allowd as nam as wll as no lank spacs. Th Nam should not confusd with th lal, that is usd for display; for xampl on may want to display A 1 whil th nam will A1. For a \Vrtx th following options ar availal: Option Dfault Typ Dfinition x 0 masur x-coordinat y 0 masur y-coordinat siz {} masur diamtr of th circl color {} color fillcolor of vrtx opacity {} numr opacity of th fill color lal {} string lal position cntr valu a lal position distanc 0 masur lal distanc from th cntr styl {} string additional TikZ styls layr {} numr assignd layr of th vrtx Tal 2.1: Local options for th \Vrtx command. NoLal fals oolan dlt th lal IdAsLal fals oolan uss th Nam as lal Math fals oolan displays th lal in math mod RGB fals oolan allow RGB colors a ithr masur or string Th ordr how th options ar ntrd dos not mattr. Changs to th dfault Vrtx layout can mad with \StVrtxStyl 1 1 s Sction 5.2 \Vrtx[ x =masur, y =masur]{nam} Th location of th vrtics ar dtrmind y Cartsian coordinats in x and y. Th coordinats ar optional. If no coordinats ar dtrmind th vrtx will placd at th origin (0, 0). Th ntrd masur ar in dfault units (cm). Changing th units (locally) can don y adding th unit to th masur 2. Changs to 2.g. x=1 in th dfault stting can mad with \StDfaultUnit 3. 3 s Sction 5.1

10 10 simpl ntworks \Vrtx{A} \Vrtx[x=1,y=1]{B} \Vrtx[x=2]{C} A B C \Vrtx[ siz =masur]{nam} Th diamtr of th vrtx can changd with th option siz. Pr dfault a vrtx has 0.6 cm in diamtr. Also, hr th dfault units ar cm and hav not to addd to th masur. \Vrtx[siz=.3]{A} \Vrtx[x=1,siz=.7]{B} \Vrtx[x=2.3,siz=1]{C} \Vrtx[ color =color]{nam} To chang th fill color of ach vrtx individually, th option color has to usd. Without th option RGB st, th dfault TikZ and LATEX colors can applid. \Vrtx[color = lu]{a} \Vrtx[x=1,color=rd]{B} \Vrtx[x=2,color=grn!70!lu]{C} \Vrtx[ opacity =numr]{nam} With th option opacity th opacity of th vrtx fill color can modifid. Th rang of th numr lis twn 0 and 1. Whr 0 rprsnts a fully transparnt fill and 1 a solid fill. \Vrtx[opacity = 1]{A} \Vrtx[x=1,opacity =.7]{B} \Vrtx[x=2,opacity =.2]{C} \Vrtx[ lal =string]{nam} In tikz-ntwork thr ar svral ways to dfin th lals of th vrtics and dgs. Th common way is via th option lal. Hr, any string argumnt can usd, including lank spacs. Th nvironmnt $ $ can usd to display mathmatical xprssions. \Vrtx[lal=foo]{A} \Vrtx[x=1,lal=ar]{B} \Vrtx[x=2,lal=$u_1$]{B} foo ar u 1

11 tikz-ntwork manual 11 \Vrtx[ lal =string, position =valu, distanc =numr]{nam} Pr dfault th position of th lal is in th cntr of th vrtx. Classical TikZ commands 4 can usd to chang th position of th lal. Instad, using such command, th position can dtrmind via an angl, y ntring a numr twn 360 and 360. Th origin (0 ) is th y axis. A positiv numr chang th position countr clockwis, whil a ngativ numr mak changs clockwis. With th option, distanc th distanc twn th vrtx and th lal can changd. 4.g. aov, low, lft, right, aov lft, aov right,... \Vrtx[lal=A,position=low]{A} \Vrtx[x=1,lal=B,position=low,distanc=2mm]{B} \Vrtx[x=2,lal=C,position=30,distanc=1mm]{C} A B C 30 \Vrtx[ styl ={string}]{nam} Any othr TikZ styl option or command can ntrd via th option styl. Most of ths commands can found in th TikZ and PGF Manual. Contain th commands additional options (.g. shading =all), thn th argumnt for th styl has to twn { } rackts. \Vrtx[styl={color=grn}]{A} \Vrtx[x=1,styl=dashd]{B} \Vrtx[x=2,styl={shading=all}]{C} \Vrtx[ IdAsLal ]{Nam} \Vrtx[ NoLal, lal =string]{nam} IdAsLal is a oolan option which assigns th Nam of th vrtx as lal. On th contrary, NoLal supprss all lals. \Vrtx[IdAsLal]{A} \Vrtx[x=1,lal=B,NoLal]{B} \Vrtx[x=2,IdAsLal,NoLal]{C} A \Vrtx[ Math, lal =string]{nam} Th option Math allows transforming lals into mathmatical xprssions without using th $ $ nvironmnt. In comination with IdAsLal allows this option also mathmatical xprssions y th dfinition of th vrtx Nam.

12 12 simpl ntworks \Vrtx[IdAsLal]{A1} \Vrtx[x=1,lal=B_1,Math]{B} \Vrtx[x=2,Math,IdAsLal]{C_1} A1 B 1 C 1 \Vrtx[ RGB, color =RGB valus]{nam} In ordr to display RGB colors for th vrtx fill color, th option RGB has to ntrd. In comination with this option, th color hast to a list with th RGB valus, sparatd y «,» and within { }. 5 5.g. th RGB cod for whit: {255, 255, 255} \Vrtx[RGB,color={127,201,127}]{A} \Vrtx[x=1,RGB,color={190,174,212}]{B} \Vrtx[x=2,RGB,color={253,192,134}]{C} \Vrtx[ layr =numr]{nam} With th option layr th vrtx can assignd to a spcific layr. Mor aout this option and th us of layrs is xplaind in Chaptr 4.

13 tikz-ntwork manual Edg Th scond ssntial command is an \Edg, which allow conncting two vrtics. \Edg[ local options ](Vrtx i)(vrtx j) Edgs can gnratd twn on or two vrtics. In th first cas, a slf-loop will gnratd. As mandatory argumnts th Nams of th vrtics which should connctd must ntrd twn ( ) rackts. In cas of a dirctd dg, th ordr is important. An dg is cratd from Vrtx i (origin) to Vrtx j (dstination). For an \Edg th following options ar availal: Option Dfault Typ Dfinition lw {} masur lin width of th dg color {} color dg color opacity {} numr opacity of th dg nd 0 numr angl out/in of th vrtx lal {} string lal position {} string lal position distanc 0.5 numr lal distanc from Vrtx i styl {} string additional TikZ styls loopsiz 1cm masur siz paramtr of th slf-loop loopposition 0 numr orintation of th slf-loop loopshap 90 numr loop angl out/in of th vrtx Dirct fals oolan allow dirctd dgs Math fals oolan displays th lal in math mod RGB fals oolan allow RGB colors Tal 2.2: Local options for th \Edg command. Th options loopsiz, loopposition, and loopsiz ar only for slf-loops availal. \Edg(Vrtx i)(vrtx j) An dg is cratd twn Vrtx i and Vrtx j. \Vrtx{A} \Vrtx[x=2]{B} \Edg(A)(B) \Edg[ lw =masur](vrtx i)(vrtx j) Th lin width of an dg can modifid with th option lw. Hr, th unit of th masur has to spcifid. Th dfault valu is 1.5 pt. \Vrtx{A} \Vrtx[x=2]{B} \Vrtx[x=2,y=-1]{C} \Edg[lw=3pt](A)(B) \Edg[lw=5pt](A)(C)

14 14 simpl ntworks \Edg[ color =color](vrtx i)(vrtx j) To chang th lin color of ach dg individually, th option color has to usd. Without th option RGB st, th dfault TikZ and LATEX colors can applid. \Vrtx{A} \Vrtx[x=2]{B} \Vrtx[x=2,y=-1]{C} \Edg[color=rd](A)(B) \Edg[color=grn!70!lu](A)(C) \Edg[ opacity =numr](vrtx i)(vrtx j) With th option opacity th opacity of th dg lin can modifid. Th rang of th numr lis twn 0 and 1. Whr 0 rprsnts a fully transparnt fill and 1 a solid fill. \Vrtx{A} \Vrtx[x=2]{B} \Vrtx[x=2,y=-1]{C} \Edg[opacity=.7](A)(B) \Edg[opacity=.2](A)(C) \Edg[ nd =numr](vrtx i)(vrtx j) Th shap of th dg can modifid with th nd option. If nothing is spcifid a straight dg, twn th vrtics, is drawn. Th numr dfins th angl in which th dg is divrging from its straight connction. A positiv numr nd th dg countr clockwis, whil a ngativ numr mak changs clockwis. \Vrtx{A} \Vrtx[x=2]{B} \Edg[nd=45](A)(B) \Edg[nd=-70](A)(B) \Edg[ lal =string](vrtx i)(vrtx j) An dg is lald with th option lal. For th lal any string argumnt can usd, including lank spacs. Th nvironmnt $ $ can usd to display mathmatical xprssions. \Vrtx{A} \Vrtx[x=2]{B} \Edg[lal=X](A)(B) X \Edg[ lal =string, position =string](vrtx i)(vrtx j) Pr dfault th lal is positiond in twn oth vrtics in th cntr of th lin. Classical TikZ commands 6 can usd to chang th position of th lal. 6.g. aov, low, lft, right, aov lft, aov right,...

15 tikz-ntwork manual 15 \Vrtx{A} \Vrtx[x=2]{B} \Vrtx[x=2,y=-1]{C} \Edg[lal=X,position=aov](A)(B) \Edg[lal=Y,position={low lft=2mm}](a)(c) Y X \Edg[ lal =string, distanc =numr](vrtx i)(vrtx j) Th lal position twn th vrtics can modifid with th distanc option. Pr dfault th lal is cntrd twn oth vrtics. Th position is xprssd as th prcntag of th lngth twn th vrtics,.g. of distanc =0.7, th lal is placd at 70% of th dg lngth away of Vrtx i. \Vrtx{A} \Vrtx[x=2]{B} \Edg[lal=X,distanc=.7](A)(B) 1.0 X 0.7 \Edg[ styl =string](vrtx i)(vrtx j) Any othr TikZ styl option or command can ntrd via th option styl. Most of ths commands can found in th TikZ and PGF Manual. Contain th commands additional options (.g. shading =all), thn th argumnt for th styl has to twn { } rackts. \Vrtx{A} \Vrtx[x=2]{B} \Edg[styl={dashd}](A)(B) \Edg(Vrtx i)(vrtx i) Slf-loops ar cratd y using th sam vrtx as origin and dstination. Bsid th options xplaind aov, thr ar thr slf-loop spcific options: loopsiz, loopposition, and loopshap. \Vrtx{A} \Edg(A)(A) \Edg[ loopsiz =masur](vrtx i)(vrtx i) With th option loopsiz th lngth of th dg can modifid. Th masur valu has to insrt togthr with its units. Pr dfault th loopsiz is 1 cm. \Vrtx{A} \Vrtx[x=1.3]{B} \Edg[loopsiz=.5cm](A)(A) \Edg[loopsiz=1.5cm](B)(B)

16 16 simpl ntworks \Edg[ loopposition =numr](vrtx i)(vrtx i) Th position of th slf-loop is dfind via th rotation angl around th vrtx. Th origin (0 ) is th y axis. A positiv numr chang th loopposition countr clockwis, whil a ngativ numr mak changs clockwis. \Vrtx{A} \Vrtx[x=1.5]{B} \Edg[loopposition=45](A)(A) \Edg[loopposition=-70](B)(B) \Edg[ loopshap =numr](vrtx i)(vrtx i) Th shap of th slf-loop is dfind y th nclosing angl. Th shap can changd y dcrasing or incrasing th argumnt valu of th loopshap option. \Vrtx{A} \Edg[angl=45](A)(A) 45 \Edg[ Dirct ](Vrtx i)(vrtx j) Dirctd dgs ar cratd y naling th option Dirct. Th arrow is drawn from Vrtx i to Vrtx j. \Vrtx{A} \Vrtx[x=2]{B} \Edg[Dirct](A)(B) \Edg[Math, lal= string ](Vrtx i)(vrtx j) Th option Math allows transforming lals into mathmatical xprssions without using th $ $ nvironmnt. \Vrtx{A} \Vrtx[x=2]{B} \Edg[Math,lal=X_1](A)(B) X 1 \Edg[RBG, color= RGB valu ](Vrtx i)(vrtx j) In ordr to display RGB colors for th lin color of th dg, th option RGB has to ntrd. In comination with this option, th color hast to a list with th RGB valus, sparatd y «,» and within { }. 7 7.g. th RGB cod for whit: {255, 255, 255} \Vrtx{A} \Vrtx[x=2]{B} \Vrtx[x=2,y=-1]{C} \Edg[RGB,color={127,201,127}](A)(B) \Edg[RGB,color={253,192,134}](A)(C)

17 3 Complx Ntworks Whil in Chaptr 2 th uilding locks of th ntworks ar introducd, hr th main strngth of th tikz-ntwork packag is xplaind. This includs crating ntworks asd on data, otaind from othr sourcs (.g. Python, R, GIS). Th ida is that th layout will don y this xtrnal sourcs and tikz-ntwork is usd mak som changs and to rcrat th ntworks in LATEX. 3.1 Vrtics Th \Vrtics command is th xtnsion of th \Vrtx command. Instad of a singl vrtx, a st of vrtics will drawn. This st of vrtics is dfind in an xtrnal fil ut can modifid with \Vrtics. \Vrtics[ gloal options ]{filnam} Th vrtics hav to stord in a clar txt fil 1, prfrntially 1.g..txt,.tx,.csv,.dat,... in a.csv format. Th first row should contain th hadings, which ar qual to th options dfind in Tal 2.1. Option ar sparatd y a comma «,». Each nw row is corrsponds to a nw vrtx. id, x, y,siz,color,opacity,lal,idaslal,nolal A, 0, 0,.4,grn,.9, a, fals, fals B, 1,.7,.6,,.5,, fals, fals C, 2, 1,.8,orang,.3, c, fals, tru D, 2, 0,.5,rd,.7, d, tru, fals E,.2,1.5,.5,gray,,, fals, fals Fil: vrtics.csv Only th id valu is mandatory for a vrtx and corrsponds to th Nam argumnt of a singl \Vrtx. Thrfor, th sam ruls and naming convntions apply as for th Nam argumnt: no mathmatical xprssions, no lank spacs, and th id must uniqu! All othr options ar optional. No spcific ordr of th options must maintaind. If no valu is ntrd for an option, th dfault valu will chosn 2. Th filnam should not contain lank spacs or spcial charactrs. Th vrtics ar drawn y th command \Vrtx with th filnam plus fil format (.g..csv). If th vrtics fil is not in th sam dirctory as th main LATEX fil, also th path has to spcifid. 2 TODO! This is NOT valid for Boolan options, hr valus for all vrtics hav to ntrd.

18 18 complx ntworks \Vrtics{data/vrtics.csv} Prdfind \Vrtx options can ovrruld y th gloal options of th \Vrtics command; I.. ths options apply for all vrtics in th fil. For th \Vrtics th following options ar availal: a D Option Dfault Typ Dfinition siz {} masur diamtr of th circls color {} color fillcolor of vrtics opacity {} numr opacity of th fill color styl {} string additional TikZ styls layr {} numr assignd layr of th vrtics NoLal fals oolan dlt th lals IdAsLal fals oolan uss th Nams as lals Math fals oolan displays th lals in math mod RGB fals oolan allow RGB colors Tal 3.1: Gloal options for th \Vrtics command. Th us of ths options ar similar to th options for a singl \Vrtx dfind in Sction 2.1. \Vrtics[ siz =masur]{filnam} Th diamtr of th vrtics can changd with th option siz. Pr dfault a vrtx has 0.6 cm in diamtr. Also, hr th dfault units ar cm and hav not to addd to th masur. \Vrtics[siz=.6]{data/vrtics.csv} \Vrtics[ color =color]{filnam} a D To chang th fill color for all vrtics, th option color has to usd. Without th option RGB st, th dfault TikZ and LATEX colors can applid. \Vrtics[color=grn!70!lu]{data/vrtics.csv} \Vrtics[ opacity =numr]{filnam} With th option opacity th opacity of all vrtics fills colors can modifid. Th rang of th numr lis twn 0 and 1. Whr 0 rprsnts a fully transparnt fill and 1 a solid fill. a D \Vrtics[opacity=.3]{data/vrtics.csv} a D

19 tikz-ntwork manual 19 \Vrtics[ styl =string]{filnam} Any othr TikZ styl option or command can ntrd via th option styl. Most of ths commands can found in th TikZ and PGF Manual. Contain th commands additional options (.g. shading =all), thn th argumnt for th styl has to twn { } rackts. \Vrtics[styl={shading=all,lu}]{data/vrtics.csv} a D \Vrtics[ IdAsLal ]{filnam} \Vrtics[ NoLal ]{filnam} IdAsLal is a oolan option which assigns th id of th singl vrtics as lals. On th contrary, NoLal supprss all lals. E \Vrtics[IdAsLal]{data/vrtics.csv} A B C D \Vrtics[NoLal]{data/vrtics.csv} \Vrtics[ RGB ]{filnam} In ordr to display RGB colors for th vrtx fill colors, th option RGB has to ntrd. Additionally, th RGB valus hav to spcifid in th fil whr th vrtics ar stord. Each valu has its own column with th caption R, G, and B. id, x, y,siz, color,opacity,lal, R, G, B A, 0, 0,.4, grn,.9, a,255, 0, 0 B, 1,.7,.6,,.5,, 0,255, 0 C, 2, 1,.8,orang,.3, c, 0, 0,255 D, 2, 0,.5, rd,.7, d, 10,120,255 E,.2,1.5,.5, gray,,, 76, 55,255 Fil: vrtics_rgb.csv Th normal color dfinition can also part of th vrtx dfinition. If th option RGB is not st, thn th colors undr color ar applid. \Vrtics[RGB]{data/vrtics_RGB.csv} c \Vrtics[ layr =numr]{filnam} With th option layr, only th vrtics on th slctd layr ar plottd. Mor aout this option and th us of layrs is xplaind in Chaptr 4. a d

20 20 complx ntworks 3.2 Edgs Th \Edgs command is th xtnsion of th \Edg command. Instad of a singl dg, a st of dgs will drawn. This st of dgs is dfind in an xtrnal fil ut can modifid with \Edgs. \Edgs[ gloal options ]{filnam} Lik th vrtics, th dgs hav to stord in a clar txt fil 3, 3.g..txt,.tx,.csv,.dat,... prfrntially in a.csv format. Th first row should contain th hadings, which ar qual to th options dfind in Tal 2.2. Option ar sparatd y a comma «,». Each nw row is corrsponds to a nw dg. u,v,lal,lw,color,opacity,nd, R, G, B,Dirct A,B, a,.5,rd, 1, 30, 0,120,255,fals B,C, c,.7,lu, 1, -60, 76, 55,255,fals B,D, d,.5,lu,.5, -60, 76, 55,255,fals A,E, a, 1,grn, 1, 75,255, 0, 0,tru C,E, c, 2,orang, 1, 0,150,150,150,fals A,A, aa,.3,lack,.5, 75,255, 0,0,fals Fil: dgs.csv Th mandatory valus ar th u and v argumnt, which corrsponds to th Vrtx i and Vrtx j argumnts of a singl \Edg. Edgs can only crat if a vrtx xists with th sam Nam. All othr options ar optional. No spcific ordr of th options must maintaind. If no valu is ntrd for an option, th dfault valu will chosn 4. Th filnam should not contain lank spacs or spcial charactrs. Th dgs ar drawn y th command \Edgs with th filnam plus fil format (.g..csv). If th dgs fil is not in th sam dirctory as th main LATEX fil, also th path has to spcifid. In ordr to draw dgs, first, th vrtics hav to gnratd. Only thn, dgs can assignd. 4 TODO! This is NOT valid for Boolan options, hr valus for all vrtics hav to ntrd. \Vrtics{data/vrtics.csv} \Edgs{data/dgs.csv} a c a c a aa d c d Prdfind \Edg options can ovrruld y th gloal options of th \Edgs command; I.. ths options apply for all dgs in th fil. For th \Edgs th following options ar availal:

21 tikz-ntwork manual 21 Option Dfault Typ Dfinition lw {} masur lin width of th dg color {} color dg color opacity {} numr opacity of th dg styl {} string additional TikZ styls vrtics {} fil vrtics wr th dgs ar assignd to layr {} numr dgs in spcific layrs Dirct fals oolan allow dirctd dgs Math fals oolan displays th lals in math mod NoLal fals oolan dlt th lals RGB fals oolan allow RGB colors NotInBG fals oolan dgs ar not in th ackground layr Tal 3.2: Gloal options for th \Edgs command. Th us of ths options ar similar to th options for a singl \Edg dfind in Sction 2.2. \Edgs[ lw =masur]{filnam} Th lin width of th dgs can modifid with th option lw. Hr, th unit of th masur can spcifid, othrwis, it is in pt. \Vrtics{data/vrtics.csv} \Edgs[lw=2.5]{data/dgs.csv} a c a c a aa d c d \Edgs[ color =color]{filnam} To chang th lin color of all dgs, th option color has to usd. Without th option RGB st, th dfault TikZ and LATEX colors can applid. \Vrtics{data/vrtics.csv} \Edgs[color=grn!70!lu]{data/dgs.csv} a c a c a aa d c d \Edgs[ opacity =numr]{filnam} With th option opacity th opacity of all dg lins can modifid. Th rang of th numr lis twn 0 and 1. Whr 0 rprsnts a fully transparnt fill and 1 a solid fill. \Vrtics{data/vrtics.csv} \Edgs[opacity=0.3]{data/dgs.csv} a c a c a aa d c d

22 22 complx ntworks \Edgs[ styl =string]{filnam} Any othr TikZ styl option or command can ntrd via th option styl. Most of ths commands can found in th TikZ and PGF Manual. \Vrtics{data/vrtics.csv} \Edgs[styl={dashd}]{data/dgs.csv} a c a c a aa d c d \Edgs[ Dirct ]{filnam} Dirctd dgs ar cratd y naling th option Dirct. Th arrow is drawn from u to v. \Vrtics{data/vrtics.csv} \Edgs[Dirct]{data/dgs.csv} a c a c a aa d c d \Edgs[Math]{filnam} Th option Math allows transforming lals into mathmatical xprssions without using th $ $ nvironmnt. \Edgs[ NoLal ]{filnam} Th option NoLal supprss all dg lals. \Vrtics{data/vrtics.csv} \Edgs[NoLal]{data/dgs.csv} a c d \Edgs[ RGB ]{filnam} In ordr to display RGB colors for th dg lin colors, th option RGB has to ntrd. Additionally, th RGB valus hav to spcifid in th fil whr th vrtics ar stord. Each valu has its own column with th caption R, G, and B. Th normal color dfinition can also part of th vrtx dfinition. If th option RGB is not st, thn th colors undr color ar applid. \Vrtics{data/vrtics.csv} \Edgs[RGB]{data/dgs.csv} a c a c a aa d c d \Edgs[ NotInBG ]{filnam} Pr dfault, th dgs ar drawn on th ackground layr of th tikzpictur. I.. ojcts which ar cratd aftr th dgs appar also on top of thm. To turn this off, th option NotInBG has to nald.

23 tikz-ntwork manual 23 \Edgs[ vrtics =filnam]{filnam} Edgs can assignd to a spcific st of \Vrtics with th option vrtics. Thry th argumnt filnam is th sam as usd for th \Vrtics command. This option might ncssary if multipl \Vrtics ar cratd and dgs ar assignd at th nd. \Edgs[ layr ={layr α,layr β}]{filnam} With th option layr only th dgs twn layr α and β ar plottd. Th argumnt is a tupl of oth layrs indicatd y {, }. Mor aout this option and th us of layrs is xplaind in Chaptr 4.

24

25 4 Multilayr Ntworks On of th main purposs of th tikz-ntwork packag is th illustration of multilayr ntwork structurs. Thry, all th prvious commands can usd. A multilayr ntwork is rprsntd as a thr-dimnsional ojct, whr ach layr is locatd at a diffrnt z plain. In ordr to nal this functionality, th option multilayr has to usd at th ginning of th tikzpictur. 4.1 Simpl Ntworks \Vrtx[ layr =numr]{nam} With th option layr th vrtx can assignd to a spcific layr. Layrs ar dfind y numrs (.g. 1, 2, 3,... ). Working with th multilayr option, ach \Vrtx has to assignd to a spcific layr. For th dg assignmnt no additional information is ndd. [multilayr] \Vrtx[x=0.5,IdAsLal,layr=1]{A} \Vrtx[x=1.5,IdAsLal,layr=1]{B} \Vrtx[x=1.5,IdAsLal,layr=2]{C} \Edg[nd=60](A)(B) \Edg[styl=dashd](B)(C) \Edg(C)(C) A BC Enaling th option multilayr, rturns th ntwork in a twodimnsional plan, lik th ntworks discussd for. Stting th argumnt multilayr =3d, th ntwork is rndrd in a thrdimnsional rprsntation. Pr dfault, th layr with th lowst numr is on th top. This and th spacing twn th layrs can changd with th command \StLayrDistanc. [multilayr=3d] \Vrtx[x=0.5,IdAsLal,layr=1]{A} \Vrtx[x=1.5,IdAsLal,layr=1]{B} \Vrtx[x=1.5,IdAsLal,layr=2]{C} \Edg[nd=60](A)(B) \Edg[styl=dashd](B)(C) \Edg(C)(C) A B Layr 1 C Layr 2

26 26 multilayr ntworks 4.2 Complx Ntworks Similar as in Chaptr 3 introducd, layrs can assignd to th vrtics y adding a column layr to th fil whr th vrtics ar stord. id, x, y,siz, color,opacity,lal,layr A, 0, 0,.4, grn,.9, a, 1 B, 1,.7,.6,,.5,, 1 C, 2, 1,.8,orang,.3, c, 1 D, 2, 0,.5, rd,.7, d, 2 E,.2,1.5,.5, gray,,, 1 F,.1,.5,.7, lu,.3, f, 2 G, 2, 1,.4, cyan,.7, g, 2 H, 1, 1,.4,yllow,.7, h, 2 Fil: ml_vrtics.csv u,v,lal,lw,color,opacity,nd,dirct A,B, a,.5,rd, 1, 30,fals B,C, c,.7,lu, 1, -60,fals A,E, a, 1,grn, 1, 45,tru C,E, c, 2,orang, 1, 0,fals A,A, aa,.3,lack,.5, 75,fals C,G, cg, 1,lu,.5, 0,fals E,H, h, 1,gray,.5, 0,fals F,A, fa,.7,rd,.7, 0,tru D,F, df,.7,cyan, 1, 30,tru F,H, fh,.7,purpl, 1, 60,fals D,G, dg,.7,lu,.7, 60,fals Fil: ml_dgs.csv With th commands \Vrtics and \Edgs, th ntwork can cratd automatically. Again th \Vrtics vrtics should prformd first and thn th command \Edgs. a c [multilayr=3d] \Vrtics{data/ml_vrtics.csv} \Edgs{data/ml_dgs.csv} \Vrtics[ layr =numr]{filnam} a a aa hc Layr 1 fa fh h f dg df d Layr 2 c cg g \Edgs[ layr ={layr α,layr β}]{filnam} With th \Vrtics option layr only th vrtics on th slctd layr ar plottd. Whil, with th \Edgs option layr, th dgs twn layr α and β ar plottd. Th argumnt is a tupl of oth layrs indicatd y {, }. [multilayr=3d] \Vrtics[layr=1]{data/ml_vrtics.csv} \Edgs[layr={1,1}]{data/ml_dgs.csv} a Layr 1 a a aa c c c

27 tikz-ntwork manual 27 Plotting dgs without dfining first th vrtics can don with th \Edgs option vrtics. This allows modifying spcific sts of Edgs. [multilayr=3d] \Edgs[vrtics=data/ml_vrtics.csv, layr={1,2},styl=dashd]{data/ml_dgs.csv} fa h cg 4.3 Layrs and Layouts Bsids adding vrtics and dgs to spcific layrs, vry othr TikZ ojct can drawn on such a layr using th Layr nvironmnt. With th option layr =layr α, th position of th canvas can assignd to th spcific layr. \gin{layr}[ layr =layr α] \nd{layr} [multilayr=3d] \gin{layr}[layr=1] \draw[vry thick] (-.5,-.5) rctangl (2.5,2); \nod at (-.5,-.5)[low right]{layr 1}; \nd{layr} \Vrtics[layr=1]{data/ml_vrtics.csv} \Edgs[layr={1,1}]{data/ml_dgs.csv} a Layr 1 a a aa c c c \StLayrDistanc{masur} With th command \StLayrDistanc th distanc twn th layrs and thir orintation can modifid. Pr dfault th distanc is st to 2\DfaultUnit (hr cm). A ngativ numr implis that layrs with a highr numr will stackd low layrs with a smallr numr. \StCoordinats[ xangl =numr, yangl =numr, zangl =numr, xlngth =numr, ylngth =numr, zlngth =numr] Th prspctiv of th thr-dimnsional plot can modifid y changing th orintation of th coordinat systm, which is don with th command \StCoordinats. Hr th angl and th lngth of ach axis can modifid. Angls ar dfind as a numr in th rang twn 360 and 360. Pr dfault, th lngths of th axs ar dfind y th idntity matrix, i.. no distortion. If th lngth ratio is changd x, y, and/or z valus ar distortd. Th \StCoordinats command has to ntrd for th multilayr option is calld! \StCoordinats[xAngl=-30,yLngth=1.2,xLngth=.8] [multilayr=3d] \Vrtics[layr=1]{data/ml_vrtics.csv} \Edgs[layr={1,1}]{data/ml_dgs.csv} a a a aa Layr 1 c c c

28

29 5 Dfault Sttings In ordr to customiz th look of th ntworks, ach layout stting usd can modifid and adaptd. Thr ar thr catgoris: Gnral sttings, vrtx styl, and dg styl. 5.1 Gnral Sttings With th gnral sttings mainly th sizs, distancs and masurs of th ntworks can modifid. \StDfaultUnit{unit} Th command \StDfaultUnit allows to chang th units usd for drawing th ntwork 1, including diamtrs of th vrtics, x and y coordinats or th distanc twn th layrs. Th dfault unit is cm. 1 Excpt th lin width, which ar dfind in pt. \StDistancScal{numr} With th command \StDistancScal, th distanc twn th vrtics can scald. Pr dfault 1 cm ntrd corrsponds to 1 cm drawn, i.. \StDistancScal{1}. Dcrasing or incrasing th scal changs th drawing distancs twn th vrtics. \StLayrDistanc{masur} With th command \StLayrDistanc th distanc twn th layrs and thir orintation can modifid. Pr dfault, th distanc is st to 2. A ngativ numr implis that layrs with a highr numr will stackd low layrs with a smallr numr. \StCoordinats[ xangl =numr, yangl =numr, zangl =numr, xlngth =numr, ylngth =numr, zlngth =numr] Th prspctiv of th thr-dimnsional plot can modifid y changing th orintation of th coordinat systm, which is don with th command \StCoordinats. Hr th angl and th lngth of ach axis can modifid. Angls ar dfind as a numr in th rang twn 360 and 360. Pr dfault, th lngth of th axs ar dfind y th idntity matrix, i.. no distortion. If th lngth ratio is changd x, y, and/or z valus ar distortd. Th \StCoordinats command has to ntrd for th multilayr option is calld!

30 30 dfault sttings 5.2 Vrtx Styl Th apparanc of th vrtics can modifid with th command \StVrtxStyl. This command will chang th dfault sttings of th vrtics in th ntwork. \StVrtxStyl{documnt options} Th following options ar availal: Option Dfault Typ Dfinition VrtxShap circl txt shap of th vrtx VrtxInnrSp 2pt masur sparation spac which will addd insid th shap VrtxOutrSp 0pt masur sparation spac outsid th ackground path VrtxMinSiz 0.6\DfaultUnit masur diamtr (siz) of th vrtx VrtxFillColor vrtxfill color color of th vrtx VrtxFillOpacity 1 numr opacity of th vrtx VrtxLinWidth 1pt masur lin width of th vrtx oundary VrtxLinColor lack color lin color of th vrtx oundary VrtxLinOpacity 1 numr lin opacity of th vrtx oundary VrtxTxtFont \scriptsiz fontsiz font siz of th vrtx lal VrtxTxtColor lack color color of th vrtx lal VrtxTxtOpacity 1 numr opacity of th vrtx lal VrtxTxtRotation 0 numr initial rotation of th vrtx Tal 5.1: Documnt styl options for th vrtics. 5.3 Edg Styl Th apparanc of th dgs can modifid with th command \StEdgStyl. This command will chang th dfault sttings of th dgs in th ntwork. \StEdgStyl{documnt options} Th following options ar availal: Option Dfault Typ Dfinition EdgLinWidth 1.5pt masur width of th dg EdgColor lack!75 color color of th dg EdgOpacity 1 numr opacity of th dg EdgArrow -latx txt arrow shap of th dirctd dg EdgTxtFont \scriptsiz fontsiz font siz of th dg lal EdgTxtOpacity 1 numr opacity of th dg lal EdgTxtFillColor whit color fill color of th dg lal EdgTxtFillOpacity 1 numr fill opacity of th dg lal EdgInnrSp 0pt masur sparation spac which will addd insid th shap EdgOutrSp 1pt masur sparation spac outsid th ackground path EdgTxtRotation 0 numr initial rotation of th dg lal Tal 5.2: Documnt styl options for th dgs.

31 6 Troulshooting and Support 6.1 Tuft-LATEX Wsit Th wsit for th tikz-ntwork packags is locatd at https: //githu.com/hackl/tikz-ntwork. Thr, you ll find th actual vrsion of th sourc cod, a ug trackr, and th documntation. 6.2 Gtting Hlp If you v ncountrd a prolm with on of th tikz-ntwork commands, hav a qustion, or would lik to rport a ug, plas snd an mail to m or visit our wsit. To hlp m troulshoot th prolm mor quickly, plas try to compil your documnt using th dug class option and snd th gnratd.log fil to th mailing list with a rif dscription of th prolm. 6.3 Errors, Warnings, and Informational Mssags Th following is a list of all of th rrors, warnings, and othr mssags gnratd y th tikz-ntwork classs and a rif dscription of thir manings. Error:! TX capacity xcdd, sorry [main mmory siz= ]. Th considrd ntwork is to larg and pdflatx runs out of mmory. This prolm can solvd y using lualatx or xtx instad. 6.4 Packag Dpndncis Th following is a list of packags that th tikz-ntwork packag rly upon. Packags markd with an astrisk ar optional. tx xifthn xkyval datatool tikz arrows positioning 3d fit calc ackgrounds

32

33 A ToDo A.1 Cod to fix chang dfault ntris for Boolan options in th vrtics fil. A.2 Documntation add indics to th manual. add an xtndd tutorial/xampl to th documnt. clan-up and documnt th.sty fil. upload th packag to CTAN, if it is appropriatd tstd. A.3 Faturs add \Plain command in ordr to crat automatically multilayr plains. add a sphrical coordinat systm A.4 Add-ons add igraph to tikz-ntwork compilr (.g. plot function) add ntworkx to tikz-ntwork compilr (.g. plot function) add QGIS to tikz-ntwork compilr

34