https://github.com/bomsy/d-lite

A small js library that simulates digital lighting.
https://github.com/bomsy/d-lite

Last synced: about 1 month ago
JSON representation

A small js library that simulates digital lighting.

• Host: GitHub
• URL: https://github.com/bomsy/d-lite
• Owner: bomsy
• Created: 2012-06-26T15:29:19.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2015-01-28T10:20:51.000Z (almost 10 years ago)
• Last Synced: 2023-03-23T12:55:12.236Z (over 1 year ago)
• Language: JavaScript
• Homepage: http://bomsy.github.com/d-lite
• Size: 838 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Dlite.js

A small js library that simulates digital lighting. Dependent on [d3.js](http://mbostock.github.com/d3/) library.

The character library currently contains all uppercase, lowercase characters, digits and some special characters such as *, -, _, ?, ., /, =, +, !.

## Compatibility

Compatible with ie9+, chrome, firefox, safari, opera

## Dependencies

This library is dependent on the [D3 Visualization library](http://mbostock.github.com/d3/).

## Getting Started

Creating a simple lighting to display "Hello World"

    Dlite("foo")

        .setContent("HELLO WORLD")

        .setSize(5)

        .setColor("#f00")

        .setAlignment(Dlite.align.HORIZONTAL)

        .setBackground(Dlite.background.SHOW)

        .show()

See more in the [Code examples](http://bomsy.github.com/d-lite/examples.html)

## Dlite

### methods

* __setContent([string]/[numbers]/[array])__ : Sets the content to be displayed. Content can be a string, series of digits, an array (basic array or passed through the _Dlite.waveform.domain_ generated function. See [code examples](http://bomsy.github.com/d-lite/examples.html))

* __setSize(size)__ : Sets the size of each lighting element. It takes a number as parameter (Note: no units).

* __setColor(color)__ : Sets the color for the lighting. it takes color strings, HEX or RGB values.

* __setAlignment(alignment)__ : Sets the alignment of the charaters in the content. The constants accepted by the alignment are either _Dlite.align.HORIZONTAL_ or _Dlite.align.VERTICAL_ .

* __setBackground(state)__ : Sets the state of the background. The 3 possible states are _Dlite.background.SHOW_ , _Dlite.background.PARTIAL_ or _Dlite.background.NONE_ .

* __show(delay, interval, duration, callback)__ : Starts the lighting. if no arguments is passed, it runs once (to display its currrent content). It also accepts 4 arguments  in which situation it runs according to the parameters specifications. See [code examples](http://bomsy.github.com/d-lite/examples.html)

* __Dlite.waveforms.domain(lowerlimit, upperlimit)__ : Allows for generating waveforms using random data. it takes in integer values for the lower and upper limits of the domain, then returns a function which is used to scale the waveform array. See [code examples](http://bomsy.github.com/d-lite/examples.html) above for more details.

### properties

* __version__ : Specifies the current version.

### constants

* __Dlite.align.HORIZONTAL__ : When used, elements will be aligned horizontally.

* __Dlite.align.VERTICAL__ : When used, elements will be aligned vertically. 

* __Dlite.background.SHOW__ : When used, the full background will be shown.

* __Dlite.background.PARTIAL__ : When used, an outline of background will be shown.

* __Dlite.background.NONE__ : When used, no background will be shown.

## Authors

This library is developed by [Hubert Boma Manilla](http://bomsy-webcode.blogspot.co.uk/).

## Licence

Copyright (c) 2012 [Hubert Boma Manilla](http://bomsy-webcode.blogspot.co.uk/)

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

"Software"), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

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 OR COPYRIGHT HOLDERS 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.