view

package
v0.1.19 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 24, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Capabilities

type Capabilities struct {
	Show       bool `json:"show,omitempty" yaml:"show,omitempty"`
	Inspect    bool `json:"inspect,omitempty" yaml:"inspect,omitempty"`
	Datasource bool `json:"datasource,omitempty" yaml:"datasource,omitempty"`
}

type Parameter

type Parameter struct {
	Name     string `json:"name" yaml:"name"`
	Type     string `json:"type,omitempty" yaml:"type,omitempty"`
	Required bool   `json:"required,omitempty" yaml:"required,omitempty"`
	BindTo   string `json:"bindTo,omitempty" yaml:"bindTo,omitempty"`
}

type ReportPreset added in v0.1.17

type ReportPreset struct {
	ID          string `json:"id" yaml:"id"`
	Label       string `json:"label" yaml:"label"`
	Description string `json:"description,omitempty" yaml:"description,omitempty"`
}

ReportPreset describes a built-in, read-only report starter exposed by a view.

type ReportPresetResolution added in v0.1.19

type ReportPresetResolution struct {
	Requested  string `json:"requested"`
	ResolvedID string `json:"resolvedId"`
	MatchedBy  string `json:"matchedBy"`
}

ReportPresetResolution describes how a requested report starter was resolved to the canonical ID sent to the view.

type Spec

type Spec struct {
	ID                 string         `json:"id" yaml:"id"`
	Title              string         `json:"title,omitempty" yaml:"title,omitempty"`
	Description        string         `json:"description,omitempty" yaml:"description,omitempty"`
	WindowKey          string         `json:"windowKey" yaml:"windowKey"`
	Presentation       string         `json:"presentation,omitempty" yaml:"presentation,omitempty"`
	Region             string         `json:"region,omitempty" yaml:"region,omitempty"`
	OpenMode           string         `json:"openMode,omitempty" yaml:"openMode,omitempty"`
	IdentityScope      string         `json:"identityScope,omitempty" yaml:"identityScope,omitempty"`
	WorkspaceSharePct  int            `json:"workspaceSharePct,omitempty" yaml:"workspaceSharePct,omitempty"`
	WorkspaceMinHeight int            `json:"workspaceMinHeight,omitempty" yaml:"workspaceMinHeight,omitempty"`
	ReportBuilderRef   string         `json:"reportBuilderRef,omitempty" yaml:"reportBuilderRef,omitempty"`
	Parameters         []Parameter    `json:"parameters,omitempty" yaml:"parameters,omitempty"`
	ReportPresets      []ReportPreset `json:"reportPresets,omitempty" yaml:"reportPresets,omitempty"`
	Capabilities       Capabilities   `json:"capabilities,omitempty" yaml:"capabilities,omitempty"`
}

Spec is a workspace-defined dynamic UI view descriptor. It does not duplicate the Forge Window payload; it points to an existing windowKey and adds model-facing metadata for routing.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL