@@ -295,23 +295,31 @@ Style.prototype = {
295
295
296
296
/**
297
297
* Whether transform text.
298
- * Only useful in Path and Image element
298
+ * Only available in Path and Image element,
299
+ * where the text is called as `RectText`.
299
300
* @type {boolean }
300
301
*/
301
302
transformText : false ,
302
303
303
304
/**
304
- * Text rotate around position of Path or Image
305
- * Only useful in Path and Image element and transformText is false.
305
+ * Text rotate around position of Path or Image.
306
+ * The origin of the rotation can be specified by `textOrigin`.
307
+ * Only available in Path and Image element,
308
+ * where the text is called as `RectText`.
306
309
*/
307
310
textRotation : 0 ,
308
311
309
312
/**
310
- * Text origin of text rotation, like [10, 40].
311
- * Based on x, y of rect.
312
- * Useful in label rotation of circular symbol.
313
- * By default, this origin is textPosition.
314
- * Can be 'center'.
313
+ * Text origin of text rotation.
314
+ * Useful in the case like label rotation of circular symbol.
315
+ * Only available in Path and Image element, where the text is called
316
+ * as `RectText` and the element is called as "host element".
317
+ * The value can be:
318
+ * + If specified as a coordinate like `[10, 40]`, it is the `[x, y]`
319
+ * base on the left-top corner of the rect of its host element.
320
+ * + If specified as a string `center`, it is the center of the rect of
321
+ * its host element.
322
+ * + By default, this origin is the `textPosition`.
315
323
* @type {string|Array.<number> }
316
324
*/
317
325
textOrigin : null ,
0 commit comments