@geoscene/charts-components 5.0.19

package/dist/utils/type-guards/series-types.d.ts

@@ -0,0 +1,38 @@
+import type { WebChartCalendarDatePartsBinning, WebChartHeatChartSeries, WebChartSeries, WebChartTemporalBinning } from "../../spec/web-chart.js";
+import type { ChartTypes } from "../misc/index.js";
+
+/**
+ * Determines if a Set of series type matches a combo bar-line chart
+ *
+ * @param uniqueTypes - The set of unique series types
+ * @internal
+ */
+export function isComboLineAndBarChart(uniqueTypes: Set<string>): boolean | undefined;
+
+/**
+ * Determines if a Set of series type matches a box plot
+ *
+ * @param uniqueTypes - The set of unique series types
+ * @internal
+ */
+export function isBoxPlotChart(uniqueTypes: Set<string>): boolean;
+
+/**
+ * Getting the type of a chart or series. If the input parameters are incorrect (empty array of series, or a mix of unknown/unallowed series types) the function returns `undefined`.
+ * To get the series type, a valid seriesIndex is required. Otherwise, the type of a chart is determined and returned.
+ *
+ * @param chartSeries - The array of chart's series
+ * @param seriesIndex - An index to get a specific series' type.  A valid index is required if the goal is to get the type of the series.
+ * @internal
+ */
+export function getChartOrSeriesType(chartSeries: WebChartSeries[] | undefined, seriesIndex?: number): ChartTypes | undefined;
+
+/**
+ * Gets the binning type for a heat chart from the provided chart series.
+ *
+ * @param chartSeries - The heat chart series to check
+ * @param isXAxis - An indicator to find the associated binning type for the x-axis or y-axis
+ * @returns The binning type for the specified axis
+ * @internal
+ */
+export function getHeatChartBinningType(chartSeries: WebChartHeatChartSeries | undefined, isXAxis?: boolean): WebChartCalendarDatePartsBinning | WebChartTemporalBinning | undefined;

package/dist/utils/types/index.d.ts

@@ -0,0 +1,227 @@
+import type {
+  ModelTypes,
+  ModelTypeToSeriesType,
+} from "../../model/interfaces/common.js";
+import type {
+  WebBoxPlot,
+  WebChart,
+  WebChartBarChartSeries,
+  WebChartBoxPlotSeries,
+  WebChartGaugeSeries,
+  WebChartHistogramSeries,
+  WebChartLegend,
+  WebChartLineChartSeries,
+  WebChartPieChartLegend,
+  WebChartPieChartSeries,
+  WebChartRadarChartSeries,
+  WebChartScatterplotSeries,
+  WebGaugeChart,
+  WebHeatChart,
+} from "../../spec/web-chart.js";
+
+/** Interface to hold the action bar properties. */
+export interface ActionBarHideActionsProps {
+  /** Determines whether to hide clear selection action or not. */
+  hideClearSelection?: boolean;
+  /** Determines whether to hide filter by extent action or not. */
+  hideFilterByExtent?: boolean;
+  /** Determines whether to hide filter by selection action or not. */
+  hideFilterBySelection?: boolean;
+  /** Determines whether to hide full extent action or not. */
+  hideFullExtent?: boolean;
+  /** Determines whether to hide legend action or not. */
+  hideLegend?: boolean;
+  /** Determines whether to hide rotate action or not. */
+  hideRotateChart?: boolean;
+  /** Determines whether to hide selection action or not. */
+  hideSelection?: boolean;
+  /** Determines whether to hide switch selection action or not. */
+  hideSwitchSelection?: boolean;
+  /** Determines whether to hide zoom action or not. */
+  hideZoom?: boolean;
+  /** Determines whether to hide expand action or not. */
+  hideExpandAction?: boolean;
+}
+
+export const ChartComponentEvents: {
+  readonly DataProcessComplete: "geosceneDataProcessComplete";
+  readonly DataFetchComplete: "geosceneDataFetchComplete";
+  readonly DataProcessError: "geosceneDataProcessError";
+  readonly LegendItemVisibilityChange: "geosceneLegendItemVisibilityChange";
+  readonly UpdateComplete: "geosceneUpdateComplete";
+  readonly SeriesColorChange: "geosceneSeriesColorChange";
+  readonly AxesMinMaxChange: "geosceneAxesMinMaxChange";
+  readonly DefaultActionSelect: "geosceneDefaultActionSelect";
+  readonly SelectionComplete: "geosceneSelectionComplete";
+  readonly ActionBarToggle: "geosceneActionBarToggle";
+  readonly NoRenderPropChange: "geosceneNoRenderPropChange";
+  readonly BadDataWarningRaise: "geosceneBadDataWarningRaise";
+  readonly InvalidConfigRaise: "geosceneInvalidConfigWarningRaise";
+  readonly SeriesOrder: "geosceneSeriesOrder";
+  readonly RuntimeError: "geosceneRuntimeError";
+  readonly ConfigChange: "geosceneConfigChange";
+  readonly RenderingComplete: "geosceneRenderingComplete";
+};
+
+/** @internal */
+export const DefaultChartActions: {
+  readonly FilterBySelection: "filterBySelection";
+  readonly FilterByExtent: "filterByExtent";
+  readonly Legend: "legend";
+  readonly RotateChart: "rotateChart";
+  readonly Selection: "selection";
+  readonly ClearSelection: "clearSelection";
+  readonly SwitchSelection: "switchSelection";
+  readonly Zoom: "zoom";
+  readonly FullExtent: "fullExtent";
+  readonly EditChart: "editChart";
+  readonly ExportAsImage: "exportAsImage";
+  readonly ExportAsCSV: "exportAsCSV";
+};
+
+export type DefaultChartActions =
+  (typeof DefaultChartActions)[keyof typeof DefaultChartActions];
+
+/**
+ * Type alias for a histogram config.
+ *
+ * @internal
+ */
+export type HistogramConfig = Omit<WebChart, "series"> & {
+  series: WebChartHistogramSeries[];
+};
+
+/**
+ * Type alias for a scatterplot config.
+ *
+ * @internal
+ */
+export type ScatterplotConfig = Omit<WebChart, "series"> & {
+  series: WebChartScatterplotSeries[];
+};
+
+/**
+ * Type alias for a gauge  config.
+ *
+ * @internal
+ */
+export type GaugeChartConfig = WebGaugeChart;
+
+/**
+ * Type alias for a box plot config.
+ *
+ * @internal
+ */
+export type BoxPlotConfig = WebBoxPlot;
+
+/**
+ * Type alias for a heat chart config.
+ *
+ * @internal
+ */
+export type HeatChartConfig = WebHeatChart;
+
+/**
+ * Type alias for the supported chart series types.
+ *
+ * @internal
+ */
+export type SupportedChartSeries =
+  | WebChartBarChartSeries
+  | WebChartBoxPlotSeries
+  | WebChartGaugeSeries
+  | WebChartHistogramSeries
+  | WebChartLineChartSeries
+  | WebChartPieChartSeries
+  | WebChartRadarChartSeries
+  | WebChartScatterplotSeries;
+
+/**
+ * Type alias for a chart configuration.
+ *
+ * This type is generic and supports configuration for different chart types, data source types, and data source requirement policies.
+ *
+ * It extends and modifies the base `WebChart` while replacing the generic `series` with the specific series type.
+ *
+ * @template T - The series type. It can be any of the supported chart series types.
+ * @template V - The chart type. This acts as the base type for the configuration. Default type is derived from the series type.
+ */
+export type ChartConfig<
+  T extends ModelTypes = ModelTypes,
+  V extends WebChart = T extends typeof ModelTypes.BoxPlot
+    ? WebBoxPlot
+    : T extends typeof ModelTypes.Gauge
+    ? WebGaugeChart
+    : T extends typeof ModelTypes.HeatChart
+    ? WebHeatChart
+    : WebChart
+> = Omit<V, "legend" | "series"> & {
+  series: ModelTypeToSeriesType<T>[];
+  legend?: T extends typeof ModelTypes.PieChart
+    ? WebChartPieChartLegend
+    : WebChartLegend;
+};
+
+export const ActionToggle: {
+  readonly Active: "active";
+  readonly Inactive: "inactive";
+};
+
+export type ActionToggle = (typeof ActionToggle)[keyof typeof ActionToggle];
+
+export const ActionState: {
+  readonly Enabled: "enabled";
+  readonly Disabled: "disabled";
+};
+
+export type ActionState = (typeof ActionState)[keyof typeof ActionState];
+
+export const ErrorPolicy: {
+  readonly Ignore: "ignore";
+  readonly Throw: "throw";
+};
+
+export type ErrorPolicy = (typeof ErrorPolicy)[keyof typeof ErrorPolicy];
+
+export const ChangePolicy: {
+  readonly Ignore: "ignore";
+  readonly Refresh: "refresh";
+};
+
+export type ChangePolicy = (typeof ChangePolicy)[keyof typeof ChangePolicy];
+
+export const LayerFilterChangePolicy: {
+  readonly Ignore: "ignore";
+  readonly Refresh: "refresh";
+};
+
+export type LayerFilterChangePolicy = ChangePolicy;
+
+export const LayerRendererChangePolicy: {
+  readonly Ignore: "ignore";
+  readonly Refresh: "refresh";
+};
+
+export type LayerRendererChangePolicy = ChangePolicy;
+
+export const LayerFieldsChangePolicy: {
+  readonly Ignore: "ignore";
+  readonly Refresh: "refresh";
+};
+
+export type LayerFieldsChangePolicy = ChangePolicy;
+
+export const ViewTimeExtentChangePolicy: {
+  readonly Ignore: "ignore";
+  readonly Refresh: "refresh";
+};
+
+export type ViewTimeExtentChangePolicy = ChangePolicy;
+
+export const SyncSelectionsBetweenChartAndLayerViewPolicy: {
+  readonly Enabled: "enabled";
+  readonly Disabled: "disabled";
+};
+
+export type SyncSelectionsBetweenChartAndLayerViewPolicy =
+  (typeof SyncSelectionsBetweenChartAndLayerViewPolicy)[keyof typeof SyncSelectionsBetweenChartAndLayerViewPolicy];

package/dist/utils/ui/chart-ui-utils.d.ts

@@ -0,0 +1,34 @@
+import type { CommonStrings } from "../localization/interfaces.js";
+import type { WebChart } from "../../spec/web-chart.js";
+import type { WebChartTypes } from "../../spec/chart-object-literals.js";
+import type { Icon as Icon } from "@geoscene/calcite-components/components/calcite-icon";
+
+/**
+ * @param chart
+ * @internal
+ */
+export function getChartIcon(chart: WebChart): Icon["icon"];
+
+/**
+ * Fetches the chart type text based on the provided chart type.
+ *
+ * @param chartType - The type of chart
+ * @param config - chart config to further determine chart type text (optional)
+ * @internal
+ */
+export function fetchChartText(
+  chartType: WebChartTypes,
+  config?: WebChart
+): Promise<string>;
+
+/**
+ * Gets the chart type text based on the provided chart type.
+ *
+ * @param props - The type of chart
+ * @internal
+ */
+export function getChartText(props: {
+  chartType: WebChartTypes;
+  commonStrings: CommonStrings;
+  config?: WebChart;
+}): string;

package/dist/utils/ui/popover-ui-utils.d.ts

@@ -0,0 +1,35 @@
+import type { IntervalPopoverProps } from "../../interfaces.js";
+import type { Popover as Popover } from "@geoscene/calcite-components/components/calcite-popover";
+
+/**
+ * Remove popover element
+ *
+ * @param popover - popover element to be removed
+ * @internal
+ */
+export function removePopover(popover: any): null;
+
+/**
+ * Edit popover element dynamically
+ *
+ * @param popover - a popover element
+ * @param isOpen - determine whether to open popover or not
+ * @internal
+ */
+export function editPopover(
+  popover: Popover | undefined,
+  isOpen?: boolean
+): void;
+
+/**
+ * Check if the selected content in the popover has changed. Ignores cases going to or coming from `undefined`, as this indicates setup or teardown of the popover rather than a change in selection.
+ *
+ * @param newSelectedContent - new selected content
+ * @param oldSelectedContent - old selected content
+ * @returns true if the selected content has changed, false otherwise
+ * @internal
+ */
+export function popoverSelectedContentHasChanged(
+  newSelectedContent: IntervalPopoverProps | string[] | string | undefined,
+  oldSelectedContent: IntervalPopoverProps | string[] | string | undefined
+): boolean;

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@geoscene/charts-components",
+  "version": "5.0.19",
+  "description": "Reusable GeoScene charting Web Components.",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./loader": "./dist/loader.js",
+    "./package.json": "./package.json",
+    "./components/*/customElement": "./dist/components/*/customElement.js",
+    "./components/*": "./dist/components/*/index.js",
+    "./types/*": "./dist/types/*.d.ts",
+    "./docs/*": "./dist/docs/*",
+    "./main.css": "./dist/cdn/main.css",
+    "./geoscene-charts-components/geoscene-charts-components.css": "./dist/cdn/main.css",
+    "./dist/geoscene-charts-components/geoscene-charts-components.css": "./dist/cdn/main.css",
+    "./dist/loader": "./dist/loader.js",
+    "./dist/components": "./dist/index.js",
+    "./dist/components/*": "./dist/components/*/index.js"
+  },
+  "files": [
+    "dist/"
+  ],
+  "license": "SEE LICENSE IN LICENSE.md",
+  "dependencies": {
+    "@amcharts/amcharts4": "^4.10.31",
+    "@amcharts/amcharts5": "~5.15.5",
+    "@geoscene/geoscene-html-sanitizer": "~4.1.0",
+    "ajv": "6.12.6",
+    "d3-array": "^3.2.1",
+    "d3-shape": "^3.2.0",
+    "fast-memoize": "^2.5.2",
+    "html2canvas": "^1.4.1",
+    "jszip": "^3.10.1",
+    "lit": "^3.3.0",
+    "lodash-es": "^4.17.23",
+    "luxon": "~3.7.2",
+    "simple-statistics": "^7.8.8",
+    "tslib": "^2.8.1",
+    "uuid": "^11.1.0",
+    "@geoscene/toolkit": "5.0.19",
+    "@geoscene/lumina": "5.0.19"
+  },
+  "peerDependencies": {
+    "@geoscene/core": "^5.0.0",
+    "@geoscene/calcite-components": "^5.0.2"
+  },
+  "css.customData": [
+    "dist/docs/vscode.css-custom-data.json"
+  ],
+  "customElements": "dist/docs/api.json",
+  "html.customData": [
+    "dist/docs/vscode.html-custom-data.json"
+  ],
+  "web-types": "dist/docs/web-types.json"
+}