docs(api): Add notes for .axis' methods (#3349)

Add notes for .axis() methods, where only applicable for chart types which has x and y axes. Ref #3343
naver · Sep 5, 2023 · cd001eb · cd001eb
1 parent 321510b
commit cd001eb
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/Chart/api/axis.ts b/src/Chart/api/axis.ts
@@ -77,6 +77,7 @@ function getMinMax($$, type: "min" | "max"): {x: number, y: number, y2: number}
 const axis = {
 	/**
 	 * Get and set axis labels.
+	 * - **NOTE:** Only applicable for chart types which has x and y axes.
 	 * @function axis․labels
 	 * @instance
 	 * @memberof Chart
@@ -126,6 +127,7 @@ const axis = {
 
 	/**
 	 * Get and set axis min value.
+	 * - **NOTE:** Only applicable for chart types which has x and y axes.
 	 * @function axis․min
 	 * @instance
 	 * @memberof Chart
@@ -163,6 +165,7 @@ const axis = {
 
 	/**
 	 * Get and set axis max value.
+	 * - **NOTE:** Only applicable for chart types which has x and y axes.
 	 * @function axis․max
 	 * @instance
 	 * @memberof Chart
@@ -200,6 +203,7 @@ const axis = {
 
 	/**
 	 * Get and set axis min and max value.
+	 * - **NOTE:** Only applicable for chart types which has x and y axes.
 	 * @function axis․range
 	 * @instance
 	 * @memberof Chart