Object
Represents a clickable region or location on an Artboard. Objects can be either a spot (single point) or a polygon (region). They can trigger actions, open links, run scripts, or change artboards.
Schema
| Name | Type | Description | Default |
|---|---|---|---|
| id | string | A unique identifier for the object. | — |
| name | string | A human-readable name for the object. | Untitled Object |
| type | "spot""poly" | Geometry type of the object: a single spot or a polygon. | — |
| interactive | boolean | If true, the object can be interacted with (clicked, hovered, etc.). | true |
| click_action | "none""follow-link""change-artboard" | Defines the action when the object is clicked. | none |
| open_link_in_new_tab | boolean | If click_action is follow-link, determines whether the link opens in a new tab. | false |
| click_action_url | string | URL to open if click_action = follow-link. | — |
| click_action_artboard_id | string | Target Artboard ID if click_action = change-artboard. | — |
| x | number | X coordinate of the object (used for spot type). | 0 |
| y | number | Y coordinate of the object (used for spot type). | 0 |
| coords | { x: number, y: number } [] | List of coordinates defining the polygon (for poly type). | |
| radius | number | Radius of the spot object (in pixels). | 20 |
| pin | boolean | If true, display as a pin (bottom aligned); if false, display as a centered spot. | true |
| color | string | Fill color of the object. | #000000 |
| opacity | number | Opacity of the object. | 1 |
| stroke_color | string | Border (stroke) color. | #000000 |
| stroke_width | number | Border (stroke) width. | 0 |
| stroke_opacity | number | Opacity of the border (stroke). | 1 |
| hover_color | string | Fill color on hover. | #000000 |
| hover_opacity | number | Opacity on hover. | 0.5 |
| hover_stroke_color | string | Border color on hover. | #000000 |
| hover_stroke_width | number | Border width on hover. | 0 |
| hover_stroke_opacity | number | Border opacity on hover. | 1 |
| blend_mode | "inherit""normal""add""multiply""screen""darken""lighten""erase""color-dodge""color-burn""linear-burn""linear-dodge""linear-light""hard-light""soft-light""pin-light""difference""exclusion""overlay""saturation""color""luminosity""normal-npm""add-npm""screen-npm""none""subtract""divide""vivid-light""hard-mix""negation""min""max" | Blend mode applied when rendering the object. | normal |