Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ChrisNikkel/SharpVG

Create SVG vector graphics in F#
https://github.com/ChrisNikkel/SharpVG

animation fable graphics jupyter svg vector-graphics

Last synced: 4 months ago
JSON representation

Create SVG vector graphics in F#

Host: GitHub
URL: https://github.com/ChrisNikkel/SharpVG
Owner: ChrisNikkel
License: mit
Created: 2016-06-26T04:50:26.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2023-09-16T15:02:41.000Z (10 months ago)
Last Synced: 2024-01-16T05:56:00.300Z (6 months ago)
Topics: animation, fable, graphics, jupyter, svg, vector-graphics
Language: F#
Homepage: http://www.sharpvg.com/
Size: 634 KB
Stars: 70
Watchers: 5
Forks: 10
Open Issues: 21
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Lists

awesome-fsharp - SharpVG ★ 32 ⧗ 0 - Create SVG vector graphics in F#. [MIT] (Visualization / Creating type providers)

README

        # SharpVG

A .NET Standard library for F# to generate vector graphics in SVG format.

_[Pull requests](https://github.com/ChrisNikkel/SharpVG/pulls) and [suggestions](https://github.com/ChrisNikkel/SharpVG/issues) are greatly appreciated._

[Source code on GitHub](https://github.com/ChrisNikkel/SharpVG)

[![NuGet Info](https://buildstats.info/nuget/SharpVG?includePreReleases=true)](https://www.nuget.org/packages/SharpVG/)

![.NET Core](https://github.com/ChrisNikkel/SharpVG/workflows/.NET%20Core/badge.svg)

[![Build history](https://buildstats.info/github/chart/ChrisNikkel/SharpVG?branch=master)](https://github.com/ChrisNikkel/SharpVG/actions)

## Why SharpVG?

  - Allows you to emit SVG using simple F# commands so that you can create graphics and animations that are easy to distribute

  - Ability to render dynamically using [Fable](http://fable.io) to create interactive web pages

  - All basic SVG elements are supported: [line](https://github.com/ChrisNikkel/SharpVG/wiki/Line), [circle](https://github.com/ChrisNikkel/SharpVG/wiki/Circle), [ellipse](https://github.com/ChrisNikkel/SharpVG/wiki/Ellipse), [rect](https://github.com/ChrisNikkel/SharpVG/wiki/Rect), [text](https://github.com/ChrisNikkel/SharpVG/wiki/Text), [polygon](https://github.com/ChrisNikkel/SharpVG/wiki/Polygon), [polyline](https://github.com/ChrisNikkel/SharpVG/wiki/polyLine), [path](https://github.com/ChrisNikkel/SharpVG/wiki/Path), [image](https://github.com/ChrisNikkel/SharpVG/wiki/Image), and [groups](https://github.com/ChrisNikkel/SharpVG/wiki/Group)

  - No understanding of SVG is required and its as easy as using seq, list, or array

  - No external dependencies other than SharpVG are required

  - .NET Standard cross platform support on Windows, Linux, and OSX

  - Limited support for SVG animations

  - Reusable styles

## SharpVG Goals

  - To enable easy cross platform graphics in F#

  - To create simple and clear DSL

  - To reduce invalid state and runtime problems

## Try SharpVG

Run the interactive notebook: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ChrisNikkel/SharpVG/master)

## Examples

```F#

let position = Point.ofInts (10, 10)

let area = Area.ofInts (50, 50)

let style = Style.create (Color.ofName Colors.Cyan) (Color.ofName Colors.Blue) (Length.ofInt 3) 1.0 1.0

Rect.create position area

  |> Element.createWithStyle style

  |> printf "%O"

```

```html

```

```F#

let center = Point.ofInts (60, 60)

let radius = Length.ofInt 50

let style = Style.create (Color.ofName Colors.Violet) (Color.ofName Colors.Indigo) (Length.ofInt 3) 1.0 1.0

Circle.create center radius

  |> Element.createWithStyle style

  |> Svg.ofElement

  |> Svg.toHtml "Example"

  |> printf "%s"

```

```html

Example

```

## Building SharpVG

Clone the repository:

```bash

git clone https://github.com/ChrisNikkel/SharpVG.git

cd SharpVG

```

Start the build:

```bash

dotnet build

```

Run the tests:

```bash

dotnet test Tests

```

Run the examples:

```bash

dotnet run -p Examples/Triangle/Triangle.fsproj

dotnet run -p Examples/Life/Life.fsproj

```

Explore interactively:

```bash

fsharpi -r:SharpVG/bin/Debug/netcoreapp2.0/SharpVG.dll

```

```F#

open SharpVG;;

Circle.create Point.origin (Length.ofInt 10) |> printf "%O";;

Circle.create Point.origin (Length.ofInt 10) |> Element.create |> Svg.ofElement |> Svg.toHtml "Example";;

#quit;;

```

Explore interactively with a Notebook:

Install Visual Studio Code plugin for [Interactive Notebooks](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.dotnet-interactive-vscode)

```bash

Code Examples/Notebooks/SharpVG.dib

```

## Documentation

Read the documentation [here](https://github.com/ChrisNikkel/SharpVG/wiki).

## Support

Please submit bugs and feature requests [here](https://github.com/ChrisNikkel/SharpVG/issues).

## Library License

The library is available under the MIT license. For more information see the [license file](https://github.com/ChrisNikkel/SharpVG/blob/master/LICENSE.md).

## Maintainer(s)

  - [@ChrisNikkel](https://github.com/ChrisNikkel)