@grafana/scenes 0.0.13 → 0.0.15

package/dist/index.d.ts

@@ -1,7 +1,6 @@
-/// <reference types="react" />
 import React, { CSSProperties } from 'react';
 import { Observable, Observer, Subscription, Unsubscribable } from 'rxjs';
-import { BusEventWithPayload, PanelData, BusEvent, BusEventType, BusEventHandler, TimeZone, TimeRange, ScopedVars, DataTransformerConfig, DataSourceRef, DataQuery, Registry, RegistryItem, VariableRefresh, VariableSort, FieldConfigSource, PanelPlugin, AbsoluteTimeRange, DataFrame } from '@grafana/data';
+import { BusEventWithPayload, PanelData, BusEvent, BusEventType, BusEventHandler, TimeZone, TimeRange, ScopedVars, DataTransformerConfig, DataSourceRef, DataQuery, Registry, RegistryItem, VariableRefresh, VariableSort, FieldConfigSource, PanelPlugin, AbsoluteTimeRange, InterpolateFunction, DataFrame } from '@grafana/data';
 import { VariableType, VariableHide, VariableModel } from '@grafana/schema';
 import { IconName } from '@grafana/ui';
 import ReactGridLayout from 'react-grid-layout';
@@ -52,7 +51,14 @@ interface SceneVariableSetState extends SceneObjectStatePlain {
     variables: SceneVariable[];
 }
 interface SceneVariables extends SceneObject<SceneVariableSetState> {
+    /**
+     * Will look for and return variable matching name
+     */
     getByName(name: string): SceneVariable | undefined;
+    /**
+     * Will return true if the variable is loading or waiting for an update to complete.
+     */
+    isVariableLoadingOrWaitingToUpdate(variable: SceneVariable): boolean;
 }
 declare class SceneVariableValueChangedEvent extends BusEventWithPayload<SceneVariable> {
     static type: string;
@@ -63,9 +69,9 @@ interface SceneVariableDependencyConfigLike {
     /** Used to check for dependency on a specific variable */
     hasDependencyOn(name: string): boolean;
     /**
-     * Will be called when any variable value has changed.
+     * Will be called when the VariableSet have completed an update process
      **/
-    variableValuesChanged(variables: Set<SceneVariable>): void;
+    variableUpdatesCompleted(changedVariables: Set<SceneVariable>): void;
 }
 
 interface SceneObjectStatePlain {
@@ -197,6 +203,11 @@ declare class SceneObjectStateChangedEvent extends BusEventWithPayload<SceneObje
 
 type CustomFormatterFn = (value: unknown, legacyVariableModel: Partial<VariableModel>, legacyDefaultFormatter?: CustomFormatterFn) => string;
 
+/**
+ * Will walk the scene object graph up to the root looking for the first variable with the specified name
+ */
+declare function lookupVariable(name: string, sceneObject: SceneObject): SceneVariable | null | undefined;
+
 /**
  * Get the closest node with variables
  */
@@ -221,6 +232,10 @@ declare function getLayout(scene: SceneObject): SceneObject<SceneLayoutState>;
  * Interpolates the given string using the current scene object as context.   *
  */
 declare function interpolate(sceneObject: SceneObject, value: string | undefined | null, scopedVars?: ScopedVars, format?: string | CustomFormatterFn): string;
+/**
+ * Checks if the variable is currently loading or waiting to update
+ */
+declare function hasVariableDependencyInLoadingState(sceneObject: SceneObject): boolean;
 declare const sceneGraph: {
     getVariables: typeof getVariables;
     getData: typeof getData;
@@ -228,6 +243,8 @@ declare const sceneGraph: {
     getSceneEditor: typeof getSceneEditor;
     getLayout: typeof getLayout;
     interpolate: typeof interpolate;
+    lookupVariable: typeof lookupVariable;
+    hasVariableDependencyInLoadingState: typeof hasVariableDependencyInLoadingState;
 };
 
 declare abstract class SceneObjectBase<TState extends SceneObjectState = SceneObjectState> implements SceneObject<TState> {
@@ -235,8 +252,6 @@ declare abstract class SceneObjectBase<TState extends SceneObjectState = SceneOb
     private _subject;
     private _state;
     private _events;
-    /** Incremented in SceneComponentWrapper, useful for tests and rendering optimizations */
-    protected _renderCount: number;
     protected _parent?: SceneObject;
     protected _subs: Subscription;
     protected _variableDependency: SceneVariableDependencyConfigLike | undefined;
@@ -343,15 +358,19 @@ interface VariableDependencyConfigOptions<TState extends SceneObjectState> {
      * If not specified the default behavior is to trigger a re-render
      */
     onReferencedVariableValueChanged?: () => void;
+    /**
+     * Optional way to customize how to handle when the variable system has completed an update
+     */
+    onVariableUpdatesCompleted?: (changedVariables: Set<SceneVariable>, dependencyChanged: boolean) => void;
 }
 declare class VariableDependencyConfig<TState extends SceneObjectState> implements SceneVariableDependencyConfigLike {
     private _sceneObject;
+    private _options;
     private _state;
     private _dependencies;
     private _statePaths?;
-    private _onReferencedVariableValueChanged;
     scanCount: number;
-    constructor(_sceneObject: SceneObject<TState>, options: VariableDependencyConfigOptions<TState>);
+    constructor(_sceneObject: SceneObject<TState>, _options: VariableDependencyConfigOptions<TState>);
     /**
      * Used to check for dependency on a specific variable
      */
@@ -359,7 +378,7 @@ declare class VariableDependencyConfig<TState extends SceneObjectState> implemen
     /**
      * This is called whenever any set of variables have new values. It up to this implementation to check if it's relevant given the current dependencies.
      */
-    variableValuesChanged(variables: Set<SceneVariable>): void;
+    variableUpdatesCompleted(changedVariables: Set<SceneVariable>): void;
     /**
      * Only way to force a re-render is to update state right now
      */
@@ -377,6 +396,7 @@ interface QueryRunnerState extends SceneObjectStatePlain {
     minInterval?: string;
     maxDataPoints?: number;
     maxDataPointsFromWidth?: boolean;
+    isWaitingForVariables?: boolean;
 }
 interface DataQueryExtended extends DataQuery {
     [key: string]: any;
@@ -384,8 +404,14 @@ interface DataQueryExtended extends DataQuery {
 declare class SceneQueryRunner extends SceneObjectBase<QueryRunnerState> {
     private _querySub?;
     private _containerWidth?;
+    private _variableValueRecorder;
     protected _variableDependency: VariableDependencyConfig<QueryRunnerState>;
     activate(): void;
+    /**
+     * Handles some tricky cases where we need to run queries even when they have not changed in case
+     * the query execution on activate was stopped due to VariableSet still not having processed all variables.
+     */
+    private onVariableUpdatesCompleted;
     private shouldRunQueriesOnActivate;
     deactivate(): void;
     setContainerWidth(width: number): void;
@@ -443,7 +469,7 @@ declare class SceneVariableSet extends SceneObjectBase<SceneVariableSetState> im
     private _variablesToUpdate;
     /** Variables currently updating  */
     private _updating;
-    private _validValuesWhenDeactivated;
+    private _variableValueRecorder;
     getByName(name: string): SceneVariable | undefined;
     /**
      * Subscribes to child variable value changes
@@ -478,6 +504,7 @@ declare class SceneVariableSet extends SceneObjectBase<SceneVariableSetState> im
      */
     private hasDependendencyInUpdateQueue;
     private handleVariableValueChanged;
+    private addDependentVariablesToUpdateQueue;
     /**
      * Walk scene object graph and update all objects that depend on variables that have changed
      */
@@ -486,6 +513,10 @@ declare class SceneVariableSet extends SceneObjectBase<SceneVariableSetState> im
      * Recursivly walk the full scene object graph and notify all objects with dependencies that include any of changed variables
      */
     private traverseSceneAndNotify;
+    /**
+     * Return true if variable is waiting to update or currently updating
+     */
+    isVariableLoadingOrWaitingToUpdate(variable: SceneVariable): boolean;
 }
 
 interface ConstantVariableState extends SceneVariableState {
@@ -571,7 +602,6 @@ interface QueryVariableState extends MultiValueVariableState {
 }
 declare class QueryVariable extends MultiValueVariable<QueryVariableState> {
     private updateSubscription?;
-    private dataSourceSubject?;
     protected _variableDependency: VariableDependencyConfig<QueryVariableState>;
     constructor(initialState: Partial<QueryVariableState>);
     activate(): void;
@@ -602,6 +632,22 @@ declare class TestVariable extends MultiValueVariable<TestVariableState> {
     static Component: ({ model }: SceneComponentProps<MultiValueVariable>) => JSX.Element;
 }
 
+interface TextBoxVariableState extends SceneVariableState {
+    value: string;
+}
+declare class TextBoxVariable extends SceneObjectBase<TextBoxVariableState> implements SceneVariable<TextBoxVariableState> {
+    protected _urlSync: SceneObjectUrlSyncHandler<TextBoxVariableState>;
+    constructor(initialState: Partial<TextBoxVariableState>);
+    getValue(): VariableValue;
+    setValue(newValue: string): void;
+    private getKey;
+    getUrlState(state: TextBoxVariableState): {
+        [x: string]: string;
+    };
+    updateFromUrl(values: SceneObjectUrlValues): void;
+    static Component: ({ model }: SceneComponentProps<TextBoxVariable>) => JSX.Element;
+}
+
 declare class UrlSyncManager {
     private sceneRoot;
     private locationListenerUnsub;
@@ -655,6 +701,8 @@ interface VizPanelState<TOptions = {}, TFieldConfig = {}> extends SceneLayoutChi
     options: DeepPartial<TOptions>;
     fieldConfig: FieldConfigSource<DeepPartial<TFieldConfig>>;
     pluginVersion?: string;
+    displayMode?: 'default' | 'transparent';
+    hoverHeader?: boolean;
     pluginLoadError?: string;
 }
 declare class VizPanel<TOptions = {}, TFieldConfig = {}> extends SceneObjectBase<VizPanelState<TOptions, TFieldConfig>> {
@@ -669,6 +717,7 @@ declare class VizPanel<TOptions = {}, TFieldConfig = {}> extends SceneObjectBase
     onChangeTimeRange: (timeRange: AbsoluteTimeRange) => void;
     onOptionsChange: (options: TOptions) => void;
     onFieldConfigChange: (fieldConfig: FieldConfigSource<TFieldConfig>) => void;
+    interpolate: InterpolateFunction;
 }
 
 interface NestedSceneState extends SceneLayoutChildState {
@@ -727,6 +776,28 @@ declare class SceneTimePicker extends SceneObjectBase<SceneTimePickerState> {
 }
 declare function SceneTimePickerRenderer({ model }: SceneComponentProps<SceneTimePicker>): JSX.Element | null;
 
+interface SceneRefreshPickerState extends SceneObjectStatePlain {
+    refresh: string;
+    intervals?: string[];
+    isOnCanvas?: boolean;
+}
+declare class SceneRefreshPicker extends SceneObjectBase<SceneRefreshPickerState> {
+    static Component: typeof SceneRefreshPickerRenderer;
+    protected _urlSync: SceneObjectUrlSyncConfig<SceneObjectState>;
+    private _intervalTimer;
+    constructor(state: Partial<SceneRefreshPickerState>);
+    activate(): void;
+    deactivate(): void;
+    onRefresh: () => void;
+    onIntervalChanged: (interval: string) => void;
+    getUrlState(): {
+        refresh: string;
+    };
+    updateFromUrl(values: SceneObjectUrlValues): void;
+    private setupIntervalTimer;
+}
+declare function SceneRefreshPickerRenderer({ model }: SceneComponentProps<SceneRefreshPicker>): JSX.Element;
+
 interface RepeatOptions extends SceneObjectStatePlain {
     body: SceneObject<SceneLayoutState>;
     getLayoutChild(data: PanelData, frame: DataFrame, frameIndex: number): SceneLayoutChild;
@@ -843,4 +914,4 @@ interface SceneAppDrilldownView {
     getPage: (routeMatch: SceneRouteMatch<any>, parent: SceneAppPage) => SceneAppPage;
 }
 
-export { ConstantVariable, CustomFormatterFn, CustomVariable, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, FormatRegistryID, FormatVariable, NestedScene, QueryRunnerState, QueryVariable, SceneApp, SceneAppPage, SceneByFrameRepeater, SceneCanvasText, SceneComponent, SceneComponentProps, SceneControlsSpacer, SceneDataNode, SceneDataState, SceneDataTransformer, SceneEditor, SceneEditorState, SceneFlexLayout, SceneGridLayout, SceneGridRow, SceneLayout, SceneLayoutChild, SceneLayoutChildOptions, SceneLayoutChildState, SceneLayoutState, SceneObject, SceneObjectBase, SceneObjectRef, SceneObjectState, SceneObjectStateChangedEvent, SceneObjectStateChangedPayload, SceneObjectStatePlain, SceneObjectUrlSyncConfig, SceneObjectUrlSyncHandler, SceneObjectUrlValue, SceneObjectUrlValues, SceneObjectWithUrlSync, SceneQueryRunner, SceneRouteMatch, SceneTimePicker, SceneTimeRange, SceneTimeRangeLike, SceneTimeRangeState, SceneToolbarButton, SceneToolbarInput, SceneVariable, SceneVariableDependencyConfigLike, SceneVariableSet, SceneVariableSetState, SceneVariableState, SceneVariableValueChangedEvent, SceneVariables, TestVariable, UrlSyncManager, ValidateAndUpdateResult, VariableDependencyConfig, VariableValue, VariableValueCustom, VariableValueOption, VariableValueSelectors, VariableValueSingle, VizPanel, VizPanelState, formatRegistry, isSceneObject, sceneGraph };
+export { ConstantVariable, CustomFormatterFn, CustomVariable, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, FormatRegistryID, FormatVariable, NestedScene, QueryRunnerState, QueryVariable, SceneApp, SceneAppPage, SceneByFrameRepeater, SceneCanvasText, SceneComponent, SceneComponentProps, SceneControlsSpacer, SceneDataNode, SceneDataState, SceneDataTransformer, SceneEditor, SceneEditorState, SceneFlexLayout, SceneGridLayout, SceneGridRow, SceneLayout, SceneLayoutChild, SceneLayoutChildOptions, SceneLayoutChildState, SceneLayoutState, SceneObject, SceneObjectBase, SceneObjectRef, SceneObjectState, SceneObjectStateChangedEvent, SceneObjectStateChangedPayload, SceneObjectStatePlain, SceneObjectUrlSyncConfig, SceneObjectUrlSyncHandler, SceneObjectUrlValue, SceneObjectUrlValues, SceneObjectWithUrlSync, SceneQueryRunner, SceneRefreshPicker, SceneRouteMatch, SceneTimePicker, SceneTimeRange, SceneTimeRangeLike, SceneTimeRangeState, SceneToolbarButton, SceneToolbarInput, SceneVariable, SceneVariableDependencyConfigLike, SceneVariableSet, SceneVariableSetState, SceneVariableState, SceneVariableValueChangedEvent, SceneVariables, TestVariable, TextBoxVariable, UrlSyncManager, ValidateAndUpdateResult, VariableDependencyConfig, VariableValue, VariableValueCustom, VariableValueOption, VariableValueSelectors, VariableValueSingle, VizPanel, VizPanelState, formatRegistry, isSceneObject, sceneGraph };