docs: update constants

antvis · May 12, 2021 · 6ab1af6 · 6ab1af6
1 parent 97be511
commit 6ab1af6
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/docs/api/constants.md b/docs/api/constants.md
@@ -0,0 +1,24 @@
+# Constants
+
+There are some constants for tickInterval option used in time scale.
+
+## Usage
+
+<a name="DURATION_SECOND" href="#DURATION_SECOND">#</a> **DURATION_SECOND**
+
+```ts
+import { Time, DURATION_SECOND } from '@antv/scale';
+
+DURATION_SECOND; // 60000
+
+const x = new Time({
+  tickInterval: DURATION_SECOND
+  domain: [new Date(2011, 0, 1, 12, 0, 0), new Date(2011, 0, 1, 12, 0, 4)]
+})
+x.getTicks();
+//[new Date(2011, 0, 1, 12, 0, 0),
+// new Date(2011, 0, 1, 12, 0, 1),
+// new Date(2011, 0, 1, 12, 0, 2),
+// new Date(2011, 0, 1, 12, 0, 3),
+// new Date(2011, 0, 1, 12, 0, 4),]
+```