rubyXL 3.3.33 → 3.4.25
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.circleci/config.yml +60 -0
- data/Gemfile +9 -8
- data/Gemfile.lock +124 -0
- data/LICENSE.txt +1 -1
- data/README.rdoc +46 -22
- data/Rakefile +29 -29
- data/VERSION +1 -1
- data/lib/rubyXL/cell.rb +2 -29
- data/lib/rubyXL/convenience_methods/cell.rb +276 -0
- data/lib/rubyXL/convenience_methods/color.rb +156 -0
- data/lib/rubyXL/convenience_methods/font.rb +63 -0
- data/lib/rubyXL/convenience_methods/workbook.rb +141 -0
- data/lib/rubyXL/convenience_methods/worksheet.rb +714 -0
- data/lib/rubyXL/convenience_methods.rb +5 -1301
- data/lib/rubyXL/objects/border.rb +0 -3
- data/lib/rubyXL/objects/calculation_chain.rb +2 -2
- data/lib/rubyXL/objects/cell_style.rb +1 -3
- data/lib/rubyXL/objects/chartsheet.rb +8 -12
- data/lib/rubyXL/objects/color.rb +3 -7
- data/lib/rubyXL/objects/column_range.rb +0 -3
- data/lib/rubyXL/objects/comments.rb +1 -4
- data/lib/rubyXL/objects/connection.rb +175 -0
- data/lib/rubyXL/objects/container_nodes.rb +1 -5
- data/lib/rubyXL/objects/content_types.rb +3 -6
- data/lib/rubyXL/objects/data_validation.rb +2 -2
- data/lib/rubyXL/objects/document_properties.rb +11 -15
- data/lib/rubyXL/objects/extensions.rb +0 -2
- data/lib/rubyXL/objects/external_links.rb +30 -8
- data/lib/rubyXL/objects/fill.rb +2 -5
- data/lib/rubyXL/objects/filters.rb +5 -7
- data/lib/rubyXL/objects/font.rb +2 -7
- data/lib/rubyXL/objects/formula.rb +3 -5
- data/lib/rubyXL/objects/ooxml_object.rb +26 -19
- data/lib/rubyXL/objects/query_table.rb +104 -0
- data/lib/rubyXL/objects/reference.rb +6 -8
- data/lib/rubyXL/objects/relationships.rb +13 -13
- data/lib/rubyXL/objects/root.rb +0 -2
- data/lib/rubyXL/objects/shared_strings.rb +3 -6
- data/lib/rubyXL/objects/sheet_common.rb +1 -3
- data/lib/rubyXL/objects/sheet_data.rb +38 -11
- data/lib/rubyXL/objects/simple_types.rb +16 -1
- data/lib/rubyXL/objects/storage.rb +51 -50
- data/lib/rubyXL/objects/stylesheet.rb +8 -15
- data/lib/rubyXL/objects/text.rb +5 -7
- data/lib/rubyXL/objects/theme.rb +5 -8
- data/lib/rubyXL/objects/workbook.rb +140 -33
- data/lib/rubyXL/objects/worksheet.rb +44 -31
- data/lib/rubyXL/parser.rb +1 -3
- data/lib/rubyXL/worksheet.rb +83 -91
- data/lib/rubyXL.rb +1 -1
- data/rdoc/README_rdoc.html +111 -126
- data/rdoc/RubyXL/AExtension.html +20 -60
- data/rdoc/RubyXL/AExtensionStorageArea.html +11 -17
- data/rdoc/RubyXL/ActiveX.html +19 -47
- data/rdoc/RubyXL/ActiveXBinary.html +11 -22
- data/rdoc/RubyXL/AdjustHandleList.html +12 -19
- data/rdoc/RubyXL/Alignment.html +12 -19
- data/rdoc/RubyXL/AlternateContent.html +11 -17
- data/rdoc/RubyXL/Authors.html +12 -19
- data/rdoc/RubyXL/AutoFilter.html +12 -19
- data/rdoc/RubyXL/AutoFilterColumn.html +12 -19
- data/rdoc/RubyXL/BinaryImageFile.html +11 -25
- data/rdoc/RubyXL/BodyProperties.html +12 -19
- data/rdoc/RubyXL/BooleanNode.html +11 -17
- data/rdoc/RubyXL/BooleanValue.html +11 -17
- data/rdoc/RubyXL/Border.html +24 -84
- data/rdoc/RubyXL/BorderEdge.html +19 -52
- data/rdoc/RubyXL/Borders.html +18 -39
- data/rdoc/RubyXL/Break.html +12 -19
- data/rdoc/RubyXL/BreakList.html +12 -19
- data/rdoc/RubyXL/CT_AdjPoint2D.html +12 -19
- data/rdoc/RubyXL/CT_AlphaBiLevelEffect.html +12 -19
- data/rdoc/RubyXL/CT_AlphaModulateEffect.html +12 -19
- data/rdoc/RubyXL/CT_AlphaModulateFixedEffect.html +12 -19
- data/rdoc/RubyXL/CT_AlphaOutsetEffect.html +12 -19
- data/rdoc/RubyXL/CT_AlphaReplaceEffect.html +12 -19
- data/rdoc/RubyXL/CT_Backdrop.html +12 -19
- data/rdoc/RubyXL/CT_Bevel.html +12 -19
- data/rdoc/RubyXL/CT_BiLevelEffect.html +12 -19
- data/rdoc/RubyXL/CT_BlendEffect.html +12 -19
- data/rdoc/RubyXL/CT_Blip.html +12 -19
- data/rdoc/RubyXL/CT_BlipFillProperties.html +12 -19
- data/rdoc/RubyXL/CT_BlurEffect.html +12 -19
- data/rdoc/RubyXL/CT_Camera.html +12 -19
- data/rdoc/RubyXL/CT_Color.html +12 -19
- data/rdoc/RubyXL/CT_ColorChangeEffect.html +12 -19
- data/rdoc/RubyXL/CT_ColorMapping.html +12 -19
- data/rdoc/RubyXL/CT_ColorScheme.html +12 -19
- data/rdoc/RubyXL/CT_ColorSchemeAndMapping.html +12 -19
- data/rdoc/RubyXL/CT_ConnectionSite.html +12 -19
- data/rdoc/RubyXL/CT_ConnectionSiteList.html +12 -19
- data/rdoc/RubyXL/CT_DashStop.html +12 -19
- data/rdoc/RubyXL/CT_DashStopList.html +12 -19
- data/rdoc/RubyXL/CT_DefaultShapeDefinition.html +12 -19
- data/rdoc/RubyXL/CT_DuotoneEffect.html +12 -19
- data/rdoc/RubyXL/CT_EffectContainer.html +12 -19
- data/rdoc/RubyXL/CT_EffectList.html +12 -19
- data/rdoc/RubyXL/CT_EffectReference.html +12 -19
- data/rdoc/RubyXL/CT_EffectStyleItem.html +12 -19
- data/rdoc/RubyXL/CT_EffectStyleList.html +12 -19
- data/rdoc/RubyXL/CT_EmbeddedWAVAudioFile.html +12 -19
- data/rdoc/RubyXL/CT_FillEffect.html +12 -19
- data/rdoc/RubyXL/CT_FillOverlayEffect.html +12 -19
- data/rdoc/RubyXL/CT_FillStyleList.html +12 -19
- data/rdoc/RubyXL/CT_FlatText.html +12 -19
- data/rdoc/RubyXL/CT_FontCollection.html +12 -19
- data/rdoc/RubyXL/CT_FontReference.html +12 -19
- data/rdoc/RubyXL/CT_GeomGuideList.html +12 -19
- data/rdoc/RubyXL/CT_GlowEffect.html +12 -19
- data/rdoc/RubyXL/CT_GradientFillProperties.html +12 -19
- data/rdoc/RubyXL/CT_GradientStop.html +12 -19
- data/rdoc/RubyXL/CT_GradientStopList.html +12 -19
- data/rdoc/RubyXL/CT_HSLEffect.html +12 -19
- data/rdoc/RubyXL/CT_HslColor.html +12 -19
- data/rdoc/RubyXL/CT_Hyperlink.html +12 -19
- data/rdoc/RubyXL/CT_InnerShadowEffect.html +12 -19
- data/rdoc/RubyXL/CT_LightRig.html +12 -19
- data/rdoc/RubyXL/CT_LineEndProperties.html +12 -19
- data/rdoc/RubyXL/CT_LineJoinMiterProperties.html +12 -19
- data/rdoc/RubyXL/CT_LineProperties.html +12 -19
- data/rdoc/RubyXL/CT_LineStyleList.html +12 -19
- data/rdoc/RubyXL/CT_LinearShadeProperties.html +12 -19
- data/rdoc/RubyXL/CT_LuminanceEffect.html +12 -19
- data/rdoc/RubyXL/CT_ObjectStyleDefaults.html +12 -19
- data/rdoc/RubyXL/CT_OuterShadowEffect.html +12 -19
- data/rdoc/RubyXL/CT_Path2D.html +12 -19
- data/rdoc/RubyXL/CT_Path2DArcTo.html +12 -19
- data/rdoc/RubyXL/CT_Path2DCubicBezierTo.html +12 -19
- data/rdoc/RubyXL/CT_Path2DList.html +12 -19
- data/rdoc/RubyXL/CT_Path2DQuadBezierTo.html +12 -19
- data/rdoc/RubyXL/CT_Path2DTo.html +12 -19
- data/rdoc/RubyXL/CT_PathShadeProperties.html +12 -19
- data/rdoc/RubyXL/CT_PatternFillProperties.html +12 -19
- data/rdoc/RubyXL/CT_Point3D.html +12 -19
- data/rdoc/RubyXL/CT_PolarAdjustHandle.html +12 -19
- data/rdoc/RubyXL/CT_PresetColor.html +12 -19
- data/rdoc/RubyXL/CT_PresetLineDashProperties.html +12 -19
- data/rdoc/RubyXL/CT_PresetShadowEffect.html +12 -19
- data/rdoc/RubyXL/CT_PresetTextShape.html +12 -19
- data/rdoc/RubyXL/CT_ReflectionEffect.html +12 -19
- data/rdoc/RubyXL/CT_RelativeOffsetEffect.html +12 -19
- data/rdoc/RubyXL/CT_RelativeRect.html +12 -19
- data/rdoc/RubyXL/CT_SRgbColor.html +12 -19
- data/rdoc/RubyXL/CT_ScRgbColor.html +12 -19
- data/rdoc/RubyXL/CT_Scene3D.html +12 -19
- data/rdoc/RubyXL/CT_SchemeColor.html +12 -19
- data/rdoc/RubyXL/CT_Shape3D.html +12 -19
- data/rdoc/RubyXL/CT_ShapeStyle.html +12 -19
- data/rdoc/RubyXL/CT_SoftEdgesEffect.html +12 -19
- data/rdoc/RubyXL/CT_SphereCoords.html +12 -19
- data/rdoc/RubyXL/CT_StretchInfoProperties.html +12 -19
- data/rdoc/RubyXL/CT_StyleMatrix.html +12 -19
- data/rdoc/RubyXL/CT_StyleMatrixReference.html +12 -19
- data/rdoc/RubyXL/CT_SupplementalFont.html +12 -19
- data/rdoc/RubyXL/CT_SystemColor.html +12 -19
- data/rdoc/RubyXL/CT_TextAutonumberBullet.html +12 -19
- data/rdoc/RubyXL/CT_TextBlipBullet.html +12 -19
- data/rdoc/RubyXL/CT_TextCharBullet.html +12 -19
- data/rdoc/RubyXL/CT_TextCharacterProperties.html +12 -19
- data/rdoc/RubyXL/CT_TextFont.html +12 -19
- data/rdoc/RubyXL/CT_TextListStyle.html +12 -19
- data/rdoc/RubyXL/CT_TextNormalAutofit.html +12 -19
- data/rdoc/RubyXL/CT_TextParagraphProperties.html +12 -19
- data/rdoc/RubyXL/CT_TextSpacing.html +12 -19
- data/rdoc/RubyXL/CT_TextTabStop.html +12 -19
- data/rdoc/RubyXL/CT_TextTabStopList.html +12 -19
- data/rdoc/RubyXL/CT_TileInfoProperties.html +12 -19
- data/rdoc/RubyXL/CT_TintEffect.html +12 -19
- data/rdoc/RubyXL/CT_Transform2D.html +12 -19
- data/rdoc/RubyXL/CT_TransformEffect.html +12 -19
- data/rdoc/RubyXL/CT_Vector3D.html +12 -19
- data/rdoc/RubyXL/CT_XYAdjustHandle.html +12 -19
- data/rdoc/RubyXL/CalculationChain.html +16 -45
- data/rdoc/RubyXL/CalculationChainCell.html +12 -19
- data/rdoc/RubyXL/CalculationProperties.html +12 -19
- data/rdoc/RubyXL/Cell.html +133 -209
- data/rdoc/RubyXL/CellConvenienceMethods.html +168 -522
- data/rdoc/RubyXL/CellExt.html +12 -19
- data/rdoc/RubyXL/CellSmartTag.html +12 -19
- data/rdoc/RubyXL/CellSmartTagProperty.html +12 -19
- data/rdoc/RubyXL/CellSmartTags.html +12 -19
- data/rdoc/RubyXL/CellStyle.html +12 -19
- data/rdoc/RubyXL/CellStyleXFs.html +18 -39
- data/rdoc/RubyXL/CellStyles.html +18 -39
- data/rdoc/RubyXL/CellValue.html +17 -38
- data/rdoc/RubyXL/CellWatch.html +12 -19
- data/rdoc/RubyXL/CellWatches.html +12 -19
- data/rdoc/RubyXL/CellXFs.html +19 -42
- data/rdoc/RubyXL/ChartColorsFile.html +11 -25
- data/rdoc/RubyXL/ChartFile.html +18 -49
- data/rdoc/RubyXL/ChartStyleFile.html +11 -25
- data/rdoc/RubyXL/ChartUserShapesFile.html +11 -25
- data/rdoc/RubyXL/Chartsheet.html +19 -68
- data/rdoc/RubyXL/ChartsheetPageSetup.html +12 -19
- data/rdoc/RubyXL/ChartsheetProperties.html +12 -19
- data/rdoc/RubyXL/ChartsheetProtection.html +12 -19
- data/rdoc/RubyXL/ChartsheetView.html +12 -19
- data/rdoc/RubyXL/ChartsheetViews.html +12 -19
- data/rdoc/RubyXL/Color.html +18 -55
- data/rdoc/RubyXL/ColorConvenienceClasses/HlsColor.html +18 -65
- data/rdoc/RubyXL/ColorConvenienceClasses/RgbColor.html +28 -88
- data/rdoc/RubyXL/ColorConvenienceClasses.html +9 -14
- data/rdoc/RubyXL/ColorConvenienceMethods.html +14 -33
- data/rdoc/RubyXL/ColorFilter.html +12 -19
- data/rdoc/RubyXL/ColorScale.html +12 -19
- data/rdoc/RubyXL/ColorSet.html +12 -19
- data/rdoc/RubyXL/Colors.html +12 -19
- data/rdoc/RubyXL/ColumnRange.html +22 -74
- data/rdoc/RubyXL/ColumnRanges.html +23 -83
- data/rdoc/RubyXL/Comment.html +12 -19
- data/rdoc/RubyXL/CommentList.html +12 -19
- data/rdoc/RubyXL/CommentsFile.html +17 -51
- data/rdoc/RubyXL/ConditionalFormatValue.html +12 -19
- data/rdoc/RubyXL/ConditionalFormatting.html +12 -19
- data/rdoc/RubyXL/ConditionalFormattingRule.html +12 -19
- data/rdoc/RubyXL/Connection.html +99 -0
- data/rdoc/RubyXL/ConnectionTable.html +99 -0
- data/rdoc/RubyXL/ConnectionTables.html +99 -0
- data/rdoc/RubyXL/ConnectionTextField.html +99 -0
- data/rdoc/RubyXL/ConnectionTextFields.html +99 -0
- data/rdoc/RubyXL/Connections.html +147 -0
- data/rdoc/RubyXL/ContentTypeDefault.html +11 -17
- data/rdoc/RubyXL/ContentTypeOverride.html +11 -17
- data/rdoc/RubyXL/ContentTypes.html +22 -63
- data/rdoc/RubyXL/ControlPropertiesFile.html +13 -22
- data/rdoc/RubyXL/CorePropertiesFile.html +34 -171
- data/rdoc/RubyXL/CustomColor.html +12 -19
- data/rdoc/RubyXL/CustomColorList.html +12 -19
- data/rdoc/RubyXL/CustomFilter.html +12 -19
- data/rdoc/RubyXL/CustomFilters.html +12 -19
- data/rdoc/RubyXL/CustomGeometry.html +12 -19
- data/rdoc/RubyXL/CustomProperties.html +12 -19
- data/rdoc/RubyXL/CustomPropertiesFile.html +11 -25
- data/rdoc/RubyXL/CustomProperty.html +12 -19
- data/rdoc/RubyXL/CustomPropertyFile.html +11 -25
- data/rdoc/RubyXL/CustomSheetView.html +12 -19
- data/rdoc/RubyXL/CustomSheetViews.html +12 -19
- data/rdoc/RubyXL/CustomWorkbookView.html +12 -19
- data/rdoc/RubyXL/CustomWorkbookViews.html +12 -19
- data/rdoc/RubyXL/CustomXMLFile.html +11 -22
- data/rdoc/RubyXL/DXF.html +12 -19
- data/rdoc/RubyXL/DXFs.html +12 -19
- data/rdoc/RubyXL/DataBar.html +12 -19
- data/rdoc/RubyXL/DataConsolidate.html +12 -19
- data/rdoc/RubyXL/DataConsolidationReference.html +12 -19
- data/rdoc/RubyXL/DataConsolidationReferences.html +12 -19
- data/rdoc/RubyXL/DataType.html +10 -39
- data/rdoc/RubyXL/DataValidation.html +12 -19
- data/rdoc/RubyXL/DataValidations.html +12 -19
- data/rdoc/RubyXL/DateGroupItem.html +12 -19
- data/rdoc/RubyXL/DefinedName.html +12 -19
- data/rdoc/RubyXL/DefinedNameExt.html +12 -19
- data/rdoc/RubyXL/DefinedNames.html +12 -19
- data/rdoc/RubyXL/DefinedNamesExt.html +12 -19
- data/rdoc/RubyXL/DocumentPropertiesFile.html +21 -68
- data/rdoc/RubyXL/DrawingFile.html +18 -49
- data/rdoc/RubyXL/DynamicFilter.html +12 -19
- data/rdoc/RubyXL/EmbeddedControl.html +12 -19
- data/rdoc/RubyXL/EmbeddedControls.html +12 -19
- data/rdoc/RubyXL/Extension.html +12 -19
- data/rdoc/RubyXL/ExtensionStorageArea.html +12 -19
- data/rdoc/RubyXL/Extents.html +12 -19
- data/rdoc/RubyXL/ExternalBook.html +12 -19
- data/rdoc/RubyXL/ExternalLinksFile.html +18 -49
- data/rdoc/RubyXL/ExternalReference.html +12 -19
- data/rdoc/RubyXL/ExternalReferences.html +12 -19
- data/rdoc/RubyXL/ExtraColorSchemeList.html +12 -19
- data/rdoc/RubyXL/FieldItem.html +12 -19
- data/rdoc/RubyXL/FileRecoveryProperties.html +12 -19
- data/rdoc/RubyXL/FileSharing.html +12 -19
- data/rdoc/RubyXL/FileVersion.html +12 -19
- data/rdoc/RubyXL/Fill.html +18 -39
- data/rdoc/RubyXL/Fills.html +18 -39
- data/rdoc/RubyXL/FilterContainer.html +12 -19
- data/rdoc/RubyXL/FloatNode.html +11 -17
- data/rdoc/RubyXL/FloatValue.html +11 -17
- data/rdoc/RubyXL/Font.html +21 -59
- data/rdoc/RubyXL/FontConvenienceMethods.html +48 -237
- data/rdoc/RubyXL/FontScheme.html +12 -19
- data/rdoc/RubyXL/Fonts.html +18 -39
- data/rdoc/RubyXL/Formula.html +12 -19
- data/rdoc/RubyXL/FunctionGroup.html +12 -19
- data/rdoc/RubyXL/FunctionGroups.html +12 -19
- data/rdoc/RubyXL/GenericStorageObject.html +21 -84
- data/rdoc/RubyXL/GradientFill.html +12 -19
- data/rdoc/RubyXL/HeaderFooterSettings.html +12 -19
- data/rdoc/RubyXL/Hyperlink.html +12 -19
- data/rdoc/RubyXL/HyperlinkRelFile.html +11 -22
- data/rdoc/RubyXL/Hyperlinks.html +12 -19
- data/rdoc/RubyXL/IconFilter.html +12 -19
- data/rdoc/RubyXL/IconSet.html +12 -19
- data/rdoc/RubyXL/IgnoredError.html +12 -19
- data/rdoc/RubyXL/IgnoredErrors.html +12 -19
- data/rdoc/RubyXL/IndexedColors.html +12 -19
- data/rdoc/RubyXL/InputCells.html +12 -19
- data/rdoc/RubyXL/IntegerNode.html +11 -17
- data/rdoc/RubyXL/IntegerValue.html +11 -17
- data/rdoc/RubyXL/LegacyCell.html +13 -66
- data/rdoc/RubyXL/LegacyWorksheet.html +25 -99
- data/rdoc/RubyXL/MRUColors.html +12 -19
- data/rdoc/RubyXL/MacrosFile.html +11 -25
- data/rdoc/RubyXL/MergedCell.html +12 -19
- data/rdoc/RubyXL/MergedCells.html +12 -19
- data/rdoc/RubyXL/NumFmt.html +12 -19
- data/rdoc/RubyXL/NumberFormat.html +18 -39
- data/rdoc/RubyXL/NumberFormats.html +18 -45
- data/rdoc/RubyXL/OLEObject.html +12 -19
- data/rdoc/RubyXL/OLEObjectFile.html +11 -25
- data/rdoc/RubyXL/OLEObjects.html +12 -19
- data/rdoc/RubyXL/OLESize.html +12 -19
- data/rdoc/RubyXL/OOXMLContainerObject.html +35 -132
- data/rdoc/RubyXL/OOXMLIgnored.html +19 -53
- data/rdoc/RubyXL/OOXMLObject.html +14 -25
- data/rdoc/RubyXL/OOXMLObjectClassMethods.html +91 -183
- data/rdoc/RubyXL/OOXMLObjectInstanceMethods.html +48 -185
- data/rdoc/RubyXL/OOXMLRelationshipsFile.html +47 -200
- data/rdoc/RubyXL/OOXMLTopLevelObject.html +36 -133
- data/rdoc/RubyXL/OdbcOleDbProperties.html +99 -0
- data/rdoc/RubyXL/Offset.html +12 -19
- data/rdoc/RubyXL/OlapProperties.html +99 -0
- data/rdoc/RubyXL/OleItem.html +99 -0
- data/rdoc/RubyXL/OleItems.html +99 -0
- data/rdoc/RubyXL/OleLink.html +99 -0
- data/rdoc/RubyXL/OutlineProperties.html +12 -19
- data/rdoc/RubyXL/PageMargins.html +12 -19
- data/rdoc/RubyXL/PageSetup.html +12 -19
- data/rdoc/RubyXL/PageSetupProperties.html +12 -19
- data/rdoc/RubyXL/Pane.html +12 -19
- data/rdoc/RubyXL/Parser.html +22 -56
- data/rdoc/RubyXL/PatternFill.html +12 -19
- data/rdoc/RubyXL/PhoneticProperties.html +12 -19
- data/rdoc/RubyXL/PhoneticRun.html +12 -19
- data/rdoc/RubyXL/PivotArea.html +12 -19
- data/rdoc/RubyXL/PivotCache.html +12 -19
- data/rdoc/RubyXL/PivotCacheDefinitionFile.html +13 -30
- data/rdoc/RubyXL/PivotCacheRecordsFile.html +11 -25
- data/rdoc/RubyXL/PivotCaches.html +12 -19
- data/rdoc/RubyXL/PivotReference.html +12 -19
- data/rdoc/RubyXL/PivotReferences.html +12 -19
- data/rdoc/RubyXL/PivotTableFile.html +13 -30
- data/rdoc/RubyXL/PivotTableSelection.html +12 -19
- data/rdoc/RubyXL/PresetGeometry.html +12 -19
- data/rdoc/RubyXL/PrintOptions.html +12 -19
- data/rdoc/RubyXL/PrinterSettingsFile.html +11 -25
- data/rdoc/RubyXL/ProtectedRange.html +12 -19
- data/rdoc/RubyXL/ProtectedRanges.html +12 -19
- data/rdoc/RubyXL/Protection.html +12 -19
- data/rdoc/RubyXL/QueryParameter.html +99 -0
- data/rdoc/RubyXL/QueryParameters.html +99 -0
- data/rdoc/RubyXL/QueryTable.html +155 -0
- data/rdoc/RubyXL/QueryTableDeletedField.html +99 -0
- data/rdoc/RubyXL/QueryTableDeletedFields.html +99 -0
- data/rdoc/RubyXL/QueryTableField.html +99 -0
- data/rdoc/RubyXL/QueryTableFields.html +99 -0
- data/rdoc/RubyXL/QueryTableRefresh.html +99 -0
- data/rdoc/RubyXL/RID.html +11 -17
- data/rdoc/RubyXL/RawOOXML.html +20 -60
- data/rdoc/RubyXL/Reference.html +62 -228
- data/rdoc/RubyXL/Relationship.html +11 -17
- data/rdoc/RubyXL/RelationshipSupport/ClassMehods.html +13 -32
- data/rdoc/RubyXL/RelationshipSupport.html +25 -120
- data/rdoc/RubyXL/RevisionPointer.html +12 -22
- data/rdoc/RubyXL/RichText.html +19 -39
- data/rdoc/RubyXL/RichTextRun.html +17 -38
- data/rdoc/RubyXL/Row.html +33 -168
- data/rdoc/RubyXL/RowExt.html +12 -19
- data/rdoc/RubyXL/RunProperties.html +12 -19
- data/rdoc/RubyXL/Scenario.html +12 -19
- data/rdoc/RubyXL/Scenarios.html +12 -19
- data/rdoc/RubyXL/Selection.html +16 -37
- data/rdoc/RubyXL/ShapeGuide.html +12 -19
- data/rdoc/RubyXL/ShapeTextRectangle.html +12 -19
- data/rdoc/RubyXL/SharedStringsTable.html +37 -147
- data/rdoc/RubyXL/Sheet.html +12 -19
- data/rdoc/RubyXL/SheetCalculationProperties.html +12 -19
- data/rdoc/RubyXL/SheetData.html +19 -53
- data/rdoc/RubyXL/SheetDataExt.html +12 -19
- data/rdoc/RubyXL/SheetDataSet.html +12 -19
- data/rdoc/RubyXL/SheetMetadata.html +108 -0
- data/rdoc/RubyXL/SheetName.html +12 -19
- data/rdoc/RubyXL/SheetNames.html +12 -19
- data/rdoc/RubyXL/Sheets.html +12 -19
- data/rdoc/RubyXL/SlicerCacheFile.html +11 -25
- data/rdoc/RubyXL/SlicerFile.html +11 -25
- data/rdoc/RubyXL/SmartTagProperties.html +12 -19
- data/rdoc/RubyXL/SmartTagType.html +12 -19
- data/rdoc/RubyXL/SmartTagTypes.html +12 -19
- data/rdoc/RubyXL/SmartTags.html +12 -19
- data/rdoc/RubyXL/SortCondition.html +12 -19
- data/rdoc/RubyXL/SortState.html +12 -19
- data/rdoc/RubyXL/Sqref.html +19 -53
- data/rdoc/RubyXL/Stop.html +12 -19
- data/rdoc/RubyXL/StringNode.html +11 -17
- data/rdoc/RubyXL/StringNodeW3C.html +20 -54
- data/rdoc/RubyXL/StringValue.html +11 -17
- data/rdoc/RubyXL/Stylesheet.html +34 -117
- data/rdoc/RubyXL/TableFile.html +11 -25
- data/rdoc/RubyXL/TableParts.html +11 -17
- data/rdoc/RubyXL/TableStyle.html +12 -19
- data/rdoc/RubyXL/TableStyles.html +12 -19
- data/rdoc/RubyXL/Text.html +22 -67
- data/rdoc/RubyXL/TextImportSettings.html +99 -0
- data/rdoc/RubyXL/Theme.html +19 -75
- data/rdoc/RubyXL/ThemeElements.html +12 -19
- data/rdoc/RubyXL/ThumbnailFile.html +11 -25
- data/rdoc/RubyXL/Top10.html +12 -19
- data/rdoc/RubyXL/VMLDrawingFile.html +14 -32
- data/rdoc/RubyXL/Variant.html +12 -19
- data/rdoc/RubyXL/Vector.html +17 -38
- data/rdoc/RubyXL/VectorValue.html +11 -17
- data/rdoc/RubyXL/VisualProperties.html +12 -19
- data/rdoc/RubyXL/WebPublishObject.html +12 -19
- data/rdoc/RubyXL/WebPublishObjects.html +12 -19
- data/rdoc/RubyXL/WebPublishingItem.html +12 -19
- data/rdoc/RubyXL/WebPublishingItems.html +12 -19
- data/rdoc/RubyXL/WebPublishingProperties.html +12 -19
- data/rdoc/RubyXL/WebQueryProperties.html +99 -0
- data/rdoc/RubyXL/Workbook.html +486 -227
- data/rdoc/RubyXL/WorkbookConvenienceMethods.html +130 -888
- data/rdoc/RubyXL/WorkbookProperties.html +12 -19
- data/rdoc/RubyXL/WorkbookProtection.html +12 -19
- data/rdoc/RubyXL/WorkbookRoot.html +27 -114
- data/rdoc/RubyXL/WorkbookView.html +12 -19
- data/rdoc/RubyXL/WorkbookViews.html +12 -19
- data/rdoc/RubyXL/Worksheet.html +92 -121
- data/rdoc/RubyXL/WorksheetConvenienceMethods.html +298 -1109
- data/rdoc/RubyXL/WorksheetDimensions.html +12 -19
- data/rdoc/RubyXL/WorksheetFormatProperties.html +11 -17
- data/rdoc/RubyXL/WorksheetProperties.html +12 -19
- data/rdoc/RubyXL/WorksheetProtection.html +12 -19
- data/rdoc/RubyXL/WorksheetView.html +12 -19
- data/rdoc/RubyXL/WorksheetViews.html +12 -19
- data/rdoc/RubyXL/XF.html +12 -19
- data/rdoc/RubyXL.html +39 -318
- data/rdoc/created.rid +45 -38
- data/rdoc/css/rdoc.css +55 -6
- data/rdoc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/rdoc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/rdoc/index.html +33 -373
- data/rdoc/js/darkfish.js +22 -99
- data/rdoc/js/navigation.js +4 -41
- data/rdoc/js/navigation.js.gz +0 -0
- data/rdoc/js/search.js +32 -31
- data/rdoc/js/search_index.js +1 -1
- data/rdoc/js/search_index.js.gz +0 -0
- data/rdoc/js/searcher.js +6 -6
- data/rdoc/js/searcher.js.gz +0 -0
- data/rdoc/table_of_contents.html +205 -45
- data/rubyXL.gemspec +53 -29
- data/spec/lib/cell_spec.rb +57 -6
- data/spec/lib/color_spec.rb +2 -1
- data/spec/lib/parser_spec.rb +24 -27
- data/spec/lib/reference_spec.rb +9 -3
- data/spec/lib/rgb_color_spec.rb +27 -0
- data/spec/lib/stylesheet_spec.rb +8 -11
- data/spec/lib/text_spec.rb +1 -5
- data/spec/lib/workbook_spec.rb +25 -4
- data/spec/lib/worksheet_spec.rb +873 -479
- data/spec/spec_helper.rb +2 -0
- data/test/test_parse_write.rb +15 -15
- metadata +54 -10
- data/rdoc/js/jquery.js +0 -4
|
@@ -4,21 +4,23 @@
|
|
|
4
4
|
<head>
|
|
5
5
|
<meta charset="UTF-8">
|
|
6
6
|
|
|
7
|
-
<title>module RubyXL::OOXMLObjectInstanceMethods - rubyXL 3.
|
|
7
|
+
<title>module RubyXL::OOXMLObjectInstanceMethods - rubyXL 3.4.25</title>
|
|
8
8
|
|
|
9
9
|
<script type="text/javascript">
|
|
10
10
|
var rdoc_rel_prefix = "../";
|
|
11
11
|
var index_rel_prefix = "../";
|
|
12
12
|
</script>
|
|
13
13
|
|
|
14
|
-
<script src="../js/
|
|
15
|
-
<script src="../js/
|
|
14
|
+
<script src="../js/navigation.js" defer></script>
|
|
15
|
+
<script src="../js/search.js" defer></script>
|
|
16
|
+
<script src="../js/search_index.js" defer></script>
|
|
17
|
+
<script src="../js/searcher.js" defer></script>
|
|
18
|
+
<script src="../js/darkfish.js" defer></script>
|
|
16
19
|
|
|
17
20
|
<link href="../css/fonts.css" rel="stylesheet">
|
|
18
21
|
<link href="../css/rdoc.css" rel="stylesheet">
|
|
19
22
|
|
|
20
23
|
|
|
21
|
-
|
|
22
24
|
<body id="top" role="document" class="module">
|
|
23
25
|
<nav role="navigation">
|
|
24
26
|
<div id="project-navigation">
|
|
@@ -57,40 +59,29 @@
|
|
|
57
59
|
|
|
58
60
|
|
|
59
61
|
|
|
60
|
-
|
|
62
|
+
|
|
63
|
+
<div id="extends-section" class="nav-section">
|
|
61
64
|
<h3>Extended With Modules</h3>
|
|
62
65
|
|
|
63
66
|
<ul class="link-list">
|
|
64
|
-
|
|
65
|
-
|
|
66
67
|
<li><a class="extend" href="OOXMLObjectClassMethods.html">RubyXL::OOXMLObjectClassMethods</a>
|
|
67
|
-
|
|
68
|
-
|
|
69
68
|
</ul>
|
|
70
69
|
</div>
|
|
71
70
|
|
|
72
|
-
|
|
71
|
+
|
|
72
|
+
<!-- Method Quickref -->
|
|
73
73
|
<div id="method-list-section" class="nav-section">
|
|
74
74
|
<h3>Methods</h3>
|
|
75
75
|
|
|
76
76
|
<ul class="link-list" role="directory">
|
|
77
|
-
|
|
78
77
|
<li ><a href="#method-c-included">::included</a>
|
|
79
|
-
|
|
80
78
|
<li ><a href="#method-c-new">::new</a>
|
|
81
|
-
|
|
82
79
|
<li ><a href="#method-i-3D-3D">#==</a>
|
|
83
|
-
|
|
84
80
|
<li ><a href="#method-i-before_write_xml">#before_write_xml</a>
|
|
85
|
-
|
|
86
81
|
<li ><a href="#method-i-get_node_object">#get_node_object</a>
|
|
87
|
-
|
|
88
82
|
<li ><a href="#method-i-index_in_collection">#index_in_collection</a>
|
|
89
|
-
|
|
90
83
|
<li ><a href="#method-i-init_child_nodes">#init_child_nodes</a>
|
|
91
|
-
|
|
92
84
|
<li ><a href="#method-i-write_xml">#write_xml</a>
|
|
93
|
-
|
|
94
85
|
</ul>
|
|
95
86
|
</div>
|
|
96
87
|
|
|
@@ -106,23 +97,15 @@
|
|
|
106
97
|
|
|
107
98
|
</section>
|
|
108
99
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
100
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
113
|
-
|
|
114
101
|
|
|
115
|
-
|
|
116
102
|
|
|
117
|
-
|
|
118
103
|
|
|
119
|
-
|
|
120
104
|
<section class="attribute-method-details" class="method-section">
|
|
121
105
|
<header>
|
|
122
106
|
<h3>Attributes</h3>
|
|
123
107
|
</header>
|
|
124
108
|
|
|
125
|
-
|
|
126
109
|
<div id="attribute-i-local_namespaces" class="method-detail">
|
|
127
110
|
<div class="method-heading attribute-method-heading">
|
|
128
111
|
<span class="method-name">local_namespaces</span><span
|
|
@@ -131,76 +114,52 @@
|
|
|
131
114
|
|
|
132
115
|
<div class="method-description">
|
|
133
116
|
|
|
134
|
-
|
|
135
|
-
|
|
136
117
|
</div>
|
|
137
118
|
</div>
|
|
138
|
-
|
|
139
119
|
</section>
|
|
140
|
-
|
|
141
120
|
|
|
142
|
-
|
|
121
|
+
|
|
143
122
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
144
123
|
<header>
|
|
145
124
|
<h3>Public Class Methods</h3>
|
|
146
125
|
</header>
|
|
147
126
|
|
|
148
|
-
|
|
149
127
|
<div id="method-c-included" class="method-detail ">
|
|
150
|
-
|
|
151
128
|
<div class="method-heading">
|
|
152
129
|
<span class="method-name">included</span><span
|
|
153
130
|
class="method-args">(klass)</span>
|
|
154
|
-
|
|
155
131
|
<span class="method-click-advice">click to toggle source</span>
|
|
156
|
-
|
|
157
132
|
</div>
|
|
158
|
-
|
|
159
133
|
|
|
160
134
|
<div class="method-description">
|
|
161
135
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
136
|
|
|
166
|
-
|
|
167
137
|
<div class="method-source-code" id="included-source">
|
|
168
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
169
|
-
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">included</span>(<span class="ruby-identifier">klass</span>)
|
|
138
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 217</span>
|
|
139
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">included</span>(<span class="ruby-identifier">klass</span>)
|
|
170
140
|
<span class="ruby-identifier">klass</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">RubyXL</span><span class="ruby-operator">::</span><span class="ruby-constant">OOXMLObjectClassMethods</span>
|
|
171
141
|
<span class="ruby-keyword">end</span></pre>
|
|
172
142
|
</div>
|
|
173
|
-
|
|
174
143
|
</div>
|
|
175
144
|
|
|
176
|
-
|
|
177
145
|
|
|
178
|
-
|
|
179
146
|
</div>
|
|
180
147
|
|
|
181
|
-
|
|
182
148
|
<div id="method-c-new" class="method-detail ">
|
|
183
|
-
|
|
184
149
|
<div class="method-heading">
|
|
185
150
|
<span class="method-name">new</span><span
|
|
186
|
-
class="method-args">(params =
|
|
187
|
-
|
|
151
|
+
class="method-args">(params = nil)</span>
|
|
188
152
|
<span class="method-click-advice">click to toggle source</span>
|
|
189
|
-
|
|
190
153
|
</div>
|
|
191
|
-
|
|
192
154
|
|
|
193
155
|
<div class="method-description">
|
|
194
156
|
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
157
|
|
|
199
|
-
|
|
200
158
|
<div class="method-source-code" id="new-source">
|
|
201
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
202
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">params</span> =
|
|
159
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 226</span>
|
|
160
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">params</span> = <span class="ruby-keyword">nil</span>)
|
|
203
161
|
<span class="ruby-ivar">@local_namespaces</span> = <span class="ruby-keyword">nil</span>
|
|
162
|
+
<span class="ruby-identifier">params</span> <span class="ruby-operator">||=</span> {}
|
|
204
163
|
|
|
205
164
|
<span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>).<span class="ruby-identifier">each_value</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
|
|
206
165
|
<span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">"@#{v[:accessor]}"</span>, <span class="ruby-identifier">params</span>[<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]]) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">v</span>[<span class="ruby-value">:computed</span>]
|
|
@@ -209,82 +168,54 @@
|
|
|
209
168
|
<span class="ruby-identifier">init_child_nodes</span>(<span class="ruby-identifier">params</span>)
|
|
210
169
|
<span class="ruby-keyword">end</span></pre>
|
|
211
170
|
</div>
|
|
212
|
-
|
|
213
171
|
</div>
|
|
214
172
|
|
|
215
|
-
|
|
216
173
|
|
|
217
|
-
|
|
218
174
|
</div>
|
|
219
175
|
|
|
220
|
-
|
|
221
176
|
</section>
|
|
222
|
-
|
|
177
|
+
|
|
223
178
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
224
179
|
<header>
|
|
225
180
|
<h3>Public Instance Methods</h3>
|
|
226
181
|
</header>
|
|
227
182
|
|
|
228
|
-
|
|
229
183
|
<div id="method-i-3D-3D" class="method-detail ">
|
|
230
|
-
|
|
231
184
|
<div class="method-heading">
|
|
232
185
|
<span class="method-name">==</span><span
|
|
233
186
|
class="method-args">(other)</span>
|
|
234
|
-
|
|
235
187
|
<span class="method-click-advice">click to toggle source</span>
|
|
236
|
-
|
|
237
188
|
</div>
|
|
238
|
-
|
|
239
189
|
|
|
240
190
|
<div class="method-description">
|
|
241
191
|
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
192
|
|
|
246
|
-
|
|
247
193
|
<div class="method-source-code" id="3D-3D-source">
|
|
248
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
249
|
-
<span class="ruby-keyword">def</span> <span class="ruby-
|
|
194
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 255</span>
|
|
195
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">==</span>(<span class="ruby-identifier">other</span>)
|
|
250
196
|
<span class="ruby-identifier">other</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>) <span class="ruby-operator">&&</span>
|
|
251
197
|
<span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_attributes</span>).<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) } <span class="ruby-operator">&&</span>
|
|
252
198
|
<span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>).<span class="ruby-identifier">all?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) }
|
|
253
199
|
<span class="ruby-keyword">end</span></pre>
|
|
254
200
|
</div>
|
|
255
|
-
|
|
256
201
|
</div>
|
|
257
202
|
|
|
258
|
-
|
|
259
203
|
|
|
260
|
-
|
|
261
204
|
</div>
|
|
262
205
|
|
|
263
|
-
|
|
264
206
|
<div id="method-i-before_write_xml" class="method-detail ">
|
|
265
|
-
|
|
266
207
|
<div class="method-heading">
|
|
267
208
|
<span class="method-name">before_write_xml</span><span
|
|
268
209
|
class="method-args">()</span>
|
|
269
|
-
|
|
270
210
|
<span class="method-click-advice">click to toggle source</span>
|
|
271
|
-
|
|
272
211
|
</div>
|
|
273
|
-
|
|
274
212
|
|
|
275
213
|
<div class="method-description">
|
|
276
|
-
|
|
277
|
-
<p>Subclass provided filter to perform last-minute operations (cleanup, count,
|
|
278
|
-
etc.) immediately prior to write, along with option to terminate the actual
|
|
279
|
-
write if <code>false</code> is returned (for example, to avoid writing the
|
|
280
|
-
collection's root node if the collection is empty).</p>
|
|
281
|
-
|
|
282
|
-
|
|
214
|
+
<p>Subclass provided filter to perform last-minute operations (cleanup, count, etc.) immediately prior to write, along with option to terminate the actual write if <code>false</code> is returned (for example, to avoid writing the collection’s root node if the collection is empty).</p>
|
|
283
215
|
|
|
284
|
-
|
|
285
216
|
<div class="method-source-code" id="before_write_xml-source">
|
|
286
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
287
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">before_write_xml</span>
|
|
217
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 355</span>
|
|
218
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">before_write_xml</span>
|
|
288
219
|
<span class="ruby-comment">#TODO# This will go away once containers are fully implemented.</span>
|
|
289
220
|
<span class="ruby-identifier">child_nodes</span> = <span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>)
|
|
290
221
|
<span class="ruby-identifier">child_nodes</span>.<span class="ruby-identifier">each_pair</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">child_node_name</span>, <span class="ruby-identifier">child_node_params</span><span class="ruby-operator">|</span>
|
|
@@ -293,80 +224,47 @@ collection's root node if the collection is empty).</p>
|
|
|
293
224
|
<span class="ruby-keyword">true</span>
|
|
294
225
|
<span class="ruby-keyword">end</span></pre>
|
|
295
226
|
</div>
|
|
296
|
-
|
|
297
227
|
</div>
|
|
298
228
|
|
|
299
|
-
|
|
300
229
|
|
|
301
|
-
|
|
302
230
|
</div>
|
|
303
231
|
|
|
304
|
-
|
|
305
232
|
<div id="method-i-index_in_collection" class="method-detail ">
|
|
306
|
-
|
|
307
233
|
<div class="method-heading">
|
|
308
234
|
<span class="method-name">index_in_collection</span><span
|
|
309
235
|
class="method-args">()</span>
|
|
310
|
-
|
|
311
236
|
<span class="method-click-advice">click to toggle source</span>
|
|
312
|
-
|
|
313
237
|
</div>
|
|
314
|
-
|
|
315
238
|
|
|
316
239
|
<div class="method-description">
|
|
317
|
-
|
|
318
|
-
<p>Prototype method. For sparse collections (<code>Rows</code>,
|
|
319
|
-
<code>Cells</code>, etc.) must return index at which this object is
|
|
320
|
-
expected to reside in the collection. If <code>nil</code> is returned, then
|
|
321
|
-
object is simply added to the end of the collection.</p>
|
|
322
|
-
|
|
323
|
-
|
|
240
|
+
<p>Prototype method. For sparse collections (<code>Rows</code>, <code>Cells</code>, etc.) must return index at which this object is expected to reside in the collection. If <code>nil</code> is returned, then object is simply added to the end of the collection.</p>
|
|
324
241
|
|
|
325
|
-
|
|
326
242
|
<div class="method-source-code" id="index_in_collection-source">
|
|
327
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
328
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">index_in_collection</span>
|
|
243
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 343</span>
|
|
244
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">index_in_collection</span>
|
|
329
245
|
<span class="ruby-keyword">nil</span>
|
|
330
246
|
<span class="ruby-keyword">end</span></pre>
|
|
331
247
|
</div>
|
|
332
|
-
|
|
333
248
|
</div>
|
|
334
249
|
|
|
335
|
-
|
|
336
250
|
|
|
337
|
-
|
|
338
251
|
</div>
|
|
339
252
|
|
|
340
|
-
|
|
341
253
|
<div id="method-i-write_xml" class="method-detail ">
|
|
342
|
-
|
|
343
254
|
<div class="method-heading">
|
|
344
255
|
<span class="method-name">write_xml</span><span
|
|
345
256
|
class="method-args">(xml = nil, node_name_override = nil)</span>
|
|
346
|
-
|
|
347
257
|
<span class="method-click-advice">click to toggle source</span>
|
|
348
|
-
|
|
349
258
|
</div>
|
|
350
|
-
|
|
351
259
|
|
|
352
260
|
<div class="method-description">
|
|
353
|
-
|
|
354
|
-
<p>Recursively write the OOXML object and all its children out as
|
|
355
|
-
Nokogiri::XML. Immediately before the actual generation,
|
|
356
|
-
+before_write_xml()+ is called to perform last-minute cleanup and
|
|
357
|
-
validation operations; if it returns <code>false</code>, an empty string is
|
|
358
|
-
returned (rather than <code>nil</code>, so Nokogiri::XML's
|
|
359
|
-
<code>&lt;&lt;</code> operator can be used without additional
|
|
360
|
-
<code>nil</code> checking)</p>
|
|
261
|
+
<p>Recursively write the OOXML object and all its children out as Nokogiri::XML. Immediately before the actual generation, +before_write_xml()+ is called to perform last-minute cleanup and validation operations; if it returns <code>false</code>, an empty string is returned (rather than <code>nil</code>, so Nokogiri::XML’s <code>&lt;&lt;</code> operator can be used without additional <code>nil</code> checking)</p>
|
|
361
262
|
|
|
362
263
|
<h3 id="method-i-write_xml-label-Parameters">Parameters<span><a href="#method-i-write_xml-label-Parameters">¶</a> <a href="#top">↑</a></span></h3>
|
|
363
264
|
<ul><li>
|
|
364
|
-
<p><code>xml</code> - Base Nokogiri::XML object used for building. If omitted,
|
|
365
|
-
a blank document will be generated.</p>
|
|
265
|
+
<p><code>xml</code> - Base Nokogiri::XML object used for building. If omitted, a blank document will be generated.</p>
|
|
366
266
|
</li><li>
|
|
367
|
-
<p><code>node_name_override</code> - if present, is used instead of the
|
|
368
|
-
default element name for this object provided by
|
|
369
|
-
<code>define_element_name</code></p>
|
|
267
|
+
<p><code>node_name_override</code> - if present, is used instead of the default element name for this object provided by <code>define_element_name</code></p>
|
|
370
268
|
</li></ul>
|
|
371
269
|
|
|
372
270
|
<h4 id="method-i-write_xml-label-Examples">Examples<span><a href="#method-i-write_xml-label-Examples">¶</a> <a href="#top">↑</a></span></h4>
|
|
@@ -374,38 +272,33 @@ default element name for this object provided by
|
|
|
374
272
|
<pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>()
|
|
375
273
|
</pre>
|
|
376
274
|
|
|
377
|
-
<p>Creates a new empty <code>Nokogiri::XML</code>, populates it with the OOXML
|
|
378
|
-
structure as described in the respective definition, and returns the
|
|
379
|
-
resulting <code>Nokogiri::XML</code> object.</p>
|
|
275
|
+
<p>Creates a new empty <code>Nokogiri::XML</code>, populates it with the OOXML structure as described in the respective definition, and returns the resulting <code>Nokogiri::XML</code> object.</p>
|
|
380
276
|
|
|
381
277
|
<pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>)
|
|
382
278
|
</pre>
|
|
383
279
|
|
|
384
|
-
<p>Using the passed-in <code>Nokogiri</code> <code>xml</code> object, creates
|
|
385
|
-
a new element corresponding to <code>obj</code> according to its
|
|
386
|
-
definition, along with all its properties and children, and returns the
|
|
387
|
-
newly created element.</p>
|
|
280
|
+
<p>Using the passed-in <code>Nokogiri</code> <code>xml</code> object, creates a new element corresponding to <code>obj</code> according to its definition, along with all its properties and children, and returns the newly created element.</p>
|
|
388
281
|
|
|
389
282
|
<pre class="ruby"><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>, <span class="ruby-string">'overriden_element_name'</span>)
|
|
390
283
|
</pre>
|
|
391
284
|
|
|
392
|
-
<p>Same as above, but uses the passed-in <code>node_name_override</code> as
|
|
393
|
-
the new element name, instead of its default name set by
|
|
394
|
-
<code>define_element_name</code>.</p>
|
|
395
|
-
|
|
396
|
-
|
|
285
|
+
<p>Same as above, but uses the passed-in <code>node_name_override</code> as the new element name, instead of its default name set by <code>define_element_name</code>.</p>
|
|
397
286
|
|
|
398
|
-
|
|
399
287
|
<div class="method-source-code" id="write_xml-source">
|
|
400
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
401
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">xml</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">node_name_override</span> = <span class="ruby-keyword">nil</span>)
|
|
288
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 275</span>
|
|
289
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_xml</span>(<span class="ruby-identifier">xml</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">node_name_override</span> = <span class="ruby-keyword">nil</span>)
|
|
402
290
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">xml</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">then</span>
|
|
403
291
|
<span class="ruby-identifier">seed_xml</span> = <span class="ruby-constant">Nokogiri</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span>(<span class="ruby-string">'<?xml version = "1.0" standalone ="yes"?>'</span>)
|
|
404
292
|
<span class="ruby-identifier">seed_xml</span>.<span class="ruby-identifier">encoding</span> = <span class="ruby-string">'UTF-8'</span>
|
|
293
|
+
|
|
294
|
+
<span class="ruby-keyword">if</span> <span class="ruby-constant">Nokogiri</span>.<span class="ruby-identifier">jruby?</span> <span class="ruby-keyword">then</span> <span class="ruby-comment"># Issue 188 workaround for JRuby</span>
|
|
295
|
+
<span class="ruby-identifier">seed_xml</span>.<span class="ruby-identifier">to_java</span>.<span class="ruby-identifier">strict_error_checking</span> = <span class="ruby-keyword">false</span>
|
|
296
|
+
<span class="ruby-keyword">end</span>
|
|
297
|
+
|
|
405
298
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">write_xml</span>(<span class="ruby-identifier">seed_xml</span>)
|
|
406
299
|
<span class="ruby-keyword">return</span> <span class="ruby-identifier">result</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span> <span class="ruby-operator">==</span> <span class="ruby-string">''</span>
|
|
407
300
|
<span class="ruby-identifier">seed_xml</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">result</span>
|
|
408
|
-
<span class="ruby-keyword">return</span> <span class="ruby-identifier">seed_xml</span>.<span class="ruby-identifier">to_xml</span>({ <span class="ruby-value">:indent</span>
|
|
301
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">seed_xml</span>.<span class="ruby-identifier">to_xml</span>({ <span class="ruby-value">:indent</span> <span class="ruby-operator">=></span> <span class="ruby-value">0</span>, <span class="ruby-value">:save_with</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Nokogiri</span><span class="ruby-operator">::</span><span class="ruby-constant">XML</span><span class="ruby-operator">::</span><span class="ruby-constant">Node</span><span class="ruby-operator">::</span><span class="ruby-constant">SaveOptions</span><span class="ruby-operator">::</span><span class="ruby-constant">AS_XML</span> })
|
|
409
302
|
<span class="ruby-keyword">end</span>
|
|
410
303
|
|
|
411
304
|
<span class="ruby-keyword">return</span> <span class="ruby-string">''</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">before_write_xml</span>
|
|
@@ -458,79 +351,53 @@ the new element name, instead of its default name set by
|
|
|
458
351
|
<span class="ruby-identifier">elem</span>
|
|
459
352
|
<span class="ruby-keyword">end</span></pre>
|
|
460
353
|
</div>
|
|
461
|
-
|
|
462
354
|
</div>
|
|
463
355
|
|
|
464
|
-
|
|
465
356
|
|
|
466
|
-
|
|
467
357
|
</div>
|
|
468
358
|
|
|
469
|
-
|
|
470
359
|
</section>
|
|
471
|
-
|
|
360
|
+
|
|
472
361
|
<section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
|
|
473
362
|
<header>
|
|
474
363
|
<h3>Protected Instance Methods</h3>
|
|
475
364
|
</header>
|
|
476
365
|
|
|
477
|
-
|
|
478
366
|
<div id="method-i-get_node_object" class="method-detail ">
|
|
479
|
-
|
|
480
367
|
<div class="method-heading">
|
|
481
368
|
<span class="method-name">get_node_object</span><span
|
|
482
369
|
class="method-args">(child_node_params)</span>
|
|
483
|
-
|
|
484
370
|
<span class="method-click-advice">click to toggle source</span>
|
|
485
|
-
|
|
486
371
|
</div>
|
|
487
|
-
|
|
488
372
|
|
|
489
373
|
<div class="method-description">
|
|
490
374
|
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
375
|
|
|
495
|
-
|
|
496
376
|
<div class="method-source-code" id="get_node_object-source">
|
|
497
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
498
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_node_object</span>(<span class="ruby-identifier">child_node_params</span>)
|
|
377
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 347</span>
|
|
378
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_node_object</span>(<span class="ruby-identifier">child_node_params</span>)
|
|
499
379
|
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">child_node_params</span>[<span class="ruby-value">:accessor</span>])
|
|
500
380
|
<span class="ruby-keyword">end</span></pre>
|
|
501
381
|
</div>
|
|
502
|
-
|
|
503
382
|
</div>
|
|
504
383
|
|
|
505
|
-
|
|
506
384
|
|
|
507
|
-
|
|
508
385
|
</div>
|
|
509
386
|
|
|
510
|
-
|
|
511
387
|
<div id="method-i-init_child_nodes" class="method-detail ">
|
|
512
|
-
|
|
513
388
|
<div class="method-heading">
|
|
514
389
|
<span class="method-name">init_child_nodes</span><span
|
|
515
390
|
class="method-args">(params)</span>
|
|
516
|
-
|
|
517
391
|
<span class="method-click-advice">click to toggle source</span>
|
|
518
|
-
|
|
519
392
|
</div>
|
|
520
|
-
|
|
521
393
|
|
|
522
394
|
<div class="method-description">
|
|
523
395
|
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
396
|
|
|
528
|
-
|
|
529
397
|
<div class="method-source-code" id="init_child_nodes-source">
|
|
530
|
-
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line
|
|
531
|
-
<span class="ruby-keyword">def</span> <span class="ruby-identifier">init_child_nodes</span>(<span class="ruby-identifier">params</span>)
|
|
398
|
+
<pre><span class="ruby-comment"># File lib/rubyXL/objects/ooxml_object.rb, line 237</span>
|
|
399
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">init_child_nodes</span>(<span class="ruby-identifier">params</span>)
|
|
532
400
|
<span class="ruby-identifier">obtain_class_variable</span>(<span class="ruby-value">:@@ooxml_child_nodes</span>).<span class="ruby-identifier">each_value</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
|
|
533
|
-
|
|
534
401
|
<span class="ruby-identifier">initial_value</span> =
|
|
535
402
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]) <span class="ruby-keyword">then</span> <span class="ruby-identifier">params</span>[<span class="ruby-identifier">v</span>[<span class="ruby-value">:accessor</span>]]
|
|
536
403
|
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">v</span>[<span class="ruby-value">:is_array</span>] <span class="ruby-keyword">then</span> []
|
|
@@ -541,24 +408,20 @@ the new element name, instead of its default name set by
|
|
|
541
408
|
}
|
|
542
409
|
<span class="ruby-keyword">end</span></pre>
|
|
543
410
|
</div>
|
|
544
|
-
|
|
545
411
|
</div>
|
|
546
412
|
|
|
547
|
-
|
|
548
413
|
|
|
549
|
-
|
|
550
414
|
</div>
|
|
551
415
|
|
|
552
|
-
|
|
553
416
|
</section>
|
|
554
|
-
|
|
417
|
+
|
|
555
418
|
</section>
|
|
556
419
|
</main>
|
|
557
420
|
|
|
558
421
|
|
|
559
422
|
<footer id="validator-badges" role="contentinfo">
|
|
560
|
-
<p><a href="
|
|
561
|
-
<p>Generated by <a href="https://
|
|
423
|
+
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
424
|
+
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.
|
|
562
425
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
563
426
|
</footer>
|
|
564
427
|
|