@grafana/scenes 3.14.0 → 3.14.1--canary.655.8371909776.0

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import * as _grafana_data from '@grafana/data';
-import { BusEventWithPayload, PanelData, BusEvent, BusEventType, BusEventHandler, TimeRange, DataQueryRequest, DataTransformContext, DataFrame, DataTopic, PanelPlugin, EventBus, DataQuery, DataSourceApi, Registry, RegistryItem, ScopedVars, AdHocVariableFilter, SelectableValue, MetricFindValue, VariableRefresh as VariableRefresh$1, VariableSort, EventFilterOptions, AnnotationEvent, AnnotationQuery, DataTransformerConfig, PanelMenuItem, FieldConfigSource, PanelModel, AbsoluteTimeRange, InterpolateFunction, IconName as IconName$1, FieldConfig, FieldType, FieldValueMatcherConfig } from '@grafana/data';
+import { BusEventWithPayload, PanelData, BusEvent, BusEventType, BusEventHandler, TimeRange, DataQueryRequest, DataTransformContext, DataFrame, PanelPlugin, EventBus, DataQuery, DataSourceApi, Registry, RegistryItem, ScopedVars, AdHocVariableFilter, SelectableValue, MetricFindValue, VariableRefresh as VariableRefresh$1, VariableSort, EventFilterOptions, AnnotationEvent, AnnotationQuery, DataTransformerConfig, PanelMenuItem, FieldConfigSource, PanelModel, AbsoluteTimeRange, InterpolateFunction, IconName as IconName$1, FieldConfig, FieldType, FieldValueMatcherConfig } from '@grafana/data';
 import React$1, { CSSProperties, ComponentType } from 'react';
 import * as rxjs from 'rxjs';
 import { Observable, Unsubscribable, MonoTypeOperatorFunction, Subscription, ReplaySubject } from 'rxjs';
 import * as _grafana_schema from '@grafana/schema';
-import { VariableType, VariableHide, TimeZone, DataSourceRef, VariableRefresh, DataQuery as DataQuery$1, LoadingState, DashboardCursorSync, MatcherConfig, TableFieldOptions } from '@grafana/schema';
+import { VariableType, VariableHide, TimeZone, DataTopic, DataSourceRef, VariableRefresh, DataQuery as DataQuery$1, LoadingState, DashboardCursorSync, MatcherConfig, TableFieldOptions } from '@grafana/schema';
 import { PanelContext, IconName } from '@grafana/ui';
 import ReactGridLayout from 'react-grid-layout';
 import { RouteComponentProps } from 'react-router-dom';
@@ -263,32 +263,26 @@ type SceneStateChangedHandler<TState> = (newState: TState, prevState: TState) =>
 type DeepPartial<T> = {
     [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
 };
-interface SceneDataProviderResultLike<O, T> {
-    origin: O;
-    data: T;
+interface SceneDataProviderResult {
+    data: PanelData;
+    origin: SceneDataProvider;
 }
-type SceneDataProviderResult = SceneDataProviderResultLike<SceneDataProvider, PanelData>;
-type SceneDataLayerProviderResult = SceneDataProviderResultLike<SceneDataLayerProvider, PanelData> & {
-    topic: DataTopic;
-};
-interface SceneDataProvider extends SceneObject<SceneDataState> {
+interface SceneDataProvider<T extends SceneObjectState = SceneDataState> extends SceneObject<T> {
     setContainerWidth?: (width: number) => void;
     isDataReadyToDisplay?: () => boolean;
     cancelQuery?: () => void;
-    getResultsStream?(): Observable<SceneDataProviderResult>;
+    getResultsStream(): Observable<SceneDataProviderResult>;
 }
-interface SceneDataLayerProviderState extends SceneObjectState {
+interface SceneDataLayerProviderState extends SceneDataState {
     name: string;
     description?: string;
-    data?: PanelData;
     isEnabled?: boolean;
     isHidden?: boolean;
 }
-interface SceneDataLayerProvider extends SceneObject<SceneDataLayerProviderState> {
-    topic: DataTopic;
-    cancelQuery?: () => void;
-    getResultsStream(): Observable<SceneDataLayerProviderResult>;
+interface SceneDataLayerProvider extends SceneDataProvider<SceneDataLayerProviderState> {
+    isDataLayer: true;
 }
+declare function isDataLayer(obj: SceneObject): obj is SceneDataLayerProvider;
 interface DataLayerFilter {
     panelId: number;
 }
@@ -1140,9 +1134,9 @@ declare abstract class SceneDataLayerBase<T extends SceneDataLayerProviderState>
      */
     protected abstract runLayer(): void;
     /**
-     * Data topic that a given layer is responsible for.
+     * Mark data provider as data layer
      */
-    abstract topic: DataTopic;
+    isDataLayer: true;
     private _variableValueRecorder;
     protected _variableDependency: VariableDependencyConfig<T>;
     /**
@@ -1153,8 +1147,8 @@ declare abstract class SceneDataLayerBase<T extends SceneDataLayerProviderState>
     protected onDeactivate(): void;
     protected onVariableUpdateCompleted(): void;
     cancelQuery(): void;
-    protected publishResults(data: PanelData, topic: DataTopic): void;
-    getResultsStream(): ReplaySubject<SceneDataLayerProviderResult>;
+    protected publishResults(data: PanelData): void;
+    getResultsStream(): ReplaySubject<SceneDataProviderResult>;
     private shouldRunLayerOnActivate;
     /**
      * This helper function is to counter the contravariance of setState
@@ -1171,9 +1165,9 @@ interface AnnotationsDataLayerState extends SceneDataLayerProviderState {
     query: AnnotationQuery;
 }
 declare class AnnotationsDataLayer extends SceneDataLayerBase<AnnotationsDataLayerState> implements SceneDataLayerProvider {
+    static Component: typeof AnnotationsDataLayerRenderer;
     private _scopedVars;
     private _timeRangeSub;
-    topic: DataTopic;
     constructor(initialState: AnnotationsDataLayerState);
     onEnable(): void;
     onDisable(): void;
@@ -1194,6 +1188,7 @@ declare class AnnotationsDataLayer extends SceneDataLayerBase<AnnotationsDataLay
         traceIds?: string[] | undefined;
     };
 }
+declare function AnnotationsDataLayerRenderer({ model }: SceneComponentProps<AnnotationsDataLayer>): JSX.Element | null;
 
 type index_AnnotationsDataLayer = AnnotationsDataLayer;
 declare const index_AnnotationsDataLayer: typeof AnnotationsDataLayer;
@@ -1265,23 +1260,40 @@ declare class SceneTimeZoneOverride extends SceneTimeRangeTransformerBase<SceneT
     onTimeZoneChange(timeZone: string): void;
 }
 
-interface SceneDataLayersState extends SceneObjectState {
+declare abstract class SceneDataLayerSetBase<T extends SceneDataLayerProviderState> extends SceneObjectBase<T> implements SceneDataLayerProvider {
+    /** Mark it as a data layer */
+    isDataLayer: true;
+    /**
+     * Subscription to query results. Should be set when layer runs a query.
+     */
+    protected querySub?: Unsubscribable;
+    /**
+     * Subject to emit results to.
+     */
+    private _results;
+    protected subscribeToAllLayers(layers: SceneDataLayerProvider[]): void;
+    private _onLayerUpdateReceived;
+    getResultsStream(): Observable<SceneDataProviderResult>;
+    cancelQuery(): void;
+    /**
+     * This helper function is to counter the contravariance of setState
+     */
+    private setStateHelper;
+}
+interface SceneDataLayersSetState extends SceneDataLayerProviderState {
     layers: SceneDataLayerProvider[];
-    data?: PanelData;
 }
-declare class SceneDataLayers extends SceneObjectBase<SceneDataLayersState> implements SceneDataProvider {
-    constructor(state: SceneDataLayersState);
+declare class SceneDataLayerSet extends SceneDataLayerSetBase<SceneDataLayersSetState> implements SceneDataLayerProvider {
+    constructor(state: Partial<SceneDataLayersSetState>);
     private _onActivate;
+    static Component: ({ model }: SceneComponentProps<SceneDataLayerSet>) => JSX.Element;
 }
 
 interface SceneDataLayerControlsState extends SceneObjectState {
-    layersMap: Record<string, boolean>;
 }
 declare class SceneDataLayerControls extends SceneObjectBase<SceneDataLayerControlsState> {
     static Component: typeof SceneDataLayerControlsRenderer;
     constructor();
-    private _onActivate;
-    toggleLayer(l: SceneDataLayerProvider): void;
 }
 declare function SceneDataLayerControlsRenderer({ model }: SceneComponentProps<SceneDataLayerControls>): JSX.Element | null;
 
@@ -2427,4 +2439,4 @@ declare const sceneUtils: {
     isGroupByVariable: typeof isGroupByVariable;
 };
 
-export { AdHocFiltersVariable, CancelActivationHandler, ConstantVariable, ControlsLayout, CustomFormatterVariable, CustomTransformOperator, CustomTransformerDefinition, CustomVariable, CustomVariableValue, DataLayerFilter, DataRequestEnricher, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, FieldConfigBuilders, FormatVariable, GroupByVariable, InterpolationFormatParameter, IntervalVariable, LocalValueVariable, MacroVariableConstructor, MultiValueVariable, NestedScene, PanelBuilders, PanelOptionsBuilders, QueryRunnerState, QueryVariable, RuntimeDataSource, SceneActivationHandler, SceneApp, SceneAppDrilldownView, SceneAppPage, SceneAppPageLike, SceneAppPageState, SceneAppRoute, SceneByFrameRepeater, SceneByVariableRepeater, SceneCSSGridItem, SceneCSSGridLayout, SceneCanvasText, SceneComponent, SceneComponentProps, SceneControlsSpacer, SceneDataLayerBase, SceneDataLayerControls, SceneDataLayerProvider, SceneDataLayerProviderResult, SceneDataLayerProviderState, SceneDataLayers, SceneDataNode, SceneDataProvider, SceneDataProviderResult, SceneDataProviderResultLike, SceneDataState, SceneDataTransformer, SceneDeactivationHandler, SceneDebugger, SceneFlexItem, SceneFlexItemLike, SceneFlexItemState, SceneFlexLayout, SceneGridItem, SceneGridItemLike, SceneGridItemStateLike, SceneGridLayout, SceneGridRow, SceneLayout, SceneLayoutChildOptions, SceneLayoutState, SceneObject, SceneObjectBase, SceneObjectRef, SceneObjectState, SceneObjectStateChangedEvent, SceneObjectStateChangedPayload, SceneObjectUrlSyncConfig, SceneObjectUrlSyncHandler, SceneObjectUrlValue, SceneObjectUrlValues, SceneObjectWithUrlSync, SceneQueryControllerEntry, SceneQueryControllerEntryType, SceneQueryControllerLike, SceneQueryRunner, SceneReactObject, SceneRefreshPicker, SceneRouteMatch, SceneStateChangedHandler, SceneStatelessBehavior, SceneTimePicker, SceneTimeRange, SceneTimeRangeCompare, SceneTimeRangeLike, SceneTimeRangeState, SceneTimeRangeTransformerBase, SceneTimeZoneOverride, SceneToolbarButton, SceneToolbarInput, SceneVariable, SceneVariableDependencyConfigLike, SceneVariableSet, SceneVariableSetState, SceneVariableState, SceneVariableValueChangedEvent, SceneVariables, SplitLayout, TestVariable, TextBoxVariable, UrlSyncManager, UrlSyncManagerLike, UserActionEvent, ValidateAndUpdateResult, VariableCustomFormatterFn, VariableDependencyConfig, VariableValue, VariableValueControl, VariableValueOption, VariableValueSelectors, VariableValueSingle, VizPanel, VizPanelBuilder, VizPanelMenu, VizPanelState, index$1 as behaviors, index as dataLayers, formatRegistry, getUrlSyncManager, isCustomVariableValue, isDataRequestEnricher, isSceneObject, registerQueryWithController, registerRuntimeDataSource, sceneGraph, sceneUtils, useSceneApp };
+export { AdHocFiltersVariable, CancelActivationHandler, ConstantVariable, ControlsLayout, CustomFormatterVariable, CustomTransformOperator, CustomTransformerDefinition, CustomVariable, CustomVariableValue, DataLayerFilter, DataRequestEnricher, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, FieldConfigBuilders, FormatVariable, GroupByVariable, InterpolationFormatParameter, IntervalVariable, LocalValueVariable, MacroVariableConstructor, MultiValueVariable, NestedScene, PanelBuilders, PanelOptionsBuilders, QueryRunnerState, QueryVariable, RuntimeDataSource, SceneActivationHandler, SceneApp, SceneAppDrilldownView, SceneAppPage, SceneAppPageLike, SceneAppPageState, SceneAppRoute, SceneByFrameRepeater, SceneByVariableRepeater, SceneCSSGridItem, SceneCSSGridLayout, SceneCanvasText, SceneComponent, SceneComponentProps, SceneControlsSpacer, SceneDataLayerBase, SceneDataLayerControls, SceneDataLayerProvider, SceneDataLayerProviderState, SceneDataLayerSet, SceneDataLayerSetBase, SceneDataNode, SceneDataProvider, SceneDataProviderResult, SceneDataState, SceneDataTransformer, SceneDeactivationHandler, SceneDebugger, SceneFlexItem, SceneFlexItemLike, SceneFlexItemState, SceneFlexLayout, SceneGridItem, SceneGridItemLike, SceneGridItemStateLike, SceneGridLayout, SceneGridRow, SceneLayout, SceneLayoutChildOptions, SceneLayoutState, SceneObject, SceneObjectBase, SceneObjectRef, SceneObjectState, SceneObjectStateChangedEvent, SceneObjectStateChangedPayload, SceneObjectUrlSyncConfig, SceneObjectUrlSyncHandler, SceneObjectUrlValue, SceneObjectUrlValues, SceneObjectWithUrlSync, SceneQueryControllerEntry, SceneQueryControllerEntryType, SceneQueryControllerLike, SceneQueryRunner, SceneReactObject, SceneRefreshPicker, SceneRouteMatch, SceneStateChangedHandler, SceneStatelessBehavior, SceneTimePicker, SceneTimeRange, SceneTimeRangeCompare, SceneTimeRangeLike, SceneTimeRangeState, SceneTimeRangeTransformerBase, SceneTimeZoneOverride, SceneToolbarButton, SceneToolbarInput, SceneVariable, SceneVariableDependencyConfigLike, SceneVariableSet, SceneVariableSetState, SceneVariableState, SceneVariableValueChangedEvent, SceneVariables, SplitLayout, TestVariable, TextBoxVariable, UrlSyncManager, UrlSyncManagerLike, UserActionEvent, ValidateAndUpdateResult, VariableCustomFormatterFn, VariableDependencyConfig, VariableValue, VariableValueControl, VariableValueOption, VariableValueSelectors, VariableValueSingle, VizPanel, VizPanelBuilder, VizPanelMenu, VizPanelState, index$1 as behaviors, index as dataLayers, formatRegistry, getUrlSyncManager, isCustomVariableValue, isDataLayer, isDataRequestEnricher, isSceneObject, registerQueryWithController, registerRuntimeDataSource, sceneGraph, sceneUtils, useSceneApp };