> For the complete documentation index, see [llms.txt](https://learn.squirrel365.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/events/oninitstate.md).

# onInitState

```typescript
override onInitState(state: any): void {
    super.onInitState(state);
}
```

This is the end of the initialisation handshake with Squirrel.  The initState event contains the following properties

1. a copy of state
2. the size of the component
3. the position of the component on the Squirrel canvas
4. the size and colour of the Squirrel canvas
   * introduced in release 1.12.x
5. the runtime mode (i.e. whether Squirrel is in Design, Debug, Preview or live)
   * introduced in release 1.12.x

You can get a copy of these properties by calling their corresponding get method

1. [getCopyOfState()](/squirrel-addon-documentation/squirrel-helper-library/angular/methods/getcopyofstate.md)
2. [getSize()](/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/getsize.md)
3. [getPosition()](/squirrel-addon-documentation/squirrel-helper-library/angular/methods/getposition.md)
4. [getCanvas()](/squirrel-addon-documentation/squirrel-helper-library/angular/methods/getcanvas.md)
5. [getRuntimeMode()](/squirrel-addon-documentation/squirrel-helper-library/angular/methods/getruntimemode.md)

If you super the base class onInitState method then it will add debug logs to your output

<br>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/events/oninitstate.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
