Skip to content

Commit 3f24df5

Browse files
ehsannarmaniehsannarmani
committed
reformat document
1 parent ef1fd95 commit 3f24df5

File tree

11 files changed

+119
-120
lines changed

11 files changed

+119
-120
lines changed

‎document/docs/animation-mode.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ In Row/Column/Line charts you can set running animations at the same time types:
88
| `Together` | By default, animations will run async, but you can set delay for next animations |
99

1010
!!! Example
11-
```kotlin linenums="1" hl_lines="3 8"
12-
LineChart(
13-
...,
14-
animationMode = AnimationMode.OneByOne
15-
)
11+
```kotlin linenums="1" hl_lines="3 8"
12+
LineChart(
13+
...,
14+
animationMode = AnimationMode.OneByOne
15+
)
1616

1717
LineChart(
1818
...,

‎document/docs/chart-properties/axis.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@
99
| `lineCount` | Int | `5` | specifies count of axis lines |
1010

1111
!!! Example
12-
```kotlin linenums="1"
13-
val axisProperties = AxisProperties(
14-
enabled = true,
15-
style = StrokeStyle.Dashed(intervals = floatArrayOf(10f,10f)),
16-
color = Color.Gray,
17-
thickness = (.5).dp,
18-
lineCount = 5
19-
)
20-
```
12+
```kotlin linenums="1"
13+
val axisProperties = AxisProperties(
14+
enabled = true,
15+
style = StrokeStyle.Dashed(intervals = floatArrayOf(10f,10f)),
16+
color = Color.Gray,
17+
thickness = (.5).dp,
18+
lineCount = 5
19+
)
20+
```

‎document/docs/chart-properties/bars.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Bar Properties
22

33
!!! info "Usage"
4-
In Column/Row Charts you can set bar properties with this property
4+
In Column/Row Charts you can set bar properties with this property
55

66
| Property | Type | Default | Description |
77
|----------------|------------------|-------------------------|-----------------------------------------------------------------------------|
@@ -11,11 +11,11 @@ In Column/Row Charts you can set bar properties with this property
1111
| `style` | DrawStyle | `DrawStyle.Fill` | specifies bar style |\
1212

1313
!!! Example
14-
```kotlin linenums="1"
15-
val barProperties = BarProperties(
16-
thickness = 15.dp,
17-
spacing = 4.dp,
18-
cornerRadius = Bars.Data.Radius.Circular(6.dp),
19-
style = DrawStyle.Fill
20-
)
21-
```
14+
```kotlin linenums="1"
15+
val barProperties = BarProperties(
16+
thickness = 15.dp,
17+
spacing = 4.dp,
18+
cornerRadius = Bars.Data.Radius.Circular(6.dp),
19+
style = DrawStyle.Fill
20+
)
21+
```

‎document/docs/chart-properties/dividers.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Divider Properties
22

33
!!! info "Usage"
4-
In every chart you can set properties of dividers between labels and chart, indicators and chart
4+
In every chart you can set properties of dividers between labels and chart, indicators and chart
55

66
| Property | Type | Default | Description |
77
|-------------------|----------------|----------------------|-----------------------------------------|
@@ -10,14 +10,14 @@ In every chart you can set properties of dividers between labels and chart, indi
1010
| `yAxisProperties` | LineProperties | `LineProperties(..)` | specifies vertical divider properties
1111

1212
!!! Example
13-
```kotlin linenums="1"
14-
val dividerProperties = DividerProperties(
15-
enabled = true,
16-
xAxisProperties = LineProperties(
17-
...
18-
),
19-
yAxisProperties = LineProperties(
20-
...
21-
)
22-
)
23-
```
13+
```kotlin linenums="1"
14+
val dividerProperties = DividerProperties(
15+
enabled = true,
16+
xAxisProperties = LineProperties(
17+
...
18+
),
19+
yAxisProperties = LineProperties(
20+
...
21+
)
22+
)
23+
```

‎document/docs/chart-properties/dots.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Dot Properties]
22

33
!!! info "Usage"
4-
In Line Charts you can set data dot shape properties with this property
4+
In Line Charts you can set data dot shape properties with this property
55

66
| Property | Type | Default | Description |
77
|--------------------|----------------------|-----------------------------------|------------------------------------------------------------------|
@@ -15,15 +15,15 @@ In Line Charts you can set data dot shape properties with this property
1515
| `animationSpec` | AnimationSpec<Float> | `tween(300)` | specifies dots visibility animation spec |\
1616

1717
!!! Example
18-
```kotlin linenums="1"
19-
val dotProperties = DotProperties(
20-
enabled = true,
21-
radius = 4.dp,
22-
color = SolidColor(Color.Red),
23-
strokeWidth = 3.dp,
24-
strokeColor = Color.White,
25-
strokeStyle = StrokeStyle.Normal,
26-
animationEnabled = true,
27-
animationSpec = tween(500)
28-
)
29-
```
18+
```kotlin linenums="1"
19+
val dotProperties = DotProperties(
20+
enabled = true,
21+
radius = 4.dp,
22+
color = SolidColor(Color.Red),
23+
strokeWidth = 3.dp,
24+
strokeColor = Color.White,
25+
strokeStyle = StrokeStyle.Normal,
26+
animationEnabled = true,
27+
animationSpec = tween(500)
28+
)
29+
```

‎document/docs/chart-properties/grid-lines.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Grid Properties
22

33
!!! info "Usage"
4-
In every chart you can set properties of grid lines
4+
In every chart you can set properties of grid lines
55

66
| Property | Type | Default | Description |
77
|-------------------|----------------|----------------------|--------------------------------------------|
@@ -11,13 +11,13 @@ In every chart you can set properties of grid lines
1111

1212
!!! Example
1313
```kotlin linenums="1"
14-
val gridProperties = GridProperties(
15-
enabled = true,
16-
xAxisProperties = AxisProperties(
17-
...
18-
),
19-
yAxisProperties = AxisProperties(
20-
...
21-
)
22-
)
23-
```
14+
val gridProperties = GridProperties(
15+
enabled = true,
16+
xAxisProperties = AxisProperties(
17+
...
18+
),
19+
yAxisProperties = AxisProperties(
20+
...
21+
)
22+
)
23+
```

‎document/docs/chart-properties/indicators.md‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Indicator Properties
22

33
!!! info "Usage"
4-
In every chart you can set properties of counters next to the chart
4+
In every chart you can set properties of counters next to the chart
55

66
| Property | Type | Default | Description |
77
|------------------|--------------------|--------------------------------|------------------------------------------------------------------------------------------------------------------|
@@ -13,19 +13,18 @@ In every chart you can set properties of counters next to the chart
1313
| `contentBuilder` | (Double) -> String | `{ "%.2f".format(it) }` | specifies counter content creation template |
1414

1515
!!! Example
16-
=== "Line & Column Chart"
17-
```kotlin linenums="1"
18-
val indicatorProperties = HorizontalIndicatorProperties(
19-
enabled = true,
20-
textStyle = MaterialTheme.typography.labelSmall,
21-
count = IndicatorCount.CountBased(count = 5),
22-
position = IndicatorPosition.Horizontal.End,
23-
padding = 32.dp,
24-
contentBuilder = { indicator ->
25-
"%.2f".format(indicator) + " Million"
26-
}
27-
)
28-
16+
=== "Line & Column Chart"
17+
```kotlin linenums="1"
18+
val indicatorProperties = HorizontalIndicatorProperties(
19+
enabled = true,
20+
textStyle = MaterialTheme.typography.labelSmall,
21+
count = IndicatorCount.CountBased(count = 5),
22+
position = IndicatorPosition.Horizontal.End,
23+
padding = 32.dp,
24+
contentBuilder = { indicator ->
25+
"%.2f".format(indicator) + " Million"
26+
}
27+
)
2928
```
3029
=== "Row Chart"
3130
```kotlin linenums="1"
@@ -46,10 +45,10 @@ contentBuilder = { indicator ->
4645
### Indicators Bases
4746

4847
!!! tip "You can specify type of indicator counts, we have two type: CountBased, StepBased"
49-
- <strong>`CountBased`</strong>: it will receive a count number and will divide & calculate and in
50-
the end it will show the requested count
51-
of indicators.
52-
48+
- <strong>`CountBased`</strong>: it will receive a count number and will divide & calculate and in
49+
the end it will show the requested count
50+
of indicators.
51+
5352
- <strong>`StepBased`</strong>: it will receive a stepBy value and will split step by given value until it reach min value, for example
5453
if (max value = 20, min value = -10) and stepBy value is 5, the indicators will be: 20,15,10,5,0,-5,-10
5554

‎document/docs/chart-properties/label-helpers.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# LabelHelper Properties
22

33
!!! info "Usage"
4-
In every chart you can set properties of the labels helper which positioned in top of chart
4+
In every chart you can set properties of the labels helper which positioned in top of chart
55

66
| Property | Type | Default | Description |
77
|-------------|-----------|---------------------|------------------------------------|
88
| `enabled` | Boolean | `true` | specifies label helpers visibility |
99
| `textStyle` | TextStyle | `TextStyle.Default` | specifies label helper textStyle |
1010

1111
!!! Example
12-
```kotlin linenums="1"
13-
val labelHelperProperties = LabelHelperProperties(
14-
enabled = true,
15-
textStyle = MaterialTheme.typography.labelMedium
16-
)
17-
```
12+
```kotlin linenums="1"
13+
val labelHelperProperties = LabelHelperProperties(
14+
enabled = true,
15+
textStyle = MaterialTheme.typography.labelMedium
16+
)
17+
```

‎document/docs/chart-properties/labels.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Label Properties
22

33
!!! info "Usage"
4-
In every chart you can set properties of the labels (Apr, Jan, ...)
4+
In every chart you can set properties of the labels (Apr, Jan, ...)
55

66
| Property | Type | Default | Description |
77
|--------------------------------|--------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -17,11 +17,11 @@ In every chart you can set properties of the labels (Apr, Jan, ...)
1717
<img src="https://github.com/ehsannarmani/ComposeCharts/blob/master/assets/rotation_degree_sample.png?raw=true" width="300">
1818

1919
!!! Example
20-
```kotlin linenums="1"
21-
val labelProperties = LabelProperties(
22-
enabled = true,
23-
textStyle = MaterialTheme.typography.labelSmall,
24-
verticalPadding = 16.dp,
25-
labels = listOf("Apr","Mar",...)
26-
)
27-
```
20+
```kotlin linenums="1"
21+
val labelProperties = LabelProperties(
22+
enabled = true,
23+
textStyle = MaterialTheme.typography.labelSmall,
24+
verticalPadding = 16.dp,
25+
labels = listOf("Apr","Mar",...)
26+
)
27+
```

‎document/docs/chart-properties/lines.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
| `thickness` | Dp | `(0.5).dp` | specifies axis line stroke width |
99

1010
!!! Example
11-
```kotlin linenums="1"
12-
val lineProperties = LineProperties(
13-
enabled = true,
14-
style = StrokeStyle.Dashed(intervals = floatArrayOf(10f,10f)),
15-
color = Color.Gray,
16-
thickness = (.5).dp,
17-
)
18-
```
11+
```kotlin linenums="1"
12+
val lineProperties = LineProperties(
13+
enabled = true,
14+
style = StrokeStyle.Dashed(intervals = floatArrayOf(10f,10f)),
15+
color = Color.Gray,
16+
thickness = (.5).dp,
17+
)
18+
```

0 commit comments

Comments
 (0)