Members
(inner) additionalDivisionsAmount
amount of additional(redundant) divisions on left and right (top, bottom) side of ruler
(inner) c
result config
(inner) currentPosition :number
Current position of ruler
Type:
- number
(inner) endPosition :number
End position of drawing ruler
Type:
- number
(inner) g :SVGGElement
main group (g svg element) that contains all divisions and texts
Type:
- SVGGElement
(inner) scale :number
Scale of ruler
Type:
- number
(inner) startPosition :number
Start position of drawing ruler
Type:
- number
(inner) texts :Array.<Array.<SVGTextElement>>
Array of arrays of all texts
Type:
- Array.<Array.<SVGTextElement>>
Methods
getUnitConversionRate() → {number}
Returns:
how much pixels are in used unit.
- Type
- number
render()
Renders ruler inside svg element
resize()
Updates size with current clientWidth(height) in case it's bigger than previous one.
Only appends more divisions and texts if necessary.
saveAsImage(saveFinishCallback)
Saves ruler as image.
Parameters:
| Name | Type | Description |
|---|---|---|
saveFinishCallback |
saveFinishCallback |
scrollTo(pos, useUnits)
Scrolls ruler to specified position.
Parameters:
| Name | Type | Description |
|---|---|---|
pos |
number | left(or top for vertical rulers) position to scroll to. |
useUnits |
boolean | if true pos will be multiplied by unit conversion rate; |
setScale(scaleValue)
Scales the ruler's text values by specific value.
Parameters:
| Name | Type | Description |
|---|---|---|
scaleValue |
number |