Member Junction
    Preparing search index...

    Class ViewPropertiesEditorComponent

    The Properties panel of the view designer: add, edit and remove a view's declared properties (name, type, description, default as a fixed value or a token with an offset, required, allow override, target field and operator). Edits are immutable: every change emits a new list through PropertiesChange, so [(Properties)] works.

    Index

    Constructors

    constructor

    Properties

    Disabled Entity OffsetUnits Properties PropertiesChange Tokens Types

    Accessors

    FieldOptions Problems

    Methods

    AddProperty DefaultMode DefaultText OperatorsFor RemoveProperty SetDefaultMode SetDefaultValue SetField SetOffset SetOperator SetToken SetType TakesOffset Update

    Constructors

    Properties

    Disabled: boolean = false

    True when the user cannot edit the view.

    Entity: EntityInfo | null = null

    The view's entity: its fields are the targets a property can filter.

    OffsetUnits: readonly ["day", "week", "month", "quarter", "year"] = PROPERTY_OFFSET_UNITS
    Properties: UserViewProperty[] = []

    The properties being edited.

    PropertiesChange: EventEmitter<UserViewProperty[]> = ...
    Tokens: readonly [
        "Context.UserID",
        "Context.UserEmail",
        "Context.UserName",
        "Context.Now",
        "Context.Today",
        "Context.StartOfWeek",
        "Context.StartOfMonth",
        "Context.StartOfQuarter",
        "Context.StartOfYear",
    ] = CONTEXT_TOKENS
    Types: readonly ["string", "number", "boolean", "date", "uuid"] = PROPERTY_VALUE_TYPES

    Accessors

    Methods

    • A user token takes no offset, so choosing one drops it.

      Parameters

      • index: number
      • token:
            | "Context.UserID"
            | "Context.UserEmail"
            | "Context.UserName"
            | "Context.Now"
            | "Context.Today"
            | "Context.StartOfWeek"
            | "Context.StartOfMonth"
            | "Context.StartOfQuarter"
            | "Context.StartOfYear"

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods