StyleBI Documentation

InetSoftUserDocumentation

    • Connect to Your Data
      • Connect to a Specific Data Source
        • 42Matters
        • Actian
        • ActiveCampaign
        • Aerospike
        • Airtable
        • Amazon Aurora MySQL
        • Amazon Aurora PostgreSQL
        • Apache Drill
        • Apache Hive
        • Appfigures
        • Asana
        • Aster Data nCluster
        • AWS EMR
        • AWS Redshift
        • Azure Blob
        • Azure Search
        • Campaign Monitor
        • Cassandra
        • Chargebee
        • Chargify
        • ChartMogul
        • Cisco Info Server
        • ClickHouse
        • Constant Contact
        • Copper
        • Clockify
        • Databricks
        • Data.Gov JSON
        • data.world
        • DB2
        • Derby
        • Derby Embedded
        • Dremio
        • Elasticsearch REST
        • Exasol
        • Facebook Ad Insights
        • Facebook Page Insights
        • FileMaker
        • Firebase
        • Freshdesk
        • Freshsales
        • Freshservice
        • Github
        • GitLab
        • Google Analytics GA4
        • Google BigQuery
        • Google Calendar
        • Google Cloud SQL
        • Google Search Console
        • Google Spreadsheets
        • GoSquared
        • GraphQL
        • Harvest
        • Help Scout Docs
        • HPCC
        • HubSpot
        • IBM AS400
        • Impala
        • InfluxDB
        • Informix
        • Ingres
        • Insightly
        • Intervals
        • JDBC
        • Jira
        • Jive
        • jTDS
        • Keap
        • Lighthouse
        • Linkedin
        • LiveAgent
        • LucidDB
        • Mailchimp
        • MapR
        • MariaDB
        • MemSQL
        • Microsoft Access
        • Mixpanel
        • monday.com
        • MonetDB
        • MongoDB REST
        • MySQL
        • Netezza
        • Nicereply
        • OData
        • OneDrive
        • Oracle
        • OrientDB
        • Phoenix
        • Pipedrive
        • Pipeline CRM
        • Pivotal (EMC) Greenplum
        • PostgreSQL
        • Presto
        • Progress OpenEdge
        • Prometheus
        • Quickbooks Reports
        • R
        • REST JSON
        • REST XML
        • Salesforce
        • Salesforce Reports and Dashboards
        • SAP
        • SAP Hana
        • SEOmonitor
        • ServiceNow
        • SharePoint Online
        • Shopify
        • Siebel CRM
        • Smartsheet
        • Snowflake
        • SQL Anywhere
        • SQL Server
        • SQL Server Express
        • SQLite
        • Square
        • Stripe
        • SurveyMonkey
        • TeamDesk
        • Teradata
        • Text/Excel Directory
        • Toggl
        • Twilio
        • Twilio SendGrid
        • Twitter (X)
        • Vertica
        • WordPress
        • Xero
        • YouTube Analytics
        • Zendesk
        • Zendesk Sell
        • ZohoCRM
      • Organize Data Sources
      • Edit a Connection
      • Add an Additional Connection
      • Configure Connection Pool
      • Add Data Security (VPM)
        • Create a New VPM
        • Create a Condition
        • Create a Hidden Column
        • Add a Condition Trigger
        • Add a Hidden Column Trigger
        • Add a Lookup Trigger
        • Test a VPM
        • Filter Unparsable Queries
    • Prepare Your Data
      • Do You Need a Data Model?
        • Physical View
          • Create a Physical View
          • Edit a Physical View
          • Extend a Physical View
        • Logical Model
          • Create a Logical Model
          • Edit a Logical Model
          • Extend a Logical Model
      • Create a Data Worksheet
      • Edit a Data Worksheet
      • Upload Data
      • Enter Data
      • Query Data
      • Mashup Data
      • Modify a Column
      • Filter Data
      • Group and Aggregate Data
      • Copy Data
      • Join Data
      • Concatenate Data
      • Sort Data
      • Preview Data
      • Preview Query
      • Create a New Data Field
      • Access Data in Expression
      • Create a New Variable
      • Pivot Data
      • Secure Data
      • Data Block Properties
      • Data Worksheet Properties
      • Query a Specific Data Source
        • 42Matters Query
        • ActiveCampaign Query
        • Airtable Query
        • Appfigures Query
        • Asana Query
        • Azure Blob Query
        • Azure Search Query
        • Campaign Monitor Query
        • Cassandra Query
        • Chargebee Query
        • Chargify Query
        • ChartMogul Query
        • Clockify Query
        • Constant Contact Query
        • Copper Query
        • Data.Gov JSON Query
        • data.world Query
        • Elasticsearch REST Query
        • Facebook Ad Insights Query
        • Facebook Page Insights Query
        • Firebase Query
        • Freshdesk Query
        • Freshsales Query
        • Freshservice Query
        • Github Query
        • GitLab Query
        • Google Analytics GA4 Query
        • Google Calendar Query
        • Google Search Console Query
        • Google Spreadsheets Query
        • GoSquared Query
        • GraphQL Query
        • Harvest Query
        • Help Scout Docs Query
        • Hive Query
        • HubSpot Query
        • InfluxDB Query
        • Insightly Query
        • Intervals Query
        • JDBC Query
        • Jira Query
        • Jive Query
        • Keap Query
        • Lighthouse Query
        • Linkedin Query
        • LiveAgent Query
        • Mailchimp Query
        • Mixpanel Query
        • monday.com Query
        • MongoDB REST Query
        • Nicereply Query
        • OData Query
        • One Drive Query
        • Pipedrive Query
        • Pipeline CRM Query
        • Prometheus Query
        • Quickbooks Reports Query
        • R Query
        • REST JSON Query
        • REST XML Query
        • Salesforce Query
        • Salesforce Reports and Dashboards Query
        • SAP Query
        • SEOmonitor Query
        • ServiceNow Query
        • SharePoint Online Query
        • Shopify Query
        • Smartsheet Query
        • Square Query
        • Stripe Query
        • SurveyMonkey Query
        • TeamDesk Query
        • Text/Excel Directory Query
        • Toggl Query
        • Twilio Query
        • Twilio SendGrid Query
        • Twitter Query
        • WordPress Query
        • Xero Query
        • YouTube Analytics Query
        • Zendesk Query
        • Zendesk Sell Query
        • ZohoCRM Query
    • Visualize Your Data
      • Create a New Dashboard
      • Edit a Dashboard
      • Add Components
      • Arrange Components
      • Create a Chart
        • Basic Charting Steps
        • Group Data by Dimension
        • Trend and Compare Data
        • Add a Target Line/Curve Fit
        • End-User Chart Control
        • Chart Types
          • Area Chart
          • Bar Chart
          • Box Chart
          • Bubble Chart
          • Candle Chart
          • Circle Packing Chart
          • Circular Network Chart
          • Contour Map Chart
          • Dot Plot Chart
          • Donut Chart
          • Dual Axis Chart
          • Funnel Chart
          • Gantt Chart
          • Heat Map Chart
          • Hybrid Table Chart
          • Icicle Chart
          • Interval Chart
          • Jump Line Chart
          • Line Chart
          • Map Chart
          • Marimekko Chart
          • Multiple Measure Chart
          • Multiple Style Chart
          • Network Chart
          • Pareto Chart
          • Pie Chart
          • Point Chart
          • Percent Change Chart
          • Radar Chart
          • Running Total Chart
          • Scatter Chart
          • Scatter Contour Chart
          • Scatter Matrix Chart
          • Sliding Window Chart
          • Step Area Chart
          • Step Line Chart
          • Stock Chart
          • Sunburst Chart
          • Tree Chart
          • Treemap Chart
          • Trellis Chart (Grid)
          • Waterfall Chart
          • Word Cloud Chart
      • Create a Table
      • Create a Crosstab
      • Create a Freehand Table
      • Create a Table Style
      • Compare Data by Date
      • Add a KPI
      • Drill Down into Data
      • Filter a Dashboard
        • Add Filter Components
        • Filter Aggregated Data
        • Filter Top or Bottom Groups
        • Add Conditions
      • Sort Data
      • Dynamically Set Properties
      • Write Back to Storage
      • Improve Performance
      • Enhance a Visualization
        • Add Visual Format
        • Add Data Format
        • Add Conditional Format (Highlight)
        • Add Tips to a Chart
        • Add Text or HTML
        • Add Background
        • Embed External Content
    • Configure Self-Service
    • Publish a Dashboard
      • Create a Device Layout
      • Modularize a Dashboard
      • Localize a Dashboard
    • Dashboard Reference
      • Dashboard Options
      • Visual Composer Console
      • Visual Composer Search
      • Visual Composer Toolbar
      • Keyboard Navigation
      • Common Properties
        • General Tab
        • Data Tab
        • Advanced Tab
        • Script Tab
      • Nested Dashboard Properties
      • Calendar Properties
      • Chart Properties
      • Legend Properties
      • Axis Properties
      • Axis Title Properties
      • Container Properties
      • Crosstab Properties
      • Freehand Table Properties
      • Gauge Properties
      • Image Properties
      • Radio Button/Check Box/Combo Box Properties
      • Range Slider Properties
      • Selection Container Properties
      • Selection List Properties
      • Selection Tree Properties
      • Shape Properties
      • Slider/Spinner Properties
      • Submit Button Properties
      • Tabbed Interface Properties
      • Table Properties
      • Text Properties
      • TextInput Properties
    • Advanced Dashboard Scripting
      • Introduction to Programming
      • Add Script to a Dashboard
      • Create a Custom Function
      • Access Component Data
      • Access Datasource Data
      • Run a Query from Script
      • Reference Query Data
      • Special Freehand Table Functions
      • Change Images with Script
      • Dashboard Object Reference
        • Dashboard
          • isActionVisible(name)
          • setActionVisible(name,Boolean)
          • parameter
          • setInputSelectedObject()
          • thisParameter
          • thisViewsheet
            • isActionVisible()
            • scheduleAction()
            • setActionVisible()
            • taskName
            • updateTime
            • viewsheetAlias
            • viewsheetName
            • viewsheetPath
        • Special Purpose Functions
          • addImage()
          • alert()
          • appendRow()
          • confirm()
          • event
          • isCancelled()
          • pviewsheet
          • refreshData()
          • saveWorksheet()
          • viewsheetPath
          • viewsheetUser
        • Common Properties
          • alignment
          • alpha
          • background
          • borderColors
          • borders
          • dataConditions
          • enabled
          • exportFormat
          • font
          • foreground
          • format
          • formatSpec
          • position
          • refreshAfterSubmit
          • scaledPosition
          • scaledSize
          • selectedLabel
          • selectedLabels
          • selectedObject
          • selectedObjects
          • size
          • title
          • titleVisible
          • visible
          • wrapping
        • Calendar
          • daySelection
          • doubleCalendar
          • dropdown
          • fields
          • isActionVisible()
          • max
          • min
          • period
          • queries
          • query
          • setActionVisible()
          • singleSelection
          • submitOnChange
          • weekFormat
          • yearView
        • Chart
          • General
            • getTextID()
            • graph
            • query
            • setHyperlink()
            • setTextID()
            • setupGoogleMapsPlot()
            • xAxis
            • yAxis
            • y2Axis
            • colorField
            • combinedTooltip
            • data
            • drillEnabled
            • flyOnClick
            • flyoverViews
            • glossyEffect
            • highlighted
            • isActionVisible()
            • padding
            • separatedStyle
            • setActionVisible()
            • singleStyle
            • sortOthersLast
            • tipAlpha
            • tipView
            • title
            • toolTip
            • toolTipVisible
          • Chart Axis Properties
            • axis.font
            • axis.format
            • axis.increment
            • axis.labelColor
            • axis.labelVisible
            • axis.lineColor
            • axis.lineVisible
            • axis.logarithmic
            • axis.maximum
            • axis.minimum
            • axis.minorIncrement
            • axis.noNull
            • axis.reversed
            • axis.rotation
            • axis.setLabelAlias()
            • axis.sharedRange
            • axis.ticksVisible
            • axis.truncate
          • Measure Axis Properties
            • axis.increment
            • axis.logarithmic
            • axis.maximum
            • axis.minimum
            • axis.minorIncrement
            • axis.reversed
            • axis.sharedRange
          • Axis Title Properties
            • xTitle.color
            • xTitle.font
            • xTitle.rotation
            • xTitle.text
            • xTitle.visible
            • x2Title.color
            • x2Title.font
            • x2Title.rotation
            • x2Title.text
            • x2Title.visible
            • yTitle.color
            • yTitle.font
            • yTitle.rotation
            • yTitle.text
            • yTitle.visible
            • y2Title.color
            • y2Title.font
            • y2Title.rotation
            • y2Title.text
            • y2Title.visible
            • x2Title.font
            • x2Title.rotation
            • x2Title.text
            • x2Title.visible
            • yTitle.color
            • yTitle.font
            • yTitle.rotation
            • yTitle.text
            • yTitle.visible
          • Plot Properties
            • addConfidenceIntervalTarget()
            • addPercentageTarget()
            • addPercentileTarget()
            • addQuantileTarget()
            • addStandardDeviationTarget()
            • addTargetBand()
            • addTargetLine()
            • applyEffect
            • chartStyle
            • clearTargets()
            • colorField
            • colorLegend.color
            • colorLegend.font
            • colorLegend.format
            • colorLegend.noNull
            • colorLegend.title
            • colorLegend.titleVisible
            • colorLegends.color
            • colorLegends.font
            • colorLegends.format
            • colorLegends.noNull
            • colorLegends.title
            • colorLegends.titleVisible
            • contourBandwidth
            • contourCellSize
            • contourEdgeAlpha
            • contourLevels
            • dateComparisonEnabled
            • diagonalColor
            • diagonalStyle
            • facetGrid
            • facetGridColor
            • fillGapWithDash
            • fillTimeGap
            • fillZero
            • geoFields
            • glossyEffect
            • includeParentLabels
            • inPlot
            • legendBorder
            • legendBorderColor
            • legendPosition
            • legendTitleColor
            • legendTitleFont
            • mapDefaultColor
            • mapType
            • oneLine
            • panX
            • panY
            • paretoLineColor
            • pieExploded
            • pieRatio
            • plotAlpha
            • plotBackground
            • pointLine
            • projectTrendLineForward
            • quadrantColor
            • quadrantStyle
            • rankPerGroup
            • referenceLineVisible
            • setLabelAliasOfColorLegend()
            • setLabelAliasOfShapeLegend()
            • setLabelAliasOfSizeLegend()
            • setTrendLineExcludedMeasures()
            • shapeField
            • shapeLegend.color
            • shapeLegend.font
            • shapeLegend.format
            • shapeLegend.noNull
            • shapeLegend.title
            • shapeLegend.titleVisible
            • shapeLegends.color
            • shapeLegends.font
            • shapeLegends.format
            • shapeLegends.noNull
            • shapeLegends.title
            • shapeLegends.titleVisible
            • sizeField
            • sizeLegend.color
            • sizeLegend.font
            • sizeLegend.format
            • sizeLegend.noNull
            • sizeLegend.title
            • sizeLegend.titleVisible
            • sizeLegends.color
            • sizeLegends.font
            • sizeLegends.format
            • sizeLegends.noNull
            • sizeLegends.title
            • sizeLegends.titleVisible
            • stackMeasures
            • stackValue
            • textField
            • trendLine
            • trendLineColor
            • trendLineStyle
            • trendPerColor
            • valueColor
            • valueFont
            • valueFormat
            • valueFormats
            • valueRotation
            • valueVisible
            • webMap
            • webMapStyle
            • wordCloudFontScale
            • xBandColor
            • xBandSize
            • xFields
            • xGridColor
            • xGridStyle
            • yBandColor
            • yBandSize
            • yFields
            • yGridColor
            • yGridStyle
            • zoom
            • zoomLevel
          • bindingInfo
            • addMapping()
            • breakdownFields
            • colorFrame
            • colors
            • geoFields
            • getCandleBindingField()
            • getColorField()
            • getColumnOrder()
            • getFormula()
            • getGroupOrder()
            • getMapLayer()
            • removeMapping()
            • getPercentageType()
            • getSecondaryField()
            • getShapeField()
            • getSizeField()
            • getStockBindingField()
            • getTextField()
            • getTopN()
            • getTopNSummaryCol()
            • isDiscrete()
            • isTimeSeries()
            • isTopNReverse()
            • lineFrame
            • lines
            • pathField
            • getMappings()
            • setCandleBindingField()
            • setColorField()
            • setColumnOrder()
            • setDiscrete()
            • setFormula()
            • setGroupOrder()
            • setMapLayer()
            • setPercentageType()
            • setSecondaryField()
            • setShapeField()
            • setSizeField()
            • setStockBindingField()
            • setTextField()
            • setTimeSeries()
            • setTopN()
            • setTopNReverse()
            • setTopNSummaryCol()
            • shapeFrame
            • shapes
            • sizes
            • sizeFrame
            • textFrame
            • textureFrame
            • textures
            • xFields
            • yFields
        • CheckBox, Radio Button, ComboBox
          • datatype
          • embeddedDataOnBottom
          • labels
          • maxDate
          • minDate
          • selectFirstItemOnLoad
          • serverTimeZone
          • sortByValue
          • sortType
          • submitOnChange
          • value
          • values
        • Crosstab
          • bindingInfo
            • colFields()
            • getColumnOrder()
            • getFormula()
            • getGroupOrder()
            • getGroupTotal()
            • getPercentageType()
            • getTopN()
            • getTopNSummaryCol()
            • isGroupOthers()
            • isTimeSeries()
            • isTopNReverse()
            • measureFields
            • percentageMode
            • rowFields
            • setColumnOrder()
            • setFormula()
            • setGroupOrder()
            • setGroupOthers()
            • setGroupTotal()
            • setPercentageType()
            • setTimeSeries()
            • setTopN()
            • setTopNReverse()
            • setTopNSummaryCol()
            • showColumnTotal
            • showRowTotal
          • computeTrendAndComparisonForTotals
          • sortOthersLast
          • drillEnabled
          • fillBlankWithZero
          • isActionVisible()
          • mergeSpan
          • query
          • setActionVisible()
          • summarySideBySide
        • Freehand Table
          • fillBlankWithZero
          • keepRowHeightOnPrint
          • layoutInfo
            • setCellBinding()
            • setCellName()
            • setColGroup()
            • setExpansion()
            • setMergeCells()
            • setMergeColGroup()
            • setMergeRowGroup()
            • setRowGroup()
            • setSpan()
          • sortOthersLast
        • Gauge
          • fields
          • formula
          • hyperlink
          • labelVisible
          • majorInc
          • max
          • min
          • minorInc
          • query
          • rangeColors
          • rangeGradient
          • ranges
          • shadow
          • toolTip
          • toolTipVisible
          • value
          • valueFillColor
        • Image
          • animate
          • highlighted()
          • hyperlink
          • image
          • imageAlpha
          • maintainAspectRatio
          • popAlpha
          • popComponent
          • popLocation
          • scale9
          • scaleImage
          • shadow
          • tile
          • toolTip
          • toolTipVisible
          • value
        • Line
          • beginArrowStyle
          • endArrowStyle
          • lineStyle
        • Oval
          • gradientColor
          • lineStyle
          • shadow
        • Range Slider
          • composite
          • currentVisible
          • fields
          • isActionVisible()
          • length
          • logScale
          • max
          • maxRangeSize
          • maxVisible
          • min
          • minVisible
          • queries
          • query
          • rangeMax
          • rangeMin
          • rangeSize
          • rangeType
          • setActionVisible()
          • tickVisible
          • upperInclusive
        • Rectangle
          • gradientColor
          • lineStyle
          • roundCorner
          • shadow
        • Selection Container
          • adhocEnabled
          • empty
          • isActionVisible()
          • setActionVisible()
          • showCurrentSelection
        • Selection List and Tree
          • drillMember
          • drillMembers
          • dropdown
          • expandAll
          • fields
          • formula
          • isActionVisible()
          • measure
          • query
          • queries
          • selectFirstItemOnLoad
          • setActionVisible()
          • showBar
          • showText
          • singleSelection
          • singleSelectionLevels
          • suppressBlank
          • sortType
          • submitOnChange
          • value
        • Slider
          • currentVisible
          • increment
          • labelVisible
          • max
          • maxVisible
          • min
          • minVisible
          • snap
          • submitOnChange
          • tickVisible
        • Spinner
          • increment
          • max
          • min
          • submitOnChange
        • Submit Button
        • Tabbed Interface
          • labels
          • selectedIndex
        • Table
          • appendRow()
          • applyChanges()
          • col
          • cellFormat
          • commit()
          • colFormat
          • data
            • data.length
            • data.size
          • del
          • deleteRow()
          • edit
          • field
          • fields
          • flyOnClick
          • flyoverViews()
          • form
          • getFormRow()
          • getFormRows()
          • getHiddenColumnValue()
          • highlighted()
          • insert
          • insertRow()
          • isActionVisible()
          • keepRowHeightOnPrint
          • query
          • row
          • setActionVisible()
          • setCellValue()
          • setColumnWidth()
          • setColumnWidthAll()
          • setHyperlink()
          • setObject()
          • setPresenter()
          • setRowHeight()
          • shrink
          • table
            • table.length
            • table.size
          • tableLens
          • tableStyle
          • tipAlpha
          • tipView
          • value
        • Text
          • autoSize
          • embedAsURL
          • fields
          • formula
          • highlighted
          • hyperlink
          • popAlpha
          • popComponent
          • popLocation
          • query
          • scaleVertical
          • setPresenter
          • shadow
          • text
          • toolTip
          • toolTipVisible
          • value
        • TextInput
          • defaultText
          • placeholderText
          • submitOnChange
          • value
    • Installation
    • Manage the Server
      • Set Container Memory
      • Get Started with Enterprise Manager
        • Launch Enterprise Manager
        • Change Password
        • Navigate Enterprise Manager
        • Configuration Directory
        • Import and Export Assets
      • Configure Security
        • Specify Security Provider
        • Enable Multi-Tenancy
        • Enable Self-Signup
        • Create a User
        • Create a Group
        • Create a Role
        • Create an Organization
        • Login as Different User
        • Set Repository Permissions
        • Set Security Actions
        • Configure LDAP Security
        • Configure Database Security
        • Configure Custom Security
      • Schedule
        • Start the Scheduler
        • Create a Task, Cycle, or Alert
        • Scheduler Conditions
        • Scheduler Actions
        • Configure the Scheduler
      • Advanced Topics
        • Server Environment
          • Broadcast a Message
          • Administer License Keys
          • Administer API Key
          • Configure Server Email
          • Localization
            • Register a Locale
            • Localize the User Portal
            • Localize a Dashboard
            • Localize a Data Source
          • Define Number Formats
          • Tailor Performance
          • Monitor Server Activity
        • Storage
        • Repository
        • Audit
        • Cache
        • Materialized View
        • Presentation
        • Style with CSS
          • Create a CSS File
          • Upload a CSS File
          • CSS Properties
          • CSS Dashboard Regions
          • CSS Table Style
          • Example CSS File
        • Logging
        • All Properties
        • Create a Custom Map
        • Create a D3 Chart
        • Accessibility Compliance
      • Automate Admin Tasks
        • Groovy DSL Framework
        • Connect to a Repository
        • Manage Data Sources
        • Manage Physical Views
        • Manage Logical Models
        • Manage Data Worksheets
        • Manage Dashboards
        • Manage Content
        • Set Up Server
        • Manage Scheduled Tasks
        • Manage Scheduled Cycles
        • Manage Security
    • Advanced Server Integration
      • Change the Webapp Port
      • Integrate with Webapp
        • Configure Single Sign-On
        • Configure Security Provider
        • Load Assets via URL
        • Customize Portal Login
        • Customize Server Update
      • Data Access for Multi-tenancy
      • Access InetSoft API Methods
      • Access the User Session
      • Common Portal Frameworks
    • User Functions
      • Java Objects (LiveConnect)
      • Style Constant
        • Date Grouping Level
        • Alignment
        • Data Type
        • Chart Style
        • Line Style
        • Summarization Formula
        • Point Shape
      • Global Object Functions
        • decodeURI()
        • encodeURI()
        • eval()
        • formatNumber()
        • getImage()
        • importClass()
        • importPackage()
        • indexOf()
        • inGroups()
        • isNull(object)
        • log()
        • newInstance()
        • parseFloat()
        • parseInt()
        • registerPackage()
        • runQuery()
        • toList()
        • undefined
      • String Object Functions
        • charAt()
        • charCodeAt()
        • concat()
        • indexOf()
        • lastIndexOf()
        • length
        • localeCompare()
        • ltrim()
        • match()
        • replace()
        • rtrim()
        • search()
        • slice()
        • split()
        • subString()
        • toLocaleUpperCase()
        • toLowerCase()
        • toUpperCase()
        • trim()
      • Number Object Functions
        • isNumber()
        • numberToString()
        • toExponential()
        • toFixed()
        • toLocaleString()
        • toPrecision()
        • toString()
      • Date Global Functions
        • dateAdd()
        • dateDiff()
        • datePart()
        • formatDate()
        • isDate()
        • parseDate()
      • Date Object Functions
        • Date()
        • Date.UTC()
        • Date.getDate()
        • Date.getDay()
        • Date.getFullYear()
        • Date.getHours()
        • Date.getTime()
        • Date.getTimezoneOffset()
        • Date.getMilliseconds()
        • Date.getMinutes()
        • Date.getMonth()
        • Date.getSeconds()
        • Date.getUTCDate()
        • Date.getUTCDay()
        • Date.getUTCFullYear()
        • Date.getUTCHours()
        • Date.getUTCMilliseconds()
        • Date.getUTCMinutes()
        • Date.getUTCMonth()
        • Date.getUTCSeconds()
        • Date.parse()
        • Date.toDateString()
        • Date.toLocaleString()
        • Date.toString()
        • Date.toTimeString()
        • Date.toLocaleDateString()
        • Date.toLocaleTimeString()
        • Date.toUTCString()
        • Date.setDate()
        • Date.setFullYear()
        • Date.setHours()
        • Date.setTime()
        • Date.setMilliseconds()
        • Date.setMinutes()
        • Date.setMonth()
        • Date.setSeconds(value)
        • Date.setUTCDate()
        • Date.setUTCFullYear()
        • Date.setUTCHours()
        • Date.setUTCMonth()
        • Date.setUTCMilliseconds()
        • Date.setUTCMinutes()
        • Date.setUTCSeconds()
        • Date.valueOf()
      • Array Object Functions
        • Array.concat()
        • Array.join()
        • Array.pop()
        • Array.push()
        • Array.reverse()
        • Array.shift()
        • Array.slice()
        • Array.sort()
        • Array.splice()
        • Array.unshift()
      • Math Object Functions
        • Math.abs()
        • Math.acos()
        • Math.asin()
        • Math.atan()
        • Math.ceil()
        • Math.cos()
        • Math.exp()
        • Math.floor()
        • Math.log()
        • Math.max()
        • Math.min()
        • Math.pow()
        • Math.random()
        • Math.round()
        • Math.sin()
        • Math.sqrt()
        • Math.tan()
      • CALC Object Functions
        • Date and Time Functions
          • CALC.datevalue()
          • CALC.day()
          • CALC.days360()
          • CALC.edate()
          • CALC.eomonth()
          • CALC.fiscalyear()
          • CALC.fiscalyear445()
          • CALC.fiscalyear454()
          • CALC.fiscalyear544()
          • CALC.fiscalquarter()
          • CALC.fiscalquarter445()
          • CALC.fiscalquarter454()
          • CALC.fiscalquarter544()
          • CALC.fiscalmonth()
          • CALC.fiscalmonth445()
          • CALC.fiscalmonth454()
          • CALC.fiscalmonth544()
          • CALC.fiscalweek()
          • CALC.fiscalweek445()
          • CALC.fiscalweek454()
          • CALC.fiscalweek544()
          • CALC.hour()
          • CALC.minute()
          • CALC.month()
          • CALC.monthname()
          • CALC.networkdays()
          • CALC.now()
          • CALC.quarter()
          • CALC.second()
          • CALC.time()
          • CALC.timeValue()
          • CALC.today()
          • CALC.weekday()
          • CALC.weekdayname()
          • CALC.weeknum()
          • CALC.workday()
          • CALC.year()
          • CALC.yearfrac()
        • Financial Functions
          • CALC.accrint()
          • CALC.accrintm()
          • CALC.amordegrc()
          • CALC.amorlinc()
          • CALC.coupdaybs()
          • CALC.coupdays()
          • CALC.coupdaysnc()
          • CALC.coupncd()
          • CALC.coupnum()
          • CALC.couppcd()
          • CALC.cumipmt()
          • CALC.cumprinc()
          • CALC.db()
          • CALC.ddb()
          • CALC.disc()
          • CALC.duration()
          • CALC.effect()
          • CALC.fv()
          • CALC.fvschedule()
          • CALC.intrate()
          • CALC.ipmt()
          • CALC.ispmt()
          • CALC.mduration()
          • CALC.mirr()
          • CALC.nominal()
          • CALC.nper()
          • CALC.npv()
          • CALC.pmt()
          • CALC.ppmt()
          • CALC.price()
          • CALC.pricedisc()
          • CALC.pricemat()
          • CALC.pv()
          • CALC.received()
          • CALC.sln()
          • CALC.syd()
          • CALC.tbilleq()
          • CALC.tbillprice()
          • CALC.tbillyield()
          • CALC.vdb()
          • CALC.xirr()
          • CALC.xnpv()
          • CALC.yielddisc()
          • CALC.yieldmat()
        • Logical Functions
          • CALC.and()
          • CALC.iif()
          • CALC.not()
          • CALC.or()
        • Math Functions
          • CALC.abs()
          • CALC.acos()
          • CALC.acosh()
          • CALC.asin()
          • CALC.asinh()
          • CALC.atan()
          • CALC.atan2()
          • CALC.atanh()
          • CALC.ceiling()
          • CALC.combin()
          • CALC.cos()
          • CALC.cosh()
          • CALC.degrees()
          • CALC.even()
          • CALC.exp()
          • CALC.fact()
          • CALC.factdouble()
          • CALC.floor()
          • CALC.gcd()
          • CALC.int()
          • CALC.lcm()
          • CALC.ln()
          • CALC.log()
          • CALC.log10()
          • CALC.mdeterm()
          • CALC.minverse()
          • CALC.mmult()
          • CALC.mod()
          • CALC.mround()
          • CALC.multinomial()
          • CALC.odd()
          • CALC.pi()
          • CALC.power()
          • CALC.product()
          • CALC.quotient()
          • CALC.radians()
          • CALC.roman()
          • CALC.round()
          • CALC.rounddown()
          • CALC.roundup()
          • CALC.seriessum()
          • CALC.sign()
          • CALC.sin()
          • CALC.sinh()
          • CALC.sqrt()
          • CALC.sqrtpi()
          • CALC.subtotal()
          • CALC.sum()
          • CALC.sumif()
          • CALC.sumproduct()
          • CALC.sumsq()
          • CALC.sumx2my2()
          • CALC.sumx2py2()
          • CALC.sumxmy2()
          • CALC.tan()
          • CALC.tanh()
          • CALC.trunc()
        • Statistical Functions
          • CALC.avedev()
          • CALC.average()
          • CALC.averagea()
          • CALC.binomdist()
          • CALC.correl()
          • CALC.count()
          • CALC.counta()
          • CALC.countblank()
          • CALC.countDistinct()
          • CALC.countn()
          • CALC.countif()
          • CALC.covar()
          • CALC.devsq()
          • CALC.expondist()
          • CALC.fisher()
          • CALC.fisherinv()
          • CALC.forecast()
          • CALC.frequency()
          • CALC.geomean()
          • CALC.harmean()
          • CALC.hypgeomdist()
          • CALC.intercept()
          • CALC.kurt()
          • CALC.large()
          • CALC.max()
          • CALC.maxa()
          • CALC.median()
          • CALC.min()
          • CALC.mina()
          • CALC.mode()
          • CALC.negbinomdist()
          • CALC.nthlargest()
          • CALC.nthmostfrequent()
          • CALC.nthsmallest()
          • CALC.pearson()
          • CALC.percentile()
          • CALC.percentrank()
          • CALC.permut()
          • CALC.poisson()
          • CALC.prob()
          • CALC.pthpercentile()
          • CALC.quartile()
          • CALC.rand()
          • CALC.randbetween()
          • CALC.rank()
          • CALC.rsq()
          • CALC.skew()
          • CALC.slope()
          • CALC.small()
          • CALC.standardize()
          • CALC.stdev()
          • CALC.stdeva()
          • CALC.stdevp()
          • CALC.stdevpa()
          • CALC.steyx()
          • CALC.trimmean()
          • CALC.varn()
          • CALC.vara()
          • CALC.varp()
          • CALC.varpa()
          • CALC.weibull()
          • CALC.weightedavg()
        • Text Functions
          • CALC.char()
          • CALC.code()
          • CALC.concatenate()
          • CALC.dollar()
          • CALC.exact()
          • CALC.find()
          • CALC.fixed()
          • CALC.left()
          • CALC.len()
          • CALC.lower()
          • CALC.mid()
          • CALC.proper()
          • CALC.replace()
          • CALC.rept()
          • CALC.right()
          • CALC.search()
          • CALC.substitute()
          • CALC.t()
          • CALC.text()
          • CALC.trim()
          • CALC.upper()
          • CALC.value()
      • Regex Functions
        • exec()
        • test()
        • toString()
    • Chart Script Tutorial
      • Modify Chart Properties
      • Modify Chart Data Binding
      • Modify Chart Element
      • Create a Chart with API
      • Bind Data to Chart in Script
      • Access Chart Data
      • Change Chart Coordinates
      • Change Chart Labels
      • Change Chart Scaling
      • Change Chart Element Appearance
      • Change Axis Properties
      • Change Legend Properties
      • Represent Data with Shape, Color, Size
      • Represent Multiple Measure
      • Add Chart Decoration
    • Chart Script Reference
      • Object Hierarchy
      • Basic Chart Properties
        • AxisSpec
          • getTextSpec()
          • setAbbreviate()
          • setAxisStyle()
          • setGridAsShape()
          • setGridColor()
          • setGridOnTop()
          • setGridStyle()
          • setInPlot()
          • setLabelGap()
          • setLabelVisible()
          • setLineColor()
          • setLineVisible()
          • setTextFrame()
          • setTextSpec()
          • setTickVisible()
        • data
        • dataset
          • getColCount()
          • getData()
          • setOrder()
          • getRowCount()
        • DefaultDataSet
        • EGraph
          • addElement()
          • addForm()
          • clearElements()
          • clearForms()
          • getCoordinate()
          • getElement()
          • getElementCount()
          • getForm()
          • getFormCount()
          • getLegendLayout()
          • getLegendPreferredSize()
          • getScale()
          • getVisualFrames()[]
          • getXTitleSpec()
          • getX2TitleSpec()
          • getYTitleSpec()
          • getY2TitleSpec()
          • removeElement()
          • removeForm()
          • setCoordinate()
          • setLegendLayout()
          • setLegendPreferredSize()
          • setScale()
          • setXTitleSpec()
          • setX2TitleSpec()
          • setYTitleSpec()
          • setY2TitleSpec()
        • LegendSpec
          • setBackground()
          • setBorder()
          • setBorderColor()
          • setPartial()
          • setPosition()
          • setPreferredSize()
          • setTextFrame()
          • setTextSpec()
          • setTitle()
          • setTitleTextSpec()
          • setTitleVisible()
          • setVisible()
        • PlotSpec
          • setAlpha()
          • setBackground()
          • setBackgroundImage()
          • setLockAspect()
          • setXMax()
          • setXMin()
          • setYMax()
          • setYMin()
        • TextSpec
          • setBackground()
          • setColor()
          • setFont()
          • setFormat()
          • setRotation()
        • TitleSpec
          • getTextSpec()
          • setLabel()
          • setTextSpec()
      • Chart Elements
        • AreaElement
        • GraphElement
          • addDim()
          • addVar()
          • getColorFrame()
          • getShapeFrame()
          • getSizeFrame()
          • getTextFrame()
          • getTextSpec()
          • getTextureFrame()
          • setAutoTextColor()
          • setBorderColor()
          • setCollisionModifier()
          • setColorFrame()
          • setHint()
          • setHints()
          • setInPlot()
          • setLabelPlacement()
          • setLineFrame()
          • setShapeFrame()
          • setSizeFrame()
          • setTextFrame()
          • setTextSpec()
          • setTextureFrame()
        • IntervalElement
          • addInterval()
          • setStackGroup()
          • setStackNegative()
        • LineElement
          • setClosed()
          • setEndArrow()
          • setStackGroup()
          • setStackNegative()
          • setStartArrow()
          • setIgnoreNull()
        • PointElement
        • SchemaElement
          • addSchema()
          • setPainter()
      • Chart Coordinates
        • CategoricalScale
          • setFill()
          • setValues()
        • Coordinate
          • getPlotSpec()
          • reflect()
          • rotate()
          • setExtent()
          • setFullMap()
          • setPlotSpec()
          • transpose()
        • FacetCoord
          • setInnerCoordinates()
          • setOuterCoordinate()
          • setVertical()
        • LinearRange
        • LinearScale
          • getScaleRange()
          • setIncrement()
          • setMax()
          • setMin()
          • setMinorIncrement()
          • setReversed()
          • setScaleRange()
        • LogScale
          • setBase()
        • ParallelCoord
          • setScales()
        • PolarCoord
          • setCoordinate()
          • setHoleRatio()
          • setType()
        • PowerScale
          • setExponent()
        • RectCoord
          • getXScale()
          • getYScale()
          • getYScale2()
          • setXScale()
          • setYScale()
          • setYScale2()
        • Rect25Coord
        • Scale
          • getAxisSpec()
          • init()
          • setAxisSpec()
          • setDataFields()
          • setFields()
          • setScaleOption()
          • setSharedRange()
        • ScaleRange
          • setAbsoluteValue()
        • StackRange
          • setGroupField()
          • setStackNegative()
        • TimeScale
          • setIncrement()
          • setMax()
          • setMin()
          • setType()
        • TriCoord
          • setScale()
      • Chart Visuals
        • BarShapeFrame
        • BipolarColorFrame
        • BrightnessColorFrame
          • setColor()
        • CategoricalColorFrame
          • getColor()
          • init()
          • setColor()
        • CategoricalLineFrame
          • setLine()
        • CategoricalShapeFrame
          • setShape()
        • CategoricalSizeFrame
          • setSize()
        • CategoricalTextureFrame
          • setTexture()
        • CircularColorFrame
        • ColorFrame
        • DefaultTextFrame
        • FillShapeFrame
        • GradientColorFrame
          • setFromColor()
          • setToColor()
        • GridTextureFrame
        • HeatColorFrame
        • LeftTiltTextureFrame
        • LinearLineFrame
        • LinearSizeFrame
        • LineFrame
        • MultiShapeFrame
          • setFields()
          • setScales()
        • MultiTextFrame
          • setDelimiter()
          • setFields()
          • setMessageFormat()
        • OrientationShapeFrame
        • OrientationTextureFrame
        • OvalShapeFrame
          • setFill()
        • PieShapeFrame
        • PolygonShapeFrame
          • setFill()
        • ProfileShapeFrame
        • RainbowColorFrame
        • RGBCubeColorFrame
        • RightTiltTextureFrame
        • SaturationColorFrame
          • setColor()
        • ShapeFrame
        • SizeFrame
          • setLargest()
          • setMax()
          • setSmallest()
        • StackTextFrame
        • StarShapeFrame
        • StaticColorFrame
          • setColor()
          • setNegativeColor()
        • StaticLineFrame
          • setLine()
        • StaticShapeFrame
          • setShape()
        • StaticSizeFrame
          • setSize()
        • StaticTextureFrame
          • setTexture()
        • SunShapeFrame
        • TextFrame
          • setText()
        • TextureFrame
        • ThermoShapeFrame
        • TriangleShapeFrame
          • setFill()
        • VineShapeFrame
          • setEndAngle()
          • setStartAngle()
        • VisualFrame
          • getLegendSpec()
          • getScale()
          • setField()
          • setLegendSpec()
          • setScale()
          • setScaleOption()
      • Chart Annotation
        • GraphForm
          • setColor()
          • setFill()
          • setInPlot()
          • setLine()
          • setLineEquation()
          • setMeasure()
          • setXOffset()
          • setYOffset()
          • setZIndex()
        • DefaultForm
        • LabelForm
          • setAlignmentX()
          • setAlignmentY()
          • setCollisionModifier()
          • setInsets()
          • setLabel()
          • setPoint()
          • setTextSpec()
          • setTuple()
          • setValues()
        • LineForm
          • addPoint()
          • addTuple()
          • addValues()
          • setEndArrow()
          • setStartArrow()
        • RectForm
          • setBottomRightPoint()
          • setBottomRightTuple()
          • setBottomRightValues()
          • setTopLeftPoint()
          • setTopLeftTuple()
          • setTopLeftValues()
        • ShapeForm
          • setAlignmentX()
          • setAlignmentY()
          • setPoint()
          • setRotation()
          • setShape()
          • setSize()
          • setTuple()
          • addValues()
        • TagForm
      • Utility Objects
        • GLine
        • ExponentialLineEquation
        • GShape
          • create()
          • GShape.ImageShape
            • setAlignment()
            • setImage()
            • setTile()
          • setFillColor()
        • GTexture
        • LogarithmicLineEquation
        • PolynomialLineEquation
        • PowerLineEquation
        • GShape.ImageShape
        • Special Chart Functions
          • createBulletGraph()
          • createTreeMap()
          • createCirclePackingGraph()
          • createIcicleGraph()
          • createMekkoGraph()
          • createSunburstGraph()
    • Use the Portal
      • Open User Portal
      • Configure the Portal
      • Manage the Repository
      • Use a Dashboard
      • Use Filter Components
      • Use Charts
      • Bookmark a Dashboard
      • Annotate a Dashboard
      • Profile a Dashboard
      • Schedule a Dashboard
      • Pin a Dashboard
      • Share a Dashboard
        • Save a Public Dashboard
        • Export a Dashboard
        • Email a Dashboard
        • Share to a Social Network
InetSoftUserDocumentation 1.0.0
  • InetSoftUserDocumentation
    • 1.0.0
  • InetSoftUserDocumentation
  • Chart Script Reference
  • Chart Visuals
  • TextFrame
Edit this Page

TextFrame

  • DefaultTextFrame

  • VisualFrame

The TextFrame object contains a mapping between values and displayed text. It provides the special TextFrame.setText(value,text) method.

Built using the Antora default UI on Wed Apr 01 2026.

The source code for this UI is licensed under the terms of the MPL-2.0 license.