Theia API Documentation v1.65.0
    Preparing search index...

    Interface PreferenceDataProperty

    extended JSON schema

    interface PreferenceDataProperty {
        $comment?: string;
        $id?: string;
        $ref?: string;
        $schema?: string;
        additionalItems?: boolean | IJSONSchema;
        additionalProperties?: boolean | IJSONSchema;
        allOf?: IJSONSchema[];
        allowComments?: boolean;
        allowTrailingCommas?: boolean;
        anyOf?: IJSONSchema[];
        const?: JSONValue;
        contains?: IJSONSchema;
        default?: JSONValue;
        defaultSnippets?: IJSONSchemaSnippet[];
        definitions?: IJSONSchemaMap;
        dependencies?: IJSONSchemaMap | { [prop: string]: string[] };
        deprecationMessage?: string;
        description?: string;
        doNotSuggest?: boolean;
        else?: IJSONSchema;
        enum?: JSONValue[];
        enumDescriptions?: string[];
        enumItemLabels?: string[];
        errorMessage?: string;
        exclusiveMaximum?: number | boolean;
        exclusiveMinimum?: number | boolean;
        format?: string;
        group?: string;
        hidden?: boolean;
        id?: string;
        if?: IJSONSchema;
        included?: boolean;
        items?: IJSONSchema | IJSONSchema[];
        markdownDeprecationMessage?: string;
        markdownDescription?: string;
        markdownEnumDescriptions?: string[];
        maximum?: number;
        maxItems?: number;
        maxLength?: number;
        maxProperties?: number;
        minimum?: number;
        minItems?: number;
        minLength?: number;
        minProperties?: number;
        multipleOf?: number;
        not?: IJSONSchema;
        oneOf?: IJSONSchema[];
        overridable?: boolean;
        owner?: string;
        pattern?: string;
        patternErrorMessage?: string;
        patternProperties?: IJSONSchemaMap;
        prefixItems?: IJSONSchema[];
        properties?: IJSONSchemaMap;
        propertyNames?: IJSONSchema;
        required?: string[];
        scope?: PreferenceScope;
        tags?: string[];
        then?: IJSONSchema;
        title?: string;
        type?: JsonType | JsonType[];
        typeDetails?: any;
        uniqueItems?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $comment? $id? $ref? $schema? additionalItems? additionalProperties? allOf? allowComments? allowTrailingCommas? anyOf? const? contains? default? defaultSnippets? definitions? dependencies? deprecationMessage? description? doNotSuggest? else? enum? enumDescriptions? enumItemLabels? errorMessage? exclusiveMaximum? exclusiveMinimum? format? group? hidden? id? if? included? items? markdownDeprecationMessage? markdownDescription? markdownEnumDescriptions? maximum? maxItems? maxLength? maxProperties? minimum? minItems? minLength? minProperties? multipleOf? not? oneOf? overridable? owner? pattern? patternErrorMessage? patternProperties? prefixItems? properties? propertyNames? required? scope? tags? then? title? type? typeDetails? uniqueItems?

    Properties

    $comment?: string

    schema draft 07

    $id?: string
    $ref?: string
    $schema?: string
    additionalItems?: boolean | IJSONSchema
    additionalProperties?: boolean | IJSONSchema
    allOf?: IJSONSchema[]
    allowComments?: boolean
    allowTrailingCommas?: boolean
    anyOf?: IJSONSchema[]
    const?: JSONValue

    schema draft 06

    contains?: IJSONSchema
    default?: JSONValue
    defaultSnippets?: IJSONSchemaSnippet[]

    VSCode extensions

    definitions?: IJSONSchemaMap
    dependencies?: IJSONSchemaMap | { [prop: string]: string[] }
    deprecationMessage?: string
    description?: string
    doNotSuggest?: boolean
    else?: IJSONSchema
    enum?: JSONValue[]
    enumDescriptions?: string[]
    enumItemLabels?: string[]
    errorMessage?: string
    exclusiveMaximum?: number | boolean
    exclusiveMinimum?: number | boolean
    format?: string
    group?: string
    hidden?: boolean

    If true, this item will registered as part of the preference schema, but hidden in the preference editor UI.

    id?: string
    if?: IJSONSchema
    included?: boolean

    If false, the preference will not be included in the schema or the UI. E.g. OS-Specific prefs

    items?: IJSONSchema | IJSONSchema[]
    markdownDeprecationMessage?: string
    markdownDescription?: string
    markdownEnumDescriptions?: string[]
    maximum?: number
    maxItems?: number
    maxLength?: number
    maxProperties?: number
    minimum?: number
    minItems?: number
    minLength?: number
    minProperties?: number
    multipleOf?: number
    not?: IJSONSchema
    oneOf?: IJSONSchema[]
    overridable?: boolean

    Whether distinct values can be defined for language override identifers. E.g. values valid when editing typescript files vs. when editing Java files

    owner?: string
    pattern?: string
    patternErrorMessage?: string
    patternProperties?: IJSONSchemaMap
    prefixItems?: IJSONSchema[]
    properties?: IJSONSchemaMap
    propertyNames?: IJSONSchema
    required?: string[]
    scope?: PreferenceScope

    The maximum scope where values for this property can be set.

    tags?: string[]

    Tags can be searched for in the UI

    then?: IJSONSchema
    title?: string
    type?: JsonType | JsonType[]
    typeDetails?: any

    Metadata intended for custom renderers

    uniqueItems?: boolean

    Settings

    Member Visibility

    On This Page

    Properties