https://github.com/juliuste/colorize-transit-graph

Add “random” line colors to a given transit graph.
https://github.com/juliuste/colorize-transit-graph

library public-transport

Last synced: 3 days ago
JSON representation

Add “random” line colors to a given transit graph.

• Host: GitHub
• URL: https://github.com/juliuste/colorize-transit-graph
• Owner: juliuste
• License: isc
• Created: 2018-07-31T11:22:34.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-25T04:12:49.000Z (over 4 years ago)
• Last Synced: 2024-10-17T04:17:33.923Z (23 days ago)
• Topics: library, public-transport
• Language: JavaScript
• Homepage:
• Size: 38.1 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

• awesome-starred - juliuste/colorize-transit-graph - Add “random” line colors to a given transit graph. (library)

README

        
# colorize-transit-graph

Add “random” line colors to a given transit graph, e.g. generated using [`osm-transit-graph`](https://github.com/juliuste/osm-transit-graph).

[![npm version](https://img.shields.io/npm/v/colorize-transit-graph.svg)](https://www.npmjs.com/package/colorize-transit-graph)

[![Build Status](https://travis-ci.org/juliuste/colorize-transit-graph.svg?branch=master)](https://travis-ci.org/juliuste/colorize-transit-graph)

[![Greenkeeper badge](https://badges.greenkeeper.io/juliuste/colorize-transit-graph.svg)](https://greenkeeper.io/)

[![dependency status](https://img.shields.io/david/juliuste/colorize-transit-graph.svg)](https://david-dm.org/juliuste/colorize-transit-graph)

[![license](https://img.shields.io/github/license/juliuste/colorize-transit-graph.svg?style=flat)](license)

[![chat on gitter](https://badges.gitter.im/juliuste.svg)](https://gitter.im/juliuste)

## Installation

```shell

npm install -g colorize-transit-graph

```

## Usage

The library will add `color` attributes to all lines / line groups that don't yet have color information. Existing colors will be conserved.

The output graph could then be drawn by using [`svg-transit-map`](https://github.com/juliuste/svg-transit-map).

### CLI

```shell

Usage:

    cat graph.json | colorize-transit-graph > colorized-graph.json

```

Where `graph.json` containts a graph object with three attributes:

```js

{

    nodes: [ // list of all nodes

        {

            id: "900000042101", // required

            metadata: {

                x: 537.029, // x-coordinate in any metric, required

                y: 673.576 // y-coordinate in any metric, required, see also the --invert-y option

            }

        }

        // …

    ],

    edges: [ // list of all edges

        {

            // the direction of the edge will be ignored, source and target are therefore interchangeable

            source: "900000120025", // node id, required

            target: "900000120008", // node id, required

            metadata: {

                lines :["U5","U6"] // list of line ids, required. please note that parallel lines must be modeled as one edge with two metadata.lines entries

            }

        }

        // …

    ],

    lines: [ // additional information for lines. if lines are not found in this list, default colour / group will be applied

        {

            id: 'U6', // line id, required

            color: '#456', // line colour, optional. existing information will be conserved

            group: 'U6' // line group id, optional. lines with the same group id will be merged info one for sections where they run in parallel

        }

        // …

    ]

}

```

### As a library

The module can be used as a JS library:

```js

const colorizeTransitGraph = require('colorize-transit-graph')

const graph = require('./graph.json') // your transit graph

const colorized = colorizeTransitGraph(graph)

```

## Example

Graphs drawn using [`svg-transit-map`](https://github.com/juliuste/svg-transit-map).

```shell

    cat example/berlin-input.json | colorize-transit-graph > example/berlin-output.json

    cat example/berlin-output.json | svg-transit-map > example/berlin-output.svg

```

## Input

![Berlin subway transit map with some color information](example/berlin-input.svg)

## Output

![Berlin subway transit map fully colorized](example/berlin-output.svg)

## Contributing

If you found a bug or want to propose a feature, feel free to visit [the issues page](https://github.com/juliuste/colorize-transit-graph/issues).