[Tex/LaTex] Use timeline library with months

tikz-pgf

I'm trying to adapt this answer to a timeline that has months instead of years. The first part of the MWE below is just the timeline library.

\documentclass[tikz]{standalone}
% Timeline library
\usetikzlibrary{backgrounds,calc}
\usepackage{xstring}

\pgfkeys{/tikz/.cd,
  timespan/.store in=\timespan,
  timespan=Week,
  timeline width/.store in=\timelinewidth,
  timeline width=20,
  timeline height/.store in=\timelineheight,
  timeline height=1,
  timeline offset/.store in=\timelineoffset,
  timeline offset=0.15,
  initial week/.store in=\initialweek,
  initial week=1,
  end week/.store in=\endweek,
  end week=2,
  time point/.store in=\timepoint,
  time point=0.5,
  between week/.style args={#1 and #2 in #3}{
    initial week=#1,
    end week=#2,
    time point=#3,
  },
  involvement degree/.store in=\involvdegree,
  involvement degree=2cm,
  phase color/.store in=\phasecol,
  phase color=red!50!orange,
  phase appearance/.style={
    circle,
    opacity=0.3,
    minimum size=\involvdegree,
    fill=\phasecol
  },
}
\pgfkeys{/tikz/milestone/.cd,
  at/.store in=\msstartpoint,
  at=phase-1.north,
  circle radius/.store in=\milestonecircleradius,
  circle radius=0.1cm,
  direction/.store in=\msdirection,
  direction=90:2cm,
  text/.store in=\mstext,
  text={},
  text options/.code={\tikzset{#1}},
}

\newcommand{\reftimespan}{\MakeLowerCase{\timespan}}

\newcommand{\timeline}[1]{
  \draw[fill,opacity=0.8] (0,0) rectangle (\timelinewidth,\timelineheight);
  \shade[top color=black, bottom color=white,middle color=black!20]
    (0,0) rectangle (\timelinewidth,-\timelineoffset);
  \shade[top color=white, bottom color=black,middle color=black!20]
    (0,\timelineheight) rectangle (\timelinewidth,\timelineheight+\timelineoffset);

  \foreach \smitem [count=\xi] in {1,...,#1} {\global\let\maxsmitem\xi}
  \pgfmathsetmacro\position{\timelinewidth/(\maxsmitem+1)}
  \node at (0,0.5\timelineheight)(\timespan-0){\phantom{Week 0}};

  \foreach \x[count=\xi] in {1,...,#1}{
      \node[text=white]at +(\xi*\position,0.5\timelineheight) (\timespan-\xi) {\timespan\ \x};
  }
}

\newcounter{involv}
\setcounter{involv}{0}

\newcommand{\phase}[1]{
\stepcounter{involv}
\node[phase appearance,#1]
(phase-\theinvolv)
at ($(\timespan-\initialweek)!\timepoint!(\timespan-\endweek)$){};
}

\newcommand{\initialphase}[1]{
\node[phase appearance,#1,anchor=west,between week=0 and 1 in 0,]
(phase-\theinvolv)
at ($(\timespan-0)!0!(\timespan-1)$){};
\setcounter{involv}{0}
}

\newenvironment{phases}{\begin{pgfonlayer}{background}}{\end{pgfonlayer}}

\newcommand{\addmilestone}[1]{
\pgfkeys{/tikz/milestone/.cd,#1}
\draw[double,fill] (\msstartpoint) circle [radius=\milestonecircleradius];
\draw(\msstartpoint)--++(\msdirection)node[/tikz/milestone/text options]{\mstext};
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


% redefinition for having a interval not starting from 1
\renewcommand{\timeline}[1]{
  \draw[fill,opacity=0.8] (0,0) rectangle (\timelinewidth,\timelineheight);
  \shade[top color=black, bottom color=white,middle color=black!20]
    (0,0) rectangle (\timelinewidth,-\timelineoffset);
  \shade[top color=white, bottom color=black,middle color=black!20]
    (0,\timelineheight) rectangle (\timelinewidth,\timelineheight+\timelineoffset);

  \foreach \smitem [count=\xi] in {#1}  {\global\let\maxsmitem\xi}
  \pgfmathsetmacro\position{\timelinewidth/(\maxsmitem+1)}
  \node at (0,0.5\timelineheight)(\timespan-0){\phantom{Week 0}};

  \foreach \x[count=\xi] in {#1}{
      \node[text=white]at +(\xi*\position,0.5\timelineheight) (\timespan-\xi) {\timespan\ \x};
  }
}

\begin{document}

\begin{tikzpicture}[timespan={},% empty to not display a label before the month
  between month/.style args={#1 and #2 in #3}{% auxiliary style for month
    initial week=#1,
    end week=#2,
    time point=#3,
  }
  ]
\timeline{August,September, October, November, December, January, February,
  March, April, May, June, July} % months

% put here the phases
\begin{phases}
\phase{between month=1 and 10 in 0.2,involvement degree=4cm}
\phase{between month=3 and 7 in 0.5,phase color=blue!80!cyan}
\end{phases}

% put here the milestones
\addmilestone{at=phase-2.110,direction=120:1.5cm,text={Testing milestone text},text options={above}}
\end{tikzpicture}
\end{document}

Edit: Using the updated version of the timeline libray the names of the months in the following MWE are wrongly aligned and too close one to another. The other thing that I would like to achieve is to say something like

\phase{between week=1 and 7 in 0.5,involvement degree=4cm}

and have the phase (bubble) cover the whole distance between the starting and endpoints.

\documentclass[tikz]{standalone}

\input{timeline_library.tex}

\begin{document}
\begin{tikzpicture}[timespan={}]

\timeline[custom interval=true]{August, September, October, November, December,
  January, February, March, April, May, June, July}

\begin{phases}
\initialphase{involvement degree=1.75cm,phase color=black}
\phase{between week=1 and 7 in 0.5,involvement degree=4cm}
\end{phases}

\addmilestone{at=phase-0.90,direction=90:1cm,text={Initial meeting},text options={above}}
\end{tikzpicture}
\end{document}

enter image description here

Best Answer

The new version of the library can use custom time intervals. As a result, it is now possible to set up a timeline with the names of the months:

\timeline[custom interval=true]{January, March, May, July, September, November}

A complete example:

\documentclass[border=10pt]{standalone}

\usepackage{tikz}
\usetikzlibrary{timeline}

\begin{document}

\begin{tikzpicture}[timespan={}]% no label is displayed for the timespan

\timeline[custom interval=true]{January, March, May, July, September, November}

% put here the phases
\begin{phases}
\initialphase{involvement degree=1.75cm,phase color=black}
\phase{between week=1 and 2 in 0.1,involvement degree=2.25cm}
\phase{between week=1 and 2 in 0.5,involvement degree=3cm}
\phase{between week=1 and 2 in 0.9,involvement degree=2.125cm}
\phase{between week=3 and 4 in 0.7,phase color=blue!80!cyan}
\end{phases}

% put here the milestones
\addmilestone{at=phase-0.90,direction=90:1cm,text={Initial meeting},text options={above}}
\addmilestone{at=phase-0.270,direction=270:1cm,text={Initial meeting},text options={below}}

\addmilestone{at=phase-2.110,direction=120:1.5cm,text={Research},text options={above}}
\addmilestone{at=phase-2.250,direction=240:1.5cm,text={Need Agreement},text options={below}}
\end{tikzpicture}

\end{document}

The result:

enter image description here

For what concern the vertical alignment, a text depth was missing since the labels were not supposed to be pure text at the beginning. It is fixed in version 0.3a of the library.

For what concern the other point, I will show how to change shape and to use the between month option (basically an alias of between week): so far it is not possible to draw a rectangle from month 1 to month 7, but one has to play with the key involvement degree to find the correct setting. Why? Very simple. To a TikZ node you can only specify the minimum width and nodes are needed to be able to deploy milestones. To have nodes' width to be of a given width, one has to measure things and at the moment I don't have time to implement this feature. It is a nice suggestion, though, so it will be implemented in the near future.

The code:

\documentclass[border=10pt]{standalone}

\usepackage{tikz}
\usetikzlibrary{timeline}

\begin{document}

\begin{tikzpicture}[timespan={},timeline width=25]

\timeline[custom interval=true]{August, September, October, November, December,
  January, February, March, April, May, June, July}

% put here the phases
\begin{phases}
\initialphase{involvement degree=1.75cm,phase color=black}
\tikzset{phase appearance/.append style={
  rectangle, 
  minimum width=\involvdegree,
  minimum height=3cm}
}
\phase{between month=1 and 7 in 0.5,phase color=green!80!black,involvement degree=12cm}
\end{phases}

% put here the milestones
\addmilestone{at=phase-0.90,direction=90:1cm,text={Initial meeting},text options={above}}
\addmilestone{at=phase-0.270,direction=270:1cm,text={Initial meeting},text options={below}}
\addmilestone{at=phase-1.270,direction=270:1cm,text={A big achievement},text options={below}}
\end{tikzpicture}

\end{document}

The result:

enter image description here

Related Solutions

[Tex/LaTex] How to use OGDF library with TikZ 3.0

Too long for a comment. In Section 34 Graph Drawing Algorithms: The Open Graph Drawing Framework, the PGF documentation has a rather discouraging message about this:

Remark: The integration of the ogdf library is still under construction and the examples in this section are more a proof-of-concept. So, use at your own risk.

and then, a few lines below:

Since C++ code is compiled and not interpreted (like Lua), in order to use the present library, you need a compiled version of the pgf interface code for the ogdf library (pgf/gd/ogdf/c/ogdf_script.so) installed correctly for your particular architecture. This is by no means trivial...

So, in order for those examples to work, you need a compiled version of pgf/gd/ogdf/c/ogdf_script.so installed correctly for your particular architecture. How to do that, I wouldn't know... I did a quick search on the web but couldn't find anything really helpful. It really seems to be not a trivial task.

[Tex/LaTex] TikZ: Calculate position and size of node from optional arguments

Edit: After many iteration finally you show, what you like to achieve.

Simple solution: The simplest way to achieve desired picture (considering only bars with text) you can obtain width:

\documentclass[tikz,border=1cm]{standalone}
    \usetikzlibrary{quotes}

   \tikzset{BAR/.style = {%
every edge quotes/.style = {% " Bar Node"
    font=\scriptsize\sffamily,
    align=center,
    inner sep=0.5mm,
    auto},
BL/.style = {% " Bar Line"
    draw=blue!50!gray!40!white,
    line width=1.2mm, 
    line cap=round}}
            }% end of tikzset

    \begin{document}
\begin{tikzpicture}[BAR]
\draw[BL] (2,2) edge["The long\\two line Text"] ++ (3.3,0);
\draw[BL] (0,1) edge["The Text"] ++ (4.4,0);
\draw[BL] (0,0) edge[swap,"The Text"] ++ (4.4,0);
\draw[BL] (5,0) edge[swap,"Text longer than bar"] ++ (1.1,0);
\end{tikzpicture}
    \end{document}

In this example start and end of bar line is determined with absolute coordinate beginning of bar line and its end width relative coordinate -- its shift to right. Text above/below bars is written in quotes, and can be in more lines. Line broken should be done manually. For working of above MWE the TikZ library quotes is needed.

For text below bar line, you need to add to edge parameter swap.

Not so simple solution: Based on the first sketch in the question. There presented bar is the simplest determine width the node, which fit coordinates defines its start and end. Using nodes enable use shadings for its fill (what in the first solution is not possible).

Text here is set as label to this node, for its positioning is introduced parameters (above, below are appropriates ones)

\documentclass[tikz,border=1cm]{standalone}
    \usetikzlibrary{fit,shadings}

% start position of bar (determined with absolute coordinate}
\newcommand\startbar[1]{\path (#1) coordinate (startb);}
% end position of bar (determined by relative}
\newcommand\stopbar[1]{\path  (startb) ++ (#1,0) coordinate (stopb);}

   \tikzset{BAR/.style = {%
          bar/.style args = {##1/##2}{%
    label=##1:##2,
%    draw, very thin,
    minimum height=1.6mm,
    rounded corners=\pgfkeysvalueof{/pgf/minimum height}/2,
    inner sep=0pt,
%    fill= blue!50!gray!40!white
    top color=blue!60, bottom color=blue!60, middle color=blue!10,
    fit=(startb) (stopb),
    node contents={}},
every label/.append style = {%
    font=\scriptsize\sffamily,
    label distance=1pt, % set to desired distance
    align=center,       % multi line text
    inner sep= 0pt},    % eliminate inner sep influence
                        }
            }% end of tikzset

    \begin{document}
\begin{tikzpicture}[BAR]
\startbar{2,2}\stopbar{3.3}\node[bar=above/The long\\long two line Text];
\startbar{1,1}\stopbar{4.4}\node[bar=above/The Text];
\startbar{0,0}\stopbar{4.4}\node[bar=below/The Text];
\startbar{5,0}\stopbar{1.1}\node[bar=below/Text longer than bar];
\end{tikzpicture}
    \end{document}

Imitation of second image in question: For exercise and to show, how bars can be included in second image presented in question. As base is selected the second example:

\documentclass[tikz,border=1cm]{standalone}
    \usetikzlibrary{fit,shadings,shapes.symbols}

\newcommand\startbar[1]{\path (#1) coordinate (startb);}
\newcommand\stopbar[1]{\path  (startb) ++ (#1,0) coordinate (stopb);}

   \tikzset{BAR/.style = {%
%   
              base/.style = {%
    inner sep=0pt,
    top color=blue!60, bottom color=blue!60, middle color=blue!10,
    fit=(startb) (stopb),
    node contents={}
                            },
%
          bar/.style args = {##1/##2}{base,%
    label=##1:##2,
    minimum height=1.6mm,
    rounded corners=\pgfkeysvalueof{/pgf/minimum height}/2},
%
          timeline/.style = {base,%
    shape=signal, signal to=east,
    minimum height=5mm},
%
               year/.style = {%
    shape=circle, 
    draw, fill=gray!10,
    inner sep=1pt,
    font=\scriptsize\sffamily},
%
every label/.append style = {%
    font=\scriptsize\sffamily,
    label distance=1pt, % set to desired distance
    align=center,       % multi line text
    inner sep= 0pt},    % eliminate inner sep influence
                        }
            }% end of tikzset

    \begin{document}
\begin{tikzpicture}[BAR]
\startbar{2,2}\stopbar{3.3}\node[bar=above/The long\\long two line Text];
\startbar{1,1}\stopbar{4.4}\node[bar=above/The Text];
\startbar{0,0}\stopbar{4.4}\node[bar=below/The Text];
\startbar{0,0.5}\stopbar{7}\node[timeline];
    \foreach \y [count=\i] in {2009,2010,...,2015}
        \node[year] at (\i-0.5,0.5) {\y};
\startbar{5,0}\stopbar{1.1}\node[bar=below/Text longer than bar];
\end{tikzpicture}
    \end{document}

Best Answer

Related Solutions

[Tex/LaTex] How to use OGDF library with TikZ 3.0

[Tex/LaTex] TikZ: Calculate position and size of node from optional arguments

Related Question