Skip to main content
Version: 2.4

Reporting Widgets

Report Table tsm-pivot-reporting-widget​

Tabular representation of report data with filtering options.

Widget Or Layout: unknown

Value:

{
  "type": "layout",
  "title": "Report Table",
  "widget": {
    "type": "tsm-pivot-reporting-widget"
  }
}

Inputs​

Height

Key: height

Name: Height

Default: null

Label for "sum in the column"

Key: labelTotalCountColumn

Name: Label for "sum in the column"

Default: ""

Label for "sum in the row"

Key: labelTotalCountRow

Name: Label for "sum in the row"

Default: ""

Show filter

Key: showFilter

Name: Show filter

Default: false

Show sum in the column

Key: showTotalCountColumn

Name: Show sum in the column

Default: true

Show sum in the row

Key: showTotalCountRow

Name: Show sum in the row

Default: true

Show line number

Key: showLineNumber

Name: Show line number

Default: false

External filter

Key: externalFilters

Name: External filter

Default: []

Examples​

Curated configurations from libs/framework/fluent-forms/__fixtures__/widgets/tsm-pivot-reporting-widget/. Each is a complete validated FluentSchema — copy & adapt for your form.

Gen height — gen-height.json

Demonstrates widget.height = "exampleValue" on tsm-pivot-reporting-widget.

{
  "type": "object",
  "title": "Report Table — Height",
  "description": "Demonstrates widget.height = \"exampleValue\" on tsm-pivot-reporting-widget.",
  "properties": {
    "field": {
      "type": "layout",
      "title": "Field",
      "widget": {
        "type": "tsm-pivot-reporting-widget",
        "height": "exampleValue"
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen label total count column — gen-label-total-count-column.json

Demonstrates widget.labelTotalCountColumn = "top" on tsm-pivot-reporting-widget.

{
  "type": "object",
  "title": "Report Table — Label for \"sum in the column\"",
  "description": "Demonstrates widget.labelTotalCountColumn = \"top\" on tsm-pivot-reporting-widget.",
  "properties": {
    "field": {
      "type": "layout",
      "title": "Field",
      "widget": {
        "type": "tsm-pivot-reporting-widget",
        "labelTotalCountColumn": "top"
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen label total count row — gen-label-total-count-row.json

Demonstrates widget.labelTotalCountRow = "top" on tsm-pivot-reporting-widget.

{
  "type": "object",
  "title": "Report Table — Label for \"sum in the row\"",
  "description": "Demonstrates widget.labelTotalCountRow = \"top\" on tsm-pivot-reporting-widget.",
  "properties": {
    "field": {
      "type": "layout",
      "title": "Field",
      "widget": {
        "type": "tsm-pivot-reporting-widget",
        "labelTotalCountRow": "top"
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen show filter — gen-show-filter.json

Demonstrates widget.showFilter = true on tsm-pivot-reporting-widget.

{
  "type": "object",
  "title": "Report Table — Show filter",
  "description": "Demonstrates widget.showFilter = true on tsm-pivot-reporting-widget.",
  "properties": {
    "field": {
      "type": "layout",
      "title": "Field",
      "widget": {
        "type": "tsm-pivot-reporting-widget",
        "showFilter": true
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen show total count column — gen-show-total-count-column.json

Demonstrates widget.showTotalCountColumn = false on tsm-pivot-reporting-widget.

{
  "type": "object",
  "title": "Report Table — Show sum in the column",
  "description": "Demonstrates widget.showTotalCountColumn = false on tsm-pivot-reporting-widget.",
  "properties": {
    "field": {
      "type": "layout",
      "title": "Field",
      "widget": {
        "type": "tsm-pivot-reporting-widget",
        "showTotalCountColumn": false
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen show total count row — gen-show-total-count-row.json

Demonstrates widget.showTotalCountRow = false on tsm-pivot-reporting-widget.

{
  "type": "object",
  "title": "Report Table — Show sum in the row",
  "description": "Demonstrates widget.showTotalCountRow = false on tsm-pivot-reporting-widget.",
  "properties": {
    "field": {
      "type": "layout",
      "title": "Field",
      "widget": {
        "type": "tsm-pivot-reporting-widget",
        "showTotalCountRow": false
      }
    }
  },
  "layout": [
    "field"
  ]
}

Report Chart tsm-chart-reporting-widget​

Graphical representation of report data.

Widget Or Layout: unknown

Value:

{
  "type": "layout",
  "title": "Report Chart",
  "widget": {
    "type": "tsm-chart-reporting-widget"
  }
}

Inputs​

Height

Key: height

Name: Height

Default: null

Script

Key: scriptCode

Name: Script

Default: null

Buttons position

Key: buttonsPosition

Name: Buttons position

Default: "top"

Show filter

Key: showFilter

Name: Show filter

Default: false

External filter

Key: externalFilters

Name: External filter

Default: []

Examples​

Curated configurations from libs/framework/fluent-forms/__fixtures__/widgets/tsm-chart-reporting-widget/. Each is a complete validated FluentSchema — copy & adapt for your form.

Gen buttons position — gen-buttons-position.json

Demonstrates widget.buttonsPosition = "exampleValue" on tsm-chart-reporting-widget.

{
  "type": "object",
  "title": "Report Chart — Buttons position",
  "description": "Demonstrates widget.buttonsPosition = \"exampleValue\" on tsm-chart-reporting-widget.",
  "properties": {
    "field": {
      "type": "layout",
      "title": "Field",
      "widget": {
        "type": "tsm-chart-reporting-widget",
        "buttonsPosition": "exampleValue"
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen external filters — gen-external-filters.json

Demonstrates widget.externalFilters = ["exampleItem"] on tsm-chart-reporting-widget.

{
  "type": "object",
  "title": "Report Chart — External filter",
  "description": "Demonstrates widget.externalFilters = [\"exampleItem\"] on tsm-chart-reporting-widget.",
  "properties": {
    "field": {
      "type": "layout",
      "title": "Field",
      "widget": {
        "type": "tsm-chart-reporting-widget",
        "externalFilters": [
          "exampleItem"
        ]
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen height — gen-height.json

Demonstrates widget.height = "exampleValue" on tsm-chart-reporting-widget.

{
  "type": "object",
  "title": "Report Chart — Height",
  "description": "Demonstrates widget.height = \"exampleValue\" on tsm-chart-reporting-widget.",
  "properties": {
    "field": {
      "type": "layout",
      "title": "Field",
      "widget": {
        "type": "tsm-chart-reporting-widget",
        "height": "exampleValue"
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen script code — gen-script-code.json

Demonstrates widget.scriptCode = "exampleValue" on tsm-chart-reporting-widget.

{
  "type": "object",
  "title": "Report Chart — Script",
  "description": "Demonstrates widget.scriptCode = \"exampleValue\" on tsm-chart-reporting-widget.",
  "properties": {
    "field": {
      "type": "layout",
      "title": "Field",
      "widget": {
        "type": "tsm-chart-reporting-widget",
        "scriptCode": "exampleValue"
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen show filter — gen-show-filter.json

Demonstrates widget.showFilter = true on tsm-chart-reporting-widget.

{
  "type": "object",
  "title": "Report Chart — Show filter",
  "description": "Demonstrates widget.showFilter = true on tsm-chart-reporting-widget.",
  "properties": {
    "field": {
      "type": "layout",
      "title": "Field",
      "widget": {
        "type": "tsm-chart-reporting-widget",
        "showFilter": true
      }
    }
  },
  "layout": [
    "field"
  ]
}

Listing - Filter dtl-table-filter-widget​

Listing - Filter

Widget Or Layout: unknown

Value:

{
  "type": "object",
  "title": "Listing - Filter",
  "widget": {
    "type": "dtl-table-filter-widget",
    "notitle": true,
    "persistent": "Never"
  },
  "config": {
    "listingId": "",
    "listingTypeCode": ""
  }
}

Inputs​

Title position

Key: labelPosition

Name: Title position

Default: "left"

Optional CSS class for input

Key: fieldHtmlClass

Name: Optional CSS class for input

Default: ""

Optional CSS class for description

Key: labelHtmlClass

Name: Optional CSS class for description

Default: ""

Hide title

Key: notitle

Name: Hide title

Default: false

Hidden

Key: hidden

Name: Hidden

Default: false

Listing ID

Key: listingId

Name: Listing ID

Default: null

Listing type

Key: listingTypeCode

Name: Listing type

Default: null

Profile category

Key: profileCategory

Name: Profile category

Default: null

Profile

Key: profileId

Name: Profile

Default: null

Filters

Key: filters

Name: Filters

Description: Allows defining filters for the data displayed in the list.

Default: null

Examples​

Curated configurations from libs/framework/fluent-forms/__fixtures__/widgets/dtl-table-filter-widget/. Each is a complete validated FluentSchema — copy & adapt for your form.

Gen filters — gen-filters.json

Filters: Allows defining filters for the data displayed in the list.

{
  "type": "object",
  "title": "Listing - Filter — Filters",
  "description": "Filters: Allows defining filters for the data displayed in the list.",
  "properties": {
    "field": {
      "type": "object",
      "title": "Field",
      "widget": {
        "type": "dtl-table-filter-widget",
        "filters": "exampleValue"
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen listing id — gen-listing-id.json

Demonstrates widget.listingId = "exampleValue" on dtl-table-filter-widget.

{
  "type": "object",
  "title": "Listing - Filter — Listing ID",
  "description": "Demonstrates widget.listingId = \"exampleValue\" on dtl-table-filter-widget.",
  "properties": {
    "field": {
      "type": "object",
      "title": "Field",
      "widget": {
        "type": "dtl-table-filter-widget",
        "listingId": "exampleValue"
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen listing type code — gen-listing-type-code.json

Demonstrates widget.listingTypeCode = "exampleValue" on dtl-table-filter-widget.

{
  "type": "object",
  "title": "Listing - Filter — Listing type",
  "description": "Demonstrates widget.listingTypeCode = \"exampleValue\" on dtl-table-filter-widget.",
  "properties": {
    "field": {
      "type": "object",
      "title": "Field",
      "widget": {
        "type": "dtl-table-filter-widget",
        "listingTypeCode": "exampleValue"
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen profile category — gen-profile-category.json

Demonstrates widget.profileCategory = "exampleValue" on dtl-table-filter-widget.

{
  "type": "object",
  "title": "Listing - Filter — Profile category",
  "description": "Demonstrates widget.profileCategory = \"exampleValue\" on dtl-table-filter-widget.",
  "properties": {
    "field": {
      "type": "object",
      "title": "Field",
      "widget": {
        "type": "dtl-table-filter-widget",
        "profileCategory": "exampleValue"
      }
    }
  },
  "layout": [
    "field"
  ]
}

Gen profile id — gen-profile-id.json

Demonstrates widget.profileId = "exampleValue" on dtl-table-filter-widget.

{
  "type": "object",
  "title": "Listing - Filter — Profile",
  "description": "Demonstrates widget.profileId = \"exampleValue\" on dtl-table-filter-widget.",
  "properties": {
    "field": {
      "type": "object",
      "title": "Field",
      "widget": {
        "type": "dtl-table-filter-widget",
        "profileId": "exampleValue"
      }
    }
  },
  "layout": [
    "field"
  ]
}