@anypoint-web-components/anypoint-selector/src/AnypointSelection.d.ts

Port of iron-selector that works with ES6 classes. Manages a list of elements that can be selected.

/**
 * Port of `@polymer/iron-selector/iron-selection.js`.
 */
export declare class AnypointSelection {
  multi: boolean;
  selection: any[];
  selectCallback: Function;
  
  constructor(selectCallback: Function);

  /**
   * Retrieves the selected item(s).
   *
   * @returns Returns the selected item(s). If the multi property is true,
   * `get` will return an array, otherwise it will return
   * the selected item or undefined if there is no selection.
   */
  get(): any;

  /**
   * Clears all the selection except the ones indicated.
   *
   * @param excludes items to be excluded.
   */
  clear(excludes?: any[]): void;

  /**
   * Indicates if a given item is selected.
   *
   * @param item The item whose selection state should be checked.
   * @returns Returns true if `item` is selected.
   */
  isSelected(item: any): boolean;

  /**
   * Sets the selection state for a given item to either selected or deselected.
   *
   * @param item The item to select.
   * @param isSelected True for selected, false for deselected.
   */
  setItemSelected(item: any, isSelected: boolean): void;

  /**
   * Sets the selection state for a given item. If the `multi` property
   * is true, then the selected state of `item` will be toggled; otherwise
   * the `item` will be selected.
   *
   * @param item The item to select.
   */
  select(item: any): void;

  /**
   * Toggles the selection state for `item`.
   *
   * @param item The item to toggle.
   */
  toggle(item: any): void;
}