Class AACPage

constructor

• new AACPage(
      __namedParameters: {
          buttons?: AACButton[];
          clone_ids?: string[];
          descriptionHtml?: string;
          grid?: (AACButton | null)[][] | { columns: number; rows: number };
          id: string;
          images?: any[];
          locale?: string;
          name?: string;
          parentId?: string | null;
          scanBlocksConfig?: AACScanBlock[];
          scanningConfig?: ScanningConfig;
          scanType?: AACScanType;
          semantic_ids?: string[];
          sounds?: any[];
          style?: AACStyle;
      },
  ): AACPage

  Parameters

  • __namedParameters: {
        buttons?: AACButton[];
        clone_ids?: string[];
        descriptionHtml?: string;
        grid?: (AACButton | null)[][] | { columns: number; rows: number };
        id: string;
        images?: any[];
        locale?: string;
        name?: string;
        parentId?: string | null;
        scanBlocksConfig?: AACScanBlock[];
        scanningConfig?: ScanningConfig;
        scanType?: AACScanType;
        semantic_ids?: string[];
        sounds?: any[];
        style?: AACStyle;
    }

  Returns AACPage

buttons

Optionalclone_ids

OptionaldescriptionHtml

grid

id

Optionalimages

Optionallocale

name

parentId

OptionalscanBlocksConfig

OptionalscanningConfig

OptionalscanType

Optionalsemantic_ids

Optionalsounds

Optionalstyle

pendingMutations

• get pendingMutations(): readonly AACPageMutation[]

  Get the list of pending mutations for this page (read-only)

  Returns readonly AACPageMutation[]

_loadButton

• _loadButton(button: AACButton): void

  Internal load-path button push: adds a button to the page WITHOUT recording a mutation. Used by processors during loadIntoTree so the loaded baseline isn't treated as user changes. Not part of the public API — consumers should always use addButton.

  Parameters

  • button: AACButton

  Returns void

addButton

• addButton(button: AACButton): void

  Parameters

  • button: AACButton

  Returns void

addWordListItem

• addWordListItem(item: AACWordListItem): void

  Add an item to the page's WordList (for formats with dynamic content cells)

  Parameters

  • item: AACWordListItem

    WordList item to add

  Returns void

clearMutations

• clearMutations(): void

  Discard all recorded mutations on this page. Useful as an escape hatch after loadIntoTree if the consumer wants a clean baseline.

  Returns void

clearWordList

• clearWordList(): void

  Clear all items from the page's WordList

  Returns void

removeButton

• removeButton(buttonId: string): void

  Remove a button by ID

  Parameters

  • buttonId: string

    The ID of the button to remove

  Returns void

removeWordListItem

• removeWordListItem(
      textOrPredicate: string | ((item: AACWordListItem) => boolean),
  ): void

  Remove items from the page's WordList

  Parameters

  • textOrPredicate: string | ((item: AACWordListItem) => boolean)

    Text to match or predicate function to filter items

  Returns void

updateButton

• updateButton(buttonId: string, patch: Partial<AACButton>): void

  Update a button by merging a patch

  Parameters

  • buttonId: string

    The ID of the button to update

  • patch: Partial<AACButton>

    Partial button object with fields to update

  Returns void