i2 Notebook SDK
Search results for

    Show/hide table of contents

    Home > @i2analyze/notebook-sdk > schema

    schema namespace

    The members of the schema namespace provide access to the specifications that govern the structure of records in the i2 Notebook web client. Schemas determine what properties records can contain; place constraints on notes, source identifiers, and source references; and describe the security model that controls access to records.

    Signature:

    export declare namespace schema 
    

    Introduced: version 1.0

    Interfaces

    Interface Description
    IChartEntityType An entity type.
    IChartEntityTypeData A set of data for creating a custom entity type.
    IChartItemTypeBase A set of information that is common to all item types in i2 Notebook.
    IChartItemTypeDataBase A set of data that is common to creating all custom item types.
    IChartLinkType A link type.
    IChartLinkTypeData A set of data for creating a custom link type.
    IChartPropertyLabelPart A part of a label that consists of a property value.
    IChartPropertyType A property type.
    IChartSchema A chart schema, which defines the types of the records and properties that can appear on charts in the i2 Notebook web client.
    IChartSchemaChange A change that has occurred to an i2 Notebook chart schema.
    IItemTypeEditor A set of methods for modifying a custom item type.
    ILiteralLabelPart A part of a label that consists of a literal string.
    INotesSchema A schema for notes, which places constraints on their use.
    IPendingItemType An item type that has been created in a transaction handler, but has not yet been added to a chart's schema.
    IPendingPropertyType A custom property type that has been created in a transaction handler, but has not yet been added to a chart schema.
    IPossibleValue A possible value for a property whose property type has a string-based logical type.
    IPropertyTypeData A set of data for creating a custom property type.
    IPropertyTypeEditor A set of methods for modifying a custom property type.
    IPropertyTypesEditor A set of methods for adding and modifying custom property types on schema and custom item types.
    ISchemaInfo Information about a schema in an i2 Analyze deployment.
    ISecurityDimension A security dimension.
    ISecurityDimensionValue A security dimension value.
    ISecuritySchema A security schema, which defines the available security dimensions and their dimension values.
    ISourceIdentifiersSchema A schema for source identifiers, which places constraints on their use.
    ISourceReferenceSchema A schema for source references, which places constraints on their use.
    ISourceReferenceSelectedFromValueType A type that represents the constraints on a selected-from string value in a source reference.
    ISourceReferenceStringValueType A type that represents the constraints on a single-line string value in a source reference.
    ISourceReferenceSuggestedFromValueType A type that represents the constraints on a suggested-from string value in a source reference.
    IStringLimitedValueType A type that represents the constraints on a string value in a source reference.

    Type Aliases

    Type Alias Description
    AnalyzeItemTypeId An identifier of an item type in the i2 Analyze schema.
    AnalyzePropertyTypeId An identifier of a property type in the i2 Analyze schema.
    ChartItemTypeId An identifier of an item type in a chart schema.
    ChartItemTypeSpecifier A common specifier for a chart item type.
    ChartPropertyTypeId An identifier of a property type in a chart schema.
    CustomLogicalType A logical type for the value of a custom record property.
    IChartItemType An entity type or a link type.
    ILabelPart A part of a label definition.
    ISourceReferenceValueType A type for the value of a field in a source reference.
    ItemTypeSpecifier A common specifier for an item type.
    PropertyTypeSpecifier A common specifier for a chart property type.
    SchemaType The type of a schema.
    SecurityDimensionId An identifier of a security dimension.
    SecurityDimensionValueId The identifier of a security dimension value.
    In this article
    Back to top © N. Harris Computer Corporation