API Reference

interface GlobalAppearancePayload {
  strokeColor?: string;        // Hex color (e.g., "#FF0000")
  fillColor?: string;          // Hex color (e.g., "#CCCCCC")
  textColor?: string;          // Hex color (e.g., "#000000")
  lineWidth?: number;          // 1-10
  lineStyle?: number;          // 0 = solid, 1 = dashed, 2 = dotted
  transparency?: number;       // 0-100
}

interface AnnotationProperties {
  strokeColor?: string;        // Line/Shape color
  fillColor?: string;          // Background color
  textColor?: string;          // Text/Label color
  lineWidth?: number;          // 1-10
  lineStyle?: number;          // 0: Solid, 1: Dashed, 2: Dotted
  transparency?: number;       // 0-100
  locked?: boolean;            // Lock state
  text?: string;               // Text content
  arrowType?: number;          // 0: None, 1: Single, 2: Both
  countType?: number;          // 0: Circle, 1: Square, 2: Triangle, 3: Diamond
  measureType?: number;        // Unit/Format ID
}

// Host -> Canvas
interface SetAnnotationPropertiesPayload {
  guid: string;
  props: AnnotationProperties;
}

// Canvas -> Host
interface AnnotationPropertiesResponse {
  guid: string;
  success: boolean;
  props?: AnnotationProperties;
  error?: string;
}