API Docs for: 1.0.0
Show:

MatrixBackground Class

Defined in: src/gallery-matrix-background/js/MatrixBackground.js:9
Module: gallery-matrix-background

Node plugin to display falling text similar to what was used in the credits for The Matrix. If you plug into the body element, then it will fill the viewport. Otherwise, you must set a width and height for the node.

Constructor

MatrixBackground

(
  • config
)

Defined in src/gallery-matrix-background/js/MatrixBackground.js:9

Parameters:

  • config Object

    Plugin configuration

Attributes

charRange

Array

Defined in src/gallery-matrix-background/js/MatrixBackground.js:33

The range of Unicode characters to use for the background noise.

Default: ['\u30A1', '\u30FA']

computeWidestChar

Boolean

Defined in src/gallery-matrix-background/js/MatrixBackground.js:66

If you do not have a monospace font for the charRange, set this to true to computer the widest character in the range. Note that this can take a long time if you have a large charRange!

Default: false

monospace

Boolean

Defined in src/gallery-matrix-background/js/MatrixBackground.js:51

Set to true to force a monospace font. This only works if the browser can find a monospace version of the character range which you are using.

Default: true for IE, false for all other browsers

spinFraction

Number

Defined in src/gallery-matrix-background/js/MatrixBackground.js:81

Fraction of total columns that have a spinning character.

Default: 0.2