/** * The anychart.exports namespace contains export functions. * @namespace * @name anychart.exports */ anychart.exports;
/** * Setter and getter for the file name for exported files. * @example anychart.exports.filename * @param {string=} opt_fileName New file name. * @return {string} Returns file name. * @since 7.10.0 */ anychart.exports.filename;
/** * Setter for an address export server script, which is used to export to an image or PDF.<br/> * See: <li>{@link anychart.graphics.vector.Stage#saveAsPdf}</li> * <li>{@link anychart.graphics.vector.Stage#saveAsPng}</li> * <li>{@link anychart.graphics.vector.Stage#saveAsJpg}</li> * <li>{@link anychart.graphics.vector.Stage#saveAsSvg}</li> * @detailed <b>Note</b>: If it doesn’t set the address of the export server, you will get the current address. * @example anychart.exports.server * @param {string=} opt_address Export server script URL. * @return {string} Export server script URL. * @since 7.10.0 */ anychart.exports.server;
/** * Getter for dimensions for exported images and PDFs. * @listing See listing * var dimensions = anychart.exports.image(); * @return {Object} The image dimensions. * @since 7.13.0 */ anychart.exports.image;
/** * Setter for dimensions for exported images and PDFs. * @example anychart.exports.image * @param {(string|Object)=} opt_widthOrOptions New image or PDF width. Or object with options. * @param {string=} opt_height New image or PDF height. * @return {Object} The image dimensions. * @since 7.13.0 */ anychart.exports.image;
/** * Getter for Facebook sharing settings. * @shortDescription Facebook sharing settings * @listing See listing * var settings = anychart.exports.facebook(); * @return {Object} Sharing settings. * @since 7.13.0 */ anychart.exports.facebook;
/** * Setter for Facebook sharing settings. * @example anychart.exports.facebook * @param {(string|Object)=} opt_captionOrOptions Caption for the main link or object with options. * @param {string=} opt_link The URL is attached to the publication. * @param {string=} opt_name The title for the attached link. * @param {string=} opt_description Description for the attached link. * @param {string=} opt_width Image width. * @param {string=} opt_height Image height. * @param {string=} opt_appId Facebook application id. * @return {Object} Sharing settings. * @since 7.13.0 */ anychart.exports.facebook;
/** * Getter for Twitter sharing settings. * @shortDescription Twitter sharing settings * @listing See listing * var settings = anychart.exports.twitter(); * @return {Object} Sharing settings. * @since 7.13.0 */ anychart.exports.twitter;
/** * Setter for Twitter sharing settings. * @example anychart.exports.twitter * @param {(string|Object)=} opt_urlOrOptions Twitter sharing application export server URL or object with options. * @param {string=} opt_width Image width. * @param {string=} opt_height Image height. * @return {Object} Sharing settings. * @since 7.13.0 */ anychart.exports.twitter;
/** * Getter for LinkedIn sharing settings. * @shortDescription LinkedIn sharing settings * @listing See listing * var settings = anychart.exports.linkedin(); * @return {Object} Sharing settings. * @since 7.13.0 */ anychart.exports.linkedin;
/** * Setter for LinkedIn sharing settings. * @example anychart.exports.linkedin * @param {(string|Object)=} opt_captionOrOptions Caption for publication or object with options. * @param {string=} opt_description Description. * @param {string=} opt_width Image width. * @param {string=} opt_height Image height. * @return {Object} Sharing settings. * @since 7.13.0 */ anychart.exports.linkedin;
/** * Getter for Pinterest sharing settings. * @shortDescription Pinterest sharing settings * @listing See listing * var settings = anychart.exports.pinterest(); * @return {Object} Sharing settings. * @since 7.13.0 */ anychart.exports.pinterest;
/** * Setter for Pinterest sharing settings. * @example anychart.exports.pinterest * @param {(string|Object)=} opt_linkOrOptions Attached link or object with options. * @param {string=} opt_description Description. * @param {string=} opt_width Image width. * @param {string=} opt_height Image height. * @return {Object} Sharing settings. * @since 7.13.0 */ anychart.exports.pinterest;
/** * Type definition of client side configuration. * @typedef {Object} anychart.exports.ClientsideConfiguration * @property {string} path Base url for client side exporting dependencies. * @property {boolean} enabled If client side exporting is enabled. * @property {boolean} fallback If fallback to export server is enabled in case client side export fails. */ anychart.exports.ClientsideConfiguration;
/** * Getter for the client side exporting configuration. * @shortDescription Client side export configuration. * @return {anychart.exports.ClientsideConfiguration} Client side export configuration. */ anychart.exports.clientside;
/** * Setter for the client side exporting configuration. * @example anychart.exports.clientside * @param {anychart.exports.ClientsideConfiguration} configuration New image or PDF width. Or object with options. * @detailed Client side configuration object has 3 fields.<br> * Path is the base URL to the location where dependencies needed for client side export to work are placed. * These dependencies are: * <ol> * <li><a href='https://github.com/yWorks/jsPDF'>jsPDF</a></li> * <li><a href='https://github.com/canvg/canvg'>canvg</a></li> * <li><a href='https://github.com/SheetJS/sheetjs'>SheetJS</a></li> * </ol> * Enabled sets whether client side should be used.<br> * Fallback sets whether export should use export server if client side export fails. * @return {anychart.core.utils.Exports} Itself for method chaining. */ anychart.exports.clientside;