### Initialize VizTextDisplayOptions Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-VizTextDisplayOptions.md Instantiate the VizTextDisplayOptions object. No setup is required. ```python VizTextDisplayOptions() ``` -------------------------------- ### Instantiate Transformation Builder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboardv2/builder-Transformation.md Use this to start building a transformation configuration. ```python Transformation() ``` -------------------------------- ### Initialize VizTooltipOptionsBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/common/builder-VizTooltipOptionsBuilder.md Instantiate the builder to start configuring tooltip options. ```java new VizTooltipOptionsBuilder() ``` -------------------------------- ### New MatcherConfigBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/xychart/builder-MatcherConfigBuilder.md Initializes a new MatcherConfigBuilder. Use this to start configuring a matcher. ```go func NewMatcherConfigBuilder() *MatcherConfigBuilder ``` -------------------------------- ### Initialize MapViewConfig Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/geomap/builder-MapViewConfig.md Instantiate the MapViewConfig builder. No setup is required. ```python MapViewConfig() ``` -------------------------------- ### Install Dependencies and Run Example Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/typescript/README.md Use these commands to install project dependencies and run a Grafana dashboard example locally. ```bash yarn install yarn dev ``` -------------------------------- ### Install and Deploy Pulumi Stack Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/pulumi/README.md Commands to install dependencies and deploy infrastructure using Pulumi. Ensure you are in the example's directory before running. ```console pulumi install ``` ```console pulumi up ``` -------------------------------- ### Initialize Metadata Builder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/resource/builder-Metadata.md Instantiate the Metadata builder. No setup or imports are required for basic instantiation. ```python Metadata() ``` -------------------------------- ### Initialize HeatmapColorOptions Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/heatmap/builder-HeatmapColorOptions.md Creates a new instance of HeatmapColorOptions. No specific setup is required. ```python HeatmapColorOptions() ``` -------------------------------- ### Set Alarm Name Prefix Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/cloudwatch/builder-AnnotationQueryBuilder.md Filters alarms by a prefix in their name. For example, 'my-team-service-' matches alarms with names starting with this prefix. ```go func (builder *AnnotationQueryBuilder) AlarmNamePrefix(alarmNamePrefix string) *AnnotationQueryBuilder ``` -------------------------------- ### Filter AnnotationQuery by Alarm Name Prefix Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/cloudwatch/builder-AnnotationQuery.md Filters results to alarms whose names start with the specified prefix. For example, 'my-team-service-' matches 'my-team-service-high-cpu' but not 'your-team-service-high-cpu'. ```python def alarm_name_prefix(alarm_name_prefix: str) -> typing.Self ``` -------------------------------- ### Initialize ExemplarConfig Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/heatmap/builder-ExemplarConfig.md Use the constructor to create a new ExemplarConfig object. This object is used to configure exemplar display options. ```python ExemplarConfig() ``` -------------------------------- ### Set Action Prefix Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/cloudwatch/builder-AnnotationQueryBuilder.md Filters alarms by a prefix in their action name. For example, 'arn:aws:sns:us-east-1:123456789012:my-app-' matches alarms with actions starting with this prefix. ```go func (builder *AnnotationQueryBuilder) ActionPrefix(actionPrefix string) *AnnotationQueryBuilder ``` -------------------------------- ### Create New VisualizationV2Builder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/annotationslist/builder-VisualizationV2Builder.md Initializes a new instance of the VisualizationV2Builder. Use this to start building a visualization configuration. ```go func NewVisualizationV2Builder() *VisualizationV2Builder ``` -------------------------------- ### TimeShift Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/candlestick/builder-PanelBuilder.md Overrides the time range for individual panels by shifting its start and end relative to the dashboard's time picker. For example, `2h` shifts the panel's time range two hours earlier. ```APIDOC ## TimeShift ### Description Overrides the time range for individual panels by shifting its start and end relative to the time picker. For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. Note: Panel time overrides have no effect when the dashboard’s time range is absolute. See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options ### Method Signature ```go func (builder *PanelBuilder) TimeShift(timeShift string) *PanelBuilder ``` ``` -------------------------------- ### Build a Dashboard with PHP Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/dashboard/index.md Constructs a Grafana dashboard using the DashboardBuilder class. This example demonstrates setting dashboard properties, adding rows, and defining a timeseries panel with a Prometheus target. Ensure the SDK is installed via Composer. ```php use Grafana\Foundation\Common; use Grafana\Foundation\Dashboard\DashboardBuilder; use Grafana\Foundation\Dashboard\RowBuilder; use Grafana\Foundation\Prometheus; use Grafana\Foundation\Timeseries; require_once __DIR__.'/vendor/autoload.php'; $builder = (new DashboardBuilder(title: 'Sample dashboard')) ->uid('generated-from-php') ->tags(['generated', 'from', 'php']) ->refresh('1m') ->time('now-30m', 'now') ->timezone(Common\Constants::TIME_ZONE_BROWSER) ->withRow(new RowBuilder('Overview')) ->withPanel( (new Timeseries\PanelBuilder()) ->title('Network received') ->unit('bps') ->min(0) ->withTarget( (new Prometheus\DataqueryBuilder()) ->expr('rate(node_network_receive_bytes_total{job="integrations/raspberrypi-node", device!="lo"}[$__rate_interval]) * 8') ->legendFormat('{{ device }}') ) ) ; echo(json_encode($builder->build(), JSON_PRETTY_PRINT).PHP_EOL); ``` -------------------------------- ### Initialize FetchOptionsBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/dashboard/builder-FetchOptionsBuilder.md Use the `NewFetchOptionsBuilder` function to create a new instance of the builder. ```go func NewFetchOptionsBuilder() *FetchOptionsBuilder ``` -------------------------------- ### time_shift Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/barchart/builder-Panel.md Overrides the time range for individual panels by shifting its start and end relative to the dashboard time picker. Example: '2h' to shift the time range two hours earlier. Panel time overrides have no effect when the dashboard's time range is absolute. ```APIDOC ## time_shift ### Description Overrides the time range for individual panels by shifting its start and end relative to the time picker. For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. Note: Panel time overrides have no effect when the dashboard’s time range is absolute. See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options ### Method `time_shift(time_shift: str) -> typing.Self` ``` -------------------------------- ### Shift Panel Time Range (TimeShift) Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/librarypanel/builder-PanelModelBuilder.md Overrides the time range for individual panels by shifting their start and end times relative to the dashboard's time picker. For example, shifting the range two hours earlier. This setting is ignored if the dashboard's time range is absolute. ```go func (builder *PanelModelBuilder) TimeShift(timeShift string) *PanelModelBuilder ``` -------------------------------- ### Create a New VisualizationBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/annotationslist/builder-VisualizationBuilder.md Initializes a new instance of the VisualizationBuilder. ```go func NewVisualizationBuilder() *VisualizationBuilder ``` -------------------------------- ### timeShift Annotation Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/typescript/docs/Reference/annotationslist/builder-PanelBuilder.md Overrides the time range for individual panels by shifting their start and end relative to the dashboard's time picker. For example, '2h' shifts the panel time range two hours earlier. Panel time overrides have no effect when the dashboard's time range is absolute. ```typescript timeShift(timeShift: string) ``` -------------------------------- ### Initialize FetchOptions Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboard/builder-FetchOptions.md Instantiate the FetchOptions object. No arguments are required. ```python FetchOptions() ``` -------------------------------- ### Instantiate TraceqlFilter Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/tempo/builder-TraceqlFilter.md Use this to create a new TraceqlFilter object. No setup is required. ```python TraceqlFilter() ``` -------------------------------- ### Initialize ElasticsearchMinSettings Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/elasticsearch/builder-ElasticsearchMinSettings.md Use the constructor to create a new instance of ElasticsearchMinSettings. ```python ElasticsearchMinSettings() ``` -------------------------------- ### TimeShift Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/annotationslist/builder-PanelBuilder.md Overrides the time range for individual panels by shifting its start and end relative to the time picker. For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. Panel time overrides have no effect when the dashboard’s time range is absolute. ```APIDOC ## TimeShift ### Description Overrides the time range for individual panels by shifting its start and end relative to the time picker. For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting `2h`. Panel time overrides have no effect when the dashboard’s time range is absolute. ### Method ```go func (builder *PanelBuilder) TimeShift(timeShift string) *PanelBuilder ``` ``` -------------------------------- ### Initialize PromQLQueryBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/googlecloudmonitoring/builder-PromQLQueryBuilder.md Instantiate the PromQLQueryBuilder to start building a PromQL query. ```java new PromQLQueryBuilder() ``` -------------------------------- ### timeShift Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/bargauge/builder-PanelBuilder.md Overrides the time range for individual panels by shifting their start and end relative to the dashboard's time picker. For example, you can shift the time range for a panel to be two hours earlier than the dashboard time picker setting. Panel time overrides have no effect when the dashboard's time range is absolute. ```APIDOC ## timeShift ### Description Overrides the time range for individual panels by shifting its start and end relative to the time picker. ### Method ```php timeShift(string $timeShift) ``` ``` -------------------------------- ### Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/xychart/builder-XychartXYSeriesConfigXBuilder.md Initializes a new instance of the XychartXYSeriesConfigXBuilder. ```APIDOC ## Constructor Initializes a new instance of the XychartXYSeriesConfigXBuilder. ```php new XychartXYSeriesConfigXBuilder() ``` ``` -------------------------------- ### Initialize OptionsWithTextFormatting Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-OptionsWithTextFormatting.md Instantiates the OptionsWithTextFormatting builder. No setup is required. ```python OptionsWithTextFormatting() ``` -------------------------------- ### Set Start Value Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/testdata/builder-Query.md Sets the starting value for the query. ```python def start_value(start_value: float) -> typing.Self ``` -------------------------------- ### Initialize QueryBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/athena/builder-QueryBuilder.md Creates a new instance of the QueryBuilder. ```go func NewQueryBuilder() *QueryBuilder ``` -------------------------------- ### Instantiate CodeOptions Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/text/builder-CodeOptions.md Creates a new instance of CodeOptions. No setup or imports are required. ```python CodeOptions() ``` -------------------------------- ### Initialize OptionsWithTooltip Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-OptionsWithTooltip.md Instantiate the OptionsWithTooltip builder. ```python OptionsWithTooltip() ``` -------------------------------- ### Set Start Value Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/testdata/builder-QueryBuilder.md Set the starting value for the query. ```php startValue(float $startValue) ``` -------------------------------- ### Set Start Time for TimeOption Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/dashboard/builder-TimeOptionBuilder.md Sets the start time for the time option. ```java public TimeOptionBuilder from(String from) ``` -------------------------------- ### VizLegendOptions Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-VizLegendOptions.md Initializes a new instance of VizLegendOptions. ```APIDOC ## Constructor ```python VizLegendOptions() ``` ``` -------------------------------- ### Create UnknownQueryBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/azuremonitor/builder-UnknownQueryBuilder.md Instantiate a new UnknownQueryBuilder. This is the starting point for building an UnknownQuery. ```go func NewUnknownQueryBuilder() *UnknownQueryBuilder ``` -------------------------------- ### Initialize QueryV2Builder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/athena/builder-QueryV2Builder.md Use this constructor to create a new instance of the QueryV2Builder. ```go func NewQueryV2Builder() *QueryV2Builder ``` -------------------------------- ### Install Grafana Foundation SDK Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/typescript/README.md Install the Grafana Foundation SDK using yarn. ```shell yarn add "@grafana/grafana-foundation-sdk@~v0.0.18" ``` -------------------------------- ### Set Start Time Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/dashboardv2beta1/builder-TimeRangeOptionBuilder.md Use the from method to specify the start time for the time range option. ```java public TimeRangeOptionBuilder from(String from) ``` -------------------------------- ### Create New ArcOptionBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/nodegraph/builder-ArcOptionBuilder.md Initializes a new ArcOptionBuilder. Use this to start configuring an ArcOption. ```go func NewArcOptionBuilder() *ArcOptionBuilder ``` -------------------------------- ### Initialize ElasticsearchTopMetricsSettings Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/elasticsearch/builder-ElasticsearchTopMetricsSettings.md Instantiate the ElasticsearchTopMetricsSettings builder. No setup is required before calling this constructor. ```python ElasticsearchTopMetricsSettings() ``` -------------------------------- ### Set Start Time Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/prometheus/builder-TimeRangeBuilder.md Sets the start time for the query. Accepts a string representation of the time. ```go func (builder *TimeRangeBuilder) From(from string) *TimeRangeBuilder ``` -------------------------------- ### Initialize HeatmapTooltipBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/heatmap/builder-HeatmapTooltipBuilder.md Creates a new instance of HeatmapTooltipBuilder. ```go func NewHeatmapTooltipBuilder() *HeatmapTooltipBuilder ``` -------------------------------- ### Instantiate LineStyle Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-LineStyle.md Creates a new LineStyle object. No setup is required. ```python LineStyle() ``` -------------------------------- ### Initialize QueryOptionsSpecBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/dashboardv2/builder-QueryOptionsSpecBuilder.md Instantiate a new QueryOptionsSpecBuilder to start building query options. ```java new QueryOptionsSpecBuilder() ``` -------------------------------- ### Run Python Examples Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/python/README.md Instructions for setting up and running the Python examples. Requires Python 3.11+. ```bash python -m venv .venv source .venv/bin/activate pip install -r requirements.txt python main.py ``` -------------------------------- ### Initialize PromQLQuery Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/googlecloudmonitoring/builder-PromQLQuery.md Use the constructor to create a new PromQLQuery object. ```python PromQLQuery() ``` -------------------------------- ### Initialize ColorDimensionConfig Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-ColorDimensionConfig.md Use the constructor to create a new instance of ColorDimensionConfig. ```python ColorDimensionConfig() ``` -------------------------------- ### Run Go Examples Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/go/README.md Commands to vendor dependencies and run the Go examples from their respective directories. ```console $ go mod vendor $ go run . ``` -------------------------------- ### Initialize DashboardTemplating Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboard/builder-DashboardDashboardTemplating.md Instantiate the DashboardTemplating object. No setup or imports are required beyond the class definition. ```python DashboardDashboardTemplating() ``` -------------------------------- ### Set Week Start Day Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboard/builder-Dashboard.md Configures the day on which the week starts. Expressed in lowercase, e.g., 'monday'. ```python def week_start(week_start: str) -> typing.Self ``` -------------------------------- ### Set TimeRange Start Value Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/alerting/builder-TimeRange.md Sets the start value for the TimeRange. Accepts a string representation of the time. ```python def from_val(from_val: str) -> typing.Self: ``` -------------------------------- ### Initialize VizTooltipOptions Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-VizTooltipOptions.md Creates a new instance of VizTooltipOptions. ```python VizTooltipOptions() ``` -------------------------------- ### Set Start Time for Query Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/expr/builder-ExprTypeSqlTimeRangeBuilder.md Use the 'from' method to specify the start time for the SQL query. ```java public ExprTypeSqlTimeRangeBuilder from(String from) ``` -------------------------------- ### Initialize MonitorResource Builder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/azuremonitor/builder-MonitorResource.md Instantiate the MonitorResource builder. ```python MonitorResource() ``` -------------------------------- ### Set Query Start Time Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/expr/builder-ExprTypeResampleTimeRangeBuilder.md Sets the start time for the query. Accepts a string representation of the time. ```java public ExprTypeResampleTimeRangeBuilder from(String from) ``` -------------------------------- ### Initialize RawData Builder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/elasticsearch/builder-RawData.md Instantiate the RawData builder. No setup or imports are required for basic instantiation. ```python RawData() ``` -------------------------------- ### Set Start Value for Dataquery Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/testdata/builder-Dataquery.md Use `start_value` to specify the starting value for the query. Accepts a floating-point number. ```python def start_value(start_value: float) -> typing.Self ``` -------------------------------- ### NewPromQLQueryBuilder Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/googlecloudmonitoring/builder-PromQLQueryBuilder.md Initializes a new instance of PromQLQueryBuilder. ```go func NewPromQLQueryBuilder() *PromQLQueryBuilder ``` -------------------------------- ### Initialize PanelBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/annotationslist/builder-PanelBuilder.md Instantiate a new PanelBuilder to start constructing a panel. ```java new PanelBuilder() ``` -------------------------------- ### ExprTypeReduceTimeRangeBuilder.From Go Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/expr/builder-ExprTypeReduceTimeRangeBuilder.md Sets the start time for the query. The 'from' parameter should be a string representing the desired start time. ```go func (builder *ExprTypeReduceTimeRangeBuilder) From(from string) *ExprTypeReduceTimeRangeBuilder ``` -------------------------------- ### Create a new StackingConfigBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/common/builder-StackingConfigBuilder.md Instantiate a new StackingConfigBuilder to start configuring stacking settings. ```go func NewStackingConfigBuilder() *StackingConfigBuilder ``` -------------------------------- ### HorizontalConstraint Usage Example Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/canvas/object-HorizontalConstraint.md Example demonstrating how to use the HorizontalConstraint enum to set an object's horizontal constraint. ```APIDOC ## Usage Example ```php use Grafana\Foundation\Canvas\HorizontalConstraint; // Set an object's horizontal constraint to left alignment $object->setHorizontalConstraint(HorizontalConstraint::left()); // Create a constraint from a string value $constraint = HorizontalConstraint::fromValue('center'); $object->setHorizontalConstraint($constraint); ``` ``` -------------------------------- ### ExemplarConfigBuilder Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/heatmap/builder-ExemplarConfigBuilder.md Initializes a new instance of ExemplarConfigBuilder. ```APIDOC ## NewExemplarConfigBuilder ### Description Initializes a new instance of the ExemplarConfigBuilder. ### Signature ```go func NewExemplarConfigBuilder() *ExemplarConfigBuilder ``` ``` -------------------------------- ### Set Query Start Time Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/expr/builder-ExprTypeReduceTimeRangeBuilder.md Use the `from` method to specify the start time for the query. Accepts a String representation of the time. ```java public ExprTypeReduceTimeRangeBuilder from(String from) ``` -------------------------------- ### Set Week Start Day Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/dashboardv2/builder-TimeSettingsBuilder.md Specifies the day on which the week starts, expressed in lowercase (e.g., "monday"). ```java public TimeSettingsBuilder weekStart(TimeSettingsSpecWeekStart weekStart) ``` -------------------------------- ### New CanvasOptionsRootBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/canvas/builder-CanvasOptionsRootBuilder.md Initializes a new instance of CanvasOptionsRootBuilder. Use this to start building canvas root options. ```go func NewCanvasOptionsRootBuilder() *CanvasOptionsRootBuilder ``` -------------------------------- ### New MatcherBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/alerting/builder-MatcherBuilder.md Initializes a new MatcherBuilder. Use this to start building a new matcher. ```go func NewMatcherBuilder() *MatcherBuilder ``` -------------------------------- ### Install Grafana Foundation SDK Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/README.md Install the Grafana Foundation SDK using pip. Ensure you specify the desired version. ```shell python3 -m pip install 'grafana_foundation_sdk==v0.0.18' ``` -------------------------------- ### Initialize TracesQuery Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/azuremonitor/builder-TracesQuery.md Instantiate the TracesQuery builder. This is the starting point for constructing a traces query. ```python TracesQuery() ``` -------------------------------- ### Install Grafana Foundation SDK for Go Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/README.md Use this command to install the SDK. Ensure you are using version v0.0.18 or later. ```shell go get github.com/grafana/grafana-foundation-sdk/go@v0.0.18 ``` -------------------------------- ### NewSimulationQueryBuilder Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/testdata/builder-SimulationQueryBuilder.md Initializes a new instance of the SimulationQueryBuilder. Use this to start building a SimulationQuery. ```go func NewSimulationQueryBuilder() *SimulationQueryBuilder ``` -------------------------------- ### Install Dependencies and Run PHP Script Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/php/README.md Installs Composer dependencies and executes the PHP script to generate a Grafana dashboard. ```bash composer install php index.php ``` -------------------------------- ### Create New LineStyleBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/common/builder-LineStyleBuilder.md Initializes a new instance of LineStyleBuilder. ```go func NewLineStyleBuilder() *LineStyleBuilder ``` -------------------------------- ### Preview Go Examples with grafanactl Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/examples/go/README.md Command to preview dashboards locally using grafanactl, serving the Go example script. ```console grafanactl resources serve --script 'go run .' ``` -------------------------------- ### Initialize VizLegendOptions Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-VizLegendOptions.md Instantiate the VizLegendOptions object to begin configuring legend settings. ```python VizLegendOptions() ``` -------------------------------- ### Set TimeRange Start Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/testdata/builder-TimeRange.md Use the from_val method to specify the start time for the query range. Accepts a string representation of the time. ```python def from_val(from_val: str) -> typing.Self: ``` -------------------------------- ### ExemplarConfig Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/heatmap/builder-ExemplarConfig.md Initializes a new ExemplarConfig object. ```APIDOC ## Constructor ```python ExemplarConfig() ``` ``` -------------------------------- ### Set Start Value for DataqueryBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/testdata/builder-DataqueryBuilder.md Define the `startValue` for a data series. This is useful for initializing graphs or simulations with a specific starting point. ```java public dataqueryBuilder startValue(Double startValue) ``` -------------------------------- ### NewTooltipOptionsBuilder Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/geomap/builder-TooltipOptionsBuilder.md Initializes a new instance of TooltipOptionsBuilder. Use this to start building tooltip configurations. ```go func NewTooltipOptionsBuilder() *TooltipOptionsBuilder ``` -------------------------------- ### Set Query Start Time Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/expr/builder-ExprTypeThresholdTimeRangeBuilder.md Specify the start time for the query using a string representation. This method is part of the builder pattern. ```java public ExprTypeThresholdTimeRangeBuilder from(String from) ``` -------------------------------- ### NewColorDimensionConfigBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/common/builder-ColorDimensionConfigBuilder.md Initializes a new instance of ColorDimensionConfigBuilder. Use this to start building a ColorDimensionConfig. ```go func NewColorDimensionConfigBuilder() *ColorDimensionConfigBuilder ``` -------------------------------- ### NewBackgroundConfigBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/canvas/builder-BackgroundConfigBuilder.md Initializes a new instance of BackgroundConfigBuilder. Use this to start configuring background properties. ```go func NewBackgroundConfigBuilder() *BackgroundConfigBuilder ``` -------------------------------- ### Set Start Time for Time Range Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/expr/builder-ExprTypeClassicConditionsTimeRangeBuilder.md Use the `from` method to specify the start time of the query. Accepts a String representation of the time. ```java public ExprTypeClassicConditionsTimeRangeBuilder from(String from) ``` -------------------------------- ### Initialize Dashboardv2beta1RegexMapOptions Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboardv2beta1/builder-Dashboardv2beta1RegexMapOptions.md Use the constructor to create a new instance of Dashboardv2beta1RegexMapOptions. ```python Dashboardv2beta1RegexMapOptions() ``` -------------------------------- ### Set Fiscal Year Start Month Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/dashboardv2/builder-TimeSettingsBuilder.md Specifies the starting month of the fiscal year. Use 0 for January and 11 for December. ```go func (builder *TimeSettingsBuilder) FiscalYearStartMonth(fiscalYearStartMonth int64) *TimeSettingsBuilder ``` -------------------------------- ### Set Week Start Day Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/typescript/docs/Reference/dashboard/builder-DashboardBuilder.md Specifies the day when the week starts. The value should be the lowercase name of the day, e.g., "monday". ```typescript weekStart(weekStart: string) ``` -------------------------------- ### Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/xychart/builder-XychartXYSeriesConfigYBuilder.md Initializes a new instance of the XychartXYSeriesConfigYBuilder. ```APIDOC ## Constructor ```java new XychartXYSeriesConfigYBuilder() ``` ``` -------------------------------- ### Initialize PointsConfigBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/common/builder-PointsConfigBuilder.md Creates a new instance of the PointsConfigBuilder. This is the starting point for configuring points. ```go func NewPointsConfigBuilder() *PointsConfigBuilder ``` -------------------------------- ### Set TimeRange Start Time Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/prometheus/builder-TimeRange.md Use the from_val method to specify the start time for the query. This method returns the builder instance for chaining. ```python def from_val(from_val: str) -> typing.Self: pass ``` -------------------------------- ### Set Fiscal Year Start Month Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/dashboardv2/builder-TimeSettingsBuilder.md Specifies the starting month of the fiscal year, where 0 represents January and 11 represents December. ```java public TimeSettingsBuilder fiscalYearStartMonth(Long fiscalYearStartMonth) ``` -------------------------------- ### Initialize QueryOptionsSpec Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboardv2/builder-QueryOptionsSpec.md Use the constructor to create a new instance of QueryOptionsSpec. ```python QueryOptionsSpec() ``` -------------------------------- ### Initialize HeatmapTooltip Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/heatmap/builder-HeatmapTooltip.md Instantiate the HeatmapTooltip builder. This is the starting point for configuring tooltip options. ```python HeatmapTooltip() ``` -------------------------------- ### Initialize Rate Builder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/elasticsearch/builder-Rate.md Instantiate the Rate builder. No setup or imports are required beyond having the elasticsearch module available. ```python Rate() ``` -------------------------------- ### Set Week Start Day Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/dashboardv2/builder-TimeSettingsBuilder.md Defines the day on which the week starts. Expressed by the lowercase name of the day (e.g., "monday"). ```go func (builder *TimeSettingsBuilder) WeekStart(weekStart dashboardv2.TimeSettingsSpecWeekStart) *TimeSettingsBuilder ``` -------------------------------- ### build Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/heatmap/builder-ExemplarConfigBuilder.md Builds the ExemplarConfig object. ```APIDOC ## build Builds the object. ```java public ExemplarConfig build() ``` ``` -------------------------------- ### Set Dashboard Week Start Day Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/dashboard/builder-DashboardBuilder.md Specifies the day on which the week starts for the dashboard, using lowercase day names (e.g., 'monday'). ```go func (builder *DashboardBuilder) WeekStart(weekStart string) *DashboardBuilder ``` -------------------------------- ### Install Grafana Foundation SDK (PHP) Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/README.md Use Composer to install the Grafana Foundation SDK for PHP. Ensure you specify the desired version. ```shell composer require "grafana/foundation-sdk:v0.0.18" ``` -------------------------------- ### Initialize Snapshot Builder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboard/builder-Snapshot.md Use this constructor to begin building a dashboard snapshot. No setup or imports are required beyond this. ```python Snapshot() ``` -------------------------------- ### Set Fiscal Year Start Month Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/typescript/docs/Reference/dashboard/builder-DashboardBuilder.md Specifies the starting month of the fiscal year for the dashboard. Use a number from 0 (January) to 11 (December). ```typescript fiscalYearStartMonth(fiscalYearStartMonth: number) ``` -------------------------------- ### Instantiate XychartXYSeriesConfigX Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/xychart/builder-XychartXYSeriesConfigX.md Use the constructor to create a new instance of XychartXYSeriesConfigX. ```python XychartXYSeriesConfigX() ``` -------------------------------- ### Set Fiscal Year Start Month Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboard/builder-Dashboard.md Specifies the starting month of the fiscal year for the dashboard. Accepts an integer where 0 represents January and 11 represents December. ```python def fiscal_year_start_month(fiscal_year_start_month: int) -> typing.Self ``` -------------------------------- ### Set Fiscal Year Start Month Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/dashboard/builder-DashboardBuilder.md Specifies the starting month of the fiscal year for the dashboard. Accepts an integer where 0 represents January and 11 represents December. ```php fiscalYearStartMonth(int $fiscalYearStartMonth) ``` -------------------------------- ### Initialize Dashboardv2beta1ActionStyle Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboardv2beta1/builder-Dashboardv2beta1ActionStyle.md Use the constructor to create a new instance of the Dashboardv2beta1ActionStyle builder. ```python Dashboardv2beta1ActionStyle() ``` -------------------------------- ### from Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/expr/builder-ExprTypeClassicConditionsTimeRangeBuilder.md Sets the start time of the query. ```APIDOC ## from From is the start time of the query. ```java public ExprTypeClassicConditionsTimeRangeBuilder from(String from) ``` ``` -------------------------------- ### VizLegendOptionsBuilder Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/common/builder-VizLegendOptionsBuilder.md Initializes a new instance of the VizLegendOptionsBuilder. ```APIDOC ## Constructor Initializes a new instance of the VizLegendOptionsBuilder. ```go func NewVizLegendOptionsBuilder() *VizLegendOptionsBuilder ``` ``` -------------------------------- ### From Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/expr/builder-ExprTypeReduceTimeRangeBuilder.md Sets the start time for the query. ```APIDOC ## From Sets the start time for the query. ### Signature ```go func (builder *ExprTypeReduceTimeRangeBuilder) From(from string) *ExprTypeReduceTimeRangeBuilder ``` ### Parameters #### Path Parameters - **from** (string) - Required - The start time of the query. ``` -------------------------------- ### Initialize NodeOptions Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/nodegraph/builder-NodeOptions.md Instantiate the NodeOptions builder. ```python NodeOptions() ``` -------------------------------- ### Set Dashboard Start Time Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/dashboardv2/builder-TimeSettingsBuilder.md Configures the start time range for the dashboard. Accepts relative time strings (e.g., "now-6h") or absolute time strings (e.g., "2020-07-10T08:00:00.000Z"). ```go func (builder *TimeSettingsBuilder) From(from string) *TimeSettingsBuilder ``` -------------------------------- ### PulseWaveQuery Constructor and Methods Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/testdata/builder-PulseWaveQuery.md Demonstrates the instantiation of PulseWaveQuery and the usage of its configuration methods. ```APIDOC ## PulseWaveQuery ### Constructor ```python PulseWaveQuery() ``` ### Methods #### build Builds the object. ```python def build() -> testdata.PulseWaveQuery ``` #### off_count Sets the off_count for the PulseWaveQuery. ```python def off_count(off_count: int) -> typing.Self ``` #### off_value Sets the off_value for the PulseWaveQuery. ```python def off_value(off_value: float) -> typing.Self ``` #### on_count Sets the on_count for the PulseWaveQuery. ```python def on_count(on_count: int) -> typing.Self ``` #### on_value Sets the on_value for the PulseWaveQuery. ```python def on_value(on_value: float) -> typing.Self ``` #### time_step Sets the time_step for the PulseWaveQuery. ```python def time_step(time_step: int) -> typing.Self ``` ``` -------------------------------- ### Create ExemplarConfig Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/heatmap/index.md Creates a new ExemplarConfig object. Use this to initialize exemplar configurations for heatmaps. ```go func NewExemplarConfig() *ExemplarConfig ``` -------------------------------- ### ExprTypeSqlTimeRange.from_val() Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/expr/builder-ExprTypeSqlTimeRange.md Sets the start time for the query. ```APIDOC ## from_val(from_val: str) From is the start time of the query. ```python def from_val(from_val: str) -> typing.Self ``` ``` -------------------------------- ### ExprTypeReduceTimeRange.from_val Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/expr/builder-ExprTypeReduceTimeRange.md Sets the start time for the query. ```APIDOC ## Method: from_val ### Description From is the start time of the query. ### Signature ```python def from_val(from_val: str) -> typing.Self ``` ``` -------------------------------- ### Initialize HeatmapCalculationBucketConfig Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-HeatmapCalculationBucketConfig.md Use the constructor to create a new instance of HeatmapCalculationBucketConfig. ```python HeatmapCalculationBucketConfig() ``` -------------------------------- ### QueryOptionsSpec.time_from Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboardv2/builder-QueryOptionsSpec.md Sets the start time for the query. ```APIDOC ## time_from ```python def time_from(time_from: str) -> typing.Self ``` ``` -------------------------------- ### weekStart() Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/preferencesv1alpha1/builder-PreferencesBuilder.md Sets the starting day of the week. ```APIDOC ## weekStart() day of the week (sunday, monday, etc) ```php weekStart(string $weekStart) ``` ``` -------------------------------- ### Instantiate ElasticsearchBucketScriptSettings Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/elasticsearch/builder-ElasticsearchBucketScriptSettings.md Use the constructor to create a new instance of ElasticsearchBucketScriptSettings. ```python ElasticsearchBucketScriptSettings() ``` -------------------------------- ### Instantiate ElasticsearchRawDocumentSettings Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/elasticsearch/builder-ElasticsearchRawDocumentSettings.md Use the constructor to create a new instance of ElasticsearchRawDocumentSettings. ```python ElasticsearchRawDocumentSettings() ``` -------------------------------- ### from(string $from) Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/expr/builder-ExprTypeResampleTimeRangeBuilder.md Sets the start time for the query. ```APIDOC ## from(string $from) From is the start time of the query. ```php from(string $from) ``` ``` -------------------------------- ### from Method Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/expr/builder-ExprTypeClassicConditionsTimeRangeBuilder.md Sets the start time for the query. ```APIDOC ## from From is the start time of the query. ### Parameters #### Path Parameters - **from** (string) - Required - The start time of the query. ### Method ```php from(string $from) ``` ``` -------------------------------- ### build() Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/preferencesv1alpha1/builder-PreferencesBuilder.md Builds and returns the configured Preferences object. ```APIDOC ## build() Builds the object. ```java public Preferences build() ``` ``` -------------------------------- ### startValue Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/testdata/builder-QueryBuilder.md Sets the starting value for the query. ```APIDOC ## startValue ### Description Sets the starting value for the query. ### Method Signature ```java public QueryBuilder startValue(Double startValue) ``` ``` -------------------------------- ### Instantiate ElasticsearchGeoHashGridSettings Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/elasticsearch/builder-ElasticsearchGeoHashGridSettings.md Use the constructor to create a new instance of the ElasticsearchGeoHashGridSettings builder. ```python ElasticsearchGeoHashGridSettings() ``` -------------------------------- ### from Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/dashboard/builder-TimeOptionBuilder.md Sets the start time for the time option. ```APIDOC ## from Sets the start time for the time option. ### Method ```java public TimeOptionBuilder from(String from) ``` ``` -------------------------------- ### WeekStart Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/dashboardv2beta1/builder-TimeSettingsBuilder.md Specifies the starting day of the week. ```APIDOC ## WeekStart ### Description Sets the day on which the week starts. This should be expressed by the name of the day in lowercase (e.g., "monday"). ### Signature ```go func (builder *TimeSettingsBuilder) WeekStart(weekStart dashboardv2beta1.TimeSettingsSpecWeekStart) *TimeSettingsBuilder ``` ### Parameters #### Query Parameters - **weekStart** (dashboardv2beta1.TimeSettingsSpecWeekStart) - Required - The starting day of the week (e.g., "monday"). ``` -------------------------------- ### Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/elasticsearch/builder-ElasticsearchBucketScriptSettingsBuilder.md Initializes a new instance of the ElasticsearchBucketScriptSettingsBuilder. ```APIDOC ## Constructor Initializes a new instance of the ElasticsearchBucketScriptSettingsBuilder. ```java new ElasticsearchBucketScriptSettingsBuilder() ``` ``` -------------------------------- ### From Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/dashboardv2beta1/builder-TimeSettingsBuilder.md Sets the start time range for the dashboard. ```APIDOC ## From ### Description Defines the start time range for the dashboard. Accepted values include relative time strings (e.g., "now-6h") or absolute time strings (e.g., "2020-07-10T08:00:00.000Z"). ### Signature ```go func (builder *TimeSettingsBuilder) From(from string) *TimeSettingsBuilder ``` ### Parameters #### Query Parameters - **from** (string) - Required - The start time for the dashboard's time range. ``` -------------------------------- ### Initialize PlaylistItem Builder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/playlistv1/builder-PlaylistItem.md Instantiate the PlaylistItem builder. ```python PlaylistItem() ``` -------------------------------- ### From Method Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/dashboard/builder-TimeOptionBuilder.md Sets the start time for the TimeOption. ```go func (builder *TimeOptionBuilder) From(from string) *TimeOptionBuilder ``` -------------------------------- ### build() Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/common/builder-VizTooltipOptionsBuilder.md Builds the VizTooltipOptions object with the configured settings. ```APIDOC ## build() Builds the VizTooltipOptions object with the configured settings. ### Method ```java public VizTooltipOptions build() ``` ``` -------------------------------- ### From Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/alerting/builder-TimeRangeBuilder.md Sets the start time for the time range. ```APIDOC ## From ### Description Sets the start time for the time range. ### Signature ```go func (builder *TimeRangeBuilder) From(from time.Time) *TimeRangeBuilder ``` ### Parameters #### Path Parameters - **from** (time.Time) - Required - The start time for the range. ``` -------------------------------- ### MonthRangeBuilder.Begin Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/alerting/builder-MonthRangeBuilder.md Sets the starting month for the MonthRange. ```APIDOC ## Begin ### Description Sets the starting month for the MonthRange. ### Signature ```go func (builder *MonthRangeBuilder) Begin(begin int32) *MonthRangeBuilder ``` ### Parameters #### Path Parameters - **begin** (int32) - Required - The starting month (e.g., 1 for January, 12 for December). ``` -------------------------------- ### Initialize LogsQuery Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/azuremonitor/builder-LogsQuery.md Instantiate the LogsQuery builder. No setup or imports are required beyond having the azuremonitor library available. ```python LogsQuery() ``` -------------------------------- ### startValue Method Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/typescript/docs/Reference/testdata/builder-QueryV2Builder.md Sets the starting value for the query. ```typescript startValue(startValue: number) ``` -------------------------------- ### NewSimulationQueryBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/testdata/builder-SimulationQueryBuilder.md Initializes a new instance of SimulationQueryBuilder. ```APIDOC ## NewSimulationQueryBuilder Initializes a new instance of SimulationQueryBuilder. ### Signature ```go func NewSimulationQueryBuilder() *SimulationQueryBuilder ``` ``` -------------------------------- ### startValue Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/typescript/docs/Reference/testdata/builder-DataqueryBuilder.md Sets the starting value for the generated data. ```APIDOC ## startValue ### Description Sets the starting value for the generated data. ### Parameters #### Query Parameters - **startValue** (number) - Required - The starting value. ``` -------------------------------- ### Initialize TracesQueryBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/azuremonitor/builder-TracesQueryBuilder.md Creates a new instance of the TracesQueryBuilder. ```go func NewTracesQueryBuilder() *TracesQueryBuilder ``` -------------------------------- ### start_value Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/testdata/builder-Dataquery.md Sets the starting value for the data query. ```APIDOC ## start_value ### Description Sets the starting value for the data query. ### Parameters #### Query Parameters - **start_value** (float) - Required - The starting value. ``` -------------------------------- ### NewPromQLQueryBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/googlecloudmonitoring/builder-PromQLQueryBuilder.md Initializes a new instance of the PromQLQueryBuilder. ```APIDOC ## NewPromQLQueryBuilder ### Description Initializes a new instance of the PromQLQueryBuilder. ### Signature ```go func NewPromQLQueryBuilder() *PromQLQueryBuilder ``` ``` -------------------------------- ### from_val Method Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/expr/builder-ExprTypeClassicConditionsTimeRange.md Sets the start time for the query. ```APIDOC ### from_val From is the start time of the query. ```python def from_val(from_val: str) -> typing.Self ``` ``` -------------------------------- ### fiscal_year_start_month Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboard/builder-Dashboard.md Sets the starting month for the fiscal year. ```APIDOC ## fiscal_year_start_month ### Description Sets the starting month for the fiscal year. Use an integer where 0 represents January and 11 represents December. ### Parameters #### Path Parameters - **fiscal_year_start_month** (int) - Required - The month (0-11) that the fiscal year starts on. ``` -------------------------------- ### Initialize DashboardRegexMapOptions Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/dashboard/builder-DashboardRegexMapOptions.md Use the constructor to create a new instance of DashboardRegexMapOptions. ```python DashboardRegexMapOptions() ``` -------------------------------- ### timeFrom() Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/dashboardv2/builder-QueryOptionsSpecBuilder.md Sets the start time for the query options. ```APIDOC ## timeFrom() ```php timeFrom(string $timeFrom) ``` ``` -------------------------------- ### Initialize OptionsWithLegend Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-OptionsWithLegend.md Instantiate the OptionsWithLegend builder. ```python OptionsWithLegend() ``` -------------------------------- ### begin Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/alerting/builder-WeekdayRangeBuilder.md Sets the starting day for the weekday range. ```APIDOC ### begin ```php begin(int $begin) ``` ``` -------------------------------- ### Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/canvas/builder-CanvasOptionsRootBuilder.md Initializes a new instance of CanvasOptionsRootBuilder. ```APIDOC ## Constructor Initializes a new instance of CanvasOptionsRootBuilder. ```go func NewCanvasOptionsRootBuilder() *CanvasOptionsRootBuilder ``` ``` -------------------------------- ### startValue Method Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/testdata/builder-QueryV2Builder.md Set the starting value for the query. ```java public QueryV2Builder startValue(Double startValue) ``` -------------------------------- ### Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/dashboardv2beta1/builder-Dashboardv2beta1ActionStyleBuilder.md Initializes a new instance of the Dashboardv2beta1ActionStyleBuilder. ```APIDOC ## Constructor Initializes a new instance of the Dashboardv2beta1ActionStyleBuilder. ```java new Dashboardv2beta1ActionStyleBuilder() ``` ``` -------------------------------- ### from Method Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/dashboardv2beta1/builder-TimeRangeOptionBuilder.md Sets the start time for the time range. ```APIDOC ## from ```java public TimeRangeOptionBuilder from(String from) ``` ``` -------------------------------- ### Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/elasticsearch/builder-ElasticsearchGeoHashGridSettingsBuilder.md Initializes a new instance of the ElasticsearchGeoHashGridSettingsBuilder. ```APIDOC ## Constructor Initializes a new instance of the ElasticsearchGeoHashGridSettingsBuilder. ```java new ElasticsearchGeoHashGridSettingsBuilder() ``` ``` -------------------------------- ### from(String from) Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/alerting/builder-TimeRangeBuilder.md Sets the start time for the time range. ```APIDOC ## from(String from) Sets the start time for the time range. ### Method ```java public TimeRangeBuilder from(String from) ``` ### Parameters #### Path Parameters - **from** (String) - Required - The start time string. ``` -------------------------------- ### OptionsWithTooltip Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-OptionsWithTooltip.md Initializes a new instance of the OptionsWithTooltip builder. ```APIDOC ## Constructor ```python OptionsWithTooltip() ``` ``` -------------------------------- ### Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/stat/builder-VisualizationV2.md Initializes a new instance of the VisualizationV2 builder. ```APIDOC ## Constructor Initializes a new instance of the VisualizationV2 builder. ```python VisualizationV2() ``` ``` -------------------------------- ### begin Method Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/alerting/builder-MonthRangeBuilder.md Sets the starting month for the MonthRange. ```APIDOC ## begin ```java public MonthRangeBuilder begin(Integer begin) ``` ``` -------------------------------- ### StartValue Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/testdata/builder-DataqueryBuilder.md Sets the starting value for the data query. ```APIDOC ## StartValue ### Description Sets the starting value for the data query. ### Method Signature ```go func (builder *DataqueryBuilder) StartValue(startValue float64) *DataqueryBuilder ``` ``` -------------------------------- ### TimeFrom Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/dashboardv2/builder-QueryOptionsSpecBuilder.md Sets the start time for the query options. ```APIDOC ## TimeFrom Sets the start time for the query options. ### Signature ```go func (builder *QueryOptionsSpecBuilder) TimeFrom(timeFrom string) *QueryOptionsSpecBuilder ``` ### Parameters - **timeFrom** (string) - The start time string. ``` -------------------------------- ### Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/xychart/builder-XychartXYSeriesConfigNameBuilder.md Initializes a new instance of the XychartXYSeriesConfigNameBuilder. ```APIDOC ## Constructor Initializes a new instance of the XychartXYSeriesConfigNameBuilder. ```java new XychartXYSeriesConfigNameBuilder() ``` ``` -------------------------------- ### ExprTypeThresholdResultAssertionsType Usage Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/php/docs/Reference/expr/object-ExprTypeThresholdResultAssertionsType.md Examples of how to use the ExprTypeThresholdResultAssertionsType enum. ```APIDOC ## Usage Examples ### Getting an enum instance: ```php use GrafanaSdk\ExprTypeThresholdResultAssertionsType; $assertionType = ExprTypeThresholdResultAssertionsType::timeseriesWide(); ``` ### Creating from a string value: ```php use GrafanaSdk\ExprTypeThresholdResultAssertionsType; try { $assertionType = ExprTypeThresholdResultAssertionsType::fromValue('table'); } catch (\UnexpectedValueException $e) { // Handle invalid value } ``` ### Using in JSON serialization: ```php use GrafanaSdk\ExprTypeThresholdResultAssertionsType; $assertionType = ExprTypeThresholdResultAssertionsType::numericMulti(); $jsonData = json_encode($assertionType); // $jsonData will be "numeric-multi" ``` ### String conversion: ```php use GrafanaSdk\ExprTypeThresholdResultAssertionsType; $assertionType = ExprTypeThresholdResultAssertionsType::logLines(); echo $assertionType; // Outputs "log-lines" ``` ``` -------------------------------- ### begin(begin: number) Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/typescript/docs/Reference/alerting/builder-MonthRangeBuilder.md Sets the starting month for the range. ```APIDOC ## begin(begin: number) Sets the starting month for the range. ### Parameters #### Path Parameters - **begin** (number) - Required - The starting month of the range. ``` -------------------------------- ### Instantiate ElasticsearchMovingAverageHoltModelSettingsSettings Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/elasticsearch/builder-ElasticsearchMovingAverageHoltModelSettingsSettings.md Use the constructor to create a new instance of the settings builder. ```python ElasticsearchMovingAverageHoltModelSettingsSettings() ``` -------------------------------- ### from_val Method Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/prometheus/builder-TimeRange.md Sets the start time for the query range. ```APIDOC ## from_val ### Description Sets the start time of the query. ### Method Signature ```python def from_val(from_val: str) -> typing.Self ``` ### Parameters #### Path Parameters - **from_val** (str) - Required - The start time value for the query. ``` -------------------------------- ### Initialize TooltipOptions Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/geomap/builder-TooltipOptions.md Use the constructor to create a new TooltipOptions object. ```python TooltipOptions() ``` -------------------------------- ### VizTooltipOptions Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/common/builder-VizTooltipOptions.md Initializes a new instance of VizTooltipOptions. ```APIDOC ## Constructor ```python VizTooltipOptions() ``` ``` -------------------------------- ### from_val Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/expr/builder-ExprTypeMathTimeRange.md Sets the start time for the time range query. ```APIDOC ## from_val From is the start time of the query. ```python def from_val(from_val: str) -> typing.Self ``` ``` -------------------------------- ### begin Method Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/alerting/builder-WeekdayRange.md Sets the starting day of the week for the range. ```APIDOC ## begin(begin: int) ### Description Sets the starting day of the week for the range. ### Parameters #### Path Parameters - **begin** (int) - Required - The starting day of the week (e.g., 0 for Sunday, 1 for Monday). ### Method ```python def begin(begin: int) -> typing.Self ``` ``` -------------------------------- ### Constructor Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/java/docs/Reference/dashboard/builder-DashboardDashboardTemplatingBuilder.md Initializes a new instance of the DashboardDashboardTemplatingBuilder. ```APIDOC ## Constructor Initializes a new instance of the DashboardDashboardTemplatingBuilder. ### Method ```java new DashboardDashboardTemplatingBuilder() ``` ``` -------------------------------- ### relative_time_range Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/python/docs/Reference/alerting/builder-Query.md Sets the relative start and end time for the query. ```APIDOC ## relative_time_range RelativeTimeRange is the per query start and end time for requests. ```python def relative_time_range(relative_time_range: alerting.RelativeTimeRange) -> typing.Self ``` ``` -------------------------------- ### NewBackgroundConfigBuilder Source: https://github.com/grafana/grafana-foundation-sdk/blob/main/go/docs/Reference/canvas/builder-BackgroundConfigBuilder.md Initializes a new instance of BackgroundConfigBuilder. ```APIDOC ## NewBackgroundConfigBuilder Initializes a new instance of BackgroundConfigBuilder. ### Signature ```go func NewBackgroundConfigBuilder() *BackgroundConfigBuilder ``` ```