CreateST

Definition

function ScrollingTable:CreateST(cols, numRows, rowHeight, highlight, parent)

Arguments

cols

This arg is expected to be an array of tables that contain information about each column.
Each column table in the cols array should have the following format:

{
    ["name"] = "Test 1",
    ["width"] = 50,
    ["align"] = "RIGHT",
    ["color"] = { 
        ["r"] = 0.5, 
        ["g"] = 0.5, 
        ["b"] = 1.0, 
        ["a"] = 1.0 
    },
    ["colorargs"] = nil,
    ["bgcolor"] = {
        ["r"] = 1.0, 
        ["g"] = 0.0, 
        ["b"] = 0.0, 
        ["a"] = 1.0 
    }, -- red backgrounds, eww!
    ["defaultsort"] = "dsc",
    ["sortnext"]= 4,
    ["comparesort"] = function (cella, cellb, column)
        return cella.value < cellb.value;
    end,
    ["DoCellUpdate"] = nil,
}

name

The name to use as the column header.

width

The width in pixels that the column should be drawn.

align

(Optional) Alignment of values in the column. Must be one of ( "LEFT" | "RIGHT" | "CENTER" ) Defaults to "LEFT".

color

(Optional) A color object. Defaults to white.

colorargs

(Opional) An array of args that will be passed to the function specified for color. See color object. Defaults to (data, cols, realrow, column, table)

bgcolor

(Optional) A color object. Defaults to clear. In other areas of lib-st, you will find that you can assign a function to return a color object instead. That is not the case with the bgcolor of a column.

defaultsort

(Optional) One of ( "asc" | "dsc" ). Defaults to "asc"

sortnext

(Optional) Must be a valid column number (lua indecies start at 1). Be careful with this value, you can chain across multiple columns, and get yourself into a circular loop.

comparesort

(Optional) A comparator function used to sort values that may not be easily sorted. ex. Dates... and stuff... Be sure to check for and call the comparator of the sortnext column if you wish to keep secondary column sort functionality. See the CompareSort method in Core.lua for an example.

DoCellUpdate

A custom display function.

numRows

This arg defines how many rows you wish the table to show.
If nil, it will default to 12.

rowHeight

This arg defines how tall each row will be.
If nil, it will default to 15.

highlight

This arg defines the color object for the row highlight to use as you mouse-over a row.
If nil, it will default to mostly-yellow:

{ 
    ["r"] = 1.0, 
    ["g"] = 0.9, 
    ["b"] = 0.0, 
    ["a"] = 0.5, -- important, you want to see your text!
}

In other areas of lib-st, you will find that you can assign a function to return a color object instead. That is not the case with the highlight of a column.

parent

This arg defines the frame that is to be used as the parent frame for the new scrolling table.
If nil, it will default to UIParent

Comments

_ForgeUser154100

Join Date: 12/5/2006
Posts: 5
Member Details

#1 Posted Jul 15, 2009

re colorargs

what are being passed in by default? specifically, I want to color cell data based on it's row's column 3.

can I do

["colorargs"] = {"row"}

and then, in the function, switch on

row.cols[3].value

or if not, how do I do it? :)

edit: I figured out the color arguments. you can't abstractly specify cell data at the column level. you have to do it when you create the table data's rows.
Basically, the usage is like:

--myAddon.lua
ST_data = {}
ST = ...CreateST...

--[[ convert internal data format to lib-st's format ]]--
function ST_ProcessData( int_data )
 --[[ for example if int_data represents a 2 col/3 row table, 
       and is {{"A1","A2"},{"B1","B2"},{"C1","C2"}}
       and we want to color code the first column based on the first column
]]--
  ST_data = {}
  for j,row in pairs(int_data)
    ST_data[j] = {}
    for k,col in pairs(row)
      if k == 1 then
        ST_data[j].cols[k] = { value=col, color= handle_ColorFunc, colorargs={col}}
      else
        ST_data[j].cols[k] = { value=col }
      end
    end
  end
end

function ST_Update( int_data )
  ST_ProcessData( int_data )
  ST:SetData(ST_data)
end

_ForgeUser154100

Join Date: 12/5/2006
Posts: 5
Member Details

#2 Posted Jul 16, 2009

I'm having a little trouble with the parent tag and AceGUI now. I have code like:

local grp = AceGUI:Create("SimpleGroup")
grp:SetLayout("Fill")
f:AddChild(grp)

this create a group frame in my f frame. Later, I build my ST frame and pass it to grp:

st = ScrollingTable:CreateST( columnHeaders )
st:EnableSelection(true)
st:SetWidth(470)
st:SetHeight(384)
grp:AddChild( st.frame )

Whe I run this, it doesn't work.

edi: after a lot of copy-pasting from AceGui internals, I got it working, mostly. Don't take this as a fix, it probably doesn't work completely, but here's what's gotten it to at least appear like a standard ace-gui widget:

	st.userdata = {}
	st.SetParent = function(self, parent)
		local frame = self.frame
		frame:SetParent(nil)
		frame:SetParent(parent.content)
		self.parent = parent
		--fixlevels(parent.frame,parent.frame:GetChildren())
	end

	st.SetWidth = function(self, width)
		self.frame:SetWidth(width)
		self.frame.width = width
		if self.OnWidthSet then
			self:OnWidthSet(width)
		end
	end

	st.SetHeight = function(self, height)
		self.frame:SetHeight(height)
		self.frame.height = height
		if self.OnHeightSet then
			self:OnHeightSet(height)
		end
	end

	st.IsVisible = function(self)
		return self.frame:IsVisible()
	end

	st.IsShown= function(self)
		return self.frame:IsShown()
	end
	
	st.SetDisabled = function(self, disabled)
		self.disabled = disabled
		if disabled then
			self.frame:Hide()
		else
			self.frame:Show()
		end
	end

	st.Release= function(self)
		local widget = self.frame
		for k in pairs(widget.userdata) do
			widget.userdata[k] = nil
		end
		for k in pairs(widget.events) do
			widget.events[k] = nil
		end
		widget.width = nil
		widget.relWidth = nil
		widget.height = nil
		widget.relHeight = nil
		widget.noAutoHeight = nil
		widget.frame:ClearAllPoints()
		widget.frame:Hide()
		widget.frame:SetParent(UIParent)
		widget.frame.width = nil
		widget.frame.height = nil
		if widget.content then
			widget.content.width = nil
			widget.content.height = nil
		end
		del(widget,widget.type)
	end
	
	st.Fire = function(self, name, ...)
		if self.events[name] then
			local success, ret = safecall(self.events[name], self, name, ...)
			if success then
				return ret
			end
		end
	end
	
	st.OnRelease= function (self)
		self.frame:ClearAllPoints()
		self.frame:Hide()
		self:SetDisabled(false)
	end

gooyit
- Join Date: 9/29/2008
- Posts: 55
- Member Details
#3 gooyit

View User Profile

Send Message

Posted Aug 23, 2009
I don't get subscription updates for comments to these pages. Please post comments on the main page, or make tickets for help if you still need it. thanks :)

Rollback Post to Revision RollBack
kfsone
- Join Date: 1/26/2009
- Posts: 1
- Member Details
#4 kfsone

View User Profile

Send Message

Posted Nov 23, 2009
Would be really helpful to have an example of popping up a simple table into a simple AceGUI frame... local gui = LibStub("AceGUI-3.0") local con = LibStub("AceConsole-3.0") local libst = LibStub("ScrollingTable") local profFrame = gui:Create("Frame") profFrame:SetLayout("Fill") local table = libst:CreateST(nil, nil, nil, nil, profFrame) Gives "CreateFrame: Couldn't find 'this' in parent object" (I was trying to get the test table into a frame of my own making)

Last edited by kfsone: Nov 23, 2009

Rollback Post to Revision RollBack
Forge_User_03696397
- Join Date: 10/28/2018
- Posts: 9
- Member Details
#5 Forge_User_03696397

View User Profile

Send Message

Posted Oct 28, 2018
WARNING: The `parent` property is useless. The library defaults to showing the table in the center of UIParent (there's a line where the library runs SetPoint relative to UIParent). But you can quite easily make it work!

Run `local yourScrollingTableName = CreateST(your args here)` and give your GUI's frame as the parent.

After that, run `yourScrollingTableName.frame:SetPoint(your args here)` to change the "relative position" of the scrollingtable-frame, relative to any UI element you want, such as a button within your GUI!

You can also use this technique to customize other parts of the overall frame. Such as SetBackdrop and SetBackdropColor, and any other functions you are able to call on frames!

Now, your initialization/setup is complete!

After that setup process, just `:Show()` and `:Hide()` the table as usual from then on...
Rollback Post to Revision RollBack
actually_a_beagle
- Join Date: 5/11/2020
- Posts: 1
- Member Details
#6 actually_a_beagle

View User Profile

Send Message

Posted May 10, 2020
In reply to Forge_User_03696397:

Thanks for pointing this out! I was getting so frustrated trying to figure out why this wasn't working... then I tried Ctrl+F "parent" on this page and found your comment. Even though it's been a couple years, I submitted this PR to get it fixed. Never too late, right?

Last edited by actually_a_beagle: May 10, 2020

Rollback Post to Revision RollBack
To post a comment, please login or register a new account.

WowAce

lib-ScrollingTable

Addons

Pages

Table of Contents