Skip to content

Commit 2284644

Browse files
simeonoffsimeonoff
committed
docs(theme): udpdate the sassdoc for various charts
1 parent a6be81c commit 2284644

File tree

5 files changed

+51
-31
lines changed

5 files changed

+51
-31
lines changed

‎projects/igniteui-angular/src/lib/core/styles/components/charts/_funnel-chart-theme.scss‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
////
22
/// @group themes
3-
/// @access public
3+
/// @access private
44
/// @author <a href="https://github.com/desig9stein" target="_blank">Marin Popov</a>
55
////
66

‎projects/igniteui-angular/src/lib/core/styles/components/charts/_sparkline-theme.scss‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,26 @@
77
/// @param {Map} $palette [$default-palette] - The palette used as basis for styling the component.
88
/// @param {Map} $schema [$light-schema] - The schema used as basis for styling the component.
99
///
10-
/// @prop {Color} $brush [null] - Sets the sparkline brush.
11-
/// @prop {Number} $line-thickness [null] - Sets the line thickness of the sparkline.
12-
/// @prop {Color} $marker-brush [null] - Sets the marker brush of the sparkline.
13-
/// @prop {Color} $marker-size [null] - Sets the marker size of the sparkline.
14-
/// @prop {Color} $first-marker-brush [null] - Sets the first marker brush of the sparkline.
15-
/// @prop {Number} $first-marker-size [null] - Sets the first marker size of the sparkline.
16-
/// @prop {Color} $last-marker-brush [null] - Sets the last marker brush of the sparkline.
17-
/// @prop {Number} $last-marker-size [null] - Sets the last marker size of the sparkline.
18-
/// @prop {Color} $low-marker-brush [null] - Sets the low marker brush of the sparkline.
19-
/// @prop {Number} $low-marker-size [null] - Sets the low marker size of the sparkline.
20-
/// @prop {Color} $high-marker-brush [null] - Sets the high marker brush of the sparkline.
21-
/// @prop {Number} $high-marker-size [null] - Sets the high marker size of the sparkline.
22-
/// @prop {Color} $negative-brush [null] - Sets the negative brush of the sparkline.
23-
/// @prop {Color} $negative-marker-brush [null] - Sets the negative marker brush of the sparkline.
24-
/// @prop {Number} $negative marker-size [null] - Sets the negative marker size of the sparkline.
25-
/// @prop {Color} $trend-line-brush [null] - Sets the trendline brush of the sparkline.
26-
/// @prop {Color} $trend-line-thickness [null] - Sets the thickness of the sparkline's trendline.
27-
/// @prop {Color} $horizontal-axis-brush [null] - Sets the horizontal axis line brush of the sparkline.
28-
/// @prop {Color} $vertical-axis-brush [null] - Sets the vertical axis line brush of the sparkline.
29-
/// @prop {Color} $normal-range-fill [null] - Sets the normal range brush of the sparkline.
10+
/// @param {Color} $brush [null] - Sets the sparkline brush.
11+
/// @param {Number} $line-thickness [null] - Sets the line thickness of the sparkline.
12+
/// @param {Color} $marker-brush [null] - Sets the marker brush of the sparkline.
13+
/// @param {Color} $marker-size [null] - Sets the marker size of the sparkline.
14+
/// @param {Color} $first-marker-brush [null] - Sets the first marker brush of the sparkline.
15+
/// @param {Number} $first-marker-size [null] - Sets the first marker size of the sparkline.
16+
/// @param {Color} $last-marker-brush [null] - Sets the last marker brush of the sparkline.
17+
/// @param {Number} $last-marker-size [null] - Sets the last marker size of the sparkline.
18+
/// @param {Color} $low-marker-brush [null] - Sets the low marker brush of the sparkline.
19+
/// @param {Number} $low-marker-size [null] - Sets the low marker size of the sparkline.
20+
/// @param {Color} $high-marker-brush [null] - Sets the high marker brush of the sparkline.
21+
/// @param {Number} $high-marker-size [null] - Sets the high marker size of the sparkline.
22+
/// @param {Color} $negative-brush [null] - Sets the negative brush of the sparkline.
23+
/// @param {Color} $negative-marker-brush [null] - Sets the negative marker brush of the sparkline.
24+
/// @param {Number} $negative marker-size [null] - Sets the negative marker size of the sparkline.
25+
/// @param {Color} $trend-line-brush [null] - Sets the trendline brush of the sparkline.
26+
/// @param {Color} $trend-line-thickness [null] - Sets the thickness of the sparkline's trendline.
27+
/// @param {Color} $horizontal-axis-brush [null] - Sets the horizontal axis line brush of the sparkline.
28+
/// @param {Color} $vertical-axis-brush [null] - Sets the vertical axis line brush of the sparkline.
29+
/// @param {Color} $normal-range-fill [null] - Sets the normal range brush of the sparkline.
3030
/// @requires $default-palette
3131
/// @requires $light-schema
3232
/// @requires apply-palette

‎projects/igniteui-angular/src/lib/core/styles/themes/schemas/dark/_gauge.scss‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,36 @@
88

99
/// Generates dark gauge schemas.
1010
/// @type {Map}
11+
/// @requires {function} extend
1112
/// @requires $_light-linear-gauge
12-
/// @requires $_light-radial-gauge
13-
/// @see $default-palette
1413
$_dark-linear-gauge: extend($_light-linear-gauge);
14+
15+
/// Generates dark gauge schemas.
16+
/// @type {Map}
17+
/// @requires {function} extend
18+
/// @requires $_light-radial-gauge
1519
$_dark-radial-gauge: extend($_light-radial-gauge);
1620

1721
/// Generates a dark fluent gauge schema.
1822
/// @type {Map}
1923
/// @requires {function} extend
2024
/// @requires $_fluent-linear-gauge
21-
/// @requires $_fluent-radial-gauge
2225
$_dark-fluent-linear-gauge: extend($_fluent-linear-gauge);
26+
27+
/// Generates a dark fluent gauge schema.
28+
/// @type {Map}
29+
/// @requires {function} extend
30+
/// @requires $_fluent-radial-gauge
2331
$_dark-fluent-radial-gauge: extend($_fluent-radial-gauge);
2432

25-
/// Generates a bootstrap gauge schema.
33+
/// Generates a dark bootstrap gauge schema.
2634
/// @type {Map}
2735
/// @requires {function} extend
2836
/// @requires $_bootstrap-linear-gauge
29-
/// @requires $_bootstrap-radial-gauge
3037
$_dark-bootstrap-linear-gauge: extend($_bootstrap-linear-gauge);
38+
39+
/// Generates a dark bootstrap gauge schema.
40+
/// @type {Map}
41+
/// @requires {function} extend
42+
/// @requires $_bootstrap-radial-gauge
3143
$_dark-bootstrap-radial-gauge: extend($_bootstrap-radial-gauge);

‎projects/igniteui-angular/src/lib/core/styles/themes/schemas/light/_funnel-chart.scss‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
/// @property {Number} outline-thickness [null] - Sets the thickness of outline around slices.
1818
/// @property {Color} text-color [null] - Sets the Color used for the inner labels.
1919
/// @property {String} text-style [null] - Sets the text style for inner labels.
20-
2120
/// @see $default-palette
2221
$_light-funnel-chart: extend(
2322
(

‎projects/igniteui-angular/src/lib/core/styles/themes/schemas/light/_gauge.scss‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,18 +129,27 @@ $_light-radial-gauge: extend(
129129
)
130130
);
131131

132-
/// Generates fluent gauge schemas.
132+
/// Generates a light fluent gauge schemas.
133133
/// @type {Map}
134134
/// @requires {function} extend
135135
/// @requires $_light-linear-gauge
136-
/// @requires $_light-radial-gauge
137136
$_fluent-linear-gauge: extend($_light-linear-gauge);
137+
138+
/// Generates a light fluent gauge schemas.
139+
/// @type {Map}
140+
/// @requires {function} extend
141+
/// @requires $_light-radial-gauge
138142
$_fluent-radial-gauge: extend($_light-radial-gauge);
139143

140-
/// Generates bootstrap gauge schemas.
144+
/// Generates a light bootstrap gauge schemas.
141145
/// @type {Map}
142146
/// @requires {function} extend
143147
/// @requires $_light-linear-gauge
144-
/// @requires $_light-radial-gauge
145148
$_bootstrap-linear-gauge: extend($_light-linear-gauge);
149+
150+
/// Generates a light bootstrap gauge schemas.
151+
/// @type {Map}
152+
/// @requires {function} extend
153+
/// @requires $_light-radial-gauge
146154
$_bootstrap-radial-gauge: extend($_light-radial-gauge);
155+

0 commit comments

Comments
 (0)