models

package
v0.0.0-...-de6d16e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 11, 2022 License: AGPL-3.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// BatchInputContentTypeText captures enum value "Text"
	BatchInputContentTypeText string = "Text"

	// BatchInputContentTypeMath captures enum value "Math"
	BatchInputContentTypeMath string = "Math"

	// BatchInputContentTypeDiagram captures enum value "Diagram"
	BatchInputContentTypeDiagram string = "Diagram"

	// BatchInputContentTypeRawContent captures enum value "Raw Content"
	BatchInputContentTypeRawContent string = "Raw Content"

	// BatchInputContentTypeTextDocument captures enum value "Text Document"
	BatchInputContentTypeTextDocument string = "Text Document"
)
View Source 
const (

	// BatchInputConversionStateDIGITALPUBLISH captures enum value "DIGITAL_PUBLISH"
	BatchInputConversionStateDIGITALPUBLISH string = "DIGITAL_PUBLISH"

	// BatchInputConversionStateDIGITALEDIT captures enum value "DIGITAL_EDIT"
	BatchInputConversionStateDIGITALEDIT string = "DIGITAL_EDIT"
)
View Source 
const (

	// SolverConfigurationAngleUnitDeg captures enum value "deg"
	SolverConfigurationAngleUnitDeg string = "deg"

	// SolverConfigurationAngleUnitRad captures enum value "rad"
	SolverConfigurationAngleUnitRad string = "rad"
)
View Source 
const (

	// SolverConfigurationFractionModeDecimal captures enum value "decimal"
	SolverConfigurationFractionModeDecimal string = "decimal"

	// SolverConfigurationFractionModeRational captures enum value "rational"
	SolverConfigurationFractionModeRational string = "rational"

	// SolverConfigurationFractionModeMixed captures enum value "mixed"
	SolverConfigurationFractionModeMixed string = "mixed"
)
View Source 
const (

	// SolverConfigurationOptionsAlgebraic captures enum value "algebraic"
	SolverConfigurationOptionsAlgebraic string = "algebraic"

	// SolverConfigurationOptionsNumeric captures enum value "numeric"
	SolverConfigurationOptionsNumeric string = "numeric"
)
View Source 
const (

	// SolverConfigurationRoundingModeHalfUp captures enum value "half up"
	SolverConfigurationRoundingModeHalfUp string = "half up"

	// SolverConfigurationRoundingModeTruncate captures enum value "truncate"
	SolverConfigurationRoundingModeTruncate string = "truncate"
)
View Source 
const (

	// StrokePointerTypePEN captures enum value "PEN"
	StrokePointerTypePEN string = "PEN"

	// StrokePointerTypeTOUCH captures enum value "TOUCH"
	StrokePointerTypeTOUCH string = "TOUCH"

	// StrokePointerTypeERASER captures enum value "ERASER"
	StrokePointerTypeERASER string = "ERASER"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BatchInput 

type BatchInput struct {

	// The configuration for the recognition.
	Configuration *Configuration `json:"configuration,omitempty"`

	// recognition type
	// Required: true
	// Enum: [Text Math Diagram Raw Content Text Document]
	ContentType *string `json:"contentType"`

	// target of conversion, no conversion will be made if that parameter is not provided
	// Enum: [DIGITAL_PUBLISH DIGITAL_EDIT]
	ConversionState string `json:"conversionState,omitempty"`

	// height of the writing area
	Height int32 `json:"height,omitempty"`

	// The write entries that corresponds to the input iink
	// Required: true
	StrokeGroups []*StrokeGroup `json:"strokeGroups"`

	// A global CSS styling for your content. See https://developer.myscript.com/docs/interactive-ink/latestweb/myscriptjs/styling/
	Theme string `json:"theme,omitempty"`

	// width of the writing area
	Width int32 `json:"width,omitempty"`

	// x resolution of the writing area in dpi
	XDPI float32 `json:"xDPI,omitempty"`

	// y resolution of the writing area in dpi
	YDPI float32 `json:"yDPI,omitempty"`
}

BatchInput BatchInput

swagger:model BatchInput

func (*BatchInput) MarshalBinary 

func (m *BatchInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BatchInput) UnmarshalBinary 

func (m *BatchInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BatchInput) Validate 

func (m *BatchInput) Validate(formats strfmt.Registry) error

Validate validates this batch input

type Configuration 

type Configuration struct {

	// always connected
	AlwaysConnected bool `json:"alwaysConnected,omitempty"`

	// diagram
	Diagram *DiagramConfiguration `json:"diagram,omitempty"`

	// export
	Export *ExportConfiguration `json:"export,omitempty"`

	// lang
	Lang string `json:"lang,omitempty"`

	// math
	Math *MathConfiguration `json:"math,omitempty"`

	// raw content
	RawContent *RawContentConfiguration `json:"raw-content,omitempty"`

	// text
	Text *TextConfiguration `json:"text,omitempty"`
}

Configuration Configuration

The configuration for the recognition. See explanation for parameters in https://developer.myscript.com/docs/interactive-ink/latest/reference/web/configuration-rest/

swagger:model Configuration

func (*Configuration) MarshalBinary 

func (m *Configuration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Configuration) UnmarshalBinary 

func (m *Configuration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Configuration) Validate 

func (m *Configuration) Validate(formats strfmt.Registry) error

Validate validates this configuration

type DiagramConfiguration 

type DiagramConfiguration struct {

	// convert
	Convert *DiagramConvertConfiguration `json:"convert,omitempty"`

	// diagram.enable-sub-blocks
	EnableSubBlocks bool `json:"enable-sub-blocks,omitempty"`

	// text
	Text *TextConfConfiguration `json:"text,omitempty"`
}

DiagramConfiguration DiagramConfiguration

swagger:model DiagramConfiguration

func (*DiagramConfiguration) MarshalBinary 

func (m *DiagramConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DiagramConfiguration) UnmarshalBinary 

func (m *DiagramConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DiagramConfiguration) Validate 

func (m *DiagramConfiguration) Validate(formats strfmt.Registry) error

Validate validates this diagram configuration

type DiagramConvertConfiguration 

type DiagramConvertConfiguration struct {

	// diagram.convert.edge
	Edge bool `json:"edge,omitempty"`

	// diagram.convert.node
	Node bool `json:"node,omitempty"`

	// diagram.convert.text
	Text bool `json:"text,omitempty"`
}

DiagramConvertConfiguration DiagramConvertConfiguration

swagger:model DiagramConvertConfiguration

func (*DiagramConvertConfiguration) MarshalBinary 

func (m *DiagramConvertConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DiagramConvertConfiguration) UnmarshalBinary 

func (m *DiagramConvertConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DiagramConvertConfiguration) Validate 

func (m *DiagramConvertConfiguration) Validate(formats strfmt.Registry) error

Validate validates this diagram convert configuration

type ErrorMessage 

type ErrorMessage struct {

	// code
	Code string `json:"code,omitempty"`

	// message
	Message string `json:"message,omitempty"`
}

ErrorMessage errorMessage

swagger:model errorMessage

func (*ErrorMessage) MarshalBinary 

func (m *ErrorMessage) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorMessage) UnmarshalBinary 

func (m *ErrorMessage) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorMessage) Validate 

func (m *ErrorMessage) Validate(formats strfmt.Registry) error

Validate validates this error message

type ExportConfiguration 

type ExportConfiguration struct {

	// export.image-resolution
	ImageResolution int32 `json:"image-resolution,omitempty"`

	// jiix
	Jiix *JiixConfiguration `json:"jiix,omitempty"`
}

ExportConfiguration ExportConfiguration

swagger:model ExportConfiguration

func (*ExportConfiguration) MarshalBinary 

func (m *ExportConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExportConfiguration) UnmarshalBinary 

func (m *ExportConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExportConfiguration) Validate 

func (m *ExportConfiguration) Validate(formats strfmt.Registry) error

Validate validates this export configuration

type GuidesConfiguration 

type GuidesConfiguration struct {

	// text.guides.enable
	Enable bool `json:"enable,omitempty"`
}

GuidesConfiguration GuidesConfiguration

swagger:model GuidesConfiguration

func (*GuidesConfiguration) MarshalBinary 

func (m *GuidesConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GuidesConfiguration) UnmarshalBinary 

func (m *GuidesConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GuidesConfiguration) Validate 

func (m *GuidesConfiguration) Validate(formats strfmt.Registry) error

Validate validates this guides configuration

type JiixConfiguration 

type JiixConfiguration struct {

	// export.jiix.bounding-box
	BoundingBox bool `json:"bounding-box,omitempty"`

	// export.jiix.strokes
	Strokes bool `json:"strokes,omitempty"`

	// export.jiix.style
	Style bool `json:"style,omitempty"`

	// text
	Text *JiixTextConfiguration `json:"text,omitempty"`
}

JiixConfiguration JiixConfiguration

swagger:model JiixConfiguration

func (*JiixConfiguration) MarshalBinary 

func (m *JiixConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JiixConfiguration) UnmarshalBinary 

func (m *JiixConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JiixConfiguration) Validate 

func (m *JiixConfiguration) Validate(formats strfmt.Registry) error

Validate validates this jiix configuration

type JiixTextConfiguration 

type JiixTextConfiguration struct {

	// export.jiix.text.chars
	Chars bool `json:"chars,omitempty"`

	// export.jiix.text.words
	Words bool `json:"words,omitempty"`
}

JiixTextConfiguration JiixTextConfiguration

swagger:model JiixTextConfiguration

func (*JiixTextConfiguration) MarshalBinary 

func (m *JiixTextConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JiixTextConfiguration) UnmarshalBinary 

func (m *JiixTextConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JiixTextConfiguration) Validate 

func (m *JiixTextConfiguration) Validate(formats strfmt.Registry) error

Validate validates this jiix text configuration

type MarginConfiguration 

type MarginConfiguration struct {

	// math.margin.bottom
	Bottom int32 `json:"bottom,omitempty"`

	// math.margin.left
	Left int32 `json:"left,omitempty"`

	// math.margin.right
	Right int32 `json:"right,omitempty"`

	// math.margin.top
	Top int32 `json:"top,omitempty"`
}

MarginConfiguration MarginConfiguration

swagger:model MarginConfiguration

func (*MarginConfiguration) MarshalBinary 

func (m *MarginConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MarginConfiguration) UnmarshalBinary 

func (m *MarginConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MarginConfiguration) Validate 

func (m *MarginConfiguration) Validate(formats strfmt.Registry) error

Validate validates this margin configuration

type MathConfiguration 

type MathConfiguration struct {

	// math.customGrammarContent
	CustomGrammarContent string `json:"customGrammarContent,omitempty"`

	// math.customGrammarId
	CustomGrammarID string `json:"customGrammarId,omitempty"`

	// margin
	Margin *MarginConfiguration `json:"margin,omitempty"`

	// solver
	Solver *SolverConfiguration `json:"solver,omitempty"`
}

MathConfiguration MathConfiguration

swagger:model MathConfiguration

func (*MathConfiguration) MarshalBinary 

func (m *MathConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*MathConfiguration) UnmarshalBinary 

func (m *MathConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*MathConfiguration) Validate 

func (m *MathConfiguration) Validate(formats strfmt.Registry) error

Validate validates this math configuration

type RawContentConfiguration 

type RawContentConfiguration struct {

	// recognition
	Recognition *Recognition `json:"recognition,omitempty"`

	// text
	Text *TextConfConfiguration `json:"text,omitempty"`
}

RawContentConfiguration RawContentConfiguration

swagger:model RawContentConfiguration

func (*RawContentConfiguration) MarshalBinary 

func (m *RawContentConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RawContentConfiguration) UnmarshalBinary 

func (m *RawContentConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RawContentConfiguration) Validate 

func (m *RawContentConfiguration) Validate(formats strfmt.Registry) error

Validate validates this raw content configuration

type Recognition 

type Recognition struct {

	// shape
	Shape bool `json:"shape,omitempty"`

	// text
	Text bool `json:"text,omitempty"`
}

Recognition Recognition

swagger:model Recognition

func (*Recognition) MarshalBinary 

func (m *Recognition) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Recognition) UnmarshalBinary 

func (m *Recognition) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Recognition) Validate 

func (m *Recognition) Validate(formats strfmt.Registry) error

Validate validates this recognition

type SolverConfiguration 

type SolverConfiguration struct {

	// math.solver.angle-unit
	// Enum: [deg rad]
	AngleUnit string `json:"angle-unit,omitempty"`

	// math.solver.decimal-separator
	DecimalSeparator string `json:"decimal-separator,omitempty"`

	// math.solver.enable
	Enable bool `json:"enable,omitempty"`

	// math.solver.fraction-mode
	// Enum: [decimal rational mixed]
	FractionMode string `json:"fraction-mode,omitempty"`

	// math.solver.fractional-part-digits
	FractionalPartDigits int32 `json:"fractional-part-digits,omitempty"`

	// math.solver.options
	// Enum: [algebraic numeric]
	Options string `json:"options,omitempty"`

	// math.solver.rounding-mode
	// Enum: [half up truncate]
	RoundingMode string `json:"rounding-mode,omitempty"`
}

SolverConfiguration SolverConfiguration

swagger:model SolverConfiguration

func (*SolverConfiguration) MarshalBinary 

func (m *SolverConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SolverConfiguration) UnmarshalBinary 

func (m *SolverConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SolverConfiguration) Validate 

func (m *SolverConfiguration) Validate(formats strfmt.Registry) error

Validate validates this solver configuration

type Stroke 

type Stroke struct {

	// An optional id for the stroke
	ID string `json:"id,omitempty"`

	// The list of pressure information of the stroke
	P []float32 `json:"p"`

	// The pointer id
	PointerID int32 `json:"pointerId,omitempty"`

	// The pointer type for the stroke
	// Enum: [PEN TOUCH ERASER]
	PointerType string `json:"pointerType,omitempty"`

	// The list of timestamps of the stroke
	T []int64 `json:"t"`

	// The list of x coordinates of the stroke
	// Required: true
	X []float32 `json:"x"`

	// The list of y coordinates of the stroke
	// Required: true
	Y []float32 `json:"y"`
}

Stroke Stroke

Representation of a stroke, that is the capture of an user writing input between the moment when the writing device touches the writing surface and the moment when it is lifted from the surface. See https://developer.myscript.com/docs/interactive-ink/latest/web/myscriptjs/editing/ for information about the components of a stroke

swagger:model Stroke

func (*Stroke) MarshalBinary 

func (m *Stroke) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Stroke) UnmarshalBinary 

func (m *Stroke) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Stroke) Validate 

func (m *Stroke) Validate(formats strfmt.Registry) error

Validate validates this stroke

type StrokeGroup 

type StrokeGroup struct {

	// CSS style for the pen. See https://developer.myscript.com/docs/interactive-ink/latest/reference/web/styling/
	PenStyle string `json:"penStyle,omitempty"`

	// CSS classes for the pen. Classes are to be provided in the general CSS theme. See https://developer.myscript.com/docs/interactive-ink/latest/reference/web/styling/
	PenStyleClasses string `json:"penStyleClasses,omitempty"`

	// a list of strokes
	// Required: true
	Strokes []*Stroke `json:"strokes"`
}

StrokeGroup StrokeGroup

a list of strokes that share the same pen style

swagger:model StrokeGroup

func (*StrokeGroup) MarshalBinary 

func (m *StrokeGroup) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*StrokeGroup) UnmarshalBinary 

func (m *StrokeGroup) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*StrokeGroup) Validate 

func (m *StrokeGroup) Validate(formats strfmt.Registry) error

Validate validates this stroke group

type TextConfConfiguration 

type TextConfConfiguration struct {

	// text.configuration.addLKText
	AddLKText bool `json:"addLKText,omitempty"`

	// text.configuration.customLexycon
	CustomLexicon []string `json:"customLexicon"`

	// text.configuration.customResources
	CustomResources []string `json:"customResources"`
}

TextConfConfiguration TextConfConfiguration

swagger:model TextConfConfiguration

func (*TextConfConfiguration) MarshalBinary 

func (m *TextConfConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TextConfConfiguration) UnmarshalBinary 

func (m *TextConfConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TextConfConfiguration) Validate 

func (m *TextConfConfiguration) Validate(formats strfmt.Registry) error

Validate validates this text conf configuration

type TextConfiguration 

type TextConfiguration struct {

	// configuration
	Configuration *TextConfConfiguration `json:"configuration,omitempty"`

	// guides
	Guides *GuidesConfiguration `json:"guides,omitempty"`

	// margin
	Margin *MarginConfiguration `json:"margin,omitempty"`
}

TextConfiguration TextConfiguration

swagger:model TextConfiguration

func (*TextConfiguration) MarshalBinary 

func (m *TextConfiguration) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TextConfiguration) UnmarshalBinary 

func (m *TextConfiguration) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TextConfiguration) Validate 

func (m *TextConfiguration) Validate(formats strfmt.Registry) error

Validate validates this text configuration

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.