# squirrel-helper-library

- [Dot notation](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/dot-notation.md)
- [Angular](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular.md)
- [Classes](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/classes.md)
- [SquirrelCanvas](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/classes/squirrelcanvas.md): Used to reflect the x and y position of the component on the Squirrel canvas.
- [SquirrelColor](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/classes/squirrelcolor.md): Used to reflect the x and y position of the component on the Squirrel canvas.
- [SquirrelMessage](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/classes/squirrelmessage.md): Used for communication to and from Squirrel
- [SquirrelPosition](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/classes/squirrelposition.md): Used to reflect the x and y position of the component on the Squirrel canvas.
- [SquirrelSize](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/classes/squirrelsize.md): Used to receive height and width information from Squirrel. This could be used for component size as well as binding size.
- [Events](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/events.md)
- [onInitState](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/events/oninitstate.md): onInitState(state: any): void
- [onPropertyChange](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/events/onpropertychange.md): onPropertyChange(property: string, value: any): void
- [onPropertyChangesComplete](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/events/onpropertychangescomplete.md): onPropertyChangesComplete(): void
- [onSetCanvas](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/events/onsetcanvas.md): onSetCanvas(canvas: SquirrelCanvas): void
- [onSetPosition](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/events/onsetposition.md): onSetSize(size: SquirrelSize): void
- [onSetRuntimeMode](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/events/onsetruntimemode.md): onSetRuntimeMode(mode: string): void
- [onSetSize](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/events/onsetsize.md): onSetSize(size: SquirrelSize): void
- [Getting Started](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/getting-started.md)
- [Building your first addon](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/getting-started/building-your-first-addon.md)
- [Debugging](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/getting-started/debugging.md)
- [Sending and Receiving Data](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/getting-started/sending-and-receiving-data.md)
- [The JSON files](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/getting-started/the-json-files.md)
- [Methods](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods.md)
- [getBindingDimension](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/getbindingdimension.md): getBindingDimension(property: string): SquirrelSize
- [getCanvas](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/getcanvas.md): getCanvas(): SquirrelCanvas
- [getCopyOfState](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/getcopyofstate.md): getCopyOfState(): any
- [getGenericProperty](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/getgenericproperty.md): getGenericProperty(property: string): string
- [getPosition](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/getposition.md): getPosition(): SquirrelPosition
- [getRuntimeMode](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/getruntimemode.md): getRuntimeMode(): string
- [getSize](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/getsize.md): getSize(): SquirrelSize
- [initWithSquirrel](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/initwithsquirrel.md): initWithSquirrel();
- [parseColor](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/parsecolor.md): parseColor(color: any, alpha = 1, outputHex = false): string
- [sendToSquirrel](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/sendtosquirrel.md): sendToSquirrel(property: string, value: any, padData = true): void
- [setPosition](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/setposition.md): setPosition(position: SquirrelPosition)
- [setSize](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/setsize.md): setSize(size: SquirrelSize)
- [shadeColor](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/shadecolor.md): shadeColor(color: any, alpha = 1): string
- [tintColor](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/angular/methods/tintcolor.md): tintColor(color: any, alpha = 1): string
- [JavaScript](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript.md)
- [Classes](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/classes.md)
- [SquirrelCanvas](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/classes/squirrelcanvas.md): Used to reflect the x and y position of the component on the Squirrel canvas.
- [SquirrelColor](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/classes/squirrelcolor.md): Used to reflect the x and y position of the component on the Squirrel canvas.
- [SquirrelMessage](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/classes/squirrelmessage.md): Used for communication to and from Squirrel
- [SquirrelPosition](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/classes/squirrelposition.md): Used to reflect the x and y position of the component on the Squirrel canvas.
- [SquirrelSize](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/classes/squirrelsize.md): Used to receive height and width information from Squirrel. This could be used for component size as well as binding size.
- [Events](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/events.md)
- [onInitState](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/events/oninitstate.md): onInitState(e)
- [onPropertyChange](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/events/onpropertychange.md): onPropertyChange(property: string, value: any): void
- [onPropertyChangesComplete](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/events/onpropertychangescomplete.md): onPropertyChangesComplete()
- [onSetCanvas](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/events/onsetcanvas.md): onSetCanvas(e)
- [onSetPosition](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/events/onsetposition.md): onSetSize(e)
- [onSetRuntimeMode](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/events/onsetruntimemode.md): onSetRuntimeMode(e)
- [onSetSize](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/events/onsetsize.md): onSetSize(e)
- [Getting Started](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/getting-started.md)
- [Building your first add-on](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/getting-started/building-your-first-add-on.md)
- [Debugging](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/getting-started/debugging.md)
- [Sending and Receiving Data](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/getting-started/sending-and-receiving-data.md)
- [The JSON files](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/getting-started/the-json-files.md)
- [Methods](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods.md)
- [getBindingDimension](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/getbindingdimension.md): getBindingDimension(property: string): SquirrelSize
- [getCanvas](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/getcanvas.md): getCanvas()
- [getCopyOfState](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/getcopyofstate.md): getCopyOfState()
- [getGenericProperty](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/getgenericproperty.md): getGenericProperty(property)
- [getPosition](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/getposition.md): getPosition(): SquirrelPosition
- [getRuntimeMode](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/getruntimemode.md): getRuntimeMode()
- [getSize](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/getsize.md): getSize(): SquirrelSize
- [initWithSquirrel](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/initwithsquirrel.md): initWithSquirrel();
- [parseColor](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/parsecolor.md): parseColor(color: any, alpha = 1, outputHex = false): string
- [sendToSquirrel](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/sendtosquirrel.md): sendToSquirrel(property: string, value: any, padData = true): void
- [setPosition](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/setposition.md): setPosition(x,y)
- [setSize](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/setsize.md): setSize(width, height)
- [shadeColor](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/shadecolor.md): shadeColor(color: any, alpha = 1): string
- [tintColor](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/javascript/methods/tintcolor.md): tintColor(color: any, alpha = 1): string
- [React](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/react.md)
- [Coming Soon](https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library/react/coming-soon.md)


---

# Agent Instructions: 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:

```
GET https://learn.squirrel365.io/squirrel-addon-documentation/squirrel-helper-library.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.