ig.excel.DataBarConditionalFormat

Exposes properties which displays data bars in a WorksheetCell based on the cell's value as relative to the associated range.

Remarks

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • axisColor

    .axisColor( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Returns a WorkbookColorInfo object which defines the color of the axis.

  • axisColor

    .axisColor( value:ig.excel.WorkbookColorInfo );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Sets a WorkbookColorInfo object which defines the color of the axis.

    • value
    • Type:ig.excel.WorkbookColorInfo
  • axisPosition

    .axisPosition( );
    Return Type:
    ig.excel.DataBarAxisPosition
    Return Type Description:
    Returns a DataBarAxisPosition.

    Returns a DataBarAxisPosition value which determines whether an axis is displayed.

  • axisPosition

    .axisPosition( value:ig.excel.DataBarAxisPosition );
    Return Type:
    ig.excel.DataBarAxisPosition
    Return Type Description:
    Returns a DataBarAxisPosition.

    Sets a DataBarAxisPosition value which determines whether an axis is displayed.

    • value
    • Type:ig.excel.DataBarAxisPosition
  • barBorderColor

    .barBorderColor( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Returns a WorkbookColorInfo object which defines the border color of the data bar.

  • barBorderColor

    .barBorderColor( value:ig.excel.WorkbookColorInfo );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Sets a WorkbookColorInfo object which defines the border color of the data bar.

    • value
    • Type:ig.excel.WorkbookColorInfo
  • barColor

    .barColor( );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Returns a WorkbookColorInfo object which defines the fill color of the data bar.

  • barColor

    .barColor( value:ig.excel.WorkbookColorInfo );
    Return Type:
    ig.excel.WorkbookColorInfo
    Return Type Description:
    Returns a WorkbookColorInfo.

    Sets a WorkbookColorInfo object which defines the fill color of the data bar.

    • value
    • Type:ig.excel.WorkbookColorInfo
  • barFillType

    .barFillType( );
    Return Type:
    ig.excel.DataBarFillType
    Return Type Description:
    Returns a DataBarFillType.

    Returns a DataBarFillType value which determines whether the data bar is filled with a solid color or a gradient.

  • barFillType

    .barFillType( value:ig.excel.DataBarFillType );
    Return Type:
    ig.excel.DataBarFillType
    Return Type Description:
    Returns a DataBarFillType.

    Sets a DataBarFillType value which determines whether the data bar is filled with a solid color or a gradient.

    • value
    • Type:ig.excel.DataBarFillType
  • conditionType
    Inherited

    .conditionType( );
    Return Type:
    ig.excel.FormatConditionType
    Return Type Description:
    Returns a FormatConditionType.

    Returns a FormatConditionType value which identifies the type of condition for this instance.

  • direction

    .direction( );
    Return Type:
    ig.excel.DataBarDirection
    Return Type Description:
    Returns a DataBarDirection.

    Returns a DataBarDirection value which determines the direction in which the data bar extends.

  • direction

    .direction( value:ig.excel.DataBarDirection );
    Return Type:
    ig.excel.DataBarDirection
    Return Type Description:
    Returns a DataBarDirection.

    Sets a DataBarDirection value which determines the direction in which the data bar extends.

    • value
    • Type:ig.excel.DataBarDirection
  • fillPercentMax

    .fillPercentMax( );

    Returns an integer value which determines the length of the longest data bar, expressed as a percentage of the cell's width.

  • fillPercentMax

    .fillPercentMax( value:number );

    Sets an integer value which determines the length of the longest data bar, expressed as a percentage of the cell's width.

    • value
    • Type:number
  • fillPercentMin

    .fillPercentMin( );

    Returns an integer value which determines the length of the shortest data bar, expressed as a percentage of the cell's width.

  • fillPercentMin

    .fillPercentMin( value:number );

    Sets an integer value which determines the length of the shortest data bar, expressed as a percentage of the cell's width.

    • value
    • Type:number
  • formula
    Inherited

    .formula( );
    Return Type:
    ig.excel.Formula
    Return Type Description:
    Returns a Formula.

    Returns the formula which determines the values to which this condition applies.

    Remarks

    Note: the formula should return a boolean result. When the formula is applied to cells in the region if the formula returns false then those cells will not be included in the formatting.
  • maxPoint

    .maxPoint( );
    Return Type:
    ig.excel.ConditionValue
    Return Type Description:
    Returns a ConditionValue.

    Returns a value which determines the manner in which the longest bar is evaluated for this condition.

    Remarks

    The following values are not supported for the ConditionValue.valueType property, and will cause an exception to be thrown:

    • LowestValue
    • AutomaticMinimum
    • None

  • minPoint

    .minPoint( );
    Return Type:
    ig.excel.ConditionValue
    Return Type Description:
    Returns a ConditionValue.

    Returns a value which determines the manner in which the shortest bar is evaluated for this condition.

    Remarks

    The following values are not supported for the ConditionValue.valueType property, and will cause an exception to be thrown:

    • HighestValue
    • AutomaticMaximum
    • None

  • negativeBarFormat

    .negativeBarFormat( );
    Return Type:
    ig.excel.NegativeBarFormat
    Return Type Description:
    Returns a NegativeBarFormat.

    Returns a DataBarConditionalFormat.negativeBarFormat object which defines the visual attributes of negative-value data bars.

  • priority
    Inherited

    .priority( );

    Returns a value which determines the order of evaluation when multiple conditional formatting rules exist.

    Remarks

    By default, conditions are evaluated in the order in which they appear within the containing collection.

    This property makes it possible to weight one condition over another, essentially overriding the condition's ordinal position within the collection.

    A lower number means a higher priority; for example, a condition with a priority of 1 is evaluated before one with a priority of 2.

    If a cell value meets more than one condition, the format defined by the first condition to be evaluated takes precedence.

    Setting the priority on one condition may cause the value of other conditions in the collection to be changed to ensure that each condition has a unique value.

  • priority
    Inherited

    .priority( value:number );

    Sets a value which determines the order of evaluation when multiple conditional formatting rules exist.

    • value
    • Type:number

    Remarks

    By default, conditions are evaluated in the order in which they appear within the containing collection.

    This property makes it possible to weight one condition over another, essentially overriding the condition's ordinal position within the collection.

    A lower number means a higher priority; for example, a condition with a priority of 1 is evaluated before one with a priority of 2.

    If a cell value meets more than one condition, the format defined by the first condition to be evaluated takes precedence.

    Setting the priority on one condition may cause the value of other conditions in the collection to be changed to ensure that each condition has a unique value.

  • regions
    Inherited

    .regions( );

    Returns the WorksheetRegion which identifies the cell range with which this condition is associated.

  • setFirstPriority
    Inherited

    .setFirstPriority( );

    Sets the ConditionBase.priority value for this rule such that it is the first condition to be evaluated. Applicable only in the case where there is more than one element contained within the associated collection.

    Remarks

    When multiple conditions exist in the same collection, the order in which they are evaluated has bearing on which format is applied to cells which meet those conditions.

    This method ensures that the associated condition is the first one to be evaluated.

    To make a condition the last one to be evaluated, use the ConditionBase.setLastPriority method.

  • setFormula
    Inherited

    .setFormula( formula:string, [cellReferenceMode:ig.excel.CellReferenceMode] );

    Assigns a new Formula to the ThresholdConditionBase.formula property.

    • formula
    • Type:string
    • The string representation of the formula.
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • Optional
    • A CellReferenceMode value which specifies whether the formula parameter should be interpreted as an A1 or R1C1 expression. This parameter is optional and defaults to null, in which case the Workbook.cellReferenceMode property is used.

    Remarks

    Note: the formula should return a boolean result. When the formula is applied to cells in the region if the formula returns false then those cells will not be included in the formatting.
  • setLastPriority
    Inherited

    .setLastPriority( );

    Sets the ConditionBase.priority value for this rule such that it is the last condition to be evaluated. Applicable only in the case where there is more than one element contained within the associated ConditionalFormatCollection.

    Remarks

    Just as the ConditionBase.setFirstPriority method ensures that the associated condition is evalulated first, the SetLastPriority method ensures that the associated condition is evaluated last.

    Calling this method on more than one condition essentially replaces the previously designated condition as the last one to be evaluated with this one.

  • setRegions
    Inherited

    .setRegions( regionAddress:string, cellReferenceMode:ig.excel.CellReferenceMode );

    Replaces the existing regions with new ones

    • regionAddress
    • Type:string
    • A string with one or more comma separated region address
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • An optional cell reference mode

    Exceptions

    Exception Description
    ig.ArgumentException If regionAddress is invalid or contains a region from another worksheet
  • showBorder

    .showBorder( );

    Returns a boolean value indicating whether borders are displayed for both negative-value and positive-value databars.

  • showBorder

    .showBorder( value:boolean );

    Sets a boolean value indicating whether borders are displayed for both negative-value and positive-value databars.

    • value
    • Type:boolean
  • showValue

    .showValue( );

    Returns a boolean value indicating whether the cell value is shown along with the data bar.

    Remarks

    By default, the cell value is displayed along with the databar; use this property to prevent the cell value from appearing.

  • showValue

    .showValue( value:boolean );

    Sets a boolean value indicating whether the cell value is shown along with the data bar.

    • value
    • Type:boolean

    Remarks

    By default, the cell value is displayed along with the databar; use this property to prevent the cell value from appearing.

  • stopIfTrue
    Inherited

    .stopIfTrue( );

    Returns a boolean indicating whether additional formatting rules are evaluated if this rule evaluates to true. Applicable only in the case where the containing collection contains more than one element.

    Remarks

    If a cell value meets more than one condition, the format defined by the first condition takes precedence. Individual format properties are "merged" during the resolution process; for example, if one format has red borders and another has a red foreground color, a cell value which meets both conditions may be formatted with both red borders and a red foreground color.

    This property makes it possible to short-circuit the resolution process, so that no other conditional formats are applied after the first condition evaluates to true.

    Using the above example, assume StopIfTrue is set to a value of true on the conditional format with red borders, a second conditional format exists with a red foreground color, and a cell value meets both conditions. Because the StopIfTrue setting prevents additional formats from being evaluated, the cell will not show a red foreground color, whereas with StopIfTrue being set to false, it would show both red borders and a red foreground color.

    In addition to preventing subsequent conditions from being evaluated, the order in which conditions are evaluated can be controlled using the ConditionBase.priority property.

  • stopIfTrue
    Inherited

    .stopIfTrue( value:boolean );

    Sets a boolean indicating whether additional formatting rules are evaluated if this rule evaluates to true. Applicable only in the case where the containing collection contains more than one element.

    • value
    • Type:boolean

    Remarks

    If a cell value meets more than one condition, the format defined by the first condition takes precedence. Individual format properties are "merged" during the resolution process; for example, if one format has red borders and another has a red foreground color, a cell value which meets both conditions may be formatted with both red borders and a red foreground color.

    This property makes it possible to short-circuit the resolution process, so that no other conditional formats are applied after the first condition evaluates to true.

    Using the above example, assume StopIfTrue is set to a value of true on the conditional format with red borders, a second conditional format exists with a red foreground color, and a cell value meets both conditions. Because the StopIfTrue setting prevents additional formats from being evaluated, the cell will not show a red foreground color, whereas with StopIfTrue being set to false, it would show both red borders and a red foreground color.

    In addition to preventing subsequent conditions from being evaluated, the order in which conditions are evaluated can be controlled using the ConditionBase.priority property.

  • workbook
    Inherited

    .workbook( );
    Return Type:
    ig.excel.Workbook
    Return Type Description:
    Returns a Workbook.

    Returns a reference to the associated workbook.

  • worksheet
    Inherited

    .worksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    Returns a Worksheet.

    Returns a reference to the associated worksheet.

Copyright © 1996 - 2022 Infragistics, Inc. All rights reserved.