13. Open API Enhancements (Revision #26)

Open APIs enable developers to write scripts that access the functionality of ADStudio to create custom solutions and tasks that fall outside of the product's GUI restrictions. This includes current functionality around database access, database schema DDL generation, compare tools, version control, data pivoting, charts and much more. We have introduced new functionalities in Aqua Data Studio v10.0 including two new chart types - 3D Line Chart and the Ichimoku Cloud Chart, Move Series Functionality, Series Functions on Range of values, AxisRenderer, Chart Opacity, Legend and Chart Title Positions. Other additions include Save in Excel 2007 format, enhancements in AQRequest and AQResponse, AQMail to specify the reply-to list of email addresses etc.

Users have API access to nearly all of ADStudio's built-in functionality and be able to create fully automated end-to-end solutions. Following are the new enhancements in v10.0:

• AQReport
  • public void saveAsExcel2007(String fileName) - saves report in Excel 2007 format 
  • public byte[] getAsExcel2007() - returns report as a byte array in Excel 2007 format
• AQPivotDataSet
  • public void saveAsExcel2007(String fileName) - saves pivot data in Excel 2007 format
  • public void saveAsExcel2007(String fileName, AQDataSetSettings settings, AQChart chart) - save pivot data and chart in Excel 2007 format
  • public byte[] getAsExcel2007() - returns pivot data as a byte array in Excel 2007 format
  • public byte[] getAsExcel2007(AQDataSetSettings settings, AQChart chart) - returns pivot data and chart as a byte array in Excel 2007 format
• AQDataSet
  • public void saveAsExcel2007(String filename) - saves data set in Excel 2007 format
  • public void saveAsExcel2007(String fileName, AQDataSetSettings settings, AQChart chart) - saves data set  and chart in Excel 2007 format
  • public byte[] getAsExcel2007() - returns data set as a byte array in Excel 2007 format
  • public byte[] getAsExcel2007(AQDataSetSettings settings, AQChart chart) - returns data set and chart as a byte array in Excel 2007 format
• AQServerConnection
  • public void connect(Object password) - establishes SQL connection to the server with the provided password
  • public void connect(Object username, Object password) - establishes SQL connection to the server with the provided user credentials
• AQInputOutputFactory
  • public AQExcelWriter newExcel2007Writer() - creates new Excel 2007 file writer
• AQResponse
  • public void setTitle(String title) - sets the TITLE tag for HTML responses
  • public String getTitle() - returns the value fo the the TITLE tag
  • public void addMetaTag(String name, String value) - sets the META tag for HTML responses
  • public void clearMetaTags() - removes previously set meta tags
• AQRequest
  • public String getRemoteAddr() - returns the Internet Protocol (IP) address of the client or last proxy that sent the request
  • public String getRemoteHost() - returns the fully qualified name of the client or the last proxy that sent the request
• AQSystem
  • public String getProperty(String key) - retrieves the java system property indicated by the specified key
  • public String getProperty(String key, String def) - retrieves the java system property indicated by the specified key. If key is not found, def is returned
  • public String getenv(String name) - retrieves the value of the specified environment variable
• AQMailMessage
  • public void addReplyTo(String replyTo) - specifies the reply-to list of email addresses
  • public String[] getReplyTo() - retrieves the list of reply-to email addresses

Charts

• AQChartProperties
  • void setChartTypeCloud() - set the chart type for all series to Cloud
  • void setChartTypeCloud(int seriesNumber) - set the chart type for the specified series to Cloud
  • void setChartTypeLine3d() - set the chart type for all series to Line
  • void setChartTypeLine3d(int seriesNumber) - set the chart type for the specified series to 3D Line
  • public void moveSeries(int fromSeriesIndex, int toSeriesIndex) - moves the series at position "fromSeriesIndex" to position "toSeriesIndex" float setOpacity - set the opacity to render chart geometry
  • float getOpacity - get the opacity used to render chart geometry
  • setGridLineWidth(float lineWidth) - set the width of the grid lines
  • float getGridLineWidth() - return the width of the grid lines
  • void setFillGrid(boolean fillGrid) - set to True to fill the grid, False to only show the grid lines
  • boolean isFillGrid() - return True if the grid is filled, False if only the grid lines are shown
  • void setShowValueAxisTicks(boolean showValueAxisTicks) - set to True if the value axis tick marks are displayed 
  • boolean isShowValueAxisTicks() - return True if the value axis tick marks are displayed
  • void setShowCategoryAxisTicks(boolean showCategoryAxisTicks) - set to True if the category axis tick marks are displayed 
  • boolean isShowCategoryAxisLines() - return True if the Category axis lines are displayed
  • void setTitlePosition(String titlePosition) - set the Title position ("Top Left", "Top Center", "Top Right", "Left Center", "Right Center", "Bottom Left", "Bottom Center", "Bottom Right")
  • void setTitlePositionBottomCenter() - set the Chart Title Position Bottom Center
  • void setTitlePositionBottomRight() - set the Chart Title Position Bottom Right
  • void setTitlePositionTopCenter() - set the Chart Title Position Top Center
  • void setTitlePositionTopLeft() - set the Chart Title Position Top Left
  • void setTitlePositionTopRight() - set the Chart Title Position Top Right
  • void setLegendPosition(String position) - set the Legend position ("Top Left", "Top Right", "Bottom Left", "Bottom Right")
  • void setLegendPositionBottomCenter() - place the Legend in the Bottom Center of the rendering area
  • void setLegendPositionBottomLeft() - place the Legend in the Bottom Left corner of the rendering area
  • void setLegendPositionBottomRight() - place the Legend in the Bottom Right corner of the rendering area
  • void setLegendPositionLeftCenter() - place the Legend in the Left Center of the rendering area
  • void setLegendPositionRightCenter() - place the Legend in the Right Center of the rendering area
  • void setLegendPositionTopCenter() - place the Legend in the Top Center of the rendering area
  • void setLegendPositionTopLeft() -  place the Legend in the Top Left corner of the rendering area
  • void setLegendPositionTopRight() - place the Legend in the Top Right corner of the rendering area
  • void setShowValueAxisLines(boolean showValueAxisLines) - set to True if the value axis lines are displayed
  • boolean isShowValueAxisLines() - return True if the value axis lines are displayed
  • void setShowCategoryAxisLines(boolean showCategoryAxisLines) - set to True if the Category axis lines are displayed
  • boolean isShowCategoryAxisLines() - return True if the Category axis lines are displayed
  • void addFunctionSeries(String functionString) - Perform series functions on a specified ranges of values