Leader
A SceneObject whose data is { "type": "leader", …LeaderRecord } — the tag plus every field of LeaderRecord.
LeaderRecord
Used by: CellType, PieceData, RenderCell.
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { LeaderEntity } from "./LeaderEntity.js";
export type LeaderRecord = {
/**
* geometry — the leader entities.
*/
leaders: Array<LeaderEntity>, };| field | type | optional | class | doc |
|---|---|---|---|---|
leaders | Array<LeaderEntity> | no | geometry | geometry — the leader entities. |
LeaderEntity
Used by: LeaderRecord.
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { LeaderStyle } from "./LeaderStyle.js";
export type LeaderEntity = {
/**
* geometry — the points the leader points at, mm.
*/
targets: [number, number, number][],
/**
* geometry — the point the leader lines meet, mm.
*/
landing: [number, number, number],
/**
* intent — embedded leader style.
*/
style?: LeaderStyle,
/**
* intent — the note written at the landing.
*/
text?: string,
/**
* intent — free-form record data.
*/
attributes?: Record<string, unknown>, };| field | type | optional | class | doc |
|---|---|---|---|---|
targets | [number, number, number][] | no | geometry | geometry — the points the leader points at, mm. |
landing | [number, number, number] | no | geometry | geometry — the point the leader lines meet, mm. |
style | LeaderStyle | yes | intent | intent — embedded leader style. |
text | string | yes | intent | intent — the note written at the landing. |
attributes | Record<string, unknown> | yes | intent | intent — free-form record data. |
LeaderStyle
leader — measures nothing, so no decimals/rounding/suffix.
Used by: LeaderEntity.
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
import type { EndpointStyle } from "./EndpointStyle.js";
/**
* `leader` — measures nothing, so no decimals/rounding/suffix.
*/
export type LeaderStyle = {
/**
* intent — text size in points on screen (SketchUp's dimension font
* size); the text keeps that size at any zoom.
*/
fontSize?: number,
/**
* intent — how each end of the mark is drawn (SketchUp's dimension
* endpoint).
*/
endpoint?: EndpointStyle,
/**
* intent — endpoint length in points on screen; kept at any zoom.
*/
endpointSize?: number, };| field | type | optional | class | doc |
|---|---|---|---|---|
fontSize | number | yes | intent | intent — text size in points on screen (SketchUp's dimension font size); the text keeps that size at any zoom. |
endpoint | EndpointStyle | yes | intent | intent — how each end of the mark is drawn (SketchUp's dimension endpoint). |
endpointSize | number | yes | intent | intent — endpoint length in points on screen; kept at any zoom. |
EndpointStyle
How an end of a dimension or leader is drawn — SketchUp's dimension endpoints (https://help.sketchup.com/en/sketchup/adding-text-labels-and-dimensions-model; Ruby ARROW_CLOSED / ARROW_OPEN / ARROW_SLASH / ARROW_DOT / ARROW_NONE). closed and dot are filled.
Used by: DimensionStyle, Endpoint, LeaderStyle, LinearDimensionStyle.
// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
/**
* How an end of a dimension or leader is drawn — SketchUp's dimension
* endpoints (https://help.sketchup.com/en/sketchup/adding-text-labels-and-dimensions-model;
* Ruby `ARROW_CLOSED` / `ARROW_OPEN` / `ARROW_SLASH` / `ARROW_DOT` /
* `ARROW_NONE`). `closed` and `dot` are filled.
*/
export type EndpointStyle = "closed" | "open" | "slash" | "dot" | "none";Values: "closed", "open", "slash", "dot", "none".
📖 1 min read