@grafana/scenes 5.11.1 → 5.11.3--canary.858.10679390033.0

package/dist/index.d.ts

@@ -925,20 +925,6 @@ declare class UserActionEvent extends BusEventWithPayload<UserActionEventPayload
  */
 declare function lookupVariable(name: string, sceneObject: SceneObject): SceneVariable | null;
 
-/**
- * Will walk up the scene object graph to the closest $timeRange scene object
- */
-declare function getTimeRange(sceneObject: SceneObject): SceneTimeRangeLike;
-
-interface SceneQueryStateControllerState extends SceneObjectState {
-    isRunning: boolean;
-}
-interface SceneQueryControllerLike extends SceneObject<SceneQueryStateControllerState> {
-    isQueryController: true;
-    cancelAll(): void;
-    queryStarted(entry: SceneQueryControllerEntry): void;
-    queryCompleted(entry: SceneQueryControllerEntry): void;
-}
 interface QueryResultWithState {
     state: LoadingState;
 }
@@ -948,17 +934,40 @@ interface SceneQueryControllerEntry {
     origin: SceneObject;
     cancel?: () => void;
 }
-type SceneQueryControllerEntryType = 'data' | 'annotations' | 'variable' | 'alerts';
-declare class SceneQueryController extends SceneObjectBase<SceneQueryStateControllerState> implements SceneQueryControllerLike {
-    #private;
+type SceneQueryControllerEntryType = 'data' | 'annotations' | 'variable' | 'alerts' | 'plugin';
+interface SceneInteractionProfileEvent {
+    origin: string;
+    duration: number;
+    networkDuration: number;
+    jsHeapSizeLimit: number;
+    usedJSHeapSize: number;
+    totalJSHeapSize: number;
+    crumbs: string[];
+}
+interface SceneQueryStateControllerState extends SceneObjectState {
+    isRunning: boolean;
+    enableProfiling?: boolean;
+    onProfileComplete?(event: SceneInteractionProfileEvent): void;
+}
+interface SceneQueryControllerLike extends SceneObject<SceneQueryStateControllerState> {
     isQueryController: true;
-    constructor();
+    cancelAll(): void;
     queryStarted(entry: SceneQueryControllerEntry): void;
     queryCompleted(entry: SceneQueryControllerEntry): void;
-    private changeRunningQueryCount;
-    cancelAll(): void;
+    startProfile(source: SceneObject): void;
+    runningQueriesCount(): number;
 }
 
+/**
+ * Returns the closest query controller undefined if none found
+ */
+declare function getQueryController(sceneObject: SceneObject): SceneQueryControllerLike | undefined;
+
+/**
+ * Will walk up the scene object graph to the closest $timeRange scene object
+ */
+declare function getTimeRange(sceneObject: SceneObject): SceneTimeRangeLike;
+
 /**
  * Get the closest node with variables
  */
@@ -1023,10 +1032,6 @@ declare function getDataLayers(sceneObject: SceneObject, localOnly?: boolean): S
 declare function getAncestor<ParentType>(sceneObject: SceneObject, ancestorType: {
     new (...args: never[]): ParentType;
 }): ParentType;
-/**
- * Returns the closest query controller undefined if none found
- */
-declare function getQueryController(sceneObject: SceneObject): SceneQueryControllerLike | undefined;
 
 declare const sceneGraph: {
     getVariables: typeof getVariables;
@@ -1088,6 +1093,19 @@ declare class PanelContextEventBus implements EventBus {
     newScopedBus(key: string, filter: EventFilterOptions): EventBus;
 }
 
+declare class SceneQueryController extends SceneObjectBase<SceneQueryStateControllerState> implements SceneQueryControllerLike {
+    #private;
+    isQueryController: true;
+    private profiler;
+    constructor(state?: Partial<SceneQueryStateControllerState>);
+    runningQueriesCount: () => number;
+    startProfile(source: SceneObject): void;
+    queryStarted(entry: SceneQueryControllerEntry): void;
+    queryCompleted(entry: SceneQueryControllerEntry): void;
+    private changeRunningQueryCount;
+    cancelAll(): void;
+}
+
 interface LiveNowTimerState extends SceneObjectState {
     enabled: boolean;
 }
@@ -1821,14 +1839,24 @@ declare class SceneTimePicker extends SceneObjectBase<SceneTimePickerState> {
 declare function SceneTimePickerRenderer({ model }: SceneComponentProps<SceneTimePicker>): React__default.JSX.Element | null;
 
 interface SceneRefreshPickerState extends SceneObjectState {
+    /**
+     * Refresh interval, e.g. 5s, 1m, 2h
+     */
     refresh: string;
     autoEnabled?: boolean;
     autoMinInterval?: string;
     autoValue?: string;
+    /**
+     * List of allowed refresh intervals, e.g. ['5s', '1m']
+     */
     intervals?: string[];
     isOnCanvas?: boolean;
     primary?: boolean;
     withText?: boolean;
+    /**
+     * Overrides the default minRefreshInterval from the grafana config. Can be set to "0s" to remove the minimum refresh interval.
+     */
+    minRefreshInterval?: string;
 }
 declare class SceneRefreshPicker extends SceneObjectBase<SceneRefreshPickerState> {
     static Component: typeof SceneRefreshPickerRenderer;
@@ -2702,4 +2730,4 @@ declare const sceneUtils: {
     isGroupByVariable: typeof isGroupByVariable;
 };
 
-export { AdHocFiltersVariable, CancelActivationHandler, ConstantVariable, ControlsLayout, CustomFormatterVariable, CustomTransformOperator, CustomTransformerDefinition, CustomVariable, CustomVariableValue, DataLayerFilter, DataRequestEnricher, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, ExtraQueryDataProcessor, ExtraQueryDescriptor, ExtraQueryProvider, FieldConfigBuilder, FieldConfigBuilders, FieldConfigOverridesBuilder, FiltersRequestEnricher, FormatVariable, GroupByVariable, InterpolationFormatParameter, IntervalVariable, LocalValueVariable, MacroVariableConstructor, MultiValueVariable, MultiValueVariableState, NestedScene, PanelBuilders, PanelOptionsBuilders, QueryRunnerState, QueryVariable, RuntimeDataSource, SafeSerializableSceneObject, SceneActivationHandler, SceneApp, SceneAppDrilldownView, SceneAppPage, SceneAppPageLike, SceneAppPageState, SceneAppRoute, SceneByFrameRepeater, SceneByVariableRepeater, SceneCSSGridItem, SceneCSSGridLayout, SceneCanvasText, SceneComponent, SceneComponentProps, SceneControlsSpacer, SceneDataLayerBase, SceneDataLayerControls, SceneDataLayerProvider, SceneDataLayerProviderState, SceneDataLayerSet, SceneDataLayerSetBase, SceneDataNode, SceneDataProvider, SceneDataProviderResult, SceneDataQuery, 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, SceneRefreshPickerState, SceneRouteMatch, SceneStateChangedHandler, SceneStatelessBehavior, SceneTimePicker, SceneTimeRange, SceneTimeRangeCompare, SceneTimeRangeLike, SceneTimeRangeState, SceneTimeRangeTransformerBase, SceneTimeZoneOverride, SceneToolbarButton, SceneToolbarInput, SceneVariable, SceneVariableDependencyConfigLike, SceneVariableSet, SceneVariableSetState, SceneVariableState, SceneVariableValueChangedEvent, SceneVariables, SplitLayout, TestVariable, TextBoxVariable, UrlSyncContextProvider, UrlSyncManager, UrlSyncManagerLike, UseStateHookOptions, UserActionEvent, ValidateAndUpdateResult, VariableCustomFormatterFn, VariableDependencyConfig, VariableGetOptionsArgs, VariableValue, VariableValueControl, VariableValueOption, VariableValueSelectWrapper, VariableValueSelectors, VariableValueSingle, VizConfig, VizConfigBuilder, VizConfigBuilders, VizPanel, VizPanelBuilder, VizPanelMenu, VizPanelState, index$1 as behaviors, index as dataLayers, formatRegistry, getUrlSyncManager, isCustomVariableValue, isDataLayer, isDataRequestEnricher, isFiltersRequestEnricher, isSceneObject, registerQueryWithController, registerRuntimeDataSource, renderSelectForVariable, sceneGraph, sceneUtils, useSceneApp, useSceneObjectState, useUrlSync };
+export { AdHocFiltersVariable, CancelActivationHandler, ConstantVariable, ControlsLayout, CustomFormatterVariable, CustomTransformOperator, CustomTransformerDefinition, CustomVariable, CustomVariableValue, DataLayerFilter, DataRequestEnricher, DataSourceVariable, DeepPartial, EmbeddedScene, EmbeddedSceneState, ExtraQueryDataProcessor, ExtraQueryDescriptor, ExtraQueryProvider, FieldConfigBuilder, FieldConfigBuilders, FieldConfigOverridesBuilder, FiltersRequestEnricher, FormatVariable, GroupByVariable, InterpolationFormatParameter, IntervalVariable, LocalValueVariable, MacroVariableConstructor, MultiValueVariable, MultiValueVariableState, NestedScene, PanelBuilders, PanelOptionsBuilders, QueryRunnerState, QueryVariable, RuntimeDataSource, SafeSerializableSceneObject, SceneActivationHandler, SceneApp, SceneAppDrilldownView, SceneAppPage, SceneAppPageLike, SceneAppPageState, SceneAppRoute, SceneByFrameRepeater, SceneByVariableRepeater, SceneCSSGridItem, SceneCSSGridLayout, SceneCanvasText, SceneComponent, SceneComponentProps, SceneControlsSpacer, SceneDataLayerBase, SceneDataLayerControls, SceneDataLayerProvider, SceneDataLayerProviderState, SceneDataLayerSet, SceneDataLayerSetBase, SceneDataNode, SceneDataProvider, SceneDataProviderResult, SceneDataQuery, SceneDataState, SceneDataTransformer, SceneDeactivationHandler, SceneDebugger, SceneFlexItem, SceneFlexItemLike, SceneFlexItemState, SceneFlexLayout, SceneGridItem, SceneGridItemLike, SceneGridItemStateLike, SceneGridLayout, SceneGridRow, SceneInteractionProfileEvent, SceneLayout, SceneLayoutChildOptions, SceneLayoutState, SceneObject, SceneObjectBase, SceneObjectRef, SceneObjectState, SceneObjectStateChangedEvent, SceneObjectStateChangedPayload, SceneObjectUrlSyncConfig, SceneObjectUrlSyncHandler, SceneObjectUrlValue, SceneObjectUrlValues, SceneObjectWithUrlSync, SceneQueryControllerEntry, SceneQueryControllerEntryType, SceneQueryControllerLike, SceneQueryRunner, SceneReactObject, SceneRefreshPicker, SceneRefreshPickerState, SceneRouteMatch, SceneStateChangedHandler, SceneStatelessBehavior, SceneTimePicker, SceneTimeRange, SceneTimeRangeCompare, SceneTimeRangeLike, SceneTimeRangeState, SceneTimeRangeTransformerBase, SceneTimeZoneOverride, SceneToolbarButton, SceneToolbarInput, SceneVariable, SceneVariableDependencyConfigLike, SceneVariableSet, SceneVariableSetState, SceneVariableState, SceneVariableValueChangedEvent, SceneVariables, SplitLayout, TestVariable, TextBoxVariable, UrlSyncContextProvider, UrlSyncManager, UrlSyncManagerLike, UseStateHookOptions, UserActionEvent, ValidateAndUpdateResult, VariableCustomFormatterFn, VariableDependencyConfig, VariableGetOptionsArgs, VariableValue, VariableValueControl, VariableValueOption, VariableValueSelectWrapper, VariableValueSelectors, VariableValueSingle, VizConfig, VizConfigBuilder, VizConfigBuilders, VizPanel, VizPanelBuilder, VizPanelMenu, VizPanelState, index$1 as behaviors, index as dataLayers, formatRegistry, getUrlSyncManager, isCustomVariableValue, isDataLayer, isDataRequestEnricher, isFiltersRequestEnricher, isSceneObject, registerQueryWithController, registerRuntimeDataSource, renderSelectForVariable, sceneGraph, sceneUtils, useSceneApp, useSceneObjectState, useUrlSync };