@ionic-native/star-prnt > "index.d" > PrintCommand
PrintCommand
- BarcodeSymbology
- BarcodeWidth
- QrCodeLevel
- QrCodeModel
- absolutePosition
- alignment
- append
- appendAbsolutePosition
- appendAlignment
- appendBarcode
- appendBitmap
- appendBlackMark
- appendBytes
- appendCharacterSpace
- appendCodePage
- appendCutPaper
- appendEmphasis
- appendEncoding
- appendFontStyle
- appendHorizontalTabPosition
- appendInternational
- appendInvert
- appendLineFeed
- appendLineSpace
- appendLogo
- appendMultiple
- appendQrCode
- appendRaw
- appendRawBytes
- appendUnderline
- appendUnitFeed
- bothScale
- cell
- diffusion
- enableEmphasis
- enableInvert
- enableMultiple
- enableUnderline
- height
- hri
- logoSize
- openCashDrawer
- rotation
- width
● BarcodeSymbology: string
Defined in index.d.ts:237
Property to be used with the appendBarcode command. Choose the format of the return value defined in StarPRNT.BarcodeSymbology or the BarcodeSymbology enum. 'Code128' | 'Code39' | 'Code93' | 'ITF' | 'JAN8' | 'JAN13' | 'NW7' | 'UPCA' | 'UPCE' | Example: {appendBarcode:'{BStar', BarcodeSymbology:BarcodeSymbology.Code128}
● BarcodeWidth: string
Defined in index.d.ts:244
Property to be used with the appendBarcode command. Choose the format of the return value defined in StarPRNT.BarcodeWidth or the BarcodeWidth enum. Mode1 | Mode2 | Mode3 | Mode4 | Mode5 | Mode6 | Mode7 | Mode8 | Mode9 Example: {appendBarcode:'{BStar', BarcodeWidth:BarcodeWidth.Mode2}
● QrCodeLevel: string
Defined in index.d.ts:310
Property to be used with the appendQrCode command. Choose the format of the return value defined in StarPRNT.QrCodeLevel or the QrCodeLevel enum. 'No1' | 'No2'. Default 'H' Example: {appendQrCode:'{BStar', QrCodeLevel:QrCodeLevel.H}
● QrCodeModel: string
Defined in index.d.ts:304
Property to be used with the appendQrCode command. Choose the format of the return value defined in StarPRNT.QrCodeModel or the QrCodeModel enum. 'No1' | 'No2' Default 'No2' Example: {appendQrCode:'{BStar', QrCodeModel:QrCodeModel.No1}
● absolutePosition: number
Defined in index.d.ts:269
Property to be used with the appendBitmap command, the appendBarcode command, or the appendQrCode command (Units:Dots) appendBitmap Example: {appendBitmap:uri, absolutePosition:40}. appendBarcode Example: {appendBarcode:'{BStar', absolutePosition:40}. appendQrCode Example: {appendQrCode:'{BStar', absolutePosition:40}.
● alignment: string
Defined in index.d.ts:277
Property to be used with the appendBitmap command, the appendBarcode command, or the appendQrCode command (Units:Dots) Choose the format of the return value defined in StarPRNT.AlignmentPosition or the AlignmentPosition enum. 'Left' | 'Center' | 'Right'. appendBitmap Example: {appendBitmap:uri, alignment:AlignmentPosition.Center}. appendBarcode Example: {appendBarcode:'{BStar', alignment:AlignmentPosition.Center}. appendQrCode Example: {appendQrCode:'{BStar', alignment:AlignmentPosition.Center}.
● append: string
Defined in index.d.ts:110
Data (Text) is added to the command buffer. Example: {append:"Star Clothing Boutique\n123 Star Road\nCity, State 12345\n\n"}
● appendAbsolutePosition: number
Defined in index.d.ts:195
Absolute position command is generated and added to the command buffer. (Unit: Dots). Send in conjunction with the data property to append absolute position just to that string Example1: Append data with Absolute position {appendAbsolutePosition:40, data: "Text with absolute position"} Example2: Append absolute position to subsequent commands: {appendAbsolutePosition:40}
● appendAlignment: string
Defined in index.d.ts:202
Alignment command is generated and added to the command buffer. Send in conjunction with the data property to append alignment position just to that string Choose the format of the return value defined in StarPRNT.AlignmentPosition or the AlignmentPosition enum. 'Left' | 'Center' | 'Right'. Example1 Append data with Alignment position: {appendAlignment:AlignmentPosition.Center, data: "Text with centered position"} Example2 Append absolute position to subsequent commands: {appendAlignment:AlignmentPosition.Center}
● appendBarcode: string
Defined in index.d.ts:230
Print command of the barcode is generated and added to the command buffer. Additional Properties: BarcodeSymbology, BarcodeWidth, height, hri, absolutePosition, alignment. Example: {appendBarcode:"{BStar", BarcodeSymbology:BarcodeSymbology.Code128, BarcodeWidth:BarcodeWidth.Mode2, height:40, hri:true } Example with absolutePosition: {appendBarcode:"{BStar", BarcodeSymbology:BarcodeSymbology.Code128, BarcodeWidth:BarcodeWidth.Mode2, height:40, hri:true, absolutePosition:40 } Example with alignment:{appendBarcode:"{BStar", BarcodeSymbology:BarcodeSymbology.Code128, BarcodeWidth:BarcodeWidth.Mode2, height:40, hri:true, alignment:alignment:AlignmentPosition.Center }
● appendBitmap: string
Defined in index.d.ts:324
Print command of the bitmap is generated and added to the command buffer. Takes a string image URI this can be obtained via the camera or photo library or as a static resource saved on the phone memory. Additional Properties: diffusion, width, bothScale, rotation, absolutePosition, alignment. Example: {appendBitmap:uri, diffusion: true, width:576, bothScale: true} Example with absolutePosition: {appendBitmap:uri, diffusion: true, width:576, bothScale: true, absolutePosition: 40 }. Example with alignment: {appendBitmap:uri, diffusion: true, width:576, bothScale: true, alignment:"Center" }.
● appendBlackMark: string
Defined in index.d.ts:189
Black mark command is generated and added to the command buffer. Choose the format of the return value defined in StarPRNT.BlackMarkType or the BlackMarkType enum. 'Valid' | 'Invalid' | 'ValidWithDetection' Example: {appendBlackMark: BlackMarkType.Valid}
● appendBytes: Array.<number>
Defined in index.d.ts:119
Data (Command) is added to the command buffer. Takes an array of bytes. Example: {appendBytes:[0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x57, 0x6f, 0x72, 0x6c, 0x64, 0x2e]}
● appendCharacterSpace: number
Defined in index.d.ts:128
Set command of the character space is generated and added to the command buffer. Character Spacs (Unit: Dots) Example: 4
● appendCodePage: string
Defined in index.d.ts:106
Select command of the code page is generated and added to the commands property. Choose the format of the return value Defined in StarPRNT.CodePageType or the CodePageType enum. Example: {appendCodePage:'CP858'}
● appendCutPaper: string
Defined in index.d.ts:183
Paper cut command is generated and added to the command buffer. Choose the format of the return value defined in StarPRNT.CutPaperAction or the CutPaperAction enum. 'FullCut' | 'FullCutWithFeed' | 'PartialCut' | 'PartialCutWithFeed' Example: {appendCutPaper:CutPaperAction.PartialCutWithFeed}
● appendEmphasis: string
Defined in index.d.ts:132
Select command of the emphasis mode is generated and added to the command buffer. Example: {appendEmphasis:"SALE\n"}
● appendEncoding: string
Defined in index.d.ts:100
Characther encoding is used to getByte data from all subsequent commands. Default 'US-ASCII' Choose the format of the return value Defined in StarPRNT.Encoding or the Encoding enum. Example: {appendEncoding:'US-ASCII'}
● appendFontStyle: string
Defined in index.d.ts:177
Select command of the font style is generated and added to the command buffer. Choose the format of the return value defined in StarPRNT.FontStyleType or the FontStyleType enum. 'A' | 'B' Example: {appendFontStyle:FontStyleType.A}
● appendHorizontalTabPosition: Array.<number>
Defined in index.d.ts:209
Horizontal tab set/clear command is generated and added to the command buffer. (Only works for certain printer models, check the starSDK documentation for details) Array of horizontal tab positions (Units: ANK character pitch). Specifying empty array deletes all currently set horizontal tab positions. Example: {appendHorizontalTabPosition:[15, 35]} Delete positions Example: {appendHorizontalTabPosition:[]}
● appendInternational: string
Defined in index.d.ts:159
Select command of the international character mode is generated and added to the command buffer. Choose the format of the return value Defined in StarPRNT.InternationalType or the InternationalType enum. 'UK' | 'USA' | 'France' | 'Germany' | 'Denmark' | 'Sweden' | 'Italy' | 'Spain' | 'Japan' | 'Norway' | 'Denmark2' | 'Spain2' | 'LatinAmerica' | 'Korea' | 'Ireland' | 'Legal' Example {appendInternational:InternationalType.UK}
● appendInvert: string
Defined in index.d.ts:140
Select command of the invert mode is generated and added to the command buffer. Example: {appendInvert:"Refunds and Exchanges\n"}
● appendLineFeed: number
Defined in index.d.ts:163
Line feed command is generated and added to the command buffer. Paper feed units (Units: Lines) Example: 2
● appendLineSpace: number
Defined in index.d.ts:171
Set command of the line space is generated and added to the command buffer. Line spaces (Units: Dots) Example: 32
● appendLogo: number
Defined in index.d.ts:216
Print command of the logo is generated and added to the command buffer. The logo has to be uploaded to the printer using the Star Print utility. Send in conjuction with the logoSize property to set the logo size Example: {appendLogo:1} Example with LogoSize: {appendLogo:1, logoSize:LogoSize.DoubleWidthDoubleHeight}
● appendMultiple: string
Defined in index.d.ts:283
Select command of the multiple mode is generated and added to the command buffer. Additional properties: width:number, height:number Example: {appendMultiple:" $156.95\n", width:2, height:2}.
● appendQrCode: string
Defined in index.d.ts:298
Print command of the QR code is generated and added to the command buffer. Additional Properties: QrCodeModel, QrCodeLevel, cell, absolutePosition, alignment. Example: {appendQrCode:"{BStar", QrCodeModel:"No2", QrCodeLevel:"L", cell: 8}. Example with absolutePosition: {appendQrCode:"{BStar", QrCodeModel:"No2", QrCodeLevel:"L", cell: 8, absolutePosition: 40 }. Example with alignment: {appendQrCode:"{BStar", QrCodeModel:"No2", QrCodeLevel:"L", cell: 8, alignment:"Center" }.
● appendRaw: string
Defined in index.d.ts:114
Data (Text) is added to the command buffer. Example: {appendRaw:"Star Clothing Boutique\n123 Star Road\nCity, State 12345\n\n"}
● appendRawBytes: Array.<number>
Defined in index.d.ts:124
Data (Command) is added to the command buffer. Takes an array of bytes. Example: {appendRawBytes:[0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x20, 0x57, 0x6f, 0x72, 0x6c, 0x64, 0x2e]}
● appendUnderline: string
Defined in index.d.ts:148
Select command of the under line mode is generated and added to the command buffer. Example: {appendUnderline:"30 days"}
● appendUnitFeed: number
Defined in index.d.ts:167
Unit feed command is generated and added to the command buffer. Paper feed units (Units: Dots) Example: 64
● bothScale: boolean
Defined in index.d.ts:335
Property to be used with the appendBitmap command. Height is changed according to the conversion rate of the width property. true = Valid, false = Invalid. Default true. Example: {appendBitmap:uri, bothScale: true }
● cell: number
Defined in index.d.ts:315
Property to be used with the appendQrCode command. QRCode Cell size. Default 4. Example: {appendQrCode:'{BStar', cell:8}
● diffusion: boolean
Defined in index.d.ts:329
Property to be used with the appendBitmap command. Random dither: true = Valid, false = Invalid. Default true. Example: {appendBitmap:uri, diffusion: false }
● enableEmphasis: boolean
Defined in index.d.ts:136
Enable emphasis mode is generated and added to the command buffer. Example: {enableEmphasis:true}
● enableInvert: boolean
Defined in index.d.ts:144
Enable invert mode is generated and added to the command buffer. Example: {enableInvert:true}
● enableMultiple: boolean
Defined in index.d.ts:290
Enable multiple mode is generated and added to the command buffer. Additional properties: width:number, height:number Example: {enableMultiple:true, width:2, height:2} Disable Example: {enableMultiple:false}
● enableUnderline: boolean
Defined in index.d.ts:152
Enable under line mode is generated and added to the command buffer. Example: {enableUnderline:true}
● height: number
Defined in index.d.ts:256
Property to be used with the appendBarcode command or the appendMultiple command (Units:Dots) appendBarcode Example: {appendBarcode:'{BStar', height:40} appendMultiple: {appendMultiple:'text to print', height:40}
● hri: boolean
Defined in index.d.ts:250
Property to be used with the appendBarcode command. Under-bar characters. true = Valid, false = Invalid Example: {appendBarcode:'{BStar', hri:true}
● logoSize: string
Defined in index.d.ts:222
Property to be used with the appendLogo command. Choose the format of the return value defined in StarPRNT.LogoSize or the LogoSize enum. 'Normal' | 'DoubleWidth' | 'DoubleHeight' | 'DoubleWidthDoubleHeight'; Example: {appendLogo:1, logoSize:LogoSize.DoubleWidthDoubleHeight}
● openCashDrawer: number
Defined in index.d.ts:346
sends a appendPeripheral command to the printer for channel number: Example: 1 = No1, 2 = No2
● rotation: string
Defined in index.d.ts:342
Property to be used with the appendBitmap command. Choose the format of the return value defined in StarPRNT.BitmapConverterRotation or the BitmapConverterRotation enum. 'Normal' | 'Left90' | 'Right90' | 'Rotate180' Example: {appendBitmap:uri, rotation: BitmapConverterRotation.Left90 }
● width: number
Defined in index.d.ts:262
Property to be used with the appendBitmap command or the appendMultiple command (Units:Dots) appendBitmap Example: {appendBitmap:uri, width:576} appendMultiple: {appendMultiple:'text to print', width:40}