@teipublisher/pb-components 1.32.2 → 1.33.0

package/dist/pb-elements.json

@@ -9471,6 +9471,254 @@
         }
       ]
     },
+    {
+      "name": "pb-timeline",
+      "path": "./src/pb-timeline.js",
+      "description": "A timeline component to display time series data in a bar chart like view.\n\nTime series data can be displayed in one of 6 different scales:\n\n- by decade (10Y)\n- by 5 years (5Y)\n- by years (Y)\n- by month (M)\n- by week (W)\n- by day (D)\n\nThe endpoint is expected to return a JSON object. Each property should either be a date or the special\nmarker `?`, which indicates undated resources.\nThe value associated with each entry\nshould either correspond to a count of resources or an object with properties `count` and `info`. \n`info` should be an array, containing HTML to be shown in a list within the tooltips.",
+      "attributes": [
+        {
+          "name": "start-date",
+          "description": "start date for timeline to display",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "end-date",
+          "description": "endDate for timeline to display",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "scope",
+          "description": "The scope for the timeline. Must be one of the pre-defined scopes.\nIf not set, the component automatically tries to determine the best scope fitting the\ngiven time series.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "scopes",
+          "description": "The scopes to consider for automatic scoping.\n\nDefaults to [\"D\", \"W\", \"M\", \"Y\", \"5Y\", \"10Y\"]",
+          "type": "array",
+          "default": "[\"D\",\"W\",\"M\",\"Y\",\"5Y\",\"10Y\"]"
+        },
+        {
+          "name": "url",
+          "description": "Endpoint to load timeline data from. Expects response to be an\nobject with key value pairs for (date, hits).\n\nWill be reloaded whenever 'start-date' or 'end-date' attributes change.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "auto",
+          "description": "If set, data will be retrieved automatically on first load.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "resettable",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "subscribe",
+          "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
+          "type": "string"
+        },
+        {
+          "name": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "label"
+        },
+        {
+          "name": "maxHeight",
+          "type": "number",
+          "default": "80"
+        },
+        {
+          "name": "multiplier",
+          "type": "number",
+          "default": "0.75"
+        },
+        {
+          "name": "mousedown",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "startDate",
+          "attribute": "start-date",
+          "description": "start date for timeline to display",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "endDate",
+          "attribute": "end-date",
+          "description": "endDate for timeline to display",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "scope",
+          "attribute": "scope",
+          "description": "The scope for the timeline. Must be one of the pre-defined scopes.\nIf not set, the component automatically tries to determine the best scope fitting the\ngiven time series.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "scopes",
+          "attribute": "scopes",
+          "description": "The scopes to consider for automatic scoping.\n\nDefaults to [\"D\", \"W\", \"M\", \"Y\", \"5Y\", \"10Y\"]",
+          "type": "array",
+          "default": "[\"D\",\"W\",\"M\",\"Y\",\"5Y\",\"10Y\"]"
+        },
+        {
+          "name": "url",
+          "attribute": "url",
+          "description": "Endpoint to load timeline data from. Expects response to be an\nobject with key value pairs for (date, hits).\n\nWill be reloaded whenever 'start-date' or 'end-date' attributes change.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "auto",
+          "attribute": "auto",
+          "description": "If set, data will be retrieved automatically on first load.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "resettable",
+          "attribute": "resettable",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "subscribe",
+          "attribute": "subscribe",
+          "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
+          "type": "string"
+        },
+        {
+          "name": "subscribeConfig",
+          "attribute": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "attribute": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emitConfig",
+          "attribute": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "waitFor",
+          "attribute": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "attribute": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "events": [
+        {
+          "name": "pb-timeline-date-changed",
+          "description": "Triggered when user clicks on a single entry"
+        },
+        {
+          "name": "pb-timeline-daterange-changed",
+          "description": "Triggered when user selects a range of entries"
+        },
+        {
+          "name": "pb-timeline-reset-selection",
+          "description": "Requests that the timeline is reset to initial state"
+        },
+        {
+          "name": "pb-timeline-loaded",
+          "description": "Timeline was loaded"
+        }
+      ],
+      "slots": [
+        {
+          "name": "label",
+          "description": "Inserted before the label showing the currently displayed time range"
+        }
+      ],
+      "cssProperties": [
+        {
+          "name": "--pb-timeline-height"
+        },
+        {
+          "name": "--pb-timeline-padding"
+        },
+        {
+          "name": "--pb-timeline-color-highlight"
+        },
+        {
+          "name": "--pb-timeline-color-light"
+        },
+        {
+          "name": "--pb-timeline-color-dark"
+        },
+        {
+          "name": "--pb-timeline-color-selected"
+        },
+        {
+          "name": "--pb-timeline-color-bin"
+        },
+        {
+          "name": "--pb-timeline-title-font-size"
+        },
+        {
+          "name": "--pb-timeline-tooltip-font-size"
+        }
+      ],
+      "cssParts": [
+        {
+          "name": "label"
+        },
+        {
+          "name": "tooltip"
+        },
+        {
+          "name": "title"
+        }
+      ]
+    },
     {
       "name": "pb-toggle-feature",
       "path": "./src/pb-toggle-feature.js",

package/i18n/common/de.json

@@ -274,5 +274,9 @@
     "output": "Trainingsausgabe",
     "prepare": "Trainingsdaten vorbereiten",
     "start": "Ausführen"
+  },
+  "timeline": {
+    "unknown": "undatiert",
+    "clear": "Zeitraum zurücksetzen"
   }
 }

package/i18n/common/en.json

@@ -274,5 +274,9 @@
     "output": "Training Output",
     "prepare": "Preparing training data",
     "start": "Run"
+  },
+  "timeline": {
+    "unknown": "undated",
+    "clear": "Clear date selection"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teipublisher/pb-components",
-  "version": "1.32.2",
+  "version": "1.33.0",
   "description": "Collection of webcomponents underlying TEI Publisher",
   "repository": "https://github.com/eeditiones/tei-publisher-components.git",
   "main": "index.html",

package/pb-elements.json

@@ -9471,6 +9471,254 @@
         }
       ]
     },
+    {
+      "name": "pb-timeline",
+      "path": "./src/pb-timeline.js",
+      "description": "A timeline component to display time series data in a bar chart like view.\n\nTime series data can be displayed in one of 6 different scales:\n\n- by decade (10Y)\n- by 5 years (5Y)\n- by years (Y)\n- by month (M)\n- by week (W)\n- by day (D)\n\nThe endpoint is expected to return a JSON object. Each property should either be a date or the special\nmarker `?`, which indicates undated resources.\nThe value associated with each entry\nshould either correspond to a count of resources or an object with properties `count` and `info`. \n`info` should be an array, containing HTML to be shown in a list within the tooltips.",
+      "attributes": [
+        {
+          "name": "start-date",
+          "description": "start date for timeline to display",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "end-date",
+          "description": "endDate for timeline to display",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "scope",
+          "description": "The scope for the timeline. Must be one of the pre-defined scopes.\nIf not set, the component automatically tries to determine the best scope fitting the\ngiven time series.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "scopes",
+          "description": "The scopes to consider for automatic scoping.\n\nDefaults to [\"D\", \"W\", \"M\", \"Y\", \"5Y\", \"10Y\"]",
+          "type": "array",
+          "default": "[\"D\",\"W\",\"M\",\"Y\",\"5Y\",\"10Y\"]"
+        },
+        {
+          "name": "url",
+          "description": "Endpoint to load timeline data from. Expects response to be an\nobject with key value pairs for (date, hits).\n\nWill be reloaded whenever 'start-date' or 'end-date' attributes change.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "auto",
+          "description": "If set, data will be retrieved automatically on first load.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "resettable",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "subscribe",
+          "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
+          "type": "string"
+        },
+        {
+          "name": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "properties": [
+        {
+          "name": "label"
+        },
+        {
+          "name": "maxHeight",
+          "type": "number",
+          "default": "80"
+        },
+        {
+          "name": "multiplier",
+          "type": "number",
+          "default": "0.75"
+        },
+        {
+          "name": "mousedown",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "startDate",
+          "attribute": "start-date",
+          "description": "start date for timeline to display",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "endDate",
+          "attribute": "end-date",
+          "description": "endDate for timeline to display",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "scope",
+          "attribute": "scope",
+          "description": "The scope for the timeline. Must be one of the pre-defined scopes.\nIf not set, the component automatically tries to determine the best scope fitting the\ngiven time series.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "scopes",
+          "attribute": "scopes",
+          "description": "The scopes to consider for automatic scoping.\n\nDefaults to [\"D\", \"W\", \"M\", \"Y\", \"5Y\", \"10Y\"]",
+          "type": "array",
+          "default": "[\"D\",\"W\",\"M\",\"Y\",\"5Y\",\"10Y\"]"
+        },
+        {
+          "name": "url",
+          "attribute": "url",
+          "description": "Endpoint to load timeline data from. Expects response to be an\nobject with key value pairs for (date, hits).\n\nWill be reloaded whenever 'start-date' or 'end-date' attributes change.",
+          "type": "string",
+          "default": "\"\""
+        },
+        {
+          "name": "auto",
+          "attribute": "auto",
+          "description": "If set, data will be retrieved automatically on first load.",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "resettable",
+          "attribute": "resettable",
+          "type": "boolean",
+          "default": "false"
+        },
+        {
+          "name": "subscribe",
+          "attribute": "subscribe",
+          "description": "The name of the channel to subscribe to. Only events on a channel corresponding\nto this property are listened to.",
+          "type": "string"
+        },
+        {
+          "name": "subscribeConfig",
+          "attribute": "subscribe-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to listen to.",
+          "type": "object"
+        },
+        {
+          "name": "emit",
+          "attribute": "emit",
+          "description": "The name of the channel to send events to.",
+          "type": "string"
+        },
+        {
+          "name": "emitConfig",
+          "attribute": "emit-config",
+          "description": "Configuration object to define a channel/event mapping. Every property\nin the object is interpreted as the name of a channel and its value should\nbe an array of event names to be dispatched.",
+          "type": "object"
+        },
+        {
+          "name": "waitFor",
+          "attribute": "wait-for",
+          "description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.",
+          "type": "string"
+        },
+        {
+          "name": "disabled",
+          "attribute": "disabled",
+          "description": "Common property to disable the functionality associated with a component.\n`pb-highlight` and `pb-popover` react to this.",
+          "type": "boolean",
+          "default": "false"
+        }
+      ],
+      "events": [
+        {
+          "name": "pb-timeline-date-changed",
+          "description": "Triggered when user clicks on a single entry"
+        },
+        {
+          "name": "pb-timeline-daterange-changed",
+          "description": "Triggered when user selects a range of entries"
+        },
+        {
+          "name": "pb-timeline-reset-selection",
+          "description": "Requests that the timeline is reset to initial state"
+        },
+        {
+          "name": "pb-timeline-loaded",
+          "description": "Timeline was loaded"
+        }
+      ],
+      "slots": [
+        {
+          "name": "label",
+          "description": "Inserted before the label showing the currently displayed time range"
+        }
+      ],
+      "cssProperties": [
+        {
+          "name": "--pb-timeline-height"
+        },
+        {
+          "name": "--pb-timeline-padding"
+        },
+        {
+          "name": "--pb-timeline-color-highlight"
+        },
+        {
+          "name": "--pb-timeline-color-light"
+        },
+        {
+          "name": "--pb-timeline-color-dark"
+        },
+        {
+          "name": "--pb-timeline-color-selected"
+        },
+        {
+          "name": "--pb-timeline-color-bin"
+        },
+        {
+          "name": "--pb-timeline-title-font-size"
+        },
+        {
+          "name": "--pb-timeline-tooltip-font-size"
+        }
+      ],
+      "cssParts": [
+        {
+          "name": "label"
+        },
+        {
+          "name": "tooltip"
+        },
+        {
+          "name": "title"
+        }
+      ]
+    },
     {
       "name": "pb-toggle-feature",
       "path": "./src/pb-toggle-feature.js",