type

View

View is a read-only snapshot of a canonical immutable node. Its readers detach mutable values; author fields through their concrete fluent facades.

Full signature

type View struct{ nodeData }

Source field/field.go:256

Methods

  • View.AccessPolicy()

    AccessPolicy returns the immutable function group; closure captures remain author-owned.

  • View.AdminComponent()

    AdminComponent returns the optional statically registered admin plugin renderer selected for this field. The returned configuration is detached from the immutable definition.

  • View.AdminPolicy()

    AdminPolicy returns a detached complete presentation policy draft.

  • View.BehaviorSummary()

    BehaviorSummary describes the attached policies without exposing function addresses.

  • View.BlockReferences()

    BlockReferences returns the declared registry slugs, never expanded definitions.

  • View.Blocks()

    Blocks returns a deep copy of the allowed block types.

  • View.Boundary()

    Boundary reports a node's value/traversal semantics, not just its broad kind.

  • View.Branches()

    Branches exposes only schema-owned children, including published embedded payload cases. Arbitrary plugin JSON is never interpreted as fields.

  • View.Category()

    Category returns the behavioral category for the definition's field kind.

  • View.CodeLanguage()

    CodeLanguage is the editor language hint for a code field.

  • View.Columns()

    Columns returns the requested one-to-twelve-column admin grid width, or zero.

  • View.DateFormat()

    DateFormat returns the accepted date value format, defaulting to DateOnly.

  • View.Default()

    Default returns the configured typed literal default. List defaults use canonical JSON arrays. Dynamic defaults are executable policies and are not evaluated by this reader.

  • View.Description()

    Description returns the configured author-facing supporting text.

  • View.DescriptionTranslations()

    DescriptionTranslations returns localized supporting text by admin language.

  • View.Editor()

    Editor returns a detached application editor selection.

  • View.EmbeddedTrees()

    EmbeddedTrees returns detached declarative embedded schema definitions.

  • View.Fields()

    Fields returns a deep copy of the nested child definitions.

  • View.HasBehavior()

    HasBehavior identifies executable policies owned by this field.

  • View.Hidden()

    Hidden reports whether the admin should omit this field from presentation.

  • View.Index()

    Index reports whether the field should have a non-unique database index. Unique fields already receive a unique index even when this is false.

  • View.InitiallyCollapsed()

    InitiallyCollapsed reports whether a collapsible presentation group starts closed.

  • View.IsNamedTab()

    IsNamedTab distinguishes a stored object with tab presentation from layout.

  • View.Issues()

    Issues validates the current declaration without executing behavior.

  • View.IsUnnamedTab()

    IsUnnamedTab distinguishes a single presentation section from a tab group.

  • View.JoinAllowCreate()

    JoinAllowCreate reports whether the admin may offer inline target creation.

  • View.JoinCollection()

    JoinCollection is the collection queried by an inverse join.

  • View.JoinDefaultColumns()

    JoinDefaultColumns returns the target fields shown by the inverse-join table.

  • View.JoinDefaultSort()

    JoinDefaultSort returns the target sort expression, including an optional descending prefix.

  • View.JoinLimit()

    JoinLimit is the maximum related documents returned for an inverse join.

  • View.JoinOn()

    JoinOn is the target relationship path matched against the source document ID.

  • View.Kind()

    Kind returns the concrete authoring field kind.

  • View.Label()

    Label returns the explicit author-facing label, if one was configured.

  • View.LabelTranslations()

    LabelTranslations returns localized author-facing labels by admin language.

  • View.Localized()

    Localized reports whether the field stores an independent value for each configured application locale.

  • View.LocalRowLabel()

    LocalRowLabel returns a detached application row heading selection.

  • View.Max()

    Max returns the inclusive maximum accepted by a number field.

  • View.MaxLength()

    MaxLength returns the maximum accepted Unicode code-point length.

  • View.MaxRows()

    MaxRows is the maximum accepted length for an array or blocks list, or zero when unbounded.

  • View.Min()

    Min returns the inclusive minimum accepted by a number field.

  • View.MinLength()

    MinLength returns the minimum accepted Unicode code-point length.

  • View.MinRows()

    MinRows is the minimum accepted length for an array or blocks list.

  • View.Name()

    Name returns the document property name authored for the field.

  • View.Options()

    Options returns a copy of the select options.

  • View.Placeholder()

    Placeholder returns the canonical empty-state prompt for compatible admin controls.

  • View.PlaceholderTranslations()

    PlaceholderTranslations returns localized placeholder text by admin language.

  • View.PluginConfig()

    PluginConfig returns a copy of the plugin-owned serialized configuration.

  • View.PluginKey()

    PluginKey returns the compiled plugin responsible for a custom field.

  • View.PluginReferenceKeys()

    PluginReferenceKeys returns JSON property names whose string values contain public collection slugs and therefore participate in content renames and persisted reference-shape migration safety.

  • View.Private()

    Private returns immutable finite owner metadata, never manifest content.

  • View.Provenance()

    Provenance returns declaration/transform sources for diagnostics.

  • View.ReadOnly()

    ReadOnly reports whether the admin should prevent editing this field.

  • View.ReferenceDeleteAction()

    ReferenceDeleteAction returns the explicitly authored hard-delete policy. An empty action means config resolution must apply the deterministic default for the reference shape.

  • View.RelationshipFilters()

    RelationshipFilters returns configured multi-rule and polymorphic option filters.

  • View.RelationshipHasMany()

    RelationshipHasMany reports whether the field stores multiple references.

  • View.RelationshipTarget()

    RelationshipTarget returns the first configured target slug, or an empty string.

  • View.RelationshipTargets()

    RelationshipTargets returns a copy of all configured target slugs.

  • View.Required()

    Required reports whether validation rejects a missing, null, or field-type-specific empty value.

  • View.RowLabel()

    RowLabel is the child property used to label array rows in the admin.

  • View.RowLabelComponent()

    RowLabelComponent returns the optional statically registered admin plugin component selected for array or blocks row headings. The returned configuration is detached from the immutable definition.

  • View.RowLabels()

    RowLabels returns optional singular and plural author-facing array row names.

  • View.SelectDefaults()

    SelectDefaults returns the configured literal default options for a multi-select. Dynamic defaults are executable policies and are not evaluated by this reader.

  • View.SelectHasMany()

    SelectHasMany reports whether a select stores an ordered list of options.

  • View.Sidebar()

    Sidebar reports whether a root field belongs in the document editor's right rail.

  • View.SlugSource()

    SlugSource returns the source field path for a text-backed slug helper. The boolean distinguishes an invalid empty source from an ordinary text field.

  • View.Step()

    Step returns the positive admin input increment for a number field. It is presentation metadata and does not impose divisibility validation.

  • View.Tab()

    Tab returns the named admin form tab, or an empty string.

  • View.TabTranslations()

    TabTranslations returns localized direct-tab labels by admin language.

  • View.Unique()

    Unique reports whether values must be distinct within the collection.

  • View.ValueType()

    ValueType is the declared output contract for a virtual field.