Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ivnsch/chartlegends

Easy to use and highly customizable chart legends
https://github.com/ivnsch/chartlegends

chart charts graph ios legends plot plots swift swift-3

Last synced: 3 days ago
JSON representation

Easy to use and highly customizable chart legends

Host: GitHub
URL: https://github.com/ivnsch/chartlegends
Owner: ivnsch
License: apache-2.0
Created: 2017-01-03T13:37:15.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2019-02-11T11:10:37.000Z (over 5 years ago)
Last Synced: 2024-09-30T16:50:07.864Z (3 days ago)
Topics: chart, charts, graph, ios, legends, plot, plots, swift, swift-3
Language: Swift
Homepage:
Size: 132 KB
Stars: 35
Watchers: 2
Forks: 15
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# ChartLegends

[![Version](https://img.shields.io/cocoapods/v/ChartLegends.svg?style=flat)](http://cocoadocs.org/docsets/ChartLegends)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![License](https://img.shields.io/cocoapods/l/ChartLegends.svg?style=flat)](http://cocoadocs.org/docsets/ChartLegends)

Easy to setup and highly customizable collection view based chart legends.

Swift 4.0, iOS 8+

![ScreenShot](Screenshots/IMG_1283.PNG)

## Features:
- Define the layout with only a flag, in interface builder or code.
- Predefined shapes and possibility to use custom paths.
- Per-cell configuration or overrides, e.g. to set a different font or shape than other cells.
- Custom views via `UICollectionView` subclasses.
- Full autolayout support
- Interactive
- Scrollable
- Compatible with any chart type or library.

## Installation

### CocoaPods

Add to your Podfile:

```ruby
use_frameworks!
pod 'ChartLegends'
```

### Carthage

Add to your Cartfile:

```
github "i-schuetz/ChartLegends"
```

## Quickstart

Simply:

```swift
@IBOutlet weak var legendsView: ChartLegendsView!

legendsView.setLegends(
(text: "Chemicals", color: UIColor.orange),
(text: "Forestry", color: UIColor.green)
)
```

## Usage

### Predefined legend types

ChartLegends currently supports these types out of the box:

#### Plain text
Displays text in the given color. The example in the quick start section produces this kind of legends.

#### Shape with text
Displays text with a shape on the left side, with given color. Here, also, there are some predefined options, for example circle, with a specified radius, or rect, with specified width and height.

For example, to use legends with a small colored circle on the left:
```swift
legendsView.setLegends(.circle(radius: 7), [
(text: "Chemicals", color: UIColor.orange),
(text: "Forestry", color: UIColor.green)
])
```

If you want to show a shape that's not in the predefined types, you also can provide a path. Example:
```swift
let pathGenerator = {(size: CGSize) in
return UIBezierPath()
}
legendsView.setLegends(pathGenerator, [
(text: "Chemicals", color: UIColor.orange),
(text: "Forestry", color: UIColor.green)
])
```

Of course the idea is to expand the predefined types to support all possible regularly used paths. Don't hesitate to make a pull request with your path if you think it's of common interest!

### Custom cells

If you need more customization, you can also use custom cells. Example:

```swift
legendsView.configure(cellType: MyCustomCell.self) {cell, legend, indexPath in
cell.label.text = legend.text
// other custom configuration
}
```
This is type safe and concise - we don't need casting or delegates to configure the cell.

To implement a custom cell, you only have to extend `UICollectionViewCell` and conform to `ChartLegendCell` to add some additional functionality that `ChartLegendsView` needs to interact with the cell.

Here, again, feel free to submit a pull request with your cells, if you think they can be of common use.

### Layout types

You can configure the layout of `ChartLegendsView`, together with some other settings, directly in interface builder:

![ScreenShot](Screenshots/IBSettings.png)

#### Options:

- `flowLeft`: Left aligned flow layout. This should be the most commonly used horizontal legends layout.

- `columns`: Column layout - you can specify the number of columns in the "Columns field".

- `flow`: The default flow collection view layout, which will "justify" cells in order to occupy available space.

Note that when layout type is not set to `columns`, the Columns field is ignored.

## Demo

Download this repo and run the demo target!

## Lookout

Besides of adding new shapes and cells, there are surely several settings and refinements that can be done. Also, add animations!

## Contributing

1. Fork
2. Commit changes to a branch in your fork
3. Push your code and make a pull request

## Created By:

Ivan Schütz

## License

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.