TomTom Maps for JavaScript
    Preparing search index...

    Type Alias CleanEventStateOptions

    CleanEventStateOptions: ByIdOrIndex & { show?: boolean }

    Parameters to clean the event state from a specific feature.

    Removes event states from a feature, returning it to its normal appearance. Useful for deselecting or unhighlighting features programmatically.

    Type Declaration

    • Optionalshow?: boolean

      Whether to show the feature after cleaning the event state.

      Set to false only if you want to keep manipulating features before showing them, which can improve performance for batch updates.

      true
      
    // Remove all event states from a feature
    const options: CleanEventStateOptions = {
    index: 0,
    show: true
    };

    // Clean without immediately rendering
    const batchOptions: CleanEventStateOptions = {
    index: 5,
    show: false
    };