Skip to content

Commit 9b3b37b

Browse files
pjm17971pjm17971
committed
Minor docs changes
1 parent dfa3acb commit 9b3b37b

File tree

2 files changed

+56
-31
lines changed

2 files changed

+56
-31
lines changed

‎src/components/ChartContainer.js‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -393,18 +393,18 @@ ChartContainer.propTypes = {
393393
*
394394
* However, some options exist:
395395
*
396-
* 1) setting format to "day", "month" or "year" will show only ticks on those,
396+
* - setting format to "day", "month" or "year" will show only ticks on those,
397397
* and every one of those intervals. For example maybe you are showing a bar
398398
* chart for October 2014 then setting the format to "day" will insure that a
399399
* label is placed for each and every day
400400
*
401-
* 2) setting format to "relative" interprets the time as a duration. This
401+
* - setting format to "relative" interprets the time as a duration. This
402402
* is good for data that is specified relative to its start time, rather than
403403
* as an actual date/time
404404
*
405-
* 3) setting the format to a d3 format string will use that format
405+
* - setting the format to a d3 format string will use that format
406406
*
407-
* 4) supplying a function for format will cause that function to be called
407+
* - supplying a function for format will cause that function to be called
408408
* whenever rendering a time
409409
*/
410410
format: PropTypes.oneOfType([PropTypes.string, PropTypes.func]),
@@ -417,7 +417,8 @@ ChartContainer.propTypes = {
417417
*/
418418
showGrid: PropTypes.bool,
419419
/**
420-
* Defines whether Grid is overlayed or underlayed
420+
* Defines whether grid is overlayed ("over"( or underlayed ("under")
421+
* with respect to the charts
421422
*/
422423
showGridPosition: PropTypes.oneOf(["over", "under"]),
423424
/**

‎src/website/api/docs.json‎

Lines changed: 50 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@
155155
"required": false,
156156
"description": "The series series columns mapped to stacking up and down.\nHas the format:\n```\n \"columns\": {\n up: [\"in\", ...],\n down: [\"out\", ...]\n }\n ```",
157157
"defaultValue": {
158-
"value": "{\n up: [\"value\"],\n down: []\n}",
158+
"value": "{\n up: [\"value\"],\n down: []\n}",
159159
"computed": false
160160
}
161161
},
@@ -489,7 +489,7 @@
489489
"required": false,
490490
"description": "The style of the info box itself. Typically you'd want to\nspecify a fill color, and stroke color / width here.",
491491
"defaultValue": {
492-
"value": "{\n stroke: \"#999\",\n fill: \"white\",\n opacity: 0.90,\n pointerEvents: \"none\"\n}",
492+
"value": "{\n stroke: \"#999\",\n fill: \"white\",\n opacity: 0.90,\n pointerEvents: \"none\"\n}",
493493
"computed": false
494494
}
495495
},
@@ -548,7 +548,7 @@
548548
"required": false,
549549
"description": "The style of the infoBox dot at the end of the marker",
550550
"defaultValue": {
551-
"value": "{\n fill: \"#999\"\n}",
551+
"value": "{\n fill: \"#999\"\n}",
552552
"computed": false
553553
}
554554
},
@@ -625,7 +625,7 @@
625625
},
626626
"stemStyle": {
627627
"defaultValue": {
628-
"value": "{\n stroke: \"#999\",\n cursor: \"crosshair\",\n pointerEvents: \"none\"\n}",
628+
"value": "{\n stroke: \"#999\",\n cursor: \"crosshair\",\n pointerEvents: \"none\"\n}",
629629
"computed": false
630630
}
631631
}
@@ -659,7 +659,7 @@
659659
"required": false,
660660
"description": "An object describing the style of the baseline of the form\n{ label, line }. \"label\" and \"line\" are both objects containing\nthe inline CSS for that part of the baseline.",
661661
"defaultValue": {
662-
"value": "{\n label: {\n fill: \"#8B7E7E\", // Default label color\n fontWeight: 100,\n fontSize: 11,\n pointerEvents: \"none\"\n },\n line: {\n stroke: \"#626262\",\n strokeWidth: 1,\n strokeDasharray: \"5,3\",\n pointerEvents: \"none\"\n }\n}",
662+
"value": "{\n label: {\n fill: \"#8B7E7E\", // Default label color\n fontWeight: 100,\n fontSize: 11,\n pointerEvents: \"none\"\n },\n line: {\n stroke: \"#626262\",\n strokeWidth: 1,\n strokeDasharray: \"5,3\",\n pointerEvents: \"none\"\n }\n}",
663663
"computed": false
664664
}
665665
},
@@ -806,7 +806,7 @@
806806
"series": {
807807
"type": {
808808
"name": "custom",
809-
"raw": "(props, propName, componentName) => {\n const value = props[propName];\n if (!(value instanceof TimeSeries)) {\n return new Error(\n `A TimeSeries needs to be passed to ${componentName} as the 'series' prop.`\n );\n }\n\n // TODO: Better detection of errors\n\n // everything ok\n return null;\n}"
809+
"raw": "(props, propName, componentName) => {\n const value = props[propName];\n if (!(value instanceof TimeSeries)) {\n return new Error(\n `A TimeSeries needs to be passed to ${componentName} as the 'series' prop.`\n );\n }\n\n // TODO: Better detection of errors\n\n // everything ok\n return null;\n}"
810810
},
811811
"required": false,
812812
"description": "What [Pond TimeSeries](http://software.es.net/pond#timeseries)\ndata to visualize. See general notes on the BoxChart."
@@ -885,7 +885,7 @@
885885
"required": false,
886886
"description": "The style of the info box and connecting lines",
887887
"defaultValue": {
888-
"value": "{\n stroke: \"#999\",\n fill: \"white\",\n opacity: 0.90,\n pointerEvents: \"none\"\n}",
888+
"value": "{\n stroke: \"#999\",\n fill: \"white\",\n opacity: 0.90,\n pointerEvents: \"none\"\n}",
889889
"computed": false
890890
}
891891
},
@@ -1020,13 +1020,13 @@
10201020
},
10211021
"stemStyle": {
10221022
"defaultValue": {
1023-
"value": "{\n stroke: \"#999\",\n cursor: \"crosshair\",\n pointerEvents: \"none\"\n}",
1023+
"value": "{\n stroke: \"#999\",\n cursor: \"crosshair\",\n pointerEvents: \"none\"\n}",
10241024
"computed": false
10251025
}
10261026
},
10271027
"markerStyle": {
10281028
"defaultValue": {
1029-
"value": "{\n fill: \"#999\"\n}",
1029+
"value": "{\n fill: \"#999\"\n}",
10301030
"computed": false
10311031
}
10321032
},
@@ -1377,10 +1377,18 @@
13771377
},
13781378
"format": {
13791379
"type": {
1380-
"name": "string"
1380+
"name": "union",
1381+
"value": [
1382+
{
1383+
"name": "string"
1384+
},
1385+
{
1386+
"name": "func"
1387+
}
1388+
]
13811389
},
13821390
"required": false,
1383-
"description": "Provides several options as to the format of the time axis labels.\nIn general the time axis will generate an appropriate time scale based\non the timeRange prop and there is no need to set this.\n\nHowever, four special options exist: setting format to \"day\", \"month\" or\n\"year\" will show only ticks on those, and every one of those intervals.\nFor example maybe you are showing a bar chart for October 2014 then setting\nthe format to \"day\" will insure that a label is placed for each and every day.\n\nThe last option is \"relative\". This interprets the time as a duration. This\nis good for data that is specified relative to its start time, rather than\nas an actual date/time."
1391+
"description": "Provides several options as to the format of the time axis labels.\n\nIn general the time axis will generate an appropriate time scale based\non the timeRange prop and there is no need to set this.\n\nHowever, some options exist:\n\n - setting format to \"day\", \"month\" or \"year\" will show only ticks on those,\nand every one of those intervals. For example maybe you are showing a bar\nchart for October 2014 then setting the format to \"day\" will insure that a\nlabel is placed for each and every day\n\n - setting format to \"relative\" interprets the time as a duration. This\nis good for data that is specified relative to its start time, rather than\nas an actual date/time\n\n - setting the format to a d3 format string will use that format\n\n - supplying a function for format will cause that function to be called\nwhenever rendering a time"
13841392
},
13851393
"transition": {
13861394
"type": {
@@ -1415,7 +1423,7 @@
14151423
]
14161424
},
14171425
"required": false,
1418-
"description": "Defines whether Grid is overlayed or underlayed",
1426+
"description": "Defines whether grid is overlayed (\"over\"( or underlayed (\"under\")\nwith respect to the charts",
14191427
"defaultValue": {
14201428
"value": "\"over\"",
14211429
"computed": false
@@ -1438,7 +1446,7 @@
14381446
"required": false,
14391447
"description": "Adjust the time axis style. This is an object of the\nform { labels, axis } where \"label\" and \"axis\" are objects\nthemselves. The options here are best represented by\nan example:\n\n```\n const axisStyle = {\n labels: {\n labelColor: \"grey\",\n labelWeight: 100,\n labelSize: 11\n },\n axis: {\n axisColor: \"grey\",\n axisWidth: 1\n }\n };\n```",
14401448
"defaultValue": {
1441-
"value": "{\n labels: {\n labelColor: \"#8B7E7E\",\n labelWeight: 100,\n labelSize: 11\n },\n axis: {\n axisColor: \"#C0C0C0\",\n axisWidth: 1\n }\n}",
1449+
"value": "{\n labels: {\n labelColor: \"#8B7E7E\",\n labelWeight: 100,\n labelSize: 11\n },\n axis: {\n axisColor: \"#C0C0C0\",\n axisWidth: 1\n }\n}",
14421450
"computed": false
14431451
}
14441452
},
@@ -2160,7 +2168,7 @@
21602168
"required": false,
21612169
"description": "The style of the info box itself. Typically you'd want to\nspecify a fill color, and stroke color/width here.",
21622170
"defaultValue": {
2163-
"value": "{\n fill: \"white\",\n opacity: 0.90,\n stroke: \"#999\",\n pointerEvents: \"none\"\n}",
2171+
"value": "{\n fill: \"white\",\n opacity: 0.90,\n stroke: \"#999\",\n pointerEvents: \"none\"\n}",
21642172
"computed": false
21652173
}
21662174
},
@@ -2248,7 +2256,7 @@
22482256
"required": false,
22492257
"description": "The style of the event marker dot",
22502258
"defaultValue": {
2251-
"value": "{\n fill: \"#999\"\n}",
2259+
"value": "{\n fill: \"#999\"\n}",
22522260
"computed": false
22532261
}
22542262
},
@@ -2304,13 +2312,13 @@
23042312
},
23052313
"stemStyle": {
23062314
"defaultValue": {
2307-
"value": "{\n stroke: \"#999\",\n cursor: \"crosshair\",\n pointerEvents: \"none\"\n}",
2315+
"value": "{\n stroke: \"#999\",\n cursor: \"crosshair\",\n pointerEvents: \"none\"\n}",
23082316
"computed": false
23092317
}
23102318
},
23112319
"markerLabelStyle": {
23122320
"defaultValue": {
2313-
"value": "{\n fill: \"#999\"\n}",
2321+
"value": "{\n fill: \"#999\"\n}",
23142322
"computed": false
23152323
}
23162324
}
@@ -3261,7 +3269,7 @@
32613269
"required": false,
32623270
"description": "The style of the info box and connecting lines. The style should\nbe an object of the form { line, box }. Line and box are both objects\ncontaining the inline CSS for those elements of the info tracker.",
32633271
"defaultValue": {
3264-
"value": "{\n stroke: \"#999\",\n fill: \"white\",\n opacity: 0.90,\n pointerEvents: \"none\"\n}",
3272+
"value": "{\n stroke: \"#999\",\n fill: \"white\",\n opacity: 0.90,\n pointerEvents: \"none\"\n}",
32653273
"computed": false
32663274
}
32673275
},
@@ -3390,13 +3398,13 @@
33903398
},
33913399
"stemStyle": {
33923400
"defaultValue": {
3393-
"value": "{\n stroke: \"#999\",\n cursor: \"crosshair\",\n pointerEvents: \"none\"\n}",
3401+
"value": "{\n stroke: \"#999\",\n cursor: \"crosshair\",\n pointerEvents: \"none\"\n}",
33943402
"computed": false
33953403
}
33963404
},
33973405
"markerStyle": {
33983406
"defaultValue": {
3399-
"value": "{\n fill: \"#999\"\n}",
3407+
"value": "{\n fill: \"#999\"\n}",
34003408
"computed": false
34013409
}
34023410
}
@@ -3450,7 +3458,15 @@
34503458
},
34513459
"format": {
34523460
"type": {
3453-
"name": "string"
3461+
"name": "union",
3462+
"value": [
3463+
{
3464+
"name": "string"
3465+
},
3466+
{
3467+
"name": "func"
3468+
}
3469+
]
34543470
},
34553471
"required": false,
34563472
"description": ""
@@ -3479,7 +3495,7 @@
34793495
"required": false,
34803496
"description": "",
34813497
"defaultValue": {
3482-
"value": "{\n labels: {\n labelColor: \"#8B7E7E\", // Default label color\n labelWeight: 100,\n labelSize: 11\n },\n axis: {\n axisColor: \"#C0C0C0\"\n }\n}",
3498+
"value": "{\n labels: {\n labelColor: \"#8B7E7E\", // Default label color\n labelWeight: 100,\n labelSize: 11\n },\n axis: {\n axisColor: \"#C0C0C0\"\n }\n}",
34833499
"computed": false
34843500
}
34853501
}
@@ -3583,7 +3599,7 @@
35833599
"required": false,
35843600
"description": "The style of the info box and connecting lines. This is an\nobject of the form { line, box, dot }. Line, box and dot\nare themselves objects representing inline CSS for each of\nthe pieces of the info marker.",
35853601
"defaultValue": {
3586-
"value": "{\n line: {\n stroke: \"#999\",\n cursor: \"crosshair\",\n pointerEvents: \"none\"\n },\n box: {\n fill: \"white\",\n opacity: 0.90,\n stroke: \"#999\",\n pointerEvents: \"none\"\n },\n dot: {\n fill: \"#999\"\n }\n}",
3602+
"value": "{\n line: {\n stroke: \"#999\",\n cursor: \"crosshair\",\n pointerEvents: \"none\"\n },\n box: {\n fill: \"white\",\n opacity: 0.9,\n stroke: \"#999\",\n pointerEvents: \"none\"\n },\n dot: {\n fill: \"#999\"\n }\n}",
35873603
"computed": false
35883604
}
35893605
},
@@ -3644,10 +3660,18 @@
36443660
},
36453661
"timeFormat": {
36463662
"type": {
3647-
"name": "string"
3663+
"name": "union",
3664+
"value": [
3665+
{
3666+
"name": "string"
3667+
},
3668+
{
3669+
"name": "func"
3670+
}
3671+
]
36483672
},
36493673
"required": false,
3650-
"description": "The time format (d3 time format) used for display of the time above the info box."
3674+
"description": "The time format used for display of the time above the info box."
36513675
},
36523676
"timeScale": {
36533677
"type": {
@@ -4052,7 +4076,7 @@
40524076
"required": false,
40534077
"description": "Object specifying the available parameters by which the axis can be\nstyled. The object can contain: \"labels\" and \"axis\". Each of these\nis an inline CSS style applied to the tick labels and axis lines\nrespectively.\n\nIn addition the axis label itself can be styled with: \"labelColor\",\n\"labelFont\", \"labelWidth\" and \"labelSize\".",
40544078
"defaultValue": {
4055-
"value": "{\n labels: {\n labelColor: \"#8B7E7E\", // Default label color\n labelWeight: 100,\n labelSize: 11\n },\n axis: {\n axisColor: \"#C0C0C0\"\n }\n}",
4079+
"value": "{\n labels: {\n labelColor: \"#8B7E7E\", // Default label color\n labelWeight: 100,\n labelSize: 11\n },\n axis: {\n axisColor: \"#C0C0C0\"\n }\n}",
40564080
"computed": false
40574081
}
40584082
},

0 commit comments

Comments
 (0)