Categories

.seoUiSeoGaugeWidget()

Categories: UI

.seoUiSeoGaugeWidget( [ options ] )

Subclass: de_epages

Plugin: de_epages.seo.ui.seoGaugeWidget

Description: Add SEO percentage meter which shows the SEO rating of a content object.

  • .seoUiSeoGaugeWidget( [ options ] )

    version added: 6.12.0

    options   A map of additional options pass to the method.

The .seoUiSeoGaugeWidget() method adds a visual percentage meter for the SEO quality to a DOM node.

You can supply the option "seoQuality" together with a number from 0 to 100 which sets the shown SEO quality. It is possible to change this value later using the "setPercentage" function.

There is a small status image behind the meter which indicates whether the SEO percentage is 0 or not. You can hide this image using the "showStatusImage" option on creation or later using the "showStatusImage" function.

  • Programatically apply .seoUiSeoGaugeWidget() to a div DOM node.

    HTML:
    <div id="SEOGaugeWidget"></div>
    
    Code:
    de_epages('#SEOGaugeWidget')
        .seoUiSeoGaugeWidget({
            seoQuality: 25,
            showStatusImage : true,
            caption : 'SEO:'
        });
    
    
  • Apply .seoUiSeoGaugeWidget() to a div DOM node via ep-metaparse.

    HTML:
    <div id="SEOGaugeWidget" class="ep-metaparse de_epages.seoUiSeoGaugeWidget({'seoQuality' : 25 })"></div>
    
    
  • seoQuality

    version added: 6.12.0

    SEO quality factor.

  • showStatusImage

    version added: 6.12.0

    Show status image or not.

    Default: true

  • caption

    version added: 6.12.0

    Text to be displayed next to the meter bar.

    Default: \'SEO:\'

  • showStatusImage

    • .seoUiSeoGaugeWidget( 'showStatusImage', false )

      version added: 6.12.0

      state   Show or hide the status image.

    Shows or hides the status image.

  • setPercentage

    • .seoUiSeoGaugeWidget( 'setPercentage', 35 )

      version added: 6.12.0

      newValue   SEO quality factor.

    Changes the SEO quality factor.