Docs/Presentations/DataGrid

DataGrid

Presentations v1.0 zero-schema

Configures the DataGrid presentation plugin.

Missing descriptions: PresentationType, Columns, Data, DataSource, Url, DisplayRowActions, ShowActions, DisplaySearchBox, ShowSearchBox, CustomPaging, AddUrl, EditUrl, DeleteUrl, AddAction, EditAction, DeleteAction, NoRecordMessage, emptyDataMessage, ShowFooter, ShowPagination, EditIcon, RowActions, OnGridStateChanged.

Required fields

PresentationType

Properties

PresentationType required

No description

Columns array optional

No description

Data array optional

No description

DataSource ref optional

No description

Ref Actions / Action / 1.0

Url string optional

No description

DisplayRowActions boolean optional

No description

ShowActions boolean optional

No description

DisplaySearchBox boolean optional

No description

ShowSearchBox boolean optional

No description

ItemsPerPage integer, object optional

Accepts a responsive value map ({"sm": …, "md": …, "lg": …}).

PageNumber integer, object optional

Accepts a responsive value map ({"sm": …, "md": …, "lg": …}).

CustomPaging boolean optional

No description

TotalCount integer, object optional

Accepts a responsive value map ({"sm": …, "md": …, "lg": …}).

BorderColor string, object optional

Accepts a color name, the "primary" token, a #hex string, or a gradient object ({"Colors": [...], "Type": "Linear"|"Radial"|"Sweep"}).

BackgroundColor string, object optional

Accepts a color name, the "primary" token, a #hex string, or a gradient object ({"Colors": [...], "Type": "Linear"|"Radial"|"Sweep"}).

HeaderBackgroundColor string, object optional

Accepts a color name, the "primary" token, a #hex string, or a gradient object ({"Colors": [...], "Type": "Linear"|"Radial"|"Sweep"}).

HeaderColor string, object optional

Accepts a color name, the "primary" token, a #hex string, or a gradient object ({"Colors": [...], "Type": "Linear"|"Radial"|"Sweep"}).

FooterBackgroundColor string, object optional

Accepts a color name, the "primary" token, a #hex string, or a gradient object ({"Colors": [...], "Type": "Linear"|"Radial"|"Sweep"}).

FilterBadgeBackgroundColor string, object optional

Accepts a color name, the "primary" token, a #hex string, or a gradient object ({"Colors": [...], "Type": "Linear"|"Radial"|"Sweep"}).

FilterBadgeTextColor string, object optional

Accepts a color name, the "primary" token, a #hex string, or a gradient object ({"Colors": [...], "Type": "Linear"|"Radial"|"Sweep"}).

AddUrl string optional

No description

EditUrl string optional

No description

DeleteUrl string optional

No description

AddAction ref optional

No description

Ref Actions / Action / 1.0

EditAction ref optional

No description

Ref Actions / Action / 1.0

DeleteAction ref optional

No description

Ref Actions / Action / 1.0

NoRecordMessage string optional

No description

emptyDataMessage string optional

No description

ShowFooter boolean optional

No description

ShowPagination boolean optional

No description

EditIcon string optional

No description

RowActions array optional

No description

OnGridStateChanged ref optional

No description

Ref Actions / Action / 1.0

Referenced contracts

Actions / Action / 1.0 raw

Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "DataGrid",
  "description": "Configures the DataGrid presentation plugin.",
  "type": "object",
  "x-version": "1.0",
  "required": [
    "PresentationType"
  ],
  "properties": {
    "PresentationType": {
      "const": "DataGrid"
    },
    "Columns": {
      "type": "array",
      "items": {
        "type": [
          "string",
          "object"
        ]
      }
    },
    "Data": {
      "type": "array"
    },
    "DataSource": {
      "$ref": "/schema/Actions/Action/1.0/index.json"
    },
    "Url": {
      "type": "string"
    },
    "DisplayRowActions": {
      "type": "boolean"
    },
    "ShowActions": {
      "type": "boolean"
    },
    "DisplaySearchBox": {
      "type": "boolean"
    },
    "ShowSearchBox": {
      "type": "boolean"
    },
    "ItemsPerPage": {
      "type": [
        "integer",
        "object"
      ],
      "description": "Accepts a responsive value map ({\"sm\": …, \"md\": …, \"lg\": …})."
    },
    "PageNumber": {
      "type": [
        "integer",
        "object"
      ],
      "description": "Accepts a responsive value map ({\"sm\": …, \"md\": …, \"lg\": …})."
    },
    "CustomPaging": {
      "type": "boolean"
    },
    "TotalCount": {
      "type": [
        "integer",
        "object"
      ],
      "description": "Accepts a responsive value map ({\"sm\": …, \"md\": …, \"lg\": …})."
    },
    "BorderColor": {
      "type": [
        "string",
        "object"
      ],
      "description": "Accepts a color name, the \"primary\" token, a #hex string, or a gradient object ({\"Colors\": [...], \"Type\": \"Linear\"|\"Radial\"|\"Sweep\"})."
    },
    "BackgroundColor": {
      "type": [
        "string",
        "object"
      ],
      "description": "Accepts a color name, the \"primary\" token, a #hex string, or a gradient object ({\"Colors\": [...], \"Type\": \"Linear\"|\"Radial\"|\"Sweep\"})."
    },
    "HeaderBackgroundColor": {
      "type": [
        "string",
        "object"
      ],
      "description": "Accepts a color name, the \"primary\" token, a #hex string, or a gradient object ({\"Colors\": [...], \"Type\": \"Linear\"|\"Radial\"|\"Sweep\"})."
    },
    "HeaderColor": {
      "type": [
        "string",
        "object"
      ],
      "description": "Accepts a color name, the \"primary\" token, a #hex string, or a gradient object ({\"Colors\": [...], \"Type\": \"Linear\"|\"Radial\"|\"Sweep\"})."
    },
    "FooterBackgroundColor": {
      "type": [
        "string",
        "object"
      ],
      "description": "Accepts a color name, the \"primary\" token, a #hex string, or a gradient object ({\"Colors\": [...], \"Type\": \"Linear\"|\"Radial\"|\"Sweep\"})."
    },
    "FilterBadgeBackgroundColor": {
      "type": [
        "string",
        "object"
      ],
      "description": "Accepts a color name, the \"primary\" token, a #hex string, or a gradient object ({\"Colors\": [...], \"Type\": \"Linear\"|\"Radial\"|\"Sweep\"})."
    },
    "FilterBadgeTextColor": {
      "type": [
        "string",
        "object"
      ],
      "description": "Accepts a color name, the \"primary\" token, a #hex string, or a gradient object ({\"Colors\": [...], \"Type\": \"Linear\"|\"Radial\"|\"Sweep\"})."
    },
    "AddUrl": {
      "type": "string"
    },
    "EditUrl": {
      "type": "string"
    },
    "DeleteUrl": {
      "type": "string"
    },
    "AddAction": {
      "$ref": "/schema/Actions/Action/1.0/index.json"
    },
    "EditAction": {
      "$ref": "/schema/Actions/Action/1.0/index.json"
    },
    "DeleteAction": {
      "$ref": "/schema/Actions/Action/1.0/index.json"
    },
    "NoRecordMessage": {
      "type": "string"
    },
    "emptyDataMessage": {
      "type": "string"
    },
    "ShowFooter": {
      "type": "boolean"
    },
    "ShowPagination": {
      "type": "boolean"
    },
    "EditIcon": {
      "type": "string"
    },
    "RowActions": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "OnGridStateChanged": {
      "$ref": "/schema/Actions/Action/1.0/index.json"
    }
  },
  "additionalProperties": false,
  "x-icon": "<svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"1.7\" stroke-linecap=\"round\" stroke-linejoin=\"round\"><rect x=\"3\" y=\"4\" width=\"18\" height=\"16\" rx=\"2\"/><path d=\"M3 9.5h18M3 15h18M9 4v16\"/></svg>",
  "$id": "/schema/Presentations/DataGrid/1.0/index.json",
  "x-family": "Presentations",
  "x-name": "DataGrid",
  "x-source-package": "zero-schema"
}