Vectors

Main / API Description

Namespace: Vectors

Important Functions

Register(name)

register window windowname(string) in Vectors

Unregister(name)

unregister window windowname(string) in Vectors

Complete API

AddProfile(name)

add profile name(string), returns true if profile was added, returns false if the profile already existed or an error occurred

DeleteProfile(name)

deletes profile name(string), returns true if succeeded

GetProfiles()

returns a list of possible profiles

GetActiveProfile()

returns the active profile

SwitchProfile(name)

switch to profile name(string) and load it, return {true|false} if switch was successful

LoadProfile()

apply current profile to all exsistent windows, return nothing

LoadWindow(data)

loads window from Vectors, data may be a window name (string) or vectors data table, returns nothing

ExportData(windows)

windows(table|string) can be string of a window or a numerical indexed list of windows, returns the Vectors dataset(s)

ImportData(imortdata)

in data(table) the Object is the data for this window or the name for a window you want to delete

MakeCopyFrom(profile,ratio)

makes a copy of profile(string)/ratio(number) into the current dataset

GetWindows()

returns all Windows(table), the object is a bool that displays if data is available for that window

GetRatios()

returns a table of all ratios that have data, the active one will be marked with true

CalcRatio()

returns current ratio(string)

TrimRatio(ratio)

harmonizes the given ratio(number), returns ratio(string)

CreateDataFromWindow(name)

reads out all data from the client about window name(string) and return a Vectors dataset

AddAnchor(name)

add a anchor for the window name(string), return nothing

DeleteAnchor(name,anchor)

delete anchor(number) on window name(string), returns true if succeeded

TickValue(name,valuename,factor)

name(string) of the windows,valuename(string) {"scale"|"minscale"},factor(number)

SetValue(name,valuename,value)

name(string) of the windows,valuename(string) {"scale"|"minscale"},value(number) between 0 and 10

GetAnchorsCount(name)

returns the number of anchors on window name(string)

TickAnchorValue(name,anchor,valuename,factor)

name(string) of the windows,anchor(number),valuename(string) {"x"|"y"},factor(number) 1=1pixel at current resolution

SetAnchorValue(name,anchor,valuename,value)

name(string) of the windows,anchor(number),valuename(string) {"x"|"y"|"parentwindow"|"point"|"parentpoint"},value(number) (between -1 and 1 for x,y)

Facts

Date created
Sep 18, 2010
Last updated
Mar 09, 2011

Author