UNPKG

2.14 kBJavaScriptView Raw
1
2import * as fsw from './fsw';
3import * as fswquery from './fswquery';
4import * as swu from './swu';
5import * as swuquery from './swuquery';
6import * as style from './style';
7import * as convert from './convert';
8
9export { fsw, fswquery, swu, swuquery, style, convert }
10
11
12
13/**
14 * @typedef {object} ColumnOptions
15 * @property {number} height - the height of the columns
16 * @property {number} width - the widths of the columns
17 * @property {number} offset - the lane offset for left and right lanes
18 * @property {number} pad - amount of padding before and after signs as well as at top, left, and right of columns
19 * @property {number} margin - amount of space at bottom of column that is not available
20 * @property {boolean} dynamic - enables variable width columns
21 * @property {string} background - background color for columns
22 * @property {StyleObject} style - an object of style options
23 * @property {object} punctuation - an object of punctuation options
24 * @property {boolean} punctuation.spacing - enables special spacing for punctuation with no space above and custom space below
25 * @property {number} punctuation.pad - the amount of spacing after a punctuation if punctuation spacing is enabled
26 * @property {boolean} punctuation.pull - prevents line breaks before punctuation by reducing spacing between signs in a column
27 */
28
29/**
30 * @typedef {ColumnSegment[]} ColumnData
31 */
32
33/**
34 * @typedef {object} ColumnSegment
35 * @property {number} x - the x position in the column
36 * @property {number} y - the y position in the column
37 * @property {number} minX - the min x value within the segment
38 * @property {number} minY - the min y value within the segment
39 * @property {number} width - the width of the text segment
40 * @property {number} height - the height of the text segment
41 * @property {number} lane - Left as -1, Middle as 0, Right as 1
42 * @property {number} padding - the padding of the text segment affects colored background
43 * @property {string} segment - "sign" or "symbol"
44 * @property {string} text - the text of the sign or symbol with optional style string
45 * @property {number} zoom - the zoom size of the segment
46 */