Tar-sdk-capacitor NPM

tar-sdk-capacitor

Allows easy integration of the TroposAR SDK for augmented reality in Capacitor apps.

Install

npm install tar-sdk-capacitor
npx cap sync

API

setTARParameters(...)
showTAR(...)
showTARWithAsset(...)
isSupported()
Interfaces
Type Aliases
Enums

setTARParameters(...)

setTARParameters(params: TARSDKParams) => Promise<void>

Param	Type
`params`	TARSDKParams

showTAR(...)

showTAR(settings: TARSDKParams) => Promise<void>

Param	Type
`settings`	TARSDKParams

showTARWithAsset(...)

showTARWithAsset(params: TARSDKWitAssetParams) => Promise<void>

Param	Type
`params`	TARSDKWitAssetParams

isSupported()

isSupported() => Promise<{ value: boolean; }>

Returns: Promise<{ value: boolean; }>

Interfaces

TARSDKParams

Prop	Type
`apiKey`	String
`language`	String
`defaultLanguage`	String
`activeLanguages`	Array<String>
`mapMode`	Boolean
`walletMode`	Boolean
`paintingMode`	Boolean
`colorPalette`	Object
`startMode`	TARSDKStartMode

String

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

Prop	Type	Description
`length`	number	Returns the length of a String object.

Method	Signature	Description
toString	() => string	Returns a string representation of a string.
charAt	(pos: number) => string	Returns the character at the specified index.
charCodeAt	(index: number) => number	Returns the Unicode value of the character at the specified location.
concat	(...strings: string[]) => string	Returns a string that contains the concatenation of two or more strings.
indexOf	(searchString: string, position?: number \| undefined) => number	Returns the position of the first occurrence of a substring.
lastIndexOf	(searchString: string, position?: number \| undefined) => number	Returns the last occurrence of a substring in the string.
localeCompare	(that: string) => number	Determines whether two strings are equivalent in the current locale.
match	(regexp: string \| RegExp) => RegExpMatchArray \| null	Matches a string with a regular expression, and returns an array containing the results of that search.
replace	(searchValue: string \| RegExp, replaceValue: string) => string	Replaces text in a string, using a regular expression or search string.
replace	(searchValue: string \| RegExp, replacer: (substring: string, ...args: any[]) => string) => string	Replaces text in a string, using a regular expression or search string.
search	(regexp: string \| RegExp) => number	Finds the first substring match in a regular expression search.
slice	(start?: number \| undefined, end?: number \| undefined) => string	Returns a section of a string.
split	(separator: string \| RegExp, limit?: number \| undefined) => string[]	Split a string into substrings using the specified separator and return them as an array.
substring	(start: number, end?: number \| undefined) => string	Returns the substring at the specified location within a String object.
toLowerCase	() => string	Converts all the alphabetic characters in a string to lowercase.
toLocaleLowerCase	(locales?: string \| string[] \| undefined) => string	Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.
toUpperCase	() => string	Converts all the alphabetic characters in a string to uppercase.
toLocaleUpperCase	(locales?: string \| string[] \| undefined) => string	Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale.
trim	() => string	Removes the leading and trailing white space and line terminator characters from a string.
substr	(from: number, length?: number \| undefined) => string	Gets a substring beginning at the specified location and having the specified length.
valueOf	() => string	Returns the primitive value of the specified object.

RegExpMatchArray

Prop	Type
`index`	number
`input`	string

RegExp

Prop	Type	Description
`source`	string	Returns a copy of the text of the regular expression pattern. Read-only. The regExp argument is a Regular expression object. It can be a variable name or a literal.
`global`	boolean	Returns a Boolean value indicating the state of the global flag (g) used with a regular expression. Default is false. Read-only.
`ignoreCase`	boolean	Returns a Boolean value indicating the state of the ignoreCase flag (i) used with a regular expression. Default is false. Read-only.
`multiline`	boolean	Returns a Boolean value indicating the state of the multiline flag (m) used with a regular expression. Default is false. Read-only.
`lastIndex`	number

Method	Signature	Description
exec	(string: string) => RegExpExecArray \| null	Executes a search on a string using a regular expression pattern, and returns an array containing the results of that search.
test	(string: string) => boolean	Returns a Boolean value that indicates whether or not a pattern exists in a searched string.
compile	() => this

RegExpExecArray

Prop	Type
`index`	number
`input`	string

Array

Prop	Type	Description
`length`	number	Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Method	Signature	Description
toString	() => string	Returns a string representation of an array.
toLocaleString	() => string	Returns a string representation of an array. The elements are converted to string using their toLocalString methods.
pop	() => T \| undefined	Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
push	(...items: T[]) => number	Appends new elements to the end of an array, and returns the new length of the array.
concat	(...items: ConcatArray<T>[]) => T[]	Combines two or more arrays. This method returns a new array without modifying any existing arrays.
concat	(...items: (T \| ConcatArray<T>)[]) => T[]	Combines two or more arrays. This method returns a new array without modifying any existing arrays.
join	(separator?: string \| undefined) => string	Adds all the elements of an array into a string, separated by the specified separator string.
reverse	() => T[]	Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
shift	() => T \| undefined	Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
slice	(start?: number \| undefined, end?: number \| undefined) => T[]	Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.
sort	(compareFn?: ((a: T, b: T) => number) \| undefined) => this	Sorts an array in place. This method mutates the array and returns a reference to the same array.
splice	(start: number, deleteCount?: number \| undefined) => T[]	Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
splice	(start: number, deleteCount: number, ...items: T[]) => T[]	Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
unshift	(...items: T[]) => number	Inserts new elements at the start of an array, and returns the new length of the array.
indexOf	(searchElement: T, fromIndex?: number \| undefined) => number	Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
lastIndexOf	(searchElement: T, fromIndex?: number \| undefined) => number	Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
every	<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => this is S[]	Determines whether all the members of an array satisfy the specified test.
every	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean	Determines whether all the members of an array satisfy the specified test.
some	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean	Determines whether the specified callback function returns true for any element of an array.
forEach	(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any) => void	Performs the specified action for each element in an array.
map	<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any) => U[]	Calls a defined callback function on each element of an array, and returns an array that contains the results.
filter	<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => S[]	Returns the elements of an array that meet the condition specified in a callback function.
filter	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => T[]	Returns the elements of an array that meet the condition specified in a callback function.
reduce	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T	Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduce	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduce	<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U	Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T	Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduceRight	<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U	Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

ConcatArray

Prop	Type
`length`	number

Method	Signature
join	(separator?: string \| undefined) => string
slice	(start?: number \| undefined, end?: number \| undefined) => T[]

Boolean

Method	Signature	Description
valueOf	() => boolean	Returns the primitive value of the specified object.

Object

Provides functionality common to all JavaScript objects.

Prop	Type	Description
`constructor`	Function	The initial value of Object.prototype.constructor is the standard built-in Object constructor.

Method	Signature	Description
toString	() => string	Returns a string representation of an object.
toLocaleString	() => string	Returns a date converted to a string using the current locale.
valueOf	() => Object	Returns the primitive value of the specified object.
hasOwnProperty	(v: PropertyKey) => boolean	Determines whether an object has a property with the specified name.
isPrototypeOf	(v: Object) => boolean	Determines whether an object exists in another object's prototype chain.
propertyIsEnumerable	(v: PropertyKey) => boolean	Determines whether a specified property is enumerable.

Function

Creates a new function.

Prop	Type
`prototype`	any
`length`	number
`arguments`	any
`caller`	Function

Method	Signature	Description
apply	(this: Function, thisArg: any, argArray?: any) => any	Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.
call	(this: Function, thisArg: any, ...argArray: any[]) => any	Calls a method of an object, substituting another object for the current object.
bind	(this: Function, thisArg: any, ...argArray: any[]) => any	For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.
toString	() => string	Returns a string representation of a function.

TARSDKWitAssetParams

Prop	Type
`assetId`	String
`assetParams`	Array<String>
`params`	TARSDKParams

Type Aliases

PropertyKey

string | number | symbol

Enums

TARSDKStartMode

Members
`Indoor`
`Geo`

capacitor plugin native

0.0.1

1 year ago