Page History

...

Document Properties Marker

override	false

Short Description

Module to provide a filter for a display table macro.

Doctype

docmodule

hide

Name

Filter Module

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience
empty-as-none	true

Subject

Name List

doctype	subject
property	Subject

Tags

Tag List

property	Tags

Flags

hide

Iteration


value	finished

Type

Name List

doctype	module-type
render-no-hits-as-blank	true
property	Type

Sort Key

hide

Section

title	Description

...

Section

title	Content

Below this text is the HTML-Code to be transcluded to provide a filter for a display table macro using the remote controlled feature.

The javascript code uses the variable initialwhere which can be replaced using the transclusion variable replacement feature and be set to the initial where condition used in the display table macro.

Morover two more variables have to be set to provide options for a dropdown.

Full example replacement to put in transclusion box to disable the dropdown:

tableid=fitered

initialwhere=$<DirectAncestorId>=[112494396]
datalistselects=<datalist id="selects"></datalist>
datalistwheredatalistwheres=<datalist id="wheres"></datalist>

Full example replacement to put in transclusion box to set values for the dropdowns:

tableid=filtered

initialwhere=$<DirectAncestorId>=[112494396]
datalistselects=<datalist id="selects"><option value="Name">Name only</option><option value="Name, Short Description, Iteration">With Iteration</option></datalist>
datalistwheredatalistwheres=<datalist id="wheres"><option value="$<Iteration>=[Facade]">Facade</option><option value="$<Iteration>=[Filled]">Filled</option><option value="$<Iteration>=[Finished]">Finished</option></datalist>

Code

Section

hide	true
title	Hide

Section

title	HTML

code

-CODE

HTML

<form id="filterForm-${tableid}" action="">
  <label for="select">select:</label>
  <input id="filterSelect-${tableid}" size="50" type="text" list="selects-${tableid}" name="select" autocomplete="on">
  <label for="where">where:</label>
  <input id="filterWhere-${tableid}" size="50" type="text" list="wheres-${tableid}" name="where" autocomplete="on">
  <input type="submit" value="Submit">
  <input type="reset" value="Reset">
</form>

<form id="filterForm${uniqueid}" action=""> select: <input id="filterSelect${uniqueid}" size="50" type="text" list="selects" name="select" > ${datalistselects} where: <input id="filterWhere${uniqueid}" size="50" type="text" list="wheres" name="where"> ${datalistwhere} <input type="submit" value="Submit"> <input type="reset" value="Reset"> </form> <script> AJS.toInit(function() { var urlParams = new URLSearchParams(window.location.search); var originalSelect = urlParams.get('${tableid}:select'); var originalWhere = urlParams.get('${tableid}customWhere'); $("#filterSelect${uniqueid}").val(originalSelect); $("#filterWhere${uniqueid}").val(originalWhere); function appendToQueryString( queryString, queryParam ) {

          initialWhere = null;
                console.debug("In Check 1/1 : initial where is: " + initialWhere);
            }
        } else {
            console.debug("Check 1 : initial where is not empty");
            console.debug("In Check 1 : initial where is: " + initialWhere);
        }

        $('#filterForm${tableid} datalist').attr('id', function(index, id) {
            return id + "${tableid}";
        })

        $("#filterSelect${tableid}").val(originalSelect);
        $("#filterWhere${tableid}").val(originalWhere);

        $('#filterForm${tableid}').submit(function(evt) {
            evt.preventDefault();

            var tableId = "${tableid}";
            var $select = $('#filterSelect${tableid}').val();
            var $where = $('#filterWhere${tableid}').val();

            var $queryString = "";
            if (

queryString

oldQueryParams.trim()) {

{ queryString=queryString + "&" + queryParam

        $queryString = appendToQueryString($queryString, oldQueryParams.substr(1));
            }

else

if (typeof initialWhere == 'undefined' || initialWhere == null) {

queryString="?"+queryParam;

                console.debug("Check 2 : initial where is empty");
            } else {

return queryString; }; $('#filterForm${uniqueid}').submit(function(evt) { evt.preventDefault();

         console.debug("Check 2 : initial where is not empty");
                if (initialWhere == originalWhere) {
                    console.debug("In Check 2 b : initial where is: " + initialWhere);

var

tableId

=

"${tableid}";

console.debug("In Check 2 b : original where is: " + originalWhere);

var

$initialWhere

=

else

"$

initialwhere}" var $select = $('#filterSelect${uniqueid}').val(); var $where = $('#filterWhere${uniqueid}').val(); console.debug($select); console.debug($where); var $queryString="";


                    $queryString = appendToQueryString($queryString, "${tableid}initialWhere=" + encodeURI(initialWhere));
                    console.debug("In Check 2 c: initial where is: " + initialWhere);
                    console.debug("In Check 2 c : original where is: " + originalWhere);
                }
                console.debug("In Check 2 : initial where is: " + initialWhere);
                console.debug("In Check 2 : querystring is: " + $queryString);
            }
            if ($select.trim())

{

 {
                var $encodedSelect = encodeURI($select);
                var $selectQueryParam = tableId + ":" + "select" + "=" + $encodedSelect;
                $queryString = appendToQueryString($queryString, $selectQueryParam);

            if ($where.trim())

{

 {
                var $encodedCustomWhere = encodeURI($where);
                var $customWhereQueryParam = "${tableid}customWhere" + "=" + $encodedCustomWhere;


                var $encodedWhere = "";

                if (typeof initialWhere == 'undefined' || initialWhere == null) {
                    console.debug("Check 3 : initial where is empty");
                    $encodedWhere = encodeURI(

$initialWhere

$where);
                } else {
                    console.debug("Check 3 : initial where is not empty");
                    $encodedWhere = encodeURI(initialWhere + " AND " + $where);
                }
                var $whereQueryParam = tableId + ":" + "where" + "=" + $encodedWhere;
                $queryString = appendToQueryString($queryString, $whereQueryParam);
                $queryString = appendToQueryString($queryString, $customWhereQueryParam

);

            $action = window.location.href.split('?')[0] + $queryString;

            $('#filterForm').attr('action', $action);

            console.debug($action);
            window.location.href = $action;
        });
    }
)

;


</script>

HTML

<form id="filterForm${tableid}" action="">
  <label for="select">select:</label>
  <input id="filterSelect${tableid}" size="50" type="text" list="selects${tableid}" name="select" autocomplete="on">
  ${datalistselects}
  <label for="where">where:</label>
  <input id="

filterWhere

filterWhere${tableid}" size="50" type="text" list="

wheres

wheres${tableid}" name="where" autocomplete="on">
  ${

datalistwhere

datalistwheres}
  <input type="submit" value="Submit">
  <input type="reset" value="Reset">
</form>
<script>
AJS.toInit(
    function() {

var

 const

urlParams

logToConsole =

new URLSearchParams(window.location.search)

false;

var

originalSelect

if

=

(logToConsole)

urlParams

AJS.

get('filtered:select'); var originalWhere = urlParams.get('customWhere'

log("[copy-page-id] Registering action 'Copy Page ID to Clipboard' to keydown 'p'...");

$("#filterSelect").val(originalSelect);

    console.debug('${datalistselects}')

$("#filterWhere").val(originalWhere);

    function appendToQueryString(

queryString, queryParam

) {
            if (queryString.trim()) {

{

 queryString = queryString + "&" + queryParam;
            }

 else {

else

{

 queryString = "?" + queryParam;
            }
            return queryString;

};

$('#filterForm').submit(function(evt) {

evt.preventDefault();

var

tableId

urlParams =

"filtered"

 new URLSearchParams(window.location.search);
        var

$initialWhere

originalSelect =

"

urlParams.get('${

initialwhere}"

tableid}:select');
        var

$select

originalWhere =

$

urlParams.get('

#filterSelect').val(

${tableid}customWhere');

var

$where

initialWhere =

$

urlParams.get('

#filterWhere').val(

${tableid}initialWhere');

        console.debug(

$select); console.debug($where

"From Queryparam : initial where is: " + initialWhere);

        var oldQueryParams

$queryString

= ""

;


        urlParams.forEach(function(value, key) {
            if (

$select

!key.

trim(

startsWith("${tableid}")) {

{

var

$encodedSelect

=

encodeURI($select);

var

$selectQueryParam

oldQueryParams = appendToQueryString(oldQueryParams,

tableId

key +

":"+

select"+"

="

+$encodedSelect

 + encodeURI(value));

$queryString=appendToQueryString($queryString, $selectQueryParam);

    }
        });

        if (

$where.trim()) { var $encodedCustomWhere = encodeURI($where);

typeof initialWhere == 'undefined' || initialWhere == null) {
            console.debug("Check 1 a: initial where is empty");

var $customWhereQueryParam

  if (initialWhere =

"customWhere"+"="+$encodedCustomWhere;

= originalWhere) {

var

$encodedWhere

=

encodeURI($initialWhere + " AND

console.debug("In Check 1 b : initial where is: " +

$where

initialWhere);

var

$whereQueryParam

=

tableId

+

 console.debug("

:"+"where"+"="+$encodedWhere

In Check 1 b : original where is: " + originalWhere);

$queryString

     } else {
                initialWhere =

appendToQueryString($queryString, $whereQueryParam);

$('#${tableid} table').attr('data-projectdoc-query-where');

$queryString

=

appendToQueryString($queryString, $customWhereQueryParam ); } $action = window.location.href.split('?')[0] + $queryString; $('#filterForm').attr('action', $action); console.debug($action

console.debug("In Check 1 c: initial where is: " + initialWhere);
                console.debug("In Check 1 c : original where is: " + originalWhere);
            }
            if (typeof initialWhere == 'undefined' || initialWhere == null) {
                console.debug("Check 1 : initial is set to empty string.");

window.location.href=$action; }); }); </script>

Section

hide	true
title	HTML-CODE

HTML

Section

title	Transcluded By

Display Table

render-no-hits-as-blank	true
select	Name, Short Description, Doctype
sort-by	Sort Key, Name
where	$<TranscludedDocumentTitles>=[${Space Key}.${Title}]

...

Space shortcuts

Page tree

Versions Compared

Old Version 14

New Version Current

Key