Skip to content

Latest commit

 

History

History
293 lines (243 loc) · 10.9 KB

VisualBaseWithBounds.adoc

File metadata and controls

293 lines (243 loc) · 10.9 KB

/** * An extended base element that understands bounds settings and can handle percent values in it. * @constructor * @extends {anychart.core.VisualBase} */ anychart.core.VisualBaseWithBounds;

/** * Getter for element bounds settings. * @shortDescription Bounds settings. * @category Size and Position * @return {!anychart.core.utils.Bounds} Bounds of the element. */ anychart.core.VisualBaseWithBounds.prototype.bounds;

/** * Setter for bounds of the element using one parameter. * @example anychart.core.VisualBaseWithBounds.bounds_set_asSingle * @param {(anychart.utils.RectObj|anychart.math.Rect|anychart.core.utils.Bounds)=} opt_bounds Bounds of element. * @return {anychart.core.VisualBase} Self instance for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.bounds;

/** * Setter for element bounds settings. * @example anychart.core.VisualBaseWithBounds.bounds_set_asSeveral * @param {(number|string)=} opt_x [null] X-coordinate. * @param {(number|string)=} opt_y [null] Y-coordinate. * @param {(number|string)=} opt_width [null] Width. * @param {(number|string)=} opt_height [null] Height. * @return {anychart.core.VisualBase} Self instance for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.bounds;

/** * Getter for element left bound settings. * @shortDescription Left bound settings. * @category Size and Position * @return {number|string|undefined} Element’s left bound setting. */ anychart.core.VisualBaseWithBounds.prototype.left;

/** * Setter for element left bound settings. * @example anychart.core.VisualBaseWithBounds.left * @param {(number|string|null)=} opt_left [null] Left bound setting for the element. * @return {!anychart.core.VisualBaseWithBounds} Returns self for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.left;

/** * Getter for element right bound settings. * @shortDescription Right bound settings. * @category Size and Position * @return {number|string|undefined} Element’s right bound setting. */ anychart.core.VisualBaseWithBounds.prototype.right;

/** * Setter for element right bound setting. * @example anychart.core.VisualBaseWithBounds.right * @param {(number|string|null)=} opt_right [null] Right bound setting for the element. * @return {!anychart.core.VisualBaseWithBounds} Returns self for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.right;

/** * Getter for element top bound settings. * @shortDescription Top bound settings. * @category Size and Position * @return {number|string|undefined} Element’s top bound setting. */ anychart.core.VisualBaseWithBounds.prototype.top;

/** * Setter for element top bound settings. * @example anychart.core.VisualBaseWithBounds.top * @param {(number|string|null)=} opt_top [null] Top bound setting for the element. * @return {!anychart.core.VisualBaseWithBounds} Returns self for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.top;

/** * Getter for element bottom bound settings. * @shortDescription Bottom bound settings. * @category Size and Position * @return {number|string|undefined} Element’s bottom bound setting. */ anychart.core.VisualBaseWithBounds.prototype.bottom;

/** * Setter for element bottom bound settings. * @example anychart.core.VisualBaseWithBounds.bottom * @param {(number|string|null)=} opt_bottom [null] Bottom bound settings for the element. * @return {!anychart.core.VisualBaseWithBounds} Returns self for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.bottom;

/** * Getter for element width settings. * @shortDescription Width settings. * @category Size and Position * @return {number|string|undefined} Element’s width setting. */ anychart.core.VisualBaseWithBounds.prototype.width;

/** * Setter for element width setting. * @example anychart.core.VisualBaseWithBounds.width * @param {(number|string|null)=} opt_width [null] Width settings for the element. * @return {!anychart.core.VisualBaseWithBounds} Returns self for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.width;

/** * Getter for element height settings. * @shortDescription Height settings. * @category Size and Position * @return {number|string|undefined} Element’s height setting. */ anychart.core.VisualBaseWithBounds.prototype.height;

/** * Setter for element height setting. * @example anychart.core.VisualBaseWithBounds.height * @param {(number|string|null)=} opt_height [null] Height settings for the element. * @return {!anychart.core.VisualBaseWithBounds} Returns self for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.height;

/** * Returns pixel bounds of the element due to parent bounds and self bounds settings. * @shortDescription Returns pixel bounds. * @category Size and Position * @return {!anychart.math.Rect} Pixel bounds of the element. */ anychart.core.VisualBaseWithBounds.prototype.getPixelBounds;

/** * Getter for the minimum width. * @shortDescription Minimum width. * @category Size and Position * @return {(number|string|null)} Element’s minimum width. */ anychart.core.VisualBaseWithBounds.prototype.minWidth;

/** * Setter for the minimum width. * @detailed The method sets a minimum width of elements, that will be to remain after a resize of element. * @example anychart.core.VisualBaseWithBounds.minWidth_set * @param {(number|string|null)=} opt_width [null] Minimum width to set. * @return {anychart.core.VisualBase} Self instance for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.minWidth;

/** * Getter for the minimum height. * @shortDescription Minimum height. * @category Size and Position * @return {(number|string|null)} Element’s minimum height. */ anychart.core.VisualBaseWithBounds.prototype.minHeight;

/** * Setter for the minimum height. * @detailed The method sets a minimum height of elements, that will be to remain after a resize of element. * @example anychart.core.VisualBaseWithBounds.minHeight_set * @param {(number|string|null)=} opt_height [null] Minimum height to set. * @return {anychart.core.VisualBase} Self instance for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.minHeight;

/** * Getter for the maximum width. * @shortDescription Maximum width. * @category Size and Position * @return {(number|string|null)} Element’s maximum width. */ anychart.core.VisualBaseWithBounds.prototype.maxWidth;

/** * Setter for the maximum width. * @example anychart.core.VisualBaseWithBounds.maxWidth_set * @param {(number|string|null)=} opt_width [null] Maximum width to set. * @return {!anychart.core.VisualBase} Self instance for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.maxWidth;

/** * Getter for the maximum height. * @shortDescription Maximum height. * @category Size and Position * @return {(number|string|null)} Element’s maximum height. */ anychart.core.VisualBaseWithBounds.prototype.maxHeight;

/** * Setter for the maximum height. * @example anychart.core.VisualBaseWithBounds.maxHeight_set * @param {(number|string|null)=} opt_height [null] Maximum height to set. * @return {anychart.core.VisualBase} Self instance for method chaining. */ anychart.core.VisualBaseWithBounds.prototype.maxHeight;

/** @inheritDoc */ anychart.core.VisualBaseWithBounds.prototype.zIndex;

/** @inheritDoc */ anychart.core.VisualBaseWithBounds.prototype.enabled;