Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

??todo 1. Review text, check all options covered. 2. Request link from PhixFlow

...

Access the stream view attributes properties from the stream view → View Attributes section.

Insert excerpt
_standard_settings
_standard_settings
nopaneltrue

Basic Settings

FieldDescription
OrderThe order in which the attributes will appear in the view. For a grid view, this is the order of columns.
Name

The display name of the attribute in the view. By default, this is the same as the name of the attribute in the underlying stream.

Remember that if you are applying an Aggregate Function to the attribute, it is often useful to reflect that in the display name. For example: you are going to display the average monthly spend for each customer, by applying the aggregate function Average to the attribute CustSpend. You set the display name as CustSpendAverage.

Aggregate Function

You can specify an Aggregate Function on this attribute. As soon as you have specified a single aggregate attribute in your view, any other fields will be either aggregate attributes - if you also specify an aggregate function for them - or used as grouping attributes.

Role

This option is available if the view is a chart, i.e. not a data grid. This is the role that the field has in generating the chart.

You can set the role manually in the stream view attribute editor - but it is generally better to create charts using the visual editor. To do this:

  • drag your stream view into a dashboard
  • make sure you are in design mode
  • unlock the padlock in the view (if it is not already unlocked)

You will see a visual chart editor. You can drag stream attributes onto this editor to create your chart. See Pivot Views and Charts, below.

Double-click Actiontodo??
ActionSpecify a Stream Action for this Stream View Attribute. If this is a grid view then hovering the mouse over a cell a column created from this Stream View Attribute will cause a cog to appear. Clicking the cog select the row which contains the cell you have clicked, then will run this action.
Always Show The Action Icon

This check box is only available if an Action is specified.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
  to always display the action icon in read-only grid cells. The user can click anywhere in the cell to run the action.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to only display the action when the cell is in focus.

Hide the Input Field

This check box is only available if an Action is specified.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to hide the input field and to display the action icon in the column.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to display the input field in the column.

Hide the Action Icon

This check box is only available if an Action is specified.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to hide the action icon. The user can run the action by clicking anywhere in the cell. Do not tick this option for editable columns.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to display the action icon in the column.

Action Icon StyleThe style applied to the action icon. If no style is set, PhixFlow uses a default cog icon.
Stream Attribute Details

Name

The name of the underlying stream attribute.
TypeThe type of the underlying stream attribute. This cannot be edited here. It must be edited in the stream. See Stream.
Number Format

Available when the underlying stream attribute is Type Float, Integer or Decimal.

Specify the number format as it will be displayed on a grid or form; see Number Format.

Date/Time Format

Available when the underlying stream attribute is Type Date or Datetime.

Specify the format of a date/time as it will be displayed on a grid or form; see Date Time Format.

...

FieldDescription
Grid Default Width (pixels)Set the default width of the column for this attribute. PhixFlow will create the grid with default column widths - you only need to specify a value in this field if the width you want is different from this default.
Grid Minimum Default Width (pixels)If you do not specify a Grid Default Width then PhixFlow will set the size of the column depending on the space available.  If you set a Grid Minimum Default Width then PhixFlow will ensure that the column is at least this wide but will make it wider if there is available space.  You can still make the column narrower than this by manually shrinking it after the grid has first been displayed.  This field will be ignored if you set a specific Grid Default Width.
Label

An optional label for the resulting column header. If left blank, this is the Name of the stream view attribute, formatted with a space before each capital letter.

The label gives you more options for setting the column header - for example, control over the white space in the column heading - but you can also make this an expression. For example, to that the column contains transactions for the currently logged in user, you could use: 

Code Block
"Transactions for " + _user.username

For user pchevalier, this would give the column heading:

Code Block
Transactions for pchevalier

To use an expression in this field, tick the box Label is Expression.

Multi-level labels can be generated by configuring the Label to return a list of values.

Label is Expression
Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to set the Label using an expression.
Changes Row Colour
Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to change the row colour when the value in this field changes.
Always Hidden

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 hides this attribute's field on the view. This overrides  the result of the Hide if evalutes to True expression.  

Use this option when you need to include a field in a view for a filter or Action, but displaying it would make the view cluttered. 

Hide if evaluates to True

Enter an expression that determines whether or not the attribute's field is displayed on the view. When the  expression evaluates to true, then the field will be hidden.

When Always Hidden is ticked, the result of this expression is ignored.

Read Only

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to make this attribute read-only in the grid view.

Alignment

Set the alignment of values in this column to:

  • Left
  • Right
  • Centre

...