Skip to main content

Orbit API surface

The public Go API of Orbit v1.20.1, the version Quantum 1.42.0 certifies: 174 exported symbols in 2 packages. Orbit keeps this list in contracts/baseline/api_exported_symbols.txt. Orbit's CI compares this file with the code on every change and fails when they differ, so adding or removing an exported symbol means changing the file in the same change. Removing an exported symbol is a breaking change, and the suite ships breaking changes only in a major version. This page is generated from that file at the pinned version, so it lists exactly what the check protects.

Each package links to its documentation on pkg.go.dev at this version, where every symbol has its signature and its comment.

PackageTypesFunctionsMethodsFieldsConstants
orbit (module root)2523414
datasource152125812

orbit (module root)​

github.com/jcsvwinston/orbit · 75 symbols · pkg.go.dev

Types

  • ActionDownload
  • ActionField
  • ActionFieldType
  • ActionInput
  • ActionOption
  • ActionPlacement
  • ActionRequest
  • ActionResult
  • Branding
  • Cache
  • ClientCode
  • Config — fields Actions, AuditMaxSize, AuditRetentionDays, AuditStore, AuthDatabase, BootstrapEmail, BootstrapPassword, BootstrapUsername, Branding, Cache, Client, ClusterChannel, ClusterEnabled, ClusterNodeID, ClusterRedisURL, ClusterToken, Dashboards, DataSource, Environment, FieldWidgets, LiveExcludePatterns, Locale, Messages, MigrationsPath, MultiTenantDefault, MultiTenantEnabled, MultiTenantIDs, Pages, Prefix, RowOwnerFields, RowOwnerSubject, Title, TraceURLTemplate, Widgets
  • Dashboard
  • ModelAction
  • Operator
  • Page
  • Palette
  • RecordList
  • Series
  • SeriesValue
  • StatValue
  • TableValue
  • Widget
  • WidgetItem
  • WidgetValue

Functions — Module, OperatorFromContext

Constants — ActionFieldBoolean, ActionFieldDate, ActionFieldNumber, ActionFieldSelect, ActionFieldText, ActionOnRecord, ActionOnSelection, ActionOnSelectionAndRecord, DefaultPrefix, WidgetBar, WidgetLine, WidgetRecords, WidgetStat, WidgetTable

datasource​

github.com/jcsvwinston/orbit/datasource · 99 symbols · pkg.go.dev

Types

  • Choice — fields Label, Value
  • CountResult — fields Count, IsEstimated, Present
  • DataSource interface — methods Store
  • FieldInfo — fields Choices, Column, ForeignModel, GoType, HTMLType, IsExcluded, IsFilter, IsForeignKey, IsList, IsPK, IsReadOnly, IsRequired, IsSearch, IsTenantField, Label, Name
  • Filter — fields Column, Op, Value, Values
  • FilterOp
  • ForeignKey — fields Column, FieldName, ForeignColumn, ForeignModel, ForeignTable
  • Index — fields Columns, Name, Unique
  • ModelInfo — fields DatabaseAlias, Fields, ForeignKeys, Icon, Indexes, Name, Plural, PrimaryKey, ReadOnly, Table, TenantField; methods Field
  • ModelSource interface — methods All, Get
  • OperatorFilterSource interface — methods HonoursFilterOperators
  • Page — fields HasMore, IsEstimated, Items, Page, PageSize, Total, TotalPages
  • Query — fields ExactTotal, Filters, OrderBy, Page, PageSize, Search, Where
  • Record
  • RecordStore interface — methods Count, Create, Delete, Get, List, TableExists, Update

Functions — HonoursFilterOperators, ParseFilterOp

Constants — OpContains, OpEndsWith, OpEqual, OpGreater, OpGreaterEqual, OpIn, OpIsNull, OpLess, OpLessEqual, OpNotEqual, OpNotIn, OpStartsWith