Getting Started

Getting Started Creating your first Fyne app Run Fyne Demo Application and RunLoop Updating Content in your GUI Window Handling Using Goroutines Testing Graphical Apps Packaging for Desktop Mobile Packaging Run in a Browser App Metadata Distributing to App Stores Compiling for different platforms

Exploring Fyne

Canvas and CanvasObject Container and Layouts Widget List Layout List Dialog List Theme Icons Adding Shortcuts to an App Using the Preferences API Adding app translations System Tray Menu Data Binding Migrations Compile Options

Drawing and Animation

Rectangle Text Line Circle Image Raster Gradient Animation

Containers and Layout

Box Grid Grid Wrap Border Form Center Stack AppTabs

Widgets

Label Button Entry Choices Form ProgressBar Toolbar

Collections

List Table Tree

Data Binding

Data Binding Binding Simple Widgets Two-Way Binding Data Conversion List Data

Extending Fyne

Building a Custom Layout Writing a Custom Widget Bundling resources Creating a Custom Theme Extending Widgets Numerical Entry

Architecture

Geometry Scaling Widgets Organisation and Packages

Frequently Asked Questions

Layout and Widget Size Theme and Customisation Troubleshooting

API Documentation

Upgrade to v2.6 Fyne API v2.6

package fyne Animation AnimationCurve App AppMetadata BuildType Canvas CanvasObject Clipboard CloudProvider CloudProviderPreferences CloudProviderStorage Container Delta Device DeviceOrientation Disableable DoubleTappable DragEvent Draggable Driver Focusable HardwareKey KeyboardShortcut KeyEvent KeyModifier KeyName Layout LegacyTheme Lifecycle ListableURI Locale MainMenu Menu MenuItem Notification OverlayStack PointEvent Position Preferences Resource Scrollable ScrollDirection ScrollEvent SecondaryTappable Settings Shortcut Shortcutable ShortcutCopy ShortcutCut ShortcutHandler ShortcutPaste ShortcutRedo ShortcutSelectAll ShortcutUndo Size StaticResource Storage StringValidator Tabbable Tappable TextAlign TextStyle TextTruncation TextWrap Theme ThemeColorName ThemedResource ThemeIconName ThemeSizeName ThemeVariant URI URIReadCloser URIWithIcon URIWriteCloser Validatable Vector2 Widget WidgetRenderer Window

app canvas container data/binding data/validation dialog driver driver/desktop driver/mobile driver/software lang layout storage storage/repository test theme widget

List My App

Fyne API "fyne.Canvas"

fyne.Canvas

import "fyne.io/fyne/v2"

Usage

type Canvas

type Canvas interface {
	Content() CanvasObject
	SetContent(CanvasObject)

	Refresh(CanvasObject)

	// Focus makes the provided item focused.
	// The item has to be added to the contents of the canvas before calling this.
	Focus(Focusable)
	// FocusNext focuses the next focusable item.
	// If no item is currently focused, the first focusable item is focused.
	// If the last focusable item is currently focused, the first focusable item is focused.
	//
	// Since: 2.0
	FocusNext()
	// FocusPrevious focuses the previous focusable item.
	// If no item is currently focused, the last focusable item is focused.
	// If the first focusable item is currently focused, the last focusable item is focused.
	//
	// Since: 2.0
	FocusPrevious()
	Unfocus()
	Focused() Focusable

	// Size returns the current size of this canvas
	Size() Size
	// Scale returns the current scale (multiplication factor) this canvas uses to render
	// The pixel size of a [CanvasObject] can be found by multiplying by this value.
	Scale() float32

	// Overlays returns the overlay stack.
	Overlays() OverlayStack

	OnTypedRune() func(rune)
	SetOnTypedRune(func(rune))
	OnTypedKey() func(*KeyEvent)
	SetOnTypedKey(func(*KeyEvent))
	AddShortcut(shortcut Shortcut, handler func(shortcut Shortcut))
	RemoveShortcut(shortcut Shortcut)

	Capture() image.Image

	// PixelCoordinateForPosition returns the x and y pixel coordinate for a given position on this canvas.
	// This can be used to find absolute pixel positions or pixel offsets relative to an object top left.
	PixelCoordinateForPosition(Position) (int, int)

	// InteractiveArea returns the position and size of the central interactive area.
	// Operating system elements may overlap the portions outside this area and widgets should avoid being outside.
	//
	// Since: 1.4
	InteractiveArea() (Position, Size)
}

Canvas defines a graphical canvas to which a [CanvasObject] or Container can be added. Each canvas has a scale which is automatically applied during the render process.

Improve this page