1.2.0 - This version may not be safe as it has not been updated for a long time. Find out if your coding project uses this component and get notified of any reported security vulnerabilities with Meterian-X Open Source Security Platform
Maintain your licence declarations and avoid unwanted licences to protect your IP the way you intended.
Apache-2.0 - Apache License 2.0Terminal ASCII line charts in Elixir with no dependencies.
Ported to Elixir from kroitor/asciichart
Add asciichart
to the list of dependencies in mix.exs
:
def deps do
[{:asciichart, "~> <version>"}]
end
{:ok, chart} = Asciichart.plot([1, 2, 3, 3, 2, 1])
chart |> IO.puts()
# should render as
3.00 ┤ ╭─╮
2.00 ┤╭╯ ╰╮
1.00 ┼╯ ╰
One or more of the following settings can be provided:
offset
- number of characters to set as the chart's (left) offsetheight
- adjusts the height of the chartpadding
- one or more characters to use for the label's (left) paddingcharset
- a customizable character set. See Asciichart.Charset
.precision
- number of fractional digits to keep for floating-point values{:ok, chart} = Asciichart.plot([1, 2, 5, 5, 4, 3, 2, 100, 0], height: 3, offset: 10, padding: "__")
chart |> IO.puts()
# should render as
╭─> label
------
100.00 ┼ ╭╮
_50.00 ┤ ││
__0.00 ┼──────╯╰
--
---- ╰─> label padding
╰─> remaining offset (without the label)
# Rendering of empty charts is not supported
Asciichart.plot([])
{:error, "No data"}
If you want to change the character set, you can use a predefined one in Asciichart.Charset
or create your own.
{:ok, chart} = Asciichart.plot([1, 2, 5, 5, 4, 3, 2, 0], height: 5, charset: Asciichart.Charset.single_char("*"))
chart |> IO.puts()
5.00 ┤ ***
3.75 ┤ * **
2.50 ┤ * **
1.25 ┤** **
0.00 ** *
We use SemVer for versioning.
This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details
Copyright 2018 https://github.com/sndnv
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.