Build beautiful and interactive API documentation for ORDS

Image
In this blog post, I will show you how to quickly build beautiful and interactive API documentation for your Oracle APEX REST data sources using  swagger hub . Using APEX v23.1. I downloaded the  titanic data set  and loaded them into tables in my APEX instance, created some authorized restful services and published them using swagger hub. You can create a free account on swagger hub.   Check out my titanic swagger hub here ; Press Authorize. Username REST, password Glasgow123! I won't go through creating RESTful services and just show you the four I created that sit on top of the titanic data set; The GET is a very simple SQL query;      select * from TITANIC_DATA_SET_NEW A handy tip is to add comments, as there will appear on swagger hub, making your API self documenting; Once you have created your modules, press the Generate Swagger Doc button; This will generate an open API for you.  Copy the API and paste it into swagger hub This will generate the documentation; As mentioned b
Post a Comment

Oracle APEX style an Interactive Grid cell conditionally based on the value of another cell using JavaScript and CSS

This blog post describes how you can style an Interactive Grid cell conditionally based on the value of another cell using JQuery and CSS.  Using APEX Version 19.2.

The requirement is to highlight the cell that has the highest value in the row;


This can be achieved by setting the IG column CSS class and using JQuery to loop round the table rows to conditionally set CSS style based on cell values

First give all your columns a CSS Class (note you can give columns multiple classes separated with space) in this case all 4 columns are set with CSS class SCORE_C_1, SCORE_C_2, SCORE_C3 and SCORE_C_4 in the column Appearance;


We now add the JavaScript in Execute when page loads (preferably put this is a JS file).

We are using the JQuery $.each() method to fetch every table row;

 $.each($('tbody tr'), function(i, item) {}

and the JQuery text() method to get the column value from the row using the column CSS class names;

        var scoreC1 = $(item).find('.SCORE_C_1').text();
        var scoreC2 = $(item).find('.SCORE_C_2').text();
        var scoreC3 = $(item).find('.SCORE_C_3').text();
        var scoreC4 = $(item).find('.SCORE_C_4').text();

We then use the values to conditionally set the cell CSS using the addClass method;

       if (scoreC1 > scoreC2 && scoreC1 > scoreC3 && scoreC1 > scoreC4)
        {
            $(item).find('.SCORE_C_1').addClass("highlightTopScore");
        }

Where the CSS is;

.highlightTopScore{
        font-weight: 800;
        background-color : #f4faeb;   
   }

The full code is;

 $.each($('tbody tr'), function(i, item) {
        var scoreC1 = $(item).find('.SCORE_C_1').text();
        var scoreC2 = $(item).find('.SCORE_C_2').text();
        var scoreC3 = $(item).find('.SCORE_C_3').text();
        var scoreC4 = $(item).find('.SCORE_C_4').text();
        if (scoreC1 > scoreC2 && scoreC1 > scoreC3 && scoreC1 > scoreC4)
        {
            $(item).find('.SCORE_C_1').addClass("highlightTopScore");
        }
        if (scoreC2 > scoreC1 && scoreC2 > scoreC3 && scoreC2 > scoreC4)
        {
            $(item).find('.SCORE_C_2').addClass("highlightTopScore");
        }
         if (scoreC3 > scoreC1 && scoreC3 > scoreC2 && scoreC3 > scoreC4)
        {
            $(item).find('.SCORE_C_3').addClass("highlightTopScore");
        }
          if (scoreC4 > scoreC1 && scoreC4 > scoreC2 && scoreC4 > scoreC3)
        {
            $(item).find('.SCORE_C_4').addClass("highlightTopScore");
        }
    });

My page has several IGs that I want to style so the above code will style all IGs that have the CSS classes set.  If you only want to style a specific IG then use this;

     $.each($('#<STATIC_ID_OF_IG> tbody tr'), function(i, item) {

instead of this which will style all IGs

     $.each($('tbody tr'), function(i, item) {

Comments

Post a Comment

Popular posts from this blog

Oracle APEX Interactive Grid colour cells based on a condition using JavaScript and CSS

Image
In this post I will describe how to colour an Interactive Grid based on a column condition using CSS and JavaScript.  Using APEX Version 19.2. I want to colour every column red in my IG when the value is 'No'.   I have several IGs on my page I want to colour, so I set all my IGs that I want to colour with a CSS class of ATTENDEE_SCORE_IG in the Appearance section of the IG; Every column I want to colour in the IG I set the CSS Class to COLOUR_YES_NO (in this example I set this in 5 columns); I then created a Dynamic Action (DA) that contains the JavaScript that has the condition check that will colour the cells.  Because I have several IGs that are details of the master/detail relationship and these are refreshed by the user clicking on the master detail IG I have made my DA a Page Change [Interactive Grid].  If you don't need this you can set the DA on page load. The JS which will colour every column is this; ////////////////////////////////////////////////////////////////
Read more

Oracle APEX pretty checkbox item plugin

Image
Following on from the animated on off button this is now an item plugin.  Pretty up your checkboxes..... You have 16 checkbox types to choose from where you can control the size and colour of the checkbox in item settings; demo Create a page item with type Pretty check box Choose type of checkbox Set checkbox attributes. How it works The item plug in code uses this code to plug the rendered checkbox into APEX. /////////////////////////////////////////////////////////////////////////////////////////// // glasgow_simple_checkbox // // Provides a plug- in specific implementation for a checkbox item. The item on the page // should be a checkbox, i.e. <input type = "checkbox" and name should be your item name // i.e. name = 'P12_NAME' // // Params // // itemName - the item name , i.e. name = 'P12_NAME' // checkboxValues - the check and unchecked values , i.e. Y/N /////////////////////////////////////////////////////////////////////////////////////////// f
Read more

Build beautiful and interactive API documentation for ORDS

Image
In this blog post, I will show you how to quickly build beautiful and interactive API documentation for your Oracle APEX REST data sources using  swagger hub . Using APEX v23.1. I downloaded the  titanic data set  and loaded them into tables in my APEX instance, created some authorized restful services and published them using swagger hub. You can create a free account on swagger hub.   Check out my titanic swagger hub here ; Press Authorize. Username REST, password Glasgow123! I won't go through creating RESTful services and just show you the four I created that sit on top of the titanic data set; The GET is a very simple SQL query;      select * from TITANIC_DATA_SET_NEW A handy tip is to add comments, as there will appear on swagger hub, making your API self documenting; Once you have created your modules, press the Generate Swagger Doc button; This will generate an open API for you.  Copy the API and paste it into swagger hub This will generate the documentation; As mentioned b
Read more