@@ -13,13 +13,13 @@ parent element's dimensions can be properly transitioned
13
13
- [ measurements] ( #measurements )
14
14
- [ measured] ( #measured )
15
15
- [ validateDimension(dimension)] ( #validatedimension-dimension )
16
- - [ getMarginNumericValue(margin)] ( #getmarginnumericvalue-margin )
17
- - [ getVertMargin(margins, arrLength)] ( #getvertmargin-margins-arrlength )
18
- - [ getHorizMargin(margins, arrLength)] ( #gethorizmargin-margins-arrlength )
19
- - [ getElementMargins(element, axis)] ( #getelementmargins-element-axis )
20
- - [ getElementMeasure(element, dimension)] ( #getelementmeasure-element-dimension )
21
- - [ getParentMeasure(element, dimension)] ( #getparentmeasure-element-dimension )
22
- - [ getParentMeasures(element)] ( #getparentmeasures-element )
16
+ - [ getMarginNumericValue(margin)] ( #getmarginnumericvalue-margin ) ⇒ < code >number</ code >
17
+ - [ getVertMargin(margins, arrLength)] ( #getvertmargin-margins-arrlength ) ⇒ < code >number</ code >
18
+ - [ getHorizMargin(margins, arrLength)] ( #gethorizmargin-margins-arrlength ) ⇒ < code >number</ code >
19
+ - [ getElementMargins(element, axis)] ( #getelementmargins-element-axis ) ⇒ < code >number</ code >
20
+ - [ getElementMeasure(element, dimension)] ( #getelementmeasure-element-dimension ) ⇒ < code >number</ code >
21
+ - [ getParentMeasure(element, dimension)] ( #getparentmeasure-element-dimension ) ⇒ < code >Object</ code >
22
+ - [ getParentMeasures(element)] ( #getparentmeasures-element ) ⇒ < code >Object</ code >
23
23
- [ setDimensionMax(element, dimension, value)] ( #setdimensionmax-element-dimension-value )
24
24
- [ removeDimensionMax(element, dimension)] ( #removedimensionmax-element-dimension )
25
25
- [ setParentMaxMeasures(args)] ( #setparentmaxmeasures-args )
@@ -41,7 +41,7 @@ Throws a ReferenceError if 'dimension' is neither 'width' nor 'height'
41
41
| --------- | ------------------- | -------------------------- |
42
42
| dimension | <code >string</code > | Either 'width' or 'height' |
43
43
44
- ### getMarginNumericValue(margin)
44
+ ### getMarginNumericValue(margin) ⇒ < code >number</ code >
45
45
46
46
Returns only the numeric part of the margin property
47
47
@@ -52,7 +52,7 @@ Returns only the numeric part of the margin property
52
52
| ------ | ------------------- | -------------------------------- |
53
53
| margin | <code >string</code > | Margin value along with its unit |
54
54
55
- ### getVertMargin(margins, arrLength)
55
+ ### getVertMargin(margins, arrLength) ⇒ < code >number</ code >
56
56
57
57
Calculates the total margin of an element in the vertical axis
58
58
@@ -64,7 +64,7 @@ Calculates the total margin of an element in the vertical axis
64
64
| margins | <code >Array.< ; string> ; </code > | Array containing an element's margin values |
65
65
| arrLength | <code >number</code > | Number of values declared in the CSS margin property |
66
66
67
- ### getHorizMargin(margins, arrLength)
67
+ ### getHorizMargin(margins, arrLength) ⇒ < code >number</ code >
68
68
69
69
Calculates the total margin of an element in the horizontal axis
70
70
@@ -76,7 +76,7 @@ Calculates the total margin of an element in the horizontal axis
76
76
| margins | <code >Array.< ; string> ; </code > | Array containing an element's margin values |
77
77
| arrLength | <code >number</code > | Number of values declared in the CSS margin property |
78
78
79
- ### getElementMargins(element, axis)
79
+ ### getElementMargins(element, axis) ⇒ < code >number</ code >
80
80
81
81
Element's total margin in a given axis
82
82
@@ -88,7 +88,7 @@ Element's total margin in a given axis
88
88
| element | <code >HTMLElement</code > | The DOM element to calculate margins from |
89
89
| axis | <code >string</code > | 'horizontal' or 'vertical' margins |
90
90
91
- ### getElementMeasure(element, dimension)
91
+ ### getElementMeasure(element, dimension) ⇒ < code >number</ code >
92
92
93
93
Calculates the total width or height of an element
94
94
@@ -100,7 +100,7 @@ Calculates the total width or height of an element
100
100
| element | <code >HTMLElement</code > | The Dom element to measure |
101
101
| dimension | <code >string</code > | Either 'width' or 'height' |
102
102
103
- ### getParentMeasure(element, dimension)
103
+ ### getParentMeasure(element, dimension) ⇒ < code >Object</ code >
104
104
105
105
Calculates the element's parent dimension before and after 'element' is set to 'display: none'
106
106
@@ -112,7 +112,7 @@ Calculates the element's parent dimension before and after 'element' is set to '
112
112
| element | <code >HTMLElement</code > | The DOM element from which the parent will be measured |
113
113
| dimension | <code >string</code > | Either 'width' or 'height' |
114
114
115
- ### getParentMeasures(element)
115
+ ### getParentMeasures(element) ⇒ < code >Object</ code >
116
116
117
117
Calculates the width and height of an element's parent,
118
118
before and after the element is set to 'display: none'
0 commit comments