Metadata-Version: 2.1
Name: dash_holoniq_wordcloud
Version: 0.0.3
Summary: tag/word cloud, ses the wonderful d3-cloud under the hood
Home-page: https://github.com/stevej2608/dash-holoniq-wordcloud
Author: Steve Jones <jonesst2608@gmail.com>
License: MIT
Platform: UNKNOWN
Classifier: Framework :: Dash
Description-Content-Type: text/markdown
License-File: LICENSE

# dash-holoniq-wordcloud

![](https://raw.githubusercontent.com/stevej2608/dash-holoniq-wordcloud/master/docs/img/dash-holoniq-wordcloud.png)

This project is [Plotly/Dash] wrapper for for the highly configurable [wordcloud].

### Usage

    pip install dash-holoniq-wordcloud

```
from dash_holoniq_wordcloud import DashWordcloud

security_data = [
    ["Equity", 74, "Zillions of equity based funds"],
    ["Bond", 45],
    ["Global", 30],
    ["Sector Equity", 17],
    ["EUR", 15],
    ["Large Cap", 13],
    ["Europe", 11],
]

app.layout = html.Div([
    html.Div([
        DashWordcloud(
            id='wordcloud',
            list=security_data,
            width=300, height=200,
            gridSize=16,
            color='#f0f0c0',
            backgroundColor='#001f00',
            shuffle=False,
            rotateRatio=0.5,
            shrinkToFit=True,
            shape='circle',
            hover=True
            )
        ])
    ])

```
### Features

**DashWordcloud** supports the extensive wordcloud [API].

* Hover-over word highlighting and word tooltips are supported.
* Word *onClick* events are reported to Dash and can be used in Dash callbacks

## Installation

You can install *dash-holoniq-wordcloud* with `pip`:

```
pip install dash-holoniq-wordcloud
```

## Documentation

Head over to the [*README*][docs-homepage] for more details.

## Contributing

The source code for *dash-holoniq-wordcloud* is available
[on GitHub][dwc-repo]. If you find a bug or something is unclear, we encourage
you to raise an issue. We also welcome contributions, to contribute, fork the
repository and open a [pull request][dwc-pulls].


[Plotly/Dash]: https://dash.plot.ly/
[wordcloud]: https://github.com/timdream/wordcloud2.js
[API]: https://github.com/timdream/wordcloud2.js/blob/gh-pages/API.md
[dwc-repo]: https://github.com/stevej2608/dash-holoniq-wordcloud
[docs-homepage]: https://github.com/stevej2608/dash-holoniq-wordcloud/blob/master/README.md
[dwc-pulls]: https://github.com/stevej2608/dash-holoniq-wordcloud/pulls


