RevGrid - v0.9.3
    Preparing search index...

    Interface RevGridOptions<BGS, BCS, SF>

    interface RevGridOptions<
        BGS extends RevBehavioredGridSettings,
        BCS extends RevBehavioredColumnSettings,
        SF extends RevSchemaField,
    > {
        canvasOverflowOverride?: Overflow;
        canvasRenderingContext2DSettings?: CanvasRenderingContext2DSettings;
        customUiControllerDefinitions?: RevUiController.Definition<BGS, BCS, SF>[];
        externalParent?: unknown;
        firstGeneratedIdFromBaseIsAlsoNumbered?: boolean;
        id?: string;
    }

    Type Parameters

    Index

    Properties

    canvasOverflowOverride?: Overflow

    Normally the canvas HTML element created by Revgrid on which to draw the grid has its overflow property set to clip. However it may be helpful to set its overflow property to visible when debugging painters. canvasOverflowOverride can be used to override the default value of this property.

    canvasRenderingContext2DSettings?: CanvasRenderingContext2DSettings

    Set alpha to false to speed up rendering if no colors use alpha channel

    customUiControllerDefinitions?: RevUiController.Definition<BGS, BCS, SF>[]
    externalParent?: unknown

    Optional link to Revgrid instance's parent Javascript object. Is used to set externalParent which is not used within Revgrid however may be helpful with debugging

    firstGeneratedIdFromBaseIsAlsoNumbered?: boolean

    Internally generated ids are numbered using the host HTML element's id as a base and suffixing it with a number. Normally the first id generated from a host element base Id is not numbered. Subsequent ids generated from that base id are suffixed with numbers beginning with 2. This works well if host elements all have different Ids (so there suffices are not used). However If host elements have the same id or no id, then it may be better for all internally generated ids to be suffixed with a number (starting from 1). Set firstGeneratedIdFromBaseIsAlsoNumbered to true to suffix all internally generated ids.

    id?: string

    Used to distinguish between Revgrid instances in an application. If undefined, will generate an id from host element